blob: a8c6208d24df6d659c209846fb88a887a4841a2a [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 Tanousb7290962024-08-07 11:09:51 -07001405inline void afterLogEntriesGetManagedObjects(
1406 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1407 const boost::system::error_code& ec,
1408 const dbus::utility::ManagedObjectType& resp)
1409{
1410 if (ec)
1411 {
1412 // TODO Handle for specific error code
1413 BMCWEB_LOG_ERROR("getLogEntriesIfaceData resp_handler got error {}",
1414 ec);
1415 messages::internalError(asyncResp->res);
1416 return;
1417 }
1418 nlohmann::json::array_t entriesArray;
1419 for (const auto& objectPath : resp)
1420 {
1421 const uint32_t* id = nullptr;
1422 const uint64_t* timestamp = nullptr;
1423 const uint64_t* updateTimestamp = nullptr;
1424 const std::string* severity = nullptr;
1425 const std::string* message = nullptr;
1426 const std::string* filePath = nullptr;
1427 const std::string* resolution = nullptr;
1428 bool resolved = false;
1429 const std::string* notify = nullptr;
1430
1431 for (const auto& interfaceMap : objectPath.second)
1432 {
1433 if (interfaceMap.first == "xyz.openbmc_project.Logging.Entry")
1434 {
1435 for (const auto& propertyMap : interfaceMap.second)
1436 {
1437 if (propertyMap.first == "Id")
1438 {
1439 id = std::get_if<uint32_t>(&propertyMap.second);
1440 }
1441 else if (propertyMap.first == "Timestamp")
1442 {
1443 timestamp = std::get_if<uint64_t>(&propertyMap.second);
1444 }
1445 else if (propertyMap.first == "UpdateTimestamp")
1446 {
1447 updateTimestamp =
1448 std::get_if<uint64_t>(&propertyMap.second);
1449 }
1450 else if (propertyMap.first == "Severity")
1451 {
1452 severity =
1453 std::get_if<std::string>(&propertyMap.second);
1454 }
1455 else if (propertyMap.first == "Resolution")
1456 {
1457 resolution =
1458 std::get_if<std::string>(&propertyMap.second);
1459 }
1460 else if (propertyMap.first == "Message")
1461 {
1462 message = std::get_if<std::string>(&propertyMap.second);
1463 }
1464 else if (propertyMap.first == "Resolved")
1465 {
1466 const bool* resolveptr =
1467 std::get_if<bool>(&propertyMap.second);
1468 if (resolveptr == nullptr)
1469 {
1470 messages::internalError(asyncResp->res);
1471 return;
1472 }
1473 resolved = *resolveptr;
1474 }
1475 else if (propertyMap.first == "ServiceProviderNotify")
1476 {
1477 notify = std::get_if<std::string>(&propertyMap.second);
1478 if (notify == nullptr)
1479 {
1480 messages::internalError(asyncResp->res);
1481 return;
1482 }
1483 }
1484 }
1485 if (id == nullptr || message == nullptr || severity == nullptr)
1486 {
1487 messages::internalError(asyncResp->res);
1488 return;
1489 }
1490 }
1491 else if (interfaceMap.first ==
1492 "xyz.openbmc_project.Common.FilePath")
1493 {
1494 for (const auto& propertyMap : interfaceMap.second)
1495 {
1496 if (propertyMap.first == "Path")
1497 {
1498 filePath =
1499 std::get_if<std::string>(&propertyMap.second);
1500 }
1501 }
1502 }
1503 }
1504 // Object path without the
1505 // xyz.openbmc_project.Logging.Entry interface, ignore
1506 // and continue.
1507 if (id == nullptr || message == nullptr || severity == nullptr ||
1508 timestamp == nullptr || updateTimestamp == nullptr)
1509 {
1510 continue;
1511 }
1512 nlohmann::json& thisEntry = entriesArray.emplace_back();
1513 thisEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
1514 thisEntry["@odata.id"] = boost::urls::format(
1515 "/redfish/v1/Systems/{}/LogServices/EventLog/Entries/{}",
1516 BMCWEB_REDFISH_SYSTEM_URI_NAME, std::to_string(*id));
1517 thisEntry["Name"] = "System Event Log Entry";
1518 thisEntry["Id"] = std::to_string(*id);
1519 thisEntry["Message"] = *message;
1520 thisEntry["Resolved"] = resolved;
1521 if ((resolution != nullptr) && (!(*resolution).empty()))
1522 {
1523 thisEntry["Resolution"] = *resolution;
1524 }
1525 if (notify != nullptr)
1526 {
1527 std::optional<bool> notifyAction = getProviderNotifyAction(*notify);
1528 if (notifyAction)
1529 {
1530 thisEntry["ServiceProviderNotified"] = *notifyAction;
1531 }
1532 }
1533 thisEntry["EntryType"] = "Event";
1534 thisEntry["Severity"] = translateSeverityDbusToRedfish(*severity);
1535 thisEntry["Created"] =
1536 redfish::time_utils::getDateTimeUintMs(*timestamp);
1537 thisEntry["Modified"] =
1538 redfish::time_utils::getDateTimeUintMs(*updateTimestamp);
1539 if (filePath != nullptr)
1540 {
1541 thisEntry["AdditionalDataURI"] =
1542 std::format(
1543 "/redfish/v1/Systems/{}/LogServices/EventLog/Entries/",
1544 BMCWEB_REDFISH_SYSTEM_URI_NAME) +
1545 std::to_string(*id) + "/attachment";
1546 }
1547 }
1548 std::ranges::sort(entriesArray, [](const nlohmann::json& left,
1549 const nlohmann::json& right) {
1550 return (left["Id"] <= right["Id"]);
1551 });
1552 asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size();
1553 asyncResp->res.jsonValue["Members"] = std::move(entriesArray);
1554}
1555
Alexander Hansen599b9af2024-08-06 15:11:57 +02001556inline void handleSystemsLogServiceEventLogLogEntryCollection(
1557 App& app, const crow::Request& req,
1558 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1559 const std::string& systemName)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001560{
Alexander Hansen599b9af2024-08-06 15:11:57 +02001561 query_param::QueryCapabilities capabilities = {
1562 .canDelegateTop = true,
1563 .canDelegateSkip = true,
1564 };
1565 query_param::Query delegatedQuery;
1566 if (!redfish::setUpRedfishRouteWithDelegation(app, req, asyncResp,
1567 delegatedQuery, capabilities))
1568 {
1569 return;
1570 }
1571 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
1572 {
1573 // Option currently returns no systems. TBD
1574 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1575 systemName);
1576 return;
1577 }
1578 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
1579 {
1580 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1581 systemName);
1582 return;
1583 }
1584
1585 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
1586 size_t skip = delegatedQuery.skip.value_or(0);
1587
1588 // Collections don't include the static data added by SubRoute
1589 // because it has a duplicate entry for members
1590 asyncResp->res.jsonValue["@odata.type"] =
1591 "#LogEntryCollection.LogEntryCollection";
1592 asyncResp->res.jsonValue["@odata.id"] =
1593 std::format("/redfish/v1/Systems/{}/LogServices/EventLog/Entries",
1594 BMCWEB_REDFISH_SYSTEM_URI_NAME);
1595 asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1596 asyncResp->res.jsonValue["Description"] =
1597 "Collection of System Event Log Entries";
1598
1599 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1600 logEntryArray = nlohmann::json::array();
1601 // Go through the log files and create a unique ID for each
1602 // entry
1603 std::vector<std::filesystem::path> redfishLogFiles;
1604 getRedfishLogFiles(redfishLogFiles);
1605 uint64_t entryCount = 0;
1606 std::string logEntry;
1607
1608 // Oldest logs are in the last file, so start there and loop
1609 // backwards
1610 for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); it++)
1611 {
1612 std::ifstream logStream(*it);
1613 if (!logStream.is_open())
Ed Tanous002d39b2022-05-31 08:59:27 -07001614 {
Alexander Hansen599b9af2024-08-06 15:11:57 +02001615 continue;
Ed Tanous22d268c2022-05-19 09:39:07 -07001616 }
1617
Alexander Hansen599b9af2024-08-06 15:11:57 +02001618 // Reset the unique ID on the first entry
1619 bool firstEntry = true;
1620 while (std::getline(logStream, logEntry))
Ed Tanous002d39b2022-05-31 08:59:27 -07001621 {
Alexander Hansen599b9af2024-08-06 15:11:57 +02001622 std::string idStr;
1623 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1624 {
1625 continue;
1626 }
1627 firstEntry = false;
1628
1629 nlohmann::json::object_t bmcLogEntry;
1630 LogParseError status = fillEventLogEntryJson(idStr, logEntry,
1631 bmcLogEntry);
1632 if (status == LogParseError::messageIdNotInRegistry)
1633 {
1634 continue;
1635 }
1636 if (status != LogParseError::success)
1637 {
1638 messages::internalError(asyncResp->res);
1639 return;
1640 }
1641
1642 entryCount++;
1643 // Handle paging using skip (number of entries to skip from the
1644 // start) and top (number of entries to display)
1645 if (entryCount <= skip || entryCount > skip + top)
Jason M. Bills4978b632022-02-22 14:17:43 -08001646 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001647 continue;
Jason M. Bills4978b632022-02-22 14:17:43 -08001648 }
Jason M. Bills897967d2019-07-29 17:05:30 -07001649
Alexander Hansen599b9af2024-08-06 15:11:57 +02001650 logEntryArray.emplace_back(std::move(bmcLogEntry));
1651 }
1652 }
1653 asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1654 if (skip + top < entryCount)
1655 {
1656 asyncResp->res.jsonValue["Members@odata.nextLink"] =
1657 boost::urls::format(
1658 "/redfish/v1/Systems/{}/LogServices/EventLog/Entries?$skip={}",
1659 BMCWEB_REDFISH_SYSTEM_URI_NAME, std::to_string(skip + top));
1660 }
1661}
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001662
Alexander Hansen599b9af2024-08-06 15:11:57 +02001663inline void requestRoutesJournalEventLogEntryCollection(App& app)
1664{
1665 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/")
1666 .privileges(redfish::privileges::getLogEntryCollection)
1667 .methods(boost::beast::http::verb::get)(std::bind_front(
1668 handleSystemsLogServiceEventLogLogEntryCollection, std::ref(app)));
1669}
1670
1671inline void handleSystemsLogServiceEventLogEntriesGet(
1672 App& app, const crow::Request& req,
1673 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1674 const std::string& systemName, const std::string& param)
1675{
1676 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
1677 {
1678 return;
1679 }
1680 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
1681 {
1682 // Option currently returns no systems. TBD
1683 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1684 systemName);
1685 return;
1686 }
1687
1688 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
1689 {
1690 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1691 systemName);
1692 return;
1693 }
1694
1695 const std::string& targetID = param;
1696
1697 // Go through the log files and check the unique ID for each
1698 // entry to find the target entry
1699 std::vector<std::filesystem::path> redfishLogFiles;
1700 getRedfishLogFiles(redfishLogFiles);
1701 std::string logEntry;
1702
1703 // Oldest logs are in the last file, so start there and loop
1704 // backwards
1705 for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); it++)
1706 {
1707 std::ifstream logStream(*it);
1708 if (!logStream.is_open())
1709 {
1710 continue;
1711 }
1712
1713 // Reset the unique ID on the first entry
1714 bool firstEntry = true;
1715 while (std::getline(logStream, logEntry))
1716 {
1717 std::string idStr;
1718 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1719 {
1720 continue;
1721 }
1722 firstEntry = false;
1723
1724 if (idStr == targetID)
1725 {
Jason M. Billsde703c52022-06-23 14:19:04 -07001726 nlohmann::json::object_t bmcLogEntry;
Patrick Williams89492a12023-05-10 07:51:34 -05001727 LogParseError status = fillEventLogEntryJson(idStr, logEntry,
1728 bmcLogEntry);
Jason M. Billsac992cd2022-06-24 13:31:46 -07001729 if (status != LogParseError::success)
Ed Tanous002d39b2022-05-31 08:59:27 -07001730 {
1731 messages::internalError(asyncResp->res);
1732 return;
Andrew Geisslercb92c032018-08-17 07:56:14 -07001733 }
Alexander Hansen599b9af2024-08-06 15:11:57 +02001734 asyncResp->res.jsonValue.update(bmcLogEntry);
1735 return;
Jason M. Bills4978b632022-02-22 14:17:43 -08001736 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001737 }
Alexander Hansen599b9af2024-08-06 15:11:57 +02001738 }
1739 // Requested ID was not found
1740 messages::resourceNotFound(asyncResp->res, "LogEntry", targetID);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001741}
Chicago Duan336e96c2019-07-15 14:22:08 +08001742
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001743inline void requestRoutesJournalEventLogEntry(App& app)
1744{
1745 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001746 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001747 .privileges(redfish::privileges::getLogEntry)
Alexander Hansen599b9af2024-08-06 15:11:57 +02001748 .methods(boost::beast::http::verb::get)(std::bind_front(
1749 handleSystemsLogServiceEventLogEntriesGet, std::ref(app)));
1750}
1751
1752inline void dBusEventLogEntryCollection(
1753 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
1754{
1755 // Collections don't include the static data added by SubRoute
1756 // because it has a duplicate entry for members
1757 asyncResp->res.jsonValue["@odata.type"] =
1758 "#LogEntryCollection.LogEntryCollection";
1759 asyncResp->res.jsonValue["@odata.id"] =
1760 std::format("/redfish/v1/Systems/{}/LogServices/EventLog/Entries",
1761 BMCWEB_REDFISH_SYSTEM_URI_NAME);
1762 asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1763 asyncResp->res.jsonValue["Description"] =
1764 "Collection of System Event Log Entries";
1765
1766 // DBus implementation of EventLog/Entries
1767 // Make call to Logging Service to find all log entry objects
1768 sdbusplus::message::object_path path("/xyz/openbmc_project/logging");
1769 dbus::utility::getManagedObjects(
1770 "xyz.openbmc_project.Logging", path,
1771 [asyncResp](const boost::system::error_code& ec,
1772 const dbus::utility::ManagedObjectType& resp) {
Ed Tanousb7290962024-08-07 11:09:51 -07001773 afterLogEntriesGetManagedObjects(asyncResp, ec, resp);
Patrick Williams5a39f772023-10-20 11:20:21 -05001774 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001775}
1776
1777inline void requestRoutesDBusEventLogEntryCollection(App& app)
1778{
Ed Tanous22d268c2022-05-19 09:39:07 -07001779 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07001780 .privileges(redfish::privileges::getLogEntryCollection)
Ed Tanous002d39b2022-05-31 08:59:27 -07001781 .methods(boost::beast::http::verb::get)(
1782 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07001783 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1784 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001785 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001786 {
1787 return;
1788 }
Ed Tanous25b54db2024-04-17 15:40:31 -07001789 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001790 {
1791 // Option currently returns no systems. TBD
1792 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1793 systemName);
1794 return;
1795 }
Ed Tanous253f11b2024-05-16 09:38:31 -07001796 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07001797 {
1798 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1799 systemName);
1800 return;
1801 }
Alexander Hansen599b9af2024-08-06 15:11:57 +02001802 dBusEventLogEntryCollection(asyncResp);
1803 });
1804}
Ed Tanous22d268c2022-05-19 09:39:07 -07001805
Alexander Hansen599b9af2024-08-06 15:11:57 +02001806inline void
1807 dBusEventLogEntryGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1808 std::string& entryID)
1809{
1810 dbus::utility::escapePathForDbus(entryID);
Ed Tanous002d39b2022-05-31 08:59:27 -07001811
Alexander Hansen599b9af2024-08-06 15:11:57 +02001812 // DBus implementation of EventLog/Entries
1813 // Make call to Logging Service to find all log entry objects
1814 sdbusplus::asio::getAllProperties(
1815 *crow::connections::systemBus, "xyz.openbmc_project.Logging",
1816 "/xyz/openbmc_project/logging/entry/" + entryID, "",
1817 [asyncResp, entryID](const boost::system::error_code& ec,
1818 const dbus::utility::DBusPropertiesMap& resp) {
1819 if (ec.value() == EBADR)
1820 {
1821 messages::resourceNotFound(asyncResp->res, "EventLogEntry",
1822 entryID);
1823 return;
1824 }
1825 if (ec)
1826 {
1827 BMCWEB_LOG_ERROR("EventLogEntry (DBus) resp_handler got error {}",
1828 ec);
1829 messages::internalError(asyncResp->res);
1830 return;
1831 }
1832 const uint32_t* id = nullptr;
1833 const uint64_t* timestamp = nullptr;
1834 const uint64_t* updateTimestamp = nullptr;
1835 const std::string* severity = nullptr;
1836 const std::string* message = nullptr;
1837 const std::string* filePath = nullptr;
1838 const std::string* resolution = nullptr;
1839 bool resolved = false;
1840 const std::string* notify = nullptr;
1841
1842 const bool success = sdbusplus::unpackPropertiesNoThrow(
1843 dbus_utils::UnpackErrorPrinter(), resp, "Id", id, "Timestamp",
1844 timestamp, "UpdateTimestamp", updateTimestamp, "Severity", severity,
1845 "Message", message, "Resolved", resolved, "Resolution", resolution,
1846 "Path", filePath, "ServiceProviderNotify", notify);
1847
1848 if (!success)
1849 {
1850 messages::internalError(asyncResp->res);
1851 return;
1852 }
1853
1854 if (id == nullptr || message == nullptr || severity == nullptr ||
1855 timestamp == nullptr || updateTimestamp == nullptr ||
1856 notify == nullptr)
1857 {
1858 messages::internalError(asyncResp->res);
1859 return;
1860 }
1861
1862 asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
1863 asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
1864 "/redfish/v1/Systems/{}/LogServices/EventLog/Entries/{}",
1865 BMCWEB_REDFISH_SYSTEM_URI_NAME, std::to_string(*id));
1866 asyncResp->res.jsonValue["Name"] = "System Event Log Entry";
1867 asyncResp->res.jsonValue["Id"] = std::to_string(*id);
1868 asyncResp->res.jsonValue["Message"] = *message;
1869 asyncResp->res.jsonValue["Resolved"] = resolved;
1870 std::optional<bool> notifyAction = getProviderNotifyAction(*notify);
1871 if (notifyAction)
1872 {
1873 asyncResp->res.jsonValue["ServiceProviderNotified"] = *notifyAction;
1874 }
1875 if ((resolution != nullptr) && (!(*resolution).empty()))
1876 {
1877 asyncResp->res.jsonValue["Resolution"] = *resolution;
1878 }
1879 asyncResp->res.jsonValue["EntryType"] = "Event";
1880 asyncResp->res.jsonValue["Severity"] =
1881 translateSeverityDbusToRedfish(*severity);
1882 asyncResp->res.jsonValue["Created"] =
1883 redfish::time_utils::getDateTimeUintMs(*timestamp);
1884 asyncResp->res.jsonValue["Modified"] =
1885 redfish::time_utils::getDateTimeUintMs(*updateTimestamp);
1886 if (filePath != nullptr)
1887 {
1888 asyncResp->res.jsonValue["AdditionalDataURI"] =
1889 std::format(
1890 "/redfish/v1/Systems/{}/LogServices/EventLog/Entries/",
1891 BMCWEB_REDFISH_SYSTEM_URI_NAME) +
1892 std::to_string(*id) + "/attachment";
1893 }
1894 });
1895}
1896
1897inline void
1898 dBusEventLogEntryPatch(const crow::Request& req,
1899 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1900 const std::string& entryId)
1901{
1902 std::optional<bool> resolved;
1903
1904 if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved", resolved))
1905 {
1906 return;
1907 }
1908 BMCWEB_LOG_DEBUG("Set Resolved");
1909
1910 setDbusProperty(asyncResp, "Resolved", "xyz.openbmc_project.Logging",
1911 "/xyz/openbmc_project/logging/entry/" + entryId,
1912 "xyz.openbmc_project.Logging.Entry", "Resolved",
1913 resolved.value_or(false));
1914}
1915
1916inline void
1917 dBusEventLogEntryDelete(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1918 std::string entryID)
1919{
1920 BMCWEB_LOG_DEBUG("Do delete single event entries.");
1921
1922 dbus::utility::escapePathForDbus(entryID);
1923
1924 // Process response from Logging service.
1925 auto respHandler = [asyncResp,
1926 entryID](const boost::system::error_code& ec) {
1927 BMCWEB_LOG_DEBUG("EventLogEntry (DBus) doDelete callback: Done");
1928 if (ec)
1929 {
1930 if (ec.value() == EBADR)
Ed Tanous45ca1b82022-03-25 13:07:27 -07001931 {
Alexander Hansen599b9af2024-08-06 15:11:57 +02001932 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
Ed Tanous45ca1b82022-03-25 13:07:27 -07001933 return;
1934 }
Alexander Hansen599b9af2024-08-06 15:11:57 +02001935 // TODO Handle for specific error code
1936 BMCWEB_LOG_ERROR(
1937 "EventLogEntry (DBus) doDelete respHandler got error {}", ec);
1938 asyncResp->res.result(
1939 boost::beast::http::status::internal_server_error);
1940 return;
1941 }
Abhishek Patel9017faf2021-09-14 22:48:55 -05001942
Alexander Hansen599b9af2024-08-06 15:11:57 +02001943 asyncResp->res.result(boost::beast::http::status::ok);
1944 };
1945
1946 // Make call to Logging service to request Delete Log
1947 crow::connections::systemBus->async_method_call(
1948 respHandler, "xyz.openbmc_project.Logging",
1949 "/xyz/openbmc_project/logging/entry/" + entryID,
1950 "xyz.openbmc_project.Object.Delete", "Delete");
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001951}
Xiaochao Ma75710de2021-01-21 17:56:02 +08001952
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001953inline void requestRoutesDBusEventLogEntry(App& app)
Adriana Kobylak400fd1f2021-01-29 09:01:30 -06001954{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001955 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001956 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001957 .privileges(redfish::privileges::getLogEntry)
Ed Tanous002d39b2022-05-31 08:59:27 -07001958 .methods(boost::beast::http::verb::get)(
1959 [&app](const crow::Request& req,
1960 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07001961 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001962 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001963 {
1964 return;
1965 }
Ed Tanous25b54db2024-04-17 15:40:31 -07001966 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001967 {
1968 // Option currently returns no systems. TBD
1969 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1970 systemName);
1971 return;
1972 }
Ed Tanous253f11b2024-05-16 09:38:31 -07001973 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07001974 {
1975 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1976 systemName);
1977 return;
1978 }
1979
Ed Tanous002d39b2022-05-31 08:59:27 -07001980 std::string entryID = param;
Ed Tanous002d39b2022-05-31 08:59:27 -07001981
Alexander Hansen599b9af2024-08-06 15:11:57 +02001982 dBusEventLogEntryGet(asyncResp, entryID);
Patrick Williams5a39f772023-10-20 11:20:21 -05001983 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001984
1985 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001986 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001987 .privileges(redfish::privileges::patchLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001988 .methods(boost::beast::http::verb::patch)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07001989 [&app](const crow::Request& req,
1990 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07001991 const std::string& systemName, const std::string& entryId) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001992 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001993 {
1994 return;
1995 }
Ed Tanous25b54db2024-04-17 15:40:31 -07001996 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001997 {
1998 // Option currently returns no systems. TBD
1999 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2000 systemName);
2001 return;
2002 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002003 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002004 {
2005 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2006 systemName);
2007 return;
2008 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002009
Alexander Hansen599b9af2024-08-06 15:11:57 +02002010 dBusEventLogEntryPatch(req, asyncResp, entryId);
Patrick Williams5a39f772023-10-20 11:20:21 -05002011 });
Adriana Kobylak400fd1f2021-01-29 09:01:30 -06002012
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002013 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07002014 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002015 .privileges(redfish::privileges::deleteLogEntry)
2016
Ed Tanous002d39b2022-05-31 08:59:27 -07002017 .methods(boost::beast::http::verb::delete_)(
2018 [&app](const crow::Request& req,
2019 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07002020 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002021 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002022 {
2023 return;
2024 }
Ed Tanous25b54db2024-04-17 15:40:31 -07002025 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002026 {
2027 // Option currently returns no systems. TBD
2028 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2029 systemName);
2030 return;
2031 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002032 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002033 {
2034 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2035 systemName);
2036 return;
2037 }
Alexander Hansen599b9af2024-08-06 15:11:57 +02002038 dBusEventLogEntryDelete(asyncResp, param);
Patrick Williams5a39f772023-10-20 11:20:21 -05002039 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002040}
2041
Spencer Kub7028eb2021-10-26 15:27:35 +08002042constexpr const char* hostLoggerFolderPath = "/var/log/console";
2043
2044inline bool
2045 getHostLoggerFiles(const std::string& hostLoggerFilePath,
2046 std::vector<std::filesystem::path>& hostLoggerFiles)
2047{
2048 std::error_code ec;
2049 std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec);
2050 if (ec)
2051 {
Carson Labradobf2dded2023-08-10 00:37:06 +00002052 BMCWEB_LOG_WARNING("{}", ec.message());
Spencer Kub7028eb2021-10-26 15:27:35 +08002053 return false;
2054 }
2055 for (const std::filesystem::directory_entry& it : logPath)
2056 {
2057 std::string filename = it.path().filename();
2058 // Prefix of each log files is "log". Find the file and save the
2059 // path
Ed Tanous11ba3972022-07-11 09:50:41 -07002060 if (filename.starts_with("log"))
Spencer Kub7028eb2021-10-26 15:27:35 +08002061 {
2062 hostLoggerFiles.emplace_back(it.path());
2063 }
2064 }
2065 // As the log files rotate, they are appended with a ".#" that is higher for
2066 // the older logs. Since we start from oldest logs, sort the name in
2067 // descending order.
2068 std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(),
2069 AlphanumLess<std::string>());
2070
2071 return true;
2072}
2073
Ed Tanous02cad962022-06-30 16:50:15 -07002074inline bool getHostLoggerEntries(
2075 const std::vector<std::filesystem::path>& hostLoggerFiles, uint64_t skip,
2076 uint64_t top, std::vector<std::string>& logEntries, size_t& logCount)
Spencer Kub7028eb2021-10-26 15:27:35 +08002077{
2078 GzFileReader logFile;
2079
2080 // Go though all log files and expose host logs.
2081 for (const std::filesystem::path& it : hostLoggerFiles)
2082 {
2083 if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount))
2084 {
Ed Tanous62598e32023-07-17 17:06:25 -07002085 BMCWEB_LOG_ERROR("fail to expose host logs");
Spencer Kub7028eb2021-10-26 15:27:35 +08002086 return false;
2087 }
2088 }
2089 // Get lastMessage from constructor by getter
2090 std::string lastMessage = logFile.getLastMessage();
2091 if (!lastMessage.empty())
2092 {
2093 logCount++;
2094 if (logCount > skip && logCount <= (skip + top))
2095 {
2096 logEntries.push_back(lastMessage);
2097 }
2098 }
2099 return true;
2100}
2101
Ed Tanous6f056f22024-04-07 13:35:51 -07002102inline void fillHostLoggerEntryJson(std::string_view logEntryID,
2103 std::string_view msg,
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002104 nlohmann::json::object_t& logEntryJson)
Spencer Kub7028eb2021-10-26 15:27:35 +08002105{
2106 // Fill in the log entry with the gathered data.
Vijay Lobo9c11a172021-10-07 16:53:16 -05002107 logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07002108 logEntryJson["@odata.id"] = boost::urls::format(
Ed Tanous253f11b2024-05-16 09:38:31 -07002109 "/redfish/v1/Systems/{}/LogServices/HostLogger/Entries/{}",
2110 BMCWEB_REDFISH_SYSTEM_URI_NAME, logEntryID);
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002111 logEntryJson["Name"] = "Host Logger Entry";
2112 logEntryJson["Id"] = logEntryID;
2113 logEntryJson["Message"] = msg;
Ed Tanous539d8c62024-06-19 14:38:27 -07002114 logEntryJson["EntryType"] = log_entry::LogEntryType::Oem;
2115 logEntryJson["Severity"] = log_entry::EventSeverity::OK;
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002116 logEntryJson["OemRecordFormat"] = "Host Logger Entry";
Spencer Kub7028eb2021-10-26 15:27:35 +08002117}
2118
2119inline void requestRoutesSystemHostLogger(App& app)
2120{
Ed Tanous22d268c2022-05-19 09:39:07 -07002121 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/")
Spencer Kub7028eb2021-10-26 15:27:35 +08002122 .privileges(redfish::privileges::getLogService)
Ed Tanous14766872022-03-15 10:44:42 -07002123 .methods(boost::beast::http::verb::get)(
2124 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07002125 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2126 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002127 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002128 {
2129 return;
2130 }
Ed Tanous25b54db2024-04-17 15:40:31 -07002131 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002132 {
2133 // Option currently returns no systems. TBD
2134 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2135 systemName);
2136 return;
2137 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002138 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002139 {
2140 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2141 systemName);
2142 return;
2143 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002144 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07002145 std::format("/redfish/v1/Systems/{}/LogServices/HostLogger",
2146 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07002147 asyncResp->res.jsonValue["@odata.type"] =
Janet Adkinsb25644a2023-08-16 11:23:45 -05002148 "#LogService.v1_2_0.LogService";
Ed Tanous002d39b2022-05-31 08:59:27 -07002149 asyncResp->res.jsonValue["Name"] = "Host Logger Service";
2150 asyncResp->res.jsonValue["Description"] = "Host Logger Service";
2151 asyncResp->res.jsonValue["Id"] = "HostLogger";
2152 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07002153 std::format("/redfish/v1/Systems/{}/LogServices/HostLogger/Entries",
2154 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Patrick Williams5a39f772023-10-20 11:20:21 -05002155 });
Spencer Kub7028eb2021-10-26 15:27:35 +08002156}
2157
2158inline void requestRoutesSystemHostLoggerCollection(App& app)
2159{
2160 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002161 "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/")
Spencer Kub7028eb2021-10-26 15:27:35 +08002162 .privileges(redfish::privileges::getLogEntry)
Ed Tanous002d39b2022-05-31 08:59:27 -07002163 .methods(boost::beast::http::verb::get)(
2164 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07002165 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2166 const std::string& systemName) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002167 query_param::QueryCapabilities capabilities = {
2168 .canDelegateTop = true,
2169 .canDelegateSkip = true,
2170 };
2171 query_param::Query delegatedQuery;
2172 if (!redfish::setUpRedfishRouteWithDelegation(
Carson Labrado3ba00072022-06-06 19:40:56 +00002173 app, req, asyncResp, delegatedQuery, capabilities))
Ed Tanous002d39b2022-05-31 08:59:27 -07002174 {
2175 return;
2176 }
Ed Tanous25b54db2024-04-17 15:40:31 -07002177 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002178 {
2179 // Option currently returns no systems. TBD
2180 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2181 systemName);
2182 return;
2183 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002184 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002185 {
2186 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2187 systemName);
2188 return;
2189 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002190 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07002191 std::format("/redfish/v1/Systems/{}/LogServices/HostLogger/Entries",
2192 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07002193 asyncResp->res.jsonValue["@odata.type"] =
2194 "#LogEntryCollection.LogEntryCollection";
2195 asyncResp->res.jsonValue["Name"] = "HostLogger Entries";
2196 asyncResp->res.jsonValue["Description"] =
2197 "Collection of HostLogger Entries";
2198 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2199 logEntryArray = nlohmann::json::array();
2200 asyncResp->res.jsonValue["Members@odata.count"] = 0;
Spencer Kub7028eb2021-10-26 15:27:35 +08002201
Ed Tanous002d39b2022-05-31 08:59:27 -07002202 std::vector<std::filesystem::path> hostLoggerFiles;
2203 if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles))
2204 {
Carson Labradobf2dded2023-08-10 00:37:06 +00002205 BMCWEB_LOG_DEBUG("Failed to get host log file path");
Ed Tanous002d39b2022-05-31 08:59:27 -07002206 return;
2207 }
Ed Tanous3648c8b2022-07-25 13:39:59 -07002208 // If we weren't provided top and skip limits, use the defaults.
2209 size_t skip = delegatedQuery.skip.value_or(0);
Jiaqing Zhao5143f7a2022-07-22 09:33:33 +08002210 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
Ed Tanous002d39b2022-05-31 08:59:27 -07002211 size_t logCount = 0;
2212 // This vector only store the entries we want to expose that
2213 // control by skip and top.
2214 std::vector<std::string> logEntries;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002215 if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries,
2216 logCount))
Ed Tanous002d39b2022-05-31 08:59:27 -07002217 {
2218 messages::internalError(asyncResp->res);
2219 return;
2220 }
2221 // If vector is empty, that means skip value larger than total
2222 // log count
2223 if (logEntries.empty())
2224 {
2225 asyncResp->res.jsonValue["Members@odata.count"] = logCount;
2226 return;
2227 }
2228 if (!logEntries.empty())
2229 {
2230 for (size_t i = 0; i < logEntries.size(); i++)
George Liu0fda0f12021-11-16 10:06:17 +08002231 {
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002232 nlohmann::json::object_t hostLogEntry;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002233 fillHostLoggerEntryJson(std::to_string(skip + i), logEntries[i],
2234 hostLogEntry);
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002235 logEntryArray.emplace_back(std::move(hostLogEntry));
George Liu0fda0f12021-11-16 10:06:17 +08002236 }
2237
Ed Tanous002d39b2022-05-31 08:59:27 -07002238 asyncResp->res.jsonValue["Members@odata.count"] = logCount;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002239 if (skip + top < logCount)
George Liu0fda0f12021-11-16 10:06:17 +08002240 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002241 asyncResp->res.jsonValue["Members@odata.nextLink"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07002242 std::format(
2243 "/redfish/v1/Systems/{}/LogServices/HostLogger/Entries?$skip=",
2244 BMCWEB_REDFISH_SYSTEM_URI_NAME) +
Ed Tanous3648c8b2022-07-25 13:39:59 -07002245 std::to_string(skip + top);
George Liu0fda0f12021-11-16 10:06:17 +08002246 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002247 }
Patrick Williams5a39f772023-10-20 11:20:21 -05002248 });
Spencer Kub7028eb2021-10-26 15:27:35 +08002249}
2250
2251inline void requestRoutesSystemHostLoggerLogEntry(App& app)
2252{
2253 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07002254 app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/<str>/")
Spencer Kub7028eb2021-10-26 15:27:35 +08002255 .privileges(redfish::privileges::getLogEntry)
2256 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07002257 [&app](const crow::Request& req,
2258 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07002259 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002260 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002261 {
2262 return;
2263 }
Ed Tanous25b54db2024-04-17 15:40:31 -07002264 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002265 {
2266 // Option currently returns no systems. TBD
2267 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2268 systemName);
2269 return;
2270 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002271 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002272 {
2273 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2274 systemName);
2275 return;
2276 }
Ed Tanous6f056f22024-04-07 13:35:51 -07002277 std::string_view targetID = param;
Spencer Kub7028eb2021-10-26 15:27:35 +08002278
Ed Tanous002d39b2022-05-31 08:59:27 -07002279 uint64_t idInt = 0;
Ed Tanousca45aa32022-01-07 09:28:45 -08002280
Ed Tanous6f056f22024-04-07 13:35:51 -07002281 auto [ptr, ec] = std::from_chars(targetID.begin(), targetID.end(),
Patrick Williams84396af2023-05-11 11:47:45 -05002282 idInt);
Ed Tanous6f056f22024-04-07 13:35:51 -07002283 if (ec != std::errc{} || ptr != targetID.end())
Ed Tanous002d39b2022-05-31 08:59:27 -07002284 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08002285 messages::resourceNotFound(asyncResp->res, "LogEntry", param);
Ed Tanous002d39b2022-05-31 08:59:27 -07002286 return;
2287 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002288
Ed Tanous002d39b2022-05-31 08:59:27 -07002289 std::vector<std::filesystem::path> hostLoggerFiles;
2290 if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles))
2291 {
Carson Labradobf2dded2023-08-10 00:37:06 +00002292 BMCWEB_LOG_DEBUG("Failed to get host log file path");
Ed Tanous002d39b2022-05-31 08:59:27 -07002293 return;
2294 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002295
Ed Tanous002d39b2022-05-31 08:59:27 -07002296 size_t logCount = 0;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002297 size_t top = 1;
Ed Tanous002d39b2022-05-31 08:59:27 -07002298 std::vector<std::string> logEntries;
2299 // We can get specific entry by skip and top. For example, if we
2300 // want to get nth entry, we can set skip = n-1 and top = 1 to
2301 // get that entry
2302 if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries,
2303 logCount))
2304 {
2305 messages::internalError(asyncResp->res);
2306 return;
2307 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002308
Ed Tanous002d39b2022-05-31 08:59:27 -07002309 if (!logEntries.empty())
2310 {
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002311 nlohmann::json::object_t hostLogEntry;
2312 fillHostLoggerEntryJson(targetID, logEntries[0], hostLogEntry);
2313 asyncResp->res.jsonValue.update(hostLogEntry);
Ed Tanous002d39b2022-05-31 08:59:27 -07002314 return;
2315 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002316
Ed Tanous002d39b2022-05-31 08:59:27 -07002317 // Requested ID was not found
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08002318 messages::resourceNotFound(asyncResp->res, "LogEntry", param);
Patrick Williams5a39f772023-10-20 11:20:21 -05002319 });
Spencer Kub7028eb2021-10-26 15:27:35 +08002320}
2321
Claire Weinandd72e872022-08-15 14:20:06 -07002322inline void handleBMCLogServicesCollectionGet(
Claire Weinanfdd26902022-03-01 14:18:25 -08002323 crow::App& app, const crow::Request& req,
Ed Tanous253f11b2024-05-16 09:38:31 -07002324 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2325 const std::string& managerId)
Claire Weinanfdd26902022-03-01 14:18:25 -08002326{
2327 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2328 {
2329 return;
2330 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002331
2332 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2333 {
2334 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2335 return;
2336 }
2337
Claire Weinanfdd26902022-03-01 14:18:25 -08002338 // Collections don't include the static data added by SubRoute
2339 // because it has a duplicate entry for members
2340 asyncResp->res.jsonValue["@odata.type"] =
2341 "#LogServiceCollection.LogServiceCollection";
Ed Tanous253f11b2024-05-16 09:38:31 -07002342 asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
2343 "/redfish/v1/Managers/{}/LogServices", BMCWEB_REDFISH_MANAGER_URI_NAME);
Claire Weinanfdd26902022-03-01 14:18:25 -08002344 asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection";
2345 asyncResp->res.jsonValue["Description"] =
2346 "Collection of LogServices for this Manager";
2347 nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
2348 logServiceArray = nlohmann::json::array();
2349
Ed Tanous25b54db2024-04-17 15:40:31 -07002350 if constexpr (BMCWEB_REDFISH_BMC_JOURNAL)
2351 {
2352 nlohmann::json::object_t journal;
Ed Tanous253f11b2024-05-16 09:38:31 -07002353 journal["@odata.id"] =
2354 boost::urls::format("/redfish/v1/Managers/{}/LogServices/Journal",
2355 BMCWEB_REDFISH_MANAGER_URI_NAME);
Ed Tanous25b54db2024-04-17 15:40:31 -07002356 logServiceArray.emplace_back(std::move(journal));
2357 }
Claire Weinanfdd26902022-03-01 14:18:25 -08002358
2359 asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size();
2360
Ed Tanous25b54db2024-04-17 15:40:31 -07002361 if constexpr (BMCWEB_REDFISH_DUMP_LOG)
2362 {
2363 constexpr std::array<std::string_view, 1> interfaces = {
2364 "xyz.openbmc_project.Collection.DeleteAll"};
2365 dbus::utility::getSubTreePaths(
2366 "/xyz/openbmc_project/dump", 0, interfaces,
2367 [asyncResp](const boost::system::error_code& ec,
2368 const dbus::utility::MapperGetSubTreePathsResponse&
2369 subTreePaths) {
2370 if (ec)
Claire Weinanfdd26902022-03-01 14:18:25 -08002371 {
Ed Tanous25b54db2024-04-17 15:40:31 -07002372 BMCWEB_LOG_ERROR(
2373 "handleBMCLogServicesCollectionGet respHandler got error {}",
2374 ec);
2375 // Assume that getting an error simply means there are no dump
2376 // LogServices. Return without adding any error response.
2377 return;
Claire Weinanfdd26902022-03-01 14:18:25 -08002378 }
Claire Weinanfdd26902022-03-01 14:18:25 -08002379
Ed Tanous25b54db2024-04-17 15:40:31 -07002380 nlohmann::json& logServiceArrayLocal =
2381 asyncResp->res.jsonValue["Members"];
2382
2383 for (const std::string& path : subTreePaths)
2384 {
2385 if (path == "/xyz/openbmc_project/dump/bmc")
2386 {
2387 nlohmann::json::object_t member;
Ed Tanous253f11b2024-05-16 09:38:31 -07002388 member["@odata.id"] = boost::urls::format(
2389 "/redfish/v1/Managers/{}/LogServices/Dump",
2390 BMCWEB_REDFISH_MANAGER_URI_NAME);
Ed Tanous25b54db2024-04-17 15:40:31 -07002391 logServiceArrayLocal.emplace_back(std::move(member));
2392 }
2393 else if (path == "/xyz/openbmc_project/dump/faultlog")
2394 {
2395 nlohmann::json::object_t member;
Ed Tanous253f11b2024-05-16 09:38:31 -07002396 member["@odata.id"] = boost::urls::format(
2397 "/redfish/v1/Managers/{}/LogServices/FaultLog",
2398 BMCWEB_REDFISH_MANAGER_URI_NAME);
Ed Tanous25b54db2024-04-17 15:40:31 -07002399 logServiceArrayLocal.emplace_back(std::move(member));
2400 }
2401 }
2402
2403 asyncResp->res.jsonValue["Members@odata.count"] =
2404 logServiceArrayLocal.size();
2405 });
2406 }
Claire Weinanfdd26902022-03-01 14:18:25 -08002407}
2408
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002409inline void requestRoutesBMCLogServiceCollection(App& app)
2410{
Ed Tanous253f11b2024-05-16 09:38:31 -07002411 BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/")
Gunnar Millsad89dcf2021-07-30 14:40:11 -05002412 .privileges(redfish::privileges::getLogServiceCollection)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002413 .methods(boost::beast::http::verb::get)(
Claire Weinandd72e872022-08-15 14:20:06 -07002414 std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002415}
Ed Tanous1da66f72018-07-27 16:13:37 -07002416
Claire Weinanfdd26902022-03-01 14:18:25 -08002417inline void
2418 getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2419 const std::string& dumpType)
2420{
2421 std::string dumpPath;
Ed Tanous539d8c62024-06-19 14:38:27 -07002422 log_service::OverWritePolicy overWritePolicy =
2423 log_service::OverWritePolicy::Invalid;
Claire Weinanfdd26902022-03-01 14:18:25 -08002424 bool collectDiagnosticDataSupported = false;
2425
2426 if (dumpType == "BMC")
2427 {
Ed Tanous253f11b2024-05-16 09:38:31 -07002428 dumpPath = std::format("/redfish/v1/Managers/{}/LogServices/Dump",
2429 BMCWEB_REDFISH_MANAGER_URI_NAME);
Ed Tanous539d8c62024-06-19 14:38:27 -07002430 overWritePolicy = log_service::OverWritePolicy::WrapsWhenFull;
Claire Weinanfdd26902022-03-01 14:18:25 -08002431 collectDiagnosticDataSupported = true;
2432 }
2433 else if (dumpType == "FaultLog")
2434 {
Ed Tanous253f11b2024-05-16 09:38:31 -07002435 dumpPath = std::format("/redfish/v1/Managers/{}/LogServices/FaultLog",
2436 BMCWEB_REDFISH_MANAGER_URI_NAME);
Ed Tanous539d8c62024-06-19 14:38:27 -07002437 overWritePolicy = log_service::OverWritePolicy::Unknown;
Claire Weinanfdd26902022-03-01 14:18:25 -08002438 collectDiagnosticDataSupported = false;
2439 }
2440 else if (dumpType == "System")
2441 {
Ed Tanous253f11b2024-05-16 09:38:31 -07002442 dumpPath = std::format("/redfish/v1/Systems/{}/LogServices/Dump",
2443 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous539d8c62024-06-19 14:38:27 -07002444 overWritePolicy = log_service::OverWritePolicy::WrapsWhenFull;
Claire Weinanfdd26902022-03-01 14:18:25 -08002445 collectDiagnosticDataSupported = true;
2446 }
2447 else
2448 {
Ed Tanous62598e32023-07-17 17:06:25 -07002449 BMCWEB_LOG_ERROR("getDumpServiceInfo() invalid dump type: {}",
2450 dumpType);
Claire Weinanfdd26902022-03-01 14:18:25 -08002451 messages::internalError(asyncResp->res);
2452 return;
2453 }
2454
2455 asyncResp->res.jsonValue["@odata.id"] = dumpPath;
2456 asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService";
2457 asyncResp->res.jsonValue["Name"] = "Dump LogService";
2458 asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService";
2459 asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename();
Ed Tanous539d8c62024-06-19 14:38:27 -07002460 asyncResp->res.jsonValue["OverWritePolicy"] = overWritePolicy;
Claire Weinanfdd26902022-03-01 14:18:25 -08002461
2462 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07002463 redfish::time_utils::getDateTimeOffsetNow();
Claire Weinanfdd26902022-03-01 14:18:25 -08002464 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
2465 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
2466 redfishDateTimeOffset.second;
2467
2468 asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries";
Claire Weinanfdd26902022-03-01 14:18:25 -08002469
2470 if (collectDiagnosticDataSupported)
2471 {
2472 asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
2473 ["target"] =
2474 dumpPath + "/Actions/LogService.CollectDiagnosticData";
2475 }
Claire Weinan0d946212022-07-13 19:40:19 -07002476
2477 constexpr std::array<std::string_view, 1> interfaces = {deleteAllInterface};
2478 dbus::utility::getSubTreePaths(
2479 "/xyz/openbmc_project/dump", 0, interfaces,
2480 [asyncResp, dumpType, dumpPath](
2481 const boost::system::error_code& ec,
2482 const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) {
2483 if (ec)
2484 {
Ed Tanous62598e32023-07-17 17:06:25 -07002485 BMCWEB_LOG_ERROR("getDumpServiceInfo respHandler got error {}", ec);
Claire Weinan0d946212022-07-13 19:40:19 -07002486 // Assume that getting an error simply means there are no dump
2487 // LogServices. Return without adding any error response.
2488 return;
2489 }
Ed Tanous18f8f602023-07-18 10:07:23 -07002490 std::string dbusDumpPath = getDumpPath(dumpType);
Claire Weinan0d946212022-07-13 19:40:19 -07002491 for (const std::string& path : subTreePaths)
2492 {
2493 if (path == dbusDumpPath)
2494 {
2495 asyncResp->res
2496 .jsonValue["Actions"]["#LogService.ClearLog"]["target"] =
2497 dumpPath + "/Actions/LogService.ClearLog";
2498 break;
2499 }
2500 }
Patrick Williams5a39f772023-10-20 11:20:21 -05002501 });
Claire Weinanfdd26902022-03-01 14:18:25 -08002502}
2503
2504inline void handleLogServicesDumpServiceGet(
2505 crow::App& app, const std::string& dumpType, const crow::Request& req,
Ed Tanous253f11b2024-05-16 09:38:31 -07002506 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2507 const std::string& managerId)
Claire Weinanfdd26902022-03-01 14:18:25 -08002508{
2509 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2510 {
2511 return;
2512 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002513
2514 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2515 {
2516 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2517 return;
2518 }
2519
Claire Weinanfdd26902022-03-01 14:18:25 -08002520 getDumpServiceInfo(asyncResp, dumpType);
2521}
2522
Ed Tanous22d268c2022-05-19 09:39:07 -07002523inline void handleLogServicesDumpServiceComputerSystemGet(
2524 crow::App& app, const crow::Request& req,
2525 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2526 const std::string& chassisId)
2527{
2528 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2529 {
2530 return;
2531 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002532 if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002533 {
2534 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2535 return;
2536 }
2537 getDumpServiceInfo(asyncResp, "System");
2538}
2539
Claire Weinanfdd26902022-03-01 14:18:25 -08002540inline void handleLogServicesDumpEntriesCollectionGet(
2541 crow::App& app, const std::string& dumpType, const crow::Request& req,
Ed Tanous253f11b2024-05-16 09:38:31 -07002542 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2543 const std::string& managerId)
Claire Weinanfdd26902022-03-01 14:18:25 -08002544{
2545 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2546 {
2547 return;
2548 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002549
2550 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2551 {
2552 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2553 return;
2554 }
Claire Weinanfdd26902022-03-01 14:18:25 -08002555 getDumpEntryCollection(asyncResp, dumpType);
2556}
2557
Ed Tanous22d268c2022-05-19 09:39:07 -07002558inline void handleLogServicesDumpEntriesCollectionComputerSystemGet(
2559 crow::App& app, const crow::Request& req,
2560 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2561 const std::string& chassisId)
2562{
2563 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2564 {
2565 return;
2566 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002567 if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002568 {
2569 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2570 return;
2571 }
2572 getDumpEntryCollection(asyncResp, "System");
2573}
2574
Claire Weinanfdd26902022-03-01 14:18:25 -08002575inline void handleLogServicesDumpEntryGet(
2576 crow::App& app, const std::string& dumpType, const crow::Request& req,
2577 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous253f11b2024-05-16 09:38:31 -07002578 const std::string& managerId, const std::string& dumpId)
Claire Weinanfdd26902022-03-01 14:18:25 -08002579{
2580 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2581 {
2582 return;
2583 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002584 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2585 {
2586 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2587 return;
2588 }
Claire Weinanfdd26902022-03-01 14:18:25 -08002589 getDumpEntryById(asyncResp, dumpId, dumpType);
2590}
Carson Labrado168d1b12023-03-27 17:04:46 +00002591
Ed Tanous22d268c2022-05-19 09:39:07 -07002592inline void handleLogServicesDumpEntryComputerSystemGet(
2593 crow::App& app, const crow::Request& req,
2594 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2595 const std::string& chassisId, const std::string& dumpId)
2596{
2597 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2598 {
2599 return;
2600 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002601 if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002602 {
2603 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2604 return;
2605 }
2606 getDumpEntryById(asyncResp, dumpId, "System");
2607}
Claire Weinanfdd26902022-03-01 14:18:25 -08002608
2609inline void handleLogServicesDumpEntryDelete(
2610 crow::App& app, const std::string& dumpType, const crow::Request& req,
2611 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous253f11b2024-05-16 09:38:31 -07002612 const std::string& managerId, const std::string& dumpId)
Claire Weinanfdd26902022-03-01 14:18:25 -08002613{
2614 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2615 {
2616 return;
2617 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002618
2619 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2620 {
2621 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2622 return;
2623 }
Claire Weinanfdd26902022-03-01 14:18:25 -08002624 deleteDumpEntry(asyncResp, dumpId, dumpType);
2625}
2626
Ed Tanous22d268c2022-05-19 09:39:07 -07002627inline void handleLogServicesDumpEntryComputerSystemDelete(
2628 crow::App& app, const crow::Request& req,
2629 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2630 const std::string& chassisId, const std::string& dumpId)
2631{
2632 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2633 {
2634 return;
2635 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002636 if (chassisId != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002637 {
2638 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2639 return;
2640 }
2641 deleteDumpEntry(asyncResp, dumpId, "System");
2642}
2643
Carson Labrado168d1b12023-03-27 17:04:46 +00002644inline void handleLogServicesDumpEntryDownloadGet(
2645 crow::App& app, const std::string& dumpType, const crow::Request& req,
2646 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous253f11b2024-05-16 09:38:31 -07002647 const std::string& managerId, const std::string& dumpId)
Carson Labrado168d1b12023-03-27 17:04:46 +00002648{
2649 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2650 {
2651 return;
2652 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002653
2654 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2655 {
2656 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2657 return;
2658 }
Carson Labrado168d1b12023-03-27 17:04:46 +00002659 downloadDumpEntry(asyncResp, dumpId, dumpType);
2660}
2661
2662inline void handleDBusEventLogEntryDownloadGet(
2663 crow::App& app, const std::string& dumpType, const crow::Request& req,
2664 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2665 const std::string& systemName, const std::string& entryID)
2666{
2667 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2668 {
2669 return;
2670 }
2671 if (!http_helpers::isContentTypeAllowed(
2672 req.getHeaderValue("Accept"),
2673 http_helpers::ContentType::OctetStream, true))
2674 {
2675 asyncResp->res.result(boost::beast::http::status::bad_request);
2676 return;
2677 }
2678 downloadEventLogEntry(asyncResp, systemName, entryID, dumpType);
2679}
2680
Claire Weinanfdd26902022-03-01 14:18:25 -08002681inline void handleLogServicesDumpCollectDiagnosticDataPost(
2682 crow::App& app, const std::string& dumpType, const crow::Request& req,
Ed Tanous253f11b2024-05-16 09:38:31 -07002683 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2684 const std::string& managerId)
Claire Weinanfdd26902022-03-01 14:18:25 -08002685{
2686 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2687 {
2688 return;
2689 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002690 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2691 {
2692 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2693 return;
2694 }
2695
Claire Weinanfdd26902022-03-01 14:18:25 -08002696 createDump(asyncResp, req, dumpType);
2697}
2698
Ed Tanous22d268c2022-05-19 09:39:07 -07002699inline void handleLogServicesDumpCollectDiagnosticDataComputerSystemPost(
2700 crow::App& app, const crow::Request& req,
2701 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002702 const std::string& systemName)
Ed Tanous22d268c2022-05-19 09:39:07 -07002703{
2704 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2705 {
2706 return;
2707 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002708
Ed Tanous25b54db2024-04-17 15:40:31 -07002709 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous22d268c2022-05-19 09:39:07 -07002710 {
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002711 // Option currently returns no systems. TBD
2712 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2713 systemName);
2714 return;
2715 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002716 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002717 {
2718 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2719 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07002720 return;
2721 }
2722 createDump(asyncResp, req, "System");
2723}
2724
Claire Weinanfdd26902022-03-01 14:18:25 -08002725inline void handleLogServicesDumpClearLogPost(
2726 crow::App& app, const std::string& dumpType, const crow::Request& req,
Ed Tanous253f11b2024-05-16 09:38:31 -07002727 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2728 const std::string& managerId)
Claire Weinanfdd26902022-03-01 14:18:25 -08002729{
2730 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2731 {
2732 return;
2733 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002734
2735 if (managerId != BMCWEB_REDFISH_MANAGER_URI_NAME)
2736 {
2737 messages::resourceNotFound(asyncResp->res, "Manager", managerId);
2738 return;
2739 }
Claire Weinanfdd26902022-03-01 14:18:25 -08002740 clearDump(asyncResp, dumpType);
2741}
2742
Ed Tanous22d268c2022-05-19 09:39:07 -07002743inline void handleLogServicesDumpClearLogComputerSystemPost(
2744 crow::App& app, const crow::Request& req,
2745 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002746 const std::string& systemName)
Ed Tanous22d268c2022-05-19 09:39:07 -07002747{
2748 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2749 {
2750 return;
2751 }
Ed Tanous25b54db2024-04-17 15:40:31 -07002752 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous22d268c2022-05-19 09:39:07 -07002753 {
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002754 // Option currently returns no systems. TBD
2755 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2756 systemName);
2757 return;
2758 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002759 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002760 {
2761 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2762 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07002763 return;
2764 }
2765 clearDump(asyncResp, "System");
2766}
2767
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002768inline void requestRoutesBMCDumpService(App& app)
2769{
Ed Tanous253f11b2024-05-16 09:38:31 -07002770 BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/Dump/")
Ed Tanoused398212021-06-09 17:05:54 -07002771 .privileges(redfish::privileges::getLogService)
Claire Weinanfdd26902022-03-01 14:18:25 -08002772 .methods(boost::beast::http::verb::get)(std::bind_front(
2773 handleLogServicesDumpServiceGet, std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002774}
2775
2776inline void requestRoutesBMCDumpEntryCollection(App& app)
2777{
Ed Tanous253f11b2024-05-16 09:38:31 -07002778 BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07002779 .privileges(redfish::privileges::getLogEntryCollection)
Claire Weinanfdd26902022-03-01 14:18:25 -08002780 .methods(boost::beast::http::verb::get)(std::bind_front(
2781 handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002782}
2783
2784inline void requestRoutesBMCDumpEntry(App& app)
2785{
2786 BMCWEB_ROUTE(app,
Ed Tanous253f11b2024-05-16 09:38:31 -07002787 "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002788 .privileges(redfish::privileges::getLogEntry)
Claire Weinanfdd26902022-03-01 14:18:25 -08002789 .methods(boost::beast::http::verb::get)(std::bind_front(
2790 handleLogServicesDumpEntryGet, std::ref(app), "BMC"));
2791
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002792 BMCWEB_ROUTE(app,
Ed Tanous253f11b2024-05-16 09:38:31 -07002793 "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002794 .privileges(redfish::privileges::deleteLogEntry)
Claire Weinanfdd26902022-03-01 14:18:25 -08002795 .methods(boost::beast::http::verb::delete_)(std::bind_front(
2796 handleLogServicesDumpEntryDelete, std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002797}
2798
Carson Labrado168d1b12023-03-27 17:04:46 +00002799inline void requestRoutesBMCDumpEntryDownload(App& app)
2800{
2801 BMCWEB_ROUTE(
2802 app,
Ed Tanous253f11b2024-05-16 09:38:31 -07002803 "/redfish/v1/Managers/<str>/LogServices/Dump/Entries/<str>/attachment/")
Carson Labrado168d1b12023-03-27 17:04:46 +00002804 .privileges(redfish::privileges::getLogEntry)
2805 .methods(boost::beast::http::verb::get)(std::bind_front(
2806 handleLogServicesDumpEntryDownloadGet, std::ref(app), "BMC"));
2807}
2808
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002809inline void requestRoutesBMCDumpCreate(App& app)
2810{
George Liu0fda0f12021-11-16 10:06:17 +08002811 BMCWEB_ROUTE(
2812 app,
Ed Tanous253f11b2024-05-16 09:38:31 -07002813 "/redfish/v1/Managers/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
Ed Tanoused398212021-06-09 17:05:54 -07002814 .privileges(redfish::privileges::postLogService)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002815 .methods(boost::beast::http::verb::post)(
Claire Weinanfdd26902022-03-01 14:18:25 -08002816 std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost,
2817 std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002818}
2819
2820inline void requestRoutesBMCDumpClear(App& app)
2821{
George Liu0fda0f12021-11-16 10:06:17 +08002822 BMCWEB_ROUTE(
2823 app,
Ed Tanous253f11b2024-05-16 09:38:31 -07002824 "/redfish/v1/Managers/<str>/LogServices/Dump/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07002825 .privileges(redfish::privileges::postLogService)
Claire Weinanfdd26902022-03-01 14:18:25 -08002826 .methods(boost::beast::http::verb::post)(std::bind_front(
2827 handleLogServicesDumpClearLogPost, std::ref(app), "BMC"));
2828}
2829
Carson Labrado168d1b12023-03-27 17:04:46 +00002830inline void requestRoutesDBusEventLogEntryDownload(App& app)
2831{
2832 BMCWEB_ROUTE(
2833 app,
Ravi Teja9e9d99d2023-11-08 05:33:59 -06002834 "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/attachment/")
Carson Labrado168d1b12023-03-27 17:04:46 +00002835 .privileges(redfish::privileges::getLogEntry)
2836 .methods(boost::beast::http::verb::get)(std::bind_front(
2837 handleDBusEventLogEntryDownloadGet, std::ref(app), "System"));
2838}
2839
Claire Weinanfdd26902022-03-01 14:18:25 -08002840inline void requestRoutesFaultLogDumpService(App& app)
2841{
Ed Tanous253f11b2024-05-16 09:38:31 -07002842 BMCWEB_ROUTE(app, "/redfish/v1/Managers/<str>/LogServices/FaultLog/")
Claire Weinanfdd26902022-03-01 14:18:25 -08002843 .privileges(redfish::privileges::getLogService)
2844 .methods(boost::beast::http::verb::get)(std::bind_front(
2845 handleLogServicesDumpServiceGet, std::ref(app), "FaultLog"));
2846}
2847
2848inline void requestRoutesFaultLogDumpEntryCollection(App& app)
2849{
Ed Tanous253f11b2024-05-16 09:38:31 -07002850 BMCWEB_ROUTE(app,
2851 "/redfish/v1/Managers/<str>/LogServices/FaultLog/Entries/")
Claire Weinanfdd26902022-03-01 14:18:25 -08002852 .privileges(redfish::privileges::getLogEntryCollection)
2853 .methods(boost::beast::http::verb::get)(
2854 std::bind_front(handleLogServicesDumpEntriesCollectionGet,
2855 std::ref(app), "FaultLog"));
2856}
2857
2858inline void requestRoutesFaultLogDumpEntry(App& app)
2859{
Ed Tanous253f11b2024-05-16 09:38:31 -07002860 BMCWEB_ROUTE(
2861 app, "/redfish/v1/Managers/<str>/LogServices/FaultLog/Entries/<str>/")
Claire Weinanfdd26902022-03-01 14:18:25 -08002862 .privileges(redfish::privileges::getLogEntry)
2863 .methods(boost::beast::http::verb::get)(std::bind_front(
2864 handleLogServicesDumpEntryGet, std::ref(app), "FaultLog"));
2865
Ed Tanous253f11b2024-05-16 09:38:31 -07002866 BMCWEB_ROUTE(
2867 app, "/redfish/v1/Managers/<str>/LogServices/FaultLog/Entries/<str>/")
Claire Weinanfdd26902022-03-01 14:18:25 -08002868 .privileges(redfish::privileges::deleteLogEntry)
2869 .methods(boost::beast::http::verb::delete_)(std::bind_front(
2870 handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog"));
2871}
2872
2873inline void requestRoutesFaultLogDumpClear(App& app)
2874{
2875 BMCWEB_ROUTE(
2876 app,
Ed Tanous253f11b2024-05-16 09:38:31 -07002877 "/redfish/v1/Managers/<str>/LogServices/FaultLog/Actions/LogService.ClearLog/")
Claire Weinanfdd26902022-03-01 14:18:25 -08002878 .privileges(redfish::privileges::postLogService)
2879 .methods(boost::beast::http::verb::post)(std::bind_front(
2880 handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002881}
2882
2883inline void requestRoutesSystemDumpService(App& app)
2884{
Ed Tanous22d268c2022-05-19 09:39:07 -07002885 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/")
Ed Tanoused398212021-06-09 17:05:54 -07002886 .privileges(redfish::privileges::getLogService)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07002887 .methods(boost::beast::http::verb::get)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07002888 handleLogServicesDumpServiceComputerSystemGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002889}
2890
2891inline void requestRoutesSystemDumpEntryCollection(App& app)
2892{
Ed Tanous22d268c2022-05-19 09:39:07 -07002893 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07002894 .privileges(redfish::privileges::getLogEntryCollection)
Ed Tanous22d268c2022-05-19 09:39:07 -07002895 .methods(boost::beast::http::verb::get)(std::bind_front(
2896 handleLogServicesDumpEntriesCollectionComputerSystemGet,
2897 std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002898}
2899
2900inline void requestRoutesSystemDumpEntry(App& app)
2901{
2902 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002903 "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002904 .privileges(redfish::privileges::getLogEntry)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07002905 .methods(boost::beast::http::verb::get)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07002906 handleLogServicesDumpEntryComputerSystemGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002907
2908 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002909 "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002910 .privileges(redfish::privileges::deleteLogEntry)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07002911 .methods(boost::beast::http::verb::delete_)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07002912 handleLogServicesDumpEntryComputerSystemDelete, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002913}
2914
2915inline void requestRoutesSystemDumpCreate(App& app)
2916{
George Liu0fda0f12021-11-16 10:06:17 +08002917 BMCWEB_ROUTE(
2918 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002919 "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
Ed Tanoused398212021-06-09 17:05:54 -07002920 .privileges(redfish::privileges::postLogService)
Ed Tanous22d268c2022-05-19 09:39:07 -07002921 .methods(boost::beast::http::verb::post)(std::bind_front(
2922 handleLogServicesDumpCollectDiagnosticDataComputerSystemPost,
2923 std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002924}
2925
2926inline void requestRoutesSystemDumpClear(App& app)
2927{
George Liu0fda0f12021-11-16 10:06:17 +08002928 BMCWEB_ROUTE(
2929 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002930 "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07002931 .privileges(redfish::privileges::postLogService)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07002932 .methods(boost::beast::http::verb::post)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07002933 handleLogServicesDumpClearLogComputerSystemPost, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002934}
2935
2936inline void requestRoutesCrashdumpService(App& app)
2937{
2938 // Note: Deviated from redfish privilege registry for GET & HEAD
2939 // method for security reasons.
2940 /**
2941 * Functions triggers appropriate requests on DBus
2942 */
Ed Tanous22d268c2022-05-19 09:39:07 -07002943 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/")
Ed Tanoused398212021-06-09 17:05:54 -07002944 // This is incorrect, should be:
2945 //.privileges(redfish::privileges::getLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07002946 .privileges({{"ConfigureManager"}})
Ed Tanous002d39b2022-05-31 08:59:27 -07002947 .methods(boost::beast::http::verb::get)(
2948 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07002949 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2950 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002951 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002952 {
2953 return;
2954 }
Ed Tanous25b54db2024-04-17 15:40:31 -07002955 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002956 {
2957 // Option currently returns no systems. TBD
2958 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2959 systemName);
2960 return;
2961 }
Ed Tanous253f11b2024-05-16 09:38:31 -07002962 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07002963 {
2964 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2965 systemName);
2966 return;
2967 }
2968
Ed Tanous002d39b2022-05-31 08:59:27 -07002969 // Copy over the static data to include the entries added by
2970 // SubRoute
2971 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07002972 std::format("/redfish/v1/Systems/{}/LogServices/Crashdump",
2973 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07002974 asyncResp->res.jsonValue["@odata.type"] =
2975 "#LogService.v1_2_0.LogService";
2976 asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
2977 asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
V-Sanjana15b89722023-05-11 16:27:03 +05302978 asyncResp->res.jsonValue["Id"] = "Crashdump";
Ed Tanous539d8c62024-06-19 14:38:27 -07002979 asyncResp->res.jsonValue["OverWritePolicy"] =
2980 log_service::OverWritePolicy::WrapsWhenFull;
Ed Tanous002d39b2022-05-31 08:59:27 -07002981 asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
Tejas Patil7c8c4052021-06-04 17:43:14 +05302982
Ed Tanous002d39b2022-05-31 08:59:27 -07002983 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07002984 redfish::time_utils::getDateTimeOffsetNow();
Ed Tanous002d39b2022-05-31 08:59:27 -07002985 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
2986 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
2987 redfishDateTimeOffset.second;
Tejas Patil7c8c4052021-06-04 17:43:14 +05302988
Ed Tanous002d39b2022-05-31 08:59:27 -07002989 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07002990 std::format("/redfish/v1/Systems/{}/LogServices/Crashdump/Entries",
2991 BMCWEB_REDFISH_SYSTEM_URI_NAME);
2992 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]
2993 ["target"] = std::format(
2994 "/redfish/v1/Systems/{}/LogServices/Crashdump/Actions/LogService.ClearLog",
2995 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07002996 asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
Ed Tanous253f11b2024-05-16 09:38:31 -07002997 ["target"] = std::format(
2998 "/redfish/v1/Systems/{}/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData",
2999 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Patrick Williams5a39f772023-10-20 11:20:21 -05003000 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003001}
3002
3003void inline requestRoutesCrashdumpClear(App& app)
3004{
George Liu0fda0f12021-11-16 10:06:17 +08003005 BMCWEB_ROUTE(
3006 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003007 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07003008 // This is incorrect, should be:
3009 //.privileges(redfish::privileges::postLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07003010 .privileges({{"ConfigureComponents"}})
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003011 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003012 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003013 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3014 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003015 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003016 {
3017 return;
3018 }
Ed Tanous25b54db2024-04-17 15:40:31 -07003019 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003020 {
3021 // Option currently returns no systems. TBD
3022 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3023 systemName);
3024 return;
3025 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003026 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003027 {
3028 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3029 systemName);
3030 return;
3031 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003032 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003033 [asyncResp](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003034 const std::string&) {
3035 if (ec)
3036 {
3037 messages::internalError(asyncResp->res);
3038 return;
3039 }
3040 messages::success(asyncResp->res);
Patrick Williams5a39f772023-10-20 11:20:21 -05003041 },
Ed Tanous002d39b2022-05-31 08:59:27 -07003042 crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll");
Patrick Williams5a39f772023-10-20 11:20:21 -05003043 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003044}
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07003045
zhanghch058d1b46d2021-04-01 11:18:24 +08003046static void
3047 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3048 const std::string& logID, nlohmann::json& logEntryJson)
Jason M. Billse855dd22019-10-08 11:37:48 -07003049{
Johnathan Mantey043a0532020-03-10 17:15:28 -07003050 auto getStoredLogCallback =
Ed Tanousb9d36b42022-02-26 21:42:46 -08003051 [asyncResp, logID,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003052 &logEntryJson](const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08003053 const dbus::utility::DBusPropertiesMap& params) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003054 if (ec)
3055 {
Ed Tanous62598e32023-07-17 17:06:25 -07003056 BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message());
Ed Tanous002d39b2022-05-31 08:59:27 -07003057 if (ec.value() ==
3058 boost::system::linux_error::bad_request_descriptor)
Jason M. Bills1ddcf012019-11-26 14:59:21 -08003059 {
Ed Tanous002d39b2022-05-31 08:59:27 -07003060 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Jason M. Bills2b20ef62022-01-06 15:48:07 -08003061 }
3062 else
3063 {
Ed Tanous002d39b2022-05-31 08:59:27 -07003064 messages::internalError(asyncResp->res);
Jason M. Bills2b20ef62022-01-06 15:48:07 -08003065 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003066 return;
3067 }
3068
3069 std::string timestamp{};
3070 std::string filename{};
3071 std::string logfile{};
3072 parseCrashdumpParameters(params, filename, timestamp, logfile);
3073
3074 if (filename.empty() || timestamp.empty())
3075 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003076 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003077 return;
3078 }
3079
3080 std::string crashdumpURI =
Ed Tanous253f11b2024-05-16 09:38:31 -07003081 std::format("/redfish/v1/Systems/{}/LogServices/Crashdump/Entries/",
3082 BMCWEB_REDFISH_SYSTEM_URI_NAME) +
Ed Tanous002d39b2022-05-31 08:59:27 -07003083 logID + "/" + filename;
Jason M. Bills84afc482022-06-24 12:38:23 -07003084 nlohmann::json::object_t logEntry;
Vijay Lobo9c11a172021-10-07 16:53:16 -05003085 logEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07003086 logEntry["@odata.id"] = boost::urls::format(
Ed Tanous253f11b2024-05-16 09:38:31 -07003087 "/redfish/v1/Systems/{}/LogServices/Crashdump/Entries/{}",
3088 BMCWEB_REDFISH_SYSTEM_URI_NAME, logID);
Jason M. Bills84afc482022-06-24 12:38:23 -07003089 logEntry["Name"] = "CPU Crashdump";
3090 logEntry["Id"] = logID;
Ed Tanous539d8c62024-06-19 14:38:27 -07003091 logEntry["EntryType"] = log_entry::LogEntryType::Oem;
Jason M. Bills84afc482022-06-24 12:38:23 -07003092 logEntry["AdditionalDataURI"] = std::move(crashdumpURI);
3093 logEntry["DiagnosticDataType"] = "OEM";
3094 logEntry["OEMDiagnosticDataType"] = "PECICrashdump";
3095 logEntry["Created"] = std::move(timestamp);
Ed Tanous002d39b2022-05-31 08:59:27 -07003096
3097 // If logEntryJson references an array of LogEntry resources
3098 // ('Members' list), then push this as a new entry, otherwise set it
3099 // directly
3100 if (logEntryJson.is_array())
3101 {
3102 logEntryJson.push_back(logEntry);
3103 asyncResp->res.jsonValue["Members@odata.count"] =
3104 logEntryJson.size();
3105 }
3106 else
3107 {
Jason M. Billsd405bb52022-06-24 10:52:05 -07003108 logEntryJson.update(logEntry);
Ed Tanous002d39b2022-05-31 08:59:27 -07003109 }
3110 };
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02003111 sdbusplus::asio::getAllProperties(
3112 *crow::connections::systemBus, crashdumpObject,
3113 crashdumpPath + std::string("/") + logID, crashdumpInterface,
3114 std::move(getStoredLogCallback));
Jason M. Billse855dd22019-10-08 11:37:48 -07003115}
3116
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003117inline void requestRoutesCrashdumpEntryCollection(App& app)
Ed Tanous1da66f72018-07-27 16:13:37 -07003118{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003119 // Note: Deviated from redfish privilege registry for GET & HEAD
3120 // method for security reasons.
Ed Tanous1da66f72018-07-27 16:13:37 -07003121 /**
3122 * Functions triggers appropriate requests on DBus
3123 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003124 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003125 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07003126 // This is incorrect, should be.
3127 //.privileges(redfish::privileges::postLogEntryCollection)
Ed Tanous432a8902021-06-14 15:28:56 -07003128 .privileges({{"ConfigureComponents"}})
Ed Tanous002d39b2022-05-31 08:59:27 -07003129 .methods(boost::beast::http::verb::get)(
3130 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003131 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3132 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003133 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003134 {
3135 return;
3136 }
Ed Tanous25b54db2024-04-17 15:40:31 -07003137 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003138 {
3139 // Option currently returns no systems. TBD
3140 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3141 systemName);
3142 return;
3143 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003144 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003145 {
3146 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3147 systemName);
3148 return;
3149 }
3150
George Liu7a1dbc42022-12-07 16:03:22 +08003151 constexpr std::array<std::string_view, 1> interfaces = {
3152 crashdumpInterface};
3153 dbus::utility::getSubTreePaths(
3154 "/", 0, interfaces,
3155 [asyncResp](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003156 const std::vector<std::string>& resp) {
3157 if (ec)
Ed Tanous45ca1b82022-03-25 13:07:27 -07003158 {
Ed Tanous002d39b2022-05-31 08:59:27 -07003159 if (ec.value() !=
3160 boost::system::errc::no_such_file_or_directory)
3161 {
Ed Tanous62598e32023-07-17 17:06:25 -07003162 BMCWEB_LOG_DEBUG("failed to get entries ec: {}",
3163 ec.message());
Ed Tanous002d39b2022-05-31 08:59:27 -07003164 messages::internalError(asyncResp->res);
3165 return;
3166 }
Ed Tanous45ca1b82022-03-25 13:07:27 -07003167 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003168 asyncResp->res.jsonValue["@odata.type"] =
3169 "#LogEntryCollection.LogEntryCollection";
Ed Tanous253f11b2024-05-16 09:38:31 -07003170 asyncResp->res.jsonValue["@odata.id"] = std::format(
3171 "/redfish/v1/Systems/{}/LogServices/Crashdump/Entries",
3172 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07003173 asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
3174 asyncResp->res.jsonValue["Description"] =
3175 "Collection of Crashdump Entries";
3176 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3177 asyncResp->res.jsonValue["Members@odata.count"] = 0;
Jason M. Bills2b20ef62022-01-06 15:48:07 -08003178
Ed Tanous002d39b2022-05-31 08:59:27 -07003179 for (const std::string& path : resp)
3180 {
3181 const sdbusplus::message::object_path objPath(path);
3182 // Get the log ID
3183 std::string logID = objPath.filename();
3184 if (logID.empty())
3185 {
3186 continue;
3187 }
3188 // Add the log entry to the array
3189 logCrashdumpEntry(asyncResp, logID,
3190 asyncResp->res.jsonValue["Members"]);
3191 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003192 });
Patrick Williams5a39f772023-10-20 11:20:21 -05003193 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003194}
Ed Tanous1da66f72018-07-27 16:13:37 -07003195
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003196inline void requestRoutesCrashdumpEntry(App& app)
Ed Tanous1da66f72018-07-27 16:13:37 -07003197{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003198 // Note: Deviated from redfish privilege registry for GET & HEAD
3199 // method for security reasons.
Ed Tanous1da66f72018-07-27 16:13:37 -07003200
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003201 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07003202 app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07003203 // this is incorrect, should be
3204 // .privileges(redfish::privileges::getLogEntry)
Ed Tanous432a8902021-06-14 15:28:56 -07003205 .privileges({{"ConfigureComponents"}})
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003206 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003207 [&app](const crow::Request& req,
3208 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07003209 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003210 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003211 {
3212 return;
3213 }
Ed Tanous25b54db2024-04-17 15:40:31 -07003214 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003215 {
3216 // Option currently returns no systems. TBD
3217 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3218 systemName);
3219 return;
3220 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003221 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003222 {
3223 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3224 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003225 return;
3226 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003227 const std::string& logID = param;
3228 logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
Patrick Williams5a39f772023-10-20 11:20:21 -05003229 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003230}
Ed Tanous1da66f72018-07-27 16:13:37 -07003231
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003232inline void requestRoutesCrashdumpFile(App& app)
3233{
3234 // Note: Deviated from redfish privilege registry for GET & HEAD
3235 // method for security reasons.
3236 BMCWEB_ROUTE(
3237 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003238 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07003239 .privileges(redfish::privileges::getLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003240 .methods(boost::beast::http::verb::get)(
Nan Zhoua4ce1142022-08-02 18:45:25 +00003241 [](const crow::Request& req,
3242 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07003243 const std::string& systemName, const std::string& logID,
3244 const std::string& fileName) {
Shounak Mitra2a9beee2022-07-20 18:41:30 +00003245 // Do not call getRedfishRoute here since the crashdump file is not a
3246 // Redfish resource.
Ed Tanous22d268c2022-05-19 09:39:07 -07003247
Ed Tanous25b54db2024-04-17 15:40:31 -07003248 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003249 {
3250 // Option currently returns no systems. TBD
3251 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3252 systemName);
3253 return;
3254 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003255 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003256 {
3257 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3258 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003259 return;
3260 }
3261
Ed Tanous002d39b2022-05-31 08:59:27 -07003262 auto getStoredLogCallback =
Ed Tanous39662a32023-02-06 15:09:46 -08003263 [asyncResp, logID, fileName, url(boost::urls::url(req.url()))](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003264 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003265 const std::vector<
3266 std::pair<std::string, dbus::utility::DbusVariantType>>&
3267 resp) {
3268 if (ec)
3269 {
Ed Tanous62598e32023-07-17 17:06:25 -07003270 BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message());
Ed Tanous002d39b2022-05-31 08:59:27 -07003271 messages::internalError(asyncResp->res);
3272 return;
3273 }
Jason M. Bills8e6c0992021-03-11 16:26:53 -08003274
Ed Tanous002d39b2022-05-31 08:59:27 -07003275 std::string dbusFilename{};
3276 std::string dbusTimestamp{};
3277 std::string dbusFilepath{};
Jason M. Bills8e6c0992021-03-11 16:26:53 -08003278
Ed Tanous002d39b2022-05-31 08:59:27 -07003279 parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp,
3280 dbusFilepath);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003281
Ed Tanous002d39b2022-05-31 08:59:27 -07003282 if (dbusFilename.empty() || dbusTimestamp.empty() ||
3283 dbusFilepath.empty())
3284 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003285 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003286 return;
3287 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003288
Ed Tanous002d39b2022-05-31 08:59:27 -07003289 // Verify the file name parameter is correct
3290 if (fileName != dbusFilename)
3291 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003292 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003293 return;
3294 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003295
Ed Tanous27b0cf92023-08-07 12:02:40 -07003296 if (!asyncResp->res.openFile(dbusFilepath))
Ed Tanous002d39b2022-05-31 08:59:27 -07003297 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003298 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003299 return;
3300 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003301
Ed Tanous002d39b2022-05-31 08:59:27 -07003302 // Configure this to be a file download when accessed
3303 // from a browser
Ed Tanousd9f6c622022-03-17 09:12:17 -07003304 asyncResp->res.addHeader(
3305 boost::beast::http::field::content_disposition, "attachment");
Ed Tanous002d39b2022-05-31 08:59:27 -07003306 };
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02003307 sdbusplus::asio::getAllProperties(
3308 *crow::connections::systemBus, crashdumpObject,
3309 crashdumpPath + std::string("/") + logID, crashdumpInterface,
3310 std::move(getStoredLogCallback));
Patrick Williams5a39f772023-10-20 11:20:21 -05003311 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003312}
3313
Jason M. Billsc5a4c822022-01-06 15:51:23 -08003314enum class OEMDiagnosticType
3315{
3316 onDemand,
3317 telemetry,
3318 invalid,
3319};
3320
Ed Tanous26ccae32023-02-16 10:28:44 -08003321inline OEMDiagnosticType getOEMDiagnosticType(std::string_view oemDiagStr)
Jason M. Billsc5a4c822022-01-06 15:51:23 -08003322{
3323 if (oemDiagStr == "OnDemand")
3324 {
3325 return OEMDiagnosticType::onDemand;
3326 }
3327 if (oemDiagStr == "Telemetry")
3328 {
3329 return OEMDiagnosticType::telemetry;
3330 }
3331
3332 return OEMDiagnosticType::invalid;
3333}
3334
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003335inline void requestRoutesCrashdumpCollect(App& app)
3336{
3337 // Note: Deviated from redfish privilege registry for GET & HEAD
3338 // method for security reasons.
George Liu0fda0f12021-11-16 10:06:17 +08003339 BMCWEB_ROUTE(
3340 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003341 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/")
Ed Tanoused398212021-06-09 17:05:54 -07003342 // The below is incorrect; Should be ConfigureManager
3343 //.privileges(redfish::privileges::postLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07003344 .privileges({{"ConfigureComponents"}})
Ed Tanous002d39b2022-05-31 08:59:27 -07003345 .methods(boost::beast::http::verb::post)(
3346 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003347 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3348 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003349 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003350 {
3351 return;
3352 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003353
Ed Tanous25b54db2024-04-17 15:40:31 -07003354 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003355 {
3356 // Option currently returns no systems. TBD
3357 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3358 systemName);
3359 return;
3360 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003361 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003362 {
3363 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3364 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003365 return;
3366 }
3367
Ed Tanous002d39b2022-05-31 08:59:27 -07003368 std::string diagnosticDataType;
3369 std::string oemDiagnosticDataType;
3370 if (!redfish::json_util::readJsonAction(
3371 req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
3372 "OEMDiagnosticDataType", oemDiagnosticDataType))
3373 {
3374 return;
3375 }
3376
3377 if (diagnosticDataType != "OEM")
3378 {
Ed Tanous62598e32023-07-17 17:06:25 -07003379 BMCWEB_LOG_ERROR(
3380 "Only OEM DiagnosticDataType supported for Crashdump");
Ed Tanous002d39b2022-05-31 08:59:27 -07003381 messages::actionParameterValueFormatError(
3382 asyncResp->res, diagnosticDataType, "DiagnosticDataType",
3383 "CollectDiagnosticData");
3384 return;
3385 }
3386
3387 OEMDiagnosticType oemDiagType =
3388 getOEMDiagnosticType(oemDiagnosticDataType);
3389
3390 std::string iface;
3391 std::string method;
3392 std::string taskMatchStr;
3393 if (oemDiagType == OEMDiagnosticType::onDemand)
3394 {
3395 iface = crashdumpOnDemandInterface;
3396 method = "GenerateOnDemandLog";
3397 taskMatchStr = "type='signal',"
3398 "interface='org.freedesktop.DBus.Properties',"
3399 "member='PropertiesChanged',"
3400 "arg0namespace='com.intel.crashdump'";
3401 }
3402 else if (oemDiagType == OEMDiagnosticType::telemetry)
3403 {
3404 iface = crashdumpTelemetryInterface;
3405 method = "GenerateTelemetryLog";
3406 taskMatchStr = "type='signal',"
3407 "interface='org.freedesktop.DBus.Properties',"
3408 "member='PropertiesChanged',"
3409 "arg0namespace='com.intel.crashdump'";
3410 }
3411 else
3412 {
Ed Tanous62598e32023-07-17 17:06:25 -07003413 BMCWEB_LOG_ERROR("Unsupported OEMDiagnosticDataType: {}",
3414 oemDiagnosticDataType);
Ed Tanous002d39b2022-05-31 08:59:27 -07003415 messages::actionParameterValueFormatError(
3416 asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType",
3417 "CollectDiagnosticData");
3418 return;
3419 }
3420
3421 auto collectCrashdumpCallback =
3422 [asyncResp, payload(task::Payload(req)),
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003423 taskMatchStr](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003424 const std::string&) mutable {
3425 if (ec)
Ed Tanous45ca1b82022-03-25 13:07:27 -07003426 {
Ed Tanous002d39b2022-05-31 08:59:27 -07003427 if (ec.value() == boost::system::errc::operation_not_supported)
3428 {
3429 messages::resourceInStandby(asyncResp->res);
3430 }
3431 else if (ec.value() ==
3432 boost::system::errc::device_or_resource_busy)
3433 {
3434 messages::serviceTemporarilyUnavailable(asyncResp->res,
3435 "60");
3436 }
3437 else
3438 {
3439 messages::internalError(asyncResp->res);
3440 }
Ed Tanous45ca1b82022-03-25 13:07:27 -07003441 return;
3442 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003443 std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
Ed Tanous8b242752023-06-27 17:17:13 -07003444 [](const boost::system::error_code& ec2, sdbusplus::message_t&,
Ed Tanous002d39b2022-05-31 08:59:27 -07003445 const std::shared_ptr<task::TaskData>& taskData) {
Ed Tanous8b242752023-06-27 17:17:13 -07003446 if (!ec2)
Ed Tanous002d39b2022-05-31 08:59:27 -07003447 {
3448 taskData->messages.emplace_back(messages::taskCompletedOK(
3449 std::to_string(taskData->index)));
3450 taskData->state = "Completed";
3451 }
3452 return task::completed;
Patrick Williams5a39f772023-10-20 11:20:21 -05003453 },
Ed Tanous002d39b2022-05-31 08:59:27 -07003454 taskMatchStr);
Ed Tanous1da66f72018-07-27 16:13:37 -07003455
Ed Tanous002d39b2022-05-31 08:59:27 -07003456 task->startTimer(std::chrono::minutes(5));
3457 task->populateResp(asyncResp->res);
3458 task->payload.emplace(std::move(payload));
3459 };
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003460
Ed Tanous002d39b2022-05-31 08:59:27 -07003461 crow::connections::systemBus->async_method_call(
3462 std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath,
3463 iface, method);
Patrick Williams5a39f772023-10-20 11:20:21 -05003464 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003465}
Kenny L. Ku6eda7682020-06-19 09:48:36 -07003466
Alexander Hansen599b9af2024-08-06 15:11:57 +02003467inline void dBusLogServiceActionsClear(
3468 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
3469{
3470 BMCWEB_LOG_DEBUG("Do delete all entries.");
3471
3472 // Process response from Logging service.
3473 auto respHandler = [asyncResp](const boost::system::error_code& ec) {
3474 BMCWEB_LOG_DEBUG("doClearLog resp_handler callback: Done");
3475 if (ec)
3476 {
3477 // TODO Handle for specific error code
3478 BMCWEB_LOG_ERROR("doClearLog resp_handler got error {}", ec);
3479 asyncResp->res.result(
3480 boost::beast::http::status::internal_server_error);
3481 return;
3482 }
3483
3484 asyncResp->res.result(boost::beast::http::status::no_content);
3485 };
3486
3487 // Make call to Logging service to request Clear Log
3488 crow::connections::systemBus->async_method_call(
3489 respHandler, "xyz.openbmc_project.Logging",
3490 "/xyz/openbmc_project/logging",
3491 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3492}
3493
Andrew Geisslercb92c032018-08-17 07:56:14 -07003494/**
3495 * DBusLogServiceActionsClear class supports POST method for ClearLog action.
3496 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003497inline void requestRoutesDBusLogServiceActionsClear(App& app)
Andrew Geisslercb92c032018-08-17 07:56:14 -07003498{
Andrew Geisslercb92c032018-08-17 07:56:14 -07003499 /**
3500 * Function handles POST method request.
3501 * The Clear Log actions does not require any parameter.The action deletes
3502 * all entries found in the Entries collection for this Log Service.
3503 */
Andrew Geisslercb92c032018-08-17 07:56:14 -07003504
George Liu0fda0f12021-11-16 10:06:17 +08003505 BMCWEB_ROUTE(
3506 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003507 "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07003508 .privileges(redfish::privileges::postLogService)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003509 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003510 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003511 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3512 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003513 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003514 {
3515 return;
3516 }
Ed Tanous25b54db2024-04-17 15:40:31 -07003517 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003518 {
3519 // Option currently returns no systems. TBD
3520 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3521 systemName);
3522 return;
3523 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003524 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003525 {
3526 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3527 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003528 return;
3529 }
Alexander Hansen599b9af2024-08-06 15:11:57 +02003530 dBusLogServiceActionsClear(asyncResp);
Patrick Williams5a39f772023-10-20 11:20:21 -05003531 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003532}
ZhikuiRena3316fc2020-01-29 14:58:08 -08003533
3534/****************************************************
3535 * Redfish PostCode interfaces
3536 * using DBUS interface: getPostCodesTS
3537 ******************************************************/
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003538inline void requestRoutesPostCodesLogService(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003539{
Ed Tanous22d268c2022-05-19 09:39:07 -07003540 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/")
Ed Tanoused398212021-06-09 17:05:54 -07003541 .privileges(redfish::privileges::getLogService)
Ed Tanous002d39b2022-05-31 08:59:27 -07003542 .methods(boost::beast::http::verb::get)(
3543 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003544 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3545 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003546 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003547 {
3548 return;
3549 }
Ed Tanous25b54db2024-04-17 15:40:31 -07003550 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003551 {
3552 // Option currently returns no systems. TBD
3553 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3554 systemName);
3555 return;
3556 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003557 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003558 {
3559 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3560 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003561 return;
3562 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003563 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07003564 std::format("/redfish/v1/Systems/{}/LogServices/PostCodes",
3565 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07003566 asyncResp->res.jsonValue["@odata.type"] =
Janet Adkinsb25644a2023-08-16 11:23:45 -05003567 "#LogService.v1_2_0.LogService";
Ed Tanous002d39b2022-05-31 08:59:27 -07003568 asyncResp->res.jsonValue["Name"] = "POST Code Log Service";
3569 asyncResp->res.jsonValue["Description"] = "POST Code Log Service";
Ed Tanoused34a4a2023-02-08 15:43:27 -08003570 asyncResp->res.jsonValue["Id"] = "PostCodes";
Ed Tanous539d8c62024-06-19 14:38:27 -07003571 asyncResp->res.jsonValue["OverWritePolicy"] =
3572 log_service::OverWritePolicy::WrapsWhenFull;
Ed Tanous002d39b2022-05-31 08:59:27 -07003573 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07003574 std::format("/redfish/v1/Systems/{}/LogServices/PostCodes/Entries",
3575 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Tejas Patil7c8c4052021-06-04 17:43:14 +05303576
Ed Tanous002d39b2022-05-31 08:59:27 -07003577 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07003578 redfish::time_utils::getDateTimeOffsetNow();
Ed Tanous002d39b2022-05-31 08:59:27 -07003579 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
3580 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
3581 redfishDateTimeOffset.second;
Tejas Patil7c8c4052021-06-04 17:43:14 +05303582
Ed Tanous20fa6a22024-05-20 18:02:58 -07003583 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]
3584 ["target"] = std::format(
3585 "/redfish/v1/Systems/{}/LogServices/PostCodes/Actions/LogService.ClearLog",
3586 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Patrick Williams5a39f772023-10-20 11:20:21 -05003587 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003588}
ZhikuiRena3316fc2020-01-29 14:58:08 -08003589
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003590inline void requestRoutesPostCodesClear(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003591{
George Liu0fda0f12021-11-16 10:06:17 +08003592 BMCWEB_ROUTE(
3593 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003594 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07003595 // The following privilege is incorrect; It should be ConfigureManager
3596 //.privileges(redfish::privileges::postLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07003597 .privileges({{"ConfigureComponents"}})
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003598 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003599 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003600 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3601 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003602 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003603 {
3604 return;
3605 }
Ed Tanous25b54db2024-04-17 15:40:31 -07003606 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003607 {
3608 // Option currently returns no systems. TBD
3609 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3610 systemName);
3611 return;
3612 }
Ed Tanous253f11b2024-05-16 09:38:31 -07003613 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003614 {
3615 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3616 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003617 return;
3618 }
Ed Tanous62598e32023-07-17 17:06:25 -07003619 BMCWEB_LOG_DEBUG("Do delete all postcodes entries.");
ZhikuiRena3316fc2020-01-29 14:58:08 -08003620
Ed Tanous002d39b2022-05-31 08:59:27 -07003621 // Make call to post-code service to request clear all
3622 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003623 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003624 if (ec)
3625 {
3626 // TODO Handle for specific error code
Ed Tanous62598e32023-07-17 17:06:25 -07003627 BMCWEB_LOG_ERROR("doClearPostCodes resp_handler got error {}",
3628 ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07003629 asyncResp->res.result(
3630 boost::beast::http::status::internal_server_error);
3631 messages::internalError(asyncResp->res);
3632 return;
3633 }
Tony Lee18fc70c2023-08-24 16:15:54 +08003634 messages::success(asyncResp->res);
Patrick Williams5a39f772023-10-20 11:20:21 -05003635 },
Ed Tanous002d39b2022-05-31 08:59:27 -07003636 "xyz.openbmc_project.State.Boot.PostCode0",
3637 "/xyz/openbmc_project/State/Boot/PostCode0",
3638 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
Patrick Williams5a39f772023-10-20 11:20:21 -05003639 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003640}
ZhikuiRena3316fc2020-01-29 14:58:08 -08003641
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003642/**
3643 * @brief Parse post code ID and get the current value and index value
3644 * eg: postCodeID=B1-2, currentValue=1, index=2
3645 *
3646 * @param[in] postCodeID Post Code ID
3647 * @param[out] currentValue Current value
3648 * @param[out] index Index value
3649 *
3650 * @return bool true if the parsing is successful, false the parsing fails
3651 */
Ed Tanous6f056f22024-04-07 13:35:51 -07003652inline bool parsePostCode(std::string_view postCodeID, uint64_t& currentValue,
Ed Tanousdf254f22024-04-01 13:25:46 -07003653 uint16_t& index)
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003654{
3655 std::vector<std::string> split;
Ed Tanous50ebd4a2023-01-19 19:03:17 -08003656 bmcweb::split(split, postCodeID, '-');
Ed Tanous6f056f22024-04-07 13:35:51 -07003657 if (split.size() != 2)
3658 {
3659 return false;
3660 }
3661 std::string_view postCodeNumber = split[0];
3662 if (postCodeNumber.size() < 2)
3663 {
3664 return false;
3665 }
3666 if (postCodeNumber[0] != 'B')
3667 {
3668 return false;
3669 }
3670 postCodeNumber.remove_prefix(1);
3671 auto [ptrIndex, ecIndex] = std::from_chars(postCodeNumber.begin(),
3672 postCodeNumber.end(), index);
3673 if (ptrIndex != postCodeNumber.end() || ecIndex != std::errc())
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003674 {
3675 return false;
3676 }
3677
Ed Tanous6f056f22024-04-07 13:35:51 -07003678 std::string_view postCodeIndex = split[1];
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003679
Ed Tanous6f056f22024-04-07 13:35:51 -07003680 auto [ptrValue, ecValue] = std::from_chars(
3681 postCodeIndex.begin(), postCodeIndex.end(), currentValue);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003682
Ed Tanous6f056f22024-04-07 13:35:51 -07003683 return ptrValue == postCodeIndex.end() && ecValue == std::errc();
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003684}
3685
3686static bool fillPostCodeEntry(
Ed Tanousac106bf2023-06-07 09:24:59 -07003687 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303688 const boost::container::flat_map<
3689 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode,
ZhikuiRena3316fc2020-01-29 14:58:08 -08003690 const uint16_t bootIndex, const uint64_t codeIndex = 0,
3691 const uint64_t skip = 0, const uint64_t top = 0)
3692{
3693 // Get the Message from the MessageRegistry
Ed Tanousfffb8c12022-02-07 23:53:03 -08003694 const registries::Message* message =
3695 registries::getMessage("OpenBMC.0.2.BIOSPOSTCode");
Ed Tanousdc8cfa62024-04-07 13:37:25 -07003696 if (message == nullptr)
3697 {
3698 BMCWEB_LOG_ERROR("Couldn't find known message?");
3699 return false;
3700 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003701 uint64_t currentCodeIndex = 0;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003702 uint64_t firstCodeTimeUs = 0;
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303703 for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
3704 code : postcode)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003705 {
3706 currentCodeIndex++;
3707 std::string postcodeEntryID =
3708 "B" + std::to_string(bootIndex) + "-" +
3709 std::to_string(currentCodeIndex); // 1 based index in EntryID string
3710
3711 uint64_t usecSinceEpoch = code.first;
3712 uint64_t usTimeOffset = 0;
3713
3714 if (1 == currentCodeIndex)
3715 { // already incremented
3716 firstCodeTimeUs = code.first;
3717 }
3718 else
3719 {
3720 usTimeOffset = code.first - firstCodeTimeUs;
3721 }
3722
3723 // skip if no specific codeIndex is specified and currentCodeIndex does
3724 // not fall between top and skip
3725 if ((codeIndex == 0) &&
3726 (currentCodeIndex <= skip || currentCodeIndex > top))
3727 {
3728 continue;
3729 }
3730
Gunnar Mills4e0453b2020-07-08 14:00:30 -05003731 // skip if a specific codeIndex is specified and does not match the
ZhikuiRena3316fc2020-01-29 14:58:08 -08003732 // currentIndex
3733 if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
3734 {
3735 // This is done for simplicity. 1st entry is needed to calculate
3736 // time offset. To improve efficiency, one can get to the entry
3737 // directly (possibly with flatmap's nth method)
3738 continue;
3739 }
3740
3741 // currentCodeIndex is within top and skip or equal to specified code
3742 // index
3743
3744 // Get the Created time from the timestamp
3745 std::string entryTimeStr;
Konstantin Aladyshev2a025612023-02-15 11:52:58 +03003746 entryTimeStr = redfish::time_utils::getDateTimeUintUs(usecSinceEpoch);
ZhikuiRena3316fc2020-01-29 14:58:08 -08003747
3748 // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
3749 std::ostringstream hexCode;
3750 hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303751 << std::get<0>(code.second);
ZhikuiRena3316fc2020-01-29 14:58:08 -08003752 std::ostringstream timeOffsetStr;
3753 // Set Fixed -Point Notation
3754 timeOffsetStr << std::fixed;
3755 // Set precision to 4 digits
3756 timeOffsetStr << std::setprecision(4);
3757 // Add double to stream
3758 timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003759
Ed Tanous1e6deaf2022-02-17 11:32:37 -08003760 std::string bootIndexStr = std::to_string(bootIndex);
3761 std::string timeOffsetString = timeOffsetStr.str();
3762 std::string hexCodeStr = hexCode.str();
3763
3764 std::array<std::string_view, 3> messageArgs = {
3765 bootIndexStr, timeOffsetString, hexCodeStr};
3766
3767 std::string msg =
3768 redfish::registries::fillMessageArgs(messageArgs, message->message);
3769 if (msg.empty())
ZhikuiRena3316fc2020-01-29 14:58:08 -08003770 {
Ed Tanous1e6deaf2022-02-17 11:32:37 -08003771 messages::internalError(asyncResp->res);
3772 return false;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003773 }
3774
Tim Leed4342a92020-04-27 11:47:58 +08003775 // Get Severity template from message registry
3776 std::string severity;
3777 if (message != nullptr)
3778 {
Ed Tanous5f2b84e2022-02-08 00:41:53 -08003779 severity = message->messageSeverity;
Tim Leed4342a92020-04-27 11:47:58 +08003780 }
3781
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003782 // Format entry
3783 nlohmann::json::object_t bmcLogEntry;
Vijay Lobo9c11a172021-10-07 16:53:16 -05003784 bmcLogEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07003785 bmcLogEntry["@odata.id"] = boost::urls::format(
Ed Tanous253f11b2024-05-16 09:38:31 -07003786 "/redfish/v1/Systems/{}/LogServices/PostCodes/Entries/{}",
3787 BMCWEB_REDFISH_SYSTEM_URI_NAME, postcodeEntryID);
Jason M. Bills84afc482022-06-24 12:38:23 -07003788 bmcLogEntry["Name"] = "POST Code Log Entry";
3789 bmcLogEntry["Id"] = postcodeEntryID;
3790 bmcLogEntry["Message"] = std::move(msg);
3791 bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode";
Ed Tanous1e6deaf2022-02-17 11:32:37 -08003792 bmcLogEntry["MessageArgs"] = messageArgs;
Jason M. Bills84afc482022-06-24 12:38:23 -07003793 bmcLogEntry["EntryType"] = "Event";
3794 bmcLogEntry["Severity"] = std::move(severity);
3795 bmcLogEntry["Created"] = entryTimeStr;
George Liu647b3cd2021-07-05 12:43:56 +08003796 if (!std::get<std::vector<uint8_t>>(code.second).empty())
3797 {
3798 bmcLogEntry["AdditionalDataURI"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07003799 std::format(
3800 "/redfish/v1/Systems/{}/LogServices/PostCodes/Entries/",
3801 BMCWEB_REDFISH_SYSTEM_URI_NAME) +
George Liu647b3cd2021-07-05 12:43:56 +08003802 postcodeEntryID + "/attachment";
3803 }
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003804
3805 // codeIndex is only specified when querying single entry, return only
3806 // that entry in this case
3807 if (codeIndex != 0)
3808 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003809 asyncResp->res.jsonValue.update(bmcLogEntry);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003810 return true;
3811 }
3812
Ed Tanousac106bf2023-06-07 09:24:59 -07003813 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
Patrick Williamsb2ba3072023-05-12 10:27:39 -05003814 logEntryArray.emplace_back(std::move(bmcLogEntry));
ZhikuiRena3316fc2020-01-29 14:58:08 -08003815 }
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003816
3817 // Return value is always false when querying multiple entries
3818 return false;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003819}
3820
Ed Tanousac106bf2023-06-07 09:24:59 -07003821static void
3822 getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3823 const std::string& entryId)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003824{
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003825 uint16_t bootIndex = 0;
3826 uint64_t codeIndex = 0;
3827 if (!parsePostCode(entryId, codeIndex, bootIndex))
3828 {
3829 // Requested ID was not found
Ed Tanousac106bf2023-06-07 09:24:59 -07003830 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003831 return;
3832 }
3833
3834 if (bootIndex == 0 || codeIndex == 0)
3835 {
3836 // 0 is an invalid index
Ed Tanousac106bf2023-06-07 09:24:59 -07003837 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003838 return;
3839 }
3840
ZhikuiRena3316fc2020-01-29 14:58:08 -08003841 crow::connections::systemBus->async_method_call(
Ed Tanousac106bf2023-06-07 09:24:59 -07003842 [asyncResp, entryId, bootIndex,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003843 codeIndex](const boost::system::error_code& ec,
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303844 const boost::container::flat_map<
3845 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
3846 postcode) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003847 if (ec)
3848 {
Ed Tanous62598e32023-07-17 17:06:25 -07003849 BMCWEB_LOG_DEBUG("DBUS POST CODE PostCode response error");
Ed Tanousac106bf2023-06-07 09:24:59 -07003850 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07003851 return;
3852 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003853
Ed Tanous002d39b2022-05-31 08:59:27 -07003854 if (postcode.empty())
3855 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003856 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Ed Tanous002d39b2022-05-31 08:59:27 -07003857 return;
3858 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003859
Ed Tanousac106bf2023-06-07 09:24:59 -07003860 if (!fillPostCodeEntry(asyncResp, postcode, bootIndex, codeIndex))
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003861 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003862 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003863 return;
3864 }
Patrick Williams5a39f772023-10-20 11:20:21 -05003865 },
Jonathan Doman15124762021-01-07 17:54:17 -08003866 "xyz.openbmc_project.State.Boot.PostCode0",
3867 "/xyz/openbmc_project/State/Boot/PostCode0",
ZhikuiRena3316fc2020-01-29 14:58:08 -08003868 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3869 bootIndex);
3870}
3871
Ed Tanousac106bf2023-06-07 09:24:59 -07003872static void
3873 getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3874 const uint16_t bootIndex, const uint16_t bootCount,
3875 const uint64_t entryCount, size_t skip, size_t top)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003876{
3877 crow::connections::systemBus->async_method_call(
Ed Tanousac106bf2023-06-07 09:24:59 -07003878 [asyncResp, bootIndex, bootCount, entryCount, skip,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003879 top](const boost::system::error_code& ec,
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303880 const boost::container::flat_map<
3881 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
3882 postcode) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003883 if (ec)
3884 {
Ed Tanous62598e32023-07-17 17:06:25 -07003885 BMCWEB_LOG_DEBUG("DBUS POST CODE PostCode response error");
Ed Tanousac106bf2023-06-07 09:24:59 -07003886 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07003887 return;
3888 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003889
Ed Tanous002d39b2022-05-31 08:59:27 -07003890 uint64_t endCount = entryCount;
3891 if (!postcode.empty())
3892 {
3893 endCount = entryCount + postcode.size();
Ed Tanous3648c8b2022-07-25 13:39:59 -07003894 if (skip < endCount && (top + skip) > entryCount)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003895 {
Patrick Williams89492a12023-05-10 07:51:34 -05003896 uint64_t thisBootSkip = std::max(static_cast<uint64_t>(skip),
3897 entryCount) -
3898 entryCount;
Ed Tanous002d39b2022-05-31 08:59:27 -07003899 uint64_t thisBootTop =
Ed Tanous3648c8b2022-07-25 13:39:59 -07003900 std::min(static_cast<uint64_t>(top + skip), endCount) -
3901 entryCount;
Ed Tanous002d39b2022-05-31 08:59:27 -07003902
Ed Tanousac106bf2023-06-07 09:24:59 -07003903 fillPostCodeEntry(asyncResp, postcode, bootIndex, 0,
3904 thisBootSkip, thisBootTop);
ZhikuiRena3316fc2020-01-29 14:58:08 -08003905 }
Ed Tanousac106bf2023-06-07 09:24:59 -07003906 asyncResp->res.jsonValue["Members@odata.count"] = endCount;
Ed Tanous002d39b2022-05-31 08:59:27 -07003907 }
3908
3909 // continue to previous bootIndex
3910 if (bootIndex < bootCount)
3911 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003912 getPostCodeForBoot(asyncResp, static_cast<uint16_t>(bootIndex + 1),
Ed Tanous002d39b2022-05-31 08:59:27 -07003913 bootCount, endCount, skip, top);
3914 }
Jiaqing Zhao81584ab2022-07-28 00:33:45 +08003915 else if (skip + top < endCount)
Ed Tanous002d39b2022-05-31 08:59:27 -07003916 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003917 asyncResp->res.jsonValue["Members@odata.nextLink"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07003918 std::format(
3919 "/redfish/v1/Systems/{}/LogServices/PostCodes/Entries?$skip=",
3920 BMCWEB_REDFISH_SYSTEM_URI_NAME) +
Ed Tanous002d39b2022-05-31 08:59:27 -07003921 std::to_string(skip + top);
3922 }
Patrick Williams5a39f772023-10-20 11:20:21 -05003923 },
Jonathan Doman15124762021-01-07 17:54:17 -08003924 "xyz.openbmc_project.State.Boot.PostCode0",
3925 "/xyz/openbmc_project/State/Boot/PostCode0",
ZhikuiRena3316fc2020-01-29 14:58:08 -08003926 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3927 bootIndex);
3928}
3929
zhanghch058d1b46d2021-04-01 11:18:24 +08003930static void
Ed Tanousac106bf2023-06-07 09:24:59 -07003931 getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous3648c8b2022-07-25 13:39:59 -07003932 size_t skip, size_t top)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003933{
3934 uint64_t entryCount = 0;
Jonathan Doman1e1e5982021-06-11 09:36:17 -07003935 sdbusplus::asio::getProperty<uint16_t>(
3936 *crow::connections::systemBus,
3937 "xyz.openbmc_project.State.Boot.PostCode0",
3938 "/xyz/openbmc_project/State/Boot/PostCode0",
3939 "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount",
Ed Tanousac106bf2023-06-07 09:24:59 -07003940 [asyncResp, entryCount, skip, top](const boost::system::error_code& ec,
3941 const uint16_t bootCount) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003942 if (ec)
3943 {
Ed Tanous62598e32023-07-17 17:06:25 -07003944 BMCWEB_LOG_DEBUG("DBUS response error {}", ec);
Ed Tanousac106bf2023-06-07 09:24:59 -07003945 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07003946 return;
3947 }
Ed Tanousac106bf2023-06-07 09:24:59 -07003948 getPostCodeForBoot(asyncResp, 1, bootCount, entryCount, skip, top);
Patrick Williams5a39f772023-10-20 11:20:21 -05003949 });
ZhikuiRena3316fc2020-01-29 14:58:08 -08003950}
3951
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003952inline void requestRoutesPostCodesEntryCollection(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003953{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003954 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003955 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07003956 .privileges(redfish::privileges::getLogEntryCollection)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003957 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003958 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003959 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3960 const std::string& systemName) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003961 query_param::QueryCapabilities capabilities = {
3962 .canDelegateTop = true,
3963 .canDelegateSkip = true,
3964 };
3965 query_param::Query delegatedQuery;
3966 if (!redfish::setUpRedfishRouteWithDelegation(
Carson Labrado3ba00072022-06-06 19:40:56 +00003967 app, req, asyncResp, delegatedQuery, capabilities))
Ed Tanous002d39b2022-05-31 08:59:27 -07003968 {
3969 return;
3970 }
Ed Tanous25b54db2024-04-17 15:40:31 -07003971 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003972 {
3973 // Option currently returns no systems. TBD
3974 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3975 systemName);
3976 return;
3977 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003978
Ed Tanous253f11b2024-05-16 09:38:31 -07003979 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07003980 {
3981 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3982 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003983 return;
3984 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003985 asyncResp->res.jsonValue["@odata.type"] =
3986 "#LogEntryCollection.LogEntryCollection";
3987 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous253f11b2024-05-16 09:38:31 -07003988 std::format("/redfish/v1/Systems/{}/LogServices/PostCodes/Entries",
3989 BMCWEB_REDFISH_SYSTEM_URI_NAME);
Ed Tanous002d39b2022-05-31 08:59:27 -07003990 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3991 asyncResp->res.jsonValue["Description"] =
3992 "Collection of POST Code Log Entries";
3993 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3994 asyncResp->res.jsonValue["Members@odata.count"] = 0;
Ed Tanous3648c8b2022-07-25 13:39:59 -07003995 size_t skip = delegatedQuery.skip.value_or(0);
Jiaqing Zhao5143f7a2022-07-22 09:33:33 +08003996 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
Ed Tanous3648c8b2022-07-25 13:39:59 -07003997 getCurrentBootNumber(asyncResp, skip, top);
Patrick Williams5a39f772023-10-20 11:20:21 -05003998 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003999}
ZhikuiRena3316fc2020-01-29 14:58:08 -08004000
George Liu647b3cd2021-07-05 12:43:56 +08004001inline void requestRoutesPostCodesEntryAdditionalData(App& app)
4002{
George Liu0fda0f12021-11-16 10:06:17 +08004003 BMCWEB_ROUTE(
4004 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07004005 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/attachment/")
George Liu647b3cd2021-07-05 12:43:56 +08004006 .privileges(redfish::privileges::getLogEntry)
4007 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07004008 [&app](const crow::Request& req,
4009 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07004010 const std::string& systemName,
Ed Tanous45ca1b82022-03-25 13:07:27 -07004011 const std::string& postCodeID) {
Carson Labrado3ba00072022-06-06 19:40:56 +00004012 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07004013 {
4014 return;
4015 }
Matt Spinler72e21372023-04-19 12:53:33 -05004016 if (!http_helpers::isContentTypeAllowed(
Ed Tanous99351cd2022-08-07 16:42:51 -07004017 req.getHeaderValue("Accept"),
Ed Tanous4a0e1a02022-09-21 15:28:04 -07004018 http_helpers::ContentType::OctetStream, true))
Ed Tanous002d39b2022-05-31 08:59:27 -07004019 {
4020 asyncResp->res.result(boost::beast::http::status::bad_request);
4021 return;
4022 }
Ed Tanous25b54db2024-04-17 15:40:31 -07004023 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08004024 {
4025 // Option currently returns no systems. TBD
4026 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
4027 systemName);
4028 return;
4029 }
Ed Tanous253f11b2024-05-16 09:38:31 -07004030 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07004031 {
4032 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
4033 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07004034 return;
4035 }
George Liu647b3cd2021-07-05 12:43:56 +08004036
Ed Tanous002d39b2022-05-31 08:59:27 -07004037 uint64_t currentValue = 0;
4038 uint16_t index = 0;
4039 if (!parsePostCode(postCodeID, currentValue, index))
4040 {
4041 messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID);
4042 return;
4043 }
George Liu647b3cd2021-07-05 12:43:56 +08004044
Ed Tanous002d39b2022-05-31 08:59:27 -07004045 crow::connections::systemBus->async_method_call(
4046 [asyncResp, postCodeID, currentValue](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08004047 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07004048 const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>&
4049 postcodes) {
4050 if (ec.value() == EBADR)
4051 {
4052 messages::resourceNotFound(asyncResp->res, "LogEntry",
4053 postCodeID);
4054 return;
4055 }
4056 if (ec)
4057 {
Ed Tanous62598e32023-07-17 17:06:25 -07004058 BMCWEB_LOG_DEBUG("DBUS response error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07004059 messages::internalError(asyncResp->res);
4060 return;
4061 }
George Liu647b3cd2021-07-05 12:43:56 +08004062
Ed Tanous002d39b2022-05-31 08:59:27 -07004063 size_t value = static_cast<size_t>(currentValue) - 1;
4064 if (value == std::string::npos || postcodes.size() < currentValue)
4065 {
Ed Tanous62598e32023-07-17 17:06:25 -07004066 BMCWEB_LOG_WARNING("Wrong currentValue value");
Ed Tanous002d39b2022-05-31 08:59:27 -07004067 messages::resourceNotFound(asyncResp->res, "LogEntry",
4068 postCodeID);
4069 return;
4070 }
George Liu647b3cd2021-07-05 12:43:56 +08004071
Ed Tanous002d39b2022-05-31 08:59:27 -07004072 const auto& [tID, c] = postcodes[value];
4073 if (c.empty())
4074 {
Ed Tanous62598e32023-07-17 17:06:25 -07004075 BMCWEB_LOG_WARNING("No found post code data");
Ed Tanous002d39b2022-05-31 08:59:27 -07004076 messages::resourceNotFound(asyncResp->res, "LogEntry",
4077 postCodeID);
4078 return;
4079 }
4080 // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
4081 const char* d = reinterpret_cast<const char*>(c.data());
4082 std::string_view strData(d, c.size());
George Liu647b3cd2021-07-05 12:43:56 +08004083
Ed Tanousd9f6c622022-03-17 09:12:17 -07004084 asyncResp->res.addHeader(boost::beast::http::field::content_type,
Ed Tanous002d39b2022-05-31 08:59:27 -07004085 "application/octet-stream");
Ed Tanousd9f6c622022-03-17 09:12:17 -07004086 asyncResp->res.addHeader(
4087 boost::beast::http::field::content_transfer_encoding, "Base64");
Ed Tanous27b0cf92023-08-07 12:02:40 -07004088 asyncResp->res.write(crow::utility::base64encode(strData));
Patrick Williams5a39f772023-10-20 11:20:21 -05004089 },
Ed Tanous002d39b2022-05-31 08:59:27 -07004090 "xyz.openbmc_project.State.Boot.PostCode0",
4091 "/xyz/openbmc_project/State/Boot/PostCode0",
4092 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index);
Patrick Williams5a39f772023-10-20 11:20:21 -05004093 });
George Liu647b3cd2021-07-05 12:43:56 +08004094}
4095
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004096inline void requestRoutesPostCodesEntry(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08004097{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004098 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07004099 app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07004100 .privileges(redfish::privileges::getLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004101 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07004102 [&app](const crow::Request& req,
4103 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07004104 const std::string& systemName, const std::string& targetID) {
Carson Labrado3ba00072022-06-06 19:40:56 +00004105 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07004106 {
4107 return;
4108 }
Ed Tanous25b54db2024-04-17 15:40:31 -07004109 if constexpr (BMCWEB_EXPERIMENTAL_REDFISH_MULTI_COMPUTER_SYSTEM)
Ed Tanous7f3e84a2022-12-28 16:22:54 -08004110 {
4111 // Option currently returns no systems. TBD
4112 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
4113 systemName);
4114 return;
4115 }
Ed Tanous253f11b2024-05-16 09:38:31 -07004116 if (systemName != BMCWEB_REDFISH_SYSTEM_URI_NAME)
Ed Tanous22d268c2022-05-19 09:39:07 -07004117 {
4118 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
4119 systemName);
4120 return;
4121 }
4122
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08004123 getPostCodeForEntry(asyncResp, targetID);
Patrick Williams5a39f772023-10-20 11:20:21 -05004124 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004125}
ZhikuiRena3316fc2020-01-29 14:58:08 -08004126
Ed Tanous1da66f72018-07-27 16:13:37 -07004127} // namespace redfish