blob: 39f1de58bc3d75c947f9e6979c78da662bb17e68 [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
18#include "node.hpp"
Jason M. Bills4851d452019-03-28 11:27:48 -070019#include "registries.hpp"
20#include "registries/base_message_registry.hpp"
21#include "registries/openbmc_message_registry.hpp"
James Feist46229572020-02-19 15:11:58 -080022#include "task.hpp"
Ed Tanous1da66f72018-07-27 16:13:37 -070023
Jason M. Billse1f26342018-07-18 12:12:00 -070024#include <systemd/sd-journal.h>
25
Jason M. Bills4851d452019-03-28 11:27:48 -070026#include <boost/algorithm/string/split.hpp>
27#include <boost/beast/core/span.hpp>
Ed Tanous1da66f72018-07-27 16:13:37 -070028#include <boost/container/flat_map.hpp>
Jason M. Bills1ddcf012019-11-26 14:59:21 -080029#include <boost/system/linux_error.hpp>
Andrew Geisslercb92c032018-08-17 07:56:14 -070030#include <error_messages.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050031
James Feist4418c7f2019-04-15 11:09:15 -070032#include <filesystem>
Jason M. Billscd225da2019-05-08 15:31:57 -070033#include <string_view>
Ed Tanousabf2add2019-01-22 16:40:12 -080034#include <variant>
Ed Tanous1da66f72018-07-27 16:13:37 -070035
36namespace redfish
37{
38
Gunnar Mills1214b7e2020-06-04 10:11:30 -050039constexpr char const* crashdumpObject = "com.intel.crashdump";
40constexpr char const* crashdumpPath = "/com/intel/crashdump";
Gunnar Mills1214b7e2020-06-04 10:11:30 -050041constexpr char const* crashdumpInterface = "com.intel.crashdump";
42constexpr char const* deleteAllInterface =
Jason M. Bills5b61b5e2019-10-16 10:59:02 -070043 "xyz.openbmc_project.Collection.DeleteAll";
Gunnar Mills1214b7e2020-06-04 10:11:30 -050044constexpr char const* crashdumpOnDemandInterface =
Jason M. Bills424c4172019-03-21 13:50:33 -070045 "com.intel.crashdump.OnDemand";
Gunnar Mills1214b7e2020-06-04 10:11:30 -050046constexpr char const* crashdumpRawPECIInterface =
Jason M. Bills424c4172019-03-21 13:50:33 -070047 "com.intel.crashdump.SendRawPeci";
Kenny L. Ku6eda7682020-06-19 09:48:36 -070048constexpr char const* crashdumpTelemetryInterface =
49 "com.intel.crashdump.Telemetry";
Ed Tanous1da66f72018-07-27 16:13:37 -070050
Jason M. Bills4851d452019-03-28 11:27:48 -070051namespace message_registries
52{
Gunnar Mills1214b7e2020-06-04 10:11:30 -050053static const Message* getMessageFromRegistry(
54 const std::string& messageKey,
Jason M. Bills4851d452019-03-28 11:27:48 -070055 const boost::beast::span<const MessageEntry> registry)
56{
57 boost::beast::span<const MessageEntry>::const_iterator messageIt =
58 std::find_if(registry.cbegin(), registry.cend(),
Gunnar Mills1214b7e2020-06-04 10:11:30 -050059 [&messageKey](const MessageEntry& messageEntry) {
Jason M. Bills4851d452019-03-28 11:27:48 -070060 return !std::strcmp(messageEntry.first,
61 messageKey.c_str());
62 });
63 if (messageIt != registry.cend())
64 {
65 return &messageIt->second;
66 }
67
68 return nullptr;
69}
70
Gunnar Mills1214b7e2020-06-04 10:11:30 -050071static const Message* getMessage(const std::string_view& messageID)
Jason M. Bills4851d452019-03-28 11:27:48 -070072{
73 // Redfish MessageIds are in the form
74 // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find
75 // the right Message
76 std::vector<std::string> fields;
77 fields.reserve(4);
78 boost::split(fields, messageID, boost::is_any_of("."));
Gunnar Mills1214b7e2020-06-04 10:11:30 -050079 std::string& registryName = fields[0];
80 std::string& messageKey = fields[3];
Jason M. Bills4851d452019-03-28 11:27:48 -070081
82 // Find the right registry and check it for the MessageKey
83 if (std::string(base::header.registryPrefix) == registryName)
84 {
85 return getMessageFromRegistry(
86 messageKey, boost::beast::span<const MessageEntry>(base::registry));
87 }
88 if (std::string(openbmc::header.registryPrefix) == registryName)
89 {
90 return getMessageFromRegistry(
91 messageKey,
92 boost::beast::span<const MessageEntry>(openbmc::registry));
93 }
94 return nullptr;
95}
96} // namespace message_registries
97
James Feistf6150402019-01-08 10:36:20 -080098namespace fs = std::filesystem;
Ed Tanous1da66f72018-07-27 16:13:37 -070099
Andrew Geisslercb92c032018-08-17 07:56:14 -0700100using GetManagedPropertyType = boost::container::flat_map<
Patrick Williams19bd78d2020-05-13 17:38:24 -0500101 std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t,
102 int32_t, uint32_t, int64_t, uint64_t, double>>;
Andrew Geisslercb92c032018-08-17 07:56:14 -0700103
104using GetManagedObjectsType = boost::container::flat_map<
105 sdbusplus::message::object_path,
106 boost::container::flat_map<std::string, GetManagedPropertyType>>;
107
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500108inline std::string translateSeverityDbusToRedfish(const std::string& s)
Andrew Geisslercb92c032018-08-17 07:56:14 -0700109{
Ed Tanousd4d25792020-09-29 15:15:03 -0700110 if ((s == "xyz.openbmc_project.Logging.Entry.Level.Alert") ||
111 (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") ||
112 (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") ||
113 (s == "xyz.openbmc_project.Logging.Entry.Level.Error"))
Andrew Geisslercb92c032018-08-17 07:56:14 -0700114 {
115 return "Critical";
116 }
Ed Tanous3174e4d2020-10-07 11:41:22 -0700117 if ((s == "xyz.openbmc_project.Logging.Entry.Level.Debug") ||
118 (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") ||
119 (s == "xyz.openbmc_project.Logging.Entry.Level.Notice"))
Andrew Geisslercb92c032018-08-17 07:56:14 -0700120 {
121 return "OK";
122 }
Ed Tanous3174e4d2020-10-07 11:41:22 -0700123 if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning")
Andrew Geisslercb92c032018-08-17 07:56:14 -0700124 {
125 return "Warning";
126 }
127 return "";
128}
129
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500130static int getJournalMetadata(sd_journal* journal,
131 const std::string_view& field,
132 std::string_view& contents)
Jason M. Bills16428a12018-11-02 12:42:29 -0700133{
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500134 const char* data = nullptr;
Jason M. Bills16428a12018-11-02 12:42:29 -0700135 size_t length = 0;
136 int ret = 0;
137 // Get the metadata from the requested field of the journal entry
Ed Tanous271584a2019-07-09 16:24:22 -0700138 ret = sd_journal_get_data(journal, field.data(),
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500139 reinterpret_cast<const void**>(&data), &length);
Jason M. Bills16428a12018-11-02 12:42:29 -0700140 if (ret < 0)
141 {
142 return ret;
143 }
Ed Tanous39e77502019-03-04 17:35:53 -0800144 contents = std::string_view(data, length);
Jason M. Bills16428a12018-11-02 12:42:29 -0700145 // Only use the content after the "=" character.
146 contents.remove_prefix(std::min(contents.find("=") + 1, contents.size()));
147 return ret;
148}
149
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500150static int getJournalMetadata(sd_journal* journal,
151 const std::string_view& field, const int& base,
152 long int& contents)
Jason M. Bills16428a12018-11-02 12:42:29 -0700153{
154 int ret = 0;
Ed Tanous39e77502019-03-04 17:35:53 -0800155 std::string_view metadata;
Jason M. Bills16428a12018-11-02 12:42:29 -0700156 // Get the metadata from the requested field of the journal entry
157 ret = getJournalMetadata(journal, field, metadata);
158 if (ret < 0)
159 {
160 return ret;
161 }
Ed Tanousb01bf292019-03-25 19:25:26 +0000162 contents = strtol(metadata.data(), nullptr, base);
Jason M. Bills16428a12018-11-02 12:42:29 -0700163 return ret;
164}
165
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500166static bool getEntryTimestamp(sd_journal* journal, std::string& entryTimestamp)
ZhikuiRena3316fc2020-01-29 14:58:08 -0800167{
168 int ret = 0;
169 uint64_t timestamp = 0;
170 ret = sd_journal_get_realtime_usec(journal, &timestamp);
171 if (ret < 0)
172 {
173 BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
174 << strerror(-ret);
175 return false;
176 }
Asmitha Karunanithi9c620e22020-08-02 11:55:21 -0500177 entryTimestamp = crow::utility::getDateTime(
178 static_cast<std::time_t>(timestamp / 1000 / 1000));
179 return true;
ZhikuiRena3316fc2020-01-29 14:58:08 -0800180}
181
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500182static bool getSkipParam(crow::Response& res, const crow::Request& req,
183 uint64_t& skip)
Jason M. Bills16428a12018-11-02 12:42:29 -0700184{
James Feist5a7e8772020-07-22 09:08:38 -0700185 boost::urls::url_view::params_type::iterator it =
186 req.urlParams.find("$skip");
187 if (it != req.urlParams.end())
Jason M. Bills16428a12018-11-02 12:42:29 -0700188 {
James Feist5a7e8772020-07-22 09:08:38 -0700189 std::string skipParam = it->value();
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500190 char* ptr = nullptr;
James Feist5a7e8772020-07-22 09:08:38 -0700191 skip = std::strtoul(skipParam.c_str(), &ptr, 10);
192 if (skipParam.empty() || *ptr != '\0')
Jason M. Bills16428a12018-11-02 12:42:29 -0700193 {
194
195 messages::queryParameterValueTypeError(res, std::string(skipParam),
196 "$skip");
197 return false;
198 }
Jason M. Bills16428a12018-11-02 12:42:29 -0700199 }
200 return true;
201}
202
Ed Tanous271584a2019-07-09 16:24:22 -0700203static constexpr const uint64_t maxEntriesPerPage = 1000;
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500204static bool getTopParam(crow::Response& res, const crow::Request& req,
205 uint64_t& top)
Jason M. Bills16428a12018-11-02 12:42:29 -0700206{
James Feist5a7e8772020-07-22 09:08:38 -0700207 boost::urls::url_view::params_type::iterator it =
208 req.urlParams.find("$top");
209 if (it != req.urlParams.end())
Jason M. Bills16428a12018-11-02 12:42:29 -0700210 {
James Feist5a7e8772020-07-22 09:08:38 -0700211 std::string topParam = it->value();
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500212 char* ptr = nullptr;
James Feist5a7e8772020-07-22 09:08:38 -0700213 top = std::strtoul(topParam.c_str(), &ptr, 10);
214 if (topParam.empty() || *ptr != '\0')
Jason M. Bills16428a12018-11-02 12:42:29 -0700215 {
216 messages::queryParameterValueTypeError(res, std::string(topParam),
217 "$top");
218 return false;
219 }
Ed Tanous271584a2019-07-09 16:24:22 -0700220 if (top < 1U || top > maxEntriesPerPage)
Jason M. Bills16428a12018-11-02 12:42:29 -0700221 {
222
223 messages::queryParameterOutOfRange(
224 res, std::to_string(top), "$top",
225 "1-" + std::to_string(maxEntriesPerPage));
226 return false;
227 }
228 }
229 return true;
230}
231
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500232static bool getUniqueEntryID(sd_journal* journal, std::string& entryID,
Jason M. Billse85d6b12019-07-29 17:01:15 -0700233 const bool firstEntry = true)
Jason M. Bills16428a12018-11-02 12:42:29 -0700234{
235 int ret = 0;
236 static uint64_t prevTs = 0;
237 static int index = 0;
Jason M. Billse85d6b12019-07-29 17:01:15 -0700238 if (firstEntry)
239 {
240 prevTs = 0;
241 }
242
Jason M. Bills16428a12018-11-02 12:42:29 -0700243 // Get the entry timestamp
244 uint64_t curTs = 0;
245 ret = sd_journal_get_realtime_usec(journal, &curTs);
246 if (ret < 0)
247 {
248 BMCWEB_LOG_ERROR << "Failed to read entry timestamp: "
249 << strerror(-ret);
250 return false;
251 }
252 // If the timestamp isn't unique, increment the index
253 if (curTs == prevTs)
254 {
255 index++;
256 }
257 else
258 {
259 // Otherwise, reset it
260 index = 0;
261 }
262 // Save the timestamp
263 prevTs = curTs;
264
265 entryID = std::to_string(curTs);
266 if (index > 0)
267 {
268 entryID += "_" + std::to_string(index);
269 }
270 return true;
271}
272
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500273static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID,
Jason M. Billse85d6b12019-07-29 17:01:15 -0700274 const bool firstEntry = true)
Jason M. Bills95820182019-04-22 16:25:34 -0700275{
Ed Tanous271584a2019-07-09 16:24:22 -0700276 static time_t prevTs = 0;
Jason M. Bills95820182019-04-22 16:25:34 -0700277 static int index = 0;
Jason M. Billse85d6b12019-07-29 17:01:15 -0700278 if (firstEntry)
279 {
280 prevTs = 0;
281 }
282
Jason M. Bills95820182019-04-22 16:25:34 -0700283 // Get the entry timestamp
Ed Tanous271584a2019-07-09 16:24:22 -0700284 std::time_t curTs = 0;
Jason M. Bills95820182019-04-22 16:25:34 -0700285 std::tm timeStruct = {};
286 std::istringstream entryStream(logEntry);
287 if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S"))
288 {
289 curTs = std::mktime(&timeStruct);
290 }
291 // If the timestamp isn't unique, increment the index
292 if (curTs == prevTs)
293 {
294 index++;
295 }
296 else
297 {
298 // Otherwise, reset it
299 index = 0;
300 }
301 // Save the timestamp
302 prevTs = curTs;
303
304 entryID = std::to_string(curTs);
305 if (index > 0)
306 {
307 entryID += "_" + std::to_string(index);
308 }
309 return true;
310}
311
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500312static bool getTimestampFromID(crow::Response& res, const std::string& entryID,
313 uint64_t& timestamp, uint64_t& index)
Jason M. Bills16428a12018-11-02 12:42:29 -0700314{
315 if (entryID.empty())
316 {
317 return false;
318 }
319 // Convert the unique ID back to a timestamp to find the entry
Ed Tanous39e77502019-03-04 17:35:53 -0800320 std::string_view tsStr(entryID);
Jason M. Bills16428a12018-11-02 12:42:29 -0700321
322 auto underscorePos = tsStr.find("_");
323 if (underscorePos != tsStr.npos)
324 {
325 // Timestamp has an index
326 tsStr.remove_suffix(tsStr.size() - underscorePos);
Ed Tanous39e77502019-03-04 17:35:53 -0800327 std::string_view indexStr(entryID);
Jason M. Bills16428a12018-11-02 12:42:29 -0700328 indexStr.remove_prefix(underscorePos + 1);
329 std::size_t pos;
330 try
331 {
Ed Tanous39e77502019-03-04 17:35:53 -0800332 index = std::stoul(std::string(indexStr), &pos);
Jason M. Bills16428a12018-11-02 12:42:29 -0700333 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500334 catch (std::invalid_argument&)
Jason M. Bills16428a12018-11-02 12:42:29 -0700335 {
336 messages::resourceMissingAtURI(res, entryID);
337 return false;
338 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500339 catch (std::out_of_range&)
Jason M. Bills16428a12018-11-02 12:42:29 -0700340 {
341 messages::resourceMissingAtURI(res, entryID);
342 return false;
343 }
344 if (pos != indexStr.size())
345 {
346 messages::resourceMissingAtURI(res, entryID);
347 return false;
348 }
349 }
350 // Timestamp has no index
351 std::size_t pos;
352 try
353 {
Ed Tanous39e77502019-03-04 17:35:53 -0800354 timestamp = std::stoull(std::string(tsStr), &pos);
Jason M. Bills16428a12018-11-02 12:42:29 -0700355 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500356 catch (std::invalid_argument&)
Jason M. Bills16428a12018-11-02 12:42:29 -0700357 {
358 messages::resourceMissingAtURI(res, entryID);
359 return false;
360 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500361 catch (std::out_of_range&)
Jason M. Bills16428a12018-11-02 12:42:29 -0700362 {
363 messages::resourceMissingAtURI(res, entryID);
364 return false;
365 }
366 if (pos != tsStr.size())
367 {
368 messages::resourceMissingAtURI(res, entryID);
369 return false;
370 }
371 return true;
372}
373
Jason M. Bills95820182019-04-22 16:25:34 -0700374static bool
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500375 getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles)
Jason M. Bills95820182019-04-22 16:25:34 -0700376{
377 static const std::filesystem::path redfishLogDir = "/var/log";
378 static const std::string redfishLogFilename = "redfish";
379
380 // Loop through the directory looking for redfish log files
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500381 for (const std::filesystem::directory_entry& dirEnt :
Jason M. Bills95820182019-04-22 16:25:34 -0700382 std::filesystem::directory_iterator(redfishLogDir))
383 {
384 // If we find a redfish log file, save the path
385 std::string filename = dirEnt.path().filename();
386 if (boost::starts_with(filename, redfishLogFilename))
387 {
388 redfishLogFiles.emplace_back(redfishLogDir / filename);
389 }
390 }
391 // As the log files rotate, they are appended with a ".#" that is higher for
392 // the older logs. Since we don't expect more than 10 log files, we
393 // can just sort the list to get them in order from newest to oldest
394 std::sort(redfishLogFiles.begin(), redfishLogFiles.end());
395
396 return !redfishLogFiles.empty();
397}
398
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500399inline void getDumpEntryCollection(std::shared_ptr<AsyncResp>& asyncResp,
400 const std::string& dumpType)
401{
402 std::string dumpPath;
403 if (dumpType == "BMC")
404 {
405 dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
406 }
407 else if (dumpType == "System")
408 {
409 dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
410 }
411 else
412 {
413 BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
414 messages::internalError(asyncResp->res);
415 return;
416 }
417
418 crow::connections::systemBus->async_method_call(
419 [asyncResp, dumpPath, dumpType](const boost::system::error_code ec,
420 GetManagedObjectsType& resp) {
421 if (ec)
422 {
423 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
424 messages::internalError(asyncResp->res);
425 return;
426 }
427
428 nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
429 entriesArray = nlohmann::json::array();
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500430 std::string dumpEntryPath =
431 "/xyz/openbmc_project/dump/" +
432 std::string(boost::algorithm::to_lower_copy(dumpType)) +
433 "/entry/";
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500434
435 for (auto& object : resp)
436 {
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500437 if (object.first.str.find(dumpEntryPath) == std::string::npos)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500438 {
439 continue;
440 }
441 std::time_t timestamp;
442 uint64_t size = 0;
443 entriesArray.push_back({});
444 nlohmann::json& thisEntry = entriesArray.back();
445 const std::string& path =
446 static_cast<const std::string&>(object.first);
Ed Tanousf23b7292020-10-15 09:41:17 -0700447 std::size_t lastPos = path.rfind('/');
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500448 if (lastPos == std::string::npos)
449 {
450 continue;
451 }
452 std::string entryID = path.substr(lastPos + 1);
453
454 for (auto& interfaceMap : object.second)
455 {
456 if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
457 {
458
459 for (auto& propertyMap : interfaceMap.second)
460 {
461 if (propertyMap.first == "Size")
462 {
463 auto sizePtr =
464 std::get_if<uint64_t>(&propertyMap.second);
465 if (sizePtr == nullptr)
466 {
467 messages::internalError(asyncResp->res);
468 break;
469 }
470 size = *sizePtr;
471 break;
472 }
473 }
474 }
475 else if (interfaceMap.first ==
476 "xyz.openbmc_project.Time.EpochTime")
477 {
478
479 for (auto& propertyMap : interfaceMap.second)
480 {
481 if (propertyMap.first == "Elapsed")
482 {
483 const uint64_t* usecsTimeStamp =
484 std::get_if<uint64_t>(&propertyMap.second);
485 if (usecsTimeStamp == nullptr)
486 {
487 messages::internalError(asyncResp->res);
488 break;
489 }
490 timestamp =
491 static_cast<std::time_t>(*usecsTimeStamp);
492 break;
493 }
494 }
495 }
496 }
497
Asmitha Karunanithid337bb72020-09-21 10:34:02 -0500498 thisEntry["@odata.type"] = "#LogEntry.v1_7_0.LogEntry";
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500499 thisEntry["@odata.id"] = dumpPath + entryID;
500 thisEntry["Id"] = entryID;
501 thisEntry["EntryType"] = "Event";
502 thisEntry["Created"] = crow::utility::getDateTime(timestamp);
503 thisEntry["Name"] = dumpType + " Dump Entry";
504
Asmitha Karunanithid337bb72020-09-21 10:34:02 -0500505 thisEntry["AdditionalDataSizeBytes"] = size;
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500506
507 if (dumpType == "BMC")
508 {
Asmitha Karunanithid337bb72020-09-21 10:34:02 -0500509 thisEntry["DiagnosticDataType"] = "Manager";
510 thisEntry["AdditionalDataURI"] =
511 "/redfish/v1/Managers/bmc/LogServices/Dump/"
512 "attachment/" +
513 entryID;
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500514 }
515 else if (dumpType == "System")
516 {
Asmitha Karunanithid337bb72020-09-21 10:34:02 -0500517 thisEntry["DiagnosticDataType"] = "OEM";
518 thisEntry["OEMDiagnosticDataType"] = "System";
519 thisEntry["AdditionalDataURI"] =
520 "/redfish/v1/Systems/system/LogServices/Dump/"
521 "attachment/" +
522 entryID;
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500523 }
524 }
525 asyncResp->res.jsonValue["Members@odata.count"] =
526 entriesArray.size();
527 },
528 "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
529 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
530}
531
532inline void getDumpEntryById(std::shared_ptr<AsyncResp>& asyncResp,
533 const std::string& entryID,
534 const std::string& dumpType)
535{
536 std::string dumpPath;
537 if (dumpType == "BMC")
538 {
539 dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
540 }
541 else if (dumpType == "System")
542 {
543 dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
544 }
545 else
546 {
547 BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType;
548 messages::internalError(asyncResp->res);
549 return;
550 }
551
552 crow::connections::systemBus->async_method_call(
553 [asyncResp, entryID, dumpPath, dumpType](
554 const boost::system::error_code ec, GetManagedObjectsType& resp) {
555 if (ec)
556 {
557 BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec;
558 messages::internalError(asyncResp->res);
559 return;
560 }
561
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500562 bool foundDumpEntry = false;
563 std::string dumpEntryPath =
564 "/xyz/openbmc_project/dump/" +
565 std::string(boost::algorithm::to_lower_copy(dumpType)) +
566 "/entry/";
567
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500568 for (auto& objectPath : resp)
569 {
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500570 if (objectPath.first.str != dumpEntryPath + entryID)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500571 {
572 continue;
573 }
574
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500575 foundDumpEntry = true;
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500576 std::time_t timestamp;
577 uint64_t size = 0;
578
579 for (auto& interfaceMap : objectPath.second)
580 {
581 if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry")
582 {
583 for (auto& propertyMap : interfaceMap.second)
584 {
585 if (propertyMap.first == "Size")
586 {
587 auto sizePtr =
588 std::get_if<uint64_t>(&propertyMap.second);
589 if (sizePtr == nullptr)
590 {
591 messages::internalError(asyncResp->res);
592 break;
593 }
594 size = *sizePtr;
595 break;
596 }
597 }
598 }
599 else if (interfaceMap.first ==
600 "xyz.openbmc_project.Time.EpochTime")
601 {
602 for (auto& propertyMap : interfaceMap.second)
603 {
604 if (propertyMap.first == "Elapsed")
605 {
606 const uint64_t* usecsTimeStamp =
607 std::get_if<uint64_t>(&propertyMap.second);
608 if (usecsTimeStamp == nullptr)
609 {
610 messages::internalError(asyncResp->res);
611 break;
612 }
613 timestamp =
614 static_cast<std::time_t>(*usecsTimeStamp);
615 break;
616 }
617 }
618 }
619 }
620
621 asyncResp->res.jsonValue["@odata.type"] =
Asmitha Karunanithid337bb72020-09-21 10:34:02 -0500622 "#LogEntry.v1_7_0.LogEntry";
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500623 asyncResp->res.jsonValue["@odata.id"] = dumpPath + entryID;
624 asyncResp->res.jsonValue["Id"] = entryID;
625 asyncResp->res.jsonValue["EntryType"] = "Event";
626 asyncResp->res.jsonValue["Created"] =
627 crow::utility::getDateTime(timestamp);
628 asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry";
629
Asmitha Karunanithid337bb72020-09-21 10:34:02 -0500630 asyncResp->res.jsonValue["AdditionalDataSizeBytes"] = size;
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500631
632 if (dumpType == "BMC")
633 {
Asmitha Karunanithid337bb72020-09-21 10:34:02 -0500634 asyncResp->res.jsonValue["DiagnosticDataType"] = "Manager";
635 asyncResp->res.jsonValue["AdditionalDataURI"] =
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500636 "/redfish/v1/Managers/bmc/LogServices/Dump/"
637 "attachment/" +
638 entryID;
639 }
640 else if (dumpType == "System")
641 {
Asmitha Karunanithid337bb72020-09-21 10:34:02 -0500642 asyncResp->res.jsonValue["DiagnosticDataType"] = "OEM";
643 asyncResp->res.jsonValue["OEMDiagnosticDataType"] =
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500644 "System";
Asmitha Karunanithid337bb72020-09-21 10:34:02 -0500645 asyncResp->res.jsonValue["AdditionalDataURI"] =
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500646 "/redfish/v1/Systems/system/LogServices/Dump/"
647 "attachment/" +
648 entryID;
649 }
650 }
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500651 if (foundDumpEntry == false)
652 {
653 BMCWEB_LOG_ERROR << "Can't find Dump Entry";
654 messages::internalError(asyncResp->res);
655 return;
656 }
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500657 },
658 "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump",
659 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
660}
661
Stanley Chu98782562020-11-04 16:10:24 +0800662inline void deleteDumpEntry(const std::shared_ptr<AsyncResp>& asyncResp,
663 const std::string& entryID,
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500664 const std::string& dumpType)
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500665{
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500666 auto respHandler = [asyncResp](const boost::system::error_code ec) {
667 BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done";
668 if (ec)
669 {
670 BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error "
671 << ec;
672 messages::internalError(asyncResp->res);
673 return;
674 }
675 };
676 crow::connections::systemBus->async_method_call(
677 respHandler, "xyz.openbmc_project.Dump.Manager",
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500678 "/xyz/openbmc_project/dump/" +
679 std::string(boost::algorithm::to_lower_copy(dumpType)) + "/entry/" +
680 entryID,
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500681 "xyz.openbmc_project.Object.Delete", "Delete");
682}
683
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500684inline void createDumpTaskCallback(const crow::Request& req,
Ed Tanousb5a76932020-09-29 16:16:58 -0700685 const std::shared_ptr<AsyncResp>& asyncResp,
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500686 const uint32_t& dumpId,
687 const std::string& dumpPath,
688 const std::string& dumpType)
689{
690 std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
Asmitha Karunanithi6145ed62020-09-17 23:40:03 -0500691 [dumpId, dumpPath, dumpType](
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500692 boost::system::error_code err, sdbusplus::message::message& m,
693 const std::shared_ptr<task::TaskData>& taskData) {
Ed Tanouscb13a392020-07-25 19:02:03 +0000694 if (err)
695 {
Asmitha Karunanithi6145ed62020-09-17 23:40:03 -0500696 BMCWEB_LOG_ERROR << "Error in creating a dump";
697 taskData->state = "Cancelled";
698 return task::completed;
Ed Tanouscb13a392020-07-25 19:02:03 +0000699 }
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500700 std::vector<std::pair<
701 std::string,
702 std::vector<std::pair<std::string, std::variant<std::string>>>>>
703 interfacesList;
704
705 sdbusplus::message::object_path objPath;
706
707 m.read(objPath, interfacesList);
708
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500709 if (objPath.str ==
710 "/xyz/openbmc_project/dump/" +
711 std::string(boost::algorithm::to_lower_copy(dumpType)) +
712 "/entry/" + std::to_string(dumpId))
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500713 {
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500714 nlohmann::json retMessage = messages::success();
715 taskData->messages.emplace_back(retMessage);
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500716
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500717 std::string headerLoc =
718 "Location: " + dumpPath + std::to_string(dumpId);
719 taskData->payload->httpHeaders.emplace_back(
720 std::move(headerLoc));
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500721
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500722 taskData->state = "Completed";
723 return task::completed;
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500724 }
Asmitha Karunanithi6145ed62020-09-17 23:40:03 -0500725 return task::completed;
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500726 },
727 "type='signal',interface='org.freedesktop.DBus."
728 "ObjectManager',"
729 "member='InterfacesAdded', "
730 "path='/xyz/openbmc_project/dump'");
731
732 task->startTimer(std::chrono::minutes(3));
733 task->populateResp(asyncResp->res);
734 task->payload.emplace(req);
735}
736
737inline void createDump(crow::Response& res, const crow::Request& req,
738 const std::string& dumpType)
739{
740 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
741
742 std::string dumpPath;
743 if (dumpType == "BMC")
744 {
745 dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/";
746 }
747 else if (dumpType == "System")
748 {
749 dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/";
750 }
751 else
752 {
753 BMCWEB_LOG_ERROR << "Invalid dump type: " << dumpType;
754 messages::internalError(asyncResp->res);
755 return;
756 }
757
758 std::optional<std::string> diagnosticDataType;
759 std::optional<std::string> oemDiagnosticDataType;
760
761 if (!redfish::json_util::readJson(
762 req, asyncResp->res, "DiagnosticDataType", diagnosticDataType,
763 "OEMDiagnosticDataType", oemDiagnosticDataType))
764 {
765 return;
766 }
767
768 if (dumpType == "System")
769 {
770 if (!oemDiagnosticDataType || !diagnosticDataType)
771 {
772 BMCWEB_LOG_ERROR << "CreateDump action parameter "
773 "'DiagnosticDataType'/"
774 "'OEMDiagnosticDataType' value not found!";
775 messages::actionParameterMissing(
776 asyncResp->res, "CollectDiagnosticData",
777 "DiagnosticDataType & OEMDiagnosticDataType");
778 return;
779 }
Ed Tanous3174e4d2020-10-07 11:41:22 -0700780 if ((*oemDiagnosticDataType != "System") ||
781 (*diagnosticDataType != "OEM"))
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500782 {
783 BMCWEB_LOG_ERROR << "Wrong parameter values passed";
784 messages::invalidObject(asyncResp->res,
785 "System Dump creation parameters");
786 return;
787 }
788 }
789 else if (dumpType == "BMC")
790 {
791 if (!diagnosticDataType)
792 {
793 BMCWEB_LOG_ERROR << "CreateDump action parameter "
794 "'DiagnosticDataType' not found!";
795 messages::actionParameterMissing(
796 asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType");
797 return;
798 }
Ed Tanous3174e4d2020-10-07 11:41:22 -0700799 if (*diagnosticDataType != "Manager")
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500800 {
801 BMCWEB_LOG_ERROR
802 << "Wrong parameter value passed for 'DiagnosticDataType'";
803 messages::invalidObject(asyncResp->res,
804 "BMC Dump creation parameters");
805 return;
806 }
807 }
808
809 crow::connections::systemBus->async_method_call(
810 [asyncResp, req, dumpPath, dumpType](const boost::system::error_code ec,
811 const uint32_t& dumpId) {
812 if (ec)
813 {
814 BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec;
815 messages::internalError(asyncResp->res);
816 return;
817 }
818 BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId;
819
820 createDumpTaskCallback(req, asyncResp, dumpId, dumpPath, dumpType);
821 },
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500822 "xyz.openbmc_project.Dump.Manager",
823 "/xyz/openbmc_project/dump/" +
824 std::string(boost::algorithm::to_lower_copy(dumpType)),
Asmitha Karunanithia43be802020-05-07 05:05:36 -0500825 "xyz.openbmc_project.Dump.Create", "CreateDump");
826}
827
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500828inline void clearDump(crow::Response& res, const std::string& dumpType)
Asmitha Karunanithi80319af2020-05-07 05:30:21 -0500829{
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500830 std::string dumpTypeLowerCopy =
831 std::string(boost::algorithm::to_lower_copy(dumpType));
Asmitha Karunanithi80319af2020-05-07 05:30:21 -0500832 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
833 crow::connections::systemBus->async_method_call(
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500834 [asyncResp, dumpType](const boost::system::error_code ec,
835 const std::vector<std::string>& subTreePaths) {
Asmitha Karunanithi80319af2020-05-07 05:30:21 -0500836 if (ec)
837 {
838 BMCWEB_LOG_ERROR << "resp_handler got error " << ec;
839 messages::internalError(asyncResp->res);
840 return;
841 }
842
843 for (const std::string& path : subTreePaths)
844 {
Ed Tanousf23b7292020-10-15 09:41:17 -0700845 std::size_t pos = path.rfind('/');
Asmitha Karunanithi80319af2020-05-07 05:30:21 -0500846 if (pos != std::string::npos)
847 {
848 std::string logID = path.substr(pos + 1);
Stanley Chu98782562020-11-04 16:10:24 +0800849 deleteDumpEntry(asyncResp, logID, dumpType);
Asmitha Karunanithi80319af2020-05-07 05:30:21 -0500850 }
851 }
852 },
853 "xyz.openbmc_project.ObjectMapper",
854 "/xyz/openbmc_project/object_mapper",
855 "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
Asmitha Karunanithib47452b2020-09-25 02:02:19 -0500856 "/xyz/openbmc_project/dump/" + dumpTypeLowerCopy, 0,
857 std::array<std::string, 1>{"xyz.openbmc_project.Dump.Entry." +
858 dumpType});
Asmitha Karunanithi80319af2020-05-07 05:30:21 -0500859}
860
Ed Tanous2c70f802020-09-28 14:29:23 -0700861static void parseCrashdumpParameters(
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500862 const std::vector<std::pair<std::string, VariantType>>& params,
863 std::string& filename, std::string& timestamp, std::string& logfile)
Johnathan Mantey043a0532020-03-10 17:15:28 -0700864{
865 for (auto property : params)
866 {
867 if (property.first == "Timestamp")
868 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500869 const std::string* value =
Patrick Williams8d78b7a2020-05-13 11:24:20 -0500870 std::get_if<std::string>(&property.second);
Johnathan Mantey043a0532020-03-10 17:15:28 -0700871 if (value != nullptr)
872 {
873 timestamp = *value;
874 }
875 }
876 else if (property.first == "Filename")
877 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500878 const std::string* value =
Patrick Williams8d78b7a2020-05-13 11:24:20 -0500879 std::get_if<std::string>(&property.second);
Johnathan Mantey043a0532020-03-10 17:15:28 -0700880 if (value != nullptr)
881 {
882 filename = *value;
883 }
884 }
885 else if (property.first == "Log")
886 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500887 const std::string* value =
Patrick Williams8d78b7a2020-05-13 11:24:20 -0500888 std::get_if<std::string>(&property.second);
Johnathan Mantey043a0532020-03-10 17:15:28 -0700889 if (value != nullptr)
890 {
891 logfile = *value;
892 }
893 }
894 }
895}
896
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500897constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode";
Jason M. Billsc4bf6372018-11-05 13:48:27 -0800898class SystemLogServiceCollection : public Node
Ed Tanous1da66f72018-07-27 16:13:37 -0700899{
900 public:
Ed Tanous52cc1122020-07-18 13:51:21 -0700901 SystemLogServiceCollection(App& app) :
Ed Tanous029573d2019-02-01 10:57:49 -0800902 Node(app, "/redfish/v1/Systems/system/LogServices/")
Jason M. Billsc4bf6372018-11-05 13:48:27 -0800903 {
904 entityPrivileges = {
905 {boost::beast::http::verb::get, {{"Login"}}},
906 {boost::beast::http::verb::head, {{"Login"}}},
907 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
908 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
909 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
910 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
911 }
912
913 private:
914 /**
915 * Functions triggers appropriate requests on DBus
916 */
Ed Tanouscb13a392020-07-25 19:02:03 +0000917 void doGet(crow::Response& res, const crow::Request&,
918 const std::vector<std::string>&) override
Jason M. Billsc4bf6372018-11-05 13:48:27 -0800919 {
920 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Jason M. Billsc4bf6372018-11-05 13:48:27 -0800921 // Collections don't include the static data added by SubRoute because
922 // it has a duplicate entry for members
923 asyncResp->res.jsonValue["@odata.type"] =
924 "#LogServiceCollection.LogServiceCollection";
Jason M. Billsc4bf6372018-11-05 13:48:27 -0800925 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous029573d2019-02-01 10:57:49 -0800926 "/redfish/v1/Systems/system/LogServices";
Jason M. Billsc4bf6372018-11-05 13:48:27 -0800927 asyncResp->res.jsonValue["Name"] = "System Log Services Collection";
928 asyncResp->res.jsonValue["Description"] =
929 "Collection of LogServices for this Computer System";
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500930 nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
Jason M. Billsc4bf6372018-11-05 13:48:27 -0800931 logServiceArray = nlohmann::json::array();
Ed Tanous029573d2019-02-01 10:57:49 -0800932 logServiceArray.push_back(
933 {{"@odata.id", "/redfish/v1/Systems/system/LogServices/EventLog"}});
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500934#ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
raviteja-bc9bb6862020-02-03 11:53:32 -0600935 logServiceArray.push_back(
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -0500936 {{"@odata.id", "/redfish/v1/Systems/system/LogServices/Dump"}});
raviteja-bc9bb6862020-02-03 11:53:32 -0600937#endif
938
Jason M. Billsd53dd412019-02-12 17:16:22 -0800939#ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG
940 logServiceArray.push_back(
Anthony Wilson08a4e4b2019-04-12 08:23:05 -0500941 {{"@odata.id",
942 "/redfish/v1/Systems/system/LogServices/Crashdump"}});
Jason M. Billsd53dd412019-02-12 17:16:22 -0800943#endif
Jason M. Billsc4bf6372018-11-05 13:48:27 -0800944 asyncResp->res.jsonValue["Members@odata.count"] =
945 logServiceArray.size();
ZhikuiRena3316fc2020-01-29 14:58:08 -0800946
947 crow::connections::systemBus->async_method_call(
948 [asyncResp](const boost::system::error_code ec,
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500949 const std::vector<std::string>& subtreePath) {
ZhikuiRena3316fc2020-01-29 14:58:08 -0800950 if (ec)
951 {
952 BMCWEB_LOG_ERROR << ec;
953 return;
954 }
955
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500956 for (auto& pathStr : subtreePath)
ZhikuiRena3316fc2020-01-29 14:58:08 -0800957 {
958 if (pathStr.find("PostCode") != std::string::npos)
959 {
Ed Tanous23a21a12020-07-25 04:45:05 +0000960 nlohmann::json& logServiceArrayLocal =
ZhikuiRena3316fc2020-01-29 14:58:08 -0800961 asyncResp->res.jsonValue["Members"];
Ed Tanous23a21a12020-07-25 04:45:05 +0000962 logServiceArrayLocal.push_back(
ZhikuiRena3316fc2020-01-29 14:58:08 -0800963 {{"@odata.id", "/redfish/v1/Systems/system/"
964 "LogServices/PostCodes"}});
965 asyncResp->res.jsonValue["Members@odata.count"] =
Ed Tanous23a21a12020-07-25 04:45:05 +0000966 logServiceArrayLocal.size();
ZhikuiRena3316fc2020-01-29 14:58:08 -0800967 return;
968 }
969 }
970 },
971 "xyz.openbmc_project.ObjectMapper",
972 "/xyz/openbmc_project/object_mapper",
973 "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 0,
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500974 std::array<const char*, 1>{postCodeIface});
Jason M. Billsc4bf6372018-11-05 13:48:27 -0800975 }
976};
977
978class EventLogService : public Node
979{
980 public:
Ed Tanous52cc1122020-07-18 13:51:21 -0700981 EventLogService(App& app) :
Ed Tanous029573d2019-02-01 10:57:49 -0800982 Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/")
Jason M. Billsc4bf6372018-11-05 13:48:27 -0800983 {
984 entityPrivileges = {
985 {boost::beast::http::verb::get, {{"Login"}}},
986 {boost::beast::http::verb::head, {{"Login"}}},
987 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
988 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
989 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
990 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
991 }
992
993 private:
Ed Tanouscb13a392020-07-25 19:02:03 +0000994 void doGet(crow::Response& res, const crow::Request&,
995 const std::vector<std::string>&) override
Jason M. Billsc4bf6372018-11-05 13:48:27 -0800996 {
997 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
998
Jason M. Billsc4bf6372018-11-05 13:48:27 -0800999 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous029573d2019-02-01 10:57:49 -08001000 "/redfish/v1/Systems/system/LogServices/EventLog";
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001001 asyncResp->res.jsonValue["@odata.type"] =
1002 "#LogService.v1_1_0.LogService";
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001003 asyncResp->res.jsonValue["Name"] = "Event Log Service";
1004 asyncResp->res.jsonValue["Description"] = "System Event Log Service";
Gunnar Mills73ec8302020-04-14 16:02:42 -05001005 asyncResp->res.jsonValue["Id"] = "EventLog";
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001006 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
1007 asyncResp->res.jsonValue["Entries"] = {
1008 {"@odata.id",
Ed Tanous029573d2019-02-01 10:57:49 -08001009 "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}};
Gunnar Millse7d6c8b2019-07-03 11:30:01 -05001010 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
1011
1012 {"target", "/redfish/v1/Systems/system/LogServices/EventLog/"
1013 "Actions/LogService.ClearLog"}};
Jason M. Bills489640c2019-05-17 09:56:36 -07001014 }
1015};
1016
Tim Lee1f56a3a2019-10-09 10:17:57 +08001017class JournalEventLogClear : public Node
Jason M. Bills489640c2019-05-17 09:56:36 -07001018{
1019 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07001020 JournalEventLogClear(App& app) :
Jason M. Bills489640c2019-05-17 09:56:36 -07001021 Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
1022 "LogService.ClearLog/")
1023 {
1024 entityPrivileges = {
1025 {boost::beast::http::verb::get, {{"Login"}}},
1026 {boost::beast::http::verb::head, {{"Login"}}},
1027 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
1028 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
1029 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
1030 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
1031 }
1032
1033 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00001034 void doPost(crow::Response& res, const crow::Request&,
1035 const std::vector<std::string>&) override
Jason M. Bills489640c2019-05-17 09:56:36 -07001036 {
1037 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1038
1039 // Clear the EventLog by deleting the log files
1040 std::vector<std::filesystem::path> redfishLogFiles;
1041 if (getRedfishLogFiles(redfishLogFiles))
1042 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001043 for (const std::filesystem::path& file : redfishLogFiles)
Jason M. Bills489640c2019-05-17 09:56:36 -07001044 {
1045 std::error_code ec;
1046 std::filesystem::remove(file, ec);
1047 }
1048 }
1049
1050 // Reload rsyslog so it knows to start new log files
1051 crow::connections::systemBus->async_method_call(
1052 [asyncResp](const boost::system::error_code ec) {
1053 if (ec)
1054 {
1055 BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec;
1056 messages::internalError(asyncResp->res);
1057 return;
1058 }
1059
1060 messages::success(asyncResp->res);
1061 },
1062 "org.freedesktop.systemd1", "/org/freedesktop/systemd1",
1063 "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service",
1064 "replace");
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001065 }
1066};
1067
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001068static int fillEventLogEntryJson(const std::string& logEntryID,
Ed Tanousb5a76932020-09-29 16:16:58 -07001069 const std::string& logEntry,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001070 nlohmann::json& logEntryJson)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001071{
Jason M. Bills95820182019-04-22 16:25:34 -07001072 // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>"
Jason M. Billscd225da2019-05-08 15:31:57 -07001073 // First get the Timestamp
Ed Tanousf23b7292020-10-15 09:41:17 -07001074 size_t space = logEntry.find_first_of(' ');
Jason M. Billscd225da2019-05-08 15:31:57 -07001075 if (space == std::string::npos)
Jason M. Bills95820182019-04-22 16:25:34 -07001076 {
1077 return 1;
1078 }
Jason M. Billscd225da2019-05-08 15:31:57 -07001079 std::string timestamp = logEntry.substr(0, space);
1080 // Then get the log contents
Ed Tanousf23b7292020-10-15 09:41:17 -07001081 size_t entryStart = logEntry.find_first_not_of(' ', space);
Jason M. Billscd225da2019-05-08 15:31:57 -07001082 if (entryStart == std::string::npos)
1083 {
1084 return 1;
1085 }
1086 std::string_view entry(logEntry);
1087 entry.remove_prefix(entryStart);
1088 // Use split to separate the entry into its fields
1089 std::vector<std::string> logEntryFields;
1090 boost::split(logEntryFields, entry, boost::is_any_of(","),
1091 boost::token_compress_on);
1092 // We need at least a MessageId to be valid
1093 if (logEntryFields.size() < 1)
1094 {
1095 return 1;
1096 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001097 std::string& messageID = logEntryFields[0];
Jason M. Bills95820182019-04-22 16:25:34 -07001098
Jason M. Bills4851d452019-03-28 11:27:48 -07001099 // Get the Message from the MessageRegistry
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001100 const message_registries::Message* message =
Jason M. Bills4851d452019-03-28 11:27:48 -07001101 message_registries::getMessage(messageID);
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001102
Jason M. Bills4851d452019-03-28 11:27:48 -07001103 std::string msg;
1104 std::string severity;
1105 if (message != nullptr)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001106 {
Jason M. Bills4851d452019-03-28 11:27:48 -07001107 msg = message->message;
1108 severity = message->severity;
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001109 }
1110
Jason M. Bills15a86ff2019-06-18 13:49:54 -07001111 // Get the MessageArgs from the log if there are any
1112 boost::beast::span<std::string> messageArgs;
1113 if (logEntryFields.size() > 1)
Jason M. Bills4851d452019-03-28 11:27:48 -07001114 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001115 std::string& messageArgsStart = logEntryFields[1];
Jason M. Bills15a86ff2019-06-18 13:49:54 -07001116 // If the first string is empty, assume there are no MessageArgs
1117 std::size_t messageArgsSize = 0;
1118 if (!messageArgsStart.empty())
Jason M. Bills4851d452019-03-28 11:27:48 -07001119 {
Jason M. Bills15a86ff2019-06-18 13:49:54 -07001120 messageArgsSize = logEntryFields.size() - 1;
1121 }
1122
Ed Tanous23a21a12020-07-25 04:45:05 +00001123 messageArgs = {&messageArgsStart, messageArgsSize};
Jason M. Bills15a86ff2019-06-18 13:49:54 -07001124
1125 // Fill the MessageArgs into the Message
1126 int i = 0;
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001127 for (const std::string& messageArg : messageArgs)
Jason M. Bills15a86ff2019-06-18 13:49:54 -07001128 {
1129 std::string argStr = "%" + std::to_string(++i);
1130 size_t argPos = msg.find(argStr);
1131 if (argPos != std::string::npos)
1132 {
1133 msg.replace(argPos, argStr.length(), messageArg);
1134 }
Jason M. Bills4851d452019-03-28 11:27:48 -07001135 }
1136 }
1137
Jason M. Bills95820182019-04-22 16:25:34 -07001138 // Get the Created time from the timestamp. The log timestamp is in RFC3339
1139 // format which matches the Redfish format except for the fractional seconds
1140 // between the '.' and the '+', so just remove them.
Ed Tanousf23b7292020-10-15 09:41:17 -07001141 std::size_t dot = timestamp.find_first_of('.');
1142 std::size_t plus = timestamp.find_first_of('+');
Jason M. Bills95820182019-04-22 16:25:34 -07001143 if (dot != std::string::npos && plus != std::string::npos)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001144 {
Jason M. Bills95820182019-04-22 16:25:34 -07001145 timestamp.erase(dot, plus - dot);
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001146 }
1147
1148 // Fill in the log entry with the gathered data
Jason M. Bills95820182019-04-22 16:25:34 -07001149 logEntryJson = {
Andrew Geisslercb92c032018-08-17 07:56:14 -07001150 {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
Ed Tanous029573d2019-02-01 10:57:49 -08001151 {"@odata.id",
Jason M. Bills897967d2019-07-29 17:05:30 -07001152 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" +
Jason M. Bills95820182019-04-22 16:25:34 -07001153 logEntryID},
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001154 {"Name", "System Event Log Entry"},
Jason M. Bills95820182019-04-22 16:25:34 -07001155 {"Id", logEntryID},
1156 {"Message", std::move(msg)},
1157 {"MessageId", std::move(messageID)},
Ed Tanousf23b7292020-10-15 09:41:17 -07001158 {"MessageArgs", messageArgs},
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001159 {"EntryType", "Event"},
Jason M. Bills95820182019-04-22 16:25:34 -07001160 {"Severity", std::move(severity)},
1161 {"Created", std::move(timestamp)}};
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001162 return 0;
1163}
1164
Anthony Wilson27062602019-04-22 02:10:09 -05001165class JournalEventLogEntryCollection : public Node
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001166{
1167 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07001168 JournalEventLogEntryCollection(App& app) :
Ed Tanous029573d2019-02-01 10:57:49 -08001169 Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001170 {
1171 entityPrivileges = {
1172 {boost::beast::http::verb::get, {{"Login"}}},
1173 {boost::beast::http::verb::head, {{"Login"}}},
1174 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1175 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1176 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1177 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1178 }
1179
1180 private:
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001181 void doGet(crow::Response& res, const crow::Request& req,
Ed Tanouscb13a392020-07-25 19:02:03 +00001182 const std::vector<std::string>&) override
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001183 {
1184 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Ed Tanous271584a2019-07-09 16:24:22 -07001185 uint64_t skip = 0;
1186 uint64_t top = maxEntriesPerPage; // Show max entries by default
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001187 if (!getSkipParam(asyncResp->res, req, skip))
1188 {
1189 return;
1190 }
1191 if (!getTopParam(asyncResp->res, req, top))
1192 {
1193 return;
1194 }
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001195 // Collections don't include the static data added by SubRoute because
1196 // it has a duplicate entry for members
1197 asyncResp->res.jsonValue["@odata.type"] =
1198 "#LogEntryCollection.LogEntryCollection";
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001199 asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous029573d2019-02-01 10:57:49 -08001200 "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001201 asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1202 asyncResp->res.jsonValue["Description"] =
1203 "Collection of System Event Log Entries";
Andrew Geisslercb92c032018-08-17 07:56:14 -07001204
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001205 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001206 logEntryArray = nlohmann::json::array();
Jason M. Bills95820182019-04-22 16:25:34 -07001207 // Go through the log files and create a unique ID for each entry
1208 std::vector<std::filesystem::path> redfishLogFiles;
1209 getRedfishLogFiles(redfishLogFiles);
Ed Tanousb01bf292019-03-25 19:25:26 +00001210 uint64_t entryCount = 0;
Jason M. Billscd225da2019-05-08 15:31:57 -07001211 std::string logEntry;
Jason M. Bills95820182019-04-22 16:25:34 -07001212
1213 // Oldest logs are in the last file, so start there and loop backwards
Jason M. Billscd225da2019-05-08 15:31:57 -07001214 for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1215 it++)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001216 {
Jason M. Billscd225da2019-05-08 15:31:57 -07001217 std::ifstream logStream(*it);
Jason M. Bills95820182019-04-22 16:25:34 -07001218 if (!logStream.is_open())
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001219 {
1220 continue;
1221 }
1222
Jason M. Billse85d6b12019-07-29 17:01:15 -07001223 // Reset the unique ID on the first entry
1224 bool firstEntry = true;
Jason M. Bills95820182019-04-22 16:25:34 -07001225 while (std::getline(logStream, logEntry))
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001226 {
Jason M. Bills95820182019-04-22 16:25:34 -07001227 entryCount++;
1228 // Handle paging using skip (number of entries to skip from the
1229 // start) and top (number of entries to display)
1230 if (entryCount <= skip || entryCount > skip + top)
1231 {
1232 continue;
1233 }
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001234
Jason M. Bills95820182019-04-22 16:25:34 -07001235 std::string idStr;
Jason M. Billse85d6b12019-07-29 17:01:15 -07001236 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
Jason M. Bills95820182019-04-22 16:25:34 -07001237 {
1238 continue;
1239 }
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001240
Jason M. Billse85d6b12019-07-29 17:01:15 -07001241 if (firstEntry)
1242 {
1243 firstEntry = false;
1244 }
1245
Jason M. Bills95820182019-04-22 16:25:34 -07001246 logEntryArray.push_back({});
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001247 nlohmann::json& bmcLogEntry = logEntryArray.back();
Jason M. Bills95820182019-04-22 16:25:34 -07001248 if (fillEventLogEntryJson(idStr, logEntry, bmcLogEntry) != 0)
1249 {
1250 messages::internalError(asyncResp->res);
1251 return;
1252 }
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001253 }
1254 }
1255 asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1256 if (skip + top < entryCount)
1257 {
1258 asyncResp->res.jsonValue["Members@odata.nextLink"] =
Jason M. Bills95820182019-04-22 16:25:34 -07001259 "/redfish/v1/Systems/system/LogServices/EventLog/"
1260 "Entries?$skip=" +
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001261 std::to_string(skip + top);
1262 }
Anthony Wilson08a4e4b2019-04-12 08:23:05 -05001263 }
1264};
1265
Jason M. Bills897967d2019-07-29 17:05:30 -07001266class JournalEventLogEntry : public Node
1267{
1268 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07001269 JournalEventLogEntry(App& app) :
Jason M. Bills897967d2019-07-29 17:05:30 -07001270 Node(app,
1271 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/",
1272 std::string())
1273 {
1274 entityPrivileges = {
1275 {boost::beast::http::verb::get, {{"Login"}}},
1276 {boost::beast::http::verb::head, {{"Login"}}},
1277 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1278 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1279 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1280 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1281 }
1282
1283 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00001284 void doGet(crow::Response& res, const crow::Request&,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001285 const std::vector<std::string>& params) override
Jason M. Bills897967d2019-07-29 17:05:30 -07001286 {
1287 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1288 if (params.size() != 1)
1289 {
1290 messages::internalError(asyncResp->res);
1291 return;
1292 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001293 const std::string& targetID = params[0];
Jason M. Bills897967d2019-07-29 17:05:30 -07001294
1295 // Go through the log files and check the unique ID for each entry to
1296 // find the target entry
1297 std::vector<std::filesystem::path> redfishLogFiles;
1298 getRedfishLogFiles(redfishLogFiles);
1299 std::string logEntry;
1300
1301 // Oldest logs are in the last file, so start there and loop backwards
1302 for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend();
1303 it++)
1304 {
1305 std::ifstream logStream(*it);
1306 if (!logStream.is_open())
1307 {
1308 continue;
1309 }
1310
1311 // Reset the unique ID on the first entry
1312 bool firstEntry = true;
1313 while (std::getline(logStream, logEntry))
1314 {
1315 std::string idStr;
1316 if (!getUniqueEntryID(logEntry, idStr, firstEntry))
1317 {
1318 continue;
1319 }
1320
1321 if (firstEntry)
1322 {
1323 firstEntry = false;
1324 }
1325
1326 if (idStr == targetID)
1327 {
1328 if (fillEventLogEntryJson(idStr, logEntry,
1329 asyncResp->res.jsonValue) != 0)
1330 {
1331 messages::internalError(asyncResp->res);
1332 return;
1333 }
1334 return;
1335 }
1336 }
1337 }
1338 // Requested ID was not found
1339 messages::resourceMissingAtURI(asyncResp->res, targetID);
1340 }
1341};
1342
Anthony Wilson08a4e4b2019-04-12 08:23:05 -05001343class DBusEventLogEntryCollection : public Node
1344{
1345 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07001346 DBusEventLogEntryCollection(App& app) :
Anthony Wilson08a4e4b2019-04-12 08:23:05 -05001347 Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/")
1348 {
1349 entityPrivileges = {
1350 {boost::beast::http::verb::get, {{"Login"}}},
1351 {boost::beast::http::verb::head, {{"Login"}}},
1352 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1353 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1354 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1355 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1356 }
1357
1358 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00001359 void doGet(crow::Response& res, const crow::Request&,
1360 const std::vector<std::string>&) override
Anthony Wilson08a4e4b2019-04-12 08:23:05 -05001361 {
1362 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1363
1364 // Collections don't include the static data added by SubRoute because
1365 // it has a duplicate entry for members
1366 asyncResp->res.jsonValue["@odata.type"] =
1367 "#LogEntryCollection.LogEntryCollection";
Anthony Wilson08a4e4b2019-04-12 08:23:05 -05001368 asyncResp->res.jsonValue["@odata.id"] =
1369 "/redfish/v1/Systems/system/LogServices/EventLog/Entries";
1370 asyncResp->res.jsonValue["Name"] = "System Event Log Entries";
1371 asyncResp->res.jsonValue["Description"] =
1372 "Collection of System Event Log Entries";
1373
Andrew Geisslercb92c032018-08-17 07:56:14 -07001374 // DBus implementation of EventLog/Entries
1375 // Make call to Logging Service to find all log entry objects
1376 crow::connections::systemBus->async_method_call(
1377 [asyncResp](const boost::system::error_code ec,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001378 GetManagedObjectsType& resp) {
Andrew Geisslercb92c032018-08-17 07:56:14 -07001379 if (ec)
1380 {
1381 // TODO Handle for specific error code
1382 BMCWEB_LOG_ERROR
1383 << "getLogEntriesIfaceData resp_handler got error "
1384 << ec;
1385 messages::internalError(asyncResp->res);
1386 return;
1387 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001388 nlohmann::json& entriesArray =
Andrew Geisslercb92c032018-08-17 07:56:14 -07001389 asyncResp->res.jsonValue["Members"];
1390 entriesArray = nlohmann::json::array();
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001391 for (auto& objectPath : resp)
Andrew Geisslercb92c032018-08-17 07:56:14 -07001392 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001393 for (auto& interfaceMap : objectPath.second)
Andrew Geisslercb92c032018-08-17 07:56:14 -07001394 {
1395 if (interfaceMap.first !=
1396 "xyz.openbmc_project.Logging.Entry")
1397 {
1398 BMCWEB_LOG_DEBUG << "Bailing early on "
1399 << interfaceMap.first;
1400 continue;
1401 }
1402 entriesArray.push_back({});
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001403 nlohmann::json& thisEntry = entriesArray.back();
1404 uint32_t* id = nullptr;
Ed Tanous66664f22019-10-11 13:05:49 -07001405 std::time_t timestamp{};
George Liud139c232020-08-18 18:48:57 +08001406 std::time_t updateTimestamp{};
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001407 std::string* severity = nullptr;
1408 std::string* message = nullptr;
George Liud139c232020-08-18 18:48:57 +08001409
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001410 for (auto& propertyMap : interfaceMap.second)
Andrew Geisslercb92c032018-08-17 07:56:14 -07001411 {
1412 if (propertyMap.first == "Id")
1413 {
Patrick Williams8d78b7a2020-05-13 11:24:20 -05001414 id = std::get_if<uint32_t>(&propertyMap.second);
Andrew Geisslercb92c032018-08-17 07:56:14 -07001415 if (id == nullptr)
1416 {
Asmitha Karunanithi0f1d8ed2020-08-02 11:11:47 -05001417 messages::internalError(asyncResp->res);
Andrew Geisslercb92c032018-08-17 07:56:14 -07001418 }
1419 }
1420 else if (propertyMap.first == "Timestamp")
1421 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001422 const uint64_t* millisTimeStamp =
Andrew Geisslercb92c032018-08-17 07:56:14 -07001423 std::get_if<uint64_t>(&propertyMap.second);
1424 if (millisTimeStamp == nullptr)
1425 {
Asmitha Karunanithi0f1d8ed2020-08-02 11:11:47 -05001426 messages::internalError(asyncResp->res);
Andrew Geisslercb92c032018-08-17 07:56:14 -07001427 }
George Liuebd45902020-08-26 14:21:10 +08001428 else
1429 {
1430 timestamp = crow::utility::getTimestamp(
1431 *millisTimeStamp);
1432 }
George Liud139c232020-08-18 18:48:57 +08001433 }
1434 else if (propertyMap.first == "UpdateTimestamp")
1435 {
1436 const uint64_t* millisTimeStamp =
1437 std::get_if<uint64_t>(&propertyMap.second);
1438 if (millisTimeStamp == nullptr)
1439 {
1440 messages::internalError(asyncResp->res);
1441 }
George Liuebd45902020-08-26 14:21:10 +08001442 else
1443 {
1444 updateTimestamp =
1445 crow::utility::getTimestamp(
1446 *millisTimeStamp);
1447 }
Andrew Geisslercb92c032018-08-17 07:56:14 -07001448 }
1449 else if (propertyMap.first == "Severity")
1450 {
1451 severity = std::get_if<std::string>(
1452 &propertyMap.second);
1453 if (severity == nullptr)
1454 {
Asmitha Karunanithi0f1d8ed2020-08-02 11:11:47 -05001455 messages::internalError(asyncResp->res);
Andrew Geisslercb92c032018-08-17 07:56:14 -07001456 }
1457 }
1458 else if (propertyMap.first == "Message")
1459 {
1460 message = std::get_if<std::string>(
1461 &propertyMap.second);
1462 if (message == nullptr)
1463 {
Asmitha Karunanithi0f1d8ed2020-08-02 11:11:47 -05001464 messages::internalError(asyncResp->res);
Andrew Geisslercb92c032018-08-17 07:56:14 -07001465 }
1466 }
1467 }
1468 thisEntry = {
George Liud139c232020-08-18 18:48:57 +08001469 {"@odata.type", "#LogEntry.v1_6_0.LogEntry"},
Andrew Geisslercb92c032018-08-17 07:56:14 -07001470 {"@odata.id",
1471 "/redfish/v1/Systems/system/LogServices/EventLog/"
1472 "Entries/" +
1473 std::to_string(*id)},
Anthony Wilson27062602019-04-22 02:10:09 -05001474 {"Name", "System Event Log Entry"},
Andrew Geisslercb92c032018-08-17 07:56:14 -07001475 {"Id", std::to_string(*id)},
1476 {"Message", *message},
1477 {"EntryType", "Event"},
1478 {"Severity",
1479 translateSeverityDbusToRedfish(*severity)},
George Liud139c232020-08-18 18:48:57 +08001480 {"Created", crow::utility::getDateTime(timestamp)},
1481 {"Modified",
1482 crow::utility::getDateTime(updateTimestamp)}};
Andrew Geisslercb92c032018-08-17 07:56:14 -07001483 }
1484 }
1485 std::sort(entriesArray.begin(), entriesArray.end(),
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001486 [](const nlohmann::json& left,
1487 const nlohmann::json& right) {
Andrew Geisslercb92c032018-08-17 07:56:14 -07001488 return (left["Id"] <= right["Id"]);
1489 });
1490 asyncResp->res.jsonValue["Members@odata.count"] =
1491 entriesArray.size();
1492 },
1493 "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging",
1494 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001495 }
1496};
1497
Anthony Wilson08a4e4b2019-04-12 08:23:05 -05001498class DBusEventLogEntry : public Node
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001499{
1500 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07001501 DBusEventLogEntry(App& app) :
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001502 Node(app,
Ed Tanous029573d2019-02-01 10:57:49 -08001503 "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/",
1504 std::string())
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001505 {
1506 entityPrivileges = {
1507 {boost::beast::http::verb::get, {{"Login"}}},
1508 {boost::beast::http::verb::head, {{"Login"}}},
1509 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1510 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1511 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1512 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1513 }
1514
1515 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00001516 void doGet(crow::Response& res, const crow::Request&,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001517 const std::vector<std::string>& params) override
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001518 {
1519 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Ed Tanous029573d2019-02-01 10:57:49 -08001520 if (params.size() != 1)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001521 {
1522 messages::internalError(asyncResp->res);
1523 return;
1524 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001525 const std::string& entryID = params[0];
Andrew Geisslercb92c032018-08-17 07:56:14 -07001526
Andrew Geisslercb92c032018-08-17 07:56:14 -07001527 // DBus implementation of EventLog/Entries
1528 // Make call to Logging Service to find all log entry objects
1529 crow::connections::systemBus->async_method_call(
1530 [asyncResp, entryID](const boost::system::error_code ec,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001531 GetManagedPropertyType& resp) {
Andrew Geisslercb92c032018-08-17 07:56:14 -07001532 if (ec)
1533 {
1534 BMCWEB_LOG_ERROR
1535 << "EventLogEntry (DBus) resp_handler got error " << ec;
1536 messages::internalError(asyncResp->res);
1537 return;
1538 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001539 uint32_t* id = nullptr;
Ed Tanous66664f22019-10-11 13:05:49 -07001540 std::time_t timestamp{};
George Liud139c232020-08-18 18:48:57 +08001541 std::time_t updateTimestamp{};
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001542 std::string* severity = nullptr;
1543 std::string* message = nullptr;
George Liud139c232020-08-18 18:48:57 +08001544
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001545 for (auto& propertyMap : resp)
Andrew Geisslercb92c032018-08-17 07:56:14 -07001546 {
1547 if (propertyMap.first == "Id")
1548 {
1549 id = std::get_if<uint32_t>(&propertyMap.second);
1550 if (id == nullptr)
1551 {
Asmitha Karunanithi0f1d8ed2020-08-02 11:11:47 -05001552 messages::internalError(asyncResp->res);
Andrew Geisslercb92c032018-08-17 07:56:14 -07001553 }
1554 }
1555 else if (propertyMap.first == "Timestamp")
1556 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001557 const uint64_t* millisTimeStamp =
Andrew Geisslercb92c032018-08-17 07:56:14 -07001558 std::get_if<uint64_t>(&propertyMap.second);
1559 if (millisTimeStamp == nullptr)
1560 {
Asmitha Karunanithi0f1d8ed2020-08-02 11:11:47 -05001561 messages::internalError(asyncResp->res);
Andrew Geisslercb92c032018-08-17 07:56:14 -07001562 }
George Liuebd45902020-08-26 14:21:10 +08001563 else
1564 {
1565 timestamp =
1566 crow::utility::getTimestamp(*millisTimeStamp);
1567 }
George Liud139c232020-08-18 18:48:57 +08001568 }
1569 else if (propertyMap.first == "UpdateTimestamp")
1570 {
1571 const uint64_t* millisTimeStamp =
1572 std::get_if<uint64_t>(&propertyMap.second);
1573 if (millisTimeStamp == nullptr)
1574 {
1575 messages::internalError(asyncResp->res);
1576 }
George Liuebd45902020-08-26 14:21:10 +08001577 else
1578 {
1579 updateTimestamp =
1580 crow::utility::getTimestamp(*millisTimeStamp);
1581 }
Andrew Geisslercb92c032018-08-17 07:56:14 -07001582 }
1583 else if (propertyMap.first == "Severity")
1584 {
1585 severity =
1586 std::get_if<std::string>(&propertyMap.second);
1587 if (severity == nullptr)
1588 {
Asmitha Karunanithi0f1d8ed2020-08-02 11:11:47 -05001589 messages::internalError(asyncResp->res);
Andrew Geisslercb92c032018-08-17 07:56:14 -07001590 }
1591 }
1592 else if (propertyMap.first == "Message")
1593 {
1594 message = std::get_if<std::string>(&propertyMap.second);
1595 if (message == nullptr)
1596 {
Asmitha Karunanithi0f1d8ed2020-08-02 11:11:47 -05001597 messages::internalError(asyncResp->res);
Andrew Geisslercb92c032018-08-17 07:56:14 -07001598 }
1599 }
1600 }
Ed Tanous271584a2019-07-09 16:24:22 -07001601 if (id == nullptr || message == nullptr || severity == nullptr)
1602 {
1603 return;
1604 }
Andrew Geisslercb92c032018-08-17 07:56:14 -07001605 asyncResp->res.jsonValue = {
George Liud139c232020-08-18 18:48:57 +08001606 {"@odata.type", "#LogEntry.v1_6_0.LogEntry"},
Andrew Geisslercb92c032018-08-17 07:56:14 -07001607 {"@odata.id",
1608 "/redfish/v1/Systems/system/LogServices/EventLog/"
1609 "Entries/" +
1610 std::to_string(*id)},
Anthony Wilson27062602019-04-22 02:10:09 -05001611 {"Name", "System Event Log Entry"},
Andrew Geisslercb92c032018-08-17 07:56:14 -07001612 {"Id", std::to_string(*id)},
1613 {"Message", *message},
1614 {"EntryType", "Event"},
1615 {"Severity", translateSeverityDbusToRedfish(*severity)},
George Liud139c232020-08-18 18:48:57 +08001616 {"Created", crow::utility::getDateTime(timestamp)},
1617 {"Modified", crow::utility::getDateTime(updateTimestamp)}};
Andrew Geisslercb92c032018-08-17 07:56:14 -07001618 },
1619 "xyz.openbmc_project.Logging",
1620 "/xyz/openbmc_project/logging/entry/" + entryID,
1621 "org.freedesktop.DBus.Properties", "GetAll",
1622 "xyz.openbmc_project.Logging.Entry");
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001623 }
Chicago Duan336e96c2019-07-15 14:22:08 +08001624
Ed Tanouscb13a392020-07-25 19:02:03 +00001625 void doDelete(crow::Response& res, const crow::Request&,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001626 const std::vector<std::string>& params) override
Chicago Duan336e96c2019-07-15 14:22:08 +08001627 {
1628
1629 BMCWEB_LOG_DEBUG << "Do delete single event entries.";
1630
1631 auto asyncResp = std::make_shared<AsyncResp>(res);
1632
1633 if (params.size() != 1)
1634 {
1635 messages::internalError(asyncResp->res);
1636 return;
1637 }
1638 std::string entryID = params[0];
1639
1640 dbus::utility::escapePathForDbus(entryID);
1641
1642 // Process response from Logging service.
1643 auto respHandler = [asyncResp](const boost::system::error_code ec) {
1644 BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done";
1645 if (ec)
1646 {
1647 // TODO Handle for specific error code
1648 BMCWEB_LOG_ERROR
1649 << "EventLogEntry (DBus) doDelete respHandler got error "
1650 << ec;
1651 asyncResp->res.result(
1652 boost::beast::http::status::internal_server_error);
1653 return;
1654 }
1655
1656 asyncResp->res.result(boost::beast::http::status::ok);
1657 };
1658
1659 // Make call to Logging service to request Delete Log
1660 crow::connections::systemBus->async_method_call(
1661 respHandler, "xyz.openbmc_project.Logging",
1662 "/xyz/openbmc_project/logging/entry/" + entryID,
1663 "xyz.openbmc_project.Object.Delete", "Delete");
1664 }
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001665};
1666
1667class BMCLogServiceCollection : public Node
1668{
1669 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07001670 BMCLogServiceCollection(App& app) :
Ed Tanous4ed77cd2018-10-15 08:08:07 -07001671 Node(app, "/redfish/v1/Managers/bmc/LogServices/")
Ed Tanous1da66f72018-07-27 16:13:37 -07001672 {
Ed Tanous1da66f72018-07-27 16:13:37 -07001673 entityPrivileges = {
Jason M. Billse1f26342018-07-18 12:12:00 -07001674 {boost::beast::http::verb::get, {{"Login"}}},
1675 {boost::beast::http::verb::head, {{"Login"}}},
1676 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1677 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1678 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1679 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
Ed Tanous1da66f72018-07-27 16:13:37 -07001680 }
1681
1682 private:
1683 /**
1684 * Functions triggers appropriate requests on DBus
1685 */
Ed Tanouscb13a392020-07-25 19:02:03 +00001686 void doGet(crow::Response& res, const crow::Request&,
1687 const std::vector<std::string>&) override
Ed Tanous1da66f72018-07-27 16:13:37 -07001688 {
Jason M. Billse1f26342018-07-18 12:12:00 -07001689 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Ed Tanous1da66f72018-07-27 16:13:37 -07001690 // Collections don't include the static data added by SubRoute because
1691 // it has a duplicate entry for members
Jason M. Billse1f26342018-07-18 12:12:00 -07001692 asyncResp->res.jsonValue["@odata.type"] =
Ed Tanous1da66f72018-07-27 16:13:37 -07001693 "#LogServiceCollection.LogServiceCollection";
Jason M. Billse1f26342018-07-18 12:12:00 -07001694 asyncResp->res.jsonValue["@odata.id"] =
1695 "/redfish/v1/Managers/bmc/LogServices";
1696 asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection";
1697 asyncResp->res.jsonValue["Description"] =
Ed Tanous1da66f72018-07-27 16:13:37 -07001698 "Collection of LogServices for this Manager";
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001699 nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"];
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001700 logServiceArray = nlohmann::json::array();
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05001701#ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG
1702 logServiceArray.push_back(
1703 {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump"}});
1704#endif
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001705#ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL
1706 logServiceArray.push_back(
Anthony Wilson08a4e4b2019-04-12 08:23:05 -05001707 {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal"}});
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001708#endif
Jason M. Billse1f26342018-07-18 12:12:00 -07001709 asyncResp->res.jsonValue["Members@odata.count"] =
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001710 logServiceArray.size();
Ed Tanous1da66f72018-07-27 16:13:37 -07001711 }
1712};
1713
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001714class BMCJournalLogService : public Node
Ed Tanous1da66f72018-07-27 16:13:37 -07001715{
1716 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07001717 BMCJournalLogService(App& app) :
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001718 Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/")
Jason M. Billse1f26342018-07-18 12:12:00 -07001719 {
Jason M. Billse1f26342018-07-18 12:12:00 -07001720 entityPrivileges = {
1721 {boost::beast::http::verb::get, {{"Login"}}},
1722 {boost::beast::http::verb::head, {{"Login"}}},
1723 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1724 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1725 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1726 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1727 }
1728
1729 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00001730 void doGet(crow::Response& res, const crow::Request&,
1731 const std::vector<std::string>&) override
Jason M. Billse1f26342018-07-18 12:12:00 -07001732 {
1733 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Jason M. Billse1f26342018-07-18 12:12:00 -07001734 asyncResp->res.jsonValue["@odata.type"] =
1735 "#LogService.v1_1_0.LogService";
Ed Tanous0f74e642018-11-12 15:17:05 -08001736 asyncResp->res.jsonValue["@odata.id"] =
1737 "/redfish/v1/Managers/bmc/LogServices/Journal";
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001738 asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service";
1739 asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service";
1740 asyncResp->res.jsonValue["Id"] = "BMC Journal";
Jason M. Billse1f26342018-07-18 12:12:00 -07001741 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
Jason M. Billscd50aa42019-02-12 17:09:02 -08001742 asyncResp->res.jsonValue["Entries"] = {
1743 {"@odata.id",
Ed Tanous086be232019-05-23 11:47:09 -07001744 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}};
Jason M. Billse1f26342018-07-18 12:12:00 -07001745 }
1746};
1747
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001748static int fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID,
1749 sd_journal* journal,
1750 nlohmann::json& bmcJournalLogEntryJson)
Jason M. Billse1f26342018-07-18 12:12:00 -07001751{
1752 // Get the Log Entry contents
1753 int ret = 0;
Jason M. Billse1f26342018-07-18 12:12:00 -07001754
Ed Tanous39e77502019-03-04 17:35:53 -08001755 std::string_view msg;
Jason M. Bills16428a12018-11-02 12:42:29 -07001756 ret = getJournalMetadata(journal, "MESSAGE", msg);
Jason M. Billse1f26342018-07-18 12:12:00 -07001757 if (ret < 0)
1758 {
1759 BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret);
1760 return 1;
1761 }
Jason M. Billse1f26342018-07-18 12:12:00 -07001762
1763 // Get the severity from the PRIORITY field
Ed Tanous271584a2019-07-09 16:24:22 -07001764 long int severity = 8; // Default to an invalid priority
Jason M. Bills16428a12018-11-02 12:42:29 -07001765 ret = getJournalMetadata(journal, "PRIORITY", 10, severity);
Jason M. Billse1f26342018-07-18 12:12:00 -07001766 if (ret < 0)
1767 {
1768 BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret);
Jason M. Billse1f26342018-07-18 12:12:00 -07001769 }
Jason M. Billse1f26342018-07-18 12:12:00 -07001770
1771 // Get the Created time from the timestamp
Jason M. Bills16428a12018-11-02 12:42:29 -07001772 std::string entryTimeStr;
1773 if (!getEntryTimestamp(journal, entryTimeStr))
Jason M. Billse1f26342018-07-18 12:12:00 -07001774 {
Jason M. Bills16428a12018-11-02 12:42:29 -07001775 return 1;
Jason M. Billse1f26342018-07-18 12:12:00 -07001776 }
Jason M. Billse1f26342018-07-18 12:12:00 -07001777
1778 // Fill in the log entry with the gathered data
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001779 bmcJournalLogEntryJson = {
Andrew Geisslercb92c032018-08-17 07:56:14 -07001780 {"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001781 {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" +
1782 bmcJournalLogEntryID},
Jason M. Billse1f26342018-07-18 12:12:00 -07001783 {"Name", "BMC Journal Entry"},
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001784 {"Id", bmcJournalLogEntryID},
Jason M. Bills16428a12018-11-02 12:42:29 -07001785 {"Message", msg},
Jason M. Billse1f26342018-07-18 12:12:00 -07001786 {"EntryType", "Oem"},
1787 {"Severity",
Jason M. Billsb6a61a52019-08-01 14:26:15 -07001788 severity <= 2 ? "Critical" : severity <= 4 ? "Warning" : "OK"},
Ed Tanous086be232019-05-23 11:47:09 -07001789 {"OemRecordFormat", "BMC Journal Entry"},
Jason M. Billse1f26342018-07-18 12:12:00 -07001790 {"Created", std::move(entryTimeStr)}};
1791 return 0;
1792}
1793
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001794class BMCJournalLogEntryCollection : public Node
Jason M. Billse1f26342018-07-18 12:12:00 -07001795{
1796 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07001797 BMCJournalLogEntryCollection(App& app) :
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001798 Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/")
Jason M. Billse1f26342018-07-18 12:12:00 -07001799 {
Jason M. Billse1f26342018-07-18 12:12:00 -07001800 entityPrivileges = {
1801 {boost::beast::http::verb::get, {{"Login"}}},
1802 {boost::beast::http::verb::head, {{"Login"}}},
1803 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1804 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1805 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1806 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1807 }
1808
1809 private:
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001810 void doGet(crow::Response& res, const crow::Request& req,
Ed Tanouscb13a392020-07-25 19:02:03 +00001811 const std::vector<std::string>&) override
Jason M. Billse1f26342018-07-18 12:12:00 -07001812 {
1813 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Jason M. Bills193ad2f2018-09-26 15:08:52 -07001814 static constexpr const long maxEntriesPerPage = 1000;
Ed Tanous271584a2019-07-09 16:24:22 -07001815 uint64_t skip = 0;
1816 uint64_t top = maxEntriesPerPage; // Show max entries by default
Jason M. Bills16428a12018-11-02 12:42:29 -07001817 if (!getSkipParam(asyncResp->res, req, skip))
Jason M. Bills193ad2f2018-09-26 15:08:52 -07001818 {
Jason M. Bills16428a12018-11-02 12:42:29 -07001819 return;
Jason M. Bills193ad2f2018-09-26 15:08:52 -07001820 }
Jason M. Bills16428a12018-11-02 12:42:29 -07001821 if (!getTopParam(asyncResp->res, req, top))
Jason M. Bills193ad2f2018-09-26 15:08:52 -07001822 {
Jason M. Bills16428a12018-11-02 12:42:29 -07001823 return;
Jason M. Bills193ad2f2018-09-26 15:08:52 -07001824 }
Jason M. Billse1f26342018-07-18 12:12:00 -07001825 // Collections don't include the static data added by SubRoute because
1826 // it has a duplicate entry for members
1827 asyncResp->res.jsonValue["@odata.type"] =
1828 "#LogEntryCollection.LogEntryCollection";
Ed Tanous0f74e642018-11-12 15:17:05 -08001829 asyncResp->res.jsonValue["@odata.id"] =
1830 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
Jason M. Billse1f26342018-07-18 12:12:00 -07001831 asyncResp->res.jsonValue["@odata.id"] =
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001832 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries";
Jason M. Billse1f26342018-07-18 12:12:00 -07001833 asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries";
1834 asyncResp->res.jsonValue["Description"] =
1835 "Collection of BMC Journal Entries";
Ed Tanous0f74e642018-11-12 15:17:05 -08001836 asyncResp->res.jsonValue["@odata.id"] =
1837 "/redfish/v1/Managers/bmc/LogServices/BmcLog/Entries";
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001838 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
Jason M. Billse1f26342018-07-18 12:12:00 -07001839 logEntryArray = nlohmann::json::array();
1840
1841 // Go through the journal and use the timestamp to create a unique ID
1842 // for each entry
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001843 sd_journal* journalTmp = nullptr;
Jason M. Billse1f26342018-07-18 12:12:00 -07001844 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
1845 if (ret < 0)
1846 {
1847 BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
Jason M. Billsf12894f2018-10-09 12:45:45 -07001848 messages::internalError(asyncResp->res);
Jason M. Billse1f26342018-07-18 12:12:00 -07001849 return;
1850 }
1851 std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
1852 journalTmp, sd_journal_close);
1853 journalTmp = nullptr;
Ed Tanousb01bf292019-03-25 19:25:26 +00001854 uint64_t entryCount = 0;
Jason M. Billse85d6b12019-07-29 17:01:15 -07001855 // Reset the unique ID on the first entry
1856 bool firstEntry = true;
Jason M. Billse1f26342018-07-18 12:12:00 -07001857 SD_JOURNAL_FOREACH(journal.get())
1858 {
Jason M. Bills193ad2f2018-09-26 15:08:52 -07001859 entryCount++;
1860 // Handle paging using skip (number of entries to skip from the
1861 // start) and top (number of entries to display)
1862 if (entryCount <= skip || entryCount > skip + top)
1863 {
1864 continue;
1865 }
1866
Jason M. Bills16428a12018-11-02 12:42:29 -07001867 std::string idStr;
Jason M. Billse85d6b12019-07-29 17:01:15 -07001868 if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
Jason M. Billse1f26342018-07-18 12:12:00 -07001869 {
Jason M. Billse1f26342018-07-18 12:12:00 -07001870 continue;
1871 }
Jason M. Billse1f26342018-07-18 12:12:00 -07001872
Jason M. Billse85d6b12019-07-29 17:01:15 -07001873 if (firstEntry)
1874 {
1875 firstEntry = false;
1876 }
1877
Jason M. Billse1f26342018-07-18 12:12:00 -07001878 logEntryArray.push_back({});
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001879 nlohmann::json& bmcJournalLogEntry = logEntryArray.back();
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001880 if (fillBMCJournalLogEntryJson(idStr, journal.get(),
1881 bmcJournalLogEntry) != 0)
Jason M. Billse1f26342018-07-18 12:12:00 -07001882 {
Jason M. Billsf12894f2018-10-09 12:45:45 -07001883 messages::internalError(asyncResp->res);
Jason M. Billse1f26342018-07-18 12:12:00 -07001884 return;
1885 }
1886 }
Jason M. Bills193ad2f2018-09-26 15:08:52 -07001887 asyncResp->res.jsonValue["Members@odata.count"] = entryCount;
1888 if (skip + top < entryCount)
1889 {
1890 asyncResp->res.jsonValue["Members@odata.nextLink"] =
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001891 "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" +
Jason M. Bills193ad2f2018-09-26 15:08:52 -07001892 std::to_string(skip + top);
1893 }
Jason M. Billse1f26342018-07-18 12:12:00 -07001894 }
1895};
1896
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001897class BMCJournalLogEntry : public Node
Jason M. Billse1f26342018-07-18 12:12:00 -07001898{
1899 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07001900 BMCJournalLogEntry(App& app) :
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001901 Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/",
Jason M. Billse1f26342018-07-18 12:12:00 -07001902 std::string())
1903 {
1904 entityPrivileges = {
1905 {boost::beast::http::verb::get, {{"Login"}}},
1906 {boost::beast::http::verb::head, {{"Login"}}},
1907 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1908 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1909 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1910 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1911 }
1912
1913 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00001914 void doGet(crow::Response& res, const crow::Request&,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001915 const std::vector<std::string>& params) override
Jason M. Billse1f26342018-07-18 12:12:00 -07001916 {
1917 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
1918 if (params.size() != 1)
1919 {
Jason M. Billsf12894f2018-10-09 12:45:45 -07001920 messages::internalError(asyncResp->res);
Jason M. Billse1f26342018-07-18 12:12:00 -07001921 return;
1922 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001923 const std::string& entryID = params[0];
Jason M. Billse1f26342018-07-18 12:12:00 -07001924 // Convert the unique ID back to a timestamp to find the entry
Jason M. Billse1f26342018-07-18 12:12:00 -07001925 uint64_t ts = 0;
Ed Tanous271584a2019-07-09 16:24:22 -07001926 uint64_t index = 0;
Jason M. Bills16428a12018-11-02 12:42:29 -07001927 if (!getTimestampFromID(asyncResp->res, entryID, ts, index))
Jason M. Billse1f26342018-07-18 12:12:00 -07001928 {
Jason M. Bills16428a12018-11-02 12:42:29 -07001929 return;
Jason M. Billse1f26342018-07-18 12:12:00 -07001930 }
1931
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001932 sd_journal* journalTmp = nullptr;
Jason M. Billse1f26342018-07-18 12:12:00 -07001933 int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY);
1934 if (ret < 0)
1935 {
1936 BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret);
Jason M. Billsf12894f2018-10-09 12:45:45 -07001937 messages::internalError(asyncResp->res);
Jason M. Billse1f26342018-07-18 12:12:00 -07001938 return;
1939 }
1940 std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal(
1941 journalTmp, sd_journal_close);
1942 journalTmp = nullptr;
1943 // Go to the timestamp in the log and move to the entry at the index
Jason M. Billsaf07e3f2019-08-01 14:41:39 -07001944 // tracking the unique ID
1945 std::string idStr;
1946 bool firstEntry = true;
Jason M. Billse1f26342018-07-18 12:12:00 -07001947 ret = sd_journal_seek_realtime_usec(journal.get(), ts);
Manojkiran Eda2056b6d2020-05-28 08:57:36 +05301948 if (ret < 0)
1949 {
1950 BMCWEB_LOG_ERROR << "failed to seek to an entry in journal"
1951 << strerror(-ret);
1952 messages::internalError(asyncResp->res);
1953 return;
1954 }
Ed Tanous271584a2019-07-09 16:24:22 -07001955 for (uint64_t i = 0; i <= index; i++)
Jason M. Billse1f26342018-07-18 12:12:00 -07001956 {
1957 sd_journal_next(journal.get());
Jason M. Billsaf07e3f2019-08-01 14:41:39 -07001958 if (!getUniqueEntryID(journal.get(), idStr, firstEntry))
1959 {
1960 messages::internalError(asyncResp->res);
1961 return;
1962 }
1963 if (firstEntry)
1964 {
1965 firstEntry = false;
1966 }
Jason M. Billse1f26342018-07-18 12:12:00 -07001967 }
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001968 // Confirm that the entry ID matches what was requested
Jason M. Billsaf07e3f2019-08-01 14:41:39 -07001969 if (idStr != entryID)
Jason M. Billsc4bf6372018-11-05 13:48:27 -08001970 {
1971 messages::resourceMissingAtURI(asyncResp->res, entryID);
1972 return;
1973 }
1974
1975 if (fillBMCJournalLogEntryJson(entryID, journal.get(),
1976 asyncResp->res.jsonValue) != 0)
Jason M. Billse1f26342018-07-18 12:12:00 -07001977 {
Jason M. Billsf12894f2018-10-09 12:45:45 -07001978 messages::internalError(asyncResp->res);
Jason M. Billse1f26342018-07-18 12:12:00 -07001979 return;
1980 }
1981 }
1982};
1983
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05001984class BMCDumpService : public Node
raviteja-bc9bb6862020-02-03 11:53:32 -06001985{
1986 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07001987 BMCDumpService(App& app) :
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05001988 Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/")
raviteja-bc9bb6862020-02-03 11:53:32 -06001989 {
1990 entityPrivileges = {
1991 {boost::beast::http::verb::get, {{"Login"}}},
1992 {boost::beast::http::verb::head, {{"Login"}}},
1993 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
1994 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
1995 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
1996 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
1997 }
1998
1999 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00002000 void doGet(crow::Response& res, const crow::Request&,
2001 const std::vector<std::string>&) override
raviteja-bc9bb6862020-02-03 11:53:32 -06002002 {
2003 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2004
2005 asyncResp->res.jsonValue["@odata.id"] =
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002006 "/redfish/v1/Managers/bmc/LogServices/Dump";
raviteja-bc9bb6862020-02-03 11:53:32 -06002007 asyncResp->res.jsonValue["@odata.type"] =
Asmitha Karunanithid337bb72020-09-21 10:34:02 -05002008 "#LogService.v1_2_0.LogService";
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002009 asyncResp->res.jsonValue["Name"] = "Dump LogService";
2010 asyncResp->res.jsonValue["Description"] = "BMC Dump LogService";
2011 asyncResp->res.jsonValue["Id"] = "Dump";
raviteja-bc9bb6862020-02-03 11:53:32 -06002012 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
raviteja-bc9bb6862020-02-03 11:53:32 -06002013 asyncResp->res.jsonValue["Entries"] = {
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002014 {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"}};
2015 asyncResp->res.jsonValue["Actions"] = {
2016 {"#LogService.ClearLog",
2017 {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/"
2018 "Actions/LogService.ClearLog"}}},
Asmitha Karunanithid337bb72020-09-21 10:34:02 -05002019 {"#LogService.CollectDiagnosticData",
2020 {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/"
2021 "Actions/LogService.CollectDiagnosticData"}}}};
raviteja-bc9bb6862020-02-03 11:53:32 -06002022 }
2023};
2024
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002025class BMCDumpEntryCollection : public Node
raviteja-bc9bb6862020-02-03 11:53:32 -06002026{
2027 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002028 BMCDumpEntryCollection(App& app) :
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002029 Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/")
raviteja-bc9bb6862020-02-03 11:53:32 -06002030 {
2031 entityPrivileges = {
2032 {boost::beast::http::verb::get, {{"Login"}}},
2033 {boost::beast::http::verb::head, {{"Login"}}},
2034 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2035 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2036 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2037 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2038 }
2039
2040 private:
2041 /**
2042 * Functions triggers appropriate requests on DBus
2043 */
Ed Tanouscb13a392020-07-25 19:02:03 +00002044 void doGet(crow::Response& res, const crow::Request&,
2045 const std::vector<std::string>&) override
raviteja-bc9bb6862020-02-03 11:53:32 -06002046 {
2047 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2048
2049 asyncResp->res.jsonValue["@odata.type"] =
2050 "#LogEntryCollection.LogEntryCollection";
2051 asyncResp->res.jsonValue["@odata.id"] =
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002052 "/redfish/v1/Managers/bmc/LogServices/Dump/Entries";
2053 asyncResp->res.jsonValue["Name"] = "BMC Dump Entries";
raviteja-bc9bb6862020-02-03 11:53:32 -06002054 asyncResp->res.jsonValue["Description"] =
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002055 "Collection of BMC Dump Entries";
raviteja-bc9bb6862020-02-03 11:53:32 -06002056
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002057 getDumpEntryCollection(asyncResp, "BMC");
raviteja-bc9bb6862020-02-03 11:53:32 -06002058 }
2059};
2060
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002061class BMCDumpEntry : public Node
raviteja-bc9bb6862020-02-03 11:53:32 -06002062{
2063 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002064 BMCDumpEntry(App& app) :
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002065 Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/",
raviteja-bc9bb6862020-02-03 11:53:32 -06002066 std::string())
2067 {
2068 entityPrivileges = {
2069 {boost::beast::http::verb::get, {{"Login"}}},
2070 {boost::beast::http::verb::head, {{"Login"}}},
2071 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2072 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2073 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2074 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2075 }
2076
2077 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00002078 void doGet(crow::Response& res, const crow::Request&,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002079 const std::vector<std::string>& params) override
raviteja-bc9bb6862020-02-03 11:53:32 -06002080 {
2081 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2082 if (params.size() != 1)
2083 {
2084 messages::internalError(asyncResp->res);
2085 return;
2086 }
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002087 getDumpEntryById(asyncResp, params[0], "BMC");
raviteja-bc9bb6862020-02-03 11:53:32 -06002088 }
2089
Ed Tanouscb13a392020-07-25 19:02:03 +00002090 void doDelete(crow::Response& res, const crow::Request&,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002091 const std::vector<std::string>& params) override
raviteja-bc9bb6862020-02-03 11:53:32 -06002092 {
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002093 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
raviteja-bc9bb6862020-02-03 11:53:32 -06002094 if (params.size() != 1)
2095 {
2096 messages::internalError(asyncResp->res);
2097 return;
2098 }
Stanley Chu98782562020-11-04 16:10:24 +08002099 deleteDumpEntry(asyncResp, params[0], "bmc");
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002100 }
2101};
raviteja-bc9bb6862020-02-03 11:53:32 -06002102
Asmitha Karunanithia43be802020-05-07 05:05:36 -05002103class BMCDumpCreate : public Node
2104{
2105 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002106 BMCDumpCreate(App& app) :
Asmitha Karunanithia43be802020-05-07 05:05:36 -05002107 Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/"
Asmitha Karunanithid337bb72020-09-21 10:34:02 -05002108 "Actions/"
2109 "LogService.CollectDiagnosticData/")
Asmitha Karunanithia43be802020-05-07 05:05:36 -05002110 {
2111 entityPrivileges = {
2112 {boost::beast::http::verb::get, {{"Login"}}},
2113 {boost::beast::http::verb::head, {{"Login"}}},
2114 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2115 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2116 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2117 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2118 }
2119
2120 private:
2121 void doPost(crow::Response& res, const crow::Request& req,
Ed Tanouscb13a392020-07-25 19:02:03 +00002122 const std::vector<std::string>&) override
Asmitha Karunanithia43be802020-05-07 05:05:36 -05002123 {
2124 createDump(res, req, "BMC");
2125 }
2126};
2127
Asmitha Karunanithi80319af2020-05-07 05:30:21 -05002128class BMCDumpClear : public Node
2129{
2130 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002131 BMCDumpClear(App& app) :
Asmitha Karunanithi80319af2020-05-07 05:30:21 -05002132 Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/"
2133 "Actions/"
2134 "LogService.ClearLog/")
2135 {
2136 entityPrivileges = {
2137 {boost::beast::http::verb::get, {{"Login"}}},
2138 {boost::beast::http::verb::head, {{"Login"}}},
2139 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2140 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2141 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2142 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2143 }
2144
2145 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00002146 void doPost(crow::Response& res, const crow::Request&,
2147 const std::vector<std::string>&) override
Asmitha Karunanithi80319af2020-05-07 05:30:21 -05002148 {
Asmitha Karunanithib47452b2020-09-25 02:02:19 -05002149 clearDump(res, "BMC");
Asmitha Karunanithi80319af2020-05-07 05:30:21 -05002150 }
2151};
2152
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002153class SystemDumpService : public Node
2154{
2155 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002156 SystemDumpService(App& app) :
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002157 Node(app, "/redfish/v1/Systems/system/LogServices/Dump/")
2158 {
2159 entityPrivileges = {
2160 {boost::beast::http::verb::get, {{"Login"}}},
2161 {boost::beast::http::verb::head, {{"Login"}}},
2162 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2163 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2164 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2165 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2166 }
raviteja-bc9bb6862020-02-03 11:53:32 -06002167
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002168 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00002169 void doGet(crow::Response& res, const crow::Request&,
2170 const std::vector<std::string>&) override
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002171 {
2172 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
raviteja-bc9bb6862020-02-03 11:53:32 -06002173
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002174 asyncResp->res.jsonValue["@odata.id"] =
2175 "/redfish/v1/Systems/system/LogServices/Dump";
2176 asyncResp->res.jsonValue["@odata.type"] =
Asmitha Karunanithid337bb72020-09-21 10:34:02 -05002177 "#LogService.v1_2_0.LogService";
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002178 asyncResp->res.jsonValue["Name"] = "Dump LogService";
2179 asyncResp->res.jsonValue["Description"] = "System Dump LogService";
2180 asyncResp->res.jsonValue["Id"] = "Dump";
2181 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2182 asyncResp->res.jsonValue["Entries"] = {
2183 {"@odata.id",
2184 "/redfish/v1/Systems/system/LogServices/Dump/Entries"}};
2185 asyncResp->res.jsonValue["Actions"] = {
2186 {"#LogService.ClearLog",
2187 {{"target", "/redfish/v1/Systems/system/LogServices/Dump/Actions/"
2188 "LogService.ClearLog"}}},
Asmitha Karunanithid337bb72020-09-21 10:34:02 -05002189 {"#LogService.CollectDiagnosticData",
2190 {{"target", "/redfish/v1/Systems/system/LogServices/Dump/Actions/"
2191 "LogService.CollectDiagnosticData"}}}};
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002192 }
2193};
2194
2195class SystemDumpEntryCollection : public Node
2196{
2197 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002198 SystemDumpEntryCollection(App& app) :
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002199 Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/")
2200 {
2201 entityPrivileges = {
2202 {boost::beast::http::verb::get, {{"Login"}}},
2203 {boost::beast::http::verb::head, {{"Login"}}},
2204 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2205 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2206 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2207 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2208 }
2209
2210 private:
2211 /**
2212 * Functions triggers appropriate requests on DBus
2213 */
Ed Tanouscb13a392020-07-25 19:02:03 +00002214 void doGet(crow::Response& res, const crow::Request&,
2215 const std::vector<std::string>&) override
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002216 {
2217 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2218
2219 asyncResp->res.jsonValue["@odata.type"] =
2220 "#LogEntryCollection.LogEntryCollection";
2221 asyncResp->res.jsonValue["@odata.id"] =
2222 "/redfish/v1/Systems/system/LogServices/Dump/Entries";
2223 asyncResp->res.jsonValue["Name"] = "System Dump Entries";
2224 asyncResp->res.jsonValue["Description"] =
2225 "Collection of System Dump Entries";
2226
2227 getDumpEntryCollection(asyncResp, "System");
2228 }
2229};
2230
2231class SystemDumpEntry : public Node
2232{
2233 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002234 SystemDumpEntry(App& app) :
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002235 Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/",
2236 std::string())
2237 {
2238 entityPrivileges = {
2239 {boost::beast::http::verb::get, {{"Login"}}},
2240 {boost::beast::http::verb::head, {{"Login"}}},
2241 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2242 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2243 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2244 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2245 }
2246
2247 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00002248 void doGet(crow::Response& res, const crow::Request&,
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002249 const std::vector<std::string>& params) override
2250 {
2251 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2252 if (params.size() != 1)
2253 {
2254 messages::internalError(asyncResp->res);
2255 return;
2256 }
2257 getDumpEntryById(asyncResp, params[0], "System");
2258 }
2259
Ed Tanouscb13a392020-07-25 19:02:03 +00002260 void doDelete(crow::Response& res, const crow::Request&,
Asmitha Karunanithi5cb1dd22020-05-07 04:35:02 -05002261 const std::vector<std::string>& params) override
2262 {
2263 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2264 if (params.size() != 1)
2265 {
2266 messages::internalError(asyncResp->res);
2267 return;
2268 }
Stanley Chu98782562020-11-04 16:10:24 +08002269 deleteDumpEntry(asyncResp, params[0], "system");
raviteja-bc9bb6862020-02-03 11:53:32 -06002270 }
2271};
2272
Asmitha Karunanithia43be802020-05-07 05:05:36 -05002273class SystemDumpCreate : public Node
2274{
2275 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002276 SystemDumpCreate(App& app) :
Asmitha Karunanithia43be802020-05-07 05:05:36 -05002277 Node(app, "/redfish/v1/Systems/system/LogServices/Dump/"
Asmitha Karunanithid337bb72020-09-21 10:34:02 -05002278 "Actions/"
2279 "LogService.CollectDiagnosticData/")
Asmitha Karunanithia43be802020-05-07 05:05:36 -05002280 {
2281 entityPrivileges = {
2282 {boost::beast::http::verb::get, {{"Login"}}},
2283 {boost::beast::http::verb::head, {{"Login"}}},
2284 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2285 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2286 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2287 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2288 }
2289
2290 private:
2291 void doPost(crow::Response& res, const crow::Request& req,
Ed Tanouscb13a392020-07-25 19:02:03 +00002292 const std::vector<std::string>&) override
Asmitha Karunanithia43be802020-05-07 05:05:36 -05002293 {
2294 createDump(res, req, "System");
2295 }
2296};
2297
raviteja-b013487e2020-03-03 03:20:48 -06002298class SystemDumpClear : public Node
2299{
2300 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002301 SystemDumpClear(App& app) :
Asmitha Karunanithi80319af2020-05-07 05:30:21 -05002302 Node(app, "/redfish/v1/Systems/system/LogServices/Dump/"
raviteja-b013487e2020-03-03 03:20:48 -06002303 "Actions/"
2304 "LogService.ClearLog/")
2305 {
2306 entityPrivileges = {
2307 {boost::beast::http::verb::get, {{"Login"}}},
2308 {boost::beast::http::verb::head, {{"Login"}}},
Asmitha Karunanithi80319af2020-05-07 05:30:21 -05002309 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2310 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2311 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
raviteja-b013487e2020-03-03 03:20:48 -06002312 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2313 }
2314
2315 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00002316 void doPost(crow::Response& res, const crow::Request&,
2317 const std::vector<std::string>&) override
raviteja-b013487e2020-03-03 03:20:48 -06002318 {
Asmitha Karunanithib47452b2020-09-25 02:02:19 -05002319 clearDump(res, "System");
raviteja-b013487e2020-03-03 03:20:48 -06002320 }
2321};
2322
Jason M. Bills424c4172019-03-21 13:50:33 -07002323class CrashdumpService : public Node
Jason M. Billse1f26342018-07-18 12:12:00 -07002324{
2325 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002326 CrashdumpService(App& app) :
Jason M. Bills424c4172019-03-21 13:50:33 -07002327 Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/")
Ed Tanous1da66f72018-07-27 16:13:37 -07002328 {
AppaRao Puli39460282020-04-07 17:03:04 +05302329 // Note: Deviated from redfish privilege registry for GET & HEAD
2330 // method for security reasons.
Ed Tanous1da66f72018-07-27 16:13:37 -07002331 entityPrivileges = {
AppaRao Puli39460282020-04-07 17:03:04 +05302332 {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
2333 {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
Jason M. Billse1f26342018-07-18 12:12:00 -07002334 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2335 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2336 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2337 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
Ed Tanous1da66f72018-07-27 16:13:37 -07002338 }
2339
2340 private:
2341 /**
2342 * Functions triggers appropriate requests on DBus
2343 */
Ed Tanouscb13a392020-07-25 19:02:03 +00002344 void doGet(crow::Response& res, const crow::Request&,
2345 const std::vector<std::string>&) override
Ed Tanous1da66f72018-07-27 16:13:37 -07002346 {
Jason M. Billse1f26342018-07-18 12:12:00 -07002347 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Ed Tanous1da66f72018-07-27 16:13:37 -07002348 // Copy over the static data to include the entries added by SubRoute
Ed Tanous0f74e642018-11-12 15:17:05 -08002349 asyncResp->res.jsonValue["@odata.id"] =
Jason M. Bills424c4172019-03-21 13:50:33 -07002350 "/redfish/v1/Systems/system/LogServices/Crashdump";
Jason M. Billse1f26342018-07-18 12:12:00 -07002351 asyncResp->res.jsonValue["@odata.type"] =
2352 "#LogService.v1_1_0.LogService";
Gunnar Mills4f50ae42020-02-06 15:29:57 -06002353 asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service";
2354 asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service";
2355 asyncResp->res.jsonValue["Id"] = "Oem Crashdump";
Jason M. Billse1f26342018-07-18 12:12:00 -07002356 asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull";
2357 asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3;
Jason M. Billscd50aa42019-02-12 17:09:02 -08002358 asyncResp->res.jsonValue["Entries"] = {
2359 {"@odata.id",
Jason M. Bills424c4172019-03-21 13:50:33 -07002360 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}};
Jason M. Billse1f26342018-07-18 12:12:00 -07002361 asyncResp->res.jsonValue["Actions"] = {
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07002362 {"#LogService.ClearLog",
2363 {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
2364 "Actions/LogService.ClearLog"}}},
Ed Tanous1da66f72018-07-27 16:13:37 -07002365 {"Oem",
Jason M. Bills424c4172019-03-21 13:50:33 -07002366 {{"#Crashdump.OnDemand",
2367 {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
Kenny L. Ku6eda7682020-06-19 09:48:36 -07002368 "Actions/Oem/Crashdump.OnDemand"}}},
2369 {"#Crashdump.Telemetry",
2370 {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
2371 "Actions/Oem/Crashdump.Telemetry"}}}}}};
Ed Tanous1da66f72018-07-27 16:13:37 -07002372
2373#ifdef BMCWEB_ENABLE_REDFISH_RAW_PECI
Jason M. Billse1f26342018-07-18 12:12:00 -07002374 asyncResp->res.jsonValue["Actions"]["Oem"].push_back(
Jason M. Bills424c4172019-03-21 13:50:33 -07002375 {"#Crashdump.SendRawPeci",
Anthony Wilson08a4e4b2019-04-12 08:23:05 -05002376 {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/"
2377 "Actions/Oem/Crashdump.SendRawPeci"}}});
Ed Tanous1da66f72018-07-27 16:13:37 -07002378#endif
Ed Tanous1da66f72018-07-27 16:13:37 -07002379 }
2380};
2381
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07002382class CrashdumpClear : public Node
2383{
2384 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002385 CrashdumpClear(App& app) :
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07002386 Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/"
2387 "LogService.ClearLog/")
2388 {
AppaRao Puli39460282020-04-07 17:03:04 +05302389 // Note: Deviated from redfish privilege registry for GET & HEAD
2390 // method for security reasons.
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07002391 entityPrivileges = {
AppaRao Puli39460282020-04-07 17:03:04 +05302392 {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
2393 {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07002394 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
2395 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
2396 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
2397 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
2398 }
2399
2400 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00002401 void doPost(crow::Response& res, const crow::Request&,
2402 const std::vector<std::string>&) override
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07002403 {
2404 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2405
2406 crow::connections::systemBus->async_method_call(
2407 [asyncResp](const boost::system::error_code ec,
Ed Tanouscb13a392020-07-25 19:02:03 +00002408 const std::string&) {
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07002409 if (ec)
2410 {
2411 messages::internalError(asyncResp->res);
2412 return;
2413 }
2414 messages::success(asyncResp->res);
2415 },
2416 crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll");
2417 }
2418};
2419
Ed Tanousb5a76932020-09-29 16:16:58 -07002420static void logCrashdumpEntry(const std::shared_ptr<AsyncResp>& asyncResp,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002421 const std::string& logID,
2422 nlohmann::json& logEntryJson)
Jason M. Billse855dd22019-10-08 11:37:48 -07002423{
Johnathan Mantey043a0532020-03-10 17:15:28 -07002424 auto getStoredLogCallback =
2425 [asyncResp, logID, &logEntryJson](
2426 const boost::system::error_code ec,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002427 const std::vector<std::pair<std::string, VariantType>>& params) {
Johnathan Mantey043a0532020-03-10 17:15:28 -07002428 if (ec)
Jason M. Bills1ddcf012019-11-26 14:59:21 -08002429 {
Johnathan Mantey043a0532020-03-10 17:15:28 -07002430 BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message();
2431 if (ec.value() ==
2432 boost::system::linux_error::bad_request_descriptor)
2433 {
2434 messages::resourceNotFound(asyncResp->res, "LogEntry",
2435 logID);
2436 }
2437 else
2438 {
2439 messages::internalError(asyncResp->res);
2440 }
2441 return;
Jason M. Bills1ddcf012019-11-26 14:59:21 -08002442 }
Jason M. Billse855dd22019-10-08 11:37:48 -07002443
Johnathan Mantey043a0532020-03-10 17:15:28 -07002444 std::string timestamp{};
2445 std::string filename{};
2446 std::string logfile{};
Ed Tanous2c70f802020-09-28 14:29:23 -07002447 parseCrashdumpParameters(params, filename, timestamp, logfile);
Johnathan Mantey043a0532020-03-10 17:15:28 -07002448
2449 if (filename.empty() || timestamp.empty())
2450 {
2451 messages::resourceMissingAtURI(asyncResp->res, logID);
2452 return;
2453 }
2454
2455 std::string crashdumpURI =
2456 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" +
2457 logID + "/" + filename;
2458 logEntryJson = {{"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
2459 {"@odata.id", "/redfish/v1/Systems/system/"
2460 "LogServices/Crashdump/Entries/" +
2461 logID},
2462 {"Name", "CPU Crashdump"},
2463 {"Id", logID},
2464 {"EntryType", "Oem"},
2465 {"OemRecordFormat", "Crashdump URI"},
2466 {"Message", std::move(crashdumpURI)},
2467 {"Created", std::move(timestamp)}};
2468 };
Jason M. Billse855dd22019-10-08 11:37:48 -07002469 crow::connections::systemBus->async_method_call(
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07002470 std::move(getStoredLogCallback), crashdumpObject,
2471 crashdumpPath + std::string("/") + logID,
Johnathan Mantey043a0532020-03-10 17:15:28 -07002472 "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
Jason M. Billse855dd22019-10-08 11:37:48 -07002473}
2474
Jason M. Bills424c4172019-03-21 13:50:33 -07002475class CrashdumpEntryCollection : public Node
Ed Tanous1da66f72018-07-27 16:13:37 -07002476{
2477 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002478 CrashdumpEntryCollection(App& app) :
Jason M. Bills424c4172019-03-21 13:50:33 -07002479 Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/")
Ed Tanous1da66f72018-07-27 16:13:37 -07002480 {
AppaRao Puli39460282020-04-07 17:03:04 +05302481 // Note: Deviated from redfish privilege registry for GET & HEAD
2482 // method for security reasons.
Ed Tanous1da66f72018-07-27 16:13:37 -07002483 entityPrivileges = {
AppaRao Puli39460282020-04-07 17:03:04 +05302484 {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
2485 {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
Jason M. Billse1f26342018-07-18 12:12:00 -07002486 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2487 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2488 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2489 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
Ed Tanous1da66f72018-07-27 16:13:37 -07002490 }
2491
2492 private:
2493 /**
2494 * Functions triggers appropriate requests on DBus
2495 */
Ed Tanouscb13a392020-07-25 19:02:03 +00002496 void doGet(crow::Response& res, const crow::Request&,
2497 const std::vector<std::string>&) override
Ed Tanous1da66f72018-07-27 16:13:37 -07002498 {
Jason M. Billse1f26342018-07-18 12:12:00 -07002499 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Ed Tanous1da66f72018-07-27 16:13:37 -07002500 // Collections don't include the static data added by SubRoute because
2501 // it has a duplicate entry for members
Jason M. Billse1f26342018-07-18 12:12:00 -07002502 auto getLogEntriesCallback = [asyncResp](
2503 const boost::system::error_code ec,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002504 const std::vector<std::string>& resp) {
Jason M. Billse1f26342018-07-18 12:12:00 -07002505 if (ec)
2506 {
2507 if (ec.value() !=
2508 boost::system::errc::no_such_file_or_directory)
Ed Tanous1da66f72018-07-27 16:13:37 -07002509 {
Jason M. Billse1f26342018-07-18 12:12:00 -07002510 BMCWEB_LOG_DEBUG << "failed to get entries ec: "
2511 << ec.message();
Jason M. Billsf12894f2018-10-09 12:45:45 -07002512 messages::internalError(asyncResp->res);
Jason M. Billse1f26342018-07-18 12:12:00 -07002513 return;
Ed Tanous1da66f72018-07-27 16:13:37 -07002514 }
Jason M. Billse1f26342018-07-18 12:12:00 -07002515 }
2516 asyncResp->res.jsonValue["@odata.type"] =
2517 "#LogEntryCollection.LogEntryCollection";
Ed Tanous0f74e642018-11-12 15:17:05 -08002518 asyncResp->res.jsonValue["@odata.id"] =
Jason M. Bills424c4172019-03-21 13:50:33 -07002519 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries";
Jason M. Bills424c4172019-03-21 13:50:33 -07002520 asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries";
Jason M. Billse1f26342018-07-18 12:12:00 -07002521 asyncResp->res.jsonValue["Description"] =
Jason M. Bills424c4172019-03-21 13:50:33 -07002522 "Collection of Crashdump Entries";
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002523 nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"];
Jason M. Billse1f26342018-07-18 12:12:00 -07002524 logEntryArray = nlohmann::json::array();
Jason M. Billse855dd22019-10-08 11:37:48 -07002525 std::vector<std::string> logIDs;
2526 // Get the list of log entries and build up an empty array big
2527 // enough to hold them
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002528 for (const std::string& objpath : resp)
Jason M. Billse1f26342018-07-18 12:12:00 -07002529 {
Jason M. Billse855dd22019-10-08 11:37:48 -07002530 // Get the log ID
Ed Tanousf23b7292020-10-15 09:41:17 -07002531 std::size_t lastPos = objpath.rfind('/');
Jason M. Billse855dd22019-10-08 11:37:48 -07002532 if (lastPos == std::string::npos)
Jason M. Billse1f26342018-07-18 12:12:00 -07002533 {
Jason M. Billse855dd22019-10-08 11:37:48 -07002534 continue;
Jason M. Billse1f26342018-07-18 12:12:00 -07002535 }
Jason M. Billse855dd22019-10-08 11:37:48 -07002536 logIDs.emplace_back(objpath.substr(lastPos + 1));
2537
2538 // Add a space for the log entry to the array
2539 logEntryArray.push_back({});
2540 }
2541 // Now go through and set up async calls to fill in the entries
2542 size_t index = 0;
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002543 for (const std::string& logID : logIDs)
Jason M. Billse855dd22019-10-08 11:37:48 -07002544 {
2545 // Add the log entry to the array
2546 logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]);
Jason M. Billse1f26342018-07-18 12:12:00 -07002547 }
2548 asyncResp->res.jsonValue["Members@odata.count"] =
2549 logEntryArray.size();
2550 };
Ed Tanous1da66f72018-07-27 16:13:37 -07002551 crow::connections::systemBus->async_method_call(
2552 std::move(getLogEntriesCallback),
2553 "xyz.openbmc_project.ObjectMapper",
2554 "/xyz/openbmc_project/object_mapper",
2555 "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002556 std::array<const char*, 1>{crashdumpInterface});
Ed Tanous1da66f72018-07-27 16:13:37 -07002557 }
2558};
2559
Jason M. Bills424c4172019-03-21 13:50:33 -07002560class CrashdumpEntry : public Node
Ed Tanous1da66f72018-07-27 16:13:37 -07002561{
2562 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002563 CrashdumpEntry(App& app) :
Jason M. Billsd53dd412019-02-12 17:16:22 -08002564 Node(app,
Jason M. Bills424c4172019-03-21 13:50:33 -07002565 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/",
Ed Tanous1da66f72018-07-27 16:13:37 -07002566 std::string())
2567 {
AppaRao Puli39460282020-04-07 17:03:04 +05302568 // Note: Deviated from redfish privilege registry for GET & HEAD
2569 // method for security reasons.
Ed Tanous1da66f72018-07-27 16:13:37 -07002570 entityPrivileges = {
AppaRao Puli39460282020-04-07 17:03:04 +05302571 {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
2572 {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
Jason M. Billse1f26342018-07-18 12:12:00 -07002573 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2574 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2575 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2576 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
Ed Tanous1da66f72018-07-27 16:13:37 -07002577 }
2578
2579 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00002580 void doGet(crow::Response& res, const crow::Request&,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002581 const std::vector<std::string>& params) override
Ed Tanous1da66f72018-07-27 16:13:37 -07002582 {
Jason M. Billse1f26342018-07-18 12:12:00 -07002583 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Ed Tanous1da66f72018-07-27 16:13:37 -07002584 if (params.size() != 1)
2585 {
Jason M. Billsf12894f2018-10-09 12:45:45 -07002586 messages::internalError(asyncResp->res);
Ed Tanous1da66f72018-07-27 16:13:37 -07002587 return;
2588 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002589 const std::string& logID = params[0];
Jason M. Billse855dd22019-10-08 11:37:48 -07002590 logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue);
2591 }
2592};
2593
2594class CrashdumpFile : public Node
2595{
2596 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002597 CrashdumpFile(App& app) :
Jason M. Billse855dd22019-10-08 11:37:48 -07002598 Node(app,
2599 "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/"
2600 "<str>/",
2601 std::string(), std::string())
2602 {
AppaRao Puli39460282020-04-07 17:03:04 +05302603 // Note: Deviated from redfish privilege registry for GET & HEAD
2604 // method for security reasons.
Jason M. Billse855dd22019-10-08 11:37:48 -07002605 entityPrivileges = {
AppaRao Puli39460282020-04-07 17:03:04 +05302606 {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
2607 {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
Jason M. Billse855dd22019-10-08 11:37:48 -07002608 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2609 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2610 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2611 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2612 }
2613
2614 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00002615 void doGet(crow::Response& res, const crow::Request&,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002616 const std::vector<std::string>& params) override
Jason M. Billse855dd22019-10-08 11:37:48 -07002617 {
2618 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2619 if (params.size() != 2)
2620 {
2621 messages::internalError(asyncResp->res);
2622 return;
2623 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002624 const std::string& logID = params[0];
2625 const std::string& fileName = params[1];
Jason M. Billse855dd22019-10-08 11:37:48 -07002626
Johnathan Mantey043a0532020-03-10 17:15:28 -07002627 auto getStoredLogCallback =
2628 [asyncResp, logID, fileName](
2629 const boost::system::error_code ec,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002630 const std::vector<std::pair<std::string, VariantType>>& resp) {
Johnathan Mantey043a0532020-03-10 17:15:28 -07002631 if (ec)
2632 {
2633 BMCWEB_LOG_DEBUG << "failed to get log ec: "
2634 << ec.message();
2635 messages::internalError(asyncResp->res);
2636 return;
2637 }
Jason M. Billse855dd22019-10-08 11:37:48 -07002638
Johnathan Mantey043a0532020-03-10 17:15:28 -07002639 std::string dbusFilename{};
2640 std::string dbusTimestamp{};
2641 std::string dbusFilepath{};
Jason M. Billse855dd22019-10-08 11:37:48 -07002642
Ed Tanous2c70f802020-09-28 14:29:23 -07002643 parseCrashdumpParameters(resp, dbusFilename, dbusTimestamp,
Johnathan Mantey043a0532020-03-10 17:15:28 -07002644 dbusFilepath);
2645
2646 if (dbusFilename.empty() || dbusTimestamp.empty() ||
2647 dbusFilepath.empty())
2648 {
2649 messages::resourceMissingAtURI(asyncResp->res, fileName);
2650 return;
2651 }
2652
2653 // Verify the file name parameter is correct
2654 if (fileName != dbusFilename)
2655 {
2656 messages::resourceMissingAtURI(asyncResp->res, fileName);
2657 return;
2658 }
2659
2660 if (!std::filesystem::exists(dbusFilepath))
2661 {
2662 messages::resourceMissingAtURI(asyncResp->res, fileName);
2663 return;
2664 }
2665 std::ifstream ifs(dbusFilepath, std::ios::in |
2666 std::ios::binary |
2667 std::ios::ate);
2668 std::ifstream::pos_type fileSize = ifs.tellg();
2669 if (fileSize < 0)
2670 {
2671 messages::generalError(asyncResp->res);
2672 return;
2673 }
2674 ifs.seekg(0, std::ios::beg);
2675
2676 auto crashData = std::make_unique<char[]>(
2677 static_cast<unsigned int>(fileSize));
2678
2679 ifs.read(crashData.get(), static_cast<int>(fileSize));
2680
2681 // The cast to std::string is intentional in order to use the
2682 // assign() that applies move mechanics
2683 asyncResp->res.body().assign(
2684 static_cast<std::string>(crashData.get()));
2685
2686 // Configure this to be a file download when accessed from
2687 // a browser
2688 asyncResp->res.addHeader("Content-Disposition", "attachment");
2689 };
Ed Tanous1da66f72018-07-27 16:13:37 -07002690 crow::connections::systemBus->async_method_call(
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07002691 std::move(getStoredLogCallback), crashdumpObject,
2692 crashdumpPath + std::string("/") + logID,
Johnathan Mantey043a0532020-03-10 17:15:28 -07002693 "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface);
Ed Tanous1da66f72018-07-27 16:13:37 -07002694 }
2695};
2696
Jason M. Bills424c4172019-03-21 13:50:33 -07002697class OnDemandCrashdump : public Node
Ed Tanous1da66f72018-07-27 16:13:37 -07002698{
2699 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002700 OnDemandCrashdump(App& app) :
Jason M. Bills424c4172019-03-21 13:50:33 -07002701 Node(app,
2702 "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
2703 "Crashdump.OnDemand/")
Ed Tanous1da66f72018-07-27 16:13:37 -07002704 {
AppaRao Puli39460282020-04-07 17:03:04 +05302705 // Note: Deviated from redfish privilege registry for GET & HEAD
2706 // method for security reasons.
Ed Tanous1da66f72018-07-27 16:13:37 -07002707 entityPrivileges = {
AppaRao Puli39460282020-04-07 17:03:04 +05302708 {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
2709 {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2710 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
2711 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
2712 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
2713 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
Ed Tanous1da66f72018-07-27 16:13:37 -07002714 }
2715
2716 private:
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002717 void doPost(crow::Response& res, const crow::Request& req,
Ed Tanouscb13a392020-07-25 19:02:03 +00002718 const std::vector<std::string>&) override
Ed Tanous1da66f72018-07-27 16:13:37 -07002719 {
Jason M. Billse1f26342018-07-18 12:12:00 -07002720 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Ed Tanous1da66f72018-07-27 16:13:37 -07002721
James Feistfe306722020-03-12 16:32:08 -07002722 auto generateonDemandLogCallback = [asyncResp,
2723 req](const boost::system::error_code
2724 ec,
Ed Tanouscb13a392020-07-25 19:02:03 +00002725 const std::string&) {
James Feist46229572020-02-19 15:11:58 -08002726 if (ec)
2727 {
2728 if (ec.value() == boost::system::errc::operation_not_supported)
Ed Tanous1da66f72018-07-27 16:13:37 -07002729 {
James Feist46229572020-02-19 15:11:58 -08002730 messages::resourceInStandby(asyncResp->res);
Ed Tanous1da66f72018-07-27 16:13:37 -07002731 }
James Feist46229572020-02-19 15:11:58 -08002732 else if (ec.value() ==
2733 boost::system::errc::device_or_resource_busy)
2734 {
2735 messages::serviceTemporarilyUnavailable(asyncResp->res,
2736 "60");
2737 }
2738 else
2739 {
2740 messages::internalError(asyncResp->res);
2741 }
2742 return;
2743 }
2744 std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002745 [](boost::system::error_code err, sdbusplus::message::message&,
2746 const std::shared_ptr<task::TaskData>& taskData) {
James Feist66afe4f2020-02-24 13:09:58 -08002747 if (!err)
2748 {
James Feiste5d50062020-05-11 17:29:00 -07002749 taskData->messages.emplace_back(
2750 messages::taskCompletedOK(
2751 std::to_string(taskData->index)));
James Feist831d6b02020-03-12 16:31:30 -07002752 taskData->state = "Completed";
James Feist66afe4f2020-02-24 13:09:58 -08002753 }
James Feist32898ce2020-03-10 16:16:52 -07002754 return task::completed;
James Feist66afe4f2020-02-24 13:09:58 -08002755 },
James Feist46229572020-02-19 15:11:58 -08002756 "type='signal',interface='org.freedesktop.DBus.Properties',"
2757 "member='PropertiesChanged',arg0namespace='com.intel."
2758 "crashdump'");
2759 task->startTimer(std::chrono::minutes(5));
2760 task->populateResp(asyncResp->res);
James Feistfe306722020-03-12 16:32:08 -07002761 task->payload.emplace(req);
James Feist46229572020-02-19 15:11:58 -08002762 };
Ed Tanous1da66f72018-07-27 16:13:37 -07002763 crow::connections::systemBus->async_method_call(
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07002764 std::move(generateonDemandLogCallback), crashdumpObject,
2765 crashdumpPath, crashdumpOnDemandInterface, "GenerateOnDemandLog");
Ed Tanous1da66f72018-07-27 16:13:37 -07002766 }
2767};
2768
Kenny L. Ku6eda7682020-06-19 09:48:36 -07002769class TelemetryCrashdump : public Node
2770{
2771 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002772 TelemetryCrashdump(App& app) :
Kenny L. Ku6eda7682020-06-19 09:48:36 -07002773 Node(app,
2774 "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
2775 "Crashdump.Telemetry/")
2776 {
2777 // Note: Deviated from redfish privilege registry for GET & HEAD
2778 // method for security reasons.
2779 entityPrivileges = {
2780 {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
2781 {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2782 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
2783 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
2784 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
2785 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
2786 }
2787
2788 private:
2789 void doPost(crow::Response& res, const crow::Request& req,
Ed Tanouscb13a392020-07-25 19:02:03 +00002790 const std::vector<std::string>&) override
Kenny L. Ku6eda7682020-06-19 09:48:36 -07002791 {
2792 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2793
2794 auto generateTelemetryLogCallback = [asyncResp, req](
2795 const boost::system::error_code
2796 ec,
Ed Tanouscb13a392020-07-25 19:02:03 +00002797 const std::string&) {
Kenny L. Ku6eda7682020-06-19 09:48:36 -07002798 if (ec)
2799 {
2800 if (ec.value() == boost::system::errc::operation_not_supported)
2801 {
2802 messages::resourceInStandby(asyncResp->res);
2803 }
2804 else if (ec.value() ==
2805 boost::system::errc::device_or_resource_busy)
2806 {
2807 messages::serviceTemporarilyUnavailable(asyncResp->res,
2808 "60");
2809 }
2810 else
2811 {
2812 messages::internalError(asyncResp->res);
2813 }
2814 return;
2815 }
2816 std::shared_ptr<task::TaskData> task = task::TaskData::createTask(
2817 [](boost::system::error_code err, sdbusplus::message::message&,
2818 const std::shared_ptr<task::TaskData>& taskData) {
2819 if (!err)
2820 {
2821 taskData->messages.emplace_back(
2822 messages::taskCompletedOK(
2823 std::to_string(taskData->index)));
2824 taskData->state = "Completed";
2825 }
2826 return task::completed;
2827 },
2828 "type='signal',interface='org.freedesktop.DBus.Properties',"
2829 "member='PropertiesChanged',arg0namespace='com.intel."
2830 "crashdump'");
2831 task->startTimer(std::chrono::minutes(5));
2832 task->populateResp(asyncResp->res);
2833 task->payload.emplace(req);
2834 };
2835 crow::connections::systemBus->async_method_call(
2836 std::move(generateTelemetryLogCallback), crashdumpObject,
2837 crashdumpPath, crashdumpTelemetryInterface, "GenerateTelemetryLog");
2838 }
2839};
2840
Jason M. Billse1f26342018-07-18 12:12:00 -07002841class SendRawPECI : public Node
Ed Tanous1da66f72018-07-27 16:13:37 -07002842{
2843 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002844 SendRawPECI(App& app) :
Jason M. Bills424c4172019-03-21 13:50:33 -07002845 Node(app,
2846 "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/"
2847 "Crashdump.SendRawPeci/")
Ed Tanous1da66f72018-07-27 16:13:37 -07002848 {
AppaRao Puli39460282020-04-07 17:03:04 +05302849 // Note: Deviated from redfish privilege registry for GET & HEAD
2850 // method for security reasons.
Ed Tanous1da66f72018-07-27 16:13:37 -07002851 entityPrivileges = {
2852 {boost::beast::http::verb::get, {{"ConfigureComponents"}}},
2853 {boost::beast::http::verb::head, {{"ConfigureComponents"}}},
2854 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
2855 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
2856 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
2857 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
2858 }
2859
2860 private:
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002861 void doPost(crow::Response& res, const crow::Request& req,
Ed Tanouscb13a392020-07-25 19:02:03 +00002862 const std::vector<std::string>&) override
Ed Tanous1da66f72018-07-27 16:13:37 -07002863 {
Jason M. Billse1f26342018-07-18 12:12:00 -07002864 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Karthick Sundarrajan8724c292020-01-06 09:04:48 -08002865 std::vector<std::vector<uint8_t>> peciCommands;
Ed Tanousb1556422018-10-16 14:09:17 -07002866
Karthick Sundarrajanf0b6ae02020-01-17 13:32:58 -08002867 if (!json_util::readJson(req, res, "PECICommands", peciCommands))
Karthick Sundarrajan8724c292020-01-06 09:04:48 -08002868 {
Karthick Sundarrajanf0b6ae02020-01-17 13:32:58 -08002869 return;
Karthick Sundarrajan8724c292020-01-06 09:04:48 -08002870 }
Karthick Sundarrajanf0b6ae02020-01-17 13:32:58 -08002871 uint32_t idx = 0;
2872 for (auto const& cmd : peciCommands)
Karthick Sundarrajan8724c292020-01-06 09:04:48 -08002873 {
Karthick Sundarrajanf0b6ae02020-01-17 13:32:58 -08002874 if (cmd.size() < 3)
Karthick Sundarrajan8724c292020-01-06 09:04:48 -08002875 {
Karthick Sundarrajanf0b6ae02020-01-17 13:32:58 -08002876 std::string s("[");
2877 for (auto const& val : cmd)
2878 {
2879 if (val != *cmd.begin())
2880 {
2881 s += ",";
2882 }
2883 s += std::to_string(val);
2884 }
2885 s += "]";
2886 messages::actionParameterValueFormatError(
2887 res, s, "PECICommands[" + std::to_string(idx) + "]",
2888 "SendRawPeci");
Karthick Sundarrajan8724c292020-01-06 09:04:48 -08002889 return;
2890 }
Karthick Sundarrajanf0b6ae02020-01-17 13:32:58 -08002891 idx++;
Karthick Sundarrajan8724c292020-01-06 09:04:48 -08002892 }
Ed Tanous1da66f72018-07-27 16:13:37 -07002893 // Callback to return the Raw PECI response
Jason M. Billse1f26342018-07-18 12:12:00 -07002894 auto sendRawPECICallback =
2895 [asyncResp](const boost::system::error_code ec,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002896 const std::vector<std::vector<uint8_t>>& resp) {
Jason M. Billse1f26342018-07-18 12:12:00 -07002897 if (ec)
2898 {
Karthick Sundarrajan8724c292020-01-06 09:04:48 -08002899 BMCWEB_LOG_DEBUG << "failed to process PECI commands ec: "
Jason M. Billse1f26342018-07-18 12:12:00 -07002900 << ec.message();
Jason M. Billsf12894f2018-10-09 12:45:45 -07002901 messages::internalError(asyncResp->res);
Jason M. Billse1f26342018-07-18 12:12:00 -07002902 return;
2903 }
2904 asyncResp->res.jsonValue = {{"Name", "PECI Command Response"},
2905 {"PECIResponse", resp}};
2906 };
Ed Tanous1da66f72018-07-27 16:13:37 -07002907 // Call the SendRawPECI command with the provided data
2908 crow::connections::systemBus->async_method_call(
Jason M. Bills5b61b5e2019-10-16 10:59:02 -07002909 std::move(sendRawPECICallback), crashdumpObject, crashdumpPath,
Karthick Sundarrajan8724c292020-01-06 09:04:48 -08002910 crashdumpRawPECIInterface, "SendRawPeci", peciCommands);
Ed Tanous1da66f72018-07-27 16:13:37 -07002911 }
2912};
2913
Andrew Geisslercb92c032018-08-17 07:56:14 -07002914/**
2915 * DBusLogServiceActionsClear class supports POST method for ClearLog action.
2916 */
2917class DBusLogServiceActionsClear : public Node
2918{
2919 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002920 DBusLogServiceActionsClear(App& app) :
Andrew Geisslercb92c032018-08-17 07:56:14 -07002921 Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/"
Gunnar Mills7af91512020-04-14 22:16:57 -05002922 "LogService.ClearLog/")
Andrew Geisslercb92c032018-08-17 07:56:14 -07002923 {
2924 entityPrivileges = {
2925 {boost::beast::http::verb::get, {{"Login"}}},
2926 {boost::beast::http::verb::head, {{"Login"}}},
2927 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2928 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2929 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2930 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2931 }
2932
2933 private:
2934 /**
2935 * Function handles POST method request.
2936 * The Clear Log actions does not require any parameter.The action deletes
2937 * all entries found in the Entries collection for this Log Service.
2938 */
Ed Tanouscb13a392020-07-25 19:02:03 +00002939 void doPost(crow::Response& res, const crow::Request&,
2940 const std::vector<std::string>&) override
Andrew Geisslercb92c032018-08-17 07:56:14 -07002941 {
2942 BMCWEB_LOG_DEBUG << "Do delete all entries.";
2943
2944 auto asyncResp = std::make_shared<AsyncResp>(res);
2945 // Process response from Logging service.
Ed Tanous2c70f802020-09-28 14:29:23 -07002946 auto respHandler = [asyncResp](const boost::system::error_code ec) {
Andrew Geisslercb92c032018-08-17 07:56:14 -07002947 BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done";
2948 if (ec)
2949 {
2950 // TODO Handle for specific error code
2951 BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec;
2952 asyncResp->res.result(
2953 boost::beast::http::status::internal_server_error);
2954 return;
2955 }
2956
2957 asyncResp->res.result(boost::beast::http::status::no_content);
2958 };
2959
2960 // Make call to Logging service to request Clear Log
2961 crow::connections::systemBus->async_method_call(
Ed Tanous2c70f802020-09-28 14:29:23 -07002962 respHandler, "xyz.openbmc_project.Logging",
Andrew Geisslercb92c032018-08-17 07:56:14 -07002963 "/xyz/openbmc_project/logging",
2964 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
2965 }
2966};
ZhikuiRena3316fc2020-01-29 14:58:08 -08002967
2968/****************************************************
2969 * Redfish PostCode interfaces
2970 * using DBUS interface: getPostCodesTS
2971 ******************************************************/
2972class PostCodesLogService : public Node
2973{
2974 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07002975 PostCodesLogService(App& app) :
ZhikuiRena3316fc2020-01-29 14:58:08 -08002976 Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/")
2977 {
2978 entityPrivileges = {
2979 {boost::beast::http::verb::get, {{"Login"}}},
2980 {boost::beast::http::verb::head, {{"Login"}}},
2981 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
2982 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
2983 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
2984 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
2985 }
2986
2987 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00002988 void doGet(crow::Response& res, const crow::Request&,
2989 const std::vector<std::string>&) override
ZhikuiRena3316fc2020-01-29 14:58:08 -08002990 {
2991 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
2992
2993 asyncResp->res.jsonValue = {
2994 {"@odata.id", "/redfish/v1/Systems/system/LogServices/PostCodes"},
2995 {"@odata.type", "#LogService.v1_1_0.LogService"},
ZhikuiRena3316fc2020-01-29 14:58:08 -08002996 {"Name", "POST Code Log Service"},
2997 {"Description", "POST Code Log Service"},
2998 {"Id", "BIOS POST Code Log"},
2999 {"OverWritePolicy", "WrapsWhenFull"},
3000 {"Entries",
3001 {{"@odata.id",
3002 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"}}}};
3003 asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = {
3004 {"target", "/redfish/v1/Systems/system/LogServices/PostCodes/"
3005 "Actions/LogService.ClearLog"}};
3006 }
3007};
3008
3009class PostCodesClear : public Node
3010{
3011 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07003012 PostCodesClear(App& app) :
ZhikuiRena3316fc2020-01-29 14:58:08 -08003013 Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/"
3014 "LogService.ClearLog/")
3015 {
3016 entityPrivileges = {
3017 {boost::beast::http::verb::get, {{"Login"}}},
3018 {boost::beast::http::verb::head, {{"Login"}}},
AppaRao Puli39460282020-04-07 17:03:04 +05303019 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
3020 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
3021 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
3022 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
ZhikuiRena3316fc2020-01-29 14:58:08 -08003023 }
3024
3025 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00003026 void doPost(crow::Response& res, const crow::Request&,
3027 const std::vector<std::string>&) override
ZhikuiRena3316fc2020-01-29 14:58:08 -08003028 {
3029 BMCWEB_LOG_DEBUG << "Do delete all postcodes entries.";
3030
3031 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3032 // Make call to post-code service to request clear all
3033 crow::connections::systemBus->async_method_call(
3034 [asyncResp](const boost::system::error_code ec) {
3035 if (ec)
3036 {
3037 // TODO Handle for specific error code
3038 BMCWEB_LOG_ERROR
3039 << "doClearPostCodes resp_handler got error " << ec;
3040 asyncResp->res.result(
3041 boost::beast::http::status::internal_server_error);
3042 messages::internalError(asyncResp->res);
3043 return;
3044 }
3045 },
3046 "xyz.openbmc_project.State.Boot.PostCode",
3047 "/xyz/openbmc_project/State/Boot/PostCode",
3048 "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll");
3049 }
3050};
3051
3052static void fillPostCodeEntry(
Ed Tanousb5a76932020-09-29 16:16:58 -07003053 const std::shared_ptr<AsyncResp>& aResp,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05003054 const boost::container::flat_map<uint64_t, uint64_t>& postcode,
ZhikuiRena3316fc2020-01-29 14:58:08 -08003055 const uint16_t bootIndex, const uint64_t codeIndex = 0,
3056 const uint64_t skip = 0, const uint64_t top = 0)
3057{
3058 // Get the Message from the MessageRegistry
Gunnar Mills1214b7e2020-06-04 10:11:30 -05003059 const message_registries::Message* message =
ZhikuiRena3316fc2020-01-29 14:58:08 -08003060 message_registries::getMessage("OpenBMC.0.1.BIOSPOSTCode");
ZhikuiRena3316fc2020-01-29 14:58:08 -08003061
3062 uint64_t currentCodeIndex = 0;
Gunnar Mills1214b7e2020-06-04 10:11:30 -05003063 nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"];
ZhikuiRena3316fc2020-01-29 14:58:08 -08003064
3065 uint64_t firstCodeTimeUs = 0;
Gunnar Mills1214b7e2020-06-04 10:11:30 -05003066 for (const std::pair<uint64_t, uint64_t>& code : postcode)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003067 {
3068 currentCodeIndex++;
3069 std::string postcodeEntryID =
3070 "B" + std::to_string(bootIndex) + "-" +
3071 std::to_string(currentCodeIndex); // 1 based index in EntryID string
3072
3073 uint64_t usecSinceEpoch = code.first;
3074 uint64_t usTimeOffset = 0;
3075
3076 if (1 == currentCodeIndex)
3077 { // already incremented
3078 firstCodeTimeUs = code.first;
3079 }
3080 else
3081 {
3082 usTimeOffset = code.first - firstCodeTimeUs;
3083 }
3084
3085 // skip if no specific codeIndex is specified and currentCodeIndex does
3086 // not fall between top and skip
3087 if ((codeIndex == 0) &&
3088 (currentCodeIndex <= skip || currentCodeIndex > top))
3089 {
3090 continue;
3091 }
3092
Gunnar Mills4e0453b2020-07-08 14:00:30 -05003093 // skip if a specific codeIndex is specified and does not match the
ZhikuiRena3316fc2020-01-29 14:58:08 -08003094 // currentIndex
3095 if ((codeIndex > 0) && (currentCodeIndex != codeIndex))
3096 {
3097 // This is done for simplicity. 1st entry is needed to calculate
3098 // time offset. To improve efficiency, one can get to the entry
3099 // directly (possibly with flatmap's nth method)
3100 continue;
3101 }
3102
3103 // currentCodeIndex is within top and skip or equal to specified code
3104 // index
3105
3106 // Get the Created time from the timestamp
3107 std::string entryTimeStr;
Asmitha Karunanithi9c620e22020-08-02 11:55:21 -05003108 entryTimeStr = crow::utility::getDateTime(
3109 static_cast<std::time_t>(usecSinceEpoch / 1000 / 1000));
ZhikuiRena3316fc2020-01-29 14:58:08 -08003110
3111 // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex)
3112 std::ostringstream hexCode;
3113 hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex
3114 << code.second;
3115 std::ostringstream timeOffsetStr;
3116 // Set Fixed -Point Notation
3117 timeOffsetStr << std::fixed;
3118 // Set precision to 4 digits
3119 timeOffsetStr << std::setprecision(4);
3120 // Add double to stream
3121 timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000;
3122 std::vector<std::string> messageArgs = {
3123 std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()};
3124
3125 // Get MessageArgs template from message registry
3126 std::string msg;
3127 if (message != nullptr)
3128 {
3129 msg = message->message;
3130
3131 // fill in this post code value
3132 int i = 0;
Gunnar Mills1214b7e2020-06-04 10:11:30 -05003133 for (const std::string& messageArg : messageArgs)
ZhikuiRena3316fc2020-01-29 14:58:08 -08003134 {
3135 std::string argStr = "%" + std::to_string(++i);
3136 size_t argPos = msg.find(argStr);
3137 if (argPos != std::string::npos)
3138 {
3139 msg.replace(argPos, argStr.length(), messageArg);
3140 }
3141 }
3142 }
3143
Tim Leed4342a92020-04-27 11:47:58 +08003144 // Get Severity template from message registry
3145 std::string severity;
3146 if (message != nullptr)
3147 {
3148 severity = message->severity;
3149 }
3150
ZhikuiRena3316fc2020-01-29 14:58:08 -08003151 // add to AsyncResp
3152 logEntryArray.push_back({});
Gunnar Mills1214b7e2020-06-04 10:11:30 -05003153 nlohmann::json& bmcLogEntry = logEntryArray.back();
Gunnar Mills743e9a12020-10-26 12:44:53 -05003154 bmcLogEntry = {{"@odata.type", "#LogEntry.v1_4_0.LogEntry"},
3155 {"@odata.id", "/redfish/v1/Systems/system/LogServices/"
3156 "PostCodes/Entries/" +
3157 postcodeEntryID},
3158 {"Name", "POST Code Log Entry"},
3159 {"Id", postcodeEntryID},
3160 {"Message", std::move(msg)},
3161 {"MessageId", "OpenBMC.0.1.BIOSPOSTCode"},
3162 {"MessageArgs", std::move(messageArgs)},
3163 {"EntryType", "Event"},
3164 {"Severity", std::move(severity)},
3165 {"Created", entryTimeStr}};
ZhikuiRena3316fc2020-01-29 14:58:08 -08003166 }
3167}
3168
Ed Tanousb5a76932020-09-29 16:16:58 -07003169static void getPostCodeForEntry(const std::shared_ptr<AsyncResp>& aResp,
ZhikuiRena3316fc2020-01-29 14:58:08 -08003170 const uint16_t bootIndex,
3171 const uint64_t codeIndex)
3172{
3173 crow::connections::systemBus->async_method_call(
3174 [aResp, bootIndex, codeIndex](
3175 const boost::system::error_code ec,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05003176 const boost::container::flat_map<uint64_t, uint64_t>& postcode) {
ZhikuiRena3316fc2020-01-29 14:58:08 -08003177 if (ec)
3178 {
3179 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3180 messages::internalError(aResp->res);
3181 return;
3182 }
3183
3184 // skip the empty postcode boots
3185 if (postcode.empty())
3186 {
3187 return;
3188 }
3189
3190 fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex);
3191
3192 aResp->res.jsonValue["Members@odata.count"] =
3193 aResp->res.jsonValue["Members"].size();
3194 },
3195 "xyz.openbmc_project.State.Boot.PostCode",
3196 "/xyz/openbmc_project/State/Boot/PostCode",
3197 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3198 bootIndex);
3199}
3200
Ed Tanousb5a76932020-09-29 16:16:58 -07003201static void getPostCodeForBoot(const std::shared_ptr<AsyncResp>& aResp,
ZhikuiRena3316fc2020-01-29 14:58:08 -08003202 const uint16_t bootIndex,
3203 const uint16_t bootCount,
3204 const uint64_t entryCount, const uint64_t skip,
3205 const uint64_t top)
3206{
3207 crow::connections::systemBus->async_method_call(
3208 [aResp, bootIndex, bootCount, entryCount, skip,
3209 top](const boost::system::error_code ec,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05003210 const boost::container::flat_map<uint64_t, uint64_t>& postcode) {
ZhikuiRena3316fc2020-01-29 14:58:08 -08003211 if (ec)
3212 {
3213 BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error";
3214 messages::internalError(aResp->res);
3215 return;
3216 }
3217
3218 uint64_t endCount = entryCount;
3219 if (!postcode.empty())
3220 {
3221 endCount = entryCount + postcode.size();
3222
3223 if ((skip < endCount) && ((top + skip) > entryCount))
3224 {
3225 uint64_t thisBootSkip =
3226 std::max(skip, entryCount) - entryCount;
3227 uint64_t thisBootTop =
3228 std::min(top + skip, endCount) - entryCount;
3229
3230 fillPostCodeEntry(aResp, postcode, bootIndex, 0,
3231 thisBootSkip, thisBootTop);
3232 }
3233 aResp->res.jsonValue["Members@odata.count"] = endCount;
3234 }
3235
3236 // continue to previous bootIndex
3237 if (bootIndex < bootCount)
3238 {
3239 getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1),
3240 bootCount, endCount, skip, top);
3241 }
3242 else
3243 {
3244 aResp->res.jsonValue["Members@odata.nextLink"] =
3245 "/redfish/v1/Systems/system/LogServices/PostCodes/"
3246 "Entries?$skip=" +
3247 std::to_string(skip + top);
3248 }
3249 },
3250 "xyz.openbmc_project.State.Boot.PostCode",
3251 "/xyz/openbmc_project/State/Boot/PostCode",
3252 "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp",
3253 bootIndex);
3254}
3255
Ed Tanousb5a76932020-09-29 16:16:58 -07003256static void getCurrentBootNumber(const std::shared_ptr<AsyncResp>& aResp,
ZhikuiRena3316fc2020-01-29 14:58:08 -08003257 const uint64_t skip, const uint64_t top)
3258{
3259 uint64_t entryCount = 0;
3260 crow::connections::systemBus->async_method_call(
3261 [aResp, entryCount, skip,
3262 top](const boost::system::error_code ec,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05003263 const std::variant<uint16_t>& bootCount) {
ZhikuiRena3316fc2020-01-29 14:58:08 -08003264 if (ec)
3265 {
3266 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
3267 messages::internalError(aResp->res);
3268 return;
3269 }
3270 auto pVal = std::get_if<uint16_t>(&bootCount);
3271 if (pVal)
3272 {
3273 getPostCodeForBoot(aResp, 1, *pVal, entryCount, skip, top);
3274 }
3275 else
3276 {
3277 BMCWEB_LOG_DEBUG << "Post code boot index failed.";
3278 }
3279 },
3280 "xyz.openbmc_project.State.Boot.PostCode",
3281 "/xyz/openbmc_project/State/Boot/PostCode",
3282 "org.freedesktop.DBus.Properties", "Get",
3283 "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount");
3284}
3285
3286class PostCodesEntryCollection : public Node
3287{
3288 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07003289 PostCodesEntryCollection(App& app) :
ZhikuiRena3316fc2020-01-29 14:58:08 -08003290 Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/")
3291 {
3292 entityPrivileges = {
3293 {boost::beast::http::verb::get, {{"Login"}}},
3294 {boost::beast::http::verb::head, {{"Login"}}},
3295 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3296 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3297 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3298 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3299 }
3300
3301 private:
Gunnar Mills1214b7e2020-06-04 10:11:30 -05003302 void doGet(crow::Response& res, const crow::Request& req,
Ed Tanouscb13a392020-07-25 19:02:03 +00003303 const std::vector<std::string>&) override
ZhikuiRena3316fc2020-01-29 14:58:08 -08003304 {
3305 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3306
3307 asyncResp->res.jsonValue["@odata.type"] =
3308 "#LogEntryCollection.LogEntryCollection";
ZhikuiRena3316fc2020-01-29 14:58:08 -08003309 asyncResp->res.jsonValue["@odata.id"] =
3310 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries";
3311 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3312 asyncResp->res.jsonValue["Description"] =
3313 "Collection of POST Code Log Entries";
3314 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3315 asyncResp->res.jsonValue["Members@odata.count"] = 0;
3316
3317 uint64_t skip = 0;
3318 uint64_t top = maxEntriesPerPage; // Show max entries by default
3319 if (!getSkipParam(asyncResp->res, req, skip))
3320 {
3321 return;
3322 }
3323 if (!getTopParam(asyncResp->res, req, top))
3324 {
3325 return;
3326 }
3327 getCurrentBootNumber(asyncResp, skip, top);
3328 }
3329};
3330
3331class PostCodesEntry : public Node
3332{
3333 public:
Ed Tanous52cc1122020-07-18 13:51:21 -07003334 PostCodesEntry(App& app) :
ZhikuiRena3316fc2020-01-29 14:58:08 -08003335 Node(app,
3336 "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/",
3337 std::string())
3338 {
3339 entityPrivileges = {
3340 {boost::beast::http::verb::get, {{"Login"}}},
3341 {boost::beast::http::verb::head, {{"Login"}}},
3342 {boost::beast::http::verb::patch, {{"ConfigureManager"}}},
3343 {boost::beast::http::verb::put, {{"ConfigureManager"}}},
3344 {boost::beast::http::verb::delete_, {{"ConfigureManager"}}},
3345 {boost::beast::http::verb::post, {{"ConfigureManager"}}}};
3346 }
3347
3348 private:
Ed Tanouscb13a392020-07-25 19:02:03 +00003349 void doGet(crow::Response& res, const crow::Request&,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05003350 const std::vector<std::string>& params) override
ZhikuiRena3316fc2020-01-29 14:58:08 -08003351 {
3352 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
3353 if (params.size() != 1)
3354 {
3355 messages::internalError(asyncResp->res);
3356 return;
3357 }
3358
Gunnar Mills1214b7e2020-06-04 10:11:30 -05003359 const std::string& targetID = params[0];
ZhikuiRena3316fc2020-01-29 14:58:08 -08003360
3361 size_t bootPos = targetID.find('B');
3362 if (bootPos == std::string::npos)
3363 {
3364 // Requested ID was not found
3365 messages::resourceMissingAtURI(asyncResp->res, targetID);
3366 return;
3367 }
3368 std::string_view bootIndexStr(targetID);
3369 bootIndexStr.remove_prefix(bootPos + 1);
3370 uint16_t bootIndex = 0;
3371 uint64_t codeIndex = 0;
3372 size_t dashPos = bootIndexStr.find('-');
3373
3374 if (dashPos == std::string::npos)
3375 {
3376 return;
3377 }
3378 std::string_view codeIndexStr(bootIndexStr);
3379 bootIndexStr.remove_suffix(dashPos);
3380 codeIndexStr.remove_prefix(dashPos + 1);
3381
3382 bootIndex = static_cast<uint16_t>(
Ed Tanous23a21a12020-07-25 04:45:05 +00003383 strtoul(std::string(bootIndexStr).c_str(), nullptr, 0));
3384 codeIndex = strtoul(std::string(codeIndexStr).c_str(), nullptr, 0);
ZhikuiRena3316fc2020-01-29 14:58:08 -08003385 if (bootIndex == 0 || codeIndex == 0)
3386 {
3387 BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string "
3388 << params[0];
3389 }
3390
3391 asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry";
ZhikuiRena3316fc2020-01-29 14:58:08 -08003392 asyncResp->res.jsonValue["@odata.id"] =
3393 "/redfish/v1/Systems/system/LogServices/PostCodes/"
3394 "Entries";
3395 asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries";
3396 asyncResp->res.jsonValue["Description"] =
3397 "Collection of POST Code Log Entries";
3398 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
3399 asyncResp->res.jsonValue["Members@odata.count"] = 0;
3400
3401 getPostCodeForEntry(asyncResp, bootIndex, codeIndex);
3402 }
3403};
3404
Ed Tanous1da66f72018-07-27 16:13:37 -07003405} // namespace redfish