blob: fedf7ad6c0bebce98d260143196ed0aaecc4de9d [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 {
162 BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
163 << strerror(-ret);
164 return false;
165 }
Konstantin Aladysheve645c5e2023-02-17 13:09:53 +0300166 entryTimestamp = redfish::time_utils::getDateTimeUintUs(timestamp);
Asmitha Karunanithi9c620e22020-08-02 11:55:21 -0500167 return true;
ZhikuiRena3316fc2020-01-29 14:58:08 -0800168}
Ed Tanous50b8a432022-02-03 16:29:50 -0800169
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700170inline static bool getUniqueEntryID(sd_journal* journal, std::string& entryID,
171 const bool firstEntry = true)
Jason M. Bills16428a12018-11-02 12:42:29 -0700172{
173 int ret = 0;
174 static uint64_t prevTs = 0;
175 static int index = 0;
Jason M. Billse85d6b12019-07-29 17:01:15 -0700176 if (firstEntry)
177 {
178 prevTs = 0;
179 }
180
Jason M. Bills16428a12018-11-02 12:42:29 -0700181 // Get the entry timestamp
182 uint64_t curTs = 0;
183 ret = sd_journal_get_realtime_usec(journal, &curTs);
184 if (ret < 0)
185 {
186 BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
187 << strerror(-ret);
188 return false;
189 }
190 // If the timestamp isn't unique, increment the index
191 if (curTs == prevTs)
192 {
193 index++;
194 }
195 else
196 {
197 // Otherwise, reset it
198 index = 0;
199 }
200 // Save the timestamp
201 prevTs = curTs;
202
203 entryID = std::to_string(curTs);
204 if (index > 0)
205 {
206 entryID += "_" + std::to_string(index);
207 }
208 return true;
209}
210
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500211static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID,
Jason M. Billse85d6b12019-07-29 17:01:15 -0700212 const bool firstEntry = true)
Jason M. Bills95820182019-04-22 16:25:34 -0700213{
Ed Tanous271584a2019-07-09 16:24:22 -0700214 static time_t prevTs = 0;
Jason M. Bills95820182019-04-22 16:25:34 -0700215 static int index = 0;
Jason M. Billse85d6b12019-07-29 17:01:15 -0700216 if (firstEntry)
217 {
218 prevTs = 0;
219 }
220
Jason M. Bills95820182019-04-22 16:25:34 -0700221 // Get the entry timestamp
Ed Tanous271584a2019-07-09 16:24:22 -0700222 std::time_t curTs = 0;
Jason M. Bills95820182019-04-22 16:25:34 -0700223 std::tm timeStruct = {};
224 std::istringstream entryStream(logEntry);
225 if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
226 {
227 curTs = std::mktime(&timeStruct);
228 }
229 // If the timestamp isn't unique, increment the index
230 if (curTs == prevTs)
231 {
232 index++;
233 }
234 else
235 {
236 // Otherwise, reset it
237 index = 0;
238 }
239 // Save the timestamp
240 prevTs = curTs;
241
242 entryID = std::to_string(curTs);
243 if (index > 0)
244 {
245 entryID += "_" + std::to_string(index);
246 }
247 return true;
248}
249
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700250inline static bool
zhanghch058d1b46d2021-04-01 11:18:24 +0800251 getTimestampFromID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
252 const std::string& entryID, uint64_t& timestamp,
253 uint64_t& index)
Jason M. Bills16428a12018-11-02 12:42:29 -0700254{
255 if (entryID.empty())
256 {
257 return false;
258 }
259 // Convert the unique ID back to a timestamp to find the entry
Ed Tanous39e77502019-03-04 17:35:53 -0800260 std::string_view tsStr(entryID);
Jason M. Bills16428a12018-11-02 12:42:29 -0700261
Ed Tanous81ce6092020-12-17 16:54:55 +0000262 auto underscorePos = tsStr.find('_');
Ed Tanous71d5d8d2022-01-25 11:04:33 -0800263 if (underscorePos != std::string_view::npos)
Jason M. Bills16428a12018-11-02 12:42:29 -0700264 {
265 // Timestamp has an index
266 tsStr.remove_suffix(tsStr.size() - underscorePos);
Ed Tanous39e77502019-03-04 17:35:53 -0800267 std::string_view indexStr(entryID);
Jason M. Bills16428a12018-11-02 12:42:29 -0700268 indexStr.remove_prefix(underscorePos + 1);
Patrick Williams84396af2023-05-11 11:47:45 -0500269 auto [ptr, ec] = std::from_chars(indexStr.begin(), indexStr.end(),
270 index);
Ed Tanousc0bd5e42021-09-13 17:00:19 -0700271 if (ec != std::errc())
Jason M. Bills16428a12018-11-02 12:42:29 -0700272 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +0800273 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
Jason M. Bills16428a12018-11-02 12:42:29 -0700274 return false;
275 }
276 }
277 // Timestamp has no index
Patrick Williams84396af2023-05-11 11:47:45 -0500278 auto [ptr, ec] = std::from_chars(tsStr.begin(), tsStr.end(), timestamp);
Ed Tanousc0bd5e42021-09-13 17:00:19 -0700279 if (ec != std::errc())
Jason M. Bills16428a12018-11-02 12:42:29 -0700280 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +0800281 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
Jason M. Bills16428a12018-11-02 12:42:29 -0700282 return false;
283 }
284 return true;
285}
286
Jason M. Bills95820182019-04-22 16:25:34 -0700287static bool
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500288 getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles)
Jason M. Bills95820182019-04-22 16:25:34 -0700289{
290 static const std::filesystem::path redfishLogDir = "/var/log";
291 static const std::string redfishLogFilename = "redfish";
292
293 // Loop through the directory looking for redfish log files
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500294 for (const std::filesystem::directory_entry& dirEnt :
Jason M. Bills95820182019-04-22 16:25:34 -0700295 std::filesystem::directory_iterator(redfishLogDir))
296 {
297 // If we find a redfish log file, save the path
298 std::string filename = dirEnt.path().filename();
Ed Tanous11ba3972022-07-11 09:50:41 -0700299 if (filename.starts_with(redfishLogFilename))
Jason M. Bills95820182019-04-22 16:25:34 -0700300 {
301 redfishLogFiles.emplace_back(redfishLogDir / filename);
302 }
303 }
304 // As the log files rotate, they are appended with a ".#" that is higher for
305 // the older logs. Since we don't expect more than 10 log files, we
306 // can just sort the list to get them in order from newest to oldest
307 std::sort(redfishLogFiles.begin(), redfishLogFiles.end());
308
309 return !redfishLogFiles.empty();
310}
311
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600312inline log_entry::OriginatorTypes
313 mapDbusOriginatorTypeToRedfish(const std::string& originatorType)
314{
315 if (originatorType ==
316 "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client")
317 {
318 return log_entry::OriginatorTypes::Client;
319 }
320 if (originatorType ==
321 "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Internal")
322 {
323 return log_entry::OriginatorTypes::Internal;
324 }
325 if (originatorType ==
326 "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.SupportingService")
327 {
328 return log_entry::OriginatorTypes::SupportingService;
329 }
330 return log_entry::OriginatorTypes::Invalid;
331}
332
Claire Weinanaefe3782022-07-15 19:17:19 -0700333inline void parseDumpEntryFromDbusObject(
Jiaqing Zhao2d613eb2022-08-15 16:03:00 +0800334 const dbus::utility::ManagedObjectType::value_type& object,
Claire Weinanc6fecda2022-07-15 10:43:25 -0700335 std::string& dumpStatus, uint64_t& size, uint64_t& timestampUs,
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600336 std::string& originatorId, log_entry::OriginatorTypes& originatorType,
Claire Weinanaefe3782022-07-15 19:17:19 -0700337 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
338{
339 for (const auto& interfaceMap : object.second)
340 {
341 if (interfaceMap.first == "xyz.openbmc_project.Common.Progress")
342 {
343 for (const auto& propertyMap : interfaceMap.second)
344 {
345 if (propertyMap.first == "Status")
346 {
347 const auto* status =
348 std::get_if<std::string>(&propertyMap.second);
349 if (status == nullptr)
350 {
351 messages::internalError(asyncResp->res);
352 break;
353 }
354 dumpStatus = *status;
355 }
356 }
357 }
358 else if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
359 {
360 for (const auto& propertyMap : interfaceMap.second)
361 {
362 if (propertyMap.first == "Size")
363 {
364 const auto* sizePtr =
365 std::get_if<uint64_t>(&propertyMap.second);
366 if (sizePtr == nullptr)
367 {
368 messages::internalError(asyncResp->res);
369 break;
370 }
371 size = *sizePtr;
372 break;
373 }
374 }
375 }
376 else if (interfaceMap.first == "xyz.openbmc_project.Time.EpochTime")
377 {
378 for (const auto& propertyMap : interfaceMap.second)
379 {
380 if (propertyMap.first == "Elapsed")
381 {
382 const uint64_t* usecsTimeStamp =
383 std::get_if<uint64_t>(&propertyMap.second);
384 if (usecsTimeStamp == nullptr)
385 {
386 messages::internalError(asyncResp->res);
387 break;
388 }
Claire Weinanc6fecda2022-07-15 10:43:25 -0700389 timestampUs = *usecsTimeStamp;
Claire Weinanaefe3782022-07-15 19:17:19 -0700390 break;
391 }
392 }
393 }
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600394 else if (interfaceMap.first ==
395 "xyz.openbmc_project.Common.OriginatedBy")
396 {
397 for (const auto& propertyMap : interfaceMap.second)
398 {
399 if (propertyMap.first == "OriginatorId")
400 {
401 const std::string* id =
402 std::get_if<std::string>(&propertyMap.second);
403 if (id == nullptr)
404 {
405 messages::internalError(asyncResp->res);
406 break;
407 }
408 originatorId = *id;
409 }
410
411 if (propertyMap.first == "OriginatorType")
412 {
413 const std::string* type =
414 std::get_if<std::string>(&propertyMap.second);
415 if (type == nullptr)
416 {
417 messages::internalError(asyncResp->res);
418 break;
419 }
420
421 originatorType = mapDbusOriginatorTypeToRedfish(*type);
422 if (originatorType == log_entry::OriginatorTypes::Invalid)
423 {
424 messages::internalError(asyncResp->res);
425 break;
426 }
427 }
428 }
429 }
Claire Weinanaefe3782022-07-15 19:17:19 -0700430 }
431}
432
Nan Zhou21ab4042022-06-26 23:07:40 +0000433static std::string getDumpEntriesPath(const std::string& dumpType)
Claire Weinanfdd26902022-03-01 14:18:25 -0800434{
435 std::string entriesPath;
436
437 if (dumpType == "BMC")
438 {
439 entriesPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
440 }
441 else if (dumpType == "FaultLog")
442 {
443 entriesPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/";
444 }
445 else if (dumpType == "System")
446 {
447 entriesPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
448 }
449 else
450 {
451 BMCWEB_LOG_ERROR << "getDumpEntriesPath() invalid dump type: "
452 << dumpType;
453 }
454
455 // Returns empty string on error
456 return entriesPath;
457}
458
zhanghch058d1b46d2021-04-01 11:18:24 +0800459inline void
460 getDumpEntryCollection(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
461 const std::string& dumpType)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500462{
Claire Weinanfdd26902022-03-01 14:18:25 -0800463 std::string entriesPath = getDumpEntriesPath(dumpType);
464 if (entriesPath.empty())
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500465 {
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500466 messages::internalError(asyncResp->res);
467 return;
468 }
469
George Liu5eb468d2023-06-20 17:03:24 +0800470 sdbusplus::message::object_path path("/xyz/openbmc_project/dump");
471 dbus::utility::getManagedObjects(
472 "xyz.openbmc_project.Dump.Manager", path,
Claire Weinanfdd26902022-03-01 14:18:25 -0800473 [asyncResp, entriesPath,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800474 dumpType](const boost::system::error_code& ec,
George Liu5eb468d2023-06-20 17:03:24 +0800475 const dbus::utility::ManagedObjectType& objects) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700476 if (ec)
477 {
478 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
479 messages::internalError(asyncResp->res);
480 return;
481 }
482
Claire Weinanfdd26902022-03-01 14:18:25 -0800483 // Remove ending slash
484 std::string odataIdStr = entriesPath;
485 if (!odataIdStr.empty())
486 {
487 odataIdStr.pop_back();
488 }
489
490 asyncResp->res.jsonValue["@odata.type"] =
491 "#LogEntryCollection.LogEntryCollection";
492 asyncResp->res.jsonValue["@odata.id"] = std::move(odataIdStr);
493 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entries";
Patrick Williams89492a12023-05-10 07:51:34 -0500494 asyncResp->res.jsonValue["Description"] = "Collection of " + dumpType +
495 " Dump Entries";
Claire Weinanfdd26902022-03-01 14:18:25 -0800496
Ed Tanous002d39b2022-05-31 08:59:27 -0700497 nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
498 entriesArray = nlohmann::json::array();
499 std::string dumpEntryPath =
500 "/xyz/openbmc_project/dump/" +
501 std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/";
502
George Liu5eb468d2023-06-20 17:03:24 +0800503 dbus::utility::ManagedObjectType resp(objects);
Ed Tanous002d39b2022-05-31 08:59:27 -0700504 std::sort(resp.begin(), resp.end(), [](const auto& l, const auto& r) {
505 return AlphanumLess<std::string>()(l.first.filename(),
506 r.first.filename());
507 });
508
509 for (auto& object : resp)
510 {
511 if (object.first.str.find(dumpEntryPath) == std::string::npos)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500512 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700513 continue;
514 }
Claire Weinanc6fecda2022-07-15 10:43:25 -0700515 uint64_t timestampUs = 0;
Ed Tanous002d39b2022-05-31 08:59:27 -0700516 uint64_t size = 0;
517 std::string dumpStatus;
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600518 std::string originatorId;
519 log_entry::OriginatorTypes originatorType =
520 log_entry::OriginatorTypes::Internal;
Jason M. Bills433b68b2022-06-28 12:24:26 -0700521 nlohmann::json::object_t thisEntry;
Ed Tanous002d39b2022-05-31 08:59:27 -0700522
523 std::string entryID = object.first.filename();
524 if (entryID.empty())
525 {
526 continue;
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500527 }
528
Claire Weinanc6fecda2022-07-15 10:43:25 -0700529 parseDumpEntryFromDbusObject(object, dumpStatus, size, timestampUs,
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600530 originatorId, originatorType,
Claire Weinanaefe3782022-07-15 19:17:19 -0700531 asyncResp);
Ed Tanous002d39b2022-05-31 08:59:27 -0700532
533 if (dumpStatus !=
534 "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" &&
535 !dumpStatus.empty())
536 {
537 // Dump status is not Complete, no need to enumerate
538 continue;
539 }
540
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600541 thisEntry["@odata.type"] = "#LogEntry.v1_11_0.LogEntry";
Claire Weinanfdd26902022-03-01 14:18:25 -0800542 thisEntry["@odata.id"] = entriesPath + entryID;
Ed Tanous002d39b2022-05-31 08:59:27 -0700543 thisEntry["Id"] = entryID;
544 thisEntry["EntryType"] = "Event";
Ed Tanous002d39b2022-05-31 08:59:27 -0700545 thisEntry["Name"] = dumpType + " Dump Entry";
Claire Weinanbbd80db2022-10-26 16:55:52 -0700546 thisEntry["Created"] =
547 redfish::time_utils::getDateTimeUintUs(timestampUs);
Ed Tanous002d39b2022-05-31 08:59:27 -0700548
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600549 if (!originatorId.empty())
550 {
551 thisEntry["Originator"] = originatorId;
552 thisEntry["OriginatorType"] = originatorType;
553 }
554
Ed Tanous002d39b2022-05-31 08:59:27 -0700555 if (dumpType == "BMC")
556 {
557 thisEntry["DiagnosticDataType"] = "Manager";
Patrick Williams89492a12023-05-10 07:51:34 -0500558 thisEntry["AdditionalDataURI"] = entriesPath + entryID +
559 "/attachment";
Claire Weinanfdd26902022-03-01 14:18:25 -0800560 thisEntry["AdditionalDataSizeBytes"] = size;
Ed Tanous002d39b2022-05-31 08:59:27 -0700561 }
562 else if (dumpType == "System")
563 {
564 thisEntry["DiagnosticDataType"] = "OEM";
565 thisEntry["OEMDiagnosticDataType"] = "System";
Patrick Williams89492a12023-05-10 07:51:34 -0500566 thisEntry["AdditionalDataURI"] = entriesPath + entryID +
567 "/attachment";
Claire Weinanfdd26902022-03-01 14:18:25 -0800568 thisEntry["AdditionalDataSizeBytes"] = size;
Ed Tanous002d39b2022-05-31 08:59:27 -0700569 }
Patrick Williamsb2ba3072023-05-12 10:27:39 -0500570 entriesArray.emplace_back(std::move(thisEntry));
Ed Tanous002d39b2022-05-31 08:59:27 -0700571 }
572 asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size();
George Liu5eb468d2023-06-20 17:03:24 +0800573 });
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500574}
575
zhanghch058d1b46d2021-04-01 11:18:24 +0800576inline void
Claire Weinanc7a6d662022-06-13 16:36:39 -0700577 getDumpEntryById(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
zhanghch058d1b46d2021-04-01 11:18:24 +0800578 const std::string& entryID, const std::string& dumpType)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500579{
Claire Weinanfdd26902022-03-01 14:18:25 -0800580 std::string entriesPath = getDumpEntriesPath(dumpType);
581 if (entriesPath.empty())
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500582 {
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500583 messages::internalError(asyncResp->res);
584 return;
585 }
586
George Liu5eb468d2023-06-20 17:03:24 +0800587 sdbusplus::message::object_path path("/xyz/openbmc_project/dump");
588 dbus::utility::getManagedObjects(
589 "xyz.openbmc_project.Dump.Manager", path,
Claire Weinanfdd26902022-03-01 14:18:25 -0800590 [asyncResp, entryID, dumpType,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800591 entriesPath](const boost::system::error_code& ec,
Ed Tanous02cad962022-06-30 16:50:15 -0700592 const dbus::utility::ManagedObjectType& resp) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700593 if (ec)
594 {
595 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
596 messages::internalError(asyncResp->res);
597 return;
598 }
599
600 bool foundDumpEntry = false;
601 std::string dumpEntryPath =
602 "/xyz/openbmc_project/dump/" +
603 std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/";
604
605 for (const auto& objectPath : resp)
606 {
607 if (objectPath.first.str != dumpEntryPath + entryID)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500608 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700609 continue;
610 }
611
612 foundDumpEntry = true;
Claire Weinanc6fecda2022-07-15 10:43:25 -0700613 uint64_t timestampUs = 0;
Ed Tanous002d39b2022-05-31 08:59:27 -0700614 uint64_t size = 0;
615 std::string dumpStatus;
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600616 std::string originatorId;
617 log_entry::OriginatorTypes originatorType =
618 log_entry::OriginatorTypes::Internal;
Ed Tanous002d39b2022-05-31 08:59:27 -0700619
Claire Weinanaefe3782022-07-15 19:17:19 -0700620 parseDumpEntryFromDbusObject(objectPath, dumpStatus, size,
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600621 timestampUs, originatorId,
622 originatorType, asyncResp);
Ed Tanous002d39b2022-05-31 08:59:27 -0700623
624 if (dumpStatus !=
625 "xyz.openbmc_project.Common.Progress.OperationStatus.Completed" &&
626 !dumpStatus.empty())
627 {
628 // Dump status is not Complete
629 // return not found until status is changed to Completed
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +0200630 messages::resourceNotFound(asyncResp->res, dumpType + " dump",
631 entryID);
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500632 return;
633 }
634
Ed Tanous002d39b2022-05-31 08:59:27 -0700635 asyncResp->res.jsonValue["@odata.type"] =
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600636 "#LogEntry.v1_11_0.LogEntry";
Claire Weinanfdd26902022-03-01 14:18:25 -0800637 asyncResp->res.jsonValue["@odata.id"] = entriesPath + entryID;
Ed Tanous002d39b2022-05-31 08:59:27 -0700638 asyncResp->res.jsonValue["Id"] = entryID;
639 asyncResp->res.jsonValue["EntryType"] = "Event";
Ed Tanous002d39b2022-05-31 08:59:27 -0700640 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry";
Claire Weinanbbd80db2022-10-26 16:55:52 -0700641 asyncResp->res.jsonValue["Created"] =
642 redfish::time_utils::getDateTimeUintUs(timestampUs);
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500643
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600644 if (!originatorId.empty())
645 {
646 asyncResp->res.jsonValue["Originator"] = originatorId;
647 asyncResp->res.jsonValue["OriginatorType"] = originatorType;
648 }
649
Ed Tanous002d39b2022-05-31 08:59:27 -0700650 if (dumpType == "BMC")
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500651 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700652 asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager";
653 asyncResp->res.jsonValue["AdditionalDataURI"] =
Claire Weinanfdd26902022-03-01 14:18:25 -0800654 entriesPath + entryID + "/attachment";
655 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500656 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700657 else if (dumpType == "System")
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500658 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700659 asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM";
660 asyncResp->res.jsonValue["OEMDiagnosticDataType"] = "System";
661 asyncResp->res.jsonValue["AdditionalDataURI"] =
Claire Weinanfdd26902022-03-01 14:18:25 -0800662 entriesPath + entryID + "/attachment";
663 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500664 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700665 }
666 if (!foundDumpEntry)
667 {
Myung Baeb90d14f2023-05-31 14:40:39 -0500668 BMCWEB_LOG_WARNING << "Can't find Dump Entry " << entryID;
669 messages::resourceNotFound(asyncResp->res, dumpType + " dump",
670 entryID);
Ed Tanous002d39b2022-05-31 08:59:27 -0700671 return;
672 }
George Liu5eb468d2023-06-20 17:03:24 +0800673 });
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500674}
675
zhanghch058d1b46d2021-04-01 11:18:24 +0800676inline void deleteDumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Stanley Chu98782562020-11-04 16:10:24 +0800677 const std::string& entryID,
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500678 const std::string& dumpType)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500679{
Ed Tanous002d39b2022-05-31 08:59:27 -0700680 auto respHandler =
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800681 [asyncResp, entryID](const boost::system::error_code& ec) {
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500682 BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done";
683 if (ec)
684 {
George Liu3de8d8b2021-03-22 17:49:39 +0800685 if (ec.value() == EBADR)
686 {
687 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
688 return;
689 }
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500690 BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error "
Claire Weinanfdd26902022-03-01 14:18:25 -0800691 << ec << " entryID=" << entryID;
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500692 messages::internalError(asyncResp->res);
693 return;
694 }
695 };
696 crow::connections::systemBus->async_method_call(
697 respHandler, "xyz.openbmc_project.Dump.Manager",
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500698 "/xyz/openbmc_project/dump/" +
699 std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" +
700 entryID,
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500701 "xyz.openbmc_project.Object.Delete", "Delete");
702}
703
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600704inline DumpCreationProgress
705 mapDbusStatusToDumpProgress(const std::string& status)
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500706{
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600707 if (status ==
708 "xyz.openbmc_project.Common.Progress.OperationStatus.Failed" ||
709 status == "xyz.openbmc_project.Common.Progress.OperationStatus.Aborted")
710 {
711 return DumpCreationProgress::DUMP_CREATE_FAILED;
712 }
713 if (status ==
714 "xyz.openbmc_project.Common.Progress.OperationStatus.Completed")
715 {
716 return DumpCreationProgress::DUMP_CREATE_SUCCESS;
717 }
718 return DumpCreationProgress::DUMP_CREATE_INPROGRESS;
719}
720
721inline DumpCreationProgress
722 getDumpCompletionStatus(const dbus::utility::DBusPropertiesMap& values)
723{
724 for (const auto& [key, val] : values)
725 {
726 if (key == "Status")
Ed Tanous002d39b2022-05-31 08:59:27 -0700727 {
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600728 const std::string* value = std::get_if<std::string>(&val);
729 if (value == nullptr)
730 {
731 BMCWEB_LOG_ERROR << "Status property value is null";
732 return DumpCreationProgress::DUMP_CREATE_FAILED;
733 }
734 return mapDbusStatusToDumpProgress(*value);
735 }
736 }
737 return DumpCreationProgress::DUMP_CREATE_INPROGRESS;
738}
739
740inline std::string getDumpEntryPath(const std::string& dumpPath)
741{
742 if (dumpPath == "/xyz/openbmc_project/dump/bmc/entry")
743 {
744 return "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
745 }
746 if (dumpPath == "/xyz/openbmc_project/dump/system/entry")
747 {
748 return "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
749 }
750 return "";
751}
752
753inline void createDumpTaskCallback(
754 task::Payload&& payload,
755 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
756 const sdbusplus::message::object_path& createdObjPath)
757{
758 const std::string dumpPath = createdObjPath.parent_path().str;
759 const std::string dumpId = createdObjPath.filename();
760
761 std::string dumpEntryPath = getDumpEntryPath(dumpPath);
762
763 if (dumpEntryPath.empty())
764 {
765 BMCWEB_LOG_ERROR << "Invalid dump type received";
766 messages::internalError(asyncResp->res);
767 return;
768 }
769
770 crow::connections::systemBus->async_method_call(
771 [asyncResp, payload, createdObjPath,
772 dumpEntryPath{std::move(dumpEntryPath)},
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800773 dumpId](const boost::system::error_code& ec,
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600774 const std::string& introspectXml) {
775 if (ec)
776 {
777 BMCWEB_LOG_ERROR << "Introspect call failed with error: "
778 << ec.message();
779 messages::internalError(asyncResp->res);
780 return;
Ed Tanous002d39b2022-05-31 08:59:27 -0700781 }
782
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600783 // Check if the created dump object has implemented Progress
784 // interface to track dump completion. If yes, fetch the "Status"
785 // property of the interface, modify the task state accordingly.
786 // Else, return task completed.
787 tinyxml2::XMLDocument doc;
Ed Tanous002d39b2022-05-31 08:59:27 -0700788
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600789 doc.Parse(introspectXml.data(), introspectXml.size());
790 tinyxml2::XMLNode* pRoot = doc.FirstChildElement("node");
791 if (pRoot == nullptr)
Ed Tanous002d39b2022-05-31 08:59:27 -0700792 {
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600793 BMCWEB_LOG_ERROR << "XML document failed to parse";
794 messages::internalError(asyncResp->res);
795 return;
796 }
797 tinyxml2::XMLElement* interfaceNode =
798 pRoot->FirstChildElement("interface");
799
800 bool isProgressIntfPresent = false;
801 while (interfaceNode != nullptr)
802 {
803 const char* thisInterfaceName = interfaceNode->Attribute("name");
804 if (thisInterfaceName != nullptr)
805 {
806 if (thisInterfaceName ==
807 std::string_view("xyz.openbmc_project.Common.Progress"))
808 {
809 interfaceNode =
810 interfaceNode->NextSiblingElement("interface");
811 continue;
812 }
813 isProgressIntfPresent = true;
814 break;
815 }
816 interfaceNode = interfaceNode->NextSiblingElement("interface");
817 }
818
819 std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
820 [createdObjPath, dumpEntryPath, dumpId, isProgressIntfPresent](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800821 const boost::system::error_code& err, sdbusplus::message_t& msg,
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600822 const std::shared_ptr<task::TaskData>& taskData) {
823 if (err)
824 {
825 BMCWEB_LOG_ERROR << createdObjPath.str
826 << ": Error in creating dump";
827 taskData->messages.emplace_back(messages::internalError());
828 taskData->state = "Cancelled";
829 return task::completed;
830 }
831
832 if (isProgressIntfPresent)
833 {
834 dbus::utility::DBusPropertiesMap values;
835 std::string prop;
836 msg.read(prop, values);
837
838 DumpCreationProgress dumpStatus =
839 getDumpCompletionStatus(values);
840 if (dumpStatus == DumpCreationProgress::DUMP_CREATE_FAILED)
841 {
842 BMCWEB_LOG_ERROR << createdObjPath.str
843 << ": Error in creating dump";
844 taskData->state = "Cancelled";
845 return task::completed;
846 }
847
848 if (dumpStatus == DumpCreationProgress::DUMP_CREATE_INPROGRESS)
849 {
850 BMCWEB_LOG_DEBUG << createdObjPath.str
851 << ": Dump creation task is in progress";
852 return !task::completed;
853 }
854 }
855
Ed Tanous002d39b2022-05-31 08:59:27 -0700856 nlohmann::json retMessage = messages::success();
857 taskData->messages.emplace_back(retMessage);
858
Ed Tanousc51a58e2023-03-27 14:43:19 -0700859 boost::urls::url url = boost::urls::format(
860 "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/{}", dumpId);
861
862 std::string headerLoc = "Location: ";
863 headerLoc += url.buffer();
864
Ed Tanous002d39b2022-05-31 08:59:27 -0700865 taskData->payload->httpHeaders.emplace_back(std::move(headerLoc));
866
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600867 BMCWEB_LOG_DEBUG << createdObjPath.str
868 << ": Dump creation task completed";
Ed Tanous002d39b2022-05-31 08:59:27 -0700869 taskData->state = "Completed";
870 return task::completed;
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600871 },
872 "type='signal',interface='org.freedesktop.DBus.Properties',"
873 "member='PropertiesChanged',path='" +
874 createdObjPath.str + "'");
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500875
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600876 // The task timer is set to max time limit within which the
877 // requested dump will be collected.
878 task->startTimer(std::chrono::minutes(6));
879 task->populateResp(asyncResp->res);
880 task->payload.emplace(payload);
881 },
882 "xyz.openbmc_project.Dump.Manager", createdObjPath,
883 "org.freedesktop.DBus.Introspectable", "Introspect");
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500884}
885
zhanghch058d1b46d2021-04-01 11:18:24 +0800886inline void createDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
887 const crow::Request& req, const std::string& dumpType)
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500888{
Claire Weinanfdd26902022-03-01 14:18:25 -0800889 std::string dumpPath = getDumpEntriesPath(dumpType);
890 if (dumpPath.empty())
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500891 {
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500892 messages::internalError(asyncResp->res);
893 return;
894 }
895
896 std::optional<std::string> diagnosticDataType;
897 std::optional<std::string> oemDiagnosticDataType;
898
Willy Tu15ed6782021-12-14 11:03:16 -0800899 if (!redfish::json_util::readJsonAction(
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500900 req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
901 "OEMDiagnosticDataType", oemDiagnosticDataType))
902 {
903 return;
904 }
905
906 if (dumpType == "System")
907 {
908 if (!oemDiagnosticDataType || !diagnosticDataType)
909 {
Jason M. Bills4978b632022-02-22 14:17:43 -0800910 BMCWEB_LOG_ERROR
911 << "CreateDump action parameter 'DiagnosticDataType'/'OEMDiagnosticDataType' value not found!";
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500912 messages::actionParameterMissing(
913 asyncResp->res, "CollectDiagnosticData",
914 "DiagnosticDataType & OEMDiagnosticDataType");
915 return;
916 }
Ed Tanous3174e4d2020-10-07 11:41:22 -0700917 if ((*oemDiagnosticDataType != "System") ||
918 (*diagnosticDataType != "OEM"))
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500919 {
920 BMCWEB_LOG_ERROR << "Wrong parameter values passed";
Ed Tanousace85d62021-10-26 12:45:59 -0700921 messages::internalError(asyncResp->res);
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500922 return;
923 }
Asmitha Karunanithi59075712021-10-22 01:17:41 -0500924 dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/";
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500925 }
926 else if (dumpType == "BMC")
927 {
928 if (!diagnosticDataType)
929 {
George Liu0fda0f12021-11-16 10:06:17 +0800930 BMCWEB_LOG_ERROR
931 << "CreateDump action parameter 'DiagnosticDataType' not found!";
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500932 messages::actionParameterMissing(
933 asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType");
934 return;
935 }
Ed Tanous3174e4d2020-10-07 11:41:22 -0700936 if (*diagnosticDataType != "Manager")
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500937 {
938 BMCWEB_LOG_ERROR
939 << "Wrong parameter value passed for 'DiagnosticDataType'";
Ed Tanousace85d62021-10-26 12:45:59 -0700940 messages::internalError(asyncResp->res);
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500941 return;
942 }
Asmitha Karunanithi59075712021-10-22 01:17:41 -0500943 dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/";
944 }
945 else
946 {
947 BMCWEB_LOG_ERROR << "CreateDump failed. Unknown dump type";
948 messages::internalError(asyncResp->res);
949 return;
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500950 }
951
Asmitha Karunanithi8e317782020-12-10 03:35:05 -0600952 std::vector<std::pair<std::string, std::variant<std::string, uint64_t>>>
953 createDumpParamVec;
954
Carson Labradof574a8e2023-03-22 02:26:00 +0000955 if (req.session != nullptr)
956 {
957 createDumpParamVec.emplace_back(
958 "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorId",
959 req.session->clientIp);
960 createDumpParamVec.emplace_back(
961 "xyz.openbmc_project.Dump.Create.CreateParameters.OriginatorType",
962 "xyz.openbmc_project.Common.OriginatedBy.OriginatorTypes.Client");
963 }
Asmitha Karunanithi68dd0752022-11-15 11:33:46 -0600964
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500965 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800966 [asyncResp, payload(task::Payload(req)),
967 dumpPath](const boost::system::error_code& ec,
968 const sdbusplus::message_t& msg,
969 const sdbusplus::message::object_path& objPath) mutable {
Ed Tanous002d39b2022-05-31 08:59:27 -0700970 if (ec)
971 {
972 BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec;
Asmitha Karunanithi59075712021-10-22 01:17:41 -0500973 const sd_bus_error* dbusError = msg.get_error();
974 if (dbusError == nullptr)
975 {
976 messages::internalError(asyncResp->res);
977 return;
978 }
979
980 BMCWEB_LOG_ERROR << "CreateDump DBus error: " << dbusError->name
981 << " and error msg: " << dbusError->message;
982 if (std::string_view(
983 "xyz.openbmc_project.Common.Error.NotAllowed") ==
984 dbusError->name)
985 {
986 messages::resourceInStandby(asyncResp->res);
987 return;
988 }
989 if (std::string_view(
990 "xyz.openbmc_project.Dump.Create.Error.Disabled") ==
991 dbusError->name)
992 {
993 messages::serviceDisabled(asyncResp->res, dumpPath);
994 return;
995 }
996 if (std::string_view(
997 "xyz.openbmc_project.Common.Error.Unavailable") ==
998 dbusError->name)
999 {
1000 messages::resourceInUse(asyncResp->res);
1001 return;
1002 }
1003 // Other Dbus errors such as:
1004 // xyz.openbmc_project.Common.Error.InvalidArgument &
1005 // org.freedesktop.DBus.Error.InvalidArgs are all related to
1006 // the dbus call that is made here in the bmcweb
1007 // implementation and has nothing to do with the client's
1008 // input in the request. Hence, returning internal error
1009 // back to the client.
Ed Tanous002d39b2022-05-31 08:59:27 -07001010 messages::internalError(asyncResp->res);
1011 return;
1012 }
Asmitha Karunanithi8e317782020-12-10 03:35:05 -06001013 BMCWEB_LOG_DEBUG << "Dump Created. Path: " << objPath.str;
1014 createDumpTaskCallback(std::move(payload), asyncResp, objPath);
Asmitha Karunanithia43be802020-05-07 05:05:36 -05001015 },
Asmitha Karunanithib47452b2020-09-25 02:02:19 -05001016 "xyz.openbmc_project.Dump.Manager",
1017 "/xyz/openbmc_project/dump/" +
1018 std::string(boost::algorithm::to_lower_copy(dumpType)),
Asmitha Karunanithi8e317782020-12-10 03:35:05 -06001019 "xyz.openbmc_project.Dump.Create", "CreateDump", createDumpParamVec);
Asmitha Karunanithia43be802020-05-07 05:05:36 -05001020}
1021
zhanghch058d1b46d2021-04-01 11:18:24 +08001022inline void clearDump(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1023 const std::string& dumpType)
Asmitha Karunanithi80319af2020-05-07 05:30:21 -05001024{
Asmitha Karunanithib47452b2020-09-25 02:02:19 -05001025 std::string dumpTypeLowerCopy =
1026 std::string(boost::algorithm::to_lower_copy(dumpType));
zhanghch058d1b46d2021-04-01 11:18:24 +08001027
Claire Weinan0d946212022-07-13 19:40:19 -07001028 crow::connections::systemBus->async_method_call(
1029 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001030 if (ec)
1031 {
Claire Weinan0d946212022-07-13 19:40:19 -07001032 BMCWEB_LOG_ERROR << "clearDump resp_handler got error " << ec;
Ed Tanous002d39b2022-05-31 08:59:27 -07001033 messages::internalError(asyncResp->res);
1034 return;
1035 }
Claire Weinan0d946212022-07-13 19:40:19 -07001036 },
1037 "xyz.openbmc_project.Dump.Manager",
1038 "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy,
1039 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
Asmitha Karunanithi80319af2020-05-07 05:30:21 -05001040}
1041
Ed Tanousb9d36b42022-02-26 21:42:46 -08001042inline static void
1043 parseCrashdumpParameters(const dbus::utility::DBusPropertiesMap& params,
1044 std::string& filename, std::string& timestamp,
1045 std::string& logfile)
Johnathan Mantey043a0532020-03-10 17:15:28 -07001046{
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001047 const std::string* filenamePtr = nullptr;
1048 const std::string* timestampPtr = nullptr;
1049 const std::string* logfilePtr = nullptr;
1050
1051 const bool success = sdbusplus::unpackPropertiesNoThrow(
1052 dbus_utils::UnpackErrorPrinter(), params, "Timestamp", timestampPtr,
1053 "Filename", filenamePtr, "Log", logfilePtr);
1054
1055 if (!success)
Johnathan Mantey043a0532020-03-10 17:15:28 -07001056 {
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001057 return;
1058 }
1059
1060 if (filenamePtr != nullptr)
1061 {
1062 filename = *filenamePtr;
1063 }
1064
1065 if (timestampPtr != nullptr)
1066 {
1067 timestamp = *timestampPtr;
1068 }
1069
1070 if (logfilePtr != nullptr)
1071 {
1072 logfile = *logfilePtr;
Johnathan Mantey043a0532020-03-10 17:15:28 -07001073 }
1074}
1075
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001076inline void requestRoutesSystemLogServiceCollection(App& app)
Ed Tanous1da66f72018-07-27 16:13:37 -07001077{
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001078 /**
1079 * Functions triggers appropriate requests on DBus
1080 */
Ed Tanous22d268c2022-05-19 09:39:07 -07001081 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/")
Ed Tanoused398212021-06-09 17:05:54 -07001082 .privileges(redfish::privileges::getLogServiceCollection)
Ed Tanous002d39b2022-05-31 08:59:27 -07001083 .methods(boost::beast::http::verb::get)(
1084 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07001085 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1086 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001087 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001088 {
1089 return;
1090 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001091 if (systemName != "system")
1092 {
1093 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1094 systemName);
1095 return;
1096 }
1097
Ed Tanous002d39b2022-05-31 08:59:27 -07001098 // Collections don't include the static data added by SubRoute
1099 // because it has a duplicate entry for members
1100 asyncResp->res.jsonValue["@odata.type"] =
1101 "#LogServiceCollection.LogServiceCollection";
1102 asyncResp->res.jsonValue["@odata.id"] =
1103 "/redfish/v1/Systems/system/LogServices";
1104 asyncResp->res.jsonValue["Name"] = "System Log Services Collection";
1105 asyncResp->res.jsonValue["Description"] =
1106 "Collection of LogServices for this Computer System";
1107 nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
1108 logServiceArray = nlohmann::json::array();
1109 nlohmann::json::object_t eventLog;
1110 eventLog["@odata.id"] =
1111 "/redfish/v1/Systems/system/LogServices/EventLog";
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001112 logServiceArray.emplace_back(std::move(eventLog));
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05001113#ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
Ed Tanous002d39b2022-05-31 08:59:27 -07001114 nlohmann::json::object_t dumpLog;
1115 dumpLog["@odata.id"] = "/redfish/v1/Systems/system/LogServices/Dump";
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001116 logServiceArray.emplace_back(std::move(dumpLog));
raviteja-bc9bb6862020-02-03 11:53:32 -06001117#endif
1118
Jason M. Billsd53dd412019-02-12 17:16:22 -08001119#ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
Ed Tanous002d39b2022-05-31 08:59:27 -07001120 nlohmann::json::object_t crashdump;
1121 crashdump["@odata.id"] =
1122 "/redfish/v1/Systems/system/LogServices/Crashdump";
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001123 logServiceArray.emplace_back(std::move(crashdump));
Jason M. Billsd53dd412019-02-12 17:16:22 -08001124#endif
Spencer Kub7028eb2021-10-26 15:27:35 +08001125
1126#ifdef BMCWEB_ENABLE_REDFISH_HOST_LOGGER
Ed Tanous002d39b2022-05-31 08:59:27 -07001127 nlohmann::json::object_t hostlogger;
1128 hostlogger["@odata.id"] =
1129 "/redfish/v1/Systems/system/LogServices/HostLogger";
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001130 logServiceArray.emplace_back(std::move(hostlogger));
Spencer Kub7028eb2021-10-26 15:27:35 +08001131#endif
Ed Tanous002d39b2022-05-31 08:59:27 -07001132 asyncResp->res.jsonValue["Members@odata.count"] =
1133 logServiceArray.size();
ZhikuiRena3316fc2020-01-29 14:58:08 -08001134
George Liu7a1dbc42022-12-07 16:03:22 +08001135 constexpr std::array<std::string_view, 1> interfaces = {
1136 "xyz.openbmc_project.State.Boot.PostCode"};
1137 dbus::utility::getSubTreePaths(
1138 "/", 0, interfaces,
1139 [asyncResp](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07001140 const dbus::utility::MapperGetSubTreePathsResponse&
1141 subtreePath) {
1142 if (ec)
1143 {
1144 BMCWEB_LOG_ERROR << ec;
1145 return;
1146 }
Ed Tanous45ca1b82022-03-25 13:07:27 -07001147
Ed Tanous002d39b2022-05-31 08:59:27 -07001148 for (const auto& pathStr : subtreePath)
1149 {
1150 if (pathStr.find("PostCode") != std::string::npos)
1151 {
1152 nlohmann::json& logServiceArrayLocal =
1153 asyncResp->res.jsonValue["Members"];
Ed Tanous613dabe2022-07-09 11:17:36 -07001154 nlohmann::json::object_t member;
1155 member["@odata.id"] =
1156 "/redfish/v1/Systems/system/LogServices/PostCodes";
1157
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001158 logServiceArrayLocal.emplace_back(std::move(member));
Ed Tanous613dabe2022-07-09 11:17:36 -07001159
Ed Tanous002d39b2022-05-31 08:59:27 -07001160 asyncResp->res.jsonValue["Members@odata.count"] =
1161 logServiceArrayLocal.size();
1162 return;
1163 }
1164 }
George Liu7a1dbc42022-12-07 16:03:22 +08001165 });
Ed Tanous45ca1b82022-03-25 13:07:27 -07001166 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001167}
1168
1169inline void requestRoutesEventLogService(App& app)
1170{
Ed Tanous22d268c2022-05-19 09:39:07 -07001171 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/")
Ed Tanoused398212021-06-09 17:05:54 -07001172 .privileges(redfish::privileges::getLogService)
Ed Tanous002d39b2022-05-31 08:59:27 -07001173 .methods(boost::beast::http::verb::get)(
1174 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07001175 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1176 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001177 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001178 {
1179 return;
1180 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001181 if (systemName != "system")
1182 {
1183 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1184 systemName);
1185 return;
1186 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001187 asyncResp->res.jsonValue["@odata.id"] =
1188 "/redfish/v1/Systems/system/LogServices/EventLog";
1189 asyncResp->res.jsonValue["@odata.type"] =
1190 "#LogService.v1_1_0.LogService";
1191 asyncResp->res.jsonValue["Name"] = "Event Log Service";
1192 asyncResp->res.jsonValue["Description"] = "System Event Log Service";
1193 asyncResp->res.jsonValue["Id"] = "EventLog";
1194 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
Tejas Patil7c8c4052021-06-04 17:43:14 +05301195
Ed Tanous002d39b2022-05-31 08:59:27 -07001196 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07001197 redfish::time_utils::getDateTimeOffsetNow();
Tejas Patil7c8c4052021-06-04 17:43:14 +05301198
Ed Tanous002d39b2022-05-31 08:59:27 -07001199 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
1200 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
1201 redfishDateTimeOffset.second;
Tejas Patil7c8c4052021-06-04 17:43:14 +05301202
Ed Tanous002d39b2022-05-31 08:59:27 -07001203 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
1204 "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1205 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001206
Ed Tanous002d39b2022-05-31 08:59:27 -07001207 {"target",
1208 "/redfish/v1/Systems/system/LogServices/EventLog/Actions/LogService.ClearLog"}};
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001209 });
1210}
1211
1212inline void requestRoutesJournalEventLogClear(App& app)
1213{
Jason M. Bills4978b632022-02-22 14:17:43 -08001214 BMCWEB_ROUTE(
1215 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07001216 "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/")
Ed Tanous432a8902021-06-14 15:28:56 -07001217 .privileges({{"ConfigureComponents"}})
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001218 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07001219 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07001220 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1221 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001222 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001223 {
1224 return;
1225 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001226 if (systemName != "system")
1227 {
1228 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1229 systemName);
1230 return;
1231 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001232 // Clear the EventLog by deleting the log files
1233 std::vector<std::filesystem::path> redfishLogFiles;
1234 if (getRedfishLogFiles(redfishLogFiles))
1235 {
1236 for (const std::filesystem::path& file : redfishLogFiles)
1237 {
1238 std::error_code ec;
1239 std::filesystem::remove(file, ec);
1240 }
1241 }
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001242
Ed Tanous002d39b2022-05-31 08:59:27 -07001243 // Reload rsyslog so it knows to start new log files
1244 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001245 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001246 if (ec)
1247 {
1248 BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec;
1249 messages::internalError(asyncResp->res);
1250 return;
1251 }
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001252
Ed Tanous002d39b2022-05-31 08:59:27 -07001253 messages::success(asyncResp->res);
1254 },
1255 "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
1256 "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service",
1257 "replace");
1258 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001259}
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001260
Jason M. Billsac992cd2022-06-24 13:31:46 -07001261enum class LogParseError
1262{
1263 success,
1264 parseFailed,
1265 messageIdNotInRegistry,
1266};
1267
1268static LogParseError
1269 fillEventLogEntryJson(const std::string& logEntryID,
1270 const std::string& logEntry,
1271 nlohmann::json::object_t& logEntryJson)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001272{
Jason M. Bills95820182019-04-22 16:25:34 -07001273 // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
Jason M. Billscd225da2019-05-08 15:31:57 -07001274 // First get the Timestamp
Ed Tanousf23b7292020-10-15 09:41:17 -07001275 size_t space = logEntry.find_first_of(' ');
Jason M. Billscd225da2019-05-08 15:31:57 -07001276 if (space == std::string::npos)
Jason M. Bills95820182019-04-22 16:25:34 -07001277 {
Jason M. Billsac992cd2022-06-24 13:31:46 -07001278 return LogParseError::parseFailed;
Jason M. Bills95820182019-04-22 16:25:34 -07001279 }
Jason M. Billscd225da2019-05-08 15:31:57 -07001280 std::string timestamp = logEntry.substr(0, space);
1281 // Then get the log contents
Ed Tanousf23b7292020-10-15 09:41:17 -07001282 size_t entryStart = logEntry.find_first_not_of(' ', space);
Jason M. Billscd225da2019-05-08 15:31:57 -07001283 if (entryStart == std::string::npos)
1284 {
Jason M. Billsac992cd2022-06-24 13:31:46 -07001285 return LogParseError::parseFailed;
Jason M. Billscd225da2019-05-08 15:31:57 -07001286 }
1287 std::string_view entry(logEntry);
1288 entry.remove_prefix(entryStart);
1289 // Use split to separate the entry into its fields
1290 std::vector<std::string> logEntryFields;
Ed Tanous50ebd4a2023-01-19 19:03:17 -08001291 bmcweb::split(logEntryFields, entry, ',');
Jason M. Billscd225da2019-05-08 15:31:57 -07001292 // We need at least a MessageId to be valid
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001293 auto logEntryIter = logEntryFields.begin();
1294 if (logEntryIter == logEntryFields.end())
Jason M. Billscd225da2019-05-08 15:31:57 -07001295 {
Jason M. Billsac992cd2022-06-24 13:31:46 -07001296 return LogParseError::parseFailed;
Jason M. Billscd225da2019-05-08 15:31:57 -07001297 }
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001298 std::string& messageID = *logEntryIter;
Jason M. Bills4851d452019-03-28 11:27:48 -07001299 // Get the Message from the MessageRegistry
Ed Tanousfffb8c12022-02-07 23:53:03 -08001300 const registries::Message* message = registries::getMessage(messageID);
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001301
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001302 logEntryIter++;
Sui Chen54417b02022-03-24 14:59:52 -07001303 if (message == nullptr)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001304 {
Sui Chen54417b02022-03-24 14:59:52 -07001305 BMCWEB_LOG_WARNING << "Log entry not found in registry: " << logEntry;
Jason M. Billsac992cd2022-06-24 13:31:46 -07001306 return LogParseError::messageIdNotInRegistry;
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001307 }
1308
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001309 std::vector<std::string_view> messageArgs(logEntryIter,
1310 logEntryFields.end());
1311 std::string msg = redfish::registries::fillMessageArgs(messageArgs,
1312 message->message);
1313 if (msg.empty())
Jason M. Bills4851d452019-03-28 11:27:48 -07001314 {
Ed Tanous1e6deaf2022-02-17 11:32:37 -08001315 return LogParseError::parseFailed;
Jason M. Bills4851d452019-03-28 11:27:48 -07001316 }
1317
Jason M. Bills95820182019-04-22 16:25:34 -07001318 // Get the Created time from the timestamp. The log timestamp is in RFC3339
1319 // format which matches the Redfish format except for the fractional seconds
1320 // between the '.' and the '+', so just remove them.
Ed Tanousf23b7292020-10-15 09:41:17 -07001321 std::size_t dot = timestamp.find_first_of('.');
1322 std::size_t plus = timestamp.find_first_of('+');
Jason M. Bills95820182019-04-22 16:25:34 -07001323 if (dot != std::string::npos && plus != std::string::npos)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001324 {
Jason M. Bills95820182019-04-22 16:25:34 -07001325 timestamp.erase(dot, plus - dot);
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001326 }
1327
1328 // Fill in the log entry with the gathered data
Vijay Lobo9c11a172021-10-07 16:53:16 -05001329 logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07001330 logEntryJson["@odata.id"] = boost::urls::format(
1331 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}",
1332 logEntryID);
Jason M. Bills84afc482022-06-24 12:38:23 -07001333 logEntryJson["Name"] = "System Event Log Entry";
1334 logEntryJson["Id"] = logEntryID;
1335 logEntryJson["Message"] = std::move(msg);
1336 logEntryJson["MessageId"] = std::move(messageID);
1337 logEntryJson["MessageArgs"] = messageArgs;
1338 logEntryJson["EntryType"] = "Event";
1339 logEntryJson["Severity"] = message->messageSeverity;
1340 logEntryJson["Created"] = std::move(timestamp);
Jason M. Billsac992cd2022-06-24 13:31:46 -07001341 return LogParseError::success;
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001342}
1343
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001344inline void requestRoutesJournalEventLogEntryCollection(App& app)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001345{
Ed Tanous22d268c2022-05-19 09:39:07 -07001346 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/")
Gunnar Mills8b6a35f2021-07-30 14:52:53 -05001347 .privileges(redfish::privileges::getLogEntryCollection)
Ed Tanous002d39b2022-05-31 08:59:27 -07001348 .methods(boost::beast::http::verb::get)(
1349 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07001350 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1351 const std::string& systemName) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001352 query_param::QueryCapabilities capabilities = {
1353 .canDelegateTop = true,
1354 .canDelegateSkip = true,
1355 };
1356 query_param::Query delegatedQuery;
1357 if (!redfish::setUpRedfishRouteWithDelegation(
Carson Labrado3ba00072022-06-06 19:40:56 +00001358 app, req, asyncResp, delegatedQuery, capabilities))
Ed Tanous002d39b2022-05-31 08:59:27 -07001359 {
1360 return;
1361 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001362 if (systemName != "system")
1363 {
1364 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1365 systemName);
1366 return;
1367 }
1368
Jiaqing Zhao5143f7a2022-07-22 09:33:33 +08001369 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
Ed Tanous3648c8b2022-07-25 13:39:59 -07001370 size_t skip = delegatedQuery.skip.value_or(0);
1371
Ed Tanous002d39b2022-05-31 08:59:27 -07001372 // Collections don't include the static data added by SubRoute
1373 // because it has a duplicate entry for members
1374 asyncResp->res.jsonValue["@odata.type"] =
1375 "#LogEntryCollection.LogEntryCollection";
1376 asyncResp->res.jsonValue["@odata.id"] =
1377 "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1378 asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1379 asyncResp->res.jsonValue["Description"] =
1380 "Collection of System Event Log Entries";
1381
1382 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
1383 logEntryArray = nlohmann::json::array();
1384 // Go through the log files and create a unique ID for each
1385 // entry
1386 std::vector<std::filesystem::path> redfishLogFiles;
1387 getRedfishLogFiles(redfishLogFiles);
1388 uint64_t entryCount = 0;
1389 std::string logEntry;
1390
1391 // Oldest logs are in the last file, so start there and loop
1392 // backwards
1393 for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1394 it++)
1395 {
1396 std::ifstream logStream(*it);
1397 if (!logStream.is_open())
Jason M. Bills4978b632022-02-22 14:17:43 -08001398 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001399 continue;
Jason M. Bills4978b632022-02-22 14:17:43 -08001400 }
Jason M. Bills897967d2019-07-29 17:05:30 -07001401
Ed Tanous002d39b2022-05-31 08:59:27 -07001402 // Reset the unique ID on the first entry
1403 bool firstEntry = true;
1404 while (std::getline(logStream, logEntry))
Jason M. Bills4978b632022-02-22 14:17:43 -08001405 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001406 std::string idStr;
1407 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
Jason M. Bills4978b632022-02-22 14:17:43 -08001408 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001409 continue;
1410 }
Jason M. Billsefde4ec2022-06-24 08:59:52 -07001411 firstEntry = false;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001412
Jason M. Billsde703c52022-06-23 14:19:04 -07001413 nlohmann::json::object_t bmcLogEntry;
Patrick Williams89492a12023-05-10 07:51:34 -05001414 LogParseError status = fillEventLogEntryJson(idStr, logEntry,
1415 bmcLogEntry);
Jason M. Billsac992cd2022-06-24 13:31:46 -07001416 if (status == LogParseError::messageIdNotInRegistry)
1417 {
1418 continue;
1419 }
1420 if (status != LogParseError::success)
Ed Tanous002d39b2022-05-31 08:59:27 -07001421 {
1422 messages::internalError(asyncResp->res);
1423 return;
Andrew Geisslercb92c032018-08-17 07:56:14 -07001424 }
Jason M. Billsde703c52022-06-23 14:19:04 -07001425
Jason M. Billsde703c52022-06-23 14:19:04 -07001426 entryCount++;
1427 // Handle paging using skip (number of entries to skip from the
1428 // start) and top (number of entries to display)
Ed Tanous3648c8b2022-07-25 13:39:59 -07001429 if (entryCount <= skip || entryCount > skip + top)
Jason M. Billsde703c52022-06-23 14:19:04 -07001430 {
1431 continue;
1432 }
1433
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001434 logEntryArray.emplace_back(std::move(bmcLogEntry));
Jason M. Bills4978b632022-02-22 14:17:43 -08001435 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001436 }
1437 asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
Ed Tanous3648c8b2022-07-25 13:39:59 -07001438 if (skip + top < entryCount)
Ed Tanous002d39b2022-05-31 08:59:27 -07001439 {
1440 asyncResp->res.jsonValue["Members@odata.nextLink"] =
1441 "/redfish/v1/Systems/system/LogServices/EventLog/Entries?$skip=" +
Ed Tanous3648c8b2022-07-25 13:39:59 -07001442 std::to_string(skip + top);
Ed Tanous002d39b2022-05-31 08:59:27 -07001443 }
Jason M. Bills4978b632022-02-22 14:17:43 -08001444 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001445}
Chicago Duan336e96c2019-07-15 14:22:08 +08001446
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001447inline void requestRoutesJournalEventLogEntry(App& app)
1448{
1449 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001450 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001451 .privileges(redfish::privileges::getLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001452 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07001453 [&app](const crow::Request& req,
1454 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07001455 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001456 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001457 {
1458 return;
1459 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001460
1461 if (systemName != "system")
1462 {
1463 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1464 systemName);
1465 return;
1466 }
1467
Ed Tanous002d39b2022-05-31 08:59:27 -07001468 const std::string& targetID = param;
1469
1470 // Go through the log files and check the unique ID for each
1471 // entry to find the target entry
1472 std::vector<std::filesystem::path> redfishLogFiles;
1473 getRedfishLogFiles(redfishLogFiles);
1474 std::string logEntry;
1475
1476 // Oldest logs are in the last file, so start there and loop
1477 // backwards
1478 for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1479 it++)
1480 {
1481 std::ifstream logStream(*it);
1482 if (!logStream.is_open())
1483 {
1484 continue;
1485 }
1486
1487 // Reset the unique ID on the first entry
1488 bool firstEntry = true;
1489 while (std::getline(logStream, logEntry))
1490 {
1491 std::string idStr;
1492 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
Ed Tanous45ca1b82022-03-25 13:07:27 -07001493 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001494 continue;
1495 }
Jason M. Billsefde4ec2022-06-24 08:59:52 -07001496 firstEntry = false;
Ed Tanous002d39b2022-05-31 08:59:27 -07001497
1498 if (idStr == targetID)
1499 {
Jason M. Billsde703c52022-06-23 14:19:04 -07001500 nlohmann::json::object_t bmcLogEntry;
Jason M. Billsac992cd2022-06-24 13:31:46 -07001501 LogParseError status =
1502 fillEventLogEntryJson(idStr, logEntry, bmcLogEntry);
1503 if (status != LogParseError::success)
Ed Tanous002d39b2022-05-31 08:59:27 -07001504 {
1505 messages::internalError(asyncResp->res);
1506 return;
1507 }
Jason M. Billsd405bb52022-06-24 10:52:05 -07001508 asyncResp->res.jsonValue.update(bmcLogEntry);
Ed Tanous45ca1b82022-03-25 13:07:27 -07001509 return;
1510 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001511 }
1512 }
1513 // Requested ID was not found
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08001514 messages::resourceNotFound(asyncResp->res, "LogEntry", targetID);
Ed Tanous002d39b2022-05-31 08:59:27 -07001515 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001516}
1517
1518inline void requestRoutesDBusEventLogEntryCollection(App& app)
1519{
Ed Tanous22d268c2022-05-19 09:39:07 -07001520 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07001521 .privileges(redfish::privileges::getLogEntryCollection)
Ed Tanous002d39b2022-05-31 08:59:27 -07001522 .methods(boost::beast::http::verb::get)(
1523 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07001524 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1525 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001526 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001527 {
1528 return;
1529 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001530 if (systemName != "system")
1531 {
1532 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1533 systemName);
1534 return;
1535 }
1536
Ed Tanous002d39b2022-05-31 08:59:27 -07001537 // Collections don't include the static data added by SubRoute
1538 // because it has a duplicate entry for members
1539 asyncResp->res.jsonValue["@odata.type"] =
1540 "#LogEntryCollection.LogEntryCollection";
1541 asyncResp->res.jsonValue["@odata.id"] =
1542 "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1543 asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1544 asyncResp->res.jsonValue["Description"] =
1545 "Collection of System Event Log Entries";
1546
1547 // DBus implementation of EventLog/Entries
1548 // Make call to Logging Service to find all log entry objects
George Liu5eb468d2023-06-20 17:03:24 +08001549 sdbusplus::message::object_path path("/xyz/openbmc_project/logging");
1550 dbus::utility::getManagedObjects(
1551 "xyz.openbmc_project.Logging", path,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001552 [asyncResp](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07001553 const dbus::utility::ManagedObjectType& resp) {
1554 if (ec)
Ed Tanous45ca1b82022-03-25 13:07:27 -07001555 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001556 // TODO Handle for specific error code
1557 BMCWEB_LOG_ERROR
1558 << "getLogEntriesIfaceData resp_handler got error " << ec;
1559 messages::internalError(asyncResp->res);
Ed Tanous45ca1b82022-03-25 13:07:27 -07001560 return;
1561 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001562 nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
1563 entriesArray = nlohmann::json::array();
1564 for (const auto& objectPath : resp)
1565 {
1566 const uint32_t* id = nullptr;
1567 const uint64_t* timestamp = nullptr;
1568 const uint64_t* updateTimestamp = nullptr;
1569 const std::string* severity = nullptr;
1570 const std::string* message = nullptr;
1571 const std::string* filePath = nullptr;
Vijay Lobo9c11a172021-10-07 16:53:16 -05001572 const std::string* resolution = nullptr;
Ed Tanous002d39b2022-05-31 08:59:27 -07001573 bool resolved = false;
Abhishek Patel9017faf2021-09-14 22:48:55 -05001574 const std::string* notify = nullptr;
1575
Ed Tanous002d39b2022-05-31 08:59:27 -07001576 for (const auto& interfaceMap : objectPath.second)
1577 {
1578 if (interfaceMap.first ==
1579 "xyz.openbmc_project.Logging.Entry")
Xiaochao Ma75710de2021-01-21 17:56:02 +08001580 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001581 for (const auto& propertyMap : interfaceMap.second)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001582 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001583 if (propertyMap.first == "Id")
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001584 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001585 id = std::get_if<uint32_t>(&propertyMap.second);
1586 }
1587 else if (propertyMap.first == "Timestamp")
1588 {
1589 timestamp =
1590 std::get_if<uint64_t>(&propertyMap.second);
1591 }
1592 else if (propertyMap.first == "UpdateTimestamp")
1593 {
1594 updateTimestamp =
1595 std::get_if<uint64_t>(&propertyMap.second);
1596 }
1597 else if (propertyMap.first == "Severity")
1598 {
1599 severity = std::get_if<std::string>(
1600 &propertyMap.second);
1601 }
Vijay Lobo9c11a172021-10-07 16:53:16 -05001602 else if (propertyMap.first == "Resolution")
1603 {
1604 resolution = std::get_if<std::string>(
1605 &propertyMap.second);
1606 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001607 else if (propertyMap.first == "Message")
1608 {
1609 message = std::get_if<std::string>(
1610 &propertyMap.second);
1611 }
1612 else if (propertyMap.first == "Resolved")
1613 {
1614 const bool* resolveptr =
1615 std::get_if<bool>(&propertyMap.second);
1616 if (resolveptr == nullptr)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001617 {
1618 messages::internalError(asyncResp->res);
1619 return;
1620 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001621 resolved = *resolveptr;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001622 }
Abhishek Patel9017faf2021-09-14 22:48:55 -05001623 else if (propertyMap.first ==
1624 "ServiceProviderNotify")
1625 {
1626 notify = std::get_if<std::string>(
1627 &propertyMap.second);
1628 if (notify == nullptr)
1629 {
1630 messages::internalError(asyncResp->res);
1631 return;
1632 }
1633 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001634 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001635 if (id == nullptr || message == nullptr ||
Ed Tanous002d39b2022-05-31 08:59:27 -07001636 severity == nullptr)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001637 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001638 messages::internalError(asyncResp->res);
1639 return;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001640 }
1641 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001642 else if (interfaceMap.first ==
1643 "xyz.openbmc_project.Common.FilePath")
1644 {
1645 for (const auto& propertyMap : interfaceMap.second)
1646 {
1647 if (propertyMap.first == "Path")
1648 {
1649 filePath = std::get_if<std::string>(
1650 &propertyMap.second);
1651 }
1652 }
1653 }
1654 }
1655 // Object path without the
1656 // xyz.openbmc_project.Logging.Entry interface, ignore
1657 // and continue.
1658 if (id == nullptr || message == nullptr ||
1659 severity == nullptr || timestamp == nullptr ||
1660 updateTimestamp == nullptr)
1661 {
1662 continue;
1663 }
1664 entriesArray.push_back({});
1665 nlohmann::json& thisEntry = entriesArray.back();
Vijay Lobo9c11a172021-10-07 16:53:16 -05001666 thisEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07001667 thisEntry["@odata.id"] = boost::urls::format(
1668 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}",
1669 std::to_string(*id));
Ed Tanous002d39b2022-05-31 08:59:27 -07001670 thisEntry["Name"] = "System Event Log Entry";
1671 thisEntry["Id"] = std::to_string(*id);
1672 thisEntry["Message"] = *message;
1673 thisEntry["Resolved"] = resolved;
Vijay Lobo9c11a172021-10-07 16:53:16 -05001674 if ((resolution != nullptr) && (!(*resolution).empty()))
1675 {
1676 thisEntry["Resolution"] = *resolution;
1677 }
Abhishek Patel9017faf2021-09-14 22:48:55 -05001678 std::optional<bool> notifyAction =
1679 getProviderNotifyAction(*notify);
1680 if (notifyAction)
1681 {
1682 thisEntry["ServiceProviderNotified"] = *notifyAction;
1683 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001684 thisEntry["EntryType"] = "Event";
1685 thisEntry["Severity"] =
1686 translateSeverityDbusToRedfish(*severity);
1687 thisEntry["Created"] =
Ed Tanous2b829372022-08-03 14:22:34 -07001688 redfish::time_utils::getDateTimeUintMs(*timestamp);
Ed Tanous002d39b2022-05-31 08:59:27 -07001689 thisEntry["Modified"] =
Ed Tanous2b829372022-08-03 14:22:34 -07001690 redfish::time_utils::getDateTimeUintMs(*updateTimestamp);
Ed Tanous002d39b2022-05-31 08:59:27 -07001691 if (filePath != nullptr)
1692 {
1693 thisEntry["AdditionalDataURI"] =
1694 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
1695 std::to_string(*id) + "/attachment";
1696 }
1697 }
1698 std::sort(
1699 entriesArray.begin(), entriesArray.end(),
1700 [](const nlohmann::json& left, const nlohmann::json& right) {
1701 return (left["Id"] <= right["Id"]);
1702 });
1703 asyncResp->res.jsonValue["Members@odata.count"] =
1704 entriesArray.size();
George Liu5eb468d2023-06-20 17:03:24 +08001705 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001706 });
1707}
Xiaochao Ma75710de2021-01-21 17:56:02 +08001708
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001709inline void requestRoutesDBusEventLogEntry(App& app)
Adriana Kobylak400fd1f2021-01-29 09:01:30 -06001710{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001711 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001712 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001713 .privileges(redfish::privileges::getLogEntry)
Ed Tanous002d39b2022-05-31 08:59:27 -07001714 .methods(boost::beast::http::verb::get)(
1715 [&app](const crow::Request& req,
1716 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07001717 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001718 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001719 {
1720 return;
1721 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001722 if (systemName != "system")
1723 {
1724 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1725 systemName);
1726 return;
1727 }
1728
Ed Tanous002d39b2022-05-31 08:59:27 -07001729 std::string entryID = param;
1730 dbus::utility::escapePathForDbus(entryID);
1731
1732 // DBus implementation of EventLog/Entries
1733 // Make call to Logging Service to find all log entry objects
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001734 sdbusplus::asio::getAllProperties(
1735 *crow::connections::systemBus, "xyz.openbmc_project.Logging",
1736 "/xyz/openbmc_project/logging/entry/" + entryID, "",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001737 [asyncResp, entryID](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07001738 const dbus::utility::DBusPropertiesMap& resp) {
1739 if (ec.value() == EBADR)
Adriana Kobylak400fd1f2021-01-29 09:01:30 -06001740 {
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001741 messages::resourceNotFound(asyncResp->res, "EventLogEntry",
1742 entryID);
Ed Tanous45ca1b82022-03-25 13:07:27 -07001743 return;
1744 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001745 if (ec)
1746 {
1747 BMCWEB_LOG_ERROR
1748 << "EventLogEntry (DBus) resp_handler got error " << ec;
1749 messages::internalError(asyncResp->res);
1750 return;
1751 }
1752 const uint32_t* id = nullptr;
1753 const uint64_t* timestamp = nullptr;
1754 const uint64_t* updateTimestamp = nullptr;
1755 const std::string* severity = nullptr;
1756 const std::string* message = nullptr;
1757 const std::string* filePath = nullptr;
Vijay Lobo9c11a172021-10-07 16:53:16 -05001758 const std::string* resolution = nullptr;
Ed Tanous002d39b2022-05-31 08:59:27 -07001759 bool resolved = false;
Abhishek Patel9017faf2021-09-14 22:48:55 -05001760 const std::string* notify = nullptr;
Adriana Kobylak400fd1f2021-01-29 09:01:30 -06001761
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001762 const bool success = sdbusplus::unpackPropertiesNoThrow(
1763 dbus_utils::UnpackErrorPrinter(), resp, "Id", id, "Timestamp",
1764 timestamp, "UpdateTimestamp", updateTimestamp, "Severity",
Vijay Lobo9c11a172021-10-07 16:53:16 -05001765 severity, "Message", message, "Resolved", resolved,
Abhishek Patel9017faf2021-09-14 22:48:55 -05001766 "Resolution", resolution, "Path", filePath,
1767 "ServiceProviderNotify", notify);
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001768
1769 if (!success)
Ed Tanous002d39b2022-05-31 08:59:27 -07001770 {
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001771 messages::internalError(asyncResp->res);
1772 return;
Ed Tanous002d39b2022-05-31 08:59:27 -07001773 }
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001774
Ed Tanous002d39b2022-05-31 08:59:27 -07001775 if (id == nullptr || message == nullptr || severity == nullptr ||
Abhishek Patel9017faf2021-09-14 22:48:55 -05001776 timestamp == nullptr || updateTimestamp == nullptr ||
1777 notify == nullptr)
Ed Tanous002d39b2022-05-31 08:59:27 -07001778 {
1779 messages::internalError(asyncResp->res);
1780 return;
1781 }
Abhishek Patel9017faf2021-09-14 22:48:55 -05001782
Ed Tanous002d39b2022-05-31 08:59:27 -07001783 asyncResp->res.jsonValue["@odata.type"] =
Vijay Lobo9c11a172021-10-07 16:53:16 -05001784 "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07001785 asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
1786 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/{}",
1787 std::to_string(*id));
Ed Tanous002d39b2022-05-31 08:59:27 -07001788 asyncResp->res.jsonValue["Name"] = "System Event Log Entry";
1789 asyncResp->res.jsonValue["Id"] = std::to_string(*id);
1790 asyncResp->res.jsonValue["Message"] = *message;
1791 asyncResp->res.jsonValue["Resolved"] = resolved;
Abhishek Patel9017faf2021-09-14 22:48:55 -05001792 std::optional<bool> notifyAction = getProviderNotifyAction(*notify);
1793 if (notifyAction)
1794 {
1795 asyncResp->res.jsonValue["ServiceProviderNotified"] =
1796 *notifyAction;
1797 }
Vijay Lobo9c11a172021-10-07 16:53:16 -05001798 if ((resolution != nullptr) && (!(*resolution).empty()))
1799 {
1800 asyncResp->res.jsonValue["Resolution"] = *resolution;
1801 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001802 asyncResp->res.jsonValue["EntryType"] = "Event";
1803 asyncResp->res.jsonValue["Severity"] =
1804 translateSeverityDbusToRedfish(*severity);
1805 asyncResp->res.jsonValue["Created"] =
Ed Tanous2b829372022-08-03 14:22:34 -07001806 redfish::time_utils::getDateTimeUintMs(*timestamp);
Ed Tanous002d39b2022-05-31 08:59:27 -07001807 asyncResp->res.jsonValue["Modified"] =
Ed Tanous2b829372022-08-03 14:22:34 -07001808 redfish::time_utils::getDateTimeUintMs(*updateTimestamp);
Ed Tanous002d39b2022-05-31 08:59:27 -07001809 if (filePath != nullptr)
1810 {
1811 asyncResp->res.jsonValue["AdditionalDataURI"] =
1812 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
1813 std::to_string(*id) + "/attachment";
1814 }
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02001815 });
Ed Tanous45ca1b82022-03-25 13:07:27 -07001816 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001817
1818 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001819 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001820 .privileges(redfish::privileges::patchLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001821 .methods(boost::beast::http::verb::patch)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07001822 [&app](const crow::Request& req,
1823 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07001824 const std::string& systemName, const std::string& entryId) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001825 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001826 {
1827 return;
1828 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001829 if (systemName != "system")
1830 {
1831 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1832 systemName);
1833 return;
1834 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001835 std::optional<bool> resolved;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001836
Ed Tanous002d39b2022-05-31 08:59:27 -07001837 if (!json_util::readJsonPatch(req, asyncResp->res, "Resolved",
1838 resolved))
1839 {
1840 return;
1841 }
1842 BMCWEB_LOG_DEBUG << "Set Resolved";
Adriana Kobylak400fd1f2021-01-29 09:01:30 -06001843
Ed Tanous002d39b2022-05-31 08:59:27 -07001844 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001845 [asyncResp, entryId](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001846 if (ec)
1847 {
1848 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1849 messages::internalError(asyncResp->res);
1850 return;
1851 }
1852 },
1853 "xyz.openbmc_project.Logging",
1854 "/xyz/openbmc_project/logging/entry/" + entryId,
1855 "org.freedesktop.DBus.Properties", "Set",
1856 "xyz.openbmc_project.Logging.Entry", "Resolved",
1857 dbus::utility::DbusVariantType(*resolved));
1858 });
Adriana Kobylak400fd1f2021-01-29 09:01:30 -06001859
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001860 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07001861 app, "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07001862 .privileges(redfish::privileges::deleteLogEntry)
1863
Ed Tanous002d39b2022-05-31 08:59:27 -07001864 .methods(boost::beast::http::verb::delete_)(
1865 [&app](const crow::Request& req,
1866 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07001867 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001868 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001869 {
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 BMCWEB_LOG_DEBUG << "Do delete single event entries.";
1879
1880 std::string entryID = param;
1881
1882 dbus::utility::escapePathForDbus(entryID);
1883
1884 // Process response from Logging service.
1885 auto respHandler =
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001886 [asyncResp, entryID](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001887 BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done";
1888 if (ec)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001889 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001890 if (ec.value() == EBADR)
Ed Tanous45ca1b82022-03-25 13:07:27 -07001891 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001892 messages::resourceNotFound(asyncResp->res, "LogEntry",
1893 entryID);
Ed Tanous45ca1b82022-03-25 13:07:27 -07001894 return;
1895 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001896 // TODO Handle for specific error code
1897 BMCWEB_LOG_ERROR
1898 << "EventLogEntry (DBus) doDelete respHandler got error "
1899 << ec;
1900 asyncResp->res.result(
1901 boost::beast::http::status::internal_server_error);
1902 return;
1903 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001904
Ed Tanous002d39b2022-05-31 08:59:27 -07001905 asyncResp->res.result(boost::beast::http::status::ok);
1906 };
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001907
Ed Tanous002d39b2022-05-31 08:59:27 -07001908 // Make call to Logging service to request Delete Log
1909 crow::connections::systemBus->async_method_call(
1910 respHandler, "xyz.openbmc_project.Logging",
1911 "/xyz/openbmc_project/logging/entry/" + entryID,
1912 "xyz.openbmc_project.Object.Delete", "Delete");
Ed Tanous45ca1b82022-03-25 13:07:27 -07001913 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001914}
1915
1916inline void requestRoutesDBusEventLogEntryDownload(App& app)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001917{
George Liu0fda0f12021-11-16 10:06:17 +08001918 BMCWEB_ROUTE(
1919 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07001920 "/redfish/v1/Systems/<str>/LogServices/EventLog/Entries/<str>/attachment")
Ed Tanoused398212021-06-09 17:05:54 -07001921 .privileges(redfish::privileges::getLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001922 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07001923 [&app](const crow::Request& req,
1924 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07001925 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001926 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001927 {
1928 return;
1929 }
Matt Spinler72e21372023-04-19 12:53:33 -05001930 if (!http_helpers::isContentTypeAllowed(
Ed Tanous99351cd2022-08-07 16:42:51 -07001931 req.getHeaderValue("Accept"),
Ed Tanous4a0e1a02022-09-21 15:28:04 -07001932 http_helpers::ContentType::OctetStream, true))
Ed Tanous002d39b2022-05-31 08:59:27 -07001933 {
1934 asyncResp->res.result(boost::beast::http::status::bad_request);
1935 return;
1936 }
Ed Tanous22d268c2022-05-19 09:39:07 -07001937 if (systemName != "system")
1938 {
1939 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
1940 systemName);
1941 return;
1942 }
zhanghch058d1b46d2021-04-01 11:18:24 +08001943
Ed Tanous002d39b2022-05-31 08:59:27 -07001944 std::string entryID = param;
1945 dbus::utility::escapePathForDbus(entryID);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001946
Ed Tanous002d39b2022-05-31 08:59:27 -07001947 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001948 [asyncResp, entryID](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07001949 const sdbusplus::message::unix_fd& unixfd) {
1950 if (ec.value() == EBADR)
1951 {
1952 messages::resourceNotFound(asyncResp->res, "EventLogAttachment",
1953 entryID);
1954 return;
1955 }
1956 if (ec)
1957 {
1958 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
1959 messages::internalError(asyncResp->res);
1960 return;
1961 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001962
Ed Tanous002d39b2022-05-31 08:59:27 -07001963 int fd = -1;
1964 fd = dup(unixfd);
1965 if (fd == -1)
1966 {
1967 messages::internalError(asyncResp->res);
1968 return;
1969 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001970
Ed Tanous002d39b2022-05-31 08:59:27 -07001971 long long int size = lseek(fd, 0, SEEK_END);
1972 if (size == -1)
1973 {
1974 messages::internalError(asyncResp->res);
1975 return;
1976 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001977
Ed Tanous002d39b2022-05-31 08:59:27 -07001978 // Arbitrary max size of 64kb
1979 constexpr int maxFileSize = 65536;
1980 if (size > maxFileSize)
1981 {
1982 BMCWEB_LOG_ERROR << "File size exceeds maximum allowed size of "
1983 << maxFileSize;
1984 messages::internalError(asyncResp->res);
1985 return;
1986 }
1987 std::vector<char> data(static_cast<size_t>(size));
1988 long long int rc = lseek(fd, 0, SEEK_SET);
1989 if (rc == -1)
1990 {
1991 messages::internalError(asyncResp->res);
1992 return;
1993 }
1994 rc = read(fd, data.data(), data.size());
1995 if ((rc == -1) || (rc != size))
1996 {
1997 messages::internalError(asyncResp->res);
1998 return;
1999 }
2000 close(fd);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002001
Ed Tanous002d39b2022-05-31 08:59:27 -07002002 std::string_view strData(data.data(), data.size());
2003 std::string output = crow::utility::base64encode(strData);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002004
Ed Tanousd9f6c622022-03-17 09:12:17 -07002005 asyncResp->res.addHeader(boost::beast::http::field::content_type,
Ed Tanous002d39b2022-05-31 08:59:27 -07002006 "application/octet-stream");
Ed Tanousd9f6c622022-03-17 09:12:17 -07002007 asyncResp->res.addHeader(
2008 boost::beast::http::field::content_transfer_encoding, "Base64");
Ed Tanous002d39b2022-05-31 08:59:27 -07002009 asyncResp->res.body() = std::move(output);
2010 },
2011 "xyz.openbmc_project.Logging",
2012 "/xyz/openbmc_project/logging/entry/" + entryID,
2013 "xyz.openbmc_project.Logging.Entry", "GetEntry");
2014 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002015}
2016
Spencer Kub7028eb2021-10-26 15:27:35 +08002017constexpr const char* hostLoggerFolderPath = "/var/log/console";
2018
2019inline bool
2020 getHostLoggerFiles(const std::string& hostLoggerFilePath,
2021 std::vector<std::filesystem::path>& hostLoggerFiles)
2022{
2023 std::error_code ec;
2024 std::filesystem::directory_iterator logPath(hostLoggerFilePath, ec);
2025 if (ec)
2026 {
2027 BMCWEB_LOG_ERROR << ec.message();
2028 return false;
2029 }
2030 for (const std::filesystem::directory_entry& it : logPath)
2031 {
2032 std::string filename = it.path().filename();
2033 // Prefix of each log files is "log". Find the file and save the
2034 // path
Ed Tanous11ba3972022-07-11 09:50:41 -07002035 if (filename.starts_with("log"))
Spencer Kub7028eb2021-10-26 15:27:35 +08002036 {
2037 hostLoggerFiles.emplace_back(it.path());
2038 }
2039 }
2040 // As the log files rotate, they are appended with a ".#" that is higher for
2041 // the older logs. Since we start from oldest logs, sort the name in
2042 // descending order.
2043 std::sort(hostLoggerFiles.rbegin(), hostLoggerFiles.rend(),
2044 AlphanumLess<std::string>());
2045
2046 return true;
2047}
2048
Ed Tanous02cad962022-06-30 16:50:15 -07002049inline bool getHostLoggerEntries(
2050 const std::vector<std::filesystem::path>& hostLoggerFiles, uint64_t skip,
2051 uint64_t top, std::vector<std::string>& logEntries, size_t& logCount)
Spencer Kub7028eb2021-10-26 15:27:35 +08002052{
2053 GzFileReader logFile;
2054
2055 // Go though all log files and expose host logs.
2056 for (const std::filesystem::path& it : hostLoggerFiles)
2057 {
2058 if (!logFile.gzGetLines(it.string(), skip, top, logEntries, logCount))
2059 {
2060 BMCWEB_LOG_ERROR << "fail to expose host logs";
2061 return false;
2062 }
2063 }
2064 // Get lastMessage from constructor by getter
2065 std::string lastMessage = logFile.getLastMessage();
2066 if (!lastMessage.empty())
2067 {
2068 logCount++;
2069 if (logCount > skip && logCount <= (skip + top))
2070 {
2071 logEntries.push_back(lastMessage);
2072 }
2073 }
2074 return true;
2075}
2076
2077inline void fillHostLoggerEntryJson(const std::string& logEntryID,
2078 const std::string& msg,
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002079 nlohmann::json::object_t& logEntryJson)
Spencer Kub7028eb2021-10-26 15:27:35 +08002080{
2081 // Fill in the log entry with the gathered data.
Vijay Lobo9c11a172021-10-07 16:53:16 -05002082 logEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07002083 logEntryJson["@odata.id"] = boost::urls::format(
2084 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries/{}",
2085 logEntryID);
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002086 logEntryJson["Name"] = "Host Logger Entry";
2087 logEntryJson["Id"] = logEntryID;
2088 logEntryJson["Message"] = msg;
2089 logEntryJson["EntryType"] = "Oem";
2090 logEntryJson["Severity"] = "OK";
2091 logEntryJson["OemRecordFormat"] = "Host Logger Entry";
Spencer Kub7028eb2021-10-26 15:27:35 +08002092}
2093
2094inline void requestRoutesSystemHostLogger(App& app)
2095{
Ed Tanous22d268c2022-05-19 09:39:07 -07002096 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/")
Spencer Kub7028eb2021-10-26 15:27:35 +08002097 .privileges(redfish::privileges::getLogService)
Ed Tanous14766872022-03-15 10:44:42 -07002098 .methods(boost::beast::http::verb::get)(
2099 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07002100 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2101 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002102 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002103 {
2104 return;
2105 }
Ed Tanous22d268c2022-05-19 09:39:07 -07002106 if (systemName != "system")
2107 {
2108 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2109 systemName);
2110 return;
2111 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002112 asyncResp->res.jsonValue["@odata.id"] =
2113 "/redfish/v1/Systems/system/LogServices/HostLogger";
2114 asyncResp->res.jsonValue["@odata.type"] =
2115 "#LogService.v1_1_0.LogService";
2116 asyncResp->res.jsonValue["Name"] = "Host Logger Service";
2117 asyncResp->res.jsonValue["Description"] = "Host Logger Service";
2118 asyncResp->res.jsonValue["Id"] = "HostLogger";
2119 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
2120 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries";
2121 });
Spencer Kub7028eb2021-10-26 15:27:35 +08002122}
2123
2124inline void requestRoutesSystemHostLoggerCollection(App& app)
2125{
2126 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002127 "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/")
Spencer Kub7028eb2021-10-26 15:27:35 +08002128 .privileges(redfish::privileges::getLogEntry)
Ed Tanous002d39b2022-05-31 08:59:27 -07002129 .methods(boost::beast::http::verb::get)(
2130 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07002131 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2132 const std::string& systemName) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002133 query_param::QueryCapabilities capabilities = {
2134 .canDelegateTop = true,
2135 .canDelegateSkip = true,
2136 };
2137 query_param::Query delegatedQuery;
2138 if (!redfish::setUpRedfishRouteWithDelegation(
Carson Labrado3ba00072022-06-06 19:40:56 +00002139 app, req, asyncResp, delegatedQuery, capabilities))
Ed Tanous002d39b2022-05-31 08:59:27 -07002140 {
2141 return;
2142 }
Ed Tanous22d268c2022-05-19 09:39:07 -07002143 if (systemName != "system")
2144 {
2145 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2146 systemName);
2147 return;
2148 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002149 asyncResp->res.jsonValue["@odata.id"] =
2150 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries";
2151 asyncResp->res.jsonValue["@odata.type"] =
2152 "#LogEntryCollection.LogEntryCollection";
2153 asyncResp->res.jsonValue["Name"] = "HostLogger Entries";
2154 asyncResp->res.jsonValue["Description"] =
2155 "Collection of HostLogger Entries";
2156 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2157 logEntryArray = nlohmann::json::array();
2158 asyncResp->res.jsonValue["Members@odata.count"] = 0;
Spencer Kub7028eb2021-10-26 15:27:35 +08002159
Ed Tanous002d39b2022-05-31 08:59:27 -07002160 std::vector<std::filesystem::path> hostLoggerFiles;
2161 if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles))
2162 {
2163 BMCWEB_LOG_ERROR << "fail to get host log file path";
2164 return;
2165 }
Ed Tanous3648c8b2022-07-25 13:39:59 -07002166 // If we weren't provided top and skip limits, use the defaults.
2167 size_t skip = delegatedQuery.skip.value_or(0);
Jiaqing Zhao5143f7a2022-07-22 09:33:33 +08002168 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
Ed Tanous002d39b2022-05-31 08:59:27 -07002169 size_t logCount = 0;
2170 // This vector only store the entries we want to expose that
2171 // control by skip and top.
2172 std::vector<std::string> logEntries;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002173 if (!getHostLoggerEntries(hostLoggerFiles, skip, top, logEntries,
2174 logCount))
Ed Tanous002d39b2022-05-31 08:59:27 -07002175 {
2176 messages::internalError(asyncResp->res);
2177 return;
2178 }
2179 // If vector is empty, that means skip value larger than total
2180 // log count
2181 if (logEntries.empty())
2182 {
2183 asyncResp->res.jsonValue["Members@odata.count"] = logCount;
2184 return;
2185 }
2186 if (!logEntries.empty())
2187 {
2188 for (size_t i = 0; i < logEntries.size(); i++)
George Liu0fda0f12021-11-16 10:06:17 +08002189 {
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002190 nlohmann::json::object_t hostLogEntry;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002191 fillHostLoggerEntryJson(std::to_string(skip + i), logEntries[i],
2192 hostLogEntry);
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002193 logEntryArray.emplace_back(std::move(hostLogEntry));
George Liu0fda0f12021-11-16 10:06:17 +08002194 }
2195
Ed Tanous002d39b2022-05-31 08:59:27 -07002196 asyncResp->res.jsonValue["Members@odata.count"] = logCount;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002197 if (skip + top < logCount)
George Liu0fda0f12021-11-16 10:06:17 +08002198 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002199 asyncResp->res.jsonValue["Members@odata.nextLink"] =
2200 "/redfish/v1/Systems/system/LogServices/HostLogger/Entries?$skip=" +
Ed Tanous3648c8b2022-07-25 13:39:59 -07002201 std::to_string(skip + top);
George Liu0fda0f12021-11-16 10:06:17 +08002202 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002203 }
George Liu0fda0f12021-11-16 10:06:17 +08002204 });
Spencer Kub7028eb2021-10-26 15:27:35 +08002205}
2206
2207inline void requestRoutesSystemHostLoggerLogEntry(App& app)
2208{
2209 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07002210 app, "/redfish/v1/Systems/<str>/LogServices/HostLogger/Entries/<str>/")
Spencer Kub7028eb2021-10-26 15:27:35 +08002211 .privileges(redfish::privileges::getLogEntry)
2212 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07002213 [&app](const crow::Request& req,
2214 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07002215 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002216 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002217 {
2218 return;
2219 }
Ed Tanous22d268c2022-05-19 09:39:07 -07002220 if (systemName != "system")
2221 {
2222 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
2223 systemName);
2224 return;
2225 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002226 const std::string& targetID = param;
Spencer Kub7028eb2021-10-26 15:27:35 +08002227
Ed Tanous002d39b2022-05-31 08:59:27 -07002228 uint64_t idInt = 0;
Ed Tanousca45aa32022-01-07 09:28:45 -08002229
Patrick Williams84396af2023-05-11 11:47:45 -05002230 auto [ptr, ec] = std::from_chars(&*targetID.begin(), &*targetID.end(),
2231 idInt);
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08002232 if (ec == std::errc::invalid_argument ||
2233 ec == std::errc::result_out_of_range)
Ed Tanous002d39b2022-05-31 08:59:27 -07002234 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08002235 messages::resourceNotFound(asyncResp->res, "LogEntry", param);
Ed Tanous002d39b2022-05-31 08:59:27 -07002236 return;
2237 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002238
Ed Tanous002d39b2022-05-31 08:59:27 -07002239 std::vector<std::filesystem::path> hostLoggerFiles;
2240 if (!getHostLoggerFiles(hostLoggerFolderPath, hostLoggerFiles))
2241 {
2242 BMCWEB_LOG_ERROR << "fail to get host log file path";
2243 return;
2244 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002245
Ed Tanous002d39b2022-05-31 08:59:27 -07002246 size_t logCount = 0;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002247 size_t top = 1;
Ed Tanous002d39b2022-05-31 08:59:27 -07002248 std::vector<std::string> logEntries;
2249 // We can get specific entry by skip and top. For example, if we
2250 // want to get nth entry, we can set skip = n-1 and top = 1 to
2251 // get that entry
2252 if (!getHostLoggerEntries(hostLoggerFiles, idInt, top, logEntries,
2253 logCount))
2254 {
2255 messages::internalError(asyncResp->res);
2256 return;
2257 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002258
Ed Tanous002d39b2022-05-31 08:59:27 -07002259 if (!logEntries.empty())
2260 {
Jason M. Bills6d6574c2022-06-28 12:30:16 -07002261 nlohmann::json::object_t hostLogEntry;
2262 fillHostLoggerEntryJson(targetID, logEntries[0], hostLogEntry);
2263 asyncResp->res.jsonValue.update(hostLogEntry);
Ed Tanous002d39b2022-05-31 08:59:27 -07002264 return;
2265 }
Spencer Kub7028eb2021-10-26 15:27:35 +08002266
Ed Tanous002d39b2022-05-31 08:59:27 -07002267 // Requested ID was not found
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08002268 messages::resourceNotFound(asyncResp->res, "LogEntry", param);
Ed Tanous002d39b2022-05-31 08:59:27 -07002269 });
Spencer Kub7028eb2021-10-26 15:27:35 +08002270}
2271
Claire Weinandd72e872022-08-15 14:20:06 -07002272inline void handleBMCLogServicesCollectionGet(
Claire Weinanfdd26902022-03-01 14:18:25 -08002273 crow::App& app, const crow::Request& req,
2274 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2275{
2276 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2277 {
2278 return;
2279 }
2280 // Collections don't include the static data added by SubRoute
2281 // because it has a duplicate entry for members
2282 asyncResp->res.jsonValue["@odata.type"] =
2283 "#LogServiceCollection.LogServiceCollection";
2284 asyncResp->res.jsonValue["@odata.id"] =
2285 "/redfish/v1/Managers/bmc/LogServices";
2286 asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection";
2287 asyncResp->res.jsonValue["Description"] =
2288 "Collection of LogServices for this Manager";
2289 nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
2290 logServiceArray = nlohmann::json::array();
2291
2292#ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
Ed Tanous613dabe2022-07-09 11:17:36 -07002293 nlohmann::json::object_t journal;
2294 journal["@odata.id"] = "/redfish/v1/Managers/bmc/LogServices/Journal";
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002295 logServiceArray.emplace_back(std::move(journal));
Claire Weinanfdd26902022-03-01 14:18:25 -08002296#endif
2297
2298 asyncResp->res.jsonValue["Members@odata.count"] = logServiceArray.size();
2299
2300#ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
George Liu15912152023-01-11 10:18:18 +08002301 constexpr std::array<std::string_view, 1> interfaces = {
George Liu7a1dbc42022-12-07 16:03:22 +08002302 "xyz.openbmc_project.Collection.DeleteAll"};
2303 dbus::utility::getSubTreePaths(
2304 "/xyz/openbmc_project/dump", 0, interfaces,
Claire Weinanfdd26902022-03-01 14:18:25 -08002305 [asyncResp](
George Liu7a1dbc42022-12-07 16:03:22 +08002306 const boost::system::error_code& ec,
Claire Weinanfdd26902022-03-01 14:18:25 -08002307 const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) {
2308 if (ec)
2309 {
2310 BMCWEB_LOG_ERROR
Claire Weinandd72e872022-08-15 14:20:06 -07002311 << "handleBMCLogServicesCollectionGet respHandler got error "
Claire Weinanfdd26902022-03-01 14:18:25 -08002312 << ec;
2313 // Assume that getting an error simply means there are no dump
2314 // LogServices. Return without adding any error response.
2315 return;
2316 }
2317
2318 nlohmann::json& logServiceArrayLocal =
2319 asyncResp->res.jsonValue["Members"];
2320
2321 for (const std::string& path : subTreePaths)
2322 {
2323 if (path == "/xyz/openbmc_project/dump/bmc")
2324 {
Ed Tanous613dabe2022-07-09 11:17:36 -07002325 nlohmann::json::object_t member;
2326 member["@odata.id"] =
2327 "/redfish/v1/Managers/bmc/LogServices/Dump";
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002328 logServiceArrayLocal.emplace_back(std::move(member));
Claire Weinanfdd26902022-03-01 14:18:25 -08002329 }
2330 else if (path == "/xyz/openbmc_project/dump/faultlog")
2331 {
Ed Tanous613dabe2022-07-09 11:17:36 -07002332 nlohmann::json::object_t member;
2333 member["@odata.id"] =
2334 "/redfish/v1/Managers/bmc/LogServices/FaultLog";
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002335 logServiceArrayLocal.emplace_back(std::move(member));
Claire Weinanfdd26902022-03-01 14:18:25 -08002336 }
2337 }
2338
2339 asyncResp->res.jsonValue["Members@odata.count"] =
2340 logServiceArrayLocal.size();
George Liu7a1dbc42022-12-07 16:03:22 +08002341 });
Claire Weinanfdd26902022-03-01 14:18:25 -08002342#endif
2343}
2344
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002345inline void requestRoutesBMCLogServiceCollection(App& app)
2346{
2347 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/")
Gunnar Millsad89dcf2021-07-30 14:40:11 -05002348 .privileges(redfish::privileges::getLogServiceCollection)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002349 .methods(boost::beast::http::verb::get)(
Claire Weinandd72e872022-08-15 14:20:06 -07002350 std::bind_front(handleBMCLogServicesCollectionGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002351}
Ed Tanous1da66f72018-07-27 16:13:37 -07002352
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002353inline void requestRoutesBMCJournalLogService(App& app)
Ed Tanous1da66f72018-07-27 16:13:37 -07002354{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002355 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/")
Ed Tanoused398212021-06-09 17:05:54 -07002356 .privileges(redfish::privileges::getLogService)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002357 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07002358 [&app](const crow::Request& req,
2359 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002360 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002361 {
2362 return;
2363 }
2364 asyncResp->res.jsonValue["@odata.type"] =
2365 "#LogService.v1_1_0.LogService";
2366 asyncResp->res.jsonValue["@odata.id"] =
2367 "/redfish/v1/Managers/bmc/LogServices/Journal";
2368 asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service";
2369 asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service";
Ed Tanoused34a4a2023-02-08 15:43:27 -08002370 asyncResp->res.jsonValue["Id"] = "Journal";
Ed Tanous002d39b2022-05-31 08:59:27 -07002371 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
Tejas Patil7c8c4052021-06-04 17:43:14 +05302372
Ed Tanous002d39b2022-05-31 08:59:27 -07002373 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07002374 redfish::time_utils::getDateTimeOffsetNow();
Ed Tanous002d39b2022-05-31 08:59:27 -07002375 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
2376 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
2377 redfishDateTimeOffset.second;
Tejas Patil7c8c4052021-06-04 17:43:14 +05302378
Ed Tanous002d39b2022-05-31 08:59:27 -07002379 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
2380 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
2381 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002382}
Jason M. Billse1f26342018-07-18 12:12:00 -07002383
Jason M. Bills3a48b3a2022-06-24 10:10:15 -07002384static int
2385 fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID,
2386 sd_journal* journal,
2387 nlohmann::json::object_t& bmcJournalLogEntryJson)
Jason M. Billse1f26342018-07-18 12:12:00 -07002388{
2389 // Get the Log Entry contents
2390 int ret = 0;
Jason M. Billse1f26342018-07-18 12:12:00 -07002391
Jason M. Billsa8fe54f2020-11-20 15:57:55 -08002392 std::string message;
2393 std::string_view syslogID;
2394 ret = getJournalMetadata(journal, "SYSLOG_IDENTIFIER", syslogID);
2395 if (ret < 0)
2396 {
2397 BMCWEB_LOG_ERROR << "Failed to read SYSLOG_IDENTIFIER field: "
2398 << strerror(-ret);
2399 }
2400 if (!syslogID.empty())
2401 {
2402 message += std::string(syslogID) + ": ";
2403 }
2404
Ed Tanous39e77502019-03-04 17:35:53 -08002405 std::string_view msg;
Jason M. Bills16428a12018-11-02 12:42:29 -07002406 ret = getJournalMetadata(journal, "MESSAGE", msg);
Jason M. Billse1f26342018-07-18 12:12:00 -07002407 if (ret < 0)
2408 {
2409 BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret);
2410 return 1;
2411 }
Jason M. Billsa8fe54f2020-11-20 15:57:55 -08002412 message += std::string(msg);
Jason M. Billse1f26342018-07-18 12:12:00 -07002413
2414 // Get the severity from the PRIORITY field
Ed Tanous271584a2019-07-09 16:24:22 -07002415 long int severity = 8; // Default to an invalid priority
Jason M. Bills16428a12018-11-02 12:42:29 -07002416 ret = getJournalMetadata(journal, "PRIORITY", 10, severity);
Jason M. Billse1f26342018-07-18 12:12:00 -07002417 if (ret < 0)
2418 {
2419 BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret);
Jason M. Billse1f26342018-07-18 12:12:00 -07002420 }
Jason M. Billse1f26342018-07-18 12:12:00 -07002421
2422 // Get the Created time from the timestamp
Jason M. Bills16428a12018-11-02 12:42:29 -07002423 std::string entryTimeStr;
2424 if (!getEntryTimestamp(journal, entryTimeStr))
Jason M. Billse1f26342018-07-18 12:12:00 -07002425 {
Jason M. Bills16428a12018-11-02 12:42:29 -07002426 return 1;
Jason M. Billse1f26342018-07-18 12:12:00 -07002427 }
Jason M. Billse1f26342018-07-18 12:12:00 -07002428
2429 // Fill in the log entry with the gathered data
Vijay Lobo9c11a172021-10-07 16:53:16 -05002430 bmcJournalLogEntryJson["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07002431 bmcJournalLogEntryJson["@odata.id"] = boost::urls::format(
2432 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/{}",
Willy Tueddfc432022-09-26 16:46:38 +00002433 bmcJournalLogEntryID);
Jason M. Bills84afc482022-06-24 12:38:23 -07002434 bmcJournalLogEntryJson["Name"] = "BMC Journal Entry";
2435 bmcJournalLogEntryJson["Id"] = bmcJournalLogEntryID;
2436 bmcJournalLogEntryJson["Message"] = std::move(message);
2437 bmcJournalLogEntryJson["EntryType"] = "Oem";
2438 bmcJournalLogEntryJson["Severity"] = severity <= 2 ? "Critical"
2439 : severity <= 4 ? "Warning"
2440 : "OK";
2441 bmcJournalLogEntryJson["OemRecordFormat"] = "BMC Journal Entry";
2442 bmcJournalLogEntryJson["Created"] = std::move(entryTimeStr);
Jason M. Billse1f26342018-07-18 12:12:00 -07002443 return 0;
2444}
2445
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002446inline void requestRoutesBMCJournalLogEntryCollection(App& app)
Jason M. Billse1f26342018-07-18 12:12:00 -07002447{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002448 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07002449 .privileges(redfish::privileges::getLogEntryCollection)
Ed Tanous002d39b2022-05-31 08:59:27 -07002450 .methods(boost::beast::http::verb::get)(
2451 [&app](const crow::Request& req,
2452 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
2453 query_param::QueryCapabilities capabilities = {
2454 .canDelegateTop = true,
2455 .canDelegateSkip = true,
2456 };
2457 query_param::Query delegatedQuery;
2458 if (!redfish::setUpRedfishRouteWithDelegation(
Carson Labrado3ba00072022-06-06 19:40:56 +00002459 app, req, asyncResp, delegatedQuery, capabilities))
Ed Tanous002d39b2022-05-31 08:59:27 -07002460 {
2461 return;
2462 }
Ed Tanous3648c8b2022-07-25 13:39:59 -07002463
2464 size_t skip = delegatedQuery.skip.value_or(0);
Jiaqing Zhao5143f7a2022-07-22 09:33:33 +08002465 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
Ed Tanous3648c8b2022-07-25 13:39:59 -07002466
Ed Tanous002d39b2022-05-31 08:59:27 -07002467 // Collections don't include the static data added by SubRoute
2468 // because it has a duplicate entry for members
2469 asyncResp->res.jsonValue["@odata.type"] =
2470 "#LogEntryCollection.LogEntryCollection";
2471 asyncResp->res.jsonValue["@odata.id"] =
2472 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
2473 asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries";
2474 asyncResp->res.jsonValue["Description"] =
2475 "Collection of BMC Journal Entries";
2476 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
2477 logEntryArray = nlohmann::json::array();
Jason M. Billse1f26342018-07-18 12:12:00 -07002478
Ed Tanous002d39b2022-05-31 08:59:27 -07002479 // Go through the journal and use the timestamp to create a
2480 // unique ID for each entry
2481 sd_journal* journalTmp = nullptr;
2482 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
2483 if (ret < 0)
2484 {
2485 BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
2486 messages::internalError(asyncResp->res);
2487 return;
2488 }
2489 std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
2490 journalTmp, sd_journal_close);
2491 journalTmp = nullptr;
2492 uint64_t entryCount = 0;
2493 // Reset the unique ID on the first entry
2494 bool firstEntry = true;
2495 SD_JOURNAL_FOREACH(journal.get())
2496 {
2497 entryCount++;
2498 // Handle paging using skip (number of entries to skip from
2499 // the start) and top (number of entries to display)
Ed Tanous3648c8b2022-07-25 13:39:59 -07002500 if (entryCount <= skip || entryCount > skip + top)
George Liu0fda0f12021-11-16 10:06:17 +08002501 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002502 continue;
2503 }
2504
2505 std::string idStr;
2506 if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
2507 {
2508 continue;
2509 }
Jason M. Billsefde4ec2022-06-24 08:59:52 -07002510 firstEntry = false;
Ed Tanous002d39b2022-05-31 08:59:27 -07002511
Jason M. Bills3a48b3a2022-06-24 10:10:15 -07002512 nlohmann::json::object_t bmcJournalLogEntry;
Ed Tanous002d39b2022-05-31 08:59:27 -07002513 if (fillBMCJournalLogEntryJson(idStr, journal.get(),
2514 bmcJournalLogEntry) != 0)
2515 {
George Liu0fda0f12021-11-16 10:06:17 +08002516 messages::internalError(asyncResp->res);
2517 return;
2518 }
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002519 logEntryArray.emplace_back(std::move(bmcJournalLogEntry));
Ed Tanous002d39b2022-05-31 08:59:27 -07002520 }
2521 asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
Ed Tanous3648c8b2022-07-25 13:39:59 -07002522 if (skip + top < entryCount)
Ed Tanous002d39b2022-05-31 08:59:27 -07002523 {
2524 asyncResp->res.jsonValue["Members@odata.nextLink"] =
2525 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" +
Ed Tanous3648c8b2022-07-25 13:39:59 -07002526 std::to_string(skip + top);
Ed Tanous002d39b2022-05-31 08:59:27 -07002527 }
George Liu0fda0f12021-11-16 10:06:17 +08002528 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002529}
Jason M. Billse1f26342018-07-18 12:12:00 -07002530
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002531inline void requestRoutesBMCJournalLogEntry(App& app)
Jason M. Billse1f26342018-07-18 12:12:00 -07002532{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002533 BMCWEB_ROUTE(app,
2534 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002535 .privileges(redfish::privileges::getLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002536 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07002537 [&app](const crow::Request& req,
2538 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2539 const std::string& entryID) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002540 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002541 {
2542 return;
2543 }
2544 // Convert the unique ID back to a timestamp to find the entry
2545 uint64_t ts = 0;
2546 uint64_t index = 0;
2547 if (!getTimestampFromID(asyncResp, entryID, ts, index))
2548 {
2549 return;
2550 }
Jason M. Billse1f26342018-07-18 12:12:00 -07002551
Ed Tanous002d39b2022-05-31 08:59:27 -07002552 sd_journal* journalTmp = nullptr;
2553 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
2554 if (ret < 0)
2555 {
2556 BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
2557 messages::internalError(asyncResp->res);
2558 return;
2559 }
2560 std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
2561 journalTmp, sd_journal_close);
2562 journalTmp = nullptr;
2563 // Go to the timestamp in the log and move to the entry at the
2564 // index tracking the unique ID
2565 std::string idStr;
2566 bool firstEntry = true;
2567 ret = sd_journal_seek_realtime_usec(journal.get(), ts);
2568 if (ret < 0)
2569 {
2570 BMCWEB_LOG_ERROR << "failed to seek to an entry in journal"
2571 << strerror(-ret);
2572 messages::internalError(asyncResp->res);
2573 return;
2574 }
2575 for (uint64_t i = 0; i <= index; i++)
2576 {
2577 sd_journal_next(journal.get());
2578 if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
2579 {
2580 messages::internalError(asyncResp->res);
2581 return;
2582 }
Jason M. Billsefde4ec2022-06-24 08:59:52 -07002583 firstEntry = false;
Ed Tanous002d39b2022-05-31 08:59:27 -07002584 }
2585 // Confirm that the entry ID matches what was requested
2586 if (idStr != entryID)
2587 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08002588 messages::resourceNotFound(asyncResp->res, "LogEntry", entryID);
Ed Tanous002d39b2022-05-31 08:59:27 -07002589 return;
2590 }
zhanghch058d1b46d2021-04-01 11:18:24 +08002591
Jason M. Bills3a48b3a2022-06-24 10:10:15 -07002592 nlohmann::json::object_t bmcJournalLogEntry;
Ed Tanous002d39b2022-05-31 08:59:27 -07002593 if (fillBMCJournalLogEntryJson(entryID, journal.get(),
Jason M. Bills3a48b3a2022-06-24 10:10:15 -07002594 bmcJournalLogEntry) != 0)
Ed Tanous002d39b2022-05-31 08:59:27 -07002595 {
2596 messages::internalError(asyncResp->res);
2597 return;
2598 }
Jason M. Billsd405bb52022-06-24 10:52:05 -07002599 asyncResp->res.jsonValue.update(bmcJournalLogEntry);
Ed Tanous002d39b2022-05-31 08:59:27 -07002600 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002601}
2602
Claire Weinanfdd26902022-03-01 14:18:25 -08002603inline void
2604 getDumpServiceInfo(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2605 const std::string& dumpType)
2606{
2607 std::string dumpPath;
2608 std::string overWritePolicy;
2609 bool collectDiagnosticDataSupported = false;
2610
2611 if (dumpType == "BMC")
2612 {
2613 dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump";
2614 overWritePolicy = "WrapsWhenFull";
2615 collectDiagnosticDataSupported = true;
2616 }
2617 else if (dumpType == "FaultLog")
2618 {
2619 dumpPath = "/redfish/v1/Managers/bmc/LogServices/FaultLog";
2620 overWritePolicy = "Unknown";
2621 collectDiagnosticDataSupported = false;
2622 }
2623 else if (dumpType == "System")
2624 {
2625 dumpPath = "/redfish/v1/Systems/system/LogServices/Dump";
2626 overWritePolicy = "WrapsWhenFull";
2627 collectDiagnosticDataSupported = true;
2628 }
2629 else
2630 {
2631 BMCWEB_LOG_ERROR << "getDumpServiceInfo() invalid dump type: "
2632 << dumpType;
2633 messages::internalError(asyncResp->res);
2634 return;
2635 }
2636
2637 asyncResp->res.jsonValue["@odata.id"] = dumpPath;
2638 asyncResp->res.jsonValue["@odata.type"] = "#LogService.v1_2_0.LogService";
2639 asyncResp->res.jsonValue["Name"] = "Dump LogService";
2640 asyncResp->res.jsonValue["Description"] = dumpType + " Dump LogService";
2641 asyncResp->res.jsonValue["Id"] = std::filesystem::path(dumpPath).filename();
2642 asyncResp->res.jsonValue["OverWritePolicy"] = std::move(overWritePolicy);
2643
2644 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07002645 redfish::time_utils::getDateTimeOffsetNow();
Claire Weinanfdd26902022-03-01 14:18:25 -08002646 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
2647 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
2648 redfishDateTimeOffset.second;
2649
2650 asyncResp->res.jsonValue["Entries"]["@odata.id"] = dumpPath + "/Entries";
Claire Weinanfdd26902022-03-01 14:18:25 -08002651
2652 if (collectDiagnosticDataSupported)
2653 {
2654 asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
2655 ["target"] =
2656 dumpPath + "/Actions/LogService.CollectDiagnosticData";
2657 }
Claire Weinan0d946212022-07-13 19:40:19 -07002658
2659 constexpr std::array<std::string_view, 1> interfaces = {deleteAllInterface};
2660 dbus::utility::getSubTreePaths(
2661 "/xyz/openbmc_project/dump", 0, interfaces,
2662 [asyncResp, dumpType, dumpPath](
2663 const boost::system::error_code& ec,
2664 const dbus::utility::MapperGetSubTreePathsResponse& subTreePaths) {
2665 if (ec)
2666 {
2667 BMCWEB_LOG_ERROR << "getDumpServiceInfo respHandler got error "
2668 << ec;
2669 // Assume that getting an error simply means there are no dump
2670 // LogServices. Return without adding any error response.
2671 return;
2672 }
2673
2674 const std::string dbusDumpPath =
2675 "/xyz/openbmc_project/dump/" +
2676 boost::algorithm::to_lower_copy(dumpType);
2677
2678 for (const std::string& path : subTreePaths)
2679 {
2680 if (path == dbusDumpPath)
2681 {
2682 asyncResp->res
2683 .jsonValue["Actions"]["#LogService.ClearLog"]["target"] =
2684 dumpPath + "/Actions/LogService.ClearLog";
2685 break;
2686 }
2687 }
2688 });
Claire Weinanfdd26902022-03-01 14:18:25 -08002689}
2690
2691inline void handleLogServicesDumpServiceGet(
2692 crow::App& app, const std::string& dumpType, const crow::Request& req,
2693 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2694{
2695 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2696 {
2697 return;
2698 }
2699 getDumpServiceInfo(asyncResp, dumpType);
2700}
2701
Ed Tanous22d268c2022-05-19 09:39:07 -07002702inline void handleLogServicesDumpServiceComputerSystemGet(
2703 crow::App& app, const crow::Request& req,
2704 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2705 const std::string& chassisId)
2706{
2707 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2708 {
2709 return;
2710 }
2711 if (chassisId != "system")
2712 {
2713 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2714 return;
2715 }
2716 getDumpServiceInfo(asyncResp, "System");
2717}
2718
Claire Weinanfdd26902022-03-01 14:18:25 -08002719inline void handleLogServicesDumpEntriesCollectionGet(
2720 crow::App& app, const std::string& dumpType, const crow::Request& req,
2721 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2722{
2723 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2724 {
2725 return;
2726 }
2727 getDumpEntryCollection(asyncResp, dumpType);
2728}
2729
Ed Tanous22d268c2022-05-19 09:39:07 -07002730inline void handleLogServicesDumpEntriesCollectionComputerSystemGet(
2731 crow::App& app, const crow::Request& req,
2732 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2733 const std::string& chassisId)
2734{
2735 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2736 {
2737 return;
2738 }
2739 if (chassisId != "system")
2740 {
2741 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2742 return;
2743 }
2744 getDumpEntryCollection(asyncResp, "System");
2745}
2746
Claire Weinanfdd26902022-03-01 14:18:25 -08002747inline void handleLogServicesDumpEntryGet(
2748 crow::App& app, const std::string& dumpType, const crow::Request& req,
2749 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2750 const std::string& dumpId)
2751{
2752 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2753 {
2754 return;
2755 }
2756 getDumpEntryById(asyncResp, dumpId, dumpType);
2757}
Ed Tanous22d268c2022-05-19 09:39:07 -07002758inline void handleLogServicesDumpEntryComputerSystemGet(
2759 crow::App& app, const crow::Request& req,
2760 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2761 const std::string& chassisId, const std::string& dumpId)
2762{
2763 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2764 {
2765 return;
2766 }
2767 if (chassisId != "system")
2768 {
2769 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2770 return;
2771 }
2772 getDumpEntryById(asyncResp, dumpId, "System");
2773}
Claire Weinanfdd26902022-03-01 14:18:25 -08002774
2775inline void handleLogServicesDumpEntryDelete(
2776 crow::App& app, const std::string& dumpType, const crow::Request& req,
2777 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2778 const std::string& dumpId)
2779{
2780 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2781 {
2782 return;
2783 }
2784 deleteDumpEntry(asyncResp, dumpId, dumpType);
2785}
2786
Ed Tanous22d268c2022-05-19 09:39:07 -07002787inline void handleLogServicesDumpEntryComputerSystemDelete(
2788 crow::App& app, const crow::Request& req,
2789 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2790 const std::string& chassisId, const std::string& dumpId)
2791{
2792 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2793 {
2794 return;
2795 }
2796 if (chassisId != "system")
2797 {
2798 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2799 return;
2800 }
2801 deleteDumpEntry(asyncResp, dumpId, "System");
2802}
2803
Claire Weinanfdd26902022-03-01 14:18:25 -08002804inline void handleLogServicesDumpCollectDiagnosticDataPost(
2805 crow::App& app, const std::string& dumpType, const crow::Request& req,
2806 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2807{
2808 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2809 {
2810 return;
2811 }
2812 createDump(asyncResp, req, dumpType);
2813}
2814
Ed Tanous22d268c2022-05-19 09:39:07 -07002815inline void handleLogServicesDumpCollectDiagnosticDataComputerSystemPost(
2816 crow::App& app, const crow::Request& req,
2817 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2818 const std::string& chassisId)
2819{
2820 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2821 {
2822 return;
2823 }
2824 if (chassisId != "system")
2825 {
2826 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2827 return;
2828 }
2829 createDump(asyncResp, req, "System");
2830}
2831
Claire Weinanfdd26902022-03-01 14:18:25 -08002832inline void handleLogServicesDumpClearLogPost(
2833 crow::App& app, const std::string& dumpType, const crow::Request& req,
2834 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
2835{
2836 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2837 {
2838 return;
2839 }
2840 clearDump(asyncResp, dumpType);
2841}
2842
Ed Tanous22d268c2022-05-19 09:39:07 -07002843inline void handleLogServicesDumpClearLogComputerSystemPost(
2844 crow::App& app, const crow::Request& req,
2845 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2846 const std::string& chassisId)
2847{
2848 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
2849 {
2850 return;
2851 }
2852 if (chassisId != "system")
2853 {
2854 messages::resourceNotFound(asyncResp->res, "ComputerSystem", chassisId);
2855 return;
2856 }
2857 clearDump(asyncResp, "System");
2858}
2859
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002860inline void requestRoutesBMCDumpService(App& app)
2861{
2862 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/")
Ed Tanoused398212021-06-09 17:05:54 -07002863 .privileges(redfish::privileges::getLogService)
Claire Weinanfdd26902022-03-01 14:18:25 -08002864 .methods(boost::beast::http::verb::get)(std::bind_front(
2865 handleLogServicesDumpServiceGet, std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002866}
2867
2868inline void requestRoutesBMCDumpEntryCollection(App& app)
2869{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002870 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07002871 .privileges(redfish::privileges::getLogEntryCollection)
Claire Weinanfdd26902022-03-01 14:18:25 -08002872 .methods(boost::beast::http::verb::get)(std::bind_front(
2873 handleLogServicesDumpEntriesCollectionGet, std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002874}
2875
2876inline void requestRoutesBMCDumpEntry(App& app)
2877{
2878 BMCWEB_ROUTE(app,
2879 "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002880 .privileges(redfish::privileges::getLogEntry)
Claire Weinanfdd26902022-03-01 14:18:25 -08002881 .methods(boost::beast::http::verb::get)(std::bind_front(
2882 handleLogServicesDumpEntryGet, std::ref(app), "BMC"));
2883
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002884 BMCWEB_ROUTE(app,
2885 "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002886 .privileges(redfish::privileges::deleteLogEntry)
Claire Weinanfdd26902022-03-01 14:18:25 -08002887 .methods(boost::beast::http::verb::delete_)(std::bind_front(
2888 handleLogServicesDumpEntryDelete, std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002889}
2890
2891inline void requestRoutesBMCDumpCreate(App& app)
2892{
George Liu0fda0f12021-11-16 10:06:17 +08002893 BMCWEB_ROUTE(
2894 app,
2895 "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
Ed Tanoused398212021-06-09 17:05:54 -07002896 .privileges(redfish::privileges::postLogService)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002897 .methods(boost::beast::http::verb::post)(
Claire Weinanfdd26902022-03-01 14:18:25 -08002898 std::bind_front(handleLogServicesDumpCollectDiagnosticDataPost,
2899 std::ref(app), "BMC"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002900}
2901
2902inline void requestRoutesBMCDumpClear(App& app)
2903{
George Liu0fda0f12021-11-16 10:06:17 +08002904 BMCWEB_ROUTE(
2905 app,
2906 "/redfish/v1/Managers/bmc/LogServices/Dump/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07002907 .privileges(redfish::privileges::postLogService)
Claire Weinanfdd26902022-03-01 14:18:25 -08002908 .methods(boost::beast::http::verb::post)(std::bind_front(
2909 handleLogServicesDumpClearLogPost, std::ref(app), "BMC"));
2910}
2911
2912inline void requestRoutesFaultLogDumpService(App& app)
2913{
2914 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/")
2915 .privileges(redfish::privileges::getLogService)
2916 .methods(boost::beast::http::verb::get)(std::bind_front(
2917 handleLogServicesDumpServiceGet, std::ref(app), "FaultLog"));
2918}
2919
2920inline void requestRoutesFaultLogDumpEntryCollection(App& app)
2921{
2922 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/")
2923 .privileges(redfish::privileges::getLogEntryCollection)
2924 .methods(boost::beast::http::verb::get)(
2925 std::bind_front(handleLogServicesDumpEntriesCollectionGet,
2926 std::ref(app), "FaultLog"));
2927}
2928
2929inline void requestRoutesFaultLogDumpEntry(App& app)
2930{
2931 BMCWEB_ROUTE(app,
2932 "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/")
2933 .privileges(redfish::privileges::getLogEntry)
2934 .methods(boost::beast::http::verb::get)(std::bind_front(
2935 handleLogServicesDumpEntryGet, std::ref(app), "FaultLog"));
2936
2937 BMCWEB_ROUTE(app,
2938 "/redfish/v1/Managers/bmc/LogServices/FaultLog/Entries/<str>/")
2939 .privileges(redfish::privileges::deleteLogEntry)
2940 .methods(boost::beast::http::verb::delete_)(std::bind_front(
2941 handleLogServicesDumpEntryDelete, std::ref(app), "FaultLog"));
2942}
2943
2944inline void requestRoutesFaultLogDumpClear(App& app)
2945{
2946 BMCWEB_ROUTE(
2947 app,
2948 "/redfish/v1/Managers/bmc/LogServices/FaultLog/Actions/LogService.ClearLog/")
2949 .privileges(redfish::privileges::postLogService)
2950 .methods(boost::beast::http::verb::post)(std::bind_front(
2951 handleLogServicesDumpClearLogPost, std::ref(app), "FaultLog"));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002952}
2953
2954inline void requestRoutesSystemDumpService(App& app)
2955{
Ed Tanous22d268c2022-05-19 09:39:07 -07002956 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/")
Ed Tanoused398212021-06-09 17:05:54 -07002957 .privileges(redfish::privileges::getLogService)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07002958 .methods(boost::beast::http::verb::get)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07002959 handleLogServicesDumpServiceComputerSystemGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002960}
2961
2962inline void requestRoutesSystemDumpEntryCollection(App& app)
2963{
Ed Tanous22d268c2022-05-19 09:39:07 -07002964 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07002965 .privileges(redfish::privileges::getLogEntryCollection)
Ed Tanous22d268c2022-05-19 09:39:07 -07002966 .methods(boost::beast::http::verb::get)(std::bind_front(
2967 handleLogServicesDumpEntriesCollectionComputerSystemGet,
2968 std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002969}
2970
2971inline void requestRoutesSystemDumpEntry(App& app)
2972{
2973 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002974 "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002975 .privileges(redfish::privileges::getLogEntry)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07002976 .methods(boost::beast::http::verb::get)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07002977 handleLogServicesDumpEntryComputerSystemGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002978
2979 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002980 "/redfish/v1/Systems/<str>/LogServices/Dump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002981 .privileges(redfish::privileges::deleteLogEntry)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07002982 .methods(boost::beast::http::verb::delete_)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07002983 handleLogServicesDumpEntryComputerSystemDelete, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002984}
2985
2986inline void requestRoutesSystemDumpCreate(App& app)
2987{
George Liu0fda0f12021-11-16 10:06:17 +08002988 BMCWEB_ROUTE(
2989 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07002990 "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.CollectDiagnosticData/")
Ed Tanoused398212021-06-09 17:05:54 -07002991 .privileges(redfish::privileges::postLogService)
Ed Tanous22d268c2022-05-19 09:39:07 -07002992 .methods(boost::beast::http::verb::post)(std::bind_front(
2993 handleLogServicesDumpCollectDiagnosticDataComputerSystemPost,
2994 std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002995}
2996
2997inline void requestRoutesSystemDumpClear(App& app)
2998{
George Liu0fda0f12021-11-16 10:06:17 +08002999 BMCWEB_ROUTE(
3000 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003001 "/redfish/v1/Systems/<str>/LogServices/Dump/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07003002 .privileges(redfish::privileges::postLogService)
Claire Weinan6ab9ad52022-08-12 18:20:17 -07003003 .methods(boost::beast::http::verb::post)(std::bind_front(
Ed Tanous22d268c2022-05-19 09:39:07 -07003004 handleLogServicesDumpClearLogComputerSystemPost, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003005}
3006
3007inline void requestRoutesCrashdumpService(App& app)
3008{
3009 // Note: Deviated from redfish privilege registry for GET & HEAD
3010 // method for security reasons.
3011 /**
3012 * Functions triggers appropriate requests on DBus
3013 */
Ed Tanous22d268c2022-05-19 09:39:07 -07003014 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/")
Ed Tanoused398212021-06-09 17:05:54 -07003015 // This is incorrect, should be:
3016 //.privileges(redfish::privileges::getLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07003017 .privileges({{"ConfigureManager"}})
Ed Tanous002d39b2022-05-31 08:59:27 -07003018 .methods(boost::beast::http::verb::get)(
3019 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003020 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3021 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003022 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003023 {
3024 return;
3025 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003026 if (systemName != "system")
3027 {
3028 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3029 systemName);
3030 return;
3031 }
3032
Ed Tanous002d39b2022-05-31 08:59:27 -07003033 // Copy over the static data to include the entries added by
3034 // SubRoute
3035 asyncResp->res.jsonValue["@odata.id"] =
3036 "/redfish/v1/Systems/system/LogServices/Crashdump";
3037 asyncResp->res.jsonValue["@odata.type"] =
3038 "#LogService.v1_2_0.LogService";
3039 asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
3040 asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
V-Sanjana15b89722023-05-11 16:27:03 +05303041 asyncResp->res.jsonValue["Id"] = "Crashdump";
Ed Tanous002d39b2022-05-31 08:59:27 -07003042 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
3043 asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
Tejas Patil7c8c4052021-06-04 17:43:14 +05303044
Ed Tanous002d39b2022-05-31 08:59:27 -07003045 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07003046 redfish::time_utils::getDateTimeOffsetNow();
Ed Tanous002d39b2022-05-31 08:59:27 -07003047 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
3048 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
3049 redfishDateTimeOffset.second;
Tejas Patil7c8c4052021-06-04 17:43:14 +05303050
Ed Tanous002d39b2022-05-31 08:59:27 -07003051 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
Ed Tanousef4c65b2023-04-24 15:28:50 -07003052 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
Ed Tanous002d39b2022-05-31 08:59:27 -07003053 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"]["target"] =
3054 "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.ClearLog";
3055 asyncResp->res.jsonValue["Actions"]["#LogService.CollectDiagnosticData"]
3056 ["target"] =
3057 "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData";
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003058 });
3059}
3060
3061void inline requestRoutesCrashdumpClear(App& app)
3062{
George Liu0fda0f12021-11-16 10:06:17 +08003063 BMCWEB_ROUTE(
3064 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003065 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07003066 // This is incorrect, should be:
3067 //.privileges(redfish::privileges::postLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07003068 .privileges({{"ConfigureComponents"}})
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003069 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003070 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003071 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3072 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003073 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003074 {
3075 return;
3076 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003077 if (systemName != "system")
3078 {
3079 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3080 systemName);
3081 return;
3082 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003083 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003084 [asyncResp](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003085 const std::string&) {
3086 if (ec)
3087 {
3088 messages::internalError(asyncResp->res);
3089 return;
3090 }
3091 messages::success(asyncResp->res);
3092 },
3093 crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll");
3094 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003095}
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07003096
zhanghch058d1b46d2021-04-01 11:18:24 +08003097static void
3098 logCrashdumpEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3099 const std::string& logID, nlohmann::json& logEntryJson)
Jason M. Billse855dd22019-10-08 11:37:48 -07003100{
Johnathan Mantey043a0532020-03-10 17:15:28 -07003101 auto getStoredLogCallback =
Ed Tanousb9d36b42022-02-26 21:42:46 -08003102 [asyncResp, logID,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003103 &logEntryJson](const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08003104 const dbus::utility::DBusPropertiesMap& params) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003105 if (ec)
3106 {
3107 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message();
3108 if (ec.value() ==
3109 boost::system::linux_error::bad_request_descriptor)
Jason M. Bills1ddcf012019-11-26 14:59:21 -08003110 {
Ed Tanous002d39b2022-05-31 08:59:27 -07003111 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Jason M. Bills2b20ef62022-01-06 15:48:07 -08003112 }
3113 else
3114 {
Ed Tanous002d39b2022-05-31 08:59:27 -07003115 messages::internalError(asyncResp->res);
Jason M. Bills2b20ef62022-01-06 15:48:07 -08003116 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003117 return;
3118 }
3119
3120 std::string timestamp{};
3121 std::string filename{};
3122 std::string logfile{};
3123 parseCrashdumpParameters(params, filename, timestamp, logfile);
3124
3125 if (filename.empty() || timestamp.empty())
3126 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003127 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003128 return;
3129 }
3130
3131 std::string crashdumpURI =
3132 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" +
3133 logID + "/" + filename;
Jason M. Bills84afc482022-06-24 12:38:23 -07003134 nlohmann::json::object_t logEntry;
Vijay Lobo9c11a172021-10-07 16:53:16 -05003135 logEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07003136 logEntry["@odata.id"] = boost::urls::format(
3137 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/{}",
3138 logID);
Jason M. Bills84afc482022-06-24 12:38:23 -07003139 logEntry["Name"] = "CPU Crashdump";
3140 logEntry["Id"] = logID;
3141 logEntry["EntryType"] = "Oem";
3142 logEntry["AdditionalDataURI"] = std::move(crashdumpURI);
3143 logEntry["DiagnosticDataType"] = "OEM";
3144 logEntry["OEMDiagnosticDataType"] = "PECICrashdump";
3145 logEntry["Created"] = std::move(timestamp);
Ed Tanous002d39b2022-05-31 08:59:27 -07003146
3147 // If logEntryJson references an array of LogEntry resources
3148 // ('Members' list), then push this as a new entry, otherwise set it
3149 // directly
3150 if (logEntryJson.is_array())
3151 {
3152 logEntryJson.push_back(logEntry);
3153 asyncResp->res.jsonValue["Members@odata.count"] =
3154 logEntryJson.size();
3155 }
3156 else
3157 {
Jason M. Billsd405bb52022-06-24 10:52:05 -07003158 logEntryJson.update(logEntry);
Ed Tanous002d39b2022-05-31 08:59:27 -07003159 }
3160 };
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02003161 sdbusplus::asio::getAllProperties(
3162 *crow::connections::systemBus, crashdumpObject,
3163 crashdumpPath + std::string("/") + logID, crashdumpInterface,
3164 std::move(getStoredLogCallback));
Jason M. Billse855dd22019-10-08 11:37:48 -07003165}
3166
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003167inline void requestRoutesCrashdumpEntryCollection(App& app)
Ed Tanous1da66f72018-07-27 16:13:37 -07003168{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003169 // Note: Deviated from redfish privilege registry for GET & HEAD
3170 // method for security reasons.
Ed Tanous1da66f72018-07-27 16:13:37 -07003171 /**
3172 * Functions triggers appropriate requests on DBus
3173 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003174 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003175 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07003176 // This is incorrect, should be.
3177 //.privileges(redfish::privileges::postLogEntryCollection)
Ed Tanous432a8902021-06-14 15:28:56 -07003178 .privileges({{"ConfigureComponents"}})
Ed Tanous002d39b2022-05-31 08:59:27 -07003179 .methods(boost::beast::http::verb::get)(
3180 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003181 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3182 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003183 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003184 {
3185 return;
3186 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003187 if (systemName != "system")
3188 {
3189 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3190 systemName);
3191 return;
3192 }
3193
George Liu7a1dbc42022-12-07 16:03:22 +08003194 constexpr std::array<std::string_view, 1> interfaces = {
3195 crashdumpInterface};
3196 dbus::utility::getSubTreePaths(
3197 "/", 0, interfaces,
3198 [asyncResp](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003199 const std::vector<std::string>& resp) {
3200 if (ec)
Ed Tanous45ca1b82022-03-25 13:07:27 -07003201 {
Ed Tanous002d39b2022-05-31 08:59:27 -07003202 if (ec.value() !=
3203 boost::system::errc::no_such_file_or_directory)
3204 {
3205 BMCWEB_LOG_DEBUG << "failed to get entries ec: "
3206 << ec.message();
3207 messages::internalError(asyncResp->res);
3208 return;
3209 }
Ed Tanous45ca1b82022-03-25 13:07:27 -07003210 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003211 asyncResp->res.jsonValue["@odata.type"] =
3212 "#LogEntryCollection.LogEntryCollection";
3213 asyncResp->res.jsonValue["@odata.id"] =
3214 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
3215 asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
3216 asyncResp->res.jsonValue["Description"] =
3217 "Collection of Crashdump Entries";
3218 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3219 asyncResp->res.jsonValue["Members@odata.count"] = 0;
Jason M. Bills2b20ef62022-01-06 15:48:07 -08003220
Ed Tanous002d39b2022-05-31 08:59:27 -07003221 for (const std::string& path : resp)
3222 {
3223 const sdbusplus::message::object_path objPath(path);
3224 // Get the log ID
3225 std::string logID = objPath.filename();
3226 if (logID.empty())
3227 {
3228 continue;
3229 }
3230 // Add the log entry to the array
3231 logCrashdumpEntry(asyncResp, logID,
3232 asyncResp->res.jsonValue["Members"]);
3233 }
George Liu7a1dbc42022-12-07 16:03:22 +08003234 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003235 });
3236}
Ed Tanous1da66f72018-07-27 16:13:37 -07003237
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003238inline void requestRoutesCrashdumpEntry(App& app)
Ed Tanous1da66f72018-07-27 16:13:37 -07003239{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003240 // Note: Deviated from redfish privilege registry for GET & HEAD
3241 // method for security reasons.
Ed Tanous1da66f72018-07-27 16:13:37 -07003242
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003243 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07003244 app, "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07003245 // this is incorrect, should be
3246 // .privileges(redfish::privileges::getLogEntry)
Ed Tanous432a8902021-06-14 15:28:56 -07003247 .privileges({{"ConfigureComponents"}})
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003248 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003249 [&app](const crow::Request& req,
3250 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07003251 const std::string& systemName, const std::string& param) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003252 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003253 {
3254 return;
3255 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003256 if (systemName != "system")
3257 {
3258 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3259 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003260 return;
3261 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003262 const std::string& logID = param;
3263 logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
3264 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003265}
Ed Tanous1da66f72018-07-27 16:13:37 -07003266
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003267inline void requestRoutesCrashdumpFile(App& app)
3268{
3269 // Note: Deviated from redfish privilege registry for GET & HEAD
3270 // method for security reasons.
3271 BMCWEB_ROUTE(
3272 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003273 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Entries/<str>/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07003274 .privileges(redfish::privileges::getLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003275 .methods(boost::beast::http::verb::get)(
Nan Zhoua4ce1142022-08-02 18:45:25 +00003276 [](const crow::Request& req,
3277 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07003278 const std::string& systemName, const std::string& logID,
3279 const std::string& fileName) {
Shounak Mitra2a9beee2022-07-20 18:41:30 +00003280 // Do not call getRedfishRoute here since the crashdump file is not a
3281 // Redfish resource.
Ed Tanous22d268c2022-05-19 09:39:07 -07003282
3283 if (systemName != "system")
3284 {
3285 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3286 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003287 return;
3288 }
3289
Ed Tanous002d39b2022-05-31 08:59:27 -07003290 auto getStoredLogCallback =
Ed Tanous39662a32023-02-06 15:09:46 -08003291 [asyncResp, logID, fileName, url(boost::urls::url(req.url()))](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003292 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003293 const std::vector<
3294 std::pair<std::string, dbus::utility::DbusVariantType>>&
3295 resp) {
3296 if (ec)
3297 {
3298 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message();
3299 messages::internalError(asyncResp->res);
3300 return;
3301 }
Jason M. Bills8e6c0992021-03-11 16:26:53 -08003302
Ed Tanous002d39b2022-05-31 08:59:27 -07003303 std::string dbusFilename{};
3304 std::string dbusTimestamp{};
3305 std::string dbusFilepath{};
Jason M. Bills8e6c0992021-03-11 16:26:53 -08003306
Ed Tanous002d39b2022-05-31 08:59:27 -07003307 parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp,
3308 dbusFilepath);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003309
Ed Tanous002d39b2022-05-31 08:59:27 -07003310 if (dbusFilename.empty() || dbusTimestamp.empty() ||
3311 dbusFilepath.empty())
3312 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003313 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003314 return;
3315 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003316
Ed Tanous002d39b2022-05-31 08:59:27 -07003317 // Verify the file name parameter is correct
3318 if (fileName != dbusFilename)
3319 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003320 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003321 return;
3322 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003323
Ed Tanous002d39b2022-05-31 08:59:27 -07003324 if (!std::filesystem::exists(dbusFilepath))
3325 {
Jiaqing Zhao9db4ba22022-10-09 17:24:40 +08003326 messages::resourceNotFound(asyncResp->res, "LogEntry", logID);
Ed Tanous002d39b2022-05-31 08:59:27 -07003327 return;
3328 }
3329 std::ifstream ifs(dbusFilepath, std::ios::in | std::ios::binary);
3330 asyncResp->res.body() =
3331 std::string(std::istreambuf_iterator<char>{ifs}, {});
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003332
Ed Tanous002d39b2022-05-31 08:59:27 -07003333 // Configure this to be a file download when accessed
3334 // from a browser
Ed Tanousd9f6c622022-03-17 09:12:17 -07003335 asyncResp->res.addHeader(
3336 boost::beast::http::field::content_disposition, "attachment");
Ed Tanous002d39b2022-05-31 08:59:27 -07003337 };
Krzysztof Grobelnyd1bde9e2022-09-07 10:40:51 +02003338 sdbusplus::asio::getAllProperties(
3339 *crow::connections::systemBus, crashdumpObject,
3340 crashdumpPath + std::string("/") + logID, crashdumpInterface,
3341 std::move(getStoredLogCallback));
Ed Tanous002d39b2022-05-31 08:59:27 -07003342 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003343}
3344
Jason M. Billsc5a4c822022-01-06 15:51:23 -08003345enum class OEMDiagnosticType
3346{
3347 onDemand,
3348 telemetry,
3349 invalid,
3350};
3351
Ed Tanous26ccae32023-02-16 10:28:44 -08003352inline OEMDiagnosticType getOEMDiagnosticType(std::string_view oemDiagStr)
Jason M. Billsc5a4c822022-01-06 15:51:23 -08003353{
3354 if (oemDiagStr == "OnDemand")
3355 {
3356 return OEMDiagnosticType::onDemand;
3357 }
3358 if (oemDiagStr == "Telemetry")
3359 {
3360 return OEMDiagnosticType::telemetry;
3361 }
3362
3363 return OEMDiagnosticType::invalid;
3364}
3365
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003366inline void requestRoutesCrashdumpCollect(App& app)
3367{
3368 // Note: Deviated from redfish privilege registry for GET & HEAD
3369 // method for security reasons.
George Liu0fda0f12021-11-16 10:06:17 +08003370 BMCWEB_ROUTE(
3371 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003372 "/redfish/v1/Systems/<str>/LogServices/Crashdump/Actions/LogService.CollectDiagnosticData/")
Ed Tanoused398212021-06-09 17:05:54 -07003373 // The below is incorrect; Should be ConfigureManager
3374 //.privileges(redfish::privileges::postLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07003375 .privileges({{"ConfigureComponents"}})
Ed Tanous002d39b2022-05-31 08:59:27 -07003376 .methods(boost::beast::http::verb::post)(
3377 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003378 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3379 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003380 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003381 {
3382 return;
3383 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003384
3385 if (systemName != "system")
3386 {
3387 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3388 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003389 return;
3390 }
3391
Ed Tanous002d39b2022-05-31 08:59:27 -07003392 std::string diagnosticDataType;
3393 std::string oemDiagnosticDataType;
3394 if (!redfish::json_util::readJsonAction(
3395 req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
3396 "OEMDiagnosticDataType", oemDiagnosticDataType))
3397 {
3398 return;
3399 }
3400
3401 if (diagnosticDataType != "OEM")
3402 {
3403 BMCWEB_LOG_ERROR
3404 << "Only OEM DiagnosticDataType supported for Crashdump";
3405 messages::actionParameterValueFormatError(
3406 asyncResp->res, diagnosticDataType, "DiagnosticDataType",
3407 "CollectDiagnosticData");
3408 return;
3409 }
3410
3411 OEMDiagnosticType oemDiagType =
3412 getOEMDiagnosticType(oemDiagnosticDataType);
3413
3414 std::string iface;
3415 std::string method;
3416 std::string taskMatchStr;
3417 if (oemDiagType == OEMDiagnosticType::onDemand)
3418 {
3419 iface = crashdumpOnDemandInterface;
3420 method = "GenerateOnDemandLog";
3421 taskMatchStr = "type='signal',"
3422 "interface='org.freedesktop.DBus.Properties',"
3423 "member='PropertiesChanged',"
3424 "arg0namespace='com.intel.crashdump'";
3425 }
3426 else if (oemDiagType == OEMDiagnosticType::telemetry)
3427 {
3428 iface = crashdumpTelemetryInterface;
3429 method = "GenerateTelemetryLog";
3430 taskMatchStr = "type='signal',"
3431 "interface='org.freedesktop.DBus.Properties',"
3432 "member='PropertiesChanged',"
3433 "arg0namespace='com.intel.crashdump'";
3434 }
3435 else
3436 {
3437 BMCWEB_LOG_ERROR << "Unsupported OEMDiagnosticDataType: "
3438 << oemDiagnosticDataType;
3439 messages::actionParameterValueFormatError(
3440 asyncResp->res, oemDiagnosticDataType, "OEMDiagnosticDataType",
3441 "CollectDiagnosticData");
3442 return;
3443 }
3444
3445 auto collectCrashdumpCallback =
3446 [asyncResp, payload(task::Payload(req)),
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003447 taskMatchStr](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07003448 const std::string&) mutable {
3449 if (ec)
Ed Tanous45ca1b82022-03-25 13:07:27 -07003450 {
Ed Tanous002d39b2022-05-31 08:59:27 -07003451 if (ec.value() == boost::system::errc::operation_not_supported)
3452 {
3453 messages::resourceInStandby(asyncResp->res);
3454 }
3455 else if (ec.value() ==
3456 boost::system::errc::device_or_resource_busy)
3457 {
3458 messages::serviceTemporarilyUnavailable(asyncResp->res,
3459 "60");
3460 }
3461 else
3462 {
3463 messages::internalError(asyncResp->res);
3464 }
Ed Tanous45ca1b82022-03-25 13:07:27 -07003465 return;
3466 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003467 std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003468 [](const boost::system::error_code& err, sdbusplus::message_t&,
Ed Tanous002d39b2022-05-31 08:59:27 -07003469 const std::shared_ptr<task::TaskData>& taskData) {
3470 if (!err)
3471 {
3472 taskData->messages.emplace_back(messages::taskCompletedOK(
3473 std::to_string(taskData->index)));
3474 taskData->state = "Completed";
3475 }
3476 return task::completed;
3477 },
3478 taskMatchStr);
Ed Tanous1da66f72018-07-27 16:13:37 -07003479
Ed Tanous002d39b2022-05-31 08:59:27 -07003480 task->startTimer(std::chrono::minutes(5));
3481 task->populateResp(asyncResp->res);
3482 task->payload.emplace(std::move(payload));
3483 };
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003484
Ed Tanous002d39b2022-05-31 08:59:27 -07003485 crow::connections::systemBus->async_method_call(
3486 std::move(collectCrashdumpCallback), crashdumpObject, crashdumpPath,
3487 iface, method);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003488 });
3489}
Kenny L. Ku6eda7682020-06-19 09:48:36 -07003490
Andrew Geisslercb92c032018-08-17 07:56:14 -07003491/**
3492 * DBusLogServiceActionsClear class supports POST method for ClearLog action.
3493 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003494inline void requestRoutesDBusLogServiceActionsClear(App& app)
Andrew Geisslercb92c032018-08-17 07:56:14 -07003495{
Andrew Geisslercb92c032018-08-17 07:56:14 -07003496 /**
3497 * Function handles POST method request.
3498 * The Clear Log actions does not require any parameter.The action deletes
3499 * all entries found in the Entries collection for this Log Service.
3500 */
Andrew Geisslercb92c032018-08-17 07:56:14 -07003501
George Liu0fda0f12021-11-16 10:06:17 +08003502 BMCWEB_ROUTE(
3503 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003504 "/redfish/v1/Systems/<str>/LogServices/EventLog/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07003505 .privileges(redfish::privileges::postLogService)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003506 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003507 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003508 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3509 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003510 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003511 {
3512 return;
3513 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003514 if (systemName != "system")
3515 {
3516 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3517 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003518 return;
3519 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003520 BMCWEB_LOG_DEBUG << "Do delete all entries.";
Andrew Geisslercb92c032018-08-17 07:56:14 -07003521
Ed Tanous002d39b2022-05-31 08:59:27 -07003522 // Process response from Logging service.
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003523 auto respHandler = [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003524 BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done";
3525 if (ec)
3526 {
3527 // TODO Handle for specific error code
3528 BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec;
3529 asyncResp->res.result(
3530 boost::beast::http::status::internal_server_error);
3531 return;
3532 }
Andrew Geisslercb92c032018-08-17 07:56:14 -07003533
Ed Tanous002d39b2022-05-31 08:59:27 -07003534 asyncResp->res.result(boost::beast::http::status::no_content);
3535 };
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003536
Ed Tanous002d39b2022-05-31 08:59:27 -07003537 // Make call to Logging service to request Clear Log
3538 crow::connections::systemBus->async_method_call(
3539 respHandler, "xyz.openbmc_project.Logging",
3540 "/xyz/openbmc_project/logging",
3541 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3542 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003543}
ZhikuiRena3316fc2020-01-29 14:58:08 -08003544
3545/****************************************************
3546 * Redfish PostCode interfaces
3547 * using DBUS interface: getPostCodesTS
3548 ******************************************************/
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003549inline void requestRoutesPostCodesLogService(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003550{
Ed Tanous22d268c2022-05-19 09:39:07 -07003551 BMCWEB_ROUTE(app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/")
Ed Tanoused398212021-06-09 17:05:54 -07003552 .privileges(redfish::privileges::getLogService)
Ed Tanous002d39b2022-05-31 08:59:27 -07003553 .methods(boost::beast::http::verb::get)(
3554 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003555 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3556 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003557 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003558 {
3559 return;
3560 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003561 if (systemName != "system")
3562 {
3563 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3564 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003565 return;
3566 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003567 asyncResp->res.jsonValue["@odata.id"] =
3568 "/redfish/v1/Systems/system/LogServices/PostCodes";
3569 asyncResp->res.jsonValue["@odata.type"] =
3570 "#LogService.v1_1_0.LogService";
3571 asyncResp->res.jsonValue["Name"] = "POST Code Log Service";
3572 asyncResp->res.jsonValue["Description"] = "POST Code Log Service";
Ed Tanoused34a4a2023-02-08 15:43:27 -08003573 asyncResp->res.jsonValue["Id"] = "PostCodes";
Ed Tanous002d39b2022-05-31 08:59:27 -07003574 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
3575 asyncResp->res.jsonValue["Entries"]["@odata.id"] =
3576 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
Tejas Patil7c8c4052021-06-04 17:43:14 +05303577
Ed Tanous002d39b2022-05-31 08:59:27 -07003578 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07003579 redfish::time_utils::getDateTimeOffsetNow();
Ed Tanous002d39b2022-05-31 08:59:27 -07003580 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
3581 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
3582 redfishDateTimeOffset.second;
Tejas Patil7c8c4052021-06-04 17:43:14 +05303583
Ed Tanous002d39b2022-05-31 08:59:27 -07003584 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
3585 {"target",
3586 "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/LogService.ClearLog"}};
George Liu0fda0f12021-11-16 10:06:17 +08003587 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003588}
ZhikuiRena3316fc2020-01-29 14:58:08 -08003589
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003590inline void requestRoutesPostCodesClear(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003591{
George Liu0fda0f12021-11-16 10:06:17 +08003592 BMCWEB_ROUTE(
3593 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003594 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Actions/LogService.ClearLog/")
Ed Tanoused398212021-06-09 17:05:54 -07003595 // The following privilege is incorrect; It should be ConfigureManager
3596 //.privileges(redfish::privileges::postLogService)
Ed Tanous432a8902021-06-14 15:28:56 -07003597 .privileges({{"ConfigureComponents"}})
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003598 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003599 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003600 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3601 const std::string& systemName) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003602 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003603 {
3604 return;
3605 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003606 if (systemName != "system")
3607 {
3608 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3609 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003610 return;
3611 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003612 BMCWEB_LOG_DEBUG << "Do delete all postcodes entries.";
ZhikuiRena3316fc2020-01-29 14:58:08 -08003613
Ed Tanous002d39b2022-05-31 08:59:27 -07003614 // Make call to post-code service to request clear all
3615 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003616 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003617 if (ec)
3618 {
3619 // TODO Handle for specific error code
3620 BMCWEB_LOG_ERROR << "doClearPostCodes resp_handler got error "
3621 << ec;
3622 asyncResp->res.result(
3623 boost::beast::http::status::internal_server_error);
3624 messages::internalError(asyncResp->res);
3625 return;
3626 }
3627 },
3628 "xyz.openbmc_project.State.Boot.PostCode0",
3629 "/xyz/openbmc_project/State/Boot/PostCode0",
3630 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3631 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003632}
ZhikuiRena3316fc2020-01-29 14:58:08 -08003633
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003634/**
3635 * @brief Parse post code ID and get the current value and index value
3636 * eg: postCodeID=B1-2, currentValue=1, index=2
3637 *
3638 * @param[in] postCodeID Post Code ID
3639 * @param[out] currentValue Current value
3640 * @param[out] index Index value
3641 *
3642 * @return bool true if the parsing is successful, false the parsing fails
3643 */
3644inline static bool parsePostCode(const std::string& postCodeID,
3645 uint64_t& currentValue, uint16_t& index)
3646{
3647 std::vector<std::string> split;
Ed Tanous50ebd4a2023-01-19 19:03:17 -08003648 bmcweb::split(split, postCodeID, '-');
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003649 if (split.size() != 2 || split[0].length() < 2 || split[0].front() != 'B')
3650 {
3651 return false;
3652 }
3653
Patrick Williams84396af2023-05-11 11:47:45 -05003654 auto start = std::next(split[0].begin());
3655 auto end = split[0].end();
3656 auto [ptrIndex, ecIndex] = std::from_chars(&*start, &*end, index);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003657
Patrick Williams84396af2023-05-11 11:47:45 -05003658 if (ptrIndex != &*end || ecIndex != std::errc())
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003659 {
3660 return false;
3661 }
3662
Patrick Williams84396af2023-05-11 11:47:45 -05003663 start = split[1].begin();
3664 end = split[1].end();
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003665
Patrick Williams84396af2023-05-11 11:47:45 -05003666 auto [ptrValue, ecValue] = std::from_chars(&*start, &*end, currentValue);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003667
Patrick Williams84396af2023-05-11 11:47:45 -05003668 return ptrValue == &*end && ecValue == std::errc();
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003669}
3670
3671static bool fillPostCodeEntry(
Ed Tanousac106bf2023-06-07 09:24:59 -07003672 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303673 const boost::container::flat_map<
3674 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>& postcode,
ZhikuiRena3316fc2020-01-29 14:58:08 -08003675 const uint16_t bootIndex, const uint64_t codeIndex = 0,
3676 const uint64_t skip = 0, const uint64_t top = 0)
3677{
3678 // Get the Message from the MessageRegistry
Ed Tanousfffb8c12022-02-07 23:53:03 -08003679 const registries::Message* message =
3680 registries::getMessage("OpenBMC.0.2.BIOSPOSTCode");
ZhikuiRena3316fc2020-01-29 14:58:08 -08003681
3682 uint64_t currentCodeIndex = 0;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003683 uint64_t firstCodeTimeUs = 0;
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303684 for (const std::pair<uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
3685 code : postcode)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003686 {
3687 currentCodeIndex++;
3688 std::string postcodeEntryID =
3689 "B" + std::to_string(bootIndex) + "-" +
3690 std::to_string(currentCodeIndex); // 1 based index in EntryID string
3691
3692 uint64_t usecSinceEpoch = code.first;
3693 uint64_t usTimeOffset = 0;
3694
3695 if (1 == currentCodeIndex)
3696 { // already incremented
3697 firstCodeTimeUs = code.first;
3698 }
3699 else
3700 {
3701 usTimeOffset = code.first - firstCodeTimeUs;
3702 }
3703
3704 // skip if no specific codeIndex is specified and currentCodeIndex does
3705 // not fall between top and skip
3706 if ((codeIndex == 0) &&
3707 (currentCodeIndex <= skip || currentCodeIndex > top))
3708 {
3709 continue;
3710 }
3711
Gunnar Mills4e0453b2020-07-08 14:00:30 -05003712 // skip if a specific codeIndex is specified and does not match the
ZhikuiRena3316fc2020-01-29 14:58:08 -08003713 // currentIndex
3714 if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
3715 {
3716 // This is done for simplicity. 1st entry is needed to calculate
3717 // time offset. To improve efficiency, one can get to the entry
3718 // directly (possibly with flatmap's nth method)
3719 continue;
3720 }
3721
3722 // currentCodeIndex is within top and skip or equal to specified code
3723 // index
3724
3725 // Get the Created time from the timestamp
3726 std::string entryTimeStr;
Konstantin Aladyshev2a025612023-02-15 11:52:58 +03003727 entryTimeStr = redfish::time_utils::getDateTimeUintUs(usecSinceEpoch);
ZhikuiRena3316fc2020-01-29 14:58:08 -08003728
3729 // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
3730 std::ostringstream hexCode;
3731 hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303732 << std::get<0>(code.second);
ZhikuiRena3316fc2020-01-29 14:58:08 -08003733 std::ostringstream timeOffsetStr;
3734 // Set Fixed -Point Notation
3735 timeOffsetStr << std::fixed;
3736 // Set precision to 4 digits
3737 timeOffsetStr << std::setprecision(4);
3738 // Add double to stream
3739 timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003740
Ed Tanous1e6deaf2022-02-17 11:32:37 -08003741 std::string bootIndexStr = std::to_string(bootIndex);
3742 std::string timeOffsetString = timeOffsetStr.str();
3743 std::string hexCodeStr = hexCode.str();
3744
3745 std::array<std::string_view, 3> messageArgs = {
3746 bootIndexStr, timeOffsetString, hexCodeStr};
3747
3748 std::string msg =
3749 redfish::registries::fillMessageArgs(messageArgs, message->message);
3750 if (msg.empty())
ZhikuiRena3316fc2020-01-29 14:58:08 -08003751 {
Ed Tanous1e6deaf2022-02-17 11:32:37 -08003752 messages::internalError(asyncResp->res);
3753 return false;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003754 }
3755
Tim Leed4342a92020-04-27 11:47:58 +08003756 // Get Severity template from message registry
3757 std::string severity;
3758 if (message != nullptr)
3759 {
Ed Tanous5f2b84e2022-02-08 00:41:53 -08003760 severity = message->messageSeverity;
Tim Leed4342a92020-04-27 11:47:58 +08003761 }
3762
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003763 // Format entry
3764 nlohmann::json::object_t bmcLogEntry;
Vijay Lobo9c11a172021-10-07 16:53:16 -05003765 bmcLogEntry["@odata.type"] = "#LogEntry.v1_9_0.LogEntry";
Ed Tanousef4c65b2023-04-24 15:28:50 -07003766 bmcLogEntry["@odata.id"] = boost::urls::format(
3767 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/{}",
3768 postcodeEntryID);
Jason M. Bills84afc482022-06-24 12:38:23 -07003769 bmcLogEntry["Name"] = "POST Code Log Entry";
3770 bmcLogEntry["Id"] = postcodeEntryID;
3771 bmcLogEntry["Message"] = std::move(msg);
3772 bmcLogEntry["MessageId"] = "OpenBMC.0.2.BIOSPOSTCode";
Ed Tanous1e6deaf2022-02-17 11:32:37 -08003773 bmcLogEntry["MessageArgs"] = messageArgs;
Jason M. Bills84afc482022-06-24 12:38:23 -07003774 bmcLogEntry["EntryType"] = "Event";
3775 bmcLogEntry["Severity"] = std::move(severity);
3776 bmcLogEntry["Created"] = entryTimeStr;
George Liu647b3cd2021-07-05 12:43:56 +08003777 if (!std::get<std::vector<uint8_t>>(code.second).empty())
3778 {
3779 bmcLogEntry["AdditionalDataURI"] =
3780 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/" +
3781 postcodeEntryID + "/attachment";
3782 }
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003783
3784 // codeIndex is only specified when querying single entry, return only
3785 // that entry in this case
3786 if (codeIndex != 0)
3787 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003788 asyncResp->res.jsonValue.update(bmcLogEntry);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003789 return true;
3790 }
3791
Ed Tanousac106bf2023-06-07 09:24:59 -07003792 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
Patrick Williamsb2ba3072023-05-12 10:27:39 -05003793 logEntryArray.emplace_back(std::move(bmcLogEntry));
ZhikuiRena3316fc2020-01-29 14:58:08 -08003794 }
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003795
3796 // Return value is always false when querying multiple entries
3797 return false;
ZhikuiRena3316fc2020-01-29 14:58:08 -08003798}
3799
Ed Tanousac106bf2023-06-07 09:24:59 -07003800static void
3801 getPostCodeForEntry(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3802 const std::string& entryId)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003803{
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003804 uint16_t bootIndex = 0;
3805 uint64_t codeIndex = 0;
3806 if (!parsePostCode(entryId, codeIndex, bootIndex))
3807 {
3808 // Requested ID was not found
Ed Tanousac106bf2023-06-07 09:24:59 -07003809 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003810 return;
3811 }
3812
3813 if (bootIndex == 0 || codeIndex == 0)
3814 {
3815 // 0 is an invalid index
Ed Tanousac106bf2023-06-07 09:24:59 -07003816 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003817 return;
3818 }
3819
ZhikuiRena3316fc2020-01-29 14:58:08 -08003820 crow::connections::systemBus->async_method_call(
Ed Tanousac106bf2023-06-07 09:24:59 -07003821 [asyncResp, entryId, bootIndex,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003822 codeIndex](const boost::system::error_code& ec,
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303823 const boost::container::flat_map<
3824 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
3825 postcode) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003826 if (ec)
3827 {
3828 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
Ed Tanousac106bf2023-06-07 09:24:59 -07003829 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07003830 return;
3831 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003832
Ed Tanous002d39b2022-05-31 08:59:27 -07003833 if (postcode.empty())
3834 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003835 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Ed Tanous002d39b2022-05-31 08:59:27 -07003836 return;
3837 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003838
Ed Tanousac106bf2023-06-07 09:24:59 -07003839 if (!fillPostCodeEntry(asyncResp, postcode, bootIndex, codeIndex))
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003840 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003841 messages::resourceNotFound(asyncResp->res, "LogEntry", entryId);
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08003842 return;
3843 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003844 },
Jonathan Doman15124762021-01-07 17:54:17 -08003845 "xyz.openbmc_project.State.Boot.PostCode0",
3846 "/xyz/openbmc_project/State/Boot/PostCode0",
ZhikuiRena3316fc2020-01-29 14:58:08 -08003847 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3848 bootIndex);
3849}
3850
Ed Tanousac106bf2023-06-07 09:24:59 -07003851static void
3852 getPostCodeForBoot(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3853 const uint16_t bootIndex, const uint16_t bootCount,
3854 const uint64_t entryCount, size_t skip, size_t top)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003855{
3856 crow::connections::systemBus->async_method_call(
Ed Tanousac106bf2023-06-07 09:24:59 -07003857 [asyncResp, bootIndex, bootCount, entryCount, skip,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08003858 top](const boost::system::error_code& ec,
Manojkiran Eda6c9a2792021-02-27 14:25:04 +05303859 const boost::container::flat_map<
3860 uint64_t, std::tuple<uint64_t, std::vector<uint8_t>>>&
3861 postcode) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003862 if (ec)
3863 {
3864 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
Ed Tanousac106bf2023-06-07 09:24:59 -07003865 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07003866 return;
3867 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003868
Ed Tanous002d39b2022-05-31 08:59:27 -07003869 uint64_t endCount = entryCount;
3870 if (!postcode.empty())
3871 {
3872 endCount = entryCount + postcode.size();
Ed Tanous3648c8b2022-07-25 13:39:59 -07003873 if (skip < endCount && (top + skip) > entryCount)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003874 {
Patrick Williams89492a12023-05-10 07:51:34 -05003875 uint64_t thisBootSkip = std::max(static_cast<uint64_t>(skip),
3876 entryCount) -
3877 entryCount;
Ed Tanous002d39b2022-05-31 08:59:27 -07003878 uint64_t thisBootTop =
Ed Tanous3648c8b2022-07-25 13:39:59 -07003879 std::min(static_cast<uint64_t>(top + skip), endCount) -
3880 entryCount;
Ed Tanous002d39b2022-05-31 08:59:27 -07003881
Ed Tanousac106bf2023-06-07 09:24:59 -07003882 fillPostCodeEntry(asyncResp, postcode, bootIndex, 0,
3883 thisBootSkip, thisBootTop);
ZhikuiRena3316fc2020-01-29 14:58:08 -08003884 }
Ed Tanousac106bf2023-06-07 09:24:59 -07003885 asyncResp->res.jsonValue["Members@odata.count"] = endCount;
Ed Tanous002d39b2022-05-31 08:59:27 -07003886 }
3887
3888 // continue to previous bootIndex
3889 if (bootIndex < bootCount)
3890 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003891 getPostCodeForBoot(asyncResp, static_cast<uint16_t>(bootIndex + 1),
Ed Tanous002d39b2022-05-31 08:59:27 -07003892 bootCount, endCount, skip, top);
3893 }
Jiaqing Zhao81584ab2022-07-28 00:33:45 +08003894 else if (skip + top < endCount)
Ed Tanous002d39b2022-05-31 08:59:27 -07003895 {
Ed Tanousac106bf2023-06-07 09:24:59 -07003896 asyncResp->res.jsonValue["Members@odata.nextLink"] =
Ed Tanous002d39b2022-05-31 08:59:27 -07003897 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries?$skip=" +
3898 std::to_string(skip + top);
3899 }
ZhikuiRena3316fc2020-01-29 14:58:08 -08003900 },
Jonathan Doman15124762021-01-07 17:54:17 -08003901 "xyz.openbmc_project.State.Boot.PostCode0",
3902 "/xyz/openbmc_project/State/Boot/PostCode0",
ZhikuiRena3316fc2020-01-29 14:58:08 -08003903 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3904 bootIndex);
3905}
3906
zhanghch058d1b46d2021-04-01 11:18:24 +08003907static void
Ed Tanousac106bf2023-06-07 09:24:59 -07003908 getCurrentBootNumber(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous3648c8b2022-07-25 13:39:59 -07003909 size_t skip, size_t top)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003910{
3911 uint64_t entryCount = 0;
Jonathan Doman1e1e5982021-06-11 09:36:17 -07003912 sdbusplus::asio::getProperty<uint16_t>(
3913 *crow::connections::systemBus,
3914 "xyz.openbmc_project.State.Boot.PostCode0",
3915 "/xyz/openbmc_project/State/Boot/PostCode0",
3916 "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount",
Ed Tanousac106bf2023-06-07 09:24:59 -07003917 [asyncResp, entryCount, skip, top](const boost::system::error_code& ec,
3918 const uint16_t bootCount) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003919 if (ec)
3920 {
3921 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
Ed Tanousac106bf2023-06-07 09:24:59 -07003922 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07003923 return;
3924 }
Ed Tanousac106bf2023-06-07 09:24:59 -07003925 getPostCodeForBoot(asyncResp, 1, bootCount, entryCount, skip, top);
Jonathan Doman1e1e5982021-06-11 09:36:17 -07003926 });
ZhikuiRena3316fc2020-01-29 14:58:08 -08003927}
3928
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003929inline void requestRoutesPostCodesEntryCollection(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003930{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003931 BMCWEB_ROUTE(app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003932 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/")
Ed Tanoused398212021-06-09 17:05:54 -07003933 .privileges(redfish::privileges::getLogEntryCollection)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003934 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003935 [&app](const crow::Request& req,
Ed Tanous22d268c2022-05-19 09:39:07 -07003936 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
3937 const std::string& systemName) {
Ed Tanous002d39b2022-05-31 08:59:27 -07003938 query_param::QueryCapabilities capabilities = {
3939 .canDelegateTop = true,
3940 .canDelegateSkip = true,
3941 };
3942 query_param::Query delegatedQuery;
3943 if (!redfish::setUpRedfishRouteWithDelegation(
Carson Labrado3ba00072022-06-06 19:40:56 +00003944 app, req, asyncResp, delegatedQuery, capabilities))
Ed Tanous002d39b2022-05-31 08:59:27 -07003945 {
3946 return;
3947 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003948
3949 if (systemName != "system")
3950 {
3951 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3952 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003953 return;
3954 }
Ed Tanous002d39b2022-05-31 08:59:27 -07003955 asyncResp->res.jsonValue["@odata.type"] =
3956 "#LogEntryCollection.LogEntryCollection";
3957 asyncResp->res.jsonValue["@odata.id"] =
3958 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
3959 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3960 asyncResp->res.jsonValue["Description"] =
3961 "Collection of POST Code Log Entries";
3962 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3963 asyncResp->res.jsonValue["Members@odata.count"] = 0;
Ed Tanous3648c8b2022-07-25 13:39:59 -07003964 size_t skip = delegatedQuery.skip.value_or(0);
Jiaqing Zhao5143f7a2022-07-22 09:33:33 +08003965 size_t top = delegatedQuery.top.value_or(query_param::Query::maxTop);
Ed Tanous3648c8b2022-07-25 13:39:59 -07003966 getCurrentBootNumber(asyncResp, skip, top);
Ed Tanous002d39b2022-05-31 08:59:27 -07003967 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003968}
ZhikuiRena3316fc2020-01-29 14:58:08 -08003969
George Liu647b3cd2021-07-05 12:43:56 +08003970inline void requestRoutesPostCodesEntryAdditionalData(App& app)
3971{
George Liu0fda0f12021-11-16 10:06:17 +08003972 BMCWEB_ROUTE(
3973 app,
Ed Tanous22d268c2022-05-19 09:39:07 -07003974 "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/attachment/")
George Liu647b3cd2021-07-05 12:43:56 +08003975 .privileges(redfish::privileges::getLogEntry)
3976 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003977 [&app](const crow::Request& req,
3978 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07003979 const std::string& systemName,
Ed Tanous45ca1b82022-03-25 13:07:27 -07003980 const std::string& postCodeID) {
Carson Labrado3ba00072022-06-06 19:40:56 +00003981 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07003982 {
3983 return;
3984 }
Matt Spinler72e21372023-04-19 12:53:33 -05003985 if (!http_helpers::isContentTypeAllowed(
Ed Tanous99351cd2022-08-07 16:42:51 -07003986 req.getHeaderValue("Accept"),
Ed Tanous4a0e1a02022-09-21 15:28:04 -07003987 http_helpers::ContentType::OctetStream, true))
Ed Tanous002d39b2022-05-31 08:59:27 -07003988 {
3989 asyncResp->res.result(boost::beast::http::status::bad_request);
3990 return;
3991 }
Ed Tanous22d268c2022-05-19 09:39:07 -07003992 if (systemName != "system")
3993 {
3994 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
3995 systemName);
Ed Tanous22d268c2022-05-19 09:39:07 -07003996 return;
3997 }
George Liu647b3cd2021-07-05 12:43:56 +08003998
Ed Tanous002d39b2022-05-31 08:59:27 -07003999 uint64_t currentValue = 0;
4000 uint16_t index = 0;
4001 if (!parsePostCode(postCodeID, currentValue, index))
4002 {
4003 messages::resourceNotFound(asyncResp->res, "LogEntry", postCodeID);
4004 return;
4005 }
George Liu647b3cd2021-07-05 12:43:56 +08004006
Ed Tanous002d39b2022-05-31 08:59:27 -07004007 crow::connections::systemBus->async_method_call(
4008 [asyncResp, postCodeID, currentValue](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08004009 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07004010 const std::vector<std::tuple<uint64_t, std::vector<uint8_t>>>&
4011 postcodes) {
4012 if (ec.value() == EBADR)
4013 {
4014 messages::resourceNotFound(asyncResp->res, "LogEntry",
4015 postCodeID);
4016 return;
4017 }
4018 if (ec)
4019 {
4020 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
4021 messages::internalError(asyncResp->res);
4022 return;
4023 }
George Liu647b3cd2021-07-05 12:43:56 +08004024
Ed Tanous002d39b2022-05-31 08:59:27 -07004025 size_t value = static_cast<size_t>(currentValue) - 1;
4026 if (value == std::string::npos || postcodes.size() < currentValue)
4027 {
Gunnar Millsa7405d52023-02-22 13:23:23 -06004028 BMCWEB_LOG_WARNING << "Wrong currentValue value";
Ed Tanous002d39b2022-05-31 08:59:27 -07004029 messages::resourceNotFound(asyncResp->res, "LogEntry",
4030 postCodeID);
4031 return;
4032 }
George Liu647b3cd2021-07-05 12:43:56 +08004033
Ed Tanous002d39b2022-05-31 08:59:27 -07004034 const auto& [tID, c] = postcodes[value];
4035 if (c.empty())
4036 {
Gunnar Millsa7405d52023-02-22 13:23:23 -06004037 BMCWEB_LOG_WARNING << "No found post code data";
Ed Tanous002d39b2022-05-31 08:59:27 -07004038 messages::resourceNotFound(asyncResp->res, "LogEntry",
4039 postCodeID);
4040 return;
4041 }
4042 // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
4043 const char* d = reinterpret_cast<const char*>(c.data());
4044 std::string_view strData(d, c.size());
George Liu647b3cd2021-07-05 12:43:56 +08004045
Ed Tanousd9f6c622022-03-17 09:12:17 -07004046 asyncResp->res.addHeader(boost::beast::http::field::content_type,
Ed Tanous002d39b2022-05-31 08:59:27 -07004047 "application/octet-stream");
Ed Tanousd9f6c622022-03-17 09:12:17 -07004048 asyncResp->res.addHeader(
4049 boost::beast::http::field::content_transfer_encoding, "Base64");
Ed Tanous002d39b2022-05-31 08:59:27 -07004050 asyncResp->res.body() = crow::utility::base64encode(strData);
4051 },
4052 "xyz.openbmc_project.State.Boot.PostCode0",
4053 "/xyz/openbmc_project/State/Boot/PostCode0",
4054 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodes", index);
4055 });
George Liu647b3cd2021-07-05 12:43:56 +08004056}
4057
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004058inline void requestRoutesPostCodesEntry(App& app)
ZhikuiRena3316fc2020-01-29 14:58:08 -08004059{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004060 BMCWEB_ROUTE(
Ed Tanous22d268c2022-05-19 09:39:07 -07004061 app, "/redfish/v1/Systems/<str>/LogServices/PostCodes/Entries/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07004062 .privileges(redfish::privileges::getLogEntry)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004063 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07004064 [&app](const crow::Request& req,
4065 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous22d268c2022-05-19 09:39:07 -07004066 const std::string& systemName, const std::string& targetID) {
Carson Labrado3ba00072022-06-06 19:40:56 +00004067 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07004068 {
4069 return;
4070 }
Ed Tanous22d268c2022-05-19 09:39:07 -07004071 if (systemName != "system")
4072 {
4073 messages::resourceNotFound(asyncResp->res, "ComputerSystem",
4074 systemName);
4075 return;
4076 }
4077
Jiaqing Zhao6f284d22022-10-10 15:56:45 +08004078 getPostCodeForEntry(asyncResp, targetID);
Ed Tanous002d39b2022-05-31 08:59:27 -07004079 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07004080}
ZhikuiRena3316fc2020-01-29 14:58:08 -08004081
Ed Tanous1da66f72018-07-27 16:13:37 -07004082} // namespace redfish