blob: 9cb1fe0580641aa096acbd6bed453c8da95b6914 [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"
Spencer Kub7028eb2021-10-26 15:27:35 +080022#include "gzfile.hpp"
George Liu647b3cd2021-07-05 12:43:56 +080023#include "http_utility.hpp"
Spencer Kub7028eb2021-10-26 15:27:35 +080024#include "human_sort.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080025#include "query.hpp"
Jason M. Bills4851d452019-03-28 11:27:48 -070026#include "registries.hpp"
27#include "registries/base_message_registry.hpp"
28#include "registries/openbmc_message_registry.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080029#include "registries/privilege_registry.hpp"
James Feist46229572020-02-19 15:11:58 -080030#include "task.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080031#include "utils/dbus_utils.hpp"
32#include "utils/time_utils.hpp"
Ed Tanous1da66f72018-07-27 16:13:37 -070033
Jason M. Billse1f26342018-07-18 12:12:00 -070034#include <systemd/sd-journal.h>
Asmitha Karunanithi8e317782020-12-10 03:35:05 -060035#include <tinyxml2.h>
Adriana Kobylak400fd1f2021-01-29 09:01:30 -060036#include <unistd.h>
Jason M. Billse1f26342018-07-18 12:12:00 -070037
Ed Tanous9896eae2022-07-23 15:07:33 -070038#include <boost/algorithm/string/case_conv.hpp>
Ed Tanous11ba3972022-07-11 09:50:41 -070039#include <boost/algorithm/string/classification.hpp>
Adriana Kobylak400fd1f2021-01-29 09:01:30 -060040#include <boost/algorithm/string/replace.hpp>
Jason M. Bills4851d452019-03-28 11:27:48 -070041#include <boost/algorithm/string/split.hpp>
Ed Tanous07c8c202022-07-11 10:08:08 -070042#include <boost/beast/http/verb.hpp>
Ed Tanous1da66f72018-07-27 16:13:37 -070043#include <boost/container/flat_map.hpp>
Jason M. Bills1ddcf012019-11-26 14:59:21 -080044#include <boost/system/linux_error.hpp>
Ed Tanousef4c65b2023-04-24 15:28:50 -070045#include <boost/url/format.hpp>
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +020046#include <sdbusplus/asio/property.hpp>
47#include <sdbusplus/unpack_properties.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050048
George Liu7a1dbc42022-12-07 16:03:22 +080049#include <array>
George Liu647b3cd2021-07-05 12:43:56 +080050#include <charconv>
James Feist4418c7f2019-04-15 11:09:15 -070051#include <filesystem>
Xiaochao Ma75710de2021-01-21 17:56:02 +080052#include <optional>
Ed Tanous26702d02021-11-03 15:02:33 -070053#include <span>
Jason M. Billscd225da2019-05-08 15:31:57 -070054#include <string_view>
Ed Tanousabf2add2019-01-22 16:40:12 -080055#include <variant>
Ed Tanous1da66f72018-07-27 16:13:37 -070056
57namespace redfish
58{
59
Patrick Williams89492a12023-05-10 07:51:34 -050060constexpr const char* crashdumpObject = "com.intel.crashdump";
61constexpr const char* crashdumpPath = "/com/intel/crashdump";
62constexpr const char* crashdumpInterface = "com.intel.crashdump";
63constexpr const char* deleteAllInterface =
Jason M. Bills5b61b5e2019-10-16 10:59:02 -070064 "xyz.openbmc_project.Collection.DeleteAll";
Patrick Williams89492a12023-05-10 07:51:34 -050065constexpr const char* crashdumpOnDemandInterface =
Jason M. Bills424c4172019-03-21 13:50:33 -070066 "com.intel.crashdump.OnDemand";
Patrick Williams89492a12023-05-10 07:51:34 -050067constexpr const char* crashdumpTelemetryInterface =
Kenny L. Ku6eda7682020-06-19 09:48:36 -070068 "com.intel.crashdump.Telemetry";
Ed Tanous1da66f72018-07-27 16:13:37 -070069
Asmitha Karunanithi8e317782020-12-10 03:35:05 -060070enum class DumpCreationProgress
71{
72 DUMP_CREATE_SUCCESS,
73 DUMP_CREATE_FAILED,
74 DUMP_CREATE_INPROGRESS
75};
76
James Feistf6150402019-01-08 10:36:20 -080077namespace fs = std::filesystem;
Ed Tanous1da66f72018-07-27 16:13:37 -070078
Gunnar Mills1214b7e2020-06-04 10:11:30 -050079inline std::string translateSeverityDbusToRedfish(const std::string& s)
Andrew Geisslercb92c032018-08-17 07:56:14 -070080{
Ed Tanousd4d25792020-09-29 15:15:03 -070081 if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") ||
82 (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") ||
83 (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") ||
84 (s == "xyz.openbmc_project.Logging.Entry.Level.Error"))
Andrew Geisslercb92c032018-08-17 07:56:14 -070085 {
86 return "Critical";
87 }
Ed Tanous3174e4d2020-10-07 11:41:22 -070088 if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") ||
89 (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") ||
90 (s == "xyz.openbmc_project.Logging.Entry.Level.Notice"))
Andrew Geisslercb92c032018-08-17 07:56:14 -070091 {
92 return "OK";
93 }
Ed Tanous3174e4d2020-10-07 11:41:22 -070094 if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning")
Andrew Geisslercb92c032018-08-17 07:56:14 -070095 {
96 return "Warning";
97 }
98 return "";
99}
100
Abhishek Patel9017faf2021-09-14 22:48:55 -0500101inline std::optional<bool> getProviderNotifyAction(const std::string& notify)
102{
103 std::optional<bool> notifyAction;
104 if (notify == "xyz.openbmc_project.Logging.Entry.Notify.Notify")
105 {
106 notifyAction = true;
107 }
108 else if (notify == "xyz.openbmc_project.Logging.Entry.Notify.Inhibit")
109 {
110 notifyAction = false;
111 }
112
113 return notifyAction;
114}
115
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700116inline static int getJournalMetadata(sd_journal* journal,
Ed Tanous26ccae32023-02-16 10:28:44 -0800117 std::string_view field,
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700118 std::string_view& contents)
Jason M. Bills16428a12018-11-02 12:42:29 -0700119{
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500120 const char* data = nullptr;
Jason M. Bills16428a12018-11-02 12:42:29 -0700121 size_t length = 0;
122 int ret = 0;
123 // Get the metadata from the requested field of the journal entry
Ed Tanous46ff87b2022-01-07 09:25:51 -0800124 // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
125 const void** dataVoid = reinterpret_cast<const void**>(&data);
126
127 ret = sd_journal_get_data(journal, field.data(), dataVoid, &length);
Jason M. Bills16428a12018-11-02 12:42:29 -0700128 if (ret < 0)
129 {
130 return ret;
131 }
Ed Tanous39e77502019-03-04 17:35:53 -0800132 contents = std::string_view(data, length);
Jason M. Bills16428a12018-11-02 12:42:29 -0700133 // Only use the content after the "=" character.
Ed Tanous81ce6092020-12-17 16:54:55 +0000134 contents.remove_prefix(std::min(contents.find('=') + 1, contents.size()));
Jason M. Bills16428a12018-11-02 12:42:29 -0700135 return ret;
136}
137
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700138inline static int getJournalMetadata(sd_journal* journal,
Ed Tanous26ccae32023-02-16 10:28:44 -0800139 std::string_view field, const int& base,
140 long int& contents)
Jason M. Bills16428a12018-11-02 12:42:29 -0700141{
142 int ret = 0;
Ed Tanous39e77502019-03-04 17:35:53 -0800143 std::string_view metadata;
Jason M. Bills16428a12018-11-02 12:42:29 -0700144 // Get the metadata from the requested field of the journal entry
145 ret = getJournalMetadata(journal, field, metadata);
146 if (ret < 0)
147 {
148 return ret;
149 }
Ed Tanousb01bf292019-03-25 19:25:26 +0000150 contents = strtol(metadata.data(), nullptr, base);
Jason M. Bills16428a12018-11-02 12:42:29 -0700151 return ret;
152}
153
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700154inline static bool getEntryTimestamp(sd_journal* journal,
155 std::string& entryTimestamp)
ZhikuiRena3316fc2020-01-29 14:58:08 -0800156{
157 int ret = 0;
158 uint64_t timestamp = 0;
159 ret = sd_journal_get_realtime_usec(journal, &timestamp);
160 if (ret < 0)
161 {
Ed Tanous62598e32023-07-17 17:06:25 -0700162 BMCWEB_LOG_ERROR("Failed to read entry timestamp: {}", strerror(-ret));
ZhikuiRena3316fc2020-01-29 14:58:08 -0800163 return false;
164 }
Konstantin Aladysheve645c5e2023-02-17 13:09:53 +0300165 entryTimestamp = redfish::time_utils::getDateTimeUintUs(timestamp);
Asmitha Karunanithi9c620e22020-08-02 11:55:21 -0500166 return true;
ZhikuiRena3316fc2020-01-29 14:58:08 -0800167}
Ed Tanous50b8a432022-02-03 16:29:50 -0800168
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700169inline static bool getUniqueEntryID(sd_journal* journal, std::string& entryID,
170 const bool firstEntry = true)
Jason M. Bills16428a12018-11-02 12:42:29 -0700171{
172 int ret = 0;
173 static uint64_t prevTs = 0;
174 static int index = 0;
Jason M. Billse85d6b12019-07-29 17:01:15 -0700175 if (firstEntry)
176 {
177 prevTs = 0;
178 }
179
Jason M. Bills16428a12018-11-02 12:42:29 -0700180 // Get the entry timestamp
181 uint64_t curTs = 0;
182 ret = sd_journal_get_realtime_usec(journal, &curTs);
183 if (ret < 0)
184 {
Ed Tanous62598e32023-07-17 17:06:25 -0700185 BMCWEB_LOG_ERROR("Failed to read entry timestamp: {}", strerror(-ret));
Jason M. Bills16428a12018-11-02 12:42:29 -0700186 return false;
187 }
188 // If the timestamp isn't unique, increment the index
189 if (curTs == prevTs)
190 {
191 index++;
192 }
193 else
194 {
195 // Otherwise, reset it
196 index = 0;
197 }
198 // Save the timestamp
199 prevTs = curTs;
200
201 entryID = std::to_string(curTs);
202 if (index > 0)
203 {
204 entryID += "_" + std::to_string(index);
205 }
206 return true;
207}
208
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500209static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID,
Jason M. Billse85d6b12019-07-29 17:01:15 -0700210 const bool firstEntry = true)
Jason M. Bills95820182019-04-22 16:25:34 -0700211{
Ed Tanous271584a2019-07-09 16:24:22 -0700212 static time_t prevTs = 0;
Jason M. Bills95820182019-04-22 16:25:34 -0700213 static int index = 0;
Jason M. Billse85d6b12019-07-29 17:01:15 -0700214 if (firstEntry)
215 {
216 prevTs = 0;
217 }
218
Jason M. Bills95820182019-04-22 16:25:34 -0700219 // Get the entry timestamp
Ed Tanous271584a2019-07-09 16:24:22 -0700220 std::time_t curTs = 0;
Jason M. Bills95820182019-04-22 16:25:34 -0700221 std::tm timeStruct = {};
222 std::istringstream entryStream(logEntry);
223 if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
224 {
225 curTs = std::mktime(&timeStruct);
226 }
227 // If the timestamp isn't unique, increment the index
228 if (curTs == prevTs)
229 {
230 index++;
231 }
232 else
233 {
234 // Otherwise, reset it
235 index = 0;
236 }
237 // Save the timestamp
238 prevTs = curTs;
239
240 entryID = std::to_string(curTs);
241 if (index > 0)
242 {
243 entryID += "_" + std::to_string(index);
244 }
245 return true;
246}
247
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700248inline static bool
zhanghch058d1b46d2021-04-01 11:18:24 +0800249 getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
250 const std::string& entryID, uint64_t& timestamp,
251 uint64_t& index)
Jason M. Bills16428a12018-11-02 12:42:29 -0700252{
253 if (entryID.empty())
254 {
255 return false;
256 }
257 // Convert the unique ID back to a timestamp to find the entry
Ed Tanous39e77502019-03-04 17:35:53 -0800258 std::string_view tsStr(entryID);
Jason M. Bills16428a12018-11-02 12:42:29 -0700259
Ed Tanous81ce6092020-12-17 16:54:55 +0000260 auto underscorePos = tsStr.find('_');
Ed Tanous71d5d8d2022-01-25 11:04:33 -0800261 if (underscorePos != std::string_view::npos)
Jason M. Bills16428a12018-11-02 12:42:29 -0700262 {
263 // Timestamp has an index
264 tsStr.remove_suffix(tsStr.size() - underscorePos);
Ed Tanous39e77502019-03-04 17:35:53 -0800265 std::string_view indexStr(entryID);
Jason M. Bills16428a12018-11-02 12:42:29 -0700266 indexStr.remove_prefix(underscorePos + 1);
Patrick Williams84396af2023-05-11 11:47:45 -0500267 auto [ptr, ec] = std::from_chars(indexStr.begin(), indexStr.end(),
268 index);
Ed Tanousc0bd5e42021-09-13 17:00:19 -0700269 if (ec != std::errc())
Jason M. Bills16428a12018-11-02 12:42:29 -0700270 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +0800271 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
Jason M. Bills16428a12018-11-02 12:42:29 -0700272 return false;
273 }
274 }
275 // Timestamp has no index
Patrick Williams84396af2023-05-11 11:47:45 -0500276 auto [ptr, ec] = std::from_chars(tsStr.begin(), tsStr.end(), timestamp);
Ed Tanousc0bd5e42021-09-13 17:00:19 -0700277 if (ec != std::errc())
Jason M. Bills16428a12018-11-02 12:42:29 -0700278 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +0800279 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
Jason M. Bills16428a12018-11-02 12:42:29 -0700280 return false;
281 }
282 return true;
283}
284
Jason M. Bills95820182019-04-22 16:25:34 -0700285static bool
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500286 getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles)
Jason M. Bills95820182019-04-22 16:25:34 -0700287{
288 static const std::filesystem::path redfishLogDir = "/var/log";
289 static const std::string redfishLogFilename = "redfish";
290
291 // Loop through the directory looking for redfish log files
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500292 for (const std::filesystem::directory_entry& dirEnt :
Jason M. Bills95820182019-04-22 16:25:34 -0700293 std::filesystem::directory_iterator(redfishLogDir))
294 {
295 // If we find a redfish log file, save the path
296 std::string filename = dirEnt.path().filename();
Ed Tanous11ba3972022-07-11 09:50:41 -0700297 if (filename.starts_with(redfishLogFilename))
Jason M. Bills95820182019-04-22 16:25:34 -0700298 {
299 redfishLogFiles.emplace_back(redfishLogDir / filename);
300 }
301 }
302 // As the log files rotate, they are appended with a ".#" that is higher for
303 // the older logs. Since we don't expect more than 10 log files, we
304 // can just sort the list to get them in order from newest to oldest
305 std::sort(redfishLogFiles.begin(), redfishLogFiles.end());
306
307 return !redfishLogFiles.empty();
308}
309
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600310inline log_entry::OriginatorTypes
311 mapDbusOriginatorTypeToRedfish(const std::string& originatorType)
312{
313 if (originatorType ==
314 "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client")
315 {
316 return log_entry::OriginatorTypes::Client;
317 }
318 if (originatorType ==
319 "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Internal")
320 {
321 return log_entry::OriginatorTypes::Internal;
322 }
323 if (originatorType ==
324 "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.SupportingService")
325 {
326 return log_entry::OriginatorTypes::SupportingService;
327 }
328 return log_entry::OriginatorTypes::Invalid;
329}
330
Claire Weinanaefe3782022-07-15 19:17:19 -0700331inline void parseDumpEntryFromDbusObject(
Jiaqing Zhao2d613eb2022-08-15 16:03:00 +0800332 const dbus::utility::ManagedObjectType::value_type& object,
Claire Weinanc6fecda2022-07-15 10:43:25 -0700333 std::string& dumpStatus, uint64_t& size, uint64_t& timestampUs,
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600334 std::string& originatorId, log_entry::OriginatorTypes& originatorType,
Claire Weinanaefe3782022-07-15 19:17:19 -0700335 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
336{
337 for (const auto& interfaceMap : object.second)
338 {
339 if (interfaceMap.first == "xyz.openbmc_project.Common.Progress")
340 {
341 for (const auto& propertyMap : interfaceMap.second)
342 {
343 if (propertyMap.first == "Status")
344 {
345 const auto* status =
346 std::get_if<std::string>(&propertyMap.second);
347 if (status == nullptr)
348 {
349 messages::internalError(asyncResp->res);
350 break;
351 }
352 dumpStatus = *status;
353 }
354 }
355 }
356 else if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
357 {
358 for (const auto& propertyMap : interfaceMap.second)
359 {
360 if (propertyMap.first == "Size")
361 {
362 const auto* sizePtr =
363 std::get_if<uint64_t>(&propertyMap.second);
364 if (sizePtr == nullptr)
365 {
366 messages::internalError(asyncResp->res);
367 break;
368 }
369 size = *sizePtr;
370 break;
371 }
372 }
373 }
374 else if (interfaceMap.first == "xyz.openbmc_project.Time.EpochTime")
375 {
376 for (const auto& propertyMap : interfaceMap.second)
377 {
378 if (propertyMap.first == "Elapsed")
379 {
380 const uint64_t* usecsTimeStamp =
381 std::get_if<uint64_t>(&propertyMap.second);
382 if (usecsTimeStamp == nullptr)
383 {
384 messages::internalError(asyncResp->res);
385 break;
386 }
Claire Weinanc6fecda2022-07-15 10:43:25 -0700387 timestampUs = *usecsTimeStamp;
Claire Weinanaefe3782022-07-15 19:17:19 -0700388 break;
389 }
390 }
391 }
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600392 else if (interfaceMap.first ==
393 "xyz.openbmc_project.Common.OriginatedBy")
394 {
395 for (const auto& propertyMap : interfaceMap.second)
396 {
397 if (propertyMap.first == "OriginatorId")
398 {
399 const std::string* id =
400 std::get_if<std::string>(&propertyMap.second);
401 if (id == nullptr)
402 {
403 messages::internalError(asyncResp->res);
404 break;
405 }
406 originatorId = *id;
407 }
408
409 if (propertyMap.first == "OriginatorType")
410 {
411 const std::string* type =
412 std::get_if<std::string>(&propertyMap.second);
413 if (type == nullptr)
414 {
415 messages::internalError(asyncResp->res);
416 break;
417 }
418
419 originatorType = mapDbusOriginatorTypeToRedfish(*type);
420 if (originatorType == log_entry::OriginatorTypes::Invalid)
421 {
422 messages::internalError(asyncResp->res);
423 break;
424 }
425 }
426 }
427 }
Claire Weinanaefe3782022-07-15 19:17:19 -0700428 }
429}
430
Nan Zhou21ab4042022-06-26 23:07:40 +0000431static std::string getDumpEntriesPath(const std::string& dumpType)
Claire Weinanfdd26902022-03-01 14:18:25 -0800432{
433 std::string entriesPath;
434
435 if (dumpType == "BMC")
436 {
437 entriesPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
438 }
439 else if (dumpType == "FaultLog")
440 {
441 entriesPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/";
442 }
443 else if (dumpType == "System")
444 {
445 entriesPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
446 }
447 else
448 {
Ed Tanous62598e32023-07-17 17:06:25 -0700449 BMCWEB_LOG_ERROR("getDumpEntriesPath() invalid dump type: {}",
450 dumpType);
Claire Weinanfdd26902022-03-01 14:18:25 -0800451 }
452
453 // Returns empty string on error
454 return entriesPath;
455}
456
zhanghch058d1b46d2021-04-01 11:18:24 +0800457inline void
458 getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
459 const std::string& dumpType)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500460{
Claire Weinanfdd26902022-03-01 14:18:25 -0800461 std::string entriesPath = getDumpEntriesPath(dumpType);
462 if (entriesPath.empty())
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500463 {
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500464 messages::internalError(asyncResp->res);
465 return;
466 }
467
George Liu5eb468d2023-06-20 17:03:24 +0800468 sdbusplus::message::object_path path("/xyz/openbmc_project/dump");
469 dbus::utility::getManagedObjects(
470 "xyz.openbmc_project.Dump.Manager", path,
Claire Weinanfdd26902022-03-01 14:18:25 -0800471 [asyncResp, entriesPath,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800472 dumpType](const boost::system::error_code& ec,
George Liu5eb468d2023-06-20 17:03:24 +0800473 const dbus::utility::ManagedObjectType& objects) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700474 if (ec)
475 {
Ed Tanous62598e32023-07-17 17:06:25 -0700476 BMCWEB_LOG_ERROR("DumpEntry resp_handler got error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -0700477 messages::internalError(asyncResp->res);
478 return;
479 }
480
Claire Weinanfdd26902022-03-01 14:18:25 -0800481 // Remove ending slash
482 std::string odataIdStr = entriesPath;
483 if (!odataIdStr.empty())
484 {
485 odataIdStr.pop_back();
486 }
487
488 asyncResp->res.jsonValue["@odata.type"] =
489 "#LogEntryCollection.LogEntryCollection";
490 asyncResp->res.jsonValue["@odata.id"] = std::move(odataIdStr);
491 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entries";
Patrick Williams89492a12023-05-10 07:51:34 -0500492 asyncResp->res.jsonValue["Description"] = "Collection of " + dumpType +
493 " Dump Entries";
Claire Weinanfdd26902022-03-01 14:18:25 -0800494
Ed Tanous002d39b2022-05-31 08:59:27 -0700495 nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
496 entriesArray = nlohmann::json::array();
497 std::string dumpEntryPath =
498 "/xyz/openbmc_project/dump/" +
499 std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/";
500
George Liu5eb468d2023-06-20 17:03:24 +0800501 dbus::utility::ManagedObjectType resp(objects);
Ed Tanous002d39b2022-05-31 08:59:27 -0700502 std::sort(resp.begin(), resp.end(), [](const auto& l, const auto& r) {
503 return AlphanumLess<std::string>()(l.first.filename(),
504 r.first.filename());
505 });
506
507 for (auto& object : resp)
508 {
509 if (object.first.str.find(dumpEntryPath) == std::string::npos)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500510 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700511 continue;
512 }
Claire Weinanc6fecda2022-07-15 10:43:25 -0700513 uint64_t timestampUs = 0;
Ed Tanous002d39b2022-05-31 08:59:27 -0700514 uint64_t size = 0;
515 std::string dumpStatus;
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600516 std::string originatorId;
517 log_entry::OriginatorTypes originatorType =
518 log_entry::OriginatorTypes::Internal;
Jason M. Bills433b68b2022-06-28 12:24:26 -0700519 nlohmann::json::object_t thisEntry;
Ed Tanous002d39b2022-05-31 08:59:27 -0700520
521 std::string entryID = object.first.filename();
522 if (entryID.empty())
523 {
524 continue;
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500525 }
526
Claire Weinanc6fecda2022-07-15 10:43:25 -0700527 parseDumpEntryFromDbusObject(object, dumpStatus, size, timestampUs,
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600528 originatorId, originatorType,
Claire Weinanaefe3782022-07-15 19:17:19 -0700529 asyncResp);
Ed Tanous002d39b2022-05-31 08:59:27 -0700530
531 if (dumpStatus !=
532 "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" &&
533 !dumpStatus.empty())
534 {
535 // Dump status is not Complete, no need to enumerate
536 continue;
537 }
538
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600539 thisEntry["@odata.type"] = "#LogEntry.v1_11_0.LogEntry";
Claire Weinanfdd26902022-03-01 14:18:25 -0800540 thisEntry["@odata.id"] = entriesPath + entryID;
Ed Tanous002d39b2022-05-31 08:59:27 -0700541 thisEntry["Id"] = entryID;
542 thisEntry["EntryType"] = "Event";
Ed Tanous002d39b2022-05-31 08:59:27 -0700543 thisEntry["Name"] = dumpType + " Dump Entry";
Claire Weinanbbd80db2022-10-26 16:55:52 -0700544 thisEntry["Created"] =
545 redfish::time_utils::getDateTimeUintUs(timestampUs);
Ed Tanous002d39b2022-05-31 08:59:27 -0700546
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600547 if (!originatorId.empty())
548 {
549 thisEntry["Originator"] = originatorId;
550 thisEntry["OriginatorType"] = originatorType;
551 }
552
Ed Tanous002d39b2022-05-31 08:59:27 -0700553 if (dumpType == "BMC")
554 {
555 thisEntry["DiagnosticDataType"] = "Manager";
Patrick Williams89492a12023-05-10 07:51:34 -0500556 thisEntry["AdditionalDataURI"] = entriesPath + entryID +
557 "/attachment";
Claire Weinanfdd26902022-03-01 14:18:25 -0800558 thisEntry["AdditionalDataSizeBytes"] = size;
Ed Tanous002d39b2022-05-31 08:59:27 -0700559 }
560 else if (dumpType == "System")
561 {
562 thisEntry["DiagnosticDataType"] = "OEM";
563 thisEntry["OEMDiagnosticDataType"] = "System";
Patrick Williams89492a12023-05-10 07:51:34 -0500564 thisEntry["AdditionalDataURI"] = entriesPath + entryID +
565 "/attachment";
Claire Weinanfdd26902022-03-01 14:18:25 -0800566 thisEntry["AdditionalDataSizeBytes"] = size;
Ed Tanous002d39b2022-05-31 08:59:27 -0700567 }
Patrick Williamsb2ba3072023-05-12 10:27:39 -0500568 entriesArray.emplace_back(std::move(thisEntry));
Ed Tanous002d39b2022-05-31 08:59:27 -0700569 }
570 asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size();
George Liu5eb468d2023-06-20 17:03:24 +0800571 });
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500572}
573
zhanghch058d1b46d2021-04-01 11:18:24 +0800574inline void
Claire Weinanc7a6d662022-06-13 16:36:39 -0700575 getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
zhanghch058d1b46d2021-04-01 11:18:24 +0800576 const std::string& entryID, const std::string& dumpType)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500577{
Claire Weinanfdd26902022-03-01 14:18:25 -0800578 std::string entriesPath = getDumpEntriesPath(dumpType);
579 if (entriesPath.empty())
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500580 {
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500581 messages::internalError(asyncResp->res);
582 return;
583 }
584
George Liu5eb468d2023-06-20 17:03:24 +0800585 sdbusplus::message::object_path path("/xyz/openbmc_project/dump");
586 dbus::utility::getManagedObjects(
587 "xyz.openbmc_project.Dump.Manager", path,
Claire Weinanfdd26902022-03-01 14:18:25 -0800588 [asyncResp, entryID, dumpType,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800589 entriesPath](const boost::system::error_code& ec,
Ed Tanous02cad962022-06-30 16:50:15 -0700590 const dbus::utility::ManagedObjectType& resp) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700591 if (ec)
592 {
Ed Tanous62598e32023-07-17 17:06:25 -0700593 BMCWEB_LOG_ERROR("DumpEntry resp_handler got error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -0700594 messages::internalError(asyncResp->res);
595 return;
596 }
597
598 bool foundDumpEntry = false;
599 std::string dumpEntryPath =
600 "/xyz/openbmc_project/dump/" +
601 std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/";
602
603 for (const auto& objectPath : resp)
604 {
605 if (objectPath.first.str != dumpEntryPath + entryID)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500606 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700607 continue;
608 }
609
610 foundDumpEntry = true;
Claire Weinanc6fecda2022-07-15 10:43:25 -0700611 uint64_t timestampUs = 0;
Ed Tanous002d39b2022-05-31 08:59:27 -0700612 uint64_t size = 0;
613 std::string dumpStatus;
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600614 std::string originatorId;
615 log_entry::OriginatorTypes originatorType =
616 log_entry::OriginatorTypes::Internal;
Ed Tanous002d39b2022-05-31 08:59:27 -0700617
Claire Weinanaefe3782022-07-15 19:17:19 -0700618 parseDumpEntryFromDbusObject(objectPath, dumpStatus, size,
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600619 timestampUs, originatorId,
620 originatorType, asyncResp);
Ed Tanous002d39b2022-05-31 08:59:27 -0700621
622 if (dumpStatus !=
623 "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" &&
624 !dumpStatus.empty())
625 {
626 // Dump status is not Complete
627 // return not found until status is changed to Completed
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +0200628 messages::resourceNotFound(asyncResp->res, dumpType + " dump",
629 entryID);
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500630 return;
631 }
632
Ed Tanous002d39b2022-05-31 08:59:27 -0700633 asyncResp->res.jsonValue["@odata.type"] =
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600634 "#LogEntry.v1_11_0.LogEntry";
Claire Weinanfdd26902022-03-01 14:18:25 -0800635 asyncResp->res.jsonValue["@odata.id"] = entriesPath + entryID;
Ed Tanous002d39b2022-05-31 08:59:27 -0700636 asyncResp->res.jsonValue["Id"] = entryID;
637 asyncResp->res.jsonValue["EntryType"] = "Event";
Ed Tanous002d39b2022-05-31 08:59:27 -0700638 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry";
Claire Weinanbbd80db2022-10-26 16:55:52 -0700639 asyncResp->res.jsonValue["Created"] =
640 redfish::time_utils::getDateTimeUintUs(timestampUs);
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500641
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600642 if (!originatorId.empty())
643 {
644 asyncResp->res.jsonValue["Originator"] = originatorId;
645 asyncResp->res.jsonValue["OriginatorType"] = originatorType;
646 }
647
Ed Tanous002d39b2022-05-31 08:59:27 -0700648 if (dumpType == "BMC")
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500649 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700650 asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager";
651 asyncResp->res.jsonValue["AdditionalDataURI"] =
Claire Weinanfdd26902022-03-01 14:18:25 -0800652 entriesPath + entryID + "/attachment";
653 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500654 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700655 else if (dumpType == "System")
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500656 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700657 asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM";
658 asyncResp->res.jsonValue["OEMDiagnosticDataType"] = "System";
659 asyncResp->res.jsonValue["AdditionalDataURI"] =
Claire Weinanfdd26902022-03-01 14:18:25 -0800660 entriesPath + entryID + "/attachment";
661 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500662 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700663 }
664 if (!foundDumpEntry)
665 {
Ed Tanous62598e32023-07-17 17:06:25 -0700666 BMCWEB_LOG_WARNING("Can't find Dump Entry {}", entryID);
Myung Baeb90d14f2023-05-31 14:40:39 -0500667 messages::resourceNotFound(asyncResp->res, dumpType + " dump",
668 entryID);
Ed Tanous002d39b2022-05-31 08:59:27 -0700669 return;
670 }
George Liu5eb468d2023-06-20 17:03:24 +0800671 });
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500672}
673
zhanghch058d1b46d2021-04-01 11:18:24 +0800674inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Stanley Chu98782562020-11-04 16:10:24 +0800675 const std::string& entryID,
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500676 const std::string& dumpType)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500677{
Ed Tanous002d39b2022-05-31 08:59:27 -0700678 auto respHandler =
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800679 [asyncResp, entryID](const boost::system::error_code& ec) {
Ed Tanous62598e32023-07-17 17:06:25 -0700680 BMCWEB_LOG_DEBUG("Dump Entry doDelete callback: Done");
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500681 if (ec)
682 {
George Liu3de8d8b2021-03-22 17:49:39 +0800683 if (ec.value() == EBADR)
684 {
685 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
686 return;
687 }
Ed Tanous62598e32023-07-17 17:06:25 -0700688 BMCWEB_LOG_ERROR(
689 "Dump (DBus) doDelete respHandler got error {} entryID={}", ec,
690 entryID);
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500691 messages::internalError(asyncResp->res);
692 return;
693 }
694 };
695 crow::connections::systemBus->async_method_call(
696 respHandler, "xyz.openbmc_project.Dump.Manager",
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500697 "/xyz/openbmc_project/dump/" +
698 std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" +
699 entryID,
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500700 "xyz.openbmc_project.Object.Delete", "Delete");
701}
702
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600703inline DumpCreationProgress
704 mapDbusStatusToDumpProgress(const std::string& status)
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500705{
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600706 if (status ==
707 "xyz.openbmc_project.Common.Progress.OperationStatus.Failed" ||
708 status == "xyz.openbmc_project.Common.Progress.OperationStatus.Aborted")
709 {
710 return DumpCreationProgress::DUMP_CREATE_FAILED;
711 }
712 if (status ==
713 "xyz.openbmc_project.Common.Progress.OperationStatus.Completed")
714 {
715 return DumpCreationProgress::DUMP_CREATE_SUCCESS;
716 }
717 return DumpCreationProgress::DUMP_CREATE_INPROGRESS;
718}
719
720inline DumpCreationProgress
721 getDumpCompletionStatus(const dbus::utility::DBusPropertiesMap& values)
722{
723 for (const auto& [key, val] : values)
724 {
725 if (key == "Status")
Ed Tanous002d39b2022-05-31 08:59:27 -0700726 {
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600727 const std::string* value = std::get_if<std::string>(&val);
728 if (value == nullptr)
729 {
Ed Tanous62598e32023-07-17 17:06:25 -0700730 BMCWEB_LOG_ERROR("Status property value is null");
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600731 return DumpCreationProgress::DUMP_CREATE_FAILED;
732 }
733 return mapDbusStatusToDumpProgress(*value);
734 }
735 }
736 return DumpCreationProgress::DUMP_CREATE_INPROGRESS;
737}
738
739inline std::string getDumpEntryPath(const std::string& dumpPath)
740{
741 if (dumpPath == "/xyz/openbmc_project/dump/bmc/entry")
742 {
743 return "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
744 }
745 if (dumpPath == "/xyz/openbmc_project/dump/system/entry")
746 {
747 return "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
748 }
749 return "";
750}
751
752inline void createDumpTaskCallback(
753 task::Payload&& payload,
754 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
755 const sdbusplus::message::object_path& createdObjPath)
756{
757 const std::string dumpPath = createdObjPath.parent_path().str;
758 const std::string dumpId = createdObjPath.filename();
759
760 std::string dumpEntryPath = getDumpEntryPath(dumpPath);
761
762 if (dumpEntryPath.empty())
763 {
Ed Tanous62598e32023-07-17 17:06:25 -0700764 BMCWEB_LOG_ERROR("Invalid dump type received");
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600765 messages::internalError(asyncResp->res);
766 return;
767 }
768
769 crow::connections::systemBus->async_method_call(
770 [asyncResp, payload, createdObjPath,
771 dumpEntryPath{std::move(dumpEntryPath)},
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800772 dumpId](const boost::system::error_code& ec,
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600773 const std::string& introspectXml) {
774 if (ec)
775 {
Ed Tanous62598e32023-07-17 17:06:25 -0700776 BMCWEB_LOG_ERROR("Introspect call failed with error: {}",
777 ec.message());
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600778 messages::internalError(asyncResp->res);
779 return;
Ed Tanous002d39b2022-05-31 08:59:27 -0700780 }
781
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600782 // Check if the created dump object has implemented Progress
783 // interface to track dump completion. If yes, fetch the "Status"
784 // property of the interface, modify the task state accordingly.
785 // Else, return task completed.
786 tinyxml2::XMLDocument doc;
Ed Tanous002d39b2022-05-31 08:59:27 -0700787
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600788 doc.Parse(introspectXml.data(), introspectXml.size());
789 tinyxml2::XMLNode* pRoot = doc.FirstChildElement("node");
790 if (pRoot == nullptr)
Ed Tanous002d39b2022-05-31 08:59:27 -0700791 {
Ed Tanous62598e32023-07-17 17:06:25 -0700792 BMCWEB_LOG_ERROR("XML document failed to parse");
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600793 messages::internalError(asyncResp->res);
794 return;
795 }
796 tinyxml2::XMLElement* interfaceNode =
797 pRoot->FirstChildElement("interface");
798
799 bool isProgressIntfPresent = false;
800 while (interfaceNode != nullptr)
801 {
802 const char* thisInterfaceName = interfaceNode->Attribute("name");
803 if (thisInterfaceName != nullptr)
804 {
805 if (thisInterfaceName ==
806 std::string_view("xyz.openbmc_project.Common.Progress"))
807 {
808 interfaceNode =
809 interfaceNode->NextSiblingElement("interface");
810 continue;
811 }
812 isProgressIntfPresent = true;
813 break;
814 }
815 interfaceNode = interfaceNode->NextSiblingElement("interface");
816 }
817
818 std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
819 [createdObjPath, dumpEntryPath, dumpId, isProgressIntfPresent](
Ed Tanous8b242752023-06-27 17:17:13 -0700820 const boost::system::error_code& ec2, sdbusplus::message_t& msg,
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600821 const std::shared_ptr<task::TaskData>& taskData) {
Ed Tanous8b242752023-06-27 17:17:13 -0700822 if (ec2)
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600823 {
Ed Tanous62598e32023-07-17 17:06:25 -0700824 BMCWEB_LOG_ERROR("{}: Error in creating dump",
825 createdObjPath.str);
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600826 taskData->messages.emplace_back(messages::internalError());
827 taskData->state = "Cancelled";
828 return task::completed;
829 }
830
831 if (isProgressIntfPresent)
832 {
833 dbus::utility::DBusPropertiesMap values;
834 std::string prop;
835 msg.read(prop, values);
836
837 DumpCreationProgress dumpStatus =
838 getDumpCompletionStatus(values);
839 if (dumpStatus == DumpCreationProgress::DUMP_CREATE_FAILED)
840 {
Ed Tanous62598e32023-07-17 17:06:25 -0700841 BMCWEB_LOG_ERROR("{}: Error in creating dump",
842 createdObjPath.str);
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600843 taskData->state = "Cancelled";
844 return task::completed;
845 }
846
847 if (dumpStatus == DumpCreationProgress::DUMP_CREATE_INPROGRESS)
848 {
Ed Tanous62598e32023-07-17 17:06:25 -0700849 BMCWEB_LOG_DEBUG("{}: Dump creation task is in progress",
850 createdObjPath.str);
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600851 return !task::completed;
852 }
853 }
854
Ed Tanous002d39b2022-05-31 08:59:27 -0700855 nlohmann::json retMessage = messages::success();
856 taskData->messages.emplace_back(retMessage);
857
Ed Tanousc51a58e2023-03-27 14:43:19 -0700858 boost::urls::url url = boost::urls::format(
859 "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/{}", dumpId);
860
861 std::string headerLoc = "Location: ";
862 headerLoc += url.buffer();
863
Ed Tanous002d39b2022-05-31 08:59:27 -0700864 taskData->payload->httpHeaders.emplace_back(std::move(headerLoc));
865
Ed Tanous62598e32023-07-17 17:06:25 -0700866 BMCWEB_LOG_DEBUG("{}: Dump creation task completed",
867 createdObjPath.str);
Ed Tanous002d39b2022-05-31 08:59:27 -0700868 taskData->state = "Completed";
869 return task::completed;
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600870 },
871 "type='signal',interface='org.freedesktop.DBus.Properties',"
872 "member='PropertiesChanged',path='" +
873 createdObjPath.str + "'");
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500874
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600875 // The task timer is set to max time limit within which the
876 // requested dump will be collected.
877 task->startTimer(std::chrono::minutes(6));
878 task->populateResp(asyncResp->res);
879 task->payload.emplace(payload);
880 },
881 "xyz.openbmc_project.Dump.Manager", createdObjPath,
882 "org.freedesktop.DBus.Introspectable", "Introspect");
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500883}
884
zhanghch058d1b46d2021-04-01 11:18:24 +0800885inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
886 const crow::Request& req, const std::string& dumpType)
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500887{
Claire Weinanfdd26902022-03-01 14:18:25 -0800888 std::string dumpPath = getDumpEntriesPath(dumpType);
889 if (dumpPath.empty())
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500890 {
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500891 messages::internalError(asyncResp->res);
892 return;
893 }
894
895 std::optional<std::string> diagnosticDataType;
896 std::optional<std::string> oemDiagnosticDataType;
897
Willy Tu15ed6782021-12-14 11:03:16 -0800898 if (!redfish::json_util::readJsonAction(
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500899 req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
900 "OEMDiagnosticDataType", oemDiagnosticDataType))
901 {
902 return;
903 }
904
905 if (dumpType == "System")
906 {
907 if (!oemDiagnosticDataType || !diagnosticDataType)
908 {
Ed Tanous62598e32023-07-17 17:06:25 -0700909 BMCWEB_LOG_ERROR(
910 "CreateDump action parameter 'DiagnosticDataType'/'OEMDiagnosticDataType' value not found!");
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500911 messages::actionParameterMissing(
912 asyncResp->res, "CollectDiagnosticData",
913 "DiagnosticDataType & OEMDiagnosticDataType");
914 return;
915 }
Ed Tanous3174e4d2020-10-07 11:41:22 -0700916 if ((*oemDiagnosticDataType != "System") ||
917 (*diagnosticDataType != "OEM"))
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500918 {
Ed Tanous62598e32023-07-17 17:06:25 -0700919 BMCWEB_LOG_ERROR("Wrong parameter values passed");
Ed Tanousace85d62021-10-26 12:45:59 -0700920 messages::internalError(asyncResp->res);
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500921 return;
922 }
Asmitha Karunanithi59075712021-10-22 01:17:41 -0500923 dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/";
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500924 }
925 else if (dumpType == "BMC")
926 {
927 if (!diagnosticDataType)
928 {
Ed Tanous62598e32023-07-17 17:06:25 -0700929 BMCWEB_LOG_ERROR(
930 "CreateDump action parameter 'DiagnosticDataType' not found!");
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500931 messages::actionParameterMissing(
932 asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType");
933 return;
934 }
Ed Tanous3174e4d2020-10-07 11:41:22 -0700935 if (*diagnosticDataType != "Manager")
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500936 {
Ed Tanous62598e32023-07-17 17:06:25 -0700937 BMCWEB_LOG_ERROR(
938 "Wrong parameter value passed for 'DiagnosticDataType'");
Ed Tanousace85d62021-10-26 12:45:59 -0700939 messages::internalError(asyncResp->res);
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500940 return;
941 }
Asmitha Karunanithi59075712021-10-22 01:17:41 -0500942 dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/";
943 }
944 else
945 {
Ed Tanous62598e32023-07-17 17:06:25 -0700946 BMCWEB_LOG_ERROR("CreateDump failed. Unknown dump type");
Asmitha Karunanithi59075712021-10-22 01:17:41 -0500947 messages::internalError(asyncResp->res);
948 return;
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500949 }
950
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600951 std::vector<std::pair<std::string, std::variant<std::string, uint64_t>>>
952 createDumpParamVec;
953
Carson Labradof574a8e2023-03-22 02:26:00 +0000954 if (req.session != nullptr)
955 {
956 createDumpParamVec.emplace_back(
957 "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorId",
958 req.session->clientIp);
959 createDumpParamVec.emplace_back(
960 "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorType",
961 "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client");
962 }
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600963
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500964 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800965 [asyncResp, payload(task::Payload(req)),
966 dumpPath](const boost::system::error_code& ec,
967 const sdbusplus::message_t& msg,
968 const sdbusplus::message::object_path& objPath) mutable {
Ed Tanous002d39b2022-05-31 08:59:27 -0700969 if (ec)
970 {
Ed Tanous62598e32023-07-17 17:06:25 -0700971 BMCWEB_LOG_ERROR("CreateDump resp_handler got error {}", ec);
Asmitha Karunanithi59075712021-10-22 01:17:41 -0500972 const sd_bus_error* dbusError = msg.get_error();
973 if (dbusError == nullptr)
974 {
975 messages::internalError(asyncResp->res);
976 return;
977 }
978
Ed Tanous62598e32023-07-17 17:06:25 -0700979 BMCWEB_LOG_ERROR("CreateDump DBus error: {} and error msg: {}",
980 dbusError->name, dbusError->message);
Asmitha Karunanithi59075712021-10-22 01:17:41 -0500981 if (std::string_view(
982 "xyz.openbmc_project.Common.Error.NotAllowed") ==
983 dbusError->name)
984 {
985 messages::resourceInStandby(asyncResp->res);
986 return;
987 }
988 if (std::string_view(
989 "xyz.openbmc_project.Dump.Create.Error.Disabled") ==
990 dbusError->name)
991 {
992 messages::serviceDisabled(asyncResp->res, dumpPath);
993 return;
994 }
995 if (std::string_view(
996 "xyz.openbmc_project.Common.Error.Unavailable") ==
997 dbusError->name)
998 {
999 messages::resourceInUse(asyncResp->res);
1000 return;
1001 }
1002 // Other Dbus errors such as:
1003 // xyz.openbmc_project.Common.Error.InvalidArgument &
1004 // org.freedesktop.DBus.Error.InvalidArgs are all related to
1005 // the dbus call that is made here in the bmcweb
1006 // implementation and has nothing to do with the client's
1007 // input in the request. Hence, returning internal error
1008 // back to the client.
Ed Tanous002d39b2022-05-31 08:59:27 -07001009 messages::internalError(asyncResp->res);
1010 return;
1011 }
Ed Tanous62598e32023-07-17 17:06:25 -07001012 BMCWEB_LOG_DEBUG("Dump Created. Path: {}", objPath.str);
Asmitha Karunanithi8e317782020-12-10 03:35:05 -06001013 createDumpTaskCallback(std::move(payload), asyncResp, objPath);
Asmitha Karunanithia43be802020-05-07 05:05:36 -05001014 },
Asmitha Karunanithib47452b2020-09-25 02:02:19 -05001015 "xyz.openbmc_project.Dump.Manager",
1016 "/xyz/openbmc_project/dump/" +
1017 std::string(boost::algorithm::to_lower_copy(dumpType)),
Asmitha Karunanithi8e317782020-12-10 03:35:05 -06001018 "xyz.openbmc_project.Dump.Create", "CreateDump", createDumpParamVec);
Asmitha Karunanithia43be802020-05-07 05:05:36 -05001019}
1020
zhanghch058d1b46d2021-04-01 11:18:24 +08001021inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1022 const std::string& dumpType)
Asmitha Karunanithi80319af2020-05-07 05:30:21 -05001023{
Asmitha Karunanithib47452b2020-09-25 02:02:19 -05001024 std::string dumpTypeLowerCopy =
1025 std::string(boost::algorithm::to_lower_copy(dumpType));
zhanghch058d1b46d2021-04-01 11:18:24 +08001026
Claire Weinan0d946212022-07-13 19:40:19 -07001027 crow::connections::systemBus->async_method_call(
1028 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001029 if (ec)
1030 {
Ed Tanous62598e32023-07-17 17:06:25 -07001031 BMCWEB_LOG_ERROR("clearDump resp_handler got error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07001032 messages::internalError(asyncResp->res);
1033 return;
1034 }
Claire Weinan0d946212022-07-13 19:40:19 -07001035 },
1036 "xyz.openbmc_project.Dump.Manager",
1037 "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy,
1038 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
Asmitha Karunanithi80319af2020-05-07 05:30:21 -05001039}
1040
Ed Tanousb9d36b42022-02-26 21:42:46 -08001041inline static void
1042 parseCrashdumpParameters(const dbus::utility::DBusPropertiesMap& params,
1043 std::string& filename, std::string& timestamp,
1044 std::string& logfile)
Johnathan Mantey043a0532020-03-10 17:15:28 -07001045{
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001046 const std::string* filenamePtr = nullptr;
1047 const std::string* timestampPtr = nullptr;
1048 const std::string* logfilePtr = nullptr;
1049
1050 const bool success = sdbusplus::unpackPropertiesNoThrow(
1051 dbus_utils::UnpackErrorPrinter(), params, "Timestamp", timestampPtr,
1052 "Filename", filenamePtr, "Log", logfilePtr);
1053
1054 if (!success)
Johnathan Mantey043a0532020-03-10 17:15:28 -07001055 {
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001056 return;
1057 }
1058
1059 if (filenamePtr != nullptr)
1060 {
1061 filename = *filenamePtr;
1062 }
1063
1064 if (timestampPtr != nullptr)
1065 {
1066 timestamp = *timestampPtr;
1067 }
1068
1069 if (logfilePtr != nullptr)
1070 {
1071 logfile = *logfilePtr;
Johnathan Mantey043a0532020-03-10 17:15:28 -07001072 }
1073}
1074
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001075inline void requestRoutesSystemLogServiceCollection(App& app)
Ed Tanous1da66f72018-07-27 16:13:37 -07001076{
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001077 /**
1078 * Functions triggers appropriate requests on DBus
1079 */
Ed Tanous22d268c2022-05-19 09:39:07 -07001080 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/")
Ed Tanoused398212021-06-09 17:05:54 -07001081 .privileges(redfish::privileges::getLogServiceCollection)
Ed Tanous002d39b2022-05-31 08:59:27 -07001082 .methods(boost::beast::http::verb::get)(
1083 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07001084 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1085 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001086 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001087 {
1088 return;
1089 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001090 if constexpr (bmcwebEnableMultiHost)
1091 {
1092 // Option currently returns no systems. TBD
1093 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1094 systemName);
1095 return;
1096 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001097 if (systemName != "system")
1098 {
1099 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1100 systemName);
1101 return;
1102 }
1103
Ed Tanous002d39b2022-05-31 08:59:27 -07001104 // Collections don't include the static data added by SubRoute
1105 // because it has a duplicate entry for members
1106 asyncResp->res.jsonValue["@odata.type"] =
1107 "#LogServiceCollection.LogServiceCollection";
1108 asyncResp->res.jsonValue["@odata.id"] =
1109 "/redfish/v1/Systems/system/LogServices";
1110 asyncResp->res.jsonValue["Name"] = "System Log Services Collection";
1111 asyncResp->res.jsonValue["Description"] =
1112 "Collection of LogServices for this Computer System";
1113 nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
1114 logServiceArray = nlohmann::json::array();
1115 nlohmann::json::object_t eventLog;
1116 eventLog["@odata.id"] =
1117 "/redfish/v1/Systems/system/LogServices/EventLog";
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001118 logServiceArray.emplace_back(std::move(eventLog));
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05001119#ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
Ed Tanous002d39b2022-05-31 08:59:27 -07001120 nlohmann::json::object_t dumpLog;
1121 dumpLog["@odata.id"] = "/redfish/v1/Systems/system/LogServices/Dump";
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001122 logServiceArray.emplace_back(std::move(dumpLog));
raviteja-bc9bb6862020-02-03 11:53:32 -06001123#endif
1124
Jason M. Billsd53dd412019-02-12 17:16:22 -08001125#ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
Ed Tanous002d39b2022-05-31 08:59:27 -07001126 nlohmann::json::object_t crashdump;
1127 crashdump["@odata.id"] =
1128 "/redfish/v1/Systems/system/LogServices/Crashdump";
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001129 logServiceArray.emplace_back(std::move(crashdump));
Jason M. Billsd53dd412019-02-12 17:16:22 -08001130#endif
Spencer Kub7028eb2021-10-26 15:27:35 +08001131
1132#ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER
Ed Tanous002d39b2022-05-31 08:59:27 -07001133 nlohmann::json::object_t hostlogger;
1134 hostlogger["@odata.id"] =
1135 "/redfish/v1/Systems/system/LogServices/HostLogger";
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001136 logServiceArray.emplace_back(std::move(hostlogger));
Spencer Kub7028eb2021-10-26 15:27:35 +08001137#endif
Ed Tanous002d39b2022-05-31 08:59:27 -07001138 asyncResp->res.jsonValue["Members@odata.count"] =
1139 logServiceArray.size();
ZhikuiRena3316fc2020-01-29 14:58:08 -08001140
George Liu7a1dbc42022-12-07 16:03:22 +08001141 constexpr std::array<std::string_view, 1> interfaces = {
1142 "xyz.openbmc_project.State.Boot.PostCode"};
1143 dbus::utility::getSubTreePaths(
1144 "/", 0, interfaces,
1145 [asyncResp](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07001146 const dbus::utility::MapperGetSubTreePathsResponse&
1147 subtreePath) {
1148 if (ec)
1149 {
Ed Tanous62598e32023-07-17 17:06:25 -07001150 BMCWEB_LOG_ERROR("{}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07001151 return;
1152 }
Ed Tanous45ca1b82022-03-25 13:07:27 -07001153
Ed Tanous002d39b2022-05-31 08:59:27 -07001154 for (const auto& pathStr : subtreePath)
1155 {
1156 if (pathStr.find("PostCode") != std::string::npos)
1157 {
1158 nlohmann::json& logServiceArrayLocal =
1159 asyncResp->res.jsonValue["Members"];
Ed Tanous613dabe2022-07-09 11:17:36 -07001160 nlohmann::json::object_t member;
1161 member["@odata.id"] =
1162 "/redfish/v1/Systems/system/LogServices/PostCodes";
1163
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001164 logServiceArrayLocal.emplace_back(std::move(member));
Ed Tanous613dabe2022-07-09 11:17:36 -07001165
Ed Tanous002d39b2022-05-31 08:59:27 -07001166 asyncResp->res.jsonValue["Members@odata.count"] =
1167 logServiceArrayLocal.size();
1168 return;
1169 }
1170 }
George Liu7a1dbc42022-12-07 16:03:22 +08001171 });
Ed Tanous45ca1b82022-03-25 13:07:27 -07001172 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001173}
1174
1175inline void requestRoutesEventLogService(App& app)
1176{
Ed Tanous22d268c2022-05-19 09:39:07 -07001177 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/")
Ed Tanoused398212021-06-09 17:05:54 -07001178 .privileges(redfish::privileges::getLogService)
Ed Tanous002d39b2022-05-31 08:59:27 -07001179 .methods(boost::beast::http::verb::get)(
1180 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07001181 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1182 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001183 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001184 {
1185 return;
1186 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001187 if (systemName != "system")
1188 {
1189 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1190 systemName);
1191 return;
1192 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001193 asyncResp->res.jsonValue["@odata.id"] =
1194 "/redfish/v1/Systems/system/LogServices/EventLog";
1195 asyncResp->res.jsonValue["@odata.type"] =
1196 "#LogService.v1_1_0.LogService";
1197 asyncResp->res.jsonValue["Name"] = "Event Log Service";
1198 asyncResp->res.jsonValue["Description"] = "System Event Log Service";
1199 asyncResp->res.jsonValue["Id"] = "EventLog";
1200 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
Tejas Patil7c8c4052021-06-04 17:43:14 +05301201
Ed Tanous002d39b2022-05-31 08:59:27 -07001202 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07001203 redfish::time_utils::getDateTimeOffsetNow();
Tejas Patil7c8c4052021-06-04 17:43:14 +05301204
Ed Tanous002d39b2022-05-31 08:59:27 -07001205 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
1206 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
1207 redfishDateTimeOffset.second;
Tejas Patil7c8c4052021-06-04 17:43:14 +05301208
Ed Tanous002d39b2022-05-31 08:59:27 -07001209 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
1210 "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1211 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001212
Ed Tanous002d39b2022-05-31 08:59:27 -07001213 {"target",
1214 "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog"}};
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001215 });
1216}
1217
1218inline void requestRoutesJournalEventLogClear(App& app)
1219{
Jason M. Bills4978b632022-02-22 14:17:43 -08001220 BMCWEB_ROUTE(
1221 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07001222 "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/")
Ed Tanous432a8902021-06-14 15:28:56 -07001223 .privileges({{"ConfigureComponents"}})
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001224 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07001225 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07001226 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1227 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001228 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001229 {
1230 return;
1231 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001232 if (systemName != "system")
1233 {
1234 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1235 systemName);
1236 return;
1237 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001238 // Clear the EventLog by deleting the log files
1239 std::vector<std::filesystem::path> redfishLogFiles;
1240 if (getRedfishLogFiles(redfishLogFiles))
1241 {
1242 for (const std::filesystem::path& file : redfishLogFiles)
1243 {
1244 std::error_code ec;
1245 std::filesystem::remove(file, ec);
1246 }
1247 }
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001248
Ed Tanous002d39b2022-05-31 08:59:27 -07001249 // Reload rsyslog so it knows to start new log files
1250 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001251 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001252 if (ec)
1253 {
Ed Tanous62598e32023-07-17 17:06:25 -07001254 BMCWEB_LOG_ERROR("Failed to reload rsyslog: {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07001255 messages::internalError(asyncResp->res);
1256 return;
1257 }
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001258
Ed Tanous002d39b2022-05-31 08:59:27 -07001259 messages::success(asyncResp->res);
1260 },
1261 "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
1262 "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service",
1263 "replace");
1264 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001265}
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001266
Jason M. Billsac992cd2022-06-24 13:31:46 -07001267enum class LogParseError
1268{
1269 success,
1270 parseFailed,
1271 messageIdNotInRegistry,
1272};
1273
1274static LogParseError
1275 fillEventLogEntryJson(const std::string& logEntryID,
1276 const std::string& logEntry,
1277 nlohmann::json::object_t& logEntryJson)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001278{
Jason M. Bills95820182019-04-22 16:25:34 -07001279 // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
Jason M. Billscd225da2019-05-08 15:31:57 -07001280 // First get the Timestamp
Ed Tanousf23b7292020-10-15 09:41:17 -07001281 size_t space = logEntry.find_first_of(' ');
Jason M. Billscd225da2019-05-08 15:31:57 -07001282 if (space == std::string::npos)
Jason M. Bills95820182019-04-22 16:25:34 -07001283 {
Jason M. Billsac992cd2022-06-24 13:31:46 -07001284 return LogParseError::parseFailed;
Jason M. Bills95820182019-04-22 16:25:34 -07001285 }
Jason M. Billscd225da2019-05-08 15:31:57 -07001286 std::string timestamp = logEntry.substr(0, space);
1287 // Then get the log contents
Ed Tanousf23b7292020-10-15 09:41:17 -07001288 size_t entryStart = logEntry.find_first_not_of(' ', space);
Jason M. Billscd225da2019-05-08 15:31:57 -07001289 if (entryStart == std::string::npos)
1290 {
Jason M. Billsac992cd2022-06-24 13:31:46 -07001291 return LogParseError::parseFailed;
Jason M. Billscd225da2019-05-08 15:31:57 -07001292 }
1293 std::string_view entry(logEntry);
1294 entry.remove_prefix(entryStart);
1295 // Use split to separate the entry into its fields
1296 std::vector<std::string> logEntryFields;
Ed Tanous50ebd4a2023-01-19 19:03:17 -08001297 bmcweb::split(logEntryFields, entry, ',');
Jason M. Billscd225da2019-05-08 15:31:57 -07001298 // We need at least a MessageId to be valid
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001299 auto logEntryIter = logEntryFields.begin();
1300 if (logEntryIter == logEntryFields.end())
Jason M. Billscd225da2019-05-08 15:31:57 -07001301 {
Jason M. Billsac992cd2022-06-24 13:31:46 -07001302 return LogParseError::parseFailed;
Jason M. Billscd225da2019-05-08 15:31:57 -07001303 }
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001304 std::string& messageID = *logEntryIter;
Jason M. Bills4851d452019-03-28 11:27:48 -07001305 // Get the Message from the MessageRegistry
Ed Tanousfffb8c12022-02-07 23:53:03 -08001306 const registries::Message* message = registries::getMessage(messageID);
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001307
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001308 logEntryIter++;
Sui Chen54417b02022-03-24 14:59:52 -07001309 if (message == nullptr)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001310 {
Ed Tanous62598e32023-07-17 17:06:25 -07001311 BMCWEB_LOG_WARNING("Log entry not found in registry: {}", logEntry);
Jason M. Billsac992cd2022-06-24 13:31:46 -07001312 return LogParseError::messageIdNotInRegistry;
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001313 }
1314
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001315 std::vector<std::string_view> messageArgs(logEntryIter,
1316 logEntryFields.end());
Ed Tanousc05bba42023-06-28 08:33:29 -07001317 messageArgs.resize(message->numberOfArgs);
1318
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001319 std::string msg = redfish::registries::fillMessageArgs(messageArgs,
1320 message->message);
1321 if (msg.empty())
Jason M. Bills4851d452019-03-28 11:27:48 -07001322 {
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001323 return LogParseError::parseFailed;
Jason M. Bills4851d452019-03-28 11:27:48 -07001324 }
1325
Jason M. Bills95820182019-04-22 16:25:34 -07001326 // Get the Created time from the timestamp. The log timestamp is in RFC3339
1327 // format which matches the Redfish format except for the fractional seconds
1328 // between the '.' and the '+', so just remove them.
Ed Tanousf23b7292020-10-15 09:41:17 -07001329 std::size_t dot = timestamp.find_first_of('.');
1330 std::size_t plus = timestamp.find_first_of('+');
Jason M. Bills95820182019-04-22 16:25:34 -07001331 if (dot != std::string::npos && plus != std::string::npos)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001332 {
Jason M. Bills95820182019-04-22 16:25:34 -07001333 timestamp.erase(dot, plus - dot);
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001334 }
1335
1336 // Fill in the log entry with the gathered data
Vijay Lobo9c11a172021-10-07 16:53:16 -05001337 logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07001338 logEntryJson["@odata.id"] = boost::urls::format(
1339 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}",
1340 logEntryID);
Jason M. Bills84afc482022-06-24 12:38:23 -07001341 logEntryJson["Name"] = "System Event Log Entry";
1342 logEntryJson["Id"] = logEntryID;
1343 logEntryJson["Message"] = std::move(msg);
1344 logEntryJson["MessageId"] = std::move(messageID);
1345 logEntryJson["MessageArgs"] = messageArgs;
1346 logEntryJson["EntryType"] = "Event";
1347 logEntryJson["Severity"] = message->messageSeverity;
1348 logEntryJson["Created"] = std::move(timestamp);
Jason M. Billsac992cd2022-06-24 13:31:46 -07001349 return LogParseError::success;
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001350}
1351
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001352inline void requestRoutesJournalEventLogEntryCollection(App& app)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001353{
Ed Tanous22d268c2022-05-19 09:39:07 -07001354 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/")
Gunnar Mills8b6a35f2021-07-30 14:52:53 -05001355 .privileges(redfish::privileges::getLogEntryCollection)
Ed Tanous002d39b2022-05-31 08:59:27 -07001356 .methods(boost::beast::http::verb::get)(
1357 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07001358 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1359 const std::string& systemName) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001360 query_param::QueryCapabilities capabilities = {
1361 .canDelegateTop = true,
1362 .canDelegateSkip = true,
1363 };
1364 query_param::Query delegatedQuery;
1365 if (!redfish::setUpRedfishRouteWithDelegation(
Carson Labrado3ba00072022-06-06 19:40:56 +00001366 app, req, asyncResp, delegatedQuery, capabilities))
Ed Tanous002d39b2022-05-31 08:59:27 -07001367 {
1368 return;
1369 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001370 if constexpr (bmcwebEnableMultiHost)
1371 {
1372 // Option currently returns no systems. TBD
1373 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1374 systemName);
1375 return;
1376 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001377 if (systemName != "system")
1378 {
1379 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1380 systemName);
1381 return;
1382 }
1383
Jiaqing Zhao5143f7a2022-07-22 09:33:33 +08001384 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
Ed Tanous3648c8b2022-07-25 13:39:59 -07001385 size_t skip = delegatedQuery.skip.value_or(0);
1386
Ed Tanous002d39b2022-05-31 08:59:27 -07001387 // Collections don't include the static data added by SubRoute
1388 // because it has a duplicate entry for members
1389 asyncResp->res.jsonValue["@odata.type"] =
1390 "#LogEntryCollection.LogEntryCollection";
1391 asyncResp->res.jsonValue["@odata.id"] =
1392 "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1393 asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1394 asyncResp->res.jsonValue["Description"] =
1395 "Collection of System Event Log Entries";
1396
1397 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1398 logEntryArray = nlohmann::json::array();
1399 // Go through the log files and create a unique ID for each
1400 // entry
1401 std::vector<std::filesystem::path> redfishLogFiles;
1402 getRedfishLogFiles(redfishLogFiles);
1403 uint64_t entryCount = 0;
1404 std::string logEntry;
1405
1406 // Oldest logs are in the last file, so start there and loop
1407 // backwards
1408 for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1409 it++)
1410 {
1411 std::ifstream logStream(*it);
1412 if (!logStream.is_open())
Jason M. Bills4978b632022-02-22 14:17:43 -08001413 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001414 continue;
Jason M. Bills4978b632022-02-22 14:17:43 -08001415 }
Jason M. Bills897967d2019-07-29 17:05:30 -07001416
Ed Tanous002d39b2022-05-31 08:59:27 -07001417 // Reset the unique ID on the first entry
1418 bool firstEntry = true;
1419 while (std::getline(logStream, logEntry))
Jason M. Bills4978b632022-02-22 14:17:43 -08001420 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001421 std::string idStr;
1422 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
Jason M. Bills4978b632022-02-22 14:17:43 -08001423 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001424 continue;
1425 }
Jason M. Billsefde4ec2022-06-24 08:59:52 -07001426 firstEntry = false;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001427
Jason M. Billsde703c52022-06-23 14:19:04 -07001428 nlohmann::json::object_t bmcLogEntry;
Patrick Williams89492a12023-05-10 07:51:34 -05001429 LogParseError status = fillEventLogEntryJson(idStr, logEntry,
1430 bmcLogEntry);
Jason M. Billsac992cd2022-06-24 13:31:46 -07001431 if (status == LogParseError::messageIdNotInRegistry)
1432 {
1433 continue;
1434 }
1435 if (status != LogParseError::success)
Ed Tanous002d39b2022-05-31 08:59:27 -07001436 {
1437 messages::internalError(asyncResp->res);
1438 return;
Andrew Geisslercb92c032018-08-17 07:56:14 -07001439 }
Jason M. Billsde703c52022-06-23 14:19:04 -07001440
Jason M. Billsde703c52022-06-23 14:19:04 -07001441 entryCount++;
1442 // Handle paging using skip (number of entries to skip from the
1443 // start) and top (number of entries to display)
Ed Tanous3648c8b2022-07-25 13:39:59 -07001444 if (entryCount <= skip || entryCount > skip + top)
Jason M. Billsde703c52022-06-23 14:19:04 -07001445 {
1446 continue;
1447 }
1448
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001449 logEntryArray.emplace_back(std::move(bmcLogEntry));
Jason M. Bills4978b632022-02-22 14:17:43 -08001450 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001451 }
1452 asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
Ed Tanous3648c8b2022-07-25 13:39:59 -07001453 if (skip + top < entryCount)
Ed Tanous002d39b2022-05-31 08:59:27 -07001454 {
1455 asyncResp->res.jsonValue["Members@odata.nextLink"] =
1456 "/redfish/v1/Systems/system/LogServices/EventLog/Entries?$skip=" +
Ed Tanous3648c8b2022-07-25 13:39:59 -07001457 std::to_string(skip + top);
Ed Tanous002d39b2022-05-31 08:59:27 -07001458 }
Jason M. Bills4978b632022-02-22 14:17:43 -08001459 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001460}
Chicago Duan336e96c2019-07-15 14:22:08 +08001461
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001462inline void requestRoutesJournalEventLogEntry(App& app)
1463{
1464 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001465 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001466 .privileges(redfish::privileges::getLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001467 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07001468 [&app](const crow::Request& req,
1469 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07001470 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001471 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001472 {
1473 return;
1474 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001475 if constexpr (bmcwebEnableMultiHost)
1476 {
1477 // Option currently returns no systems. TBD
1478 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1479 systemName);
1480 return;
1481 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001482
1483 if (systemName != "system")
1484 {
1485 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1486 systemName);
1487 return;
1488 }
1489
Ed Tanous002d39b2022-05-31 08:59:27 -07001490 const std::string& targetID = param;
1491
1492 // Go through the log files and check the unique ID for each
1493 // entry to find the target entry
1494 std::vector<std::filesystem::path> redfishLogFiles;
1495 getRedfishLogFiles(redfishLogFiles);
1496 std::string logEntry;
1497
1498 // Oldest logs are in the last file, so start there and loop
1499 // backwards
1500 for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1501 it++)
1502 {
1503 std::ifstream logStream(*it);
1504 if (!logStream.is_open())
1505 {
1506 continue;
1507 }
1508
1509 // Reset the unique ID on the first entry
1510 bool firstEntry = true;
1511 while (std::getline(logStream, logEntry))
1512 {
1513 std::string idStr;
1514 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
Ed Tanous45ca1b82022-03-25 13:07:27 -07001515 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001516 continue;
1517 }
Jason M. Billsefde4ec2022-06-24 08:59:52 -07001518 firstEntry = false;
Ed Tanous002d39b2022-05-31 08:59:27 -07001519
1520 if (idStr == targetID)
1521 {
Jason M. Billsde703c52022-06-23 14:19:04 -07001522 nlohmann::json::object_t bmcLogEntry;
Jason M. Billsac992cd2022-06-24 13:31:46 -07001523 LogParseError status =
1524 fillEventLogEntryJson(idStr, logEntry, bmcLogEntry);
1525 if (status != LogParseError::success)
Ed Tanous002d39b2022-05-31 08:59:27 -07001526 {
1527 messages::internalError(asyncResp->res);
1528 return;
1529 }
Jason M. Billsd405bb52022-06-24 10:52:05 -07001530 asyncResp->res.jsonValue.update(bmcLogEntry);
Ed Tanous45ca1b82022-03-25 13:07:27 -07001531 return;
1532 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001533 }
1534 }
1535 // Requested ID was not found
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08001536 messages::resourceNotFound(asyncResp->res, "LogEntry", targetID);
Ed Tanous002d39b2022-05-31 08:59:27 -07001537 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001538}
1539
1540inline void requestRoutesDBusEventLogEntryCollection(App& app)
1541{
Ed Tanous22d268c2022-05-19 09:39:07 -07001542 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07001543 .privileges(redfish::privileges::getLogEntryCollection)
Ed Tanous002d39b2022-05-31 08:59:27 -07001544 .methods(boost::beast::http::verb::get)(
1545 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07001546 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1547 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001548 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001549 {
1550 return;
1551 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001552 if constexpr (bmcwebEnableMultiHost)
1553 {
1554 // Option currently returns no systems. TBD
1555 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1556 systemName);
1557 return;
1558 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001559 if (systemName != "system")
1560 {
1561 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1562 systemName);
1563 return;
1564 }
1565
Ed Tanous002d39b2022-05-31 08:59:27 -07001566 // Collections don't include the static data added by SubRoute
1567 // because it has a duplicate entry for members
1568 asyncResp->res.jsonValue["@odata.type"] =
1569 "#LogEntryCollection.LogEntryCollection";
1570 asyncResp->res.jsonValue["@odata.id"] =
1571 "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1572 asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1573 asyncResp->res.jsonValue["Description"] =
1574 "Collection of System Event Log Entries";
1575
1576 // DBus implementation of EventLog/Entries
1577 // Make call to Logging Service to find all log entry objects
George Liu5eb468d2023-06-20 17:03:24 +08001578 sdbusplus::message::object_path path("/xyz/openbmc_project/logging");
1579 dbus::utility::getManagedObjects(
1580 "xyz.openbmc_project.Logging", path,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001581 [asyncResp](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07001582 const dbus::utility::ManagedObjectType& resp) {
1583 if (ec)
Ed Tanous45ca1b82022-03-25 13:07:27 -07001584 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001585 // TODO Handle for specific error code
Ed Tanous62598e32023-07-17 17:06:25 -07001586 BMCWEB_LOG_ERROR(
1587 "getLogEntriesIfaceData resp_handler got error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07001588 messages::internalError(asyncResp->res);
Ed Tanous45ca1b82022-03-25 13:07:27 -07001589 return;
1590 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001591 nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
1592 entriesArray = nlohmann::json::array();
1593 for (const auto& objectPath : resp)
1594 {
1595 const uint32_t* id = nullptr;
1596 const uint64_t* timestamp = nullptr;
1597 const uint64_t* updateTimestamp = nullptr;
1598 const std::string* severity = nullptr;
1599 const std::string* message = nullptr;
1600 const std::string* filePath = nullptr;
Vijay Lobo9c11a172021-10-07 16:53:16 -05001601 const std::string* resolution = nullptr;
Ed Tanous002d39b2022-05-31 08:59:27 -07001602 bool resolved = false;
Abhishek Patel9017faf2021-09-14 22:48:55 -05001603 const std::string* notify = nullptr;
1604
Ed Tanous002d39b2022-05-31 08:59:27 -07001605 for (const auto& interfaceMap : objectPath.second)
1606 {
1607 if (interfaceMap.first ==
1608 "xyz.openbmc_project.Logging.Entry")
Xiaochao Ma75710de2021-01-21 17:56:02 +08001609 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001610 for (const auto& propertyMap : interfaceMap.second)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001611 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001612 if (propertyMap.first == "Id")
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001613 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001614 id = std::get_if<uint32_t>(&propertyMap.second);
1615 }
1616 else if (propertyMap.first == "Timestamp")
1617 {
1618 timestamp =
1619 std::get_if<uint64_t>(&propertyMap.second);
1620 }
1621 else if (propertyMap.first == "UpdateTimestamp")
1622 {
1623 updateTimestamp =
1624 std::get_if<uint64_t>(&propertyMap.second);
1625 }
1626 else if (propertyMap.first == "Severity")
1627 {
1628 severity = std::get_if<std::string>(
1629 &propertyMap.second);
1630 }
Vijay Lobo9c11a172021-10-07 16:53:16 -05001631 else if (propertyMap.first == "Resolution")
1632 {
1633 resolution = std::get_if<std::string>(
1634 &propertyMap.second);
1635 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001636 else if (propertyMap.first == "Message")
1637 {
1638 message = std::get_if<std::string>(
1639 &propertyMap.second);
1640 }
1641 else if (propertyMap.first == "Resolved")
1642 {
1643 const bool* resolveptr =
1644 std::get_if<bool>(&propertyMap.second);
1645 if (resolveptr == nullptr)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001646 {
1647 messages::internalError(asyncResp->res);
1648 return;
1649 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001650 resolved = *resolveptr;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001651 }
Abhishek Patel9017faf2021-09-14 22:48:55 -05001652 else if (propertyMap.first ==
1653 "ServiceProviderNotify")
1654 {
1655 notify = std::get_if<std::string>(
1656 &propertyMap.second);
1657 if (notify == nullptr)
1658 {
1659 messages::internalError(asyncResp->res);
1660 return;
1661 }
1662 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001663 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001664 if (id == nullptr || message == nullptr ||
Ed Tanous002d39b2022-05-31 08:59:27 -07001665 severity == nullptr)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001666 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001667 messages::internalError(asyncResp->res);
1668 return;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001669 }
1670 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001671 else if (interfaceMap.first ==
1672 "xyz.openbmc_project.Common.FilePath")
1673 {
1674 for (const auto& propertyMap : interfaceMap.second)
1675 {
1676 if (propertyMap.first == "Path")
1677 {
1678 filePath = std::get_if<std::string>(
1679 &propertyMap.second);
1680 }
1681 }
1682 }
1683 }
1684 // Object path without the
1685 // xyz.openbmc_project.Logging.Entry interface, ignore
1686 // and continue.
1687 if (id == nullptr || message == nullptr ||
1688 severity == nullptr || timestamp == nullptr ||
1689 updateTimestamp == nullptr)
1690 {
1691 continue;
1692 }
1693 entriesArray.push_back({});
1694 nlohmann::json& thisEntry = entriesArray.back();
Vijay Lobo9c11a172021-10-07 16:53:16 -05001695 thisEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07001696 thisEntry["@odata.id"] = boost::urls::format(
1697 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}",
1698 std::to_string(*id));
Ed Tanous002d39b2022-05-31 08:59:27 -07001699 thisEntry["Name"] = "System Event Log Entry";
1700 thisEntry["Id"] = std::to_string(*id);
1701 thisEntry["Message"] = *message;
1702 thisEntry["Resolved"] = resolved;
Vijay Lobo9c11a172021-10-07 16:53:16 -05001703 if ((resolution != nullptr) && (!(*resolution).empty()))
1704 {
1705 thisEntry["Resolution"] = *resolution;
1706 }
Abhishek Patel9017faf2021-09-14 22:48:55 -05001707 std::optional<bool> notifyAction =
1708 getProviderNotifyAction(*notify);
1709 if (notifyAction)
1710 {
1711 thisEntry["ServiceProviderNotified"] = *notifyAction;
1712 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001713 thisEntry["EntryType"] = "Event";
1714 thisEntry["Severity"] =
1715 translateSeverityDbusToRedfish(*severity);
1716 thisEntry["Created"] =
Ed Tanous2b829372022-08-03 14:22:34 -07001717 redfish::time_utils::getDateTimeUintMs(*timestamp);
Ed Tanous002d39b2022-05-31 08:59:27 -07001718 thisEntry["Modified"] =
Ed Tanous2b829372022-08-03 14:22:34 -07001719 redfish::time_utils::getDateTimeUintMs(*updateTimestamp);
Ed Tanous002d39b2022-05-31 08:59:27 -07001720 if (filePath != nullptr)
1721 {
1722 thisEntry["AdditionalDataURI"] =
1723 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
1724 std::to_string(*id) + "/attachment";
1725 }
1726 }
1727 std::sort(
1728 entriesArray.begin(), entriesArray.end(),
1729 [](const nlohmann::json& left, const nlohmann::json& right) {
1730 return (left["Id"] <= right["Id"]);
1731 });
1732 asyncResp->res.jsonValue["Members@odata.count"] =
1733 entriesArray.size();
George Liu5eb468d2023-06-20 17:03:24 +08001734 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001735 });
1736}
Xiaochao Ma75710de2021-01-21 17:56:02 +08001737
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001738inline void requestRoutesDBusEventLogEntry(App& app)
Adriana Kobylak400fd1f2021-01-29 09:01:30 -06001739{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001740 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001741 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001742 .privileges(redfish::privileges::getLogEntry)
Ed Tanous002d39b2022-05-31 08:59:27 -07001743 .methods(boost::beast::http::verb::get)(
1744 [&app](const crow::Request& req,
1745 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07001746 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001747 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001748 {
1749 return;
1750 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001751 if constexpr (bmcwebEnableMultiHost)
1752 {
1753 // Option currently returns no systems. TBD
1754 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1755 systemName);
1756 return;
1757 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001758 if (systemName != "system")
1759 {
1760 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1761 systemName);
1762 return;
1763 }
1764
Ed Tanous002d39b2022-05-31 08:59:27 -07001765 std::string entryID = param;
1766 dbus::utility::escapePathForDbus(entryID);
1767
1768 // DBus implementation of EventLog/Entries
1769 // Make call to Logging Service to find all log entry objects
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001770 sdbusplus::asio::getAllProperties(
1771 *crow::connections::systemBus, "xyz.openbmc_project.Logging",
1772 "/xyz/openbmc_project/logging/entry/" + entryID, "",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001773 [asyncResp, entryID](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07001774 const dbus::utility::DBusPropertiesMap& resp) {
1775 if (ec.value() == EBADR)
Adriana Kobylak400fd1f2021-01-29 09:01:30 -06001776 {
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001777 messages::resourceNotFound(asyncResp->res, "EventLogEntry",
1778 entryID);
Ed Tanous45ca1b82022-03-25 13:07:27 -07001779 return;
1780 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001781 if (ec)
1782 {
Ed Tanous62598e32023-07-17 17:06:25 -07001783 BMCWEB_LOG_ERROR(
1784 "EventLogEntry (DBus) resp_handler got error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07001785 messages::internalError(asyncResp->res);
1786 return;
1787 }
1788 const uint32_t* id = nullptr;
1789 const uint64_t* timestamp = nullptr;
1790 const uint64_t* updateTimestamp = nullptr;
1791 const std::string* severity = nullptr;
1792 const std::string* message = nullptr;
1793 const std::string* filePath = nullptr;
Vijay Lobo9c11a172021-10-07 16:53:16 -05001794 const std::string* resolution = nullptr;
Ed Tanous002d39b2022-05-31 08:59:27 -07001795 bool resolved = false;
Abhishek Patel9017faf2021-09-14 22:48:55 -05001796 const std::string* notify = nullptr;
Adriana Kobylak400fd1f2021-01-29 09:01:30 -06001797
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001798 const bool success = sdbusplus::unpackPropertiesNoThrow(
1799 dbus_utils::UnpackErrorPrinter(), resp, "Id", id, "Timestamp",
1800 timestamp, "UpdateTimestamp", updateTimestamp, "Severity",
Vijay Lobo9c11a172021-10-07 16:53:16 -05001801 severity, "Message", message, "Resolved", resolved,
Abhishek Patel9017faf2021-09-14 22:48:55 -05001802 "Resolution", resolution, "Path", filePath,
1803 "ServiceProviderNotify", notify);
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001804
1805 if (!success)
Ed Tanous002d39b2022-05-31 08:59:27 -07001806 {
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001807 messages::internalError(asyncResp->res);
1808 return;
Ed Tanous002d39b2022-05-31 08:59:27 -07001809 }
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001810
Ed Tanous002d39b2022-05-31 08:59:27 -07001811 if (id == nullptr || message == nullptr || severity == nullptr ||
Abhishek Patel9017faf2021-09-14 22:48:55 -05001812 timestamp == nullptr || updateTimestamp == nullptr ||
1813 notify == nullptr)
Ed Tanous002d39b2022-05-31 08:59:27 -07001814 {
1815 messages::internalError(asyncResp->res);
1816 return;
1817 }
Abhishek Patel9017faf2021-09-14 22:48:55 -05001818
Ed Tanous002d39b2022-05-31 08:59:27 -07001819 asyncResp->res.jsonValue["@odata.type"] =
Vijay Lobo9c11a172021-10-07 16:53:16 -05001820 "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07001821 asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
1822 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}",
1823 std::to_string(*id));
Ed Tanous002d39b2022-05-31 08:59:27 -07001824 asyncResp->res.jsonValue["Name"] = "System Event Log Entry";
1825 asyncResp->res.jsonValue["Id"] = std::to_string(*id);
1826 asyncResp->res.jsonValue["Message"] = *message;
1827 asyncResp->res.jsonValue["Resolved"] = resolved;
Abhishek Patel9017faf2021-09-14 22:48:55 -05001828 std::optional<bool> notifyAction = getProviderNotifyAction(*notify);
1829 if (notifyAction)
1830 {
1831 asyncResp->res.jsonValue["ServiceProviderNotified"] =
1832 *notifyAction;
1833 }
Vijay Lobo9c11a172021-10-07 16:53:16 -05001834 if ((resolution != nullptr) && (!(*resolution).empty()))
1835 {
1836 asyncResp->res.jsonValue["Resolution"] = *resolution;
1837 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001838 asyncResp->res.jsonValue["EntryType"] = "Event";
1839 asyncResp->res.jsonValue["Severity"] =
1840 translateSeverityDbusToRedfish(*severity);
1841 asyncResp->res.jsonValue["Created"] =
Ed Tanous2b829372022-08-03 14:22:34 -07001842 redfish::time_utils::getDateTimeUintMs(*timestamp);
Ed Tanous002d39b2022-05-31 08:59:27 -07001843 asyncResp->res.jsonValue["Modified"] =
Ed Tanous2b829372022-08-03 14:22:34 -07001844 redfish::time_utils::getDateTimeUintMs(*updateTimestamp);
Ed Tanous002d39b2022-05-31 08:59:27 -07001845 if (filePath != nullptr)
1846 {
1847 asyncResp->res.jsonValue["AdditionalDataURI"] =
1848 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
1849 std::to_string(*id) + "/attachment";
1850 }
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001851 });
Ed Tanous45ca1b82022-03-25 13:07:27 -07001852 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001853
1854 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001855 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001856 .privileges(redfish::privileges::patchLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001857 .methods(boost::beast::http::verb::patch)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07001858 [&app](const crow::Request& req,
1859 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07001860 const std::string& systemName, const std::string& entryId) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001861 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001862 {
1863 return;
1864 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001865 if constexpr (bmcwebEnableMultiHost)
1866 {
1867 // Option currently returns no systems. TBD
1868 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1869 systemName);
1870 return;
1871 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001872 if (systemName != "system")
1873 {
1874 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1875 systemName);
1876 return;
1877 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001878 std::optional<bool> resolved;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001879
Ed Tanous002d39b2022-05-31 08:59:27 -07001880 if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved",
1881 resolved))
1882 {
1883 return;
1884 }
Ed Tanous62598e32023-07-17 17:06:25 -07001885 BMCWEB_LOG_DEBUG("Set Resolved");
Adriana Kobylak400fd1f2021-01-29 09:01:30 -06001886
George Liu9ae226f2023-06-21 17:56:46 +08001887 sdbusplus::asio::setProperty(
1888 *crow::connections::systemBus, "xyz.openbmc_project.Logging",
1889 "/xyz/openbmc_project/logging/entry/" + entryId,
1890 "xyz.openbmc_project.Logging.Entry", "Resolved", *resolved,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001891 [asyncResp, entryId](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001892 if (ec)
1893 {
Ed Tanous62598e32023-07-17 17:06:25 -07001894 BMCWEB_LOG_DEBUG("DBUS response error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07001895 messages::internalError(asyncResp->res);
1896 return;
1897 }
George Liu9ae226f2023-06-21 17:56:46 +08001898 });
Ed Tanous002d39b2022-05-31 08:59:27 -07001899 });
Adriana Kobylak400fd1f2021-01-29 09:01:30 -06001900
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001901 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001902 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001903 .privileges(redfish::privileges::deleteLogEntry)
1904
Ed Tanous002d39b2022-05-31 08:59:27 -07001905 .methods(boost::beast::http::verb::delete_)(
1906 [&app](const crow::Request& req,
1907 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07001908 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001909 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001910 {
1911 return;
1912 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001913 if constexpr (bmcwebEnableMultiHost)
1914 {
1915 // Option currently returns no systems. TBD
1916 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1917 systemName);
1918 return;
1919 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001920 if (systemName != "system")
1921 {
1922 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1923 systemName);
1924 return;
1925 }
Ed Tanous62598e32023-07-17 17:06:25 -07001926 BMCWEB_LOG_DEBUG("Do delete single event entries.");
Ed Tanous002d39b2022-05-31 08:59:27 -07001927
1928 std::string entryID = param;
1929
1930 dbus::utility::escapePathForDbus(entryID);
1931
1932 // Process response from Logging service.
1933 auto respHandler =
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001934 [asyncResp, entryID](const boost::system::error_code& ec) {
Ed Tanous62598e32023-07-17 17:06:25 -07001935 BMCWEB_LOG_DEBUG("EventLogEntry (DBus) doDelete callback: Done");
Ed Tanous002d39b2022-05-31 08:59:27 -07001936 if (ec)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001937 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001938 if (ec.value() == EBADR)
Ed Tanous45ca1b82022-03-25 13:07:27 -07001939 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001940 messages::resourceNotFound(asyncResp->res, "LogEntry",
1941 entryID);
Ed Tanous45ca1b82022-03-25 13:07:27 -07001942 return;
1943 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001944 // TODO Handle for specific error code
Ed Tanous62598e32023-07-17 17:06:25 -07001945 BMCWEB_LOG_ERROR(
1946 "EventLogEntry (DBus) doDelete respHandler got error {}",
1947 ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07001948 asyncResp->res.result(
1949 boost::beast::http::status::internal_server_error);
1950 return;
1951 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001952
Ed Tanous002d39b2022-05-31 08:59:27 -07001953 asyncResp->res.result(boost::beast::http::status::ok);
1954 };
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001955
Ed Tanous002d39b2022-05-31 08:59:27 -07001956 // Make call to Logging service to request Delete Log
1957 crow::connections::systemBus->async_method_call(
1958 respHandler, "xyz.openbmc_project.Logging",
1959 "/xyz/openbmc_project/logging/entry/" + entryID,
1960 "xyz.openbmc_project.Object.Delete", "Delete");
Ed Tanous45ca1b82022-03-25 13:07:27 -07001961 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001962}
1963
1964inline void requestRoutesDBusEventLogEntryDownload(App& app)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001965{
George Liu0fda0f12021-11-16 10:06:17 +08001966 BMCWEB_ROUTE(
1967 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07001968 "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/attachment")
Ed Tanoused398212021-06-09 17:05:54 -07001969 .privileges(redfish::privileges::getLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001970 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07001971 [&app](const crow::Request& req,
1972 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07001973 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001974 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001975 {
1976 return;
1977 }
Matt Spinler72e21372023-04-19 12:53:33 -05001978 if (!http_helpers::isContentTypeAllowed(
Ed Tanous99351cd2022-08-07 16:42:51 -07001979 req.getHeaderValue("Accept"),
Ed Tanous4a0e1a02022-09-21 15:28:04 -07001980 http_helpers::ContentType::OctetStream, true))
Ed Tanous002d39b2022-05-31 08:59:27 -07001981 {
1982 asyncResp->res.result(boost::beast::http::status::bad_request);
1983 return;
1984 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08001985 if constexpr (bmcwebEnableMultiHost)
1986 {
1987 // Option currently returns no systems. TBD
1988 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1989 systemName);
1990 return;
1991 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001992 if (systemName != "system")
1993 {
1994 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1995 systemName);
1996 return;
1997 }
zhanghch058d1b46d2021-04-01 11:18:24 +08001998
Ed Tanous002d39b2022-05-31 08:59:27 -07001999 std::string entryID = param;
2000 dbus::utility::escapePathForDbus(entryID);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002001
Ed Tanous002d39b2022-05-31 08:59:27 -07002002 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002003 [asyncResp, entryID](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07002004 const sdbusplus::message::unix_fd& unixfd) {
2005 if (ec.value() == EBADR)
2006 {
2007 messages::resourceNotFound(asyncResp->res, "EventLogAttachment",
2008 entryID);
2009 return;
2010 }
2011 if (ec)
2012 {
Ed Tanous62598e32023-07-17 17:06:25 -07002013 BMCWEB_LOG_DEBUG("DBUS response error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07002014 messages::internalError(asyncResp->res);
2015 return;
2016 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002017
Ed Tanous002d39b2022-05-31 08:59:27 -07002018 int fd = -1;
2019 fd = dup(unixfd);
2020 if (fd == -1)
2021 {
2022 messages::internalError(asyncResp->res);
2023 return;
2024 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002025
Ed Tanous002d39b2022-05-31 08:59:27 -07002026 long long int size = lseek(fd, 0, SEEK_END);
2027 if (size == -1)
2028 {
2029 messages::internalError(asyncResp->res);
2030 return;
2031 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002032
Ed Tanous002d39b2022-05-31 08:59:27 -07002033 // Arbitrary max size of 64kb
2034 constexpr int maxFileSize = 65536;
2035 if (size > maxFileSize)
2036 {
Ed Tanous62598e32023-07-17 17:06:25 -07002037 BMCWEB_LOG_ERROR("File size exceeds maximum allowed size of {}",
2038 maxFileSize);
Ed Tanous002d39b2022-05-31 08:59:27 -07002039 messages::internalError(asyncResp->res);
2040 return;
2041 }
2042 std::vector<char> data(static_cast<size_t>(size));
2043 long long int rc = lseek(fd, 0, SEEK_SET);
2044 if (rc == -1)
2045 {
2046 messages::internalError(asyncResp->res);
2047 return;
2048 }
2049 rc = read(fd, data.data(), data.size());
2050 if ((rc == -1) || (rc != size))
2051 {
2052 messages::internalError(asyncResp->res);
2053 return;
2054 }
2055 close(fd);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002056
Ed Tanous002d39b2022-05-31 08:59:27 -07002057 std::string_view strData(data.data(), data.size());
2058 std::string output = crow::utility::base64encode(strData);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002059
Ed Tanousd9f6c622022-03-17 09:12:17 -07002060 asyncResp->res.addHeader(boost::beast::http::field::content_type,
Ed Tanous002d39b2022-05-31 08:59:27 -07002061 "application/octet-stream");
Ed Tanousd9f6c622022-03-17 09:12:17 -07002062 asyncResp->res.addHeader(
2063 boost::beast::http::field::content_transfer_encoding, "Base64");
Ed Tanous002d39b2022-05-31 08:59:27 -07002064 asyncResp->res.body() = std::move(output);
2065 },
2066 "xyz.openbmc_project.Logging",
2067 "/xyz/openbmc_project/logging/entry/" + entryID,
2068 "xyz.openbmc_project.Logging.Entry", "GetEntry");
2069 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002070}
2071
Spencer Kub7028eb2021-10-26 15:27:35 +08002072constexpr const char* hostLoggerFolderPath = "/var/log/console";
2073
2074inline bool
2075 getHostLoggerFiles(const std::string& hostLoggerFilePath,
2076 std::vector<std::filesystem::path>& hostLoggerFiles)
2077{
2078 std::error_code ec;
2079 std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec);
2080 if (ec)
2081 {
Ed Tanous62598e32023-07-17 17:06:25 -07002082 BMCWEB_LOG_ERROR("{}", ec.message());
Spencer Kub7028eb2021-10-26 15:27:35 +08002083 return false;
2084 }
2085 for (const std::filesystem::directory_entry& it : logPath)
2086 {
2087 std::string filename = it.path().filename();
2088 // Prefix of each log files is "log". Find the file and save the
2089 // path
Ed Tanous11ba3972022-07-11 09:50:41 -07002090 if (filename.starts_with("log"))
Spencer Kub7028eb2021-10-26 15:27:35 +08002091 {
2092 hostLoggerFiles.emplace_back(it.path());
2093 }
2094 }
2095 // As the log files rotate, they are appended with a ".#" that is higher for
2096 // the older logs. Since we start from oldest logs, sort the name in
2097 // descending order.
2098 std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(),
2099 AlphanumLess<std::string>());
2100
2101 return true;
2102}
2103
Ed Tanous02cad962022-06-30 16:50:15 -07002104inline bool getHostLoggerEntries(
2105 const std::vector<std::filesystem::path>& hostLoggerFiles, uint64_t skip,
2106 uint64_t top, std::vector<std::string>& logEntries, size_t& logCount)
Spencer Kub7028eb2021-10-26 15:27:35 +08002107{
2108 GzFileReader logFile;
2109
2110 // Go though all log files and expose host logs.
2111 for (const std::filesystem::path& it : hostLoggerFiles)
2112 {
2113 if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount))
2114 {
Ed Tanous62598e32023-07-17 17:06:25 -07002115 BMCWEB_LOG_ERROR("fail to expose host logs");
Spencer Kub7028eb2021-10-26 15:27:35 +08002116 return false;
2117 }
2118 }
2119 // Get lastMessage from constructor by getter
2120 std::string lastMessage = logFile.getLastMessage();
2121 if (!lastMessage.empty())
2122 {
2123 logCount++;
2124 if (logCount > skip && logCount <= (skip + top))
2125 {
2126 logEntries.push_back(lastMessage);
2127 }
2128 }
2129 return true;
2130}
2131
2132inline void fillHostLoggerEntryJson(const std::string& logEntryID,
2133 const std::string& msg,
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002134 nlohmann::json::object_t& logEntryJson)
Spencer Kub7028eb2021-10-26 15:27:35 +08002135{
2136 // Fill in the log entry with the gathered data.
Vijay Lobo9c11a172021-10-07 16:53:16 -05002137 logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07002138 logEntryJson["@odata.id"] = boost::urls::format(
2139 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/{}",
2140 logEntryID);
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002141 logEntryJson["Name"] = "Host Logger Entry";
2142 logEntryJson["Id"] = logEntryID;
2143 logEntryJson["Message"] = msg;
2144 logEntryJson["EntryType"] = "Oem";
2145 logEntryJson["Severity"] = "OK";
2146 logEntryJson["OemRecordFormat"] = "Host Logger Entry";
Spencer Kub7028eb2021-10-26 15:27:35 +08002147}
2148
2149inline void requestRoutesSystemHostLogger(App& app)
2150{
Ed Tanous22d268c2022-05-19 09:39:07 -07002151 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/")
Spencer Kub7028eb2021-10-26 15:27:35 +08002152 .privileges(redfish::privileges::getLogService)
Ed Tanous14766872022-03-15 10:44:42 -07002153 .methods(boost::beast::http::verb::get)(
2154 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07002155 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2156 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002157 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002158 {
2159 return;
2160 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002161 if constexpr (bmcwebEnableMultiHost)
2162 {
2163 // Option currently returns no systems. TBD
2164 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2165 systemName);
2166 return;
2167 }
Ed Tanous22d268c2022-05-19 09:39:07 -07002168 if (systemName != "system")
2169 {
2170 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2171 systemName);
2172 return;
2173 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002174 asyncResp->res.jsonValue["@odata.id"] =
2175 "/redfish/v1/Systems/system/LogServices/HostLogger";
2176 asyncResp->res.jsonValue["@odata.type"] =
2177 "#LogService.v1_1_0.LogService";
2178 asyncResp->res.jsonValue["Name"] = "Host Logger Service";
2179 asyncResp->res.jsonValue["Description"] = "Host Logger Service";
2180 asyncResp->res.jsonValue["Id"] = "HostLogger";
2181 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
2182 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries";
2183 });
Spencer Kub7028eb2021-10-26 15:27:35 +08002184}
2185
2186inline void requestRoutesSystemHostLoggerCollection(App& app)
2187{
2188 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002189 "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/")
Spencer Kub7028eb2021-10-26 15:27:35 +08002190 .privileges(redfish::privileges::getLogEntry)
Ed Tanous002d39b2022-05-31 08:59:27 -07002191 .methods(boost::beast::http::verb::get)(
2192 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07002193 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2194 const std::string& systemName) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002195 query_param::QueryCapabilities capabilities = {
2196 .canDelegateTop = true,
2197 .canDelegateSkip = true,
2198 };
2199 query_param::Query delegatedQuery;
2200 if (!redfish::setUpRedfishRouteWithDelegation(
Carson Labrado3ba00072022-06-06 19:40:56 +00002201 app, req, asyncResp, delegatedQuery, capabilities))
Ed Tanous002d39b2022-05-31 08:59:27 -07002202 {
2203 return;
2204 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002205 if constexpr (bmcwebEnableMultiHost)
2206 {
2207 // Option currently returns no systems. TBD
2208 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2209 systemName);
2210 return;
2211 }
Ed Tanous22d268c2022-05-19 09:39:07 -07002212 if (systemName != "system")
2213 {
2214 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2215 systemName);
2216 return;
2217 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002218 asyncResp->res.jsonValue["@odata.id"] =
2219 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries";
2220 asyncResp->res.jsonValue["@odata.type"] =
2221 "#LogEntryCollection.LogEntryCollection";
2222 asyncResp->res.jsonValue["Name"] = "HostLogger Entries";
2223 asyncResp->res.jsonValue["Description"] =
2224 "Collection of HostLogger Entries";
2225 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2226 logEntryArray = nlohmann::json::array();
2227 asyncResp->res.jsonValue["Members@odata.count"] = 0;
Spencer Kub7028eb2021-10-26 15:27:35 +08002228
Ed Tanous002d39b2022-05-31 08:59:27 -07002229 std::vector<std::filesystem::path> hostLoggerFiles;
2230 if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles))
2231 {
Ed Tanous62598e32023-07-17 17:06:25 -07002232 BMCWEB_LOG_ERROR("fail to get host log file path");
Ed Tanous002d39b2022-05-31 08:59:27 -07002233 return;
2234 }
Ed Tanous3648c8b2022-07-25 13:39:59 -07002235 // If we weren't provided top and skip limits, use the defaults.
2236 size_t skip = delegatedQuery.skip.value_or(0);
Jiaqing Zhao5143f7a2022-07-22 09:33:33 +08002237 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
Ed Tanous002d39b2022-05-31 08:59:27 -07002238 size_t logCount = 0;
2239 // This vector only store the entries we want to expose that
2240 // control by skip and top.
2241 std::vector<std::string> logEntries;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002242 if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries,
2243 logCount))
Ed Tanous002d39b2022-05-31 08:59:27 -07002244 {
2245 messages::internalError(asyncResp->res);
2246 return;
2247 }
2248 // If vector is empty, that means skip value larger than total
2249 // log count
2250 if (logEntries.empty())
2251 {
2252 asyncResp->res.jsonValue["Members@odata.count"] = logCount;
2253 return;
2254 }
2255 if (!logEntries.empty())
2256 {
2257 for (size_t i = 0; i < logEntries.size(); i++)
George Liu0fda0f12021-11-16 10:06:17 +08002258 {
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002259 nlohmann::json::object_t hostLogEntry;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002260 fillHostLoggerEntryJson(std::to_string(skip + i), logEntries[i],
2261 hostLogEntry);
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002262 logEntryArray.emplace_back(std::move(hostLogEntry));
George Liu0fda0f12021-11-16 10:06:17 +08002263 }
2264
Ed Tanous002d39b2022-05-31 08:59:27 -07002265 asyncResp->res.jsonValue["Members@odata.count"] = logCount;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002266 if (skip + top < logCount)
George Liu0fda0f12021-11-16 10:06:17 +08002267 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002268 asyncResp->res.jsonValue["Members@odata.nextLink"] =
2269 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" +
Ed Tanous3648c8b2022-07-25 13:39:59 -07002270 std::to_string(skip + top);
George Liu0fda0f12021-11-16 10:06:17 +08002271 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002272 }
George Liu0fda0f12021-11-16 10:06:17 +08002273 });
Spencer Kub7028eb2021-10-26 15:27:35 +08002274}
2275
2276inline void requestRoutesSystemHostLoggerLogEntry(App& app)
2277{
2278 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07002279 app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/<str>/")
Spencer Kub7028eb2021-10-26 15:27:35 +08002280 .privileges(redfish::privileges::getLogEntry)
2281 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07002282 [&app](const crow::Request& req,
2283 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07002284 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002285 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002286 {
2287 return;
2288 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002289 if constexpr (bmcwebEnableMultiHost)
2290 {
2291 // Option currently returns no systems. TBD
2292 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2293 systemName);
2294 return;
2295 }
Ed Tanous22d268c2022-05-19 09:39:07 -07002296 if (systemName != "system")
2297 {
2298 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2299 systemName);
2300 return;
2301 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002302 const std::string& targetID = param;
Spencer Kub7028eb2021-10-26 15:27:35 +08002303
Ed Tanous002d39b2022-05-31 08:59:27 -07002304 uint64_t idInt = 0;
Ed Tanousca45aa32022-01-07 09:28:45 -08002305
Patrick Williams84396af2023-05-11 11:47:45 -05002306 auto [ptr, ec] = std::from_chars(&*targetID.begin(), &*targetID.end(),
2307 idInt);
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08002308 if (ec == std::errc::invalid_argument ||
2309 ec == std::errc::result_out_of_range)
Ed Tanous002d39b2022-05-31 08:59:27 -07002310 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08002311 messages::resourceNotFound(asyncResp->res, "LogEntry", param);
Ed Tanous002d39b2022-05-31 08:59:27 -07002312 return;
2313 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002314
Ed Tanous002d39b2022-05-31 08:59:27 -07002315 std::vector<std::filesystem::path> hostLoggerFiles;
2316 if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles))
2317 {
Ed Tanous62598e32023-07-17 17:06:25 -07002318 BMCWEB_LOG_ERROR("fail to get host log file path");
Ed Tanous002d39b2022-05-31 08:59:27 -07002319 return;
2320 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002321
Ed Tanous002d39b2022-05-31 08:59:27 -07002322 size_t logCount = 0;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002323 size_t top = 1;
Ed Tanous002d39b2022-05-31 08:59:27 -07002324 std::vector<std::string> logEntries;
2325 // We can get specific entry by skip and top. For example, if we
2326 // want to get nth entry, we can set skip = n-1 and top = 1 to
2327 // get that entry
2328 if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries,
2329 logCount))
2330 {
2331 messages::internalError(asyncResp->res);
2332 return;
2333 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002334
Ed Tanous002d39b2022-05-31 08:59:27 -07002335 if (!logEntries.empty())
2336 {
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002337 nlohmann::json::object_t hostLogEntry;
2338 fillHostLoggerEntryJson(targetID, logEntries[0], hostLogEntry);
2339 asyncResp->res.jsonValue.update(hostLogEntry);
Ed Tanous002d39b2022-05-31 08:59:27 -07002340 return;
2341 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002342
Ed Tanous002d39b2022-05-31 08:59:27 -07002343 // Requested ID was not found
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08002344 messages::resourceNotFound(asyncResp->res, "LogEntry", param);
Ed Tanous002d39b2022-05-31 08:59:27 -07002345 });
Spencer Kub7028eb2021-10-26 15:27:35 +08002346}
2347
Claire Weinandd72e872022-08-15 14:20:06 -07002348inline void handleBMCLogServicesCollectionGet(
Claire Weinanfdd26902022-03-01 14:18:25 -08002349 crow::App& app, const crow::Request& req,
2350 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2351{
2352 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2353 {
2354 return;
2355 }
2356 // Collections don't include the static data added by SubRoute
2357 // because it has a duplicate entry for members
2358 asyncResp->res.jsonValue["@odata.type"] =
2359 "#LogServiceCollection.LogServiceCollection";
2360 asyncResp->res.jsonValue["@odata.id"] =
2361 "/redfish/v1/Managers/bmc/LogServices";
2362 asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection";
2363 asyncResp->res.jsonValue["Description"] =
2364 "Collection of LogServices for this Manager";
2365 nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
2366 logServiceArray = nlohmann::json::array();
2367
2368#ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
Ed Tanous613dabe2022-07-09 11:17:36 -07002369 nlohmann::json::object_t journal;
2370 journal["@odata.id"] = "/redfish/v1/Managers/bmc/LogServices/Journal";
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002371 logServiceArray.emplace_back(std::move(journal));
Claire Weinanfdd26902022-03-01 14:18:25 -08002372#endif
2373
2374 asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size();
2375
2376#ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
George Liu15912152023-01-11 10:18:18 +08002377 constexpr std::array<std::string_view, 1> interfaces = {
George Liu7a1dbc42022-12-07 16:03:22 +08002378 "xyz.openbmc_project.Collection.DeleteAll"};
2379 dbus::utility::getSubTreePaths(
2380 "/xyz/openbmc_project/dump", 0, interfaces,
Claire Weinanfdd26902022-03-01 14:18:25 -08002381 [asyncResp](
George Liu7a1dbc42022-12-07 16:03:22 +08002382 const boost::system::error_code& ec,
Claire Weinanfdd26902022-03-01 14:18:25 -08002383 const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) {
2384 if (ec)
2385 {
Ed Tanous62598e32023-07-17 17:06:25 -07002386 BMCWEB_LOG_ERROR(
2387 "handleBMCLogServicesCollectionGet respHandler got error {}",
2388 ec);
Claire Weinanfdd26902022-03-01 14:18:25 -08002389 // Assume that getting an error simply means there are no dump
2390 // LogServices. Return without adding any error response.
2391 return;
2392 }
2393
2394 nlohmann::json& logServiceArrayLocal =
2395 asyncResp->res.jsonValue["Members"];
2396
2397 for (const std::string& path : subTreePaths)
2398 {
2399 if (path == "/xyz/openbmc_project/dump/bmc")
2400 {
Ed Tanous613dabe2022-07-09 11:17:36 -07002401 nlohmann::json::object_t member;
2402 member["@odata.id"] =
2403 "/redfish/v1/Managers/bmc/LogServices/Dump";
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002404 logServiceArrayLocal.emplace_back(std::move(member));
Claire Weinanfdd26902022-03-01 14:18:25 -08002405 }
2406 else if (path == "/xyz/openbmc_project/dump/faultlog")
2407 {
Ed Tanous613dabe2022-07-09 11:17:36 -07002408 nlohmann::json::object_t member;
2409 member["@odata.id"] =
2410 "/redfish/v1/Managers/bmc/LogServices/FaultLog";
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002411 logServiceArrayLocal.emplace_back(std::move(member));
Claire Weinanfdd26902022-03-01 14:18:25 -08002412 }
2413 }
2414
2415 asyncResp->res.jsonValue["Members@odata.count"] =
2416 logServiceArrayLocal.size();
George Liu7a1dbc42022-12-07 16:03:22 +08002417 });
Claire Weinanfdd26902022-03-01 14:18:25 -08002418#endif
2419}
2420
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002421inline void requestRoutesBMCLogServiceCollection(App& app)
2422{
2423 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/")
Gunnar Millsad89dcf2021-07-30 14:40:11 -05002424 .privileges(redfish::privileges::getLogServiceCollection)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002425 .methods(boost::beast::http::verb::get)(
Claire Weinandd72e872022-08-15 14:20:06 -07002426 std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002427}
Ed Tanous1da66f72018-07-27 16:13:37 -07002428
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002429inline void requestRoutesBMCJournalLogService(App& app)
Ed Tanous1da66f72018-07-27 16:13:37 -07002430{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002431 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/")
Ed Tanoused398212021-06-09 17:05:54 -07002432 .privileges(redfish::privileges::getLogService)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002433 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07002434 [&app](const crow::Request& req,
2435 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002436 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002437 {
2438 return;
2439 }
2440 asyncResp->res.jsonValue["@odata.type"] =
2441 "#LogService.v1_1_0.LogService";
2442 asyncResp->res.jsonValue["@odata.id"] =
2443 "/redfish/v1/Managers/bmc/LogServices/Journal";
2444 asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service";
2445 asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service";
Ed Tanoused34a4a2023-02-08 15:43:27 -08002446 asyncResp->res.jsonValue["Id"] = "Journal";
Ed Tanous002d39b2022-05-31 08:59:27 -07002447 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
Tejas Patil7c8c4052021-06-04 17:43:14 +05302448
Ed Tanous002d39b2022-05-31 08:59:27 -07002449 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07002450 redfish::time_utils::getDateTimeOffsetNow();
Ed Tanous002d39b2022-05-31 08:59:27 -07002451 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
2452 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
2453 redfishDateTimeOffset.second;
Tejas Patil7c8c4052021-06-04 17:43:14 +05302454
Ed Tanous002d39b2022-05-31 08:59:27 -07002455 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
2456 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
2457 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002458}
Jason M. Billse1f26342018-07-18 12:12:00 -07002459
Jason M. Bills3a48b3a2022-06-24 10:10:15 -07002460static int
2461 fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID,
2462 sd_journal* journal,
2463 nlohmann::json::object_t& bmcJournalLogEntryJson)
Jason M. Billse1f26342018-07-18 12:12:00 -07002464{
2465 // Get the Log Entry contents
2466 int ret = 0;
Jason M. Billse1f26342018-07-18 12:12:00 -07002467
Jason M. Billsa8fe54f2020-11-20 15:57:55 -08002468 std::string message;
2469 std::string_view syslogID;
2470 ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID);
2471 if (ret < 0)
2472 {
Ed Tanous62598e32023-07-17 17:06:25 -07002473 BMCWEB_LOG_ERROR("Failed to read SYSLOG_IDENTIFIER field: {}",
2474 strerror(-ret));
Jason M. Billsa8fe54f2020-11-20 15:57:55 -08002475 }
2476 if (!syslogID.empty())
2477 {
2478 message += std::string(syslogID) + ": ";
2479 }
2480
Ed Tanous39e77502019-03-04 17:35:53 -08002481 std::string_view msg;
Jason M. Bills16428a12018-11-02 12:42:29 -07002482 ret = getJournalMetadata(journal, "MESSAGE", msg);
Jason M. Billse1f26342018-07-18 12:12:00 -07002483 if (ret < 0)
2484 {
Ed Tanous62598e32023-07-17 17:06:25 -07002485 BMCWEB_LOG_ERROR("Failed to read MESSAGE field: {}", strerror(-ret));
Jason M. Billse1f26342018-07-18 12:12:00 -07002486 return 1;
2487 }
Jason M. Billsa8fe54f2020-11-20 15:57:55 -08002488 message += std::string(msg);
Jason M. Billse1f26342018-07-18 12:12:00 -07002489
2490 // Get the severity from the PRIORITY field
Ed Tanous271584a2019-07-09 16:24:22 -07002491 long int severity = 8; // Default to an invalid priority
Jason M. Bills16428a12018-11-02 12:42:29 -07002492 ret = getJournalMetadata(journal, "PRIORITY", 10, severity);
Jason M. Billse1f26342018-07-18 12:12:00 -07002493 if (ret < 0)
2494 {
Ed Tanous62598e32023-07-17 17:06:25 -07002495 BMCWEB_LOG_ERROR("Failed to read PRIORITY field: {}", strerror(-ret));
Jason M. Billse1f26342018-07-18 12:12:00 -07002496 }
Jason M. Billse1f26342018-07-18 12:12:00 -07002497
2498 // Get the Created time from the timestamp
Jason M. Bills16428a12018-11-02 12:42:29 -07002499 std::string entryTimeStr;
2500 if (!getEntryTimestamp(journal, entryTimeStr))
Jason M. Billse1f26342018-07-18 12:12:00 -07002501 {
Jason M. Bills16428a12018-11-02 12:42:29 -07002502 return 1;
Jason M. Billse1f26342018-07-18 12:12:00 -07002503 }
Jason M. Billse1f26342018-07-18 12:12:00 -07002504
2505 // Fill in the log entry with the gathered data
Vijay Lobo9c11a172021-10-07 16:53:16 -05002506 bmcJournalLogEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07002507 bmcJournalLogEntryJson["@odata.id"] = boost::urls::format(
2508 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/{}",
Willy Tueddfc432022-09-26 16:46:38 +00002509 bmcJournalLogEntryID);
Jason M. Bills84afc482022-06-24 12:38:23 -07002510 bmcJournalLogEntryJson["Name"] = "BMC Journal Entry";
2511 bmcJournalLogEntryJson["Id"] = bmcJournalLogEntryID;
2512 bmcJournalLogEntryJson["Message"] = std::move(message);
2513 bmcJournalLogEntryJson["EntryType"] = "Oem";
2514 bmcJournalLogEntryJson["Severity"] = severity <= 2 ? "Critical"
2515 : severity <= 4 ? "Warning"
2516 : "OK";
2517 bmcJournalLogEntryJson["OemRecordFormat"] = "BMC Journal Entry";
2518 bmcJournalLogEntryJson["Created"] = std::move(entryTimeStr);
Jason M. Billse1f26342018-07-18 12:12:00 -07002519 return 0;
2520}
2521
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002522inline void requestRoutesBMCJournalLogEntryCollection(App& app)
Jason M. Billse1f26342018-07-18 12:12:00 -07002523{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002524 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07002525 .privileges(redfish::privileges::getLogEntryCollection)
Ed Tanous002d39b2022-05-31 08:59:27 -07002526 .methods(boost::beast::http::verb::get)(
2527 [&app](const crow::Request& req,
2528 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2529 query_param::QueryCapabilities capabilities = {
2530 .canDelegateTop = true,
2531 .canDelegateSkip = true,
2532 };
2533 query_param::Query delegatedQuery;
2534 if (!redfish::setUpRedfishRouteWithDelegation(
Carson Labrado3ba00072022-06-06 19:40:56 +00002535 app, req, asyncResp, delegatedQuery, capabilities))
Ed Tanous002d39b2022-05-31 08:59:27 -07002536 {
2537 return;
2538 }
Ed Tanous3648c8b2022-07-25 13:39:59 -07002539
2540 size_t skip = delegatedQuery.skip.value_or(0);
Jiaqing Zhao5143f7a2022-07-22 09:33:33 +08002541 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
Ed Tanous3648c8b2022-07-25 13:39:59 -07002542
Ed Tanous002d39b2022-05-31 08:59:27 -07002543 // Collections don't include the static data added by SubRoute
2544 // because it has a duplicate entry for members
2545 asyncResp->res.jsonValue["@odata.type"] =
2546 "#LogEntryCollection.LogEntryCollection";
2547 asyncResp->res.jsonValue["@odata.id"] =
2548 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
2549 asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries";
2550 asyncResp->res.jsonValue["Description"] =
2551 "Collection of BMC Journal Entries";
2552 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2553 logEntryArray = nlohmann::json::array();
Jason M. Billse1f26342018-07-18 12:12:00 -07002554
Ed Tanous002d39b2022-05-31 08:59:27 -07002555 // Go through the journal and use the timestamp to create a
2556 // unique ID for each entry
2557 sd_journal* journalTmp = nullptr;
2558 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
2559 if (ret < 0)
2560 {
Ed Tanous62598e32023-07-17 17:06:25 -07002561 BMCWEB_LOG_ERROR("failed to open journal: {}", strerror(-ret));
Ed Tanous002d39b2022-05-31 08:59:27 -07002562 messages::internalError(asyncResp->res);
2563 return;
2564 }
2565 std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
2566 journalTmp, sd_journal_close);
2567 journalTmp = nullptr;
2568 uint64_t entryCount = 0;
2569 // Reset the unique ID on the first entry
2570 bool firstEntry = true;
2571 SD_JOURNAL_FOREACH(journal.get())
2572 {
2573 entryCount++;
2574 // Handle paging using skip (number of entries to skip from
2575 // the start) and top (number of entries to display)
Ed Tanous3648c8b2022-07-25 13:39:59 -07002576 if (entryCount <= skip || entryCount > skip + top)
George Liu0fda0f12021-11-16 10:06:17 +08002577 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002578 continue;
2579 }
2580
2581 std::string idStr;
2582 if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
2583 {
2584 continue;
2585 }
Jason M. Billsefde4ec2022-06-24 08:59:52 -07002586 firstEntry = false;
Ed Tanous002d39b2022-05-31 08:59:27 -07002587
Jason M. Bills3a48b3a2022-06-24 10:10:15 -07002588 nlohmann::json::object_t bmcJournalLogEntry;
Ed Tanous002d39b2022-05-31 08:59:27 -07002589 if (fillBMCJournalLogEntryJson(idStr, journal.get(),
2590 bmcJournalLogEntry) != 0)
2591 {
George Liu0fda0f12021-11-16 10:06:17 +08002592 messages::internalError(asyncResp->res);
2593 return;
2594 }
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002595 logEntryArray.emplace_back(std::move(bmcJournalLogEntry));
Ed Tanous002d39b2022-05-31 08:59:27 -07002596 }
2597 asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002598 if (skip + top < entryCount)
Ed Tanous002d39b2022-05-31 08:59:27 -07002599 {
2600 asyncResp->res.jsonValue["Members@odata.nextLink"] =
2601 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" +
Ed Tanous3648c8b2022-07-25 13:39:59 -07002602 std::to_string(skip + top);
Ed Tanous002d39b2022-05-31 08:59:27 -07002603 }
George Liu0fda0f12021-11-16 10:06:17 +08002604 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002605}
Jason M. Billse1f26342018-07-18 12:12:00 -07002606
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002607inline void requestRoutesBMCJournalLogEntry(App& app)
Jason M. Billse1f26342018-07-18 12:12:00 -07002608{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002609 BMCWEB_ROUTE(app,
2610 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002611 .privileges(redfish::privileges::getLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002612 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07002613 [&app](const crow::Request& req,
2614 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2615 const std::string& entryID) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002616 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002617 {
2618 return;
2619 }
2620 // Convert the unique ID back to a timestamp to find the entry
2621 uint64_t ts = 0;
2622 uint64_t index = 0;
2623 if (!getTimestampFromID(asyncResp, entryID, ts, index))
2624 {
2625 return;
2626 }
Jason M. Billse1f26342018-07-18 12:12:00 -07002627
Ed Tanous002d39b2022-05-31 08:59:27 -07002628 sd_journal* journalTmp = nullptr;
2629 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
2630 if (ret < 0)
2631 {
Ed Tanous62598e32023-07-17 17:06:25 -07002632 BMCWEB_LOG_ERROR("failed to open journal: {}", strerror(-ret));
Ed Tanous002d39b2022-05-31 08:59:27 -07002633 messages::internalError(asyncResp->res);
2634 return;
2635 }
2636 std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
2637 journalTmp, sd_journal_close);
2638 journalTmp = nullptr;
2639 // Go to the timestamp in the log and move to the entry at the
2640 // index tracking the unique ID
2641 std::string idStr;
2642 bool firstEntry = true;
2643 ret = sd_journal_seek_realtime_usec(journal.get(), ts);
2644 if (ret < 0)
2645 {
Ed Tanous62598e32023-07-17 17:06:25 -07002646 BMCWEB_LOG_ERROR("failed to seek to an entry in journal{}",
2647 strerror(-ret));
Ed Tanous002d39b2022-05-31 08:59:27 -07002648 messages::internalError(asyncResp->res);
2649 return;
2650 }
2651 for (uint64_t i = 0; i <= index; i++)
2652 {
2653 sd_journal_next(journal.get());
2654 if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
2655 {
2656 messages::internalError(asyncResp->res);
2657 return;
2658 }
Jason M. Billsefde4ec2022-06-24 08:59:52 -07002659 firstEntry = false;
Ed Tanous002d39b2022-05-31 08:59:27 -07002660 }
2661 // Confirm that the entry ID matches what was requested
2662 if (idStr != entryID)
2663 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08002664 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
Ed Tanous002d39b2022-05-31 08:59:27 -07002665 return;
2666 }
zhanghch058d1b46d2021-04-01 11:18:24 +08002667
Jason M. Bills3a48b3a2022-06-24 10:10:15 -07002668 nlohmann::json::object_t bmcJournalLogEntry;
Ed Tanous002d39b2022-05-31 08:59:27 -07002669 if (fillBMCJournalLogEntryJson(entryID, journal.get(),
Jason M. Bills3a48b3a2022-06-24 10:10:15 -07002670 bmcJournalLogEntry) != 0)
Ed Tanous002d39b2022-05-31 08:59:27 -07002671 {
2672 messages::internalError(asyncResp->res);
2673 return;
2674 }
Jason M. Billsd405bb52022-06-24 10:52:05 -07002675 asyncResp->res.jsonValue.update(bmcJournalLogEntry);
Ed Tanous002d39b2022-05-31 08:59:27 -07002676 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002677}
2678
Claire Weinanfdd26902022-03-01 14:18:25 -08002679inline void
2680 getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2681 const std::string& dumpType)
2682{
2683 std::string dumpPath;
2684 std::string overWritePolicy;
2685 bool collectDiagnosticDataSupported = false;
2686
2687 if (dumpType == "BMC")
2688 {
2689 dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump";
2690 overWritePolicy = "WrapsWhenFull";
2691 collectDiagnosticDataSupported = true;
2692 }
2693 else if (dumpType == "FaultLog")
2694 {
2695 dumpPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog";
2696 overWritePolicy = "Unknown";
2697 collectDiagnosticDataSupported = false;
2698 }
2699 else if (dumpType == "System")
2700 {
2701 dumpPath = "/redfish/v1/Systems/system/LogServices/Dump";
2702 overWritePolicy = "WrapsWhenFull";
2703 collectDiagnosticDataSupported = true;
2704 }
2705 else
2706 {
Ed Tanous62598e32023-07-17 17:06:25 -07002707 BMCWEB_LOG_ERROR("getDumpServiceInfo() invalid dump type: {}",
2708 dumpType);
Claire Weinanfdd26902022-03-01 14:18:25 -08002709 messages::internalError(asyncResp->res);
2710 return;
2711 }
2712
2713 asyncResp->res.jsonValue["@odata.id"] = dumpPath;
2714 asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService";
2715 asyncResp->res.jsonValue["Name"] = "Dump LogService";
2716 asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService";
2717 asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename();
2718 asyncResp->res.jsonValue["OverWritePolicy"] = std::move(overWritePolicy);
2719
2720 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07002721 redfish::time_utils::getDateTimeOffsetNow();
Claire Weinanfdd26902022-03-01 14:18:25 -08002722 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
2723 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
2724 redfishDateTimeOffset.second;
2725
2726 asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries";
Claire Weinanfdd26902022-03-01 14:18:25 -08002727
2728 if (collectDiagnosticDataSupported)
2729 {
2730 asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
2731 ["target"] =
2732 dumpPath + "/Actions/LogService.CollectDiagnosticData";
2733 }
Claire Weinan0d946212022-07-13 19:40:19 -07002734
2735 constexpr std::array<std::string_view, 1> interfaces = {deleteAllInterface};
2736 dbus::utility::getSubTreePaths(
2737 "/xyz/openbmc_project/dump", 0, interfaces,
2738 [asyncResp, dumpType, dumpPath](
2739 const boost::system::error_code& ec,
2740 const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) {
2741 if (ec)
2742 {
Ed Tanous62598e32023-07-17 17:06:25 -07002743 BMCWEB_LOG_ERROR("getDumpServiceInfo respHandler got error {}", ec);
Claire Weinan0d946212022-07-13 19:40:19 -07002744 // Assume that getting an error simply means there are no dump
2745 // LogServices. Return without adding any error response.
2746 return;
2747 }
2748
2749 const std::string dbusDumpPath =
2750 "/xyz/openbmc_project/dump/" +
2751 boost::algorithm::to_lower_copy(dumpType);
2752
2753 for (const std::string& path : subTreePaths)
2754 {
2755 if (path == dbusDumpPath)
2756 {
2757 asyncResp->res
2758 .jsonValue["Actions"]["#LogService.ClearLog"]["target"] =
2759 dumpPath + "/Actions/LogService.ClearLog";
2760 break;
2761 }
2762 }
2763 });
Claire Weinanfdd26902022-03-01 14:18:25 -08002764}
2765
2766inline void handleLogServicesDumpServiceGet(
2767 crow::App& app, const std::string& dumpType, const crow::Request& req,
2768 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2769{
2770 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2771 {
2772 return;
2773 }
2774 getDumpServiceInfo(asyncResp, dumpType);
2775}
2776
Ed Tanous22d268c2022-05-19 09:39:07 -07002777inline void handleLogServicesDumpServiceComputerSystemGet(
2778 crow::App& app, const crow::Request& req,
2779 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2780 const std::string& chassisId)
2781{
2782 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2783 {
2784 return;
2785 }
2786 if (chassisId != "system")
2787 {
2788 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2789 return;
2790 }
2791 getDumpServiceInfo(asyncResp, "System");
2792}
2793
Claire Weinanfdd26902022-03-01 14:18:25 -08002794inline void handleLogServicesDumpEntriesCollectionGet(
2795 crow::App& app, const std::string& dumpType, const crow::Request& req,
2796 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2797{
2798 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2799 {
2800 return;
2801 }
2802 getDumpEntryCollection(asyncResp, dumpType);
2803}
2804
Ed Tanous22d268c2022-05-19 09:39:07 -07002805inline void handleLogServicesDumpEntriesCollectionComputerSystemGet(
2806 crow::App& app, const crow::Request& req,
2807 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2808 const std::string& chassisId)
2809{
2810 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2811 {
2812 return;
2813 }
2814 if (chassisId != "system")
2815 {
2816 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2817 return;
2818 }
2819 getDumpEntryCollection(asyncResp, "System");
2820}
2821
Claire Weinanfdd26902022-03-01 14:18:25 -08002822inline void handleLogServicesDumpEntryGet(
2823 crow::App& app, const std::string& dumpType, const crow::Request& req,
2824 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2825 const std::string& dumpId)
2826{
2827 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2828 {
2829 return;
2830 }
2831 getDumpEntryById(asyncResp, dumpId, dumpType);
2832}
Ed Tanous22d268c2022-05-19 09:39:07 -07002833inline void handleLogServicesDumpEntryComputerSystemGet(
2834 crow::App& app, const crow::Request& req,
2835 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2836 const std::string& chassisId, const std::string& dumpId)
2837{
2838 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2839 {
2840 return;
2841 }
2842 if (chassisId != "system")
2843 {
2844 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2845 return;
2846 }
2847 getDumpEntryById(asyncResp, dumpId, "System");
2848}
Claire Weinanfdd26902022-03-01 14:18:25 -08002849
2850inline void handleLogServicesDumpEntryDelete(
2851 crow::App& app, const std::string& dumpType, const crow::Request& req,
2852 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2853 const std::string& dumpId)
2854{
2855 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2856 {
2857 return;
2858 }
2859 deleteDumpEntry(asyncResp, dumpId, dumpType);
2860}
2861
Ed Tanous22d268c2022-05-19 09:39:07 -07002862inline void handleLogServicesDumpEntryComputerSystemDelete(
2863 crow::App& app, const crow::Request& req,
2864 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2865 const std::string& chassisId, const std::string& dumpId)
2866{
2867 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2868 {
2869 return;
2870 }
2871 if (chassisId != "system")
2872 {
2873 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2874 return;
2875 }
2876 deleteDumpEntry(asyncResp, dumpId, "System");
2877}
2878
Claire Weinanfdd26902022-03-01 14:18:25 -08002879inline void handleLogServicesDumpCollectDiagnosticDataPost(
2880 crow::App& app, const std::string& dumpType, const crow::Request& req,
2881 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2882{
2883 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2884 {
2885 return;
2886 }
2887 createDump(asyncResp, req, dumpType);
2888}
2889
Ed Tanous22d268c2022-05-19 09:39:07 -07002890inline void handleLogServicesDumpCollectDiagnosticDataComputerSystemPost(
2891 crow::App& app, const crow::Request& req,
2892 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002893 const std::string& systemName)
Ed Tanous22d268c2022-05-19 09:39:07 -07002894{
2895 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2896 {
2897 return;
2898 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002899
2900 if constexpr (bmcwebEnableMultiHost)
Ed Tanous22d268c2022-05-19 09:39:07 -07002901 {
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002902 // Option currently returns no systems. TBD
2903 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2904 systemName);
2905 return;
2906 }
2907 if (systemName != "system")
2908 {
2909 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2910 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07002911 return;
2912 }
2913 createDump(asyncResp, req, "System");
2914}
2915
Claire Weinanfdd26902022-03-01 14:18:25 -08002916inline void handleLogServicesDumpClearLogPost(
2917 crow::App& app, const std::string& dumpType, const crow::Request& req,
2918 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2919{
2920 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2921 {
2922 return;
2923 }
2924 clearDump(asyncResp, dumpType);
2925}
2926
Ed Tanous22d268c2022-05-19 09:39:07 -07002927inline void handleLogServicesDumpClearLogComputerSystemPost(
2928 crow::App& app, const crow::Request& req,
2929 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002930 const std::string& systemName)
Ed Tanous22d268c2022-05-19 09:39:07 -07002931{
2932 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2933 {
2934 return;
2935 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002936 if constexpr (bmcwebEnableMultiHost)
Ed Tanous22d268c2022-05-19 09:39:07 -07002937 {
Ed Tanous7f3e84a2022-12-28 16:22:54 -08002938 // Option currently returns no systems. TBD
2939 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2940 systemName);
2941 return;
2942 }
2943 if (systemName != "system")
2944 {
2945 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2946 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07002947 return;
2948 }
2949 clearDump(asyncResp, "System");
2950}
2951
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002952inline void requestRoutesBMCDumpService(App& app)
2953{
2954 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/")
Ed Tanoused398212021-06-09 17:05:54 -07002955 .privileges(redfish::privileges::getLogService)
Claire Weinanfdd26902022-03-01 14:18:25 -08002956 .methods(boost::beast::http::verb::get)(std::bind_front(
2957 handleLogServicesDumpServiceGet, std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002958}
2959
2960inline void requestRoutesBMCDumpEntryCollection(App& app)
2961{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002962 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07002963 .privileges(redfish::privileges::getLogEntryCollection)
Claire Weinanfdd26902022-03-01 14:18:25 -08002964 .methods(boost::beast::http::verb::get)(std::bind_front(
2965 handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002966}
2967
2968inline void requestRoutesBMCDumpEntry(App& app)
2969{
2970 BMCWEB_ROUTE(app,
2971 "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002972 .privileges(redfish::privileges::getLogEntry)
Claire Weinanfdd26902022-03-01 14:18:25 -08002973 .methods(boost::beast::http::verb::get)(std::bind_front(
2974 handleLogServicesDumpEntryGet, std::ref(app), "BMC"));
2975
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002976 BMCWEB_ROUTE(app,
2977 "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002978 .privileges(redfish::privileges::deleteLogEntry)
Claire Weinanfdd26902022-03-01 14:18:25 -08002979 .methods(boost::beast::http::verb::delete_)(std::bind_front(
2980 handleLogServicesDumpEntryDelete, std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002981}
2982
2983inline void requestRoutesBMCDumpCreate(App& app)
2984{
George Liu0fda0f12021-11-16 10:06:17 +08002985 BMCWEB_ROUTE(
2986 app,
2987 "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
Ed Tanoused398212021-06-09 17:05:54 -07002988 .privileges(redfish::privileges::postLogService)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002989 .methods(boost::beast::http::verb::post)(
Claire Weinanfdd26902022-03-01 14:18:25 -08002990 std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost,
2991 std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002992}
2993
2994inline void requestRoutesBMCDumpClear(App& app)
2995{
George Liu0fda0f12021-11-16 10:06:17 +08002996 BMCWEB_ROUTE(
2997 app,
2998 "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07002999 .privileges(redfish::privileges::postLogService)
Claire Weinanfdd26902022-03-01 14:18:25 -08003000 .methods(boost::beast::http::verb::post)(std::bind_front(
3001 handleLogServicesDumpClearLogPost, std::ref(app), "BMC"));
3002}
3003
3004inline void requestRoutesFaultLogDumpService(App& app)
3005{
3006 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/")
3007 .privileges(redfish::privileges::getLogService)
3008 .methods(boost::beast::http::verb::get)(std::bind_front(
3009 handleLogServicesDumpServiceGet, std::ref(app), "FaultLog"));
3010}
3011
3012inline void requestRoutesFaultLogDumpEntryCollection(App& app)
3013{
3014 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/")
3015 .privileges(redfish::privileges::getLogEntryCollection)
3016 .methods(boost::beast::http::verb::get)(
3017 std::bind_front(handleLogServicesDumpEntriesCollectionGet,
3018 std::ref(app), "FaultLog"));
3019}
3020
3021inline void requestRoutesFaultLogDumpEntry(App& app)
3022{
3023 BMCWEB_ROUTE(app,
3024 "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/")
3025 .privileges(redfish::privileges::getLogEntry)
3026 .methods(boost::beast::http::verb::get)(std::bind_front(
3027 handleLogServicesDumpEntryGet, std::ref(app), "FaultLog"));
3028
3029 BMCWEB_ROUTE(app,
3030 "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/")
3031 .privileges(redfish::privileges::deleteLogEntry)
3032 .methods(boost::beast::http::verb::delete_)(std::bind_front(
3033 handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog"));
3034}
3035
3036inline void requestRoutesFaultLogDumpClear(App& app)
3037{
3038 BMCWEB_ROUTE(
3039 app,
3040 "/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog/")
3041 .privileges(redfish::privileges::postLogService)
3042 .methods(boost::beast::http::verb::post)(std::bind_front(
3043 handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003044}
3045
3046inline void requestRoutesSystemDumpService(App& app)
3047{
Ed Tanous22d268c2022-05-19 09:39:07 -07003048 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/")
Ed Tanoused398212021-06-09 17:05:54 -07003049 .privileges(redfish::privileges::getLogService)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07003050 .methods(boost::beast::http::verb::get)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07003051 handleLogServicesDumpServiceComputerSystemGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003052}
3053
3054inline void requestRoutesSystemDumpEntryCollection(App& app)
3055{
Ed Tanous22d268c2022-05-19 09:39:07 -07003056 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07003057 .privileges(redfish::privileges::getLogEntryCollection)
Ed Tanous22d268c2022-05-19 09:39:07 -07003058 .methods(boost::beast::http::verb::get)(std::bind_front(
3059 handleLogServicesDumpEntriesCollectionComputerSystemGet,
3060 std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003061}
3062
3063inline void requestRoutesSystemDumpEntry(App& app)
3064{
3065 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003066 "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07003067 .privileges(redfish::privileges::getLogEntry)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07003068 .methods(boost::beast::http::verb::get)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07003069 handleLogServicesDumpEntryComputerSystemGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003070
3071 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003072 "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07003073 .privileges(redfish::privileges::deleteLogEntry)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07003074 .methods(boost::beast::http::verb::delete_)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07003075 handleLogServicesDumpEntryComputerSystemDelete, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003076}
3077
3078inline void requestRoutesSystemDumpCreate(App& app)
3079{
George Liu0fda0f12021-11-16 10:06:17 +08003080 BMCWEB_ROUTE(
3081 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003082 "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
Ed Tanoused398212021-06-09 17:05:54 -07003083 .privileges(redfish::privileges::postLogService)
Ed Tanous22d268c2022-05-19 09:39:07 -07003084 .methods(boost::beast::http::verb::post)(std::bind_front(
3085 handleLogServicesDumpCollectDiagnosticDataComputerSystemPost,
3086 std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003087}
3088
3089inline void requestRoutesSystemDumpClear(App& app)
3090{
George Liu0fda0f12021-11-16 10:06:17 +08003091 BMCWEB_ROUTE(
3092 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003093 "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07003094 .privileges(redfish::privileges::postLogService)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07003095 .methods(boost::beast::http::verb::post)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07003096 handleLogServicesDumpClearLogComputerSystemPost, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003097}
3098
3099inline void requestRoutesCrashdumpService(App& app)
3100{
3101 // Note: Deviated from redfish privilege registry for GET & HEAD
3102 // method for security reasons.
3103 /**
3104 * Functions triggers appropriate requests on DBus
3105 */
Ed Tanous22d268c2022-05-19 09:39:07 -07003106 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/")
Ed Tanoused398212021-06-09 17:05:54 -07003107 // This is incorrect, should be:
3108 //.privileges(redfish::privileges::getLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07003109 .privileges({{"ConfigureManager"}})
Ed Tanous002d39b2022-05-31 08:59:27 -07003110 .methods(boost::beast::http::verb::get)(
3111 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003112 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3113 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003114 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003115 {
3116 return;
3117 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003118 if constexpr (bmcwebEnableMultiHost)
3119 {
3120 // Option currently returns no systems. TBD
3121 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3122 systemName);
3123 return;
3124 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003125 if (systemName != "system")
3126 {
3127 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3128 systemName);
3129 return;
3130 }
3131
Ed Tanous002d39b2022-05-31 08:59:27 -07003132 // Copy over the static data to include the entries added by
3133 // SubRoute
3134 asyncResp->res.jsonValue["@odata.id"] =
3135 "/redfish/v1/Systems/system/LogServices/Crashdump";
3136 asyncResp->res.jsonValue["@odata.type"] =
3137 "#LogService.v1_2_0.LogService";
3138 asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
3139 asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
V-Sanjana15b89722023-05-11 16:27:03 +05303140 asyncResp->res.jsonValue["Id"] = "Crashdump";
Ed Tanous002d39b2022-05-31 08:59:27 -07003141 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
3142 asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
Tejas Patil7c8c4052021-06-04 17:43:14 +05303143
Ed Tanous002d39b2022-05-31 08:59:27 -07003144 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07003145 redfish::time_utils::getDateTimeOffsetNow();
Ed Tanous002d39b2022-05-31 08:59:27 -07003146 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
3147 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
3148 redfishDateTimeOffset.second;
Tejas Patil7c8c4052021-06-04 17:43:14 +05303149
Ed Tanous002d39b2022-05-31 08:59:27 -07003150 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
Ed Tanousef4c65b2023-04-24 15:28:50 -07003151 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
Ed Tanous002d39b2022-05-31 08:59:27 -07003152 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] =
3153 "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog";
3154 asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
3155 ["target"] =
3156 "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData";
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003157 });
3158}
3159
3160void inline requestRoutesCrashdumpClear(App& app)
3161{
George Liu0fda0f12021-11-16 10:06:17 +08003162 BMCWEB_ROUTE(
3163 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003164 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07003165 // This is incorrect, should be:
3166 //.privileges(redfish::privileges::postLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07003167 .privileges({{"ConfigureComponents"}})
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003168 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003169 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003170 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3171 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003172 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003173 {
3174 return;
3175 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003176 if constexpr (bmcwebEnableMultiHost)
3177 {
3178 // Option currently returns no systems. TBD
3179 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3180 systemName);
3181 return;
3182 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003183 if (systemName != "system")
3184 {
3185 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3186 systemName);
3187 return;
3188 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003189 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003190 [asyncResp](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003191 const std::string&) {
3192 if (ec)
3193 {
3194 messages::internalError(asyncResp->res);
3195 return;
3196 }
3197 messages::success(asyncResp->res);
3198 },
3199 crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll");
3200 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003201}
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07003202
zhanghch058d1b46d2021-04-01 11:18:24 +08003203static void
3204 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3205 const std::string& logID, nlohmann::json& logEntryJson)
Jason M. Billse855dd22019-10-08 11:37:48 -07003206{
Johnathan Mantey043a0532020-03-10 17:15:28 -07003207 auto getStoredLogCallback =
Ed Tanousb9d36b42022-02-26 21:42:46 -08003208 [asyncResp, logID,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003209 &logEntryJson](const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08003210 const dbus::utility::DBusPropertiesMap& params) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003211 if (ec)
3212 {
Ed Tanous62598e32023-07-17 17:06:25 -07003213 BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message());
Ed Tanous002d39b2022-05-31 08:59:27 -07003214 if (ec.value() ==
3215 boost::system::linux_error::bad_request_descriptor)
Jason M. Bills1ddcf012019-11-26 14:59:21 -08003216 {
Ed Tanous002d39b2022-05-31 08:59:27 -07003217 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Jason M. Bills2b20ef62022-01-06 15:48:07 -08003218 }
3219 else
3220 {
Ed Tanous002d39b2022-05-31 08:59:27 -07003221 messages::internalError(asyncResp->res);
Jason M. Bills2b20ef62022-01-06 15:48:07 -08003222 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003223 return;
3224 }
3225
3226 std::string timestamp{};
3227 std::string filename{};
3228 std::string logfile{};
3229 parseCrashdumpParameters(params, filename, timestamp, logfile);
3230
3231 if (filename.empty() || timestamp.empty())
3232 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003233 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003234 return;
3235 }
3236
3237 std::string crashdumpURI =
3238 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" +
3239 logID + "/" + filename;
Jason M. Bills84afc482022-06-24 12:38:23 -07003240 nlohmann::json::object_t logEntry;
Vijay Lobo9c11a172021-10-07 16:53:16 -05003241 logEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07003242 logEntry["@odata.id"] = boost::urls::format(
3243 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/{}",
3244 logID);
Jason M. Bills84afc482022-06-24 12:38:23 -07003245 logEntry["Name"] = "CPU Crashdump";
3246 logEntry["Id"] = logID;
3247 logEntry["EntryType"] = "Oem";
3248 logEntry["AdditionalDataURI"] = std::move(crashdumpURI);
3249 logEntry["DiagnosticDataType"] = "OEM";
3250 logEntry["OEMDiagnosticDataType"] = "PECICrashdump";
3251 logEntry["Created"] = std::move(timestamp);
Ed Tanous002d39b2022-05-31 08:59:27 -07003252
3253 // If logEntryJson references an array of LogEntry resources
3254 // ('Members' list), then push this as a new entry, otherwise set it
3255 // directly
3256 if (logEntryJson.is_array())
3257 {
3258 logEntryJson.push_back(logEntry);
3259 asyncResp->res.jsonValue["Members@odata.count"] =
3260 logEntryJson.size();
3261 }
3262 else
3263 {
Jason M. Billsd405bb52022-06-24 10:52:05 -07003264 logEntryJson.update(logEntry);
Ed Tanous002d39b2022-05-31 08:59:27 -07003265 }
3266 };
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02003267 sdbusplus::asio::getAllProperties(
3268 *crow::connections::systemBus, crashdumpObject,
3269 crashdumpPath + std::string("/") + logID, crashdumpInterface,
3270 std::move(getStoredLogCallback));
Jason M. Billse855dd22019-10-08 11:37:48 -07003271}
3272
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003273inline void requestRoutesCrashdumpEntryCollection(App& app)
Ed Tanous1da66f72018-07-27 16:13:37 -07003274{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003275 // Note: Deviated from redfish privilege registry for GET & HEAD
3276 // method for security reasons.
Ed Tanous1da66f72018-07-27 16:13:37 -07003277 /**
3278 * Functions triggers appropriate requests on DBus
3279 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003280 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003281 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07003282 // This is incorrect, should be.
3283 //.privileges(redfish::privileges::postLogEntryCollection)
Ed Tanous432a8902021-06-14 15:28:56 -07003284 .privileges({{"ConfigureComponents"}})
Ed Tanous002d39b2022-05-31 08:59:27 -07003285 .methods(boost::beast::http::verb::get)(
3286 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003287 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3288 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003289 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003290 {
3291 return;
3292 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003293 if constexpr (bmcwebEnableMultiHost)
3294 {
3295 // Option currently returns no systems. TBD
3296 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3297 systemName);
3298 return;
3299 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003300 if (systemName != "system")
3301 {
3302 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3303 systemName);
3304 return;
3305 }
3306
George Liu7a1dbc42022-12-07 16:03:22 +08003307 constexpr std::array<std::string_view, 1> interfaces = {
3308 crashdumpInterface};
3309 dbus::utility::getSubTreePaths(
3310 "/", 0, interfaces,
3311 [asyncResp](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003312 const std::vector<std::string>& resp) {
3313 if (ec)
Ed Tanous45ca1b82022-03-25 13:07:27 -07003314 {
Ed Tanous002d39b2022-05-31 08:59:27 -07003315 if (ec.value() !=
3316 boost::system::errc::no_such_file_or_directory)
3317 {
Ed Tanous62598e32023-07-17 17:06:25 -07003318 BMCWEB_LOG_DEBUG("failed to get entries ec: {}",
3319 ec.message());
Ed Tanous002d39b2022-05-31 08:59:27 -07003320 messages::internalError(asyncResp->res);
3321 return;
3322 }
Ed Tanous45ca1b82022-03-25 13:07:27 -07003323 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003324 asyncResp->res.jsonValue["@odata.type"] =
3325 "#LogEntryCollection.LogEntryCollection";
3326 asyncResp->res.jsonValue["@odata.id"] =
3327 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
3328 asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
3329 asyncResp->res.jsonValue["Description"] =
3330 "Collection of Crashdump Entries";
3331 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3332 asyncResp->res.jsonValue["Members@odata.count"] = 0;
Jason M. Bills2b20ef62022-01-06 15:48:07 -08003333
Ed Tanous002d39b2022-05-31 08:59:27 -07003334 for (const std::string& path : resp)
3335 {
3336 const sdbusplus::message::object_path objPath(path);
3337 // Get the log ID
3338 std::string logID = objPath.filename();
3339 if (logID.empty())
3340 {
3341 continue;
3342 }
3343 // Add the log entry to the array
3344 logCrashdumpEntry(asyncResp, logID,
3345 asyncResp->res.jsonValue["Members"]);
3346 }
George Liu7a1dbc42022-12-07 16:03:22 +08003347 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003348 });
3349}
Ed Tanous1da66f72018-07-27 16:13:37 -07003350
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003351inline void requestRoutesCrashdumpEntry(App& app)
Ed Tanous1da66f72018-07-27 16:13:37 -07003352{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003353 // Note: Deviated from redfish privilege registry for GET & HEAD
3354 // method for security reasons.
Ed Tanous1da66f72018-07-27 16:13:37 -07003355
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003356 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07003357 app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07003358 // this is incorrect, should be
3359 // .privileges(redfish::privileges::getLogEntry)
Ed Tanous432a8902021-06-14 15:28:56 -07003360 .privileges({{"ConfigureComponents"}})
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003361 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003362 [&app](const crow::Request& req,
3363 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07003364 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003365 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003366 {
3367 return;
3368 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003369 if constexpr (bmcwebEnableMultiHost)
3370 {
3371 // Option currently returns no systems. TBD
3372 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3373 systemName);
3374 return;
3375 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003376 if (systemName != "system")
3377 {
3378 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3379 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003380 return;
3381 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003382 const std::string& logID = param;
3383 logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
3384 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003385}
Ed Tanous1da66f72018-07-27 16:13:37 -07003386
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003387inline void requestRoutesCrashdumpFile(App& app)
3388{
3389 // Note: Deviated from redfish privilege registry for GET & HEAD
3390 // method for security reasons.
3391 BMCWEB_ROUTE(
3392 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003393 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07003394 .privileges(redfish::privileges::getLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003395 .methods(boost::beast::http::verb::get)(
Nan Zhoua4ce1142022-08-02 18:45:25 +00003396 [](const crow::Request& req,
3397 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07003398 const std::string& systemName, const std::string& logID,
3399 const std::string& fileName) {
Shounak Mitra2a9beee2022-07-20 18:41:30 +00003400 // Do not call getRedfishRoute here since the crashdump file is not a
3401 // Redfish resource.
Ed Tanous22d268c2022-05-19 09:39:07 -07003402
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003403 if constexpr (bmcwebEnableMultiHost)
3404 {
3405 // Option currently returns no systems. TBD
3406 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3407 systemName);
3408 return;
3409 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003410 if (systemName != "system")
3411 {
3412 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3413 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003414 return;
3415 }
3416
Ed Tanous002d39b2022-05-31 08:59:27 -07003417 auto getStoredLogCallback =
Ed Tanous39662a32023-02-06 15:09:46 -08003418 [asyncResp, logID, fileName, url(boost::urls::url(req.url()))](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003419 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003420 const std::vector<
3421 std::pair<std::string, dbus::utility::DbusVariantType>>&
3422 resp) {
3423 if (ec)
3424 {
Ed Tanous62598e32023-07-17 17:06:25 -07003425 BMCWEB_LOG_DEBUG("failed to get log ec: {}", ec.message());
Ed Tanous002d39b2022-05-31 08:59:27 -07003426 messages::internalError(asyncResp->res);
3427 return;
3428 }
Jason M. Bills8e6c0992021-03-11 16:26:53 -08003429
Ed Tanous002d39b2022-05-31 08:59:27 -07003430 std::string dbusFilename{};
3431 std::string dbusTimestamp{};
3432 std::string dbusFilepath{};
Jason M. Bills8e6c0992021-03-11 16:26:53 -08003433
Ed Tanous002d39b2022-05-31 08:59:27 -07003434 parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp,
3435 dbusFilepath);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003436
Ed Tanous002d39b2022-05-31 08:59:27 -07003437 if (dbusFilename.empty() || dbusTimestamp.empty() ||
3438 dbusFilepath.empty())
3439 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003440 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003441 return;
3442 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003443
Ed Tanous002d39b2022-05-31 08:59:27 -07003444 // Verify the file name parameter is correct
3445 if (fileName != dbusFilename)
3446 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003447 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003448 return;
3449 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003450
Ed Tanous002d39b2022-05-31 08:59:27 -07003451 if (!std::filesystem::exists(dbusFilepath))
3452 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003453 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003454 return;
3455 }
3456 std::ifstream ifs(dbusFilepath, std::ios::in | std::ios::binary);
3457 asyncResp->res.body() =
3458 std::string(std::istreambuf_iterator<char>{ifs}, {});
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003459
Ed Tanous002d39b2022-05-31 08:59:27 -07003460 // Configure this to be a file download when accessed
3461 // from a browser
Ed Tanousd9f6c622022-03-17 09:12:17 -07003462 asyncResp->res.addHeader(
3463 boost::beast::http::field::content_disposition, "attachment");
Ed Tanous002d39b2022-05-31 08:59:27 -07003464 };
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02003465 sdbusplus::asio::getAllProperties(
3466 *crow::connections::systemBus, crashdumpObject,
3467 crashdumpPath + std::string("/") + logID, crashdumpInterface,
3468 std::move(getStoredLogCallback));
Ed Tanous002d39b2022-05-31 08:59:27 -07003469 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003470}
3471
Jason M. Billsc5a4c822022-01-06 15:51:23 -08003472enum class OEMDiagnosticType
3473{
3474 onDemand,
3475 telemetry,
3476 invalid,
3477};
3478
Ed Tanous26ccae32023-02-16 10:28:44 -08003479inline OEMDiagnosticType getOEMDiagnosticType(std::string_view oemDiagStr)
Jason M. Billsc5a4c822022-01-06 15:51:23 -08003480{
3481 if (oemDiagStr == "OnDemand")
3482 {
3483 return OEMDiagnosticType::onDemand;
3484 }
3485 if (oemDiagStr == "Telemetry")
3486 {
3487 return OEMDiagnosticType::telemetry;
3488 }
3489
3490 return OEMDiagnosticType::invalid;
3491}
3492
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003493inline void requestRoutesCrashdumpCollect(App& app)
3494{
3495 // Note: Deviated from redfish privilege registry for GET & HEAD
3496 // method for security reasons.
George Liu0fda0f12021-11-16 10:06:17 +08003497 BMCWEB_ROUTE(
3498 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003499 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/")
Ed Tanoused398212021-06-09 17:05:54 -07003500 // The below is incorrect; Should be ConfigureManager
3501 //.privileges(redfish::privileges::postLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07003502 .privileges({{"ConfigureComponents"}})
Ed Tanous002d39b2022-05-31 08:59:27 -07003503 .methods(boost::beast::http::verb::post)(
3504 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003505 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3506 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003507 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003508 {
3509 return;
3510 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003511
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003512 if constexpr (bmcwebEnableMultiHost)
3513 {
3514 // Option currently returns no systems. TBD
3515 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3516 systemName);
3517 return;
3518 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003519 if (systemName != "system")
3520 {
3521 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3522 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003523 return;
3524 }
3525
Ed Tanous002d39b2022-05-31 08:59:27 -07003526 std::string diagnosticDataType;
3527 std::string oemDiagnosticDataType;
3528 if (!redfish::json_util::readJsonAction(
3529 req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
3530 "OEMDiagnosticDataType", oemDiagnosticDataType))
3531 {
3532 return;
3533 }
3534
3535 if (diagnosticDataType != "OEM")
3536 {
Ed Tanous62598e32023-07-17 17:06:25 -07003537 BMCWEB_LOG_ERROR(
3538 "Only OEM DiagnosticDataType supported for Crashdump");
Ed Tanous002d39b2022-05-31 08:59:27 -07003539 messages::actionParameterValueFormatError(
3540 asyncResp->res, diagnosticDataType, "DiagnosticDataType",
3541 "CollectDiagnosticData");
3542 return;
3543 }
3544
3545 OEMDiagnosticType oemDiagType =
3546 getOEMDiagnosticType(oemDiagnosticDataType);
3547
3548 std::string iface;
3549 std::string method;
3550 std::string taskMatchStr;
3551 if (oemDiagType == OEMDiagnosticType::onDemand)
3552 {
3553 iface = crashdumpOnDemandInterface;
3554 method = "GenerateOnDemandLog";
3555 taskMatchStr = "type='signal',"
3556 "interface='org.freedesktop.DBus.Properties',"
3557 "member='PropertiesChanged',"
3558 "arg0namespace='com.intel.crashdump'";
3559 }
3560 else if (oemDiagType == OEMDiagnosticType::telemetry)
3561 {
3562 iface = crashdumpTelemetryInterface;
3563 method = "GenerateTelemetryLog";
3564 taskMatchStr = "type='signal',"
3565 "interface='org.freedesktop.DBus.Properties',"
3566 "member='PropertiesChanged',"
3567 "arg0namespace='com.intel.crashdump'";
3568 }
3569 else
3570 {
Ed Tanous62598e32023-07-17 17:06:25 -07003571 BMCWEB_LOG_ERROR("Unsupported OEMDiagnosticDataType: {}",
3572 oemDiagnosticDataType);
Ed Tanous002d39b2022-05-31 08:59:27 -07003573 messages::actionParameterValueFormatError(
3574 asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType",
3575 "CollectDiagnosticData");
3576 return;
3577 }
3578
3579 auto collectCrashdumpCallback =
3580 [asyncResp, payload(task::Payload(req)),
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003581 taskMatchStr](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003582 const std::string&) mutable {
3583 if (ec)
Ed Tanous45ca1b82022-03-25 13:07:27 -07003584 {
Ed Tanous002d39b2022-05-31 08:59:27 -07003585 if (ec.value() == boost::system::errc::operation_not_supported)
3586 {
3587 messages::resourceInStandby(asyncResp->res);
3588 }
3589 else if (ec.value() ==
3590 boost::system::errc::device_or_resource_busy)
3591 {
3592 messages::serviceTemporarilyUnavailable(asyncResp->res,
3593 "60");
3594 }
3595 else
3596 {
3597 messages::internalError(asyncResp->res);
3598 }
Ed Tanous45ca1b82022-03-25 13:07:27 -07003599 return;
3600 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003601 std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
Ed Tanous8b242752023-06-27 17:17:13 -07003602 [](const boost::system::error_code& ec2, sdbusplus::message_t&,
Ed Tanous002d39b2022-05-31 08:59:27 -07003603 const std::shared_ptr<task::TaskData>& taskData) {
Ed Tanous8b242752023-06-27 17:17:13 -07003604 if (!ec2)
Ed Tanous002d39b2022-05-31 08:59:27 -07003605 {
3606 taskData->messages.emplace_back(messages::taskCompletedOK(
3607 std::to_string(taskData->index)));
3608 taskData->state = "Completed";
3609 }
3610 return task::completed;
3611 },
3612 taskMatchStr);
Ed Tanous1da66f72018-07-27 16:13:37 -07003613
Ed Tanous002d39b2022-05-31 08:59:27 -07003614 task->startTimer(std::chrono::minutes(5));
3615 task->populateResp(asyncResp->res);
3616 task->payload.emplace(std::move(payload));
3617 };
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003618
Ed Tanous002d39b2022-05-31 08:59:27 -07003619 crow::connections::systemBus->async_method_call(
3620 std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath,
3621 iface, method);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003622 });
3623}
Kenny L. Ku6eda7682020-06-19 09:48:36 -07003624
Andrew Geisslercb92c032018-08-17 07:56:14 -07003625/**
3626 * DBusLogServiceActionsClear class supports POST method for ClearLog action.
3627 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003628inline void requestRoutesDBusLogServiceActionsClear(App& app)
Andrew Geisslercb92c032018-08-17 07:56:14 -07003629{
Andrew Geisslercb92c032018-08-17 07:56:14 -07003630 /**
3631 * Function handles POST method request.
3632 * The Clear Log actions does not require any parameter.The action deletes
3633 * all entries found in the Entries collection for this Log Service.
3634 */
Andrew Geisslercb92c032018-08-17 07:56:14 -07003635
George Liu0fda0f12021-11-16 10:06:17 +08003636 BMCWEB_ROUTE(
3637 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003638 "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07003639 .privileges(redfish::privileges::postLogService)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003640 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003641 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003642 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3643 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003644 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003645 {
3646 return;
3647 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003648 if constexpr (bmcwebEnableMultiHost)
3649 {
3650 // Option currently returns no systems. TBD
3651 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3652 systemName);
3653 return;
3654 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003655 if (systemName != "system")
3656 {
3657 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3658 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003659 return;
3660 }
Ed Tanous62598e32023-07-17 17:06:25 -07003661 BMCWEB_LOG_DEBUG("Do delete all entries.");
Andrew Geisslercb92c032018-08-17 07:56:14 -07003662
Ed Tanous002d39b2022-05-31 08:59:27 -07003663 // Process response from Logging service.
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003664 auto respHandler = [asyncResp](const boost::system::error_code& ec) {
Ed Tanous62598e32023-07-17 17:06:25 -07003665 BMCWEB_LOG_DEBUG("doClearLog resp_handler callback: Done");
Ed Tanous002d39b2022-05-31 08:59:27 -07003666 if (ec)
3667 {
3668 // TODO Handle for specific error code
Ed Tanous62598e32023-07-17 17:06:25 -07003669 BMCWEB_LOG_ERROR("doClearLog resp_handler got error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07003670 asyncResp->res.result(
3671 boost::beast::http::status::internal_server_error);
3672 return;
3673 }
Andrew Geisslercb92c032018-08-17 07:56:14 -07003674
Ed Tanous002d39b2022-05-31 08:59:27 -07003675 asyncResp->res.result(boost::beast::http::status::no_content);
3676 };
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003677
Ed Tanous002d39b2022-05-31 08:59:27 -07003678 // Make call to Logging service to request Clear Log
3679 crow::connections::systemBus->async_method_call(
3680 respHandler, "xyz.openbmc_project.Logging",
3681 "/xyz/openbmc_project/logging",
3682 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3683 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003684}
ZhikuiRena3316fc2020-01-29 14:58:08 -08003685
3686/****************************************************
3687 * Redfish PostCode interfaces
3688 * using DBUS interface: getPostCodesTS
3689 ******************************************************/
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003690inline void requestRoutesPostCodesLogService(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003691{
Ed Tanous22d268c2022-05-19 09:39:07 -07003692 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/")
Ed Tanoused398212021-06-09 17:05:54 -07003693 .privileges(redfish::privileges::getLogService)
Ed Tanous002d39b2022-05-31 08:59:27 -07003694 .methods(boost::beast::http::verb::get)(
3695 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003696 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3697 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003698 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003699 {
3700 return;
3701 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003702 if constexpr (bmcwebEnableMultiHost)
3703 {
3704 // Option currently returns no systems. TBD
3705 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3706 systemName);
3707 return;
3708 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003709 if (systemName != "system")
3710 {
3711 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3712 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003713 return;
3714 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003715 asyncResp->res.jsonValue["@odata.id"] =
3716 "/redfish/v1/Systems/system/LogServices/PostCodes";
3717 asyncResp->res.jsonValue["@odata.type"] =
3718 "#LogService.v1_1_0.LogService";
3719 asyncResp->res.jsonValue["Name"] = "POST Code Log Service";
3720 asyncResp->res.jsonValue["Description"] = "POST Code Log Service";
Ed Tanoused34a4a2023-02-08 15:43:27 -08003721 asyncResp->res.jsonValue["Id"] = "PostCodes";
Ed Tanous002d39b2022-05-31 08:59:27 -07003722 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
3723 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
3724 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
Tejas Patil7c8c4052021-06-04 17:43:14 +05303725
Ed Tanous002d39b2022-05-31 08:59:27 -07003726 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07003727 redfish::time_utils::getDateTimeOffsetNow();
Ed Tanous002d39b2022-05-31 08:59:27 -07003728 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
3729 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
3730 redfishDateTimeOffset.second;
Tejas Patil7c8c4052021-06-04 17:43:14 +05303731
Ed Tanous002d39b2022-05-31 08:59:27 -07003732 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
3733 {"target",
3734 "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}};
George Liu0fda0f12021-11-16 10:06:17 +08003735 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003736}
ZhikuiRena3316fc2020-01-29 14:58:08 -08003737
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003738inline void requestRoutesPostCodesClear(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003739{
George Liu0fda0f12021-11-16 10:06:17 +08003740 BMCWEB_ROUTE(
3741 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003742 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07003743 // The following privilege is incorrect; It should be ConfigureManager
3744 //.privileges(redfish::privileges::postLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07003745 .privileges({{"ConfigureComponents"}})
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003746 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003747 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003748 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3749 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003750 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003751 {
3752 return;
3753 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08003754 if constexpr (bmcwebEnableMultiHost)
3755 {
3756 // Option currently returns no systems. TBD
3757 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3758 systemName);
3759 return;
3760 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003761 if (systemName != "system")
3762 {
3763 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3764 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003765 return;
3766 }
Ed Tanous62598e32023-07-17 17:06:25 -07003767 BMCWEB_LOG_DEBUG("Do delete all postcodes entries.");
ZhikuiRena3316fc2020-01-29 14:58:08 -08003768
Ed Tanous002d39b2022-05-31 08:59:27 -07003769 // Make call to post-code service to request clear all
3770 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003771 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003772 if (ec)
3773 {
3774 // TODO Handle for specific error code
Ed Tanous62598e32023-07-17 17:06:25 -07003775 BMCWEB_LOG_ERROR("doClearPostCodes resp_handler got error {}",
3776 ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07003777 asyncResp->res.result(
3778 boost::beast::http::status::internal_server_error);
3779 messages::internalError(asyncResp->res);
3780 return;
3781 }
3782 },
3783 "xyz.openbmc_project.State.Boot.PostCode0",
3784 "/xyz/openbmc_project/State/Boot/PostCode0",
3785 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3786 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003787}
ZhikuiRena3316fc2020-01-29 14:58:08 -08003788
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003789/**
3790 * @brief Parse post code ID and get the current value and index value
3791 * eg: postCodeID=B1-2, currentValue=1, index=2
3792 *
3793 * @param[in] postCodeID Post Code ID
3794 * @param[out] currentValue Current value
3795 * @param[out] index Index value
3796 *
3797 * @return bool true if the parsing is successful, false the parsing fails
3798 */
3799inline static bool parsePostCode(const std::string& postCodeID,
3800 uint64_t& currentValue, uint16_t& index)
3801{
3802 std::vector<std::string> split;
Ed Tanous50ebd4a2023-01-19 19:03:17 -08003803 bmcweb::split(split, postCodeID, '-');
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003804 if (split.size() != 2 || split[0].length() < 2 || split[0].front() != 'B')
3805 {
3806 return false;
3807 }
3808
Patrick Williams84396af2023-05-11 11:47:45 -05003809 auto start = std::next(split[0].begin());
3810 auto end = split[0].end();
3811 auto [ptrIndex, ecIndex] = std::from_chars(&*start, &*end, index);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003812
Patrick Williams84396af2023-05-11 11:47:45 -05003813 if (ptrIndex != &*end || ecIndex != std::errc())
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003814 {
3815 return false;
3816 }
3817
Patrick Williams84396af2023-05-11 11:47:45 -05003818 start = split[1].begin();
3819 end = split[1].end();
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003820
Patrick Williams84396af2023-05-11 11:47:45 -05003821 auto [ptrValue, ecValue] = std::from_chars(&*start, &*end, currentValue);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003822
Patrick Williams84396af2023-05-11 11:47:45 -05003823 return ptrValue == &*end && ecValue == std::errc();
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003824}
3825
3826static bool fillPostCodeEntry(
Ed Tanousac106bf2023-06-07 09:24:59 -07003827 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303828 const boost::container::flat_map<
3829 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode,
ZhikuiRena3316fc2020-01-29 14:58:08 -08003830 const uint16_t bootIndex, const uint64_t codeIndex = 0,
3831 const uint64_t skip = 0, const uint64_t top = 0)
3832{
3833 // Get the Message from the MessageRegistry
Ed Tanousfffb8c12022-02-07 23:53:03 -08003834 const registries::Message* message =
3835 registries::getMessage("OpenBMC.0.2.BIOSPOSTCode");
ZhikuiRena3316fc2020-01-29 14:58:08 -08003836
3837 uint64_t currentCodeIndex = 0;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003838 uint64_t firstCodeTimeUs = 0;
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303839 for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
3840 code : postcode)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003841 {
3842 currentCodeIndex++;
3843 std::string postcodeEntryID =
3844 "B" + std::to_string(bootIndex) + "-" +
3845 std::to_string(currentCodeIndex); // 1 based index in EntryID string
3846
3847 uint64_t usecSinceEpoch = code.first;
3848 uint64_t usTimeOffset = 0;
3849
3850 if (1 == currentCodeIndex)
3851 { // already incremented
3852 firstCodeTimeUs = code.first;
3853 }
3854 else
3855 {
3856 usTimeOffset = code.first - firstCodeTimeUs;
3857 }
3858
3859 // skip if no specific codeIndex is specified and currentCodeIndex does
3860 // not fall between top and skip
3861 if ((codeIndex == 0) &&
3862 (currentCodeIndex <= skip || currentCodeIndex > top))
3863 {
3864 continue;
3865 }
3866
Gunnar Mills4e0453b2020-07-08 14:00:30 -05003867 // skip if a specific codeIndex is specified and does not match the
ZhikuiRena3316fc2020-01-29 14:58:08 -08003868 // currentIndex
3869 if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
3870 {
3871 // This is done for simplicity. 1st entry is needed to calculate
3872 // time offset. To improve efficiency, one can get to the entry
3873 // directly (possibly with flatmap's nth method)
3874 continue;
3875 }
3876
3877 // currentCodeIndex is within top and skip or equal to specified code
3878 // index
3879
3880 // Get the Created time from the timestamp
3881 std::string entryTimeStr;
Konstantin Aladyshev2a025612023-02-15 11:52:58 +03003882 entryTimeStr = redfish::time_utils::getDateTimeUintUs(usecSinceEpoch);
ZhikuiRena3316fc2020-01-29 14:58:08 -08003883
3884 // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
3885 std::ostringstream hexCode;
3886 hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303887 << std::get<0>(code.second);
ZhikuiRena3316fc2020-01-29 14:58:08 -08003888 std::ostringstream timeOffsetStr;
3889 // Set Fixed -Point Notation
3890 timeOffsetStr << std::fixed;
3891 // Set precision to 4 digits
3892 timeOffsetStr << std::setprecision(4);
3893 // Add double to stream
3894 timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003895
Ed Tanous1e6deaf2022-02-17 11:32:37 -08003896 std::string bootIndexStr = std::to_string(bootIndex);
3897 std::string timeOffsetString = timeOffsetStr.str();
3898 std::string hexCodeStr = hexCode.str();
3899
3900 std::array<std::string_view, 3> messageArgs = {
3901 bootIndexStr, timeOffsetString, hexCodeStr};
3902
3903 std::string msg =
3904 redfish::registries::fillMessageArgs(messageArgs, message->message);
3905 if (msg.empty())
ZhikuiRena3316fc2020-01-29 14:58:08 -08003906 {
Ed Tanous1e6deaf2022-02-17 11:32:37 -08003907 messages::internalError(asyncResp->res);
3908 return false;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003909 }
3910
Tim Leed4342a92020-04-27 11:47:58 +08003911 // Get Severity template from message registry
3912 std::string severity;
3913 if (message != nullptr)
3914 {
Ed Tanous5f2b84e2022-02-08 00:41:53 -08003915 severity = message->messageSeverity;
Tim Leed4342a92020-04-27 11:47:58 +08003916 }
3917
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003918 // Format entry
3919 nlohmann::json::object_t bmcLogEntry;
Vijay Lobo9c11a172021-10-07 16:53:16 -05003920 bmcLogEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07003921 bmcLogEntry["@odata.id"] = boost::urls::format(
3922 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/{}",
3923 postcodeEntryID);
Jason M. Bills84afc482022-06-24 12:38:23 -07003924 bmcLogEntry["Name"] = "POST Code Log Entry";
3925 bmcLogEntry["Id"] = postcodeEntryID;
3926 bmcLogEntry["Message"] = std::move(msg);
3927 bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode";
Ed Tanous1e6deaf2022-02-17 11:32:37 -08003928 bmcLogEntry["MessageArgs"] = messageArgs;
Jason M. Bills84afc482022-06-24 12:38:23 -07003929 bmcLogEntry["EntryType"] = "Event";
3930 bmcLogEntry["Severity"] = std::move(severity);
3931 bmcLogEntry["Created"] = entryTimeStr;
George Liu647b3cd2021-07-05 12:43:56 +08003932 if (!std::get<std::vector<uint8_t>>(code.second).empty())
3933 {
3934 bmcLogEntry["AdditionalDataURI"] =
3935 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" +
3936 postcodeEntryID + "/attachment";
3937 }
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003938
3939 // codeIndex is only specified when querying single entry, return only
3940 // that entry in this case
3941 if (codeIndex != 0)
3942 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003943 asyncResp->res.jsonValue.update(bmcLogEntry);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003944 return true;
3945 }
3946
Ed Tanousac106bf2023-06-07 09:24:59 -07003947 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
Patrick Williamsb2ba3072023-05-12 10:27:39 -05003948 logEntryArray.emplace_back(std::move(bmcLogEntry));
ZhikuiRena3316fc2020-01-29 14:58:08 -08003949 }
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003950
3951 // Return value is always false when querying multiple entries
3952 return false;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003953}
3954
Ed Tanousac106bf2023-06-07 09:24:59 -07003955static void
3956 getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3957 const std::string& entryId)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003958{
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003959 uint16_t bootIndex = 0;
3960 uint64_t codeIndex = 0;
3961 if (!parsePostCode(entryId, codeIndex, bootIndex))
3962 {
3963 // Requested ID was not found
Ed Tanousac106bf2023-06-07 09:24:59 -07003964 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003965 return;
3966 }
3967
3968 if (bootIndex == 0 || codeIndex == 0)
3969 {
3970 // 0 is an invalid index
Ed Tanousac106bf2023-06-07 09:24:59 -07003971 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003972 return;
3973 }
3974
ZhikuiRena3316fc2020-01-29 14:58:08 -08003975 crow::connections::systemBus->async_method_call(
Ed Tanousac106bf2023-06-07 09:24:59 -07003976 [asyncResp, entryId, bootIndex,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003977 codeIndex](const boost::system::error_code& ec,
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303978 const boost::container::flat_map<
3979 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
3980 postcode) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003981 if (ec)
3982 {
Ed Tanous62598e32023-07-17 17:06:25 -07003983 BMCWEB_LOG_DEBUG("DBUS POST CODE PostCode response error");
Ed Tanousac106bf2023-06-07 09:24:59 -07003984 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07003985 return;
3986 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003987
Ed Tanous002d39b2022-05-31 08:59:27 -07003988 if (postcode.empty())
3989 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003990 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Ed Tanous002d39b2022-05-31 08:59:27 -07003991 return;
3992 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003993
Ed Tanousac106bf2023-06-07 09:24:59 -07003994 if (!fillPostCodeEntry(asyncResp, postcode, bootIndex, codeIndex))
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003995 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003996 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003997 return;
3998 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003999 },
Jonathan Doman15124762021-01-07 17:54:17 -08004000 "xyz.openbmc_project.State.Boot.PostCode0",
4001 "/xyz/openbmc_project/State/Boot/PostCode0",
ZhikuiRena3316fc2020-01-29 14:58:08 -08004002 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
4003 bootIndex);
4004}
4005
Ed Tanousac106bf2023-06-07 09:24:59 -07004006static void
4007 getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
4008 const uint16_t bootIndex, const uint16_t bootCount,
4009 const uint64_t entryCount, size_t skip, size_t top)
ZhikuiRena3316fc2020-01-29 14:58:08 -08004010{
4011 crow::connections::systemBus->async_method_call(
Ed Tanousac106bf2023-06-07 09:24:59 -07004012 [asyncResp, bootIndex, bootCount, entryCount, skip,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08004013 top](const boost::system::error_code& ec,
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05304014 const boost::container::flat_map<
4015 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
4016 postcode) {
Ed Tanous002d39b2022-05-31 08:59:27 -07004017 if (ec)
4018 {
Ed Tanous62598e32023-07-17 17:06:25 -07004019 BMCWEB_LOG_DEBUG("DBUS POST CODE PostCode response error");
Ed Tanousac106bf2023-06-07 09:24:59 -07004020 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07004021 return;
4022 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08004023
Ed Tanous002d39b2022-05-31 08:59:27 -07004024 uint64_t endCount = entryCount;
4025 if (!postcode.empty())
4026 {
4027 endCount = entryCount + postcode.size();
Ed Tanous3648c8b2022-07-25 13:39:59 -07004028 if (skip < endCount && (top + skip) > entryCount)
ZhikuiRena3316fc2020-01-29 14:58:08 -08004029 {
Patrick Williams89492a12023-05-10 07:51:34 -05004030 uint64_t thisBootSkip = std::max(static_cast<uint64_t>(skip),
4031 entryCount) -
4032 entryCount;
Ed Tanous002d39b2022-05-31 08:59:27 -07004033 uint64_t thisBootTop =
Ed Tanous3648c8b2022-07-25 13:39:59 -07004034 std::min(static_cast<uint64_t>(top + skip), endCount) -
4035 entryCount;
Ed Tanous002d39b2022-05-31 08:59:27 -07004036
Ed Tanousac106bf2023-06-07 09:24:59 -07004037 fillPostCodeEntry(asyncResp, postcode, bootIndex, 0,
4038 thisBootSkip, thisBootTop);
ZhikuiRena3316fc2020-01-29 14:58:08 -08004039 }
Ed Tanousac106bf2023-06-07 09:24:59 -07004040 asyncResp->res.jsonValue["Members@odata.count"] = endCount;
Ed Tanous002d39b2022-05-31 08:59:27 -07004041 }
4042
4043 // continue to previous bootIndex
4044 if (bootIndex < bootCount)
4045 {
Ed Tanousac106bf2023-06-07 09:24:59 -07004046 getPostCodeForBoot(asyncResp, static_cast<uint16_t>(bootIndex + 1),
Ed Tanous002d39b2022-05-31 08:59:27 -07004047 bootCount, endCount, skip, top);
4048 }
Jiaqing Zhao81584ab2022-07-28 00:33:45 +08004049 else if (skip + top < endCount)
Ed Tanous002d39b2022-05-31 08:59:27 -07004050 {
Ed Tanousac106bf2023-06-07 09:24:59 -07004051 asyncResp->res.jsonValue["Members@odata.nextLink"] =
Ed Tanous002d39b2022-05-31 08:59:27 -07004052 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" +
4053 std::to_string(skip + top);
4054 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08004055 },
Jonathan Doman15124762021-01-07 17:54:17 -08004056 "xyz.openbmc_project.State.Boot.PostCode0",
4057 "/xyz/openbmc_project/State/Boot/PostCode0",
ZhikuiRena3316fc2020-01-29 14:58:08 -08004058 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
4059 bootIndex);
4060}
4061
zhanghch058d1b46d2021-04-01 11:18:24 +08004062static void
Ed Tanousac106bf2023-06-07 09:24:59 -07004063 getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous3648c8b2022-07-25 13:39:59 -07004064 size_t skip, size_t top)
ZhikuiRena3316fc2020-01-29 14:58:08 -08004065{
4066 uint64_t entryCount = 0;
Jonathan Doman1e1e5982021-06-11 09:36:17 -07004067 sdbusplus::asio::getProperty<uint16_t>(
4068 *crow::connections::systemBus,
4069 "xyz.openbmc_project.State.Boot.PostCode0",
4070 "/xyz/openbmc_project/State/Boot/PostCode0",
4071 "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount",
Ed Tanousac106bf2023-06-07 09:24:59 -07004072 [asyncResp, entryCount, skip, top](const boost::system::error_code& ec,
4073 const uint16_t bootCount) {
Ed Tanous002d39b2022-05-31 08:59:27 -07004074 if (ec)
4075 {
Ed Tanous62598e32023-07-17 17:06:25 -07004076 BMCWEB_LOG_DEBUG("DBUS response error {}", ec);
Ed Tanousac106bf2023-06-07 09:24:59 -07004077 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07004078 return;
4079 }
Ed Tanousac106bf2023-06-07 09:24:59 -07004080 getPostCodeForBoot(asyncResp, 1, bootCount, entryCount, skip, top);
Jonathan Doman1e1e5982021-06-11 09:36:17 -07004081 });
ZhikuiRena3316fc2020-01-29 14:58:08 -08004082}
4083
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004084inline void requestRoutesPostCodesEntryCollection(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08004085{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004086 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07004087 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07004088 .privileges(redfish::privileges::getLogEntryCollection)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004089 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07004090 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07004091 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
4092 const std::string& systemName) {
Ed Tanous002d39b2022-05-31 08:59:27 -07004093 query_param::QueryCapabilities capabilities = {
4094 .canDelegateTop = true,
4095 .canDelegateSkip = true,
4096 };
4097 query_param::Query delegatedQuery;
4098 if (!redfish::setUpRedfishRouteWithDelegation(
Carson Labrado3ba00072022-06-06 19:40:56 +00004099 app, req, asyncResp, delegatedQuery, capabilities))
Ed Tanous002d39b2022-05-31 08:59:27 -07004100 {
4101 return;
4102 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08004103 if constexpr (bmcwebEnableMultiHost)
4104 {
4105 // Option currently returns no systems. TBD
4106 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
4107 systemName);
4108 return;
4109 }
Ed Tanous22d268c2022-05-19 09:39:07 -07004110
4111 if (systemName != "system")
4112 {
4113 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
4114 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07004115 return;
4116 }
Ed Tanous002d39b2022-05-31 08:59:27 -07004117 asyncResp->res.jsonValue["@odata.type"] =
4118 "#LogEntryCollection.LogEntryCollection";
4119 asyncResp->res.jsonValue["@odata.id"] =
4120 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
4121 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
4122 asyncResp->res.jsonValue["Description"] =
4123 "Collection of POST Code Log Entries";
4124 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
4125 asyncResp->res.jsonValue["Members@odata.count"] = 0;
Ed Tanous3648c8b2022-07-25 13:39:59 -07004126 size_t skip = delegatedQuery.skip.value_or(0);
Jiaqing Zhao5143f7a2022-07-22 09:33:33 +08004127 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
Ed Tanous3648c8b2022-07-25 13:39:59 -07004128 getCurrentBootNumber(asyncResp, skip, top);
Ed Tanous002d39b2022-05-31 08:59:27 -07004129 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004130}
ZhikuiRena3316fc2020-01-29 14:58:08 -08004131
George Liu647b3cd2021-07-05 12:43:56 +08004132inline void requestRoutesPostCodesEntryAdditionalData(App& app)
4133{
George Liu0fda0f12021-11-16 10:06:17 +08004134 BMCWEB_ROUTE(
4135 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07004136 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/attachment/")
George Liu647b3cd2021-07-05 12:43:56 +08004137 .privileges(redfish::privileges::getLogEntry)
4138 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07004139 [&app](const crow::Request& req,
4140 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07004141 const std::string& systemName,
Ed Tanous45ca1b82022-03-25 13:07:27 -07004142 const std::string& postCodeID) {
Carson Labrado3ba00072022-06-06 19:40:56 +00004143 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07004144 {
4145 return;
4146 }
Matt Spinler72e21372023-04-19 12:53:33 -05004147 if (!http_helpers::isContentTypeAllowed(
Ed Tanous99351cd2022-08-07 16:42:51 -07004148 req.getHeaderValue("Accept"),
Ed Tanous4a0e1a02022-09-21 15:28:04 -07004149 http_helpers::ContentType::OctetStream, true))
Ed Tanous002d39b2022-05-31 08:59:27 -07004150 {
4151 asyncResp->res.result(boost::beast::http::status::bad_request);
4152 return;
4153 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08004154 if constexpr (bmcwebEnableMultiHost)
4155 {
4156 // Option currently returns no systems. TBD
4157 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
4158 systemName);
4159 return;
4160 }
Ed Tanous22d268c2022-05-19 09:39:07 -07004161 if (systemName != "system")
4162 {
4163 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
4164 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07004165 return;
4166 }
George Liu647b3cd2021-07-05 12:43:56 +08004167
Ed Tanous002d39b2022-05-31 08:59:27 -07004168 uint64_t currentValue = 0;
4169 uint16_t index = 0;
4170 if (!parsePostCode(postCodeID, currentValue, index))
4171 {
4172 messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID);
4173 return;
4174 }
George Liu647b3cd2021-07-05 12:43:56 +08004175
Ed Tanous002d39b2022-05-31 08:59:27 -07004176 crow::connections::systemBus->async_method_call(
4177 [asyncResp, postCodeID, currentValue](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08004178 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07004179 const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>&
4180 postcodes) {
4181 if (ec.value() == EBADR)
4182 {
4183 messages::resourceNotFound(asyncResp->res, "LogEntry",
4184 postCodeID);
4185 return;
4186 }
4187 if (ec)
4188 {
Ed Tanous62598e32023-07-17 17:06:25 -07004189 BMCWEB_LOG_DEBUG("DBUS response error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07004190 messages::internalError(asyncResp->res);
4191 return;
4192 }
George Liu647b3cd2021-07-05 12:43:56 +08004193
Ed Tanous002d39b2022-05-31 08:59:27 -07004194 size_t value = static_cast<size_t>(currentValue) - 1;
4195 if (value == std::string::npos || postcodes.size() < currentValue)
4196 {
Ed Tanous62598e32023-07-17 17:06:25 -07004197 BMCWEB_LOG_WARNING("Wrong currentValue value");
Ed Tanous002d39b2022-05-31 08:59:27 -07004198 messages::resourceNotFound(asyncResp->res, "LogEntry",
4199 postCodeID);
4200 return;
4201 }
George Liu647b3cd2021-07-05 12:43:56 +08004202
Ed Tanous002d39b2022-05-31 08:59:27 -07004203 const auto& [tID, c] = postcodes[value];
4204 if (c.empty())
4205 {
Ed Tanous62598e32023-07-17 17:06:25 -07004206 BMCWEB_LOG_WARNING("No found post code data");
Ed Tanous002d39b2022-05-31 08:59:27 -07004207 messages::resourceNotFound(asyncResp->res, "LogEntry",
4208 postCodeID);
4209 return;
4210 }
4211 // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
4212 const char* d = reinterpret_cast<const char*>(c.data());
4213 std::string_view strData(d, c.size());
George Liu647b3cd2021-07-05 12:43:56 +08004214
Ed Tanousd9f6c622022-03-17 09:12:17 -07004215 asyncResp->res.addHeader(boost::beast::http::field::content_type,
Ed Tanous002d39b2022-05-31 08:59:27 -07004216 "application/octet-stream");
Ed Tanousd9f6c622022-03-17 09:12:17 -07004217 asyncResp->res.addHeader(
4218 boost::beast::http::field::content_transfer_encoding, "Base64");
Ed Tanous002d39b2022-05-31 08:59:27 -07004219 asyncResp->res.body() = crow::utility::base64encode(strData);
4220 },
4221 "xyz.openbmc_project.State.Boot.PostCode0",
4222 "/xyz/openbmc_project/State/Boot/PostCode0",
4223 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index);
4224 });
George Liu647b3cd2021-07-05 12:43:56 +08004225}
4226
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004227inline void requestRoutesPostCodesEntry(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08004228{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004229 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07004230 app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07004231 .privileges(redfish::privileges::getLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004232 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07004233 [&app](const crow::Request& req,
4234 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07004235 const std::string& systemName, const std::string& targetID) {
Carson Labrado3ba00072022-06-06 19:40:56 +00004236 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07004237 {
4238 return;
4239 }
Ed Tanous7f3e84a2022-12-28 16:22:54 -08004240 if constexpr (bmcwebEnableMultiHost)
4241 {
4242 // Option currently returns no systems. TBD
4243 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
4244 systemName);
4245 return;
4246 }
Ed Tanous22d268c2022-05-19 09:39:07 -07004247 if (systemName != "system")
4248 {
4249 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
4250 systemName);
4251 return;
4252 }
4253
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08004254 getPostCodeForEntry(asyncResp, targetID);
Ed Tanous002d39b2022-05-31 08:59:27 -07004255 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004256}
ZhikuiRena3316fc2020-01-29 14:58:08 -08004257
Ed Tanous1da66f72018-07-27 16:13:37 -07004258} // namespace redfish