Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 1 | /* |
| 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. Bills | 4851d45 | 2019-03-28 11:27:48 -0700 | [diff] [blame] | 19 | #include "registries.hpp" |
| 20 | #include "registries/base_message_registry.hpp" |
| 21 | #include "registries/openbmc_message_registry.hpp" |
James Feist | 4622957 | 2020-02-19 15:11:58 -0800 | [diff] [blame] | 22 | #include "task.hpp" |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 23 | |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 24 | #include <systemd/sd-journal.h> |
| 25 | |
Jason M. Bills | 4851d45 | 2019-03-28 11:27:48 -0700 | [diff] [blame] | 26 | #include <boost/algorithm/string/split.hpp> |
| 27 | #include <boost/beast/core/span.hpp> |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 28 | #include <boost/container/flat_map.hpp> |
Jason M. Bills | 1ddcf01 | 2019-11-26 14:59:21 -0800 | [diff] [blame] | 29 | #include <boost/system/linux_error.hpp> |
raviteja-b | 0657843 | 2020-02-03 12:50:42 -0600 | [diff] [blame] | 30 | #include <dump_offload.hpp> |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 31 | #include <error_messages.hpp> |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 32 | |
James Feist | 4418c7f | 2019-04-15 11:09:15 -0700 | [diff] [blame] | 33 | #include <filesystem> |
Jason M. Bills | cd225da | 2019-05-08 15:31:57 -0700 | [diff] [blame] | 34 | #include <string_view> |
Ed Tanous | abf2add | 2019-01-22 16:40:12 -0800 | [diff] [blame] | 35 | #include <variant> |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 36 | |
| 37 | namespace redfish |
| 38 | { |
| 39 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 40 | constexpr char const* crashdumpObject = "com.intel.crashdump"; |
| 41 | constexpr char const* crashdumpPath = "/com/intel/crashdump"; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 42 | constexpr char const* crashdumpInterface = "com.intel.crashdump"; |
| 43 | constexpr char const* deleteAllInterface = |
Jason M. Bills | 5b61b5e | 2019-10-16 10:59:02 -0700 | [diff] [blame] | 44 | "xyz.openbmc_project.Collection.DeleteAll"; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 45 | constexpr char const* crashdumpOnDemandInterface = |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 46 | "com.intel.crashdump.OnDemand"; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 47 | constexpr char const* crashdumpRawPECIInterface = |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 48 | "com.intel.crashdump.SendRawPeci"; |
Kenny L. Ku | 6eda768 | 2020-06-19 09:48:36 -0700 | [diff] [blame] | 49 | constexpr char const* crashdumpTelemetryInterface = |
| 50 | "com.intel.crashdump.Telemetry"; |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 51 | |
Jason M. Bills | 4851d45 | 2019-03-28 11:27:48 -0700 | [diff] [blame] | 52 | namespace message_registries |
| 53 | { |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 54 | static const Message* getMessageFromRegistry( |
| 55 | const std::string& messageKey, |
Jason M. Bills | 4851d45 | 2019-03-28 11:27:48 -0700 | [diff] [blame] | 56 | const boost::beast::span<const MessageEntry> registry) |
| 57 | { |
| 58 | boost::beast::span<const MessageEntry>::const_iterator messageIt = |
| 59 | std::find_if(registry.cbegin(), registry.cend(), |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 60 | [&messageKey](const MessageEntry& messageEntry) { |
Jason M. Bills | 4851d45 | 2019-03-28 11:27:48 -0700 | [diff] [blame] | 61 | return !std::strcmp(messageEntry.first, |
| 62 | messageKey.c_str()); |
| 63 | }); |
| 64 | if (messageIt != registry.cend()) |
| 65 | { |
| 66 | return &messageIt->second; |
| 67 | } |
| 68 | |
| 69 | return nullptr; |
| 70 | } |
| 71 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 72 | static const Message* getMessage(const std::string_view& messageID) |
Jason M. Bills | 4851d45 | 2019-03-28 11:27:48 -0700 | [diff] [blame] | 73 | { |
| 74 | // Redfish MessageIds are in the form |
| 75 | // RegistryName.MajorVersion.MinorVersion.MessageKey, so parse it to find |
| 76 | // the right Message |
| 77 | std::vector<std::string> fields; |
| 78 | fields.reserve(4); |
| 79 | boost::split(fields, messageID, boost::is_any_of(".")); |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 80 | std::string& registryName = fields[0]; |
| 81 | std::string& messageKey = fields[3]; |
Jason M. Bills | 4851d45 | 2019-03-28 11:27:48 -0700 | [diff] [blame] | 82 | |
| 83 | // Find the right registry and check it for the MessageKey |
| 84 | if (std::string(base::header.registryPrefix) == registryName) |
| 85 | { |
| 86 | return getMessageFromRegistry( |
| 87 | messageKey, boost::beast::span<const MessageEntry>(base::registry)); |
| 88 | } |
| 89 | if (std::string(openbmc::header.registryPrefix) == registryName) |
| 90 | { |
| 91 | return getMessageFromRegistry( |
| 92 | messageKey, |
| 93 | boost::beast::span<const MessageEntry>(openbmc::registry)); |
| 94 | } |
| 95 | return nullptr; |
| 96 | } |
| 97 | } // namespace message_registries |
| 98 | |
James Feist | f615040 | 2019-01-08 10:36:20 -0800 | [diff] [blame] | 99 | namespace fs = std::filesystem; |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 100 | |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 101 | using GetManagedPropertyType = boost::container::flat_map< |
Patrick Williams | 19bd78d | 2020-05-13 17:38:24 -0500 | [diff] [blame] | 102 | std::string, std::variant<std::string, bool, uint8_t, int16_t, uint16_t, |
| 103 | int32_t, uint32_t, int64_t, uint64_t, double>>; |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 104 | |
| 105 | using GetManagedObjectsType = boost::container::flat_map< |
| 106 | sdbusplus::message::object_path, |
| 107 | boost::container::flat_map<std::string, GetManagedPropertyType>>; |
| 108 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 109 | inline std::string translateSeverityDbusToRedfish(const std::string& s) |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 110 | { |
| 111 | if (s == "xyz.openbmc_project.Logging.Entry.Level.Alert") |
| 112 | { |
| 113 | return "Critical"; |
| 114 | } |
| 115 | else if (s == "xyz.openbmc_project.Logging.Entry.Level.Critical") |
| 116 | { |
| 117 | return "Critical"; |
| 118 | } |
| 119 | else if (s == "xyz.openbmc_project.Logging.Entry.Level.Debug") |
| 120 | { |
| 121 | return "OK"; |
| 122 | } |
| 123 | else if (s == "xyz.openbmc_project.Logging.Entry.Level.Emergency") |
| 124 | { |
| 125 | return "Critical"; |
| 126 | } |
| 127 | else if (s == "xyz.openbmc_project.Logging.Entry.Level.Error") |
| 128 | { |
| 129 | return "Critical"; |
| 130 | } |
| 131 | else if (s == "xyz.openbmc_project.Logging.Entry.Level.Informational") |
| 132 | { |
| 133 | return "OK"; |
| 134 | } |
| 135 | else if (s == "xyz.openbmc_project.Logging.Entry.Level.Notice") |
| 136 | { |
| 137 | return "OK"; |
| 138 | } |
| 139 | else if (s == "xyz.openbmc_project.Logging.Entry.Level.Warning") |
| 140 | { |
| 141 | return "Warning"; |
| 142 | } |
| 143 | return ""; |
| 144 | } |
| 145 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 146 | static int getJournalMetadata(sd_journal* journal, |
| 147 | const std::string_view& field, |
| 148 | std::string_view& contents) |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 149 | { |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 150 | const char* data = nullptr; |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 151 | size_t length = 0; |
| 152 | int ret = 0; |
| 153 | // Get the metadata from the requested field of the journal entry |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 154 | ret = sd_journal_get_data(journal, field.data(), |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 155 | reinterpret_cast<const void**>(&data), &length); |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 156 | if (ret < 0) |
| 157 | { |
| 158 | return ret; |
| 159 | } |
Ed Tanous | 39e7750 | 2019-03-04 17:35:53 -0800 | [diff] [blame] | 160 | contents = std::string_view(data, length); |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 161 | // Only use the content after the "=" character. |
| 162 | contents.remove_prefix(std::min(contents.find("=") + 1, contents.size())); |
| 163 | return ret; |
| 164 | } |
| 165 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 166 | static int getJournalMetadata(sd_journal* journal, |
| 167 | const std::string_view& field, const int& base, |
| 168 | long int& contents) |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 169 | { |
| 170 | int ret = 0; |
Ed Tanous | 39e7750 | 2019-03-04 17:35:53 -0800 | [diff] [blame] | 171 | std::string_view metadata; |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 172 | // Get the metadata from the requested field of the journal entry |
| 173 | ret = getJournalMetadata(journal, field, metadata); |
| 174 | if (ret < 0) |
| 175 | { |
| 176 | return ret; |
| 177 | } |
Ed Tanous | b01bf29 | 2019-03-25 19:25:26 +0000 | [diff] [blame] | 178 | contents = strtol(metadata.data(), nullptr, base); |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 179 | return ret; |
| 180 | } |
| 181 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 182 | static bool getEntryTimestamp(sd_journal* journal, std::string& entryTimestamp) |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 183 | { |
| 184 | int ret = 0; |
| 185 | uint64_t timestamp = 0; |
| 186 | ret = sd_journal_get_realtime_usec(journal, ×tamp); |
| 187 | if (ret < 0) |
| 188 | { |
| 189 | BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " |
| 190 | << strerror(-ret); |
| 191 | return false; |
| 192 | } |
Asmitha Karunanithi | 9c620e2 | 2020-08-02 11:55:21 -0500 | [diff] [blame] | 193 | entryTimestamp = crow::utility::getDateTime( |
| 194 | static_cast<std::time_t>(timestamp / 1000 / 1000)); |
| 195 | return true; |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 196 | } |
| 197 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 198 | static bool getSkipParam(crow::Response& res, const crow::Request& req, |
| 199 | uint64_t& skip) |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 200 | { |
James Feist | 5a7e877 | 2020-07-22 09:08:38 -0700 | [diff] [blame] | 201 | boost::urls::url_view::params_type::iterator it = |
| 202 | req.urlParams.find("$skip"); |
| 203 | if (it != req.urlParams.end()) |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 204 | { |
James Feist | 5a7e877 | 2020-07-22 09:08:38 -0700 | [diff] [blame] | 205 | std::string skipParam = it->value(); |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 206 | char* ptr = nullptr; |
James Feist | 5a7e877 | 2020-07-22 09:08:38 -0700 | [diff] [blame] | 207 | skip = std::strtoul(skipParam.c_str(), &ptr, 10); |
| 208 | if (skipParam.empty() || *ptr != '\0') |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 209 | { |
| 210 | |
| 211 | messages::queryParameterValueTypeError(res, std::string(skipParam), |
| 212 | "$skip"); |
| 213 | return false; |
| 214 | } |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 215 | } |
| 216 | return true; |
| 217 | } |
| 218 | |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 219 | static constexpr const uint64_t maxEntriesPerPage = 1000; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 220 | static bool getTopParam(crow::Response& res, const crow::Request& req, |
| 221 | uint64_t& top) |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 222 | { |
James Feist | 5a7e877 | 2020-07-22 09:08:38 -0700 | [diff] [blame] | 223 | boost::urls::url_view::params_type::iterator it = |
| 224 | req.urlParams.find("$top"); |
| 225 | if (it != req.urlParams.end()) |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 226 | { |
James Feist | 5a7e877 | 2020-07-22 09:08:38 -0700 | [diff] [blame] | 227 | std::string topParam = it->value(); |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 228 | char* ptr = nullptr; |
James Feist | 5a7e877 | 2020-07-22 09:08:38 -0700 | [diff] [blame] | 229 | top = std::strtoul(topParam.c_str(), &ptr, 10); |
| 230 | if (topParam.empty() || *ptr != '\0') |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 231 | { |
| 232 | messages::queryParameterValueTypeError(res, std::string(topParam), |
| 233 | "$top"); |
| 234 | return false; |
| 235 | } |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 236 | if (top < 1U || top > maxEntriesPerPage) |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 237 | { |
| 238 | |
| 239 | messages::queryParameterOutOfRange( |
| 240 | res, std::to_string(top), "$top", |
| 241 | "1-" + std::to_string(maxEntriesPerPage)); |
| 242 | return false; |
| 243 | } |
| 244 | } |
| 245 | return true; |
| 246 | } |
| 247 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 248 | static bool getUniqueEntryID(sd_journal* journal, std::string& entryID, |
Jason M. Bills | e85d6b1 | 2019-07-29 17:01:15 -0700 | [diff] [blame] | 249 | const bool firstEntry = true) |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 250 | { |
| 251 | int ret = 0; |
| 252 | static uint64_t prevTs = 0; |
| 253 | static int index = 0; |
Jason M. Bills | e85d6b1 | 2019-07-29 17:01:15 -0700 | [diff] [blame] | 254 | if (firstEntry) |
| 255 | { |
| 256 | prevTs = 0; |
| 257 | } |
| 258 | |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 259 | // Get the entry timestamp |
| 260 | uint64_t curTs = 0; |
| 261 | ret = sd_journal_get_realtime_usec(journal, &curTs); |
| 262 | if (ret < 0) |
| 263 | { |
| 264 | BMCWEB_LOG_ERROR << "Failed to read entry timestamp: " |
| 265 | << strerror(-ret); |
| 266 | return false; |
| 267 | } |
| 268 | // If the timestamp isn't unique, increment the index |
| 269 | if (curTs == prevTs) |
| 270 | { |
| 271 | index++; |
| 272 | } |
| 273 | else |
| 274 | { |
| 275 | // Otherwise, reset it |
| 276 | index = 0; |
| 277 | } |
| 278 | // Save the timestamp |
| 279 | prevTs = curTs; |
| 280 | |
| 281 | entryID = std::to_string(curTs); |
| 282 | if (index > 0) |
| 283 | { |
| 284 | entryID += "_" + std::to_string(index); |
| 285 | } |
| 286 | return true; |
| 287 | } |
| 288 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 289 | static bool getUniqueEntryID(const std::string& logEntry, std::string& entryID, |
Jason M. Bills | e85d6b1 | 2019-07-29 17:01:15 -0700 | [diff] [blame] | 290 | const bool firstEntry = true) |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 291 | { |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 292 | static time_t prevTs = 0; |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 293 | static int index = 0; |
Jason M. Bills | e85d6b1 | 2019-07-29 17:01:15 -0700 | [diff] [blame] | 294 | if (firstEntry) |
| 295 | { |
| 296 | prevTs = 0; |
| 297 | } |
| 298 | |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 299 | // Get the entry timestamp |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 300 | std::time_t curTs = 0; |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 301 | std::tm timeStruct = {}; |
| 302 | std::istringstream entryStream(logEntry); |
| 303 | if (entryStream >> std::get_time(&timeStruct, "%Y-%m-%dT%H:%M:%S")) |
| 304 | { |
| 305 | curTs = std::mktime(&timeStruct); |
| 306 | } |
| 307 | // If the timestamp isn't unique, increment the index |
| 308 | if (curTs == prevTs) |
| 309 | { |
| 310 | index++; |
| 311 | } |
| 312 | else |
| 313 | { |
| 314 | // Otherwise, reset it |
| 315 | index = 0; |
| 316 | } |
| 317 | // Save the timestamp |
| 318 | prevTs = curTs; |
| 319 | |
| 320 | entryID = std::to_string(curTs); |
| 321 | if (index > 0) |
| 322 | { |
| 323 | entryID += "_" + std::to_string(index); |
| 324 | } |
| 325 | return true; |
| 326 | } |
| 327 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 328 | static bool getTimestampFromID(crow::Response& res, const std::string& entryID, |
| 329 | uint64_t& timestamp, uint64_t& index) |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 330 | { |
| 331 | if (entryID.empty()) |
| 332 | { |
| 333 | return false; |
| 334 | } |
| 335 | // Convert the unique ID back to a timestamp to find the entry |
Ed Tanous | 39e7750 | 2019-03-04 17:35:53 -0800 | [diff] [blame] | 336 | std::string_view tsStr(entryID); |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 337 | |
| 338 | auto underscorePos = tsStr.find("_"); |
| 339 | if (underscorePos != tsStr.npos) |
| 340 | { |
| 341 | // Timestamp has an index |
| 342 | tsStr.remove_suffix(tsStr.size() - underscorePos); |
Ed Tanous | 39e7750 | 2019-03-04 17:35:53 -0800 | [diff] [blame] | 343 | std::string_view indexStr(entryID); |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 344 | indexStr.remove_prefix(underscorePos + 1); |
| 345 | std::size_t pos; |
| 346 | try |
| 347 | { |
Ed Tanous | 39e7750 | 2019-03-04 17:35:53 -0800 | [diff] [blame] | 348 | index = std::stoul(std::string(indexStr), &pos); |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 349 | } |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 350 | catch (std::invalid_argument&) |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 351 | { |
| 352 | messages::resourceMissingAtURI(res, entryID); |
| 353 | return false; |
| 354 | } |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 355 | catch (std::out_of_range&) |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 356 | { |
| 357 | messages::resourceMissingAtURI(res, entryID); |
| 358 | return false; |
| 359 | } |
| 360 | if (pos != indexStr.size()) |
| 361 | { |
| 362 | messages::resourceMissingAtURI(res, entryID); |
| 363 | return false; |
| 364 | } |
| 365 | } |
| 366 | // Timestamp has no index |
| 367 | std::size_t pos; |
| 368 | try |
| 369 | { |
Ed Tanous | 39e7750 | 2019-03-04 17:35:53 -0800 | [diff] [blame] | 370 | timestamp = std::stoull(std::string(tsStr), &pos); |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 371 | } |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 372 | catch (std::invalid_argument&) |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 373 | { |
| 374 | messages::resourceMissingAtURI(res, entryID); |
| 375 | return false; |
| 376 | } |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 377 | catch (std::out_of_range&) |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 378 | { |
| 379 | messages::resourceMissingAtURI(res, entryID); |
| 380 | return false; |
| 381 | } |
| 382 | if (pos != tsStr.size()) |
| 383 | { |
| 384 | messages::resourceMissingAtURI(res, entryID); |
| 385 | return false; |
| 386 | } |
| 387 | return true; |
| 388 | } |
| 389 | |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 390 | static bool |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 391 | getRedfishLogFiles(std::vector<std::filesystem::path>& redfishLogFiles) |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 392 | { |
| 393 | static const std::filesystem::path redfishLogDir = "/var/log"; |
| 394 | static const std::string redfishLogFilename = "redfish"; |
| 395 | |
| 396 | // Loop through the directory looking for redfish log files |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 397 | for (const std::filesystem::directory_entry& dirEnt : |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 398 | std::filesystem::directory_iterator(redfishLogDir)) |
| 399 | { |
| 400 | // If we find a redfish log file, save the path |
| 401 | std::string filename = dirEnt.path().filename(); |
| 402 | if (boost::starts_with(filename, redfishLogFilename)) |
| 403 | { |
| 404 | redfishLogFiles.emplace_back(redfishLogDir / filename); |
| 405 | } |
| 406 | } |
| 407 | // As the log files rotate, they are appended with a ".#" that is higher for |
| 408 | // the older logs. Since we don't expect more than 10 log files, we |
| 409 | // can just sort the list to get them in order from newest to oldest |
| 410 | std::sort(redfishLogFiles.begin(), redfishLogFiles.end()); |
| 411 | |
| 412 | return !redfishLogFiles.empty(); |
| 413 | } |
| 414 | |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 415 | inline void getDumpEntryCollection(std::shared_ptr<AsyncResp>& asyncResp, |
| 416 | const std::string& dumpType) |
| 417 | { |
| 418 | std::string dumpPath; |
| 419 | if (dumpType == "BMC") |
| 420 | { |
| 421 | dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; |
| 422 | } |
| 423 | else if (dumpType == "System") |
| 424 | { |
| 425 | dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; |
| 426 | } |
| 427 | else |
| 428 | { |
| 429 | BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType; |
| 430 | messages::internalError(asyncResp->res); |
| 431 | return; |
| 432 | } |
| 433 | |
| 434 | crow::connections::systemBus->async_method_call( |
| 435 | [asyncResp, dumpPath, dumpType](const boost::system::error_code ec, |
| 436 | GetManagedObjectsType& resp) { |
| 437 | if (ec) |
| 438 | { |
| 439 | BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; |
| 440 | messages::internalError(asyncResp->res); |
| 441 | return; |
| 442 | } |
| 443 | |
| 444 | nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"]; |
| 445 | entriesArray = nlohmann::json::array(); |
| 446 | |
| 447 | for (auto& object : resp) |
| 448 | { |
| 449 | bool foundDumpEntry = false; |
| 450 | for (auto& interfaceMap : object.second) |
| 451 | { |
| 452 | if (interfaceMap.first == |
| 453 | ("xyz.openbmc_project.Dump.Entry." + dumpType)) |
| 454 | { |
| 455 | foundDumpEntry = true; |
| 456 | break; |
| 457 | } |
| 458 | } |
| 459 | |
| 460 | if (foundDumpEntry == false) |
| 461 | { |
| 462 | continue; |
| 463 | } |
| 464 | std::time_t timestamp; |
| 465 | uint64_t size = 0; |
| 466 | entriesArray.push_back({}); |
| 467 | nlohmann::json& thisEntry = entriesArray.back(); |
| 468 | const std::string& path = |
| 469 | static_cast<const std::string&>(object.first); |
| 470 | std::size_t lastPos = path.rfind("/"); |
| 471 | if (lastPos == std::string::npos) |
| 472 | { |
| 473 | continue; |
| 474 | } |
| 475 | std::string entryID = path.substr(lastPos + 1); |
| 476 | |
| 477 | for (auto& interfaceMap : object.second) |
| 478 | { |
| 479 | if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") |
| 480 | { |
| 481 | |
| 482 | for (auto& propertyMap : interfaceMap.second) |
| 483 | { |
| 484 | if (propertyMap.first == "Size") |
| 485 | { |
| 486 | auto sizePtr = |
| 487 | std::get_if<uint64_t>(&propertyMap.second); |
| 488 | if (sizePtr == nullptr) |
| 489 | { |
| 490 | messages::internalError(asyncResp->res); |
| 491 | break; |
| 492 | } |
| 493 | size = *sizePtr; |
| 494 | break; |
| 495 | } |
| 496 | } |
| 497 | } |
| 498 | else if (interfaceMap.first == |
| 499 | "xyz.openbmc_project.Time.EpochTime") |
| 500 | { |
| 501 | |
| 502 | for (auto& propertyMap : interfaceMap.second) |
| 503 | { |
| 504 | if (propertyMap.first == "Elapsed") |
| 505 | { |
| 506 | const uint64_t* usecsTimeStamp = |
| 507 | std::get_if<uint64_t>(&propertyMap.second); |
| 508 | if (usecsTimeStamp == nullptr) |
| 509 | { |
| 510 | messages::internalError(asyncResp->res); |
| 511 | break; |
| 512 | } |
| 513 | timestamp = |
| 514 | static_cast<std::time_t>(*usecsTimeStamp); |
| 515 | break; |
| 516 | } |
| 517 | } |
| 518 | } |
| 519 | } |
| 520 | |
| 521 | thisEntry["@odata.type"] = "#LogEntry.v1_5_1.LogEntry"; |
| 522 | thisEntry["@odata.id"] = dumpPath + entryID; |
| 523 | thisEntry["Id"] = entryID; |
| 524 | thisEntry["EntryType"] = "Event"; |
| 525 | thisEntry["Created"] = crow::utility::getDateTime(timestamp); |
| 526 | thisEntry["Name"] = dumpType + " Dump Entry"; |
| 527 | |
| 528 | thisEntry["Oem"]["OpenBmc"]["@odata.type"] = |
| 529 | "#OemLogEntry.v1_0_0.OpenBmc"; |
| 530 | thisEntry["Oem"]["OpenBmc"]["AdditionalDataSizeBytes"] = size; |
| 531 | |
| 532 | if (dumpType == "BMC") |
| 533 | { |
| 534 | thisEntry["Oem"]["OpenBmc"]["DiagnosticDataType"] = |
| 535 | "Manager"; |
| 536 | thisEntry["Oem"]["OpenBmc"]["AdditionalDataURI"] = |
| 537 | "/redfish/v1/Managers/bmc/LogServices/Dump/" |
| 538 | "attachment/" + |
| 539 | entryID; |
| 540 | } |
| 541 | else if (dumpType == "System") |
| 542 | { |
| 543 | thisEntry["Oem"]["OpenBmc"]["DiagnosticDataType"] = "OEM"; |
| 544 | thisEntry["Oem"]["OpenBmc"]["OEMDiagnosticDataType"] = |
| 545 | "System"; |
| 546 | thisEntry["Oem"]["OpenBmc"]["AdditionalDataURI"] = |
| 547 | "/redfish/v1/Systems/system/LogServices/Dump/" |
| 548 | "attachment/" + |
| 549 | entryID; |
| 550 | } |
| 551 | } |
| 552 | asyncResp->res.jsonValue["Members@odata.count"] = |
| 553 | entriesArray.size(); |
| 554 | }, |
| 555 | "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", |
| 556 | "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); |
| 557 | } |
| 558 | |
| 559 | inline void getDumpEntryById(std::shared_ptr<AsyncResp>& asyncResp, |
| 560 | const std::string& entryID, |
| 561 | const std::string& dumpType) |
| 562 | { |
| 563 | std::string dumpPath; |
| 564 | if (dumpType == "BMC") |
| 565 | { |
| 566 | dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; |
| 567 | } |
| 568 | else if (dumpType == "System") |
| 569 | { |
| 570 | dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; |
| 571 | } |
| 572 | else |
| 573 | { |
| 574 | BMCWEB_LOG_ERROR << "Invalid dump type" << dumpType; |
| 575 | messages::internalError(asyncResp->res); |
| 576 | return; |
| 577 | } |
| 578 | |
| 579 | crow::connections::systemBus->async_method_call( |
| 580 | [asyncResp, entryID, dumpPath, dumpType]( |
| 581 | const boost::system::error_code ec, GetManagedObjectsType& resp) { |
| 582 | if (ec) |
| 583 | { |
| 584 | BMCWEB_LOG_ERROR << "DumpEntry resp_handler got error " << ec; |
| 585 | messages::internalError(asyncResp->res); |
| 586 | return; |
| 587 | } |
| 588 | |
| 589 | for (auto& objectPath : resp) |
| 590 | { |
| 591 | if (objectPath.first.str.find( |
| 592 | "/xyz/openbmc_project/dump/entry/" + entryID) == |
| 593 | std::string::npos) |
| 594 | { |
| 595 | continue; |
| 596 | } |
| 597 | |
| 598 | bool foundDumpEntry = false; |
| 599 | for (auto& interfaceMap : objectPath.second) |
| 600 | { |
| 601 | if (interfaceMap.first == |
| 602 | ("xyz.openbmc_project.Dump.Entry." + dumpType)) |
| 603 | { |
| 604 | foundDumpEntry = true; |
| 605 | break; |
| 606 | } |
| 607 | } |
| 608 | if (foundDumpEntry == false) |
| 609 | { |
| 610 | BMCWEB_LOG_ERROR << "Can't find Dump Entry"; |
| 611 | messages::internalError(asyncResp->res); |
| 612 | return; |
| 613 | } |
| 614 | |
| 615 | std::time_t timestamp; |
| 616 | uint64_t size = 0; |
| 617 | |
| 618 | for (auto& interfaceMap : objectPath.second) |
| 619 | { |
| 620 | if (interfaceMap.first == "xyz.openbmc_project.Dump.Entry") |
| 621 | { |
| 622 | for (auto& propertyMap : interfaceMap.second) |
| 623 | { |
| 624 | if (propertyMap.first == "Size") |
| 625 | { |
| 626 | auto sizePtr = |
| 627 | std::get_if<uint64_t>(&propertyMap.second); |
| 628 | if (sizePtr == nullptr) |
| 629 | { |
| 630 | messages::internalError(asyncResp->res); |
| 631 | break; |
| 632 | } |
| 633 | size = *sizePtr; |
| 634 | break; |
| 635 | } |
| 636 | } |
| 637 | } |
| 638 | else if (interfaceMap.first == |
| 639 | "xyz.openbmc_project.Time.EpochTime") |
| 640 | { |
| 641 | for (auto& propertyMap : interfaceMap.second) |
| 642 | { |
| 643 | if (propertyMap.first == "Elapsed") |
| 644 | { |
| 645 | const uint64_t* usecsTimeStamp = |
| 646 | std::get_if<uint64_t>(&propertyMap.second); |
| 647 | if (usecsTimeStamp == nullptr) |
| 648 | { |
| 649 | messages::internalError(asyncResp->res); |
| 650 | break; |
| 651 | } |
| 652 | timestamp = |
| 653 | static_cast<std::time_t>(*usecsTimeStamp); |
| 654 | break; |
| 655 | } |
| 656 | } |
| 657 | } |
| 658 | } |
| 659 | |
| 660 | asyncResp->res.jsonValue["@odata.type"] = |
| 661 | "#LogEntry.v1_5_1.LogEntry"; |
| 662 | asyncResp->res.jsonValue["@odata.id"] = dumpPath + entryID; |
| 663 | asyncResp->res.jsonValue["Id"] = entryID; |
| 664 | asyncResp->res.jsonValue["EntryType"] = "Event"; |
| 665 | asyncResp->res.jsonValue["Created"] = |
| 666 | crow::utility::getDateTime(timestamp); |
| 667 | asyncResp->res.jsonValue["Name"] = dumpType + " Dump Entry"; |
| 668 | |
| 669 | asyncResp->res.jsonValue["Oem"]["OpenBmc"]["@odata.type"] = |
| 670 | "#OemLogEntry.v1_0_0.OpenBmc"; |
| 671 | asyncResp->res |
| 672 | .jsonValue["Oem"]["OpenBmc"]["AdditionalDataSizeBytes"] = |
| 673 | size; |
| 674 | |
| 675 | if (dumpType == "BMC") |
| 676 | { |
| 677 | asyncResp->res |
| 678 | .jsonValue["Oem"]["OpenBmc"]["DiagnosticDataType"] = |
| 679 | "Manager"; |
| 680 | asyncResp->res |
| 681 | .jsonValue["Oem"]["OpenBmc"]["AdditionalDataURI"] = |
| 682 | "/redfish/v1/Managers/bmc/LogServices/Dump/" |
| 683 | "attachment/" + |
| 684 | entryID; |
| 685 | } |
| 686 | else if (dumpType == "System") |
| 687 | { |
| 688 | asyncResp->res |
| 689 | .jsonValue["Oem"]["OpenBmc"]["DiagnosticDataType"] = |
| 690 | "OEM"; |
| 691 | asyncResp->res |
| 692 | .jsonValue["Oem"]["OpenBmc"]["OEMDiagnosticDataType"] = |
| 693 | "System"; |
| 694 | asyncResp->res |
| 695 | .jsonValue["Oem"]["OpenBmc"]["AdditionalDataURI"] = |
| 696 | "/redfish/v1/Systems/system/LogServices/Dump/" |
| 697 | "attachment/" + |
| 698 | entryID; |
| 699 | } |
| 700 | } |
| 701 | }, |
| 702 | "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", |
| 703 | "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); |
| 704 | } |
| 705 | |
| 706 | inline void deleteDumpEntry(crow::Response& res, const std::string& entryID) |
| 707 | { |
| 708 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 709 | |
| 710 | auto respHandler = [asyncResp](const boost::system::error_code ec) { |
| 711 | BMCWEB_LOG_DEBUG << "Dump Entry doDelete callback: Done"; |
| 712 | if (ec) |
| 713 | { |
| 714 | BMCWEB_LOG_ERROR << "Dump (DBus) doDelete respHandler got error " |
| 715 | << ec; |
| 716 | messages::internalError(asyncResp->res); |
| 717 | return; |
| 718 | } |
| 719 | }; |
| 720 | crow::connections::systemBus->async_method_call( |
| 721 | respHandler, "xyz.openbmc_project.Dump.Manager", |
| 722 | "/xyz/openbmc_project/dump/entry/" + entryID, |
| 723 | "xyz.openbmc_project.Object.Delete", "Delete"); |
| 724 | } |
| 725 | |
Asmitha Karunanithi | a43be80 | 2020-05-07 05:05:36 -0500 | [diff] [blame] | 726 | inline void createDumpTaskCallback(const crow::Request& req, |
| 727 | std::shared_ptr<AsyncResp> asyncResp, |
| 728 | const uint32_t& dumpId, |
| 729 | const std::string& dumpPath, |
| 730 | const std::string& dumpType) |
| 731 | { |
| 732 | std::shared_ptr<task::TaskData> task = task::TaskData::createTask( |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 733 | [dumpId, dumpPath, dumpType, asyncResp]( |
Asmitha Karunanithi | a43be80 | 2020-05-07 05:05:36 -0500 | [diff] [blame] | 734 | boost::system::error_code err, sdbusplus::message::message& m, |
| 735 | const std::shared_ptr<task::TaskData>& taskData) { |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 736 | if (err) |
| 737 | { |
| 738 | messages::internalError(asyncResp->res); |
| 739 | return false; |
| 740 | } |
Asmitha Karunanithi | a43be80 | 2020-05-07 05:05:36 -0500 | [diff] [blame] | 741 | std::vector<std::pair< |
| 742 | std::string, |
| 743 | std::vector<std::pair<std::string, std::variant<std::string>>>>> |
| 744 | interfacesList; |
| 745 | |
| 746 | sdbusplus::message::object_path objPath; |
| 747 | |
| 748 | m.read(objPath, interfacesList); |
| 749 | |
| 750 | for (auto& interface : interfacesList) |
| 751 | { |
| 752 | if (interface.first == |
| 753 | ("xyz.openbmc_project.Dump.Entry." + dumpType)) |
| 754 | { |
| 755 | nlohmann::json retMessage = messages::success(); |
| 756 | taskData->messages.emplace_back(retMessage); |
| 757 | |
| 758 | std::string headerLoc = |
| 759 | "Location: " + dumpPath + std::to_string(dumpId); |
| 760 | taskData->payload->httpHeaders.emplace_back( |
| 761 | std::move(headerLoc)); |
| 762 | |
| 763 | taskData->state = "Completed"; |
| 764 | return task::completed; |
| 765 | } |
| 766 | } |
| 767 | return !task::completed; |
| 768 | }, |
| 769 | "type='signal',interface='org.freedesktop.DBus." |
| 770 | "ObjectManager'," |
| 771 | "member='InterfacesAdded', " |
| 772 | "path='/xyz/openbmc_project/dump'"); |
| 773 | |
| 774 | task->startTimer(std::chrono::minutes(3)); |
| 775 | task->populateResp(asyncResp->res); |
| 776 | task->payload.emplace(req); |
| 777 | } |
| 778 | |
| 779 | inline void createDump(crow::Response& res, const crow::Request& req, |
| 780 | const std::string& dumpType) |
| 781 | { |
| 782 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 783 | |
| 784 | std::string dumpPath; |
| 785 | if (dumpType == "BMC") |
| 786 | { |
| 787 | dumpPath = "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/"; |
| 788 | } |
| 789 | else if (dumpType == "System") |
| 790 | { |
| 791 | dumpPath = "/redfish/v1/Systems/system/LogServices/Dump/Entries/"; |
| 792 | } |
| 793 | else |
| 794 | { |
| 795 | BMCWEB_LOG_ERROR << "Invalid dump type: " << dumpType; |
| 796 | messages::internalError(asyncResp->res); |
| 797 | return; |
| 798 | } |
| 799 | |
| 800 | std::optional<std::string> diagnosticDataType; |
| 801 | std::optional<std::string> oemDiagnosticDataType; |
| 802 | |
| 803 | if (!redfish::json_util::readJson( |
| 804 | req, asyncResp->res, "DiagnosticDataType", diagnosticDataType, |
| 805 | "OEMDiagnosticDataType", oemDiagnosticDataType)) |
| 806 | { |
| 807 | return; |
| 808 | } |
| 809 | |
| 810 | if (dumpType == "System") |
| 811 | { |
| 812 | if (!oemDiagnosticDataType || !diagnosticDataType) |
| 813 | { |
| 814 | BMCWEB_LOG_ERROR << "CreateDump action parameter " |
| 815 | "'DiagnosticDataType'/" |
| 816 | "'OEMDiagnosticDataType' value not found!"; |
| 817 | messages::actionParameterMissing( |
| 818 | asyncResp->res, "CollectDiagnosticData", |
| 819 | "DiagnosticDataType & OEMDiagnosticDataType"); |
| 820 | return; |
| 821 | } |
| 822 | else if ((*oemDiagnosticDataType != "System") || |
| 823 | (*diagnosticDataType != "OEM")) |
| 824 | { |
| 825 | BMCWEB_LOG_ERROR << "Wrong parameter values passed"; |
| 826 | messages::invalidObject(asyncResp->res, |
| 827 | "System Dump creation parameters"); |
| 828 | return; |
| 829 | } |
| 830 | } |
| 831 | else if (dumpType == "BMC") |
| 832 | { |
| 833 | if (!diagnosticDataType) |
| 834 | { |
| 835 | BMCWEB_LOG_ERROR << "CreateDump action parameter " |
| 836 | "'DiagnosticDataType' not found!"; |
| 837 | messages::actionParameterMissing( |
| 838 | asyncResp->res, "CollectDiagnosticData", "DiagnosticDataType"); |
| 839 | return; |
| 840 | } |
| 841 | else if (*diagnosticDataType != "Manager") |
| 842 | { |
| 843 | BMCWEB_LOG_ERROR |
| 844 | << "Wrong parameter value passed for 'DiagnosticDataType'"; |
| 845 | messages::invalidObject(asyncResp->res, |
| 846 | "BMC Dump creation parameters"); |
| 847 | return; |
| 848 | } |
| 849 | } |
| 850 | |
| 851 | crow::connections::systemBus->async_method_call( |
| 852 | [asyncResp, req, dumpPath, dumpType](const boost::system::error_code ec, |
| 853 | const uint32_t& dumpId) { |
| 854 | if (ec) |
| 855 | { |
| 856 | BMCWEB_LOG_ERROR << "CreateDump resp_handler got error " << ec; |
| 857 | messages::internalError(asyncResp->res); |
| 858 | return; |
| 859 | } |
| 860 | BMCWEB_LOG_DEBUG << "Dump Created. Id: " << dumpId; |
| 861 | |
| 862 | createDumpTaskCallback(req, asyncResp, dumpId, dumpPath, dumpType); |
| 863 | }, |
| 864 | "xyz.openbmc_project.Dump.Manager", "/xyz/openbmc_project/dump", |
| 865 | "xyz.openbmc_project.Dump.Create", "CreateDump"); |
| 866 | } |
| 867 | |
Asmitha Karunanithi | 80319af | 2020-05-07 05:30:21 -0500 | [diff] [blame] | 868 | inline void clearDump(crow::Response& res, const std::string& dumpInterface) |
| 869 | { |
| 870 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 871 | crow::connections::systemBus->async_method_call( |
| 872 | [asyncResp](const boost::system::error_code ec, |
| 873 | const std::vector<std::string>& subTreePaths) { |
| 874 | if (ec) |
| 875 | { |
| 876 | BMCWEB_LOG_ERROR << "resp_handler got error " << ec; |
| 877 | messages::internalError(asyncResp->res); |
| 878 | return; |
| 879 | } |
| 880 | |
| 881 | for (const std::string& path : subTreePaths) |
| 882 | { |
| 883 | std::size_t pos = path.rfind("/"); |
| 884 | if (pos != std::string::npos) |
| 885 | { |
| 886 | std::string logID = path.substr(pos + 1); |
| 887 | deleteDumpEntry(asyncResp->res, logID); |
| 888 | } |
| 889 | } |
| 890 | }, |
| 891 | "xyz.openbmc_project.ObjectMapper", |
| 892 | "/xyz/openbmc_project/object_mapper", |
| 893 | "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", |
| 894 | "/xyz/openbmc_project/dump", 0, |
| 895 | std::array<std::string, 1>{dumpInterface}); |
| 896 | } |
| 897 | |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 898 | static void ParseCrashdumpParameters( |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 899 | const std::vector<std::pair<std::string, VariantType>>& params, |
| 900 | std::string& filename, std::string& timestamp, std::string& logfile) |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 901 | { |
| 902 | for (auto property : params) |
| 903 | { |
| 904 | if (property.first == "Timestamp") |
| 905 | { |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 906 | const std::string* value = |
Patrick Williams | 8d78b7a | 2020-05-13 11:24:20 -0500 | [diff] [blame] | 907 | std::get_if<std::string>(&property.second); |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 908 | if (value != nullptr) |
| 909 | { |
| 910 | timestamp = *value; |
| 911 | } |
| 912 | } |
| 913 | else if (property.first == "Filename") |
| 914 | { |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 915 | const std::string* value = |
Patrick Williams | 8d78b7a | 2020-05-13 11:24:20 -0500 | [diff] [blame] | 916 | std::get_if<std::string>(&property.second); |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 917 | if (value != nullptr) |
| 918 | { |
| 919 | filename = *value; |
| 920 | } |
| 921 | } |
| 922 | else if (property.first == "Log") |
| 923 | { |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 924 | const std::string* value = |
Patrick Williams | 8d78b7a | 2020-05-13 11:24:20 -0500 | [diff] [blame] | 925 | std::get_if<std::string>(&property.second); |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 926 | if (value != nullptr) |
| 927 | { |
| 928 | logfile = *value; |
| 929 | } |
| 930 | } |
| 931 | } |
| 932 | } |
| 933 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 934 | constexpr char const* postCodeIface = "xyz.openbmc_project.State.Boot.PostCode"; |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 935 | class SystemLogServiceCollection : public Node |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 936 | { |
| 937 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 938 | SystemLogServiceCollection(App& app) : |
Ed Tanous | 029573d | 2019-02-01 10:57:49 -0800 | [diff] [blame] | 939 | Node(app, "/redfish/v1/Systems/system/LogServices/") |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 940 | { |
| 941 | entityPrivileges = { |
| 942 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 943 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 944 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 945 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 946 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 947 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 948 | } |
| 949 | |
| 950 | private: |
| 951 | /** |
| 952 | * Functions triggers appropriate requests on DBus |
| 953 | */ |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 954 | void doGet(crow::Response& res, const crow::Request&, |
| 955 | const std::vector<std::string>&) override |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 956 | { |
| 957 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 958 | // Collections don't include the static data added by SubRoute because |
| 959 | // it has a duplicate entry for members |
| 960 | asyncResp->res.jsonValue["@odata.type"] = |
| 961 | "#LogServiceCollection.LogServiceCollection"; |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 962 | asyncResp->res.jsonValue["@odata.id"] = |
Ed Tanous | 029573d | 2019-02-01 10:57:49 -0800 | [diff] [blame] | 963 | "/redfish/v1/Systems/system/LogServices"; |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 964 | asyncResp->res.jsonValue["Name"] = "System Log Services Collection"; |
| 965 | asyncResp->res.jsonValue["Description"] = |
| 966 | "Collection of LogServices for this Computer System"; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 967 | nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 968 | logServiceArray = nlohmann::json::array(); |
Ed Tanous | 029573d | 2019-02-01 10:57:49 -0800 | [diff] [blame] | 969 | logServiceArray.push_back( |
| 970 | {{"@odata.id", "/redfish/v1/Systems/system/LogServices/EventLog"}}); |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 971 | #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 972 | logServiceArray.push_back( |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 973 | {{"@odata.id", "/redfish/v1/Systems/system/LogServices/Dump"}}); |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 974 | #endif |
| 975 | |
Jason M. Bills | d53dd41 | 2019-02-12 17:16:22 -0800 | [diff] [blame] | 976 | #ifdef BMCWEB_ENABLE_REDFISH_CPU_LOG |
| 977 | logServiceArray.push_back( |
Anthony Wilson | 08a4e4b | 2019-04-12 08:23:05 -0500 | [diff] [blame] | 978 | {{"@odata.id", |
| 979 | "/redfish/v1/Systems/system/LogServices/Crashdump"}}); |
Jason M. Bills | d53dd41 | 2019-02-12 17:16:22 -0800 | [diff] [blame] | 980 | #endif |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 981 | asyncResp->res.jsonValue["Members@odata.count"] = |
| 982 | logServiceArray.size(); |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 983 | |
| 984 | crow::connections::systemBus->async_method_call( |
| 985 | [asyncResp](const boost::system::error_code ec, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 986 | const std::vector<std::string>& subtreePath) { |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 987 | if (ec) |
| 988 | { |
| 989 | BMCWEB_LOG_ERROR << ec; |
| 990 | return; |
| 991 | } |
| 992 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 993 | for (auto& pathStr : subtreePath) |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 994 | { |
| 995 | if (pathStr.find("PostCode") != std::string::npos) |
| 996 | { |
Ed Tanous | 23a21a1 | 2020-07-25 04:45:05 +0000 | [diff] [blame] | 997 | nlohmann::json& logServiceArrayLocal = |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 998 | asyncResp->res.jsonValue["Members"]; |
Ed Tanous | 23a21a1 | 2020-07-25 04:45:05 +0000 | [diff] [blame] | 999 | logServiceArrayLocal.push_back( |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 1000 | {{"@odata.id", "/redfish/v1/Systems/system/" |
| 1001 | "LogServices/PostCodes"}}); |
| 1002 | asyncResp->res.jsonValue["Members@odata.count"] = |
Ed Tanous | 23a21a1 | 2020-07-25 04:45:05 +0000 | [diff] [blame] | 1003 | logServiceArrayLocal.size(); |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 1004 | return; |
| 1005 | } |
| 1006 | } |
| 1007 | }, |
| 1008 | "xyz.openbmc_project.ObjectMapper", |
| 1009 | "/xyz/openbmc_project/object_mapper", |
| 1010 | "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "/", 0, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1011 | std::array<const char*, 1>{postCodeIface}); |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1012 | } |
| 1013 | }; |
| 1014 | |
| 1015 | class EventLogService : public Node |
| 1016 | { |
| 1017 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 1018 | EventLogService(App& app) : |
Ed Tanous | 029573d | 2019-02-01 10:57:49 -0800 | [diff] [blame] | 1019 | Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/") |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1020 | { |
| 1021 | entityPrivileges = { |
| 1022 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 1023 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 1024 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 1025 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 1026 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 1027 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 1028 | } |
| 1029 | |
| 1030 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 1031 | void doGet(crow::Response& res, const crow::Request&, |
| 1032 | const std::vector<std::string>&) override |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1033 | { |
| 1034 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 1035 | |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1036 | asyncResp->res.jsonValue["@odata.id"] = |
Ed Tanous | 029573d | 2019-02-01 10:57:49 -0800 | [diff] [blame] | 1037 | "/redfish/v1/Systems/system/LogServices/EventLog"; |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1038 | asyncResp->res.jsonValue["@odata.type"] = |
| 1039 | "#LogService.v1_1_0.LogService"; |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1040 | asyncResp->res.jsonValue["Name"] = "Event Log Service"; |
| 1041 | asyncResp->res.jsonValue["Description"] = "System Event Log Service"; |
Gunnar Mills | 73ec830 | 2020-04-14 16:02:42 -0500 | [diff] [blame] | 1042 | asyncResp->res.jsonValue["Id"] = "EventLog"; |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1043 | asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; |
| 1044 | asyncResp->res.jsonValue["Entries"] = { |
| 1045 | {"@odata.id", |
Ed Tanous | 029573d | 2019-02-01 10:57:49 -0800 | [diff] [blame] | 1046 | "/redfish/v1/Systems/system/LogServices/EventLog/Entries"}}; |
Gunnar Mills | e7d6c8b | 2019-07-03 11:30:01 -0500 | [diff] [blame] | 1047 | asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { |
| 1048 | |
| 1049 | {"target", "/redfish/v1/Systems/system/LogServices/EventLog/" |
| 1050 | "Actions/LogService.ClearLog"}}; |
Jason M. Bills | 489640c | 2019-05-17 09:56:36 -0700 | [diff] [blame] | 1051 | } |
| 1052 | }; |
| 1053 | |
Tim Lee | 1f56a3a | 2019-10-09 10:17:57 +0800 | [diff] [blame] | 1054 | class JournalEventLogClear : public Node |
Jason M. Bills | 489640c | 2019-05-17 09:56:36 -0700 | [diff] [blame] | 1055 | { |
| 1056 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 1057 | JournalEventLogClear(App& app) : |
Jason M. Bills | 489640c | 2019-05-17 09:56:36 -0700 | [diff] [blame] | 1058 | Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/" |
| 1059 | "LogService.ClearLog/") |
| 1060 | { |
| 1061 | entityPrivileges = { |
| 1062 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 1063 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 1064 | {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, |
| 1065 | {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, |
| 1066 | {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, |
| 1067 | {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; |
| 1068 | } |
| 1069 | |
| 1070 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 1071 | void doPost(crow::Response& res, const crow::Request&, |
| 1072 | const std::vector<std::string>&) override |
Jason M. Bills | 489640c | 2019-05-17 09:56:36 -0700 | [diff] [blame] | 1073 | { |
| 1074 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 1075 | |
| 1076 | // Clear the EventLog by deleting the log files |
| 1077 | std::vector<std::filesystem::path> redfishLogFiles; |
| 1078 | if (getRedfishLogFiles(redfishLogFiles)) |
| 1079 | { |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1080 | for (const std::filesystem::path& file : redfishLogFiles) |
Jason M. Bills | 489640c | 2019-05-17 09:56:36 -0700 | [diff] [blame] | 1081 | { |
| 1082 | std::error_code ec; |
| 1083 | std::filesystem::remove(file, ec); |
| 1084 | } |
| 1085 | } |
| 1086 | |
| 1087 | // Reload rsyslog so it knows to start new log files |
| 1088 | crow::connections::systemBus->async_method_call( |
| 1089 | [asyncResp](const boost::system::error_code ec) { |
| 1090 | if (ec) |
| 1091 | { |
| 1092 | BMCWEB_LOG_ERROR << "Failed to reload rsyslog: " << ec; |
| 1093 | messages::internalError(asyncResp->res); |
| 1094 | return; |
| 1095 | } |
| 1096 | |
| 1097 | messages::success(asyncResp->res); |
| 1098 | }, |
| 1099 | "org.freedesktop.systemd1", "/org/freedesktop/systemd1", |
| 1100 | "org.freedesktop.systemd1.Manager", "ReloadUnit", "rsyslog.service", |
| 1101 | "replace"); |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1102 | } |
| 1103 | }; |
| 1104 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1105 | static int fillEventLogEntryJson(const std::string& logEntryID, |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1106 | const std::string logEntry, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1107 | nlohmann::json& logEntryJson) |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1108 | { |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1109 | // The redfish log format is "<Timestamp> <MessageId>,<MessageArgs>" |
Jason M. Bills | cd225da | 2019-05-08 15:31:57 -0700 | [diff] [blame] | 1110 | // First get the Timestamp |
| 1111 | size_t space = logEntry.find_first_of(" "); |
| 1112 | if (space == std::string::npos) |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1113 | { |
| 1114 | return 1; |
| 1115 | } |
Jason M. Bills | cd225da | 2019-05-08 15:31:57 -0700 | [diff] [blame] | 1116 | std::string timestamp = logEntry.substr(0, space); |
| 1117 | // Then get the log contents |
| 1118 | size_t entryStart = logEntry.find_first_not_of(" ", space); |
| 1119 | if (entryStart == std::string::npos) |
| 1120 | { |
| 1121 | return 1; |
| 1122 | } |
| 1123 | std::string_view entry(logEntry); |
| 1124 | entry.remove_prefix(entryStart); |
| 1125 | // Use split to separate the entry into its fields |
| 1126 | std::vector<std::string> logEntryFields; |
| 1127 | boost::split(logEntryFields, entry, boost::is_any_of(","), |
| 1128 | boost::token_compress_on); |
| 1129 | // We need at least a MessageId to be valid |
| 1130 | if (logEntryFields.size() < 1) |
| 1131 | { |
| 1132 | return 1; |
| 1133 | } |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1134 | std::string& messageID = logEntryFields[0]; |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1135 | |
Jason M. Bills | 4851d45 | 2019-03-28 11:27:48 -0700 | [diff] [blame] | 1136 | // Get the Message from the MessageRegistry |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1137 | const message_registries::Message* message = |
Jason M. Bills | 4851d45 | 2019-03-28 11:27:48 -0700 | [diff] [blame] | 1138 | message_registries::getMessage(messageID); |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1139 | |
Jason M. Bills | 4851d45 | 2019-03-28 11:27:48 -0700 | [diff] [blame] | 1140 | std::string msg; |
| 1141 | std::string severity; |
| 1142 | if (message != nullptr) |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1143 | { |
Jason M. Bills | 4851d45 | 2019-03-28 11:27:48 -0700 | [diff] [blame] | 1144 | msg = message->message; |
| 1145 | severity = message->severity; |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1146 | } |
| 1147 | |
Jason M. Bills | 15a86ff | 2019-06-18 13:49:54 -0700 | [diff] [blame] | 1148 | // Get the MessageArgs from the log if there are any |
| 1149 | boost::beast::span<std::string> messageArgs; |
| 1150 | if (logEntryFields.size() > 1) |
Jason M. Bills | 4851d45 | 2019-03-28 11:27:48 -0700 | [diff] [blame] | 1151 | { |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1152 | std::string& messageArgsStart = logEntryFields[1]; |
Jason M. Bills | 15a86ff | 2019-06-18 13:49:54 -0700 | [diff] [blame] | 1153 | // If the first string is empty, assume there are no MessageArgs |
| 1154 | std::size_t messageArgsSize = 0; |
| 1155 | if (!messageArgsStart.empty()) |
Jason M. Bills | 4851d45 | 2019-03-28 11:27:48 -0700 | [diff] [blame] | 1156 | { |
Jason M. Bills | 15a86ff | 2019-06-18 13:49:54 -0700 | [diff] [blame] | 1157 | messageArgsSize = logEntryFields.size() - 1; |
| 1158 | } |
| 1159 | |
Ed Tanous | 23a21a1 | 2020-07-25 04:45:05 +0000 | [diff] [blame] | 1160 | messageArgs = {&messageArgsStart, messageArgsSize}; |
Jason M. Bills | 15a86ff | 2019-06-18 13:49:54 -0700 | [diff] [blame] | 1161 | |
| 1162 | // Fill the MessageArgs into the Message |
| 1163 | int i = 0; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1164 | for (const std::string& messageArg : messageArgs) |
Jason M. Bills | 15a86ff | 2019-06-18 13:49:54 -0700 | [diff] [blame] | 1165 | { |
| 1166 | std::string argStr = "%" + std::to_string(++i); |
| 1167 | size_t argPos = msg.find(argStr); |
| 1168 | if (argPos != std::string::npos) |
| 1169 | { |
| 1170 | msg.replace(argPos, argStr.length(), messageArg); |
| 1171 | } |
Jason M. Bills | 4851d45 | 2019-03-28 11:27:48 -0700 | [diff] [blame] | 1172 | } |
| 1173 | } |
| 1174 | |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1175 | // Get the Created time from the timestamp. The log timestamp is in RFC3339 |
| 1176 | // format which matches the Redfish format except for the fractional seconds |
| 1177 | // between the '.' and the '+', so just remove them. |
| 1178 | std::size_t dot = timestamp.find_first_of("."); |
| 1179 | std::size_t plus = timestamp.find_first_of("+"); |
| 1180 | if (dot != std::string::npos && plus != std::string::npos) |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1181 | { |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1182 | timestamp.erase(dot, plus - dot); |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1183 | } |
| 1184 | |
| 1185 | // Fill in the log entry with the gathered data |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1186 | logEntryJson = { |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1187 | {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, |
Ed Tanous | 029573d | 2019-02-01 10:57:49 -0800 | [diff] [blame] | 1188 | {"@odata.id", |
Jason M. Bills | 897967d | 2019-07-29 17:05:30 -0700 | [diff] [blame] | 1189 | "/redfish/v1/Systems/system/LogServices/EventLog/Entries/" + |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1190 | logEntryID}, |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1191 | {"Name", "System Event Log Entry"}, |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1192 | {"Id", logEntryID}, |
| 1193 | {"Message", std::move(msg)}, |
| 1194 | {"MessageId", std::move(messageID)}, |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1195 | {"MessageArgs", std::move(messageArgs)}, |
| 1196 | {"EntryType", "Event"}, |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1197 | {"Severity", std::move(severity)}, |
| 1198 | {"Created", std::move(timestamp)}}; |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1199 | return 0; |
| 1200 | } |
| 1201 | |
Anthony Wilson | 2706260 | 2019-04-22 02:10:09 -0500 | [diff] [blame] | 1202 | class JournalEventLogEntryCollection : public Node |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1203 | { |
| 1204 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 1205 | JournalEventLogEntryCollection(App& app) : |
Ed Tanous | 029573d | 2019-02-01 10:57:49 -0800 | [diff] [blame] | 1206 | Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1207 | { |
| 1208 | entityPrivileges = { |
| 1209 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 1210 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 1211 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 1212 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 1213 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 1214 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 1215 | } |
| 1216 | |
| 1217 | private: |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1218 | void doGet(crow::Response& res, const crow::Request& req, |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 1219 | const std::vector<std::string>&) override |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1220 | { |
| 1221 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 1222 | uint64_t skip = 0; |
| 1223 | uint64_t top = maxEntriesPerPage; // Show max entries by default |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1224 | if (!getSkipParam(asyncResp->res, req, skip)) |
| 1225 | { |
| 1226 | return; |
| 1227 | } |
| 1228 | if (!getTopParam(asyncResp->res, req, top)) |
| 1229 | { |
| 1230 | return; |
| 1231 | } |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1232 | // Collections don't include the static data added by SubRoute because |
| 1233 | // it has a duplicate entry for members |
| 1234 | asyncResp->res.jsonValue["@odata.type"] = |
| 1235 | "#LogEntryCollection.LogEntryCollection"; |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1236 | asyncResp->res.jsonValue["@odata.id"] = |
Ed Tanous | 029573d | 2019-02-01 10:57:49 -0800 | [diff] [blame] | 1237 | "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1238 | asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; |
| 1239 | asyncResp->res.jsonValue["Description"] = |
| 1240 | "Collection of System Event Log Entries"; |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1241 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1242 | nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1243 | logEntryArray = nlohmann::json::array(); |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1244 | // Go through the log files and create a unique ID for each entry |
| 1245 | std::vector<std::filesystem::path> redfishLogFiles; |
| 1246 | getRedfishLogFiles(redfishLogFiles); |
Ed Tanous | b01bf29 | 2019-03-25 19:25:26 +0000 | [diff] [blame] | 1247 | uint64_t entryCount = 0; |
Jason M. Bills | cd225da | 2019-05-08 15:31:57 -0700 | [diff] [blame] | 1248 | std::string logEntry; |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1249 | |
| 1250 | // Oldest logs are in the last file, so start there and loop backwards |
Jason M. Bills | cd225da | 2019-05-08 15:31:57 -0700 | [diff] [blame] | 1251 | for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); |
| 1252 | it++) |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1253 | { |
Jason M. Bills | cd225da | 2019-05-08 15:31:57 -0700 | [diff] [blame] | 1254 | std::ifstream logStream(*it); |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1255 | if (!logStream.is_open()) |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1256 | { |
| 1257 | continue; |
| 1258 | } |
| 1259 | |
Jason M. Bills | e85d6b1 | 2019-07-29 17:01:15 -0700 | [diff] [blame] | 1260 | // Reset the unique ID on the first entry |
| 1261 | bool firstEntry = true; |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1262 | while (std::getline(logStream, logEntry)) |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1263 | { |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1264 | entryCount++; |
| 1265 | // Handle paging using skip (number of entries to skip from the |
| 1266 | // start) and top (number of entries to display) |
| 1267 | if (entryCount <= skip || entryCount > skip + top) |
| 1268 | { |
| 1269 | continue; |
| 1270 | } |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1271 | |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1272 | std::string idStr; |
Jason M. Bills | e85d6b1 | 2019-07-29 17:01:15 -0700 | [diff] [blame] | 1273 | if (!getUniqueEntryID(logEntry, idStr, firstEntry)) |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1274 | { |
| 1275 | continue; |
| 1276 | } |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1277 | |
Jason M. Bills | e85d6b1 | 2019-07-29 17:01:15 -0700 | [diff] [blame] | 1278 | if (firstEntry) |
| 1279 | { |
| 1280 | firstEntry = false; |
| 1281 | } |
| 1282 | |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1283 | logEntryArray.push_back({}); |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1284 | nlohmann::json& bmcLogEntry = logEntryArray.back(); |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1285 | if (fillEventLogEntryJson(idStr, logEntry, bmcLogEntry) != 0) |
| 1286 | { |
| 1287 | messages::internalError(asyncResp->res); |
| 1288 | return; |
| 1289 | } |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1290 | } |
| 1291 | } |
| 1292 | asyncResp->res.jsonValue["Members@odata.count"] = entryCount; |
| 1293 | if (skip + top < entryCount) |
| 1294 | { |
| 1295 | asyncResp->res.jsonValue["Members@odata.nextLink"] = |
Jason M. Bills | 9582018 | 2019-04-22 16:25:34 -0700 | [diff] [blame] | 1296 | "/redfish/v1/Systems/system/LogServices/EventLog/" |
| 1297 | "Entries?$skip=" + |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1298 | std::to_string(skip + top); |
| 1299 | } |
Anthony Wilson | 08a4e4b | 2019-04-12 08:23:05 -0500 | [diff] [blame] | 1300 | } |
| 1301 | }; |
| 1302 | |
Jason M. Bills | 897967d | 2019-07-29 17:05:30 -0700 | [diff] [blame] | 1303 | class JournalEventLogEntry : public Node |
| 1304 | { |
| 1305 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 1306 | JournalEventLogEntry(App& app) : |
Jason M. Bills | 897967d | 2019-07-29 17:05:30 -0700 | [diff] [blame] | 1307 | Node(app, |
| 1308 | "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/", |
| 1309 | std::string()) |
| 1310 | { |
| 1311 | entityPrivileges = { |
| 1312 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 1313 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 1314 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 1315 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 1316 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 1317 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 1318 | } |
| 1319 | |
| 1320 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 1321 | void doGet(crow::Response& res, const crow::Request&, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1322 | const std::vector<std::string>& params) override |
Jason M. Bills | 897967d | 2019-07-29 17:05:30 -0700 | [diff] [blame] | 1323 | { |
| 1324 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 1325 | if (params.size() != 1) |
| 1326 | { |
| 1327 | messages::internalError(asyncResp->res); |
| 1328 | return; |
| 1329 | } |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1330 | const std::string& targetID = params[0]; |
Jason M. Bills | 897967d | 2019-07-29 17:05:30 -0700 | [diff] [blame] | 1331 | |
| 1332 | // Go through the log files and check the unique ID for each entry to |
| 1333 | // find the target entry |
| 1334 | std::vector<std::filesystem::path> redfishLogFiles; |
| 1335 | getRedfishLogFiles(redfishLogFiles); |
| 1336 | std::string logEntry; |
| 1337 | |
| 1338 | // Oldest logs are in the last file, so start there and loop backwards |
| 1339 | for (auto it = redfishLogFiles.rbegin(); it < redfishLogFiles.rend(); |
| 1340 | it++) |
| 1341 | { |
| 1342 | std::ifstream logStream(*it); |
| 1343 | if (!logStream.is_open()) |
| 1344 | { |
| 1345 | continue; |
| 1346 | } |
| 1347 | |
| 1348 | // Reset the unique ID on the first entry |
| 1349 | bool firstEntry = true; |
| 1350 | while (std::getline(logStream, logEntry)) |
| 1351 | { |
| 1352 | std::string idStr; |
| 1353 | if (!getUniqueEntryID(logEntry, idStr, firstEntry)) |
| 1354 | { |
| 1355 | continue; |
| 1356 | } |
| 1357 | |
| 1358 | if (firstEntry) |
| 1359 | { |
| 1360 | firstEntry = false; |
| 1361 | } |
| 1362 | |
| 1363 | if (idStr == targetID) |
| 1364 | { |
| 1365 | if (fillEventLogEntryJson(idStr, logEntry, |
| 1366 | asyncResp->res.jsonValue) != 0) |
| 1367 | { |
| 1368 | messages::internalError(asyncResp->res); |
| 1369 | return; |
| 1370 | } |
| 1371 | return; |
| 1372 | } |
| 1373 | } |
| 1374 | } |
| 1375 | // Requested ID was not found |
| 1376 | messages::resourceMissingAtURI(asyncResp->res, targetID); |
| 1377 | } |
| 1378 | }; |
| 1379 | |
Anthony Wilson | 08a4e4b | 2019-04-12 08:23:05 -0500 | [diff] [blame] | 1380 | class DBusEventLogEntryCollection : public Node |
| 1381 | { |
| 1382 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 1383 | DBusEventLogEntryCollection(App& app) : |
Anthony Wilson | 08a4e4b | 2019-04-12 08:23:05 -0500 | [diff] [blame] | 1384 | Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Entries/") |
| 1385 | { |
| 1386 | entityPrivileges = { |
| 1387 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 1388 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 1389 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 1390 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 1391 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 1392 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 1393 | } |
| 1394 | |
| 1395 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 1396 | void doGet(crow::Response& res, const crow::Request&, |
| 1397 | const std::vector<std::string>&) override |
Anthony Wilson | 08a4e4b | 2019-04-12 08:23:05 -0500 | [diff] [blame] | 1398 | { |
| 1399 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 1400 | |
| 1401 | // Collections don't include the static data added by SubRoute because |
| 1402 | // it has a duplicate entry for members |
| 1403 | asyncResp->res.jsonValue["@odata.type"] = |
| 1404 | "#LogEntryCollection.LogEntryCollection"; |
Anthony Wilson | 08a4e4b | 2019-04-12 08:23:05 -0500 | [diff] [blame] | 1405 | asyncResp->res.jsonValue["@odata.id"] = |
| 1406 | "/redfish/v1/Systems/system/LogServices/EventLog/Entries"; |
| 1407 | asyncResp->res.jsonValue["Name"] = "System Event Log Entries"; |
| 1408 | asyncResp->res.jsonValue["Description"] = |
| 1409 | "Collection of System Event Log Entries"; |
| 1410 | |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1411 | // DBus implementation of EventLog/Entries |
| 1412 | // Make call to Logging Service to find all log entry objects |
| 1413 | crow::connections::systemBus->async_method_call( |
| 1414 | [asyncResp](const boost::system::error_code ec, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1415 | GetManagedObjectsType& resp) { |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1416 | if (ec) |
| 1417 | { |
| 1418 | // TODO Handle for specific error code |
| 1419 | BMCWEB_LOG_ERROR |
| 1420 | << "getLogEntriesIfaceData resp_handler got error " |
| 1421 | << ec; |
| 1422 | messages::internalError(asyncResp->res); |
| 1423 | return; |
| 1424 | } |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1425 | nlohmann::json& entriesArray = |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1426 | asyncResp->res.jsonValue["Members"]; |
| 1427 | entriesArray = nlohmann::json::array(); |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1428 | for (auto& objectPath : resp) |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1429 | { |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1430 | for (auto& interfaceMap : objectPath.second) |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1431 | { |
| 1432 | if (interfaceMap.first != |
| 1433 | "xyz.openbmc_project.Logging.Entry") |
| 1434 | { |
| 1435 | BMCWEB_LOG_DEBUG << "Bailing early on " |
| 1436 | << interfaceMap.first; |
| 1437 | continue; |
| 1438 | } |
| 1439 | entriesArray.push_back({}); |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1440 | nlohmann::json& thisEntry = entriesArray.back(); |
| 1441 | uint32_t* id = nullptr; |
Ed Tanous | 66664f2 | 2019-10-11 13:05:49 -0700 | [diff] [blame] | 1442 | std::time_t timestamp{}; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1443 | std::string* severity = nullptr; |
| 1444 | std::string* message = nullptr; |
| 1445 | for (auto& propertyMap : interfaceMap.second) |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1446 | { |
| 1447 | if (propertyMap.first == "Id") |
| 1448 | { |
Patrick Williams | 8d78b7a | 2020-05-13 11:24:20 -0500 | [diff] [blame] | 1449 | id = std::get_if<uint32_t>(&propertyMap.second); |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1450 | if (id == nullptr) |
| 1451 | { |
Asmitha Karunanithi | 0f1d8ed | 2020-08-02 11:11:47 -0500 | [diff] [blame] | 1452 | messages::internalError(asyncResp->res); |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1453 | } |
| 1454 | } |
| 1455 | else if (propertyMap.first == "Timestamp") |
| 1456 | { |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1457 | const uint64_t* millisTimeStamp = |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1458 | std::get_if<uint64_t>(&propertyMap.second); |
| 1459 | if (millisTimeStamp == nullptr) |
| 1460 | { |
Asmitha Karunanithi | 0f1d8ed | 2020-08-02 11:11:47 -0500 | [diff] [blame] | 1461 | messages::internalError(asyncResp->res); |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 1462 | continue; |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1463 | } |
| 1464 | // Retrieve Created property with format: |
| 1465 | // yyyy-mm-ddThh:mm:ss |
| 1466 | std::chrono::milliseconds chronoTimeStamp( |
| 1467 | *millisTimeStamp); |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 1468 | timestamp = std::chrono::duration_cast< |
| 1469 | std::chrono::duration<int>>( |
| 1470 | chronoTimeStamp) |
| 1471 | .count(); |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1472 | } |
| 1473 | else if (propertyMap.first == "Severity") |
| 1474 | { |
| 1475 | severity = std::get_if<std::string>( |
| 1476 | &propertyMap.second); |
| 1477 | if (severity == nullptr) |
| 1478 | { |
Asmitha Karunanithi | 0f1d8ed | 2020-08-02 11:11:47 -0500 | [diff] [blame] | 1479 | messages::internalError(asyncResp->res); |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1480 | } |
| 1481 | } |
| 1482 | else if (propertyMap.first == "Message") |
| 1483 | { |
| 1484 | message = std::get_if<std::string>( |
| 1485 | &propertyMap.second); |
| 1486 | if (message == nullptr) |
| 1487 | { |
Asmitha Karunanithi | 0f1d8ed | 2020-08-02 11:11:47 -0500 | [diff] [blame] | 1488 | messages::internalError(asyncResp->res); |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1489 | } |
| 1490 | } |
| 1491 | } |
| 1492 | thisEntry = { |
| 1493 | {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1494 | {"@odata.id", |
| 1495 | "/redfish/v1/Systems/system/LogServices/EventLog/" |
| 1496 | "Entries/" + |
| 1497 | std::to_string(*id)}, |
Anthony Wilson | 2706260 | 2019-04-22 02:10:09 -0500 | [diff] [blame] | 1498 | {"Name", "System Event Log Entry"}, |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1499 | {"Id", std::to_string(*id)}, |
| 1500 | {"Message", *message}, |
| 1501 | {"EntryType", "Event"}, |
| 1502 | {"Severity", |
| 1503 | translateSeverityDbusToRedfish(*severity)}, |
| 1504 | {"Created", crow::utility::getDateTime(timestamp)}}; |
| 1505 | } |
| 1506 | } |
| 1507 | std::sort(entriesArray.begin(), entriesArray.end(), |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1508 | [](const nlohmann::json& left, |
| 1509 | const nlohmann::json& right) { |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1510 | return (left["Id"] <= right["Id"]); |
| 1511 | }); |
| 1512 | asyncResp->res.jsonValue["Members@odata.count"] = |
| 1513 | entriesArray.size(); |
| 1514 | }, |
| 1515 | "xyz.openbmc_project.Logging", "/xyz/openbmc_project/logging", |
| 1516 | "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1517 | } |
| 1518 | }; |
| 1519 | |
Anthony Wilson | 08a4e4b | 2019-04-12 08:23:05 -0500 | [diff] [blame] | 1520 | class DBusEventLogEntry : public Node |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1521 | { |
| 1522 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 1523 | DBusEventLogEntry(App& app) : |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1524 | Node(app, |
Ed Tanous | 029573d | 2019-02-01 10:57:49 -0800 | [diff] [blame] | 1525 | "/redfish/v1/Systems/system/LogServices/EventLog/Entries/<str>/", |
| 1526 | std::string()) |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1527 | { |
| 1528 | entityPrivileges = { |
| 1529 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 1530 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 1531 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 1532 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 1533 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 1534 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 1535 | } |
| 1536 | |
| 1537 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 1538 | void doGet(crow::Response& res, const crow::Request&, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1539 | const std::vector<std::string>& params) override |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1540 | { |
| 1541 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
Ed Tanous | 029573d | 2019-02-01 10:57:49 -0800 | [diff] [blame] | 1542 | if (params.size() != 1) |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1543 | { |
| 1544 | messages::internalError(asyncResp->res); |
| 1545 | return; |
| 1546 | } |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1547 | const std::string& entryID = params[0]; |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1548 | |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1549 | // DBus implementation of EventLog/Entries |
| 1550 | // Make call to Logging Service to find all log entry objects |
| 1551 | crow::connections::systemBus->async_method_call( |
| 1552 | [asyncResp, entryID](const boost::system::error_code ec, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1553 | GetManagedPropertyType& resp) { |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1554 | if (ec) |
| 1555 | { |
| 1556 | BMCWEB_LOG_ERROR |
| 1557 | << "EventLogEntry (DBus) resp_handler got error " << ec; |
| 1558 | messages::internalError(asyncResp->res); |
| 1559 | return; |
| 1560 | } |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1561 | uint32_t* id = nullptr; |
Ed Tanous | 66664f2 | 2019-10-11 13:05:49 -0700 | [diff] [blame] | 1562 | std::time_t timestamp{}; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1563 | std::string* severity = nullptr; |
| 1564 | std::string* message = nullptr; |
| 1565 | for (auto& propertyMap : resp) |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1566 | { |
| 1567 | if (propertyMap.first == "Id") |
| 1568 | { |
| 1569 | id = std::get_if<uint32_t>(&propertyMap.second); |
| 1570 | if (id == nullptr) |
| 1571 | { |
Asmitha Karunanithi | 0f1d8ed | 2020-08-02 11:11:47 -0500 | [diff] [blame] | 1572 | messages::internalError(asyncResp->res); |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1573 | } |
| 1574 | } |
| 1575 | else if (propertyMap.first == "Timestamp") |
| 1576 | { |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1577 | const uint64_t* millisTimeStamp = |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1578 | std::get_if<uint64_t>(&propertyMap.second); |
| 1579 | if (millisTimeStamp == nullptr) |
| 1580 | { |
Asmitha Karunanithi | 0f1d8ed | 2020-08-02 11:11:47 -0500 | [diff] [blame] | 1581 | messages::internalError(asyncResp->res); |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 1582 | continue; |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1583 | } |
| 1584 | // Retrieve Created property with format: |
| 1585 | // yyyy-mm-ddThh:mm:ss |
| 1586 | std::chrono::milliseconds chronoTimeStamp( |
| 1587 | *millisTimeStamp); |
| 1588 | timestamp = |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 1589 | std::chrono::duration_cast< |
| 1590 | std::chrono::duration<int>>(chronoTimeStamp) |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1591 | .count(); |
| 1592 | } |
| 1593 | else if (propertyMap.first == "Severity") |
| 1594 | { |
| 1595 | severity = |
| 1596 | std::get_if<std::string>(&propertyMap.second); |
| 1597 | if (severity == nullptr) |
| 1598 | { |
Asmitha Karunanithi | 0f1d8ed | 2020-08-02 11:11:47 -0500 | [diff] [blame] | 1599 | messages::internalError(asyncResp->res); |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1600 | } |
| 1601 | } |
| 1602 | else if (propertyMap.first == "Message") |
| 1603 | { |
| 1604 | message = std::get_if<std::string>(&propertyMap.second); |
| 1605 | if (message == nullptr) |
| 1606 | { |
Asmitha Karunanithi | 0f1d8ed | 2020-08-02 11:11:47 -0500 | [diff] [blame] | 1607 | messages::internalError(asyncResp->res); |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1608 | } |
| 1609 | } |
| 1610 | } |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 1611 | if (id == nullptr || message == nullptr || severity == nullptr) |
| 1612 | { |
| 1613 | return; |
| 1614 | } |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1615 | asyncResp->res.jsonValue = { |
| 1616 | {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1617 | {"@odata.id", |
| 1618 | "/redfish/v1/Systems/system/LogServices/EventLog/" |
| 1619 | "Entries/" + |
| 1620 | std::to_string(*id)}, |
Anthony Wilson | 2706260 | 2019-04-22 02:10:09 -0500 | [diff] [blame] | 1621 | {"Name", "System Event Log Entry"}, |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1622 | {"Id", std::to_string(*id)}, |
| 1623 | {"Message", *message}, |
| 1624 | {"EntryType", "Event"}, |
| 1625 | {"Severity", translateSeverityDbusToRedfish(*severity)}, |
Anthony Wilson | 08a4e4b | 2019-04-12 08:23:05 -0500 | [diff] [blame] | 1626 | {"Created", crow::utility::getDateTime(timestamp)}}; |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1627 | }, |
| 1628 | "xyz.openbmc_project.Logging", |
| 1629 | "/xyz/openbmc_project/logging/entry/" + entryID, |
| 1630 | "org.freedesktop.DBus.Properties", "GetAll", |
| 1631 | "xyz.openbmc_project.Logging.Entry"); |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1632 | } |
Chicago Duan | 336e96c | 2019-07-15 14:22:08 +0800 | [diff] [blame] | 1633 | |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 1634 | void doDelete(crow::Response& res, const crow::Request&, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1635 | const std::vector<std::string>& params) override |
Chicago Duan | 336e96c | 2019-07-15 14:22:08 +0800 | [diff] [blame] | 1636 | { |
| 1637 | |
| 1638 | BMCWEB_LOG_DEBUG << "Do delete single event entries."; |
| 1639 | |
| 1640 | auto asyncResp = std::make_shared<AsyncResp>(res); |
| 1641 | |
| 1642 | if (params.size() != 1) |
| 1643 | { |
| 1644 | messages::internalError(asyncResp->res); |
| 1645 | return; |
| 1646 | } |
| 1647 | std::string entryID = params[0]; |
| 1648 | |
| 1649 | dbus::utility::escapePathForDbus(entryID); |
| 1650 | |
| 1651 | // Process response from Logging service. |
| 1652 | auto respHandler = [asyncResp](const boost::system::error_code ec) { |
| 1653 | BMCWEB_LOG_DEBUG << "EventLogEntry (DBus) doDelete callback: Done"; |
| 1654 | if (ec) |
| 1655 | { |
| 1656 | // TODO Handle for specific error code |
| 1657 | BMCWEB_LOG_ERROR |
| 1658 | << "EventLogEntry (DBus) doDelete respHandler got error " |
| 1659 | << ec; |
| 1660 | asyncResp->res.result( |
| 1661 | boost::beast::http::status::internal_server_error); |
| 1662 | return; |
| 1663 | } |
| 1664 | |
| 1665 | asyncResp->res.result(boost::beast::http::status::ok); |
| 1666 | }; |
| 1667 | |
| 1668 | // Make call to Logging service to request Delete Log |
| 1669 | crow::connections::systemBus->async_method_call( |
| 1670 | respHandler, "xyz.openbmc_project.Logging", |
| 1671 | "/xyz/openbmc_project/logging/entry/" + entryID, |
| 1672 | "xyz.openbmc_project.Object.Delete", "Delete"); |
| 1673 | } |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1674 | }; |
| 1675 | |
| 1676 | class BMCLogServiceCollection : public Node |
| 1677 | { |
| 1678 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 1679 | BMCLogServiceCollection(App& app) : |
Ed Tanous | 4ed77cd | 2018-10-15 08:08:07 -0700 | [diff] [blame] | 1680 | Node(app, "/redfish/v1/Managers/bmc/LogServices/") |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 1681 | { |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 1682 | entityPrivileges = { |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1683 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 1684 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 1685 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 1686 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 1687 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 1688 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 1689 | } |
| 1690 | |
| 1691 | private: |
| 1692 | /** |
| 1693 | * Functions triggers appropriate requests on DBus |
| 1694 | */ |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 1695 | void doGet(crow::Response& res, const crow::Request&, |
| 1696 | const std::vector<std::string>&) override |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 1697 | { |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1698 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 1699 | // Collections don't include the static data added by SubRoute because |
| 1700 | // it has a duplicate entry for members |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1701 | asyncResp->res.jsonValue["@odata.type"] = |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 1702 | "#LogServiceCollection.LogServiceCollection"; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1703 | asyncResp->res.jsonValue["@odata.id"] = |
| 1704 | "/redfish/v1/Managers/bmc/LogServices"; |
| 1705 | asyncResp->res.jsonValue["Name"] = "Open BMC Log Services Collection"; |
| 1706 | asyncResp->res.jsonValue["Description"] = |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 1707 | "Collection of LogServices for this Manager"; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1708 | nlohmann::json& logServiceArray = asyncResp->res.jsonValue["Members"]; |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1709 | logServiceArray = nlohmann::json::array(); |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 1710 | #ifdef BMCWEB_ENABLE_REDFISH_DUMP_LOG |
| 1711 | logServiceArray.push_back( |
| 1712 | {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump"}}); |
| 1713 | #endif |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1714 | #ifdef BMCWEB_ENABLE_REDFISH_BMC_JOURNAL |
| 1715 | logServiceArray.push_back( |
Anthony Wilson | 08a4e4b | 2019-04-12 08:23:05 -0500 | [diff] [blame] | 1716 | {{"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal"}}); |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1717 | #endif |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1718 | asyncResp->res.jsonValue["Members@odata.count"] = |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1719 | logServiceArray.size(); |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 1720 | } |
| 1721 | }; |
| 1722 | |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1723 | class BMCJournalLogService : public Node |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 1724 | { |
| 1725 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 1726 | BMCJournalLogService(App& app) : |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1727 | Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/") |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1728 | { |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1729 | entityPrivileges = { |
| 1730 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 1731 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 1732 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 1733 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 1734 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 1735 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 1736 | } |
| 1737 | |
| 1738 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 1739 | void doGet(crow::Response& res, const crow::Request&, |
| 1740 | const std::vector<std::string>&) override |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1741 | { |
| 1742 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1743 | asyncResp->res.jsonValue["@odata.type"] = |
| 1744 | "#LogService.v1_1_0.LogService"; |
Ed Tanous | 0f74e64 | 2018-11-12 15:17:05 -0800 | [diff] [blame] | 1745 | asyncResp->res.jsonValue["@odata.id"] = |
| 1746 | "/redfish/v1/Managers/bmc/LogServices/Journal"; |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1747 | asyncResp->res.jsonValue["Name"] = "Open BMC Journal Log Service"; |
| 1748 | asyncResp->res.jsonValue["Description"] = "BMC Journal Log Service"; |
| 1749 | asyncResp->res.jsonValue["Id"] = "BMC Journal"; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1750 | asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; |
Jason M. Bills | cd50aa4 | 2019-02-12 17:09:02 -0800 | [diff] [blame] | 1751 | asyncResp->res.jsonValue["Entries"] = { |
| 1752 | {"@odata.id", |
Ed Tanous | 086be23 | 2019-05-23 11:47:09 -0700 | [diff] [blame] | 1753 | "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"}}; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1754 | } |
| 1755 | }; |
| 1756 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1757 | static int fillBMCJournalLogEntryJson(const std::string& bmcJournalLogEntryID, |
| 1758 | sd_journal* journal, |
| 1759 | nlohmann::json& bmcJournalLogEntryJson) |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1760 | { |
| 1761 | // Get the Log Entry contents |
| 1762 | int ret = 0; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1763 | |
Ed Tanous | 39e7750 | 2019-03-04 17:35:53 -0800 | [diff] [blame] | 1764 | std::string_view msg; |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 1765 | ret = getJournalMetadata(journal, "MESSAGE", msg); |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1766 | if (ret < 0) |
| 1767 | { |
| 1768 | BMCWEB_LOG_ERROR << "Failed to read MESSAGE field: " << strerror(-ret); |
| 1769 | return 1; |
| 1770 | } |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1771 | |
| 1772 | // Get the severity from the PRIORITY field |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 1773 | long int severity = 8; // Default to an invalid priority |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 1774 | ret = getJournalMetadata(journal, "PRIORITY", 10, severity); |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1775 | if (ret < 0) |
| 1776 | { |
| 1777 | BMCWEB_LOG_ERROR << "Failed to read PRIORITY field: " << strerror(-ret); |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1778 | } |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1779 | |
| 1780 | // Get the Created time from the timestamp |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 1781 | std::string entryTimeStr; |
| 1782 | if (!getEntryTimestamp(journal, entryTimeStr)) |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1783 | { |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 1784 | return 1; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1785 | } |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1786 | |
| 1787 | // Fill in the log entry with the gathered data |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1788 | bmcJournalLogEntryJson = { |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 1789 | {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1790 | {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/" + |
| 1791 | bmcJournalLogEntryID}, |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1792 | {"Name", "BMC Journal Entry"}, |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1793 | {"Id", bmcJournalLogEntryID}, |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 1794 | {"Message", msg}, |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1795 | {"EntryType", "Oem"}, |
| 1796 | {"Severity", |
Jason M. Bills | b6a61a5 | 2019-08-01 14:26:15 -0700 | [diff] [blame] | 1797 | severity <= 2 ? "Critical" : severity <= 4 ? "Warning" : "OK"}, |
Ed Tanous | 086be23 | 2019-05-23 11:47:09 -0700 | [diff] [blame] | 1798 | {"OemRecordFormat", "BMC Journal Entry"}, |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1799 | {"Created", std::move(entryTimeStr)}}; |
| 1800 | return 0; |
| 1801 | } |
| 1802 | |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1803 | class BMCJournalLogEntryCollection : public Node |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1804 | { |
| 1805 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 1806 | BMCJournalLogEntryCollection(App& app) : |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1807 | Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/") |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1808 | { |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1809 | entityPrivileges = { |
| 1810 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 1811 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 1812 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 1813 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 1814 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 1815 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 1816 | } |
| 1817 | |
| 1818 | private: |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1819 | void doGet(crow::Response& res, const crow::Request& req, |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 1820 | const std::vector<std::string>&) override |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1821 | { |
| 1822 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
Jason M. Bills | 193ad2f | 2018-09-26 15:08:52 -0700 | [diff] [blame] | 1823 | static constexpr const long maxEntriesPerPage = 1000; |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 1824 | uint64_t skip = 0; |
| 1825 | uint64_t top = maxEntriesPerPage; // Show max entries by default |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 1826 | if (!getSkipParam(asyncResp->res, req, skip)) |
Jason M. Bills | 193ad2f | 2018-09-26 15:08:52 -0700 | [diff] [blame] | 1827 | { |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 1828 | return; |
Jason M. Bills | 193ad2f | 2018-09-26 15:08:52 -0700 | [diff] [blame] | 1829 | } |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 1830 | if (!getTopParam(asyncResp->res, req, top)) |
Jason M. Bills | 193ad2f | 2018-09-26 15:08:52 -0700 | [diff] [blame] | 1831 | { |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 1832 | return; |
Jason M. Bills | 193ad2f | 2018-09-26 15:08:52 -0700 | [diff] [blame] | 1833 | } |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1834 | // Collections don't include the static data added by SubRoute because |
| 1835 | // it has a duplicate entry for members |
| 1836 | asyncResp->res.jsonValue["@odata.type"] = |
| 1837 | "#LogEntryCollection.LogEntryCollection"; |
Ed Tanous | 0f74e64 | 2018-11-12 15:17:05 -0800 | [diff] [blame] | 1838 | asyncResp->res.jsonValue["@odata.id"] = |
| 1839 | "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1840 | asyncResp->res.jsonValue["@odata.id"] = |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1841 | "/redfish/v1/Managers/bmc/LogServices/Journal/Entries"; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1842 | asyncResp->res.jsonValue["Name"] = "Open BMC Journal Entries"; |
| 1843 | asyncResp->res.jsonValue["Description"] = |
| 1844 | "Collection of BMC Journal Entries"; |
Ed Tanous | 0f74e64 | 2018-11-12 15:17:05 -0800 | [diff] [blame] | 1845 | asyncResp->res.jsonValue["@odata.id"] = |
| 1846 | "/redfish/v1/Managers/bmc/LogServices/BmcLog/Entries"; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1847 | nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1848 | logEntryArray = nlohmann::json::array(); |
| 1849 | |
| 1850 | // Go through the journal and use the timestamp to create a unique ID |
| 1851 | // for each entry |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1852 | sd_journal* journalTmp = nullptr; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1853 | int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); |
| 1854 | if (ret < 0) |
| 1855 | { |
| 1856 | BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); |
Jason M. Bills | f12894f | 2018-10-09 12:45:45 -0700 | [diff] [blame] | 1857 | messages::internalError(asyncResp->res); |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1858 | return; |
| 1859 | } |
| 1860 | std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( |
| 1861 | journalTmp, sd_journal_close); |
| 1862 | journalTmp = nullptr; |
Ed Tanous | b01bf29 | 2019-03-25 19:25:26 +0000 | [diff] [blame] | 1863 | uint64_t entryCount = 0; |
Jason M. Bills | e85d6b1 | 2019-07-29 17:01:15 -0700 | [diff] [blame] | 1864 | // Reset the unique ID on the first entry |
| 1865 | bool firstEntry = true; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1866 | SD_JOURNAL_FOREACH(journal.get()) |
| 1867 | { |
Jason M. Bills | 193ad2f | 2018-09-26 15:08:52 -0700 | [diff] [blame] | 1868 | entryCount++; |
| 1869 | // Handle paging using skip (number of entries to skip from the |
| 1870 | // start) and top (number of entries to display) |
| 1871 | if (entryCount <= skip || entryCount > skip + top) |
| 1872 | { |
| 1873 | continue; |
| 1874 | } |
| 1875 | |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 1876 | std::string idStr; |
Jason M. Bills | e85d6b1 | 2019-07-29 17:01:15 -0700 | [diff] [blame] | 1877 | if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1878 | { |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1879 | continue; |
| 1880 | } |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1881 | |
Jason M. Bills | e85d6b1 | 2019-07-29 17:01:15 -0700 | [diff] [blame] | 1882 | if (firstEntry) |
| 1883 | { |
| 1884 | firstEntry = false; |
| 1885 | } |
| 1886 | |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1887 | logEntryArray.push_back({}); |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1888 | nlohmann::json& bmcJournalLogEntry = logEntryArray.back(); |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1889 | if (fillBMCJournalLogEntryJson(idStr, journal.get(), |
| 1890 | bmcJournalLogEntry) != 0) |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1891 | { |
Jason M. Bills | f12894f | 2018-10-09 12:45:45 -0700 | [diff] [blame] | 1892 | messages::internalError(asyncResp->res); |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1893 | return; |
| 1894 | } |
| 1895 | } |
Jason M. Bills | 193ad2f | 2018-09-26 15:08:52 -0700 | [diff] [blame] | 1896 | asyncResp->res.jsonValue["Members@odata.count"] = entryCount; |
| 1897 | if (skip + top < entryCount) |
| 1898 | { |
| 1899 | asyncResp->res.jsonValue["Members@odata.nextLink"] = |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1900 | "/redfish/v1/Managers/bmc/LogServices/Journal/Entries?$skip=" + |
Jason M. Bills | 193ad2f | 2018-09-26 15:08:52 -0700 | [diff] [blame] | 1901 | std::to_string(skip + top); |
| 1902 | } |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1903 | } |
| 1904 | }; |
| 1905 | |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1906 | class BMCJournalLogEntry : public Node |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1907 | { |
| 1908 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 1909 | BMCJournalLogEntry(App& app) : |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1910 | Node(app, "/redfish/v1/Managers/bmc/LogServices/Journal/Entries/<str>/", |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1911 | std::string()) |
| 1912 | { |
| 1913 | entityPrivileges = { |
| 1914 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 1915 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 1916 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 1917 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 1918 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 1919 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 1920 | } |
| 1921 | |
| 1922 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 1923 | void doGet(crow::Response& res, const crow::Request&, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1924 | const std::vector<std::string>& params) override |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1925 | { |
| 1926 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 1927 | if (params.size() != 1) |
| 1928 | { |
Jason M. Bills | f12894f | 2018-10-09 12:45:45 -0700 | [diff] [blame] | 1929 | messages::internalError(asyncResp->res); |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1930 | return; |
| 1931 | } |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1932 | const std::string& entryID = params[0]; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1933 | // Convert the unique ID back to a timestamp to find the entry |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1934 | uint64_t ts = 0; |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 1935 | uint64_t index = 0; |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 1936 | if (!getTimestampFromID(asyncResp->res, entryID, ts, index)) |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1937 | { |
Jason M. Bills | 16428a1 | 2018-11-02 12:42:29 -0700 | [diff] [blame] | 1938 | return; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1939 | } |
| 1940 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 1941 | sd_journal* journalTmp = nullptr; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1942 | int ret = sd_journal_open(&journalTmp, SD_JOURNAL_LOCAL_ONLY); |
| 1943 | if (ret < 0) |
| 1944 | { |
| 1945 | BMCWEB_LOG_ERROR << "failed to open journal: " << strerror(-ret); |
Jason M. Bills | f12894f | 2018-10-09 12:45:45 -0700 | [diff] [blame] | 1946 | messages::internalError(asyncResp->res); |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1947 | return; |
| 1948 | } |
| 1949 | std::unique_ptr<sd_journal, decltype(&sd_journal_close)> journal( |
| 1950 | journalTmp, sd_journal_close); |
| 1951 | journalTmp = nullptr; |
| 1952 | // Go to the timestamp in the log and move to the entry at the index |
Jason M. Bills | af07e3f | 2019-08-01 14:41:39 -0700 | [diff] [blame] | 1953 | // tracking the unique ID |
| 1954 | std::string idStr; |
| 1955 | bool firstEntry = true; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1956 | ret = sd_journal_seek_realtime_usec(journal.get(), ts); |
Manojkiran Eda | 2056b6d | 2020-05-28 08:57:36 +0530 | [diff] [blame] | 1957 | if (ret < 0) |
| 1958 | { |
| 1959 | BMCWEB_LOG_ERROR << "failed to seek to an entry in journal" |
| 1960 | << strerror(-ret); |
| 1961 | messages::internalError(asyncResp->res); |
| 1962 | return; |
| 1963 | } |
Ed Tanous | 271584a | 2019-07-09 16:24:22 -0700 | [diff] [blame] | 1964 | for (uint64_t i = 0; i <= index; i++) |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1965 | { |
| 1966 | sd_journal_next(journal.get()); |
Jason M. Bills | af07e3f | 2019-08-01 14:41:39 -0700 | [diff] [blame] | 1967 | if (!getUniqueEntryID(journal.get(), idStr, firstEntry)) |
| 1968 | { |
| 1969 | messages::internalError(asyncResp->res); |
| 1970 | return; |
| 1971 | } |
| 1972 | if (firstEntry) |
| 1973 | { |
| 1974 | firstEntry = false; |
| 1975 | } |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1976 | } |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1977 | // Confirm that the entry ID matches what was requested |
Jason M. Bills | af07e3f | 2019-08-01 14:41:39 -0700 | [diff] [blame] | 1978 | if (idStr != entryID) |
Jason M. Bills | c4bf637 | 2018-11-05 13:48:27 -0800 | [diff] [blame] | 1979 | { |
| 1980 | messages::resourceMissingAtURI(asyncResp->res, entryID); |
| 1981 | return; |
| 1982 | } |
| 1983 | |
| 1984 | if (fillBMCJournalLogEntryJson(entryID, journal.get(), |
| 1985 | asyncResp->res.jsonValue) != 0) |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1986 | { |
Jason M. Bills | f12894f | 2018-10-09 12:45:45 -0700 | [diff] [blame] | 1987 | messages::internalError(asyncResp->res); |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 1988 | return; |
| 1989 | } |
| 1990 | } |
| 1991 | }; |
| 1992 | |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 1993 | class BMCDumpService : public Node |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 1994 | { |
| 1995 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 1996 | BMCDumpService(App& app) : |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 1997 | Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/") |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 1998 | { |
| 1999 | entityPrivileges = { |
| 2000 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 2001 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 2002 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2003 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2004 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 2005 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 2006 | } |
| 2007 | |
| 2008 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2009 | void doGet(crow::Response& res, const crow::Request&, |
| 2010 | const std::vector<std::string>&) override |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2011 | { |
| 2012 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 2013 | |
| 2014 | asyncResp->res.jsonValue["@odata.id"] = |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2015 | "/redfish/v1/Managers/bmc/LogServices/Dump"; |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2016 | asyncResp->res.jsonValue["@odata.type"] = |
| 2017 | "#LogService.v1_1_0.LogService"; |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2018 | asyncResp->res.jsonValue["Name"] = "Dump LogService"; |
| 2019 | asyncResp->res.jsonValue["Description"] = "BMC Dump LogService"; |
| 2020 | asyncResp->res.jsonValue["Id"] = "Dump"; |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2021 | asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2022 | asyncResp->res.jsonValue["Entries"] = { |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2023 | {"@odata.id", "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"}}; |
| 2024 | asyncResp->res.jsonValue["Actions"] = { |
| 2025 | {"#LogService.ClearLog", |
| 2026 | {{"target", "/redfish/v1/Managers/bmc/LogServices/Dump/" |
| 2027 | "Actions/LogService.ClearLog"}}}, |
| 2028 | {"Oem", |
| 2029 | {{"#OemLogService.CollectDiagnosticData", |
| 2030 | {{"target", |
| 2031 | "/redfish/v1/Managers/bmc/LogServices/Dump/" |
| 2032 | "Actions/Oem/OemLogService.CollectDiagnosticData"}}}}}}; |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2033 | } |
| 2034 | }; |
| 2035 | |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2036 | class BMCDumpEntryCollection : public Node |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2037 | { |
| 2038 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2039 | BMCDumpEntryCollection(App& app) : |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2040 | Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/") |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2041 | { |
| 2042 | entityPrivileges = { |
| 2043 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 2044 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 2045 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2046 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2047 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 2048 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 2049 | } |
| 2050 | |
| 2051 | private: |
| 2052 | /** |
| 2053 | * Functions triggers appropriate requests on DBus |
| 2054 | */ |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2055 | void doGet(crow::Response& res, const crow::Request&, |
| 2056 | const std::vector<std::string>&) override |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2057 | { |
| 2058 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 2059 | |
| 2060 | asyncResp->res.jsonValue["@odata.type"] = |
| 2061 | "#LogEntryCollection.LogEntryCollection"; |
| 2062 | asyncResp->res.jsonValue["@odata.id"] = |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2063 | "/redfish/v1/Managers/bmc/LogServices/Dump/Entries"; |
| 2064 | asyncResp->res.jsonValue["Name"] = "BMC Dump Entries"; |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2065 | asyncResp->res.jsonValue["Description"] = |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2066 | "Collection of BMC Dump Entries"; |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2067 | |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2068 | getDumpEntryCollection(asyncResp, "BMC"); |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2069 | } |
| 2070 | }; |
| 2071 | |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2072 | class BMCDumpEntry : public Node |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2073 | { |
| 2074 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2075 | BMCDumpEntry(App& app) : |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2076 | Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/Entries/<str>/", |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2077 | std::string()) |
| 2078 | { |
| 2079 | entityPrivileges = { |
| 2080 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 2081 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 2082 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2083 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2084 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 2085 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 2086 | } |
| 2087 | |
| 2088 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2089 | void doGet(crow::Response& res, const crow::Request&, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2090 | const std::vector<std::string>& params) override |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2091 | { |
| 2092 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 2093 | if (params.size() != 1) |
| 2094 | { |
| 2095 | messages::internalError(asyncResp->res); |
| 2096 | return; |
| 2097 | } |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2098 | getDumpEntryById(asyncResp, params[0], "BMC"); |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2099 | } |
| 2100 | |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2101 | void doDelete(crow::Response& res, const crow::Request&, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2102 | const std::vector<std::string>& params) override |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2103 | { |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2104 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2105 | if (params.size() != 1) |
| 2106 | { |
| 2107 | messages::internalError(asyncResp->res); |
| 2108 | return; |
| 2109 | } |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2110 | deleteDumpEntry(asyncResp->res, params[0]); |
| 2111 | } |
| 2112 | }; |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2113 | |
Asmitha Karunanithi | a43be80 | 2020-05-07 05:05:36 -0500 | [diff] [blame] | 2114 | class BMCDumpCreate : public Node |
| 2115 | { |
| 2116 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2117 | BMCDumpCreate(App& app) : |
Asmitha Karunanithi | a43be80 | 2020-05-07 05:05:36 -0500 | [diff] [blame] | 2118 | Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/" |
| 2119 | "Actions/Oem/" |
| 2120 | "OemLogService.CollectDiagnosticData/") |
| 2121 | { |
| 2122 | entityPrivileges = { |
| 2123 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 2124 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 2125 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2126 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2127 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 2128 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 2129 | } |
| 2130 | |
| 2131 | private: |
| 2132 | void doPost(crow::Response& res, const crow::Request& req, |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2133 | const std::vector<std::string>&) override |
Asmitha Karunanithi | a43be80 | 2020-05-07 05:05:36 -0500 | [diff] [blame] | 2134 | { |
| 2135 | createDump(res, req, "BMC"); |
| 2136 | } |
| 2137 | }; |
| 2138 | |
Asmitha Karunanithi | f71882f | 2020-05-07 06:21:47 -0500 | [diff] [blame] | 2139 | class BMCDumpEntryDownload : public Node |
| 2140 | { |
| 2141 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2142 | BMCDumpEntryDownload(App& app) : |
Asmitha Karunanithi | f71882f | 2020-05-07 06:21:47 -0500 | [diff] [blame] | 2143 | Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/attachment/<str>/", |
| 2144 | std::string()) |
| 2145 | { |
| 2146 | entityPrivileges = { |
| 2147 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 2148 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 2149 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2150 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2151 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 2152 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 2153 | } |
| 2154 | |
| 2155 | private: |
| 2156 | void doGet(crow::Response& res, const crow::Request& req, |
| 2157 | const std::vector<std::string>& params) override |
| 2158 | { |
| 2159 | if (params.size() != 1) |
| 2160 | { |
| 2161 | messages::internalError(res); |
| 2162 | return; |
| 2163 | } |
| 2164 | const std::string& entryID = params[0]; |
| 2165 | crow::obmc_dump::handleDumpOffloadUrl(req, res, entryID); |
| 2166 | } |
| 2167 | }; |
| 2168 | |
Asmitha Karunanithi | 80319af | 2020-05-07 05:30:21 -0500 | [diff] [blame] | 2169 | class BMCDumpClear : public Node |
| 2170 | { |
| 2171 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2172 | BMCDumpClear(App& app) : |
Asmitha Karunanithi | 80319af | 2020-05-07 05:30:21 -0500 | [diff] [blame] | 2173 | Node(app, "/redfish/v1/Managers/bmc/LogServices/Dump/" |
| 2174 | "Actions/" |
| 2175 | "LogService.ClearLog/") |
| 2176 | { |
| 2177 | entityPrivileges = { |
| 2178 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 2179 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 2180 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2181 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2182 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 2183 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 2184 | } |
| 2185 | |
| 2186 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2187 | void doPost(crow::Response& res, const crow::Request&, |
| 2188 | const std::vector<std::string>&) override |
Asmitha Karunanithi | 80319af | 2020-05-07 05:30:21 -0500 | [diff] [blame] | 2189 | { |
| 2190 | clearDump(res, "xyz.openbmc_project.Dump.Entry.BMC"); |
| 2191 | } |
| 2192 | }; |
| 2193 | |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2194 | class SystemDumpService : public Node |
| 2195 | { |
| 2196 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2197 | SystemDumpService(App& app) : |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2198 | Node(app, "/redfish/v1/Systems/system/LogServices/Dump/") |
| 2199 | { |
| 2200 | entityPrivileges = { |
| 2201 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 2202 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 2203 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2204 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2205 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 2206 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 2207 | } |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2208 | |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2209 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2210 | void doGet(crow::Response& res, const crow::Request&, |
| 2211 | const std::vector<std::string>&) override |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2212 | { |
| 2213 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2214 | |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2215 | asyncResp->res.jsonValue["@odata.id"] = |
| 2216 | "/redfish/v1/Systems/system/LogServices/Dump"; |
| 2217 | asyncResp->res.jsonValue["@odata.type"] = |
| 2218 | "#LogService.v1_1_0.LogService"; |
| 2219 | asyncResp->res.jsonValue["Name"] = "Dump LogService"; |
| 2220 | asyncResp->res.jsonValue["Description"] = "System Dump LogService"; |
| 2221 | asyncResp->res.jsonValue["Id"] = "Dump"; |
| 2222 | asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; |
| 2223 | asyncResp->res.jsonValue["Entries"] = { |
| 2224 | {"@odata.id", |
| 2225 | "/redfish/v1/Systems/system/LogServices/Dump/Entries"}}; |
| 2226 | asyncResp->res.jsonValue["Actions"] = { |
| 2227 | {"#LogService.ClearLog", |
| 2228 | {{"target", "/redfish/v1/Systems/system/LogServices/Dump/Actions/" |
| 2229 | "LogService.ClearLog"}}}, |
| 2230 | {"Oem", |
| 2231 | {{"#OemLogService.CollectDiagnosticData", |
| 2232 | {{"target", |
| 2233 | "/redfish/v1/Systems/system/LogServices/Dump/Actions/Oem/" |
| 2234 | "OemLogService.CollectDiagnosticData"}}}}}}; |
| 2235 | } |
| 2236 | }; |
| 2237 | |
| 2238 | class SystemDumpEntryCollection : public Node |
| 2239 | { |
| 2240 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2241 | SystemDumpEntryCollection(App& app) : |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2242 | Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/") |
| 2243 | { |
| 2244 | entityPrivileges = { |
| 2245 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 2246 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 2247 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2248 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2249 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 2250 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 2251 | } |
| 2252 | |
| 2253 | private: |
| 2254 | /** |
| 2255 | * Functions triggers appropriate requests on DBus |
| 2256 | */ |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2257 | void doGet(crow::Response& res, const crow::Request&, |
| 2258 | const std::vector<std::string>&) override |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2259 | { |
| 2260 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 2261 | |
| 2262 | asyncResp->res.jsonValue["@odata.type"] = |
| 2263 | "#LogEntryCollection.LogEntryCollection"; |
| 2264 | asyncResp->res.jsonValue["@odata.id"] = |
| 2265 | "/redfish/v1/Systems/system/LogServices/Dump/Entries"; |
| 2266 | asyncResp->res.jsonValue["Name"] = "System Dump Entries"; |
| 2267 | asyncResp->res.jsonValue["Description"] = |
| 2268 | "Collection of System Dump Entries"; |
| 2269 | |
| 2270 | getDumpEntryCollection(asyncResp, "System"); |
| 2271 | } |
| 2272 | }; |
| 2273 | |
| 2274 | class SystemDumpEntry : public Node |
| 2275 | { |
| 2276 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2277 | SystemDumpEntry(App& app) : |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2278 | Node(app, "/redfish/v1/Systems/system/LogServices/Dump/Entries/<str>/", |
| 2279 | std::string()) |
| 2280 | { |
| 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: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2291 | void doGet(crow::Response& res, const crow::Request&, |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2292 | const std::vector<std::string>& params) override |
| 2293 | { |
| 2294 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 2295 | if (params.size() != 1) |
| 2296 | { |
| 2297 | messages::internalError(asyncResp->res); |
| 2298 | return; |
| 2299 | } |
| 2300 | getDumpEntryById(asyncResp, params[0], "System"); |
| 2301 | } |
| 2302 | |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2303 | void doDelete(crow::Response& res, const crow::Request&, |
Asmitha Karunanithi | 5cb1dd2 | 2020-05-07 04:35:02 -0500 | [diff] [blame] | 2304 | const std::vector<std::string>& params) override |
| 2305 | { |
| 2306 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 2307 | if (params.size() != 1) |
| 2308 | { |
| 2309 | messages::internalError(asyncResp->res); |
| 2310 | return; |
| 2311 | } |
| 2312 | deleteDumpEntry(asyncResp->res, params[0]); |
raviteja-b | c9bb686 | 2020-02-03 11:53:32 -0600 | [diff] [blame] | 2313 | } |
| 2314 | }; |
| 2315 | |
Asmitha Karunanithi | a43be80 | 2020-05-07 05:05:36 -0500 | [diff] [blame] | 2316 | class SystemDumpCreate : public Node |
| 2317 | { |
| 2318 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2319 | SystemDumpCreate(App& app) : |
Asmitha Karunanithi | a43be80 | 2020-05-07 05:05:36 -0500 | [diff] [blame] | 2320 | Node(app, "/redfish/v1/Systems/system/LogServices/Dump/" |
| 2321 | "Actions/Oem/" |
| 2322 | "OemLogService.CollectDiagnosticData/") |
| 2323 | { |
| 2324 | entityPrivileges = { |
| 2325 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 2326 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 2327 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2328 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2329 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 2330 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 2331 | } |
| 2332 | |
| 2333 | private: |
| 2334 | void doPost(crow::Response& res, const crow::Request& req, |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2335 | const std::vector<std::string>&) override |
Asmitha Karunanithi | a43be80 | 2020-05-07 05:05:36 -0500 | [diff] [blame] | 2336 | { |
| 2337 | createDump(res, req, "System"); |
| 2338 | } |
| 2339 | }; |
| 2340 | |
raviteja-b | 0657843 | 2020-02-03 12:50:42 -0600 | [diff] [blame] | 2341 | class SystemDumpEntryDownload : public Node |
| 2342 | { |
| 2343 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2344 | SystemDumpEntryDownload(App& app) : |
raviteja-b | 0657843 | 2020-02-03 12:50:42 -0600 | [diff] [blame] | 2345 | Node(app, |
Asmitha Karunanithi | f71882f | 2020-05-07 06:21:47 -0500 | [diff] [blame] | 2346 | "/redfish/v1/Systems/system/LogServices/Dump/attachment/<str>/", |
raviteja-b | 0657843 | 2020-02-03 12:50:42 -0600 | [diff] [blame] | 2347 | std::string()) |
| 2348 | { |
| 2349 | entityPrivileges = { |
| 2350 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 2351 | {boost::beast::http::verb::head, {{"Login"}}}, |
Asmitha Karunanithi | f71882f | 2020-05-07 06:21:47 -0500 | [diff] [blame] | 2352 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2353 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2354 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
raviteja-b | 0657843 | 2020-02-03 12:50:42 -0600 | [diff] [blame] | 2355 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 2356 | } |
| 2357 | |
| 2358 | private: |
Asmitha Karunanithi | f71882f | 2020-05-07 06:21:47 -0500 | [diff] [blame] | 2359 | void doGet(crow::Response& res, const crow::Request& req, |
| 2360 | const std::vector<std::string>& params) override |
raviteja-b | 0657843 | 2020-02-03 12:50:42 -0600 | [diff] [blame] | 2361 | { |
| 2362 | if (params.size() != 1) |
| 2363 | { |
| 2364 | messages::internalError(res); |
| 2365 | return; |
| 2366 | } |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2367 | const std::string& entryID = params[0]; |
raviteja-b | 0657843 | 2020-02-03 12:50:42 -0600 | [diff] [blame] | 2368 | crow::obmc_dump::handleDumpOffloadUrl(req, res, entryID); |
| 2369 | } |
| 2370 | }; |
| 2371 | |
raviteja-b | 013487e | 2020-03-03 03:20:48 -0600 | [diff] [blame] | 2372 | class SystemDumpClear : public Node |
| 2373 | { |
| 2374 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2375 | SystemDumpClear(App& app) : |
Asmitha Karunanithi | 80319af | 2020-05-07 05:30:21 -0500 | [diff] [blame] | 2376 | Node(app, "/redfish/v1/Systems/system/LogServices/Dump/" |
raviteja-b | 013487e | 2020-03-03 03:20:48 -0600 | [diff] [blame] | 2377 | "Actions/" |
| 2378 | "LogService.ClearLog/") |
| 2379 | { |
| 2380 | entityPrivileges = { |
| 2381 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 2382 | {boost::beast::http::verb::head, {{"Login"}}}, |
Asmitha Karunanithi | 80319af | 2020-05-07 05:30:21 -0500 | [diff] [blame] | 2383 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2384 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2385 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
raviteja-b | 013487e | 2020-03-03 03:20:48 -0600 | [diff] [blame] | 2386 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 2387 | } |
| 2388 | |
| 2389 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2390 | void doPost(crow::Response& res, const crow::Request&, |
| 2391 | const std::vector<std::string>&) override |
raviteja-b | 013487e | 2020-03-03 03:20:48 -0600 | [diff] [blame] | 2392 | { |
Asmitha Karunanithi | 80319af | 2020-05-07 05:30:21 -0500 | [diff] [blame] | 2393 | clearDump(res, "xyz.openbmc_project.Dump.Entry.System"); |
raviteja-b | 013487e | 2020-03-03 03:20:48 -0600 | [diff] [blame] | 2394 | } |
| 2395 | }; |
| 2396 | |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2397 | class CrashdumpService : public Node |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2398 | { |
| 2399 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2400 | CrashdumpService(App& app) : |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2401 | Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/") |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2402 | { |
AppaRao Puli | 3946028 | 2020-04-07 17:03:04 +0530 | [diff] [blame] | 2403 | // Note: Deviated from redfish privilege registry for GET & HEAD |
| 2404 | // method for security reasons. |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2405 | entityPrivileges = { |
AppaRao Puli | 3946028 | 2020-04-07 17:03:04 +0530 | [diff] [blame] | 2406 | {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, |
| 2407 | {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2408 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2409 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2410 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 2411 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2412 | } |
| 2413 | |
| 2414 | private: |
| 2415 | /** |
| 2416 | * Functions triggers appropriate requests on DBus |
| 2417 | */ |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2418 | void doGet(crow::Response& res, const crow::Request&, |
| 2419 | const std::vector<std::string>&) override |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2420 | { |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2421 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2422 | // Copy over the static data to include the entries added by SubRoute |
Ed Tanous | 0f74e64 | 2018-11-12 15:17:05 -0800 | [diff] [blame] | 2423 | asyncResp->res.jsonValue["@odata.id"] = |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2424 | "/redfish/v1/Systems/system/LogServices/Crashdump"; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2425 | asyncResp->res.jsonValue["@odata.type"] = |
| 2426 | "#LogService.v1_1_0.LogService"; |
Gunnar Mills | 4f50ae4 | 2020-02-06 15:29:57 -0600 | [diff] [blame] | 2427 | asyncResp->res.jsonValue["Name"] = "Open BMC Oem Crashdump Service"; |
| 2428 | asyncResp->res.jsonValue["Description"] = "Oem Crashdump Service"; |
| 2429 | asyncResp->res.jsonValue["Id"] = "Oem Crashdump"; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2430 | asyncResp->res.jsonValue["OverWritePolicy"] = "WrapsWhenFull"; |
| 2431 | asyncResp->res.jsonValue["MaxNumberOfRecords"] = 3; |
Jason M. Bills | cd50aa4 | 2019-02-12 17:09:02 -0800 | [diff] [blame] | 2432 | asyncResp->res.jsonValue["Entries"] = { |
| 2433 | {"@odata.id", |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2434 | "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"}}; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2435 | asyncResp->res.jsonValue["Actions"] = { |
Jason M. Bills | 5b61b5e | 2019-10-16 10:59:02 -0700 | [diff] [blame] | 2436 | {"#LogService.ClearLog", |
| 2437 | {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" |
| 2438 | "Actions/LogService.ClearLog"}}}, |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2439 | {"Oem", |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2440 | {{"#Crashdump.OnDemand", |
| 2441 | {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" |
Kenny L. Ku | 6eda768 | 2020-06-19 09:48:36 -0700 | [diff] [blame] | 2442 | "Actions/Oem/Crashdump.OnDemand"}}}, |
| 2443 | {"#Crashdump.Telemetry", |
| 2444 | {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" |
| 2445 | "Actions/Oem/Crashdump.Telemetry"}}}}}}; |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2446 | |
| 2447 | #ifdef BMCWEB_ENABLE_REDFISH_RAW_PECI |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2448 | asyncResp->res.jsonValue["Actions"]["Oem"].push_back( |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2449 | {"#Crashdump.SendRawPeci", |
Anthony Wilson | 08a4e4b | 2019-04-12 08:23:05 -0500 | [diff] [blame] | 2450 | {{"target", "/redfish/v1/Systems/system/LogServices/Crashdump/" |
| 2451 | "Actions/Oem/Crashdump.SendRawPeci"}}}); |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2452 | #endif |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2453 | } |
| 2454 | }; |
| 2455 | |
Jason M. Bills | 5b61b5e | 2019-10-16 10:59:02 -0700 | [diff] [blame] | 2456 | class CrashdumpClear : public Node |
| 2457 | { |
| 2458 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2459 | CrashdumpClear(App& app) : |
Jason M. Bills | 5b61b5e | 2019-10-16 10:59:02 -0700 | [diff] [blame] | 2460 | Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/" |
| 2461 | "LogService.ClearLog/") |
| 2462 | { |
AppaRao Puli | 3946028 | 2020-04-07 17:03:04 +0530 | [diff] [blame] | 2463 | // Note: Deviated from redfish privilege registry for GET & HEAD |
| 2464 | // method for security reasons. |
Jason M. Bills | 5b61b5e | 2019-10-16 10:59:02 -0700 | [diff] [blame] | 2465 | entityPrivileges = { |
AppaRao Puli | 3946028 | 2020-04-07 17:03:04 +0530 | [diff] [blame] | 2466 | {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, |
| 2467 | {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, |
Jason M. Bills | 5b61b5e | 2019-10-16 10:59:02 -0700 | [diff] [blame] | 2468 | {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, |
| 2469 | {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, |
| 2470 | {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, |
| 2471 | {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; |
| 2472 | } |
| 2473 | |
| 2474 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2475 | void doPost(crow::Response& res, const crow::Request&, |
| 2476 | const std::vector<std::string>&) override |
Jason M. Bills | 5b61b5e | 2019-10-16 10:59:02 -0700 | [diff] [blame] | 2477 | { |
| 2478 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 2479 | |
| 2480 | crow::connections::systemBus->async_method_call( |
| 2481 | [asyncResp](const boost::system::error_code ec, |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2482 | const std::string&) { |
Jason M. Bills | 5b61b5e | 2019-10-16 10:59:02 -0700 | [diff] [blame] | 2483 | if (ec) |
| 2484 | { |
| 2485 | messages::internalError(asyncResp->res); |
| 2486 | return; |
| 2487 | } |
| 2488 | messages::success(asyncResp->res); |
| 2489 | }, |
| 2490 | crashdumpObject, crashdumpPath, deleteAllInterface, "DeleteAll"); |
| 2491 | } |
| 2492 | }; |
| 2493 | |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2494 | static void logCrashdumpEntry(std::shared_ptr<AsyncResp> asyncResp, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2495 | const std::string& logID, |
| 2496 | nlohmann::json& logEntryJson) |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2497 | { |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 2498 | auto getStoredLogCallback = |
| 2499 | [asyncResp, logID, &logEntryJson]( |
| 2500 | const boost::system::error_code ec, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2501 | const std::vector<std::pair<std::string, VariantType>>& params) { |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 2502 | if (ec) |
Jason M. Bills | 1ddcf01 | 2019-11-26 14:59:21 -0800 | [diff] [blame] | 2503 | { |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 2504 | BMCWEB_LOG_DEBUG << "failed to get log ec: " << ec.message(); |
| 2505 | if (ec.value() == |
| 2506 | boost::system::linux_error::bad_request_descriptor) |
| 2507 | { |
| 2508 | messages::resourceNotFound(asyncResp->res, "LogEntry", |
| 2509 | logID); |
| 2510 | } |
| 2511 | else |
| 2512 | { |
| 2513 | messages::internalError(asyncResp->res); |
| 2514 | } |
| 2515 | return; |
Jason M. Bills | 1ddcf01 | 2019-11-26 14:59:21 -0800 | [diff] [blame] | 2516 | } |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2517 | |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 2518 | std::string timestamp{}; |
| 2519 | std::string filename{}; |
| 2520 | std::string logfile{}; |
| 2521 | ParseCrashdumpParameters(params, filename, timestamp, logfile); |
| 2522 | |
| 2523 | if (filename.empty() || timestamp.empty()) |
| 2524 | { |
| 2525 | messages::resourceMissingAtURI(asyncResp->res, logID); |
| 2526 | return; |
| 2527 | } |
| 2528 | |
| 2529 | std::string crashdumpURI = |
| 2530 | "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/" + |
| 2531 | logID + "/" + filename; |
| 2532 | logEntryJson = {{"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, |
| 2533 | {"@odata.id", "/redfish/v1/Systems/system/" |
| 2534 | "LogServices/Crashdump/Entries/" + |
| 2535 | logID}, |
| 2536 | {"Name", "CPU Crashdump"}, |
| 2537 | {"Id", logID}, |
| 2538 | {"EntryType", "Oem"}, |
| 2539 | {"OemRecordFormat", "Crashdump URI"}, |
| 2540 | {"Message", std::move(crashdumpURI)}, |
| 2541 | {"Created", std::move(timestamp)}}; |
| 2542 | }; |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2543 | crow::connections::systemBus->async_method_call( |
Jason M. Bills | 5b61b5e | 2019-10-16 10:59:02 -0700 | [diff] [blame] | 2544 | std::move(getStoredLogCallback), crashdumpObject, |
| 2545 | crashdumpPath + std::string("/") + logID, |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 2546 | "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface); |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2547 | } |
| 2548 | |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2549 | class CrashdumpEntryCollection : public Node |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2550 | { |
| 2551 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2552 | CrashdumpEntryCollection(App& app) : |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2553 | Node(app, "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/") |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2554 | { |
AppaRao Puli | 3946028 | 2020-04-07 17:03:04 +0530 | [diff] [blame] | 2555 | // Note: Deviated from redfish privilege registry for GET & HEAD |
| 2556 | // method for security reasons. |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2557 | entityPrivileges = { |
AppaRao Puli | 3946028 | 2020-04-07 17:03:04 +0530 | [diff] [blame] | 2558 | {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, |
| 2559 | {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2560 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2561 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2562 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 2563 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2564 | } |
| 2565 | |
| 2566 | private: |
| 2567 | /** |
| 2568 | * Functions triggers appropriate requests on DBus |
| 2569 | */ |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2570 | void doGet(crow::Response& res, const crow::Request&, |
| 2571 | const std::vector<std::string>&) override |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2572 | { |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2573 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2574 | // Collections don't include the static data added by SubRoute because |
| 2575 | // it has a duplicate entry for members |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2576 | auto getLogEntriesCallback = [asyncResp]( |
| 2577 | const boost::system::error_code ec, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2578 | const std::vector<std::string>& resp) { |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2579 | if (ec) |
| 2580 | { |
| 2581 | if (ec.value() != |
| 2582 | boost::system::errc::no_such_file_or_directory) |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2583 | { |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2584 | BMCWEB_LOG_DEBUG << "failed to get entries ec: " |
| 2585 | << ec.message(); |
Jason M. Bills | f12894f | 2018-10-09 12:45:45 -0700 | [diff] [blame] | 2586 | messages::internalError(asyncResp->res); |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2587 | return; |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2588 | } |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2589 | } |
| 2590 | asyncResp->res.jsonValue["@odata.type"] = |
| 2591 | "#LogEntryCollection.LogEntryCollection"; |
Ed Tanous | 0f74e64 | 2018-11-12 15:17:05 -0800 | [diff] [blame] | 2592 | asyncResp->res.jsonValue["@odata.id"] = |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2593 | "/redfish/v1/Systems/system/LogServices/Crashdump/Entries"; |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2594 | asyncResp->res.jsonValue["Name"] = "Open BMC Crashdump Entries"; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2595 | asyncResp->res.jsonValue["Description"] = |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2596 | "Collection of Crashdump Entries"; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2597 | nlohmann::json& logEntryArray = asyncResp->res.jsonValue["Members"]; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2598 | logEntryArray = nlohmann::json::array(); |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2599 | std::vector<std::string> logIDs; |
| 2600 | // Get the list of log entries and build up an empty array big |
| 2601 | // enough to hold them |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2602 | for (const std::string& objpath : resp) |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2603 | { |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2604 | // Get the log ID |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2605 | std::size_t lastPos = objpath.rfind("/"); |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2606 | if (lastPos == std::string::npos) |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2607 | { |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2608 | continue; |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2609 | } |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2610 | logIDs.emplace_back(objpath.substr(lastPos + 1)); |
| 2611 | |
| 2612 | // Add a space for the log entry to the array |
| 2613 | logEntryArray.push_back({}); |
| 2614 | } |
| 2615 | // Now go through and set up async calls to fill in the entries |
| 2616 | size_t index = 0; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2617 | for (const std::string& logID : logIDs) |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2618 | { |
| 2619 | // Add the log entry to the array |
| 2620 | logCrashdumpEntry(asyncResp, logID, logEntryArray[index++]); |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2621 | } |
| 2622 | asyncResp->res.jsonValue["Members@odata.count"] = |
| 2623 | logEntryArray.size(); |
| 2624 | }; |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2625 | crow::connections::systemBus->async_method_call( |
| 2626 | std::move(getLogEntriesCallback), |
| 2627 | "xyz.openbmc_project.ObjectMapper", |
| 2628 | "/xyz/openbmc_project/object_mapper", |
| 2629 | "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", "", 0, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2630 | std::array<const char*, 1>{crashdumpInterface}); |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2631 | } |
| 2632 | }; |
| 2633 | |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2634 | class CrashdumpEntry : public Node |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2635 | { |
| 2636 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2637 | CrashdumpEntry(App& app) : |
Jason M. Bills | d53dd41 | 2019-02-12 17:16:22 -0800 | [diff] [blame] | 2638 | Node(app, |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2639 | "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/", |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2640 | std::string()) |
| 2641 | { |
AppaRao Puli | 3946028 | 2020-04-07 17:03:04 +0530 | [diff] [blame] | 2642 | // Note: Deviated from redfish privilege registry for GET & HEAD |
| 2643 | // method for security reasons. |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2644 | entityPrivileges = { |
AppaRao Puli | 3946028 | 2020-04-07 17:03:04 +0530 | [diff] [blame] | 2645 | {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, |
| 2646 | {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2647 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2648 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2649 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 2650 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2651 | } |
| 2652 | |
| 2653 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2654 | void doGet(crow::Response& res, const crow::Request&, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2655 | const std::vector<std::string>& params) override |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2656 | { |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2657 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2658 | if (params.size() != 1) |
| 2659 | { |
Jason M. Bills | f12894f | 2018-10-09 12:45:45 -0700 | [diff] [blame] | 2660 | messages::internalError(asyncResp->res); |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2661 | return; |
| 2662 | } |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2663 | const std::string& logID = params[0]; |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2664 | logCrashdumpEntry(asyncResp, logID, asyncResp->res.jsonValue); |
| 2665 | } |
| 2666 | }; |
| 2667 | |
| 2668 | class CrashdumpFile : public Node |
| 2669 | { |
| 2670 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2671 | CrashdumpFile(App& app) : |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2672 | Node(app, |
| 2673 | "/redfish/v1/Systems/system/LogServices/Crashdump/Entries/<str>/" |
| 2674 | "<str>/", |
| 2675 | std::string(), std::string()) |
| 2676 | { |
AppaRao Puli | 3946028 | 2020-04-07 17:03:04 +0530 | [diff] [blame] | 2677 | // Note: Deviated from redfish privilege registry for GET & HEAD |
| 2678 | // method for security reasons. |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2679 | entityPrivileges = { |
AppaRao Puli | 3946028 | 2020-04-07 17:03:04 +0530 | [diff] [blame] | 2680 | {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, |
| 2681 | {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2682 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 2683 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 2684 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 2685 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 2686 | } |
| 2687 | |
| 2688 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2689 | void doGet(crow::Response& res, const crow::Request&, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2690 | const std::vector<std::string>& params) override |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2691 | { |
| 2692 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 2693 | if (params.size() != 2) |
| 2694 | { |
| 2695 | messages::internalError(asyncResp->res); |
| 2696 | return; |
| 2697 | } |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2698 | const std::string& logID = params[0]; |
| 2699 | const std::string& fileName = params[1]; |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2700 | |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 2701 | auto getStoredLogCallback = |
| 2702 | [asyncResp, logID, fileName]( |
| 2703 | const boost::system::error_code ec, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2704 | const std::vector<std::pair<std::string, VariantType>>& resp) { |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 2705 | if (ec) |
| 2706 | { |
| 2707 | BMCWEB_LOG_DEBUG << "failed to get log ec: " |
| 2708 | << ec.message(); |
| 2709 | messages::internalError(asyncResp->res); |
| 2710 | return; |
| 2711 | } |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2712 | |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 2713 | std::string dbusFilename{}; |
| 2714 | std::string dbusTimestamp{}; |
| 2715 | std::string dbusFilepath{}; |
Jason M. Bills | e855dd2 | 2019-10-08 11:37:48 -0700 | [diff] [blame] | 2716 | |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 2717 | ParseCrashdumpParameters(resp, dbusFilename, dbusTimestamp, |
| 2718 | dbusFilepath); |
| 2719 | |
| 2720 | if (dbusFilename.empty() || dbusTimestamp.empty() || |
| 2721 | dbusFilepath.empty()) |
| 2722 | { |
| 2723 | messages::resourceMissingAtURI(asyncResp->res, fileName); |
| 2724 | return; |
| 2725 | } |
| 2726 | |
| 2727 | // Verify the file name parameter is correct |
| 2728 | if (fileName != dbusFilename) |
| 2729 | { |
| 2730 | messages::resourceMissingAtURI(asyncResp->res, fileName); |
| 2731 | return; |
| 2732 | } |
| 2733 | |
| 2734 | if (!std::filesystem::exists(dbusFilepath)) |
| 2735 | { |
| 2736 | messages::resourceMissingAtURI(asyncResp->res, fileName); |
| 2737 | return; |
| 2738 | } |
| 2739 | std::ifstream ifs(dbusFilepath, std::ios::in | |
| 2740 | std::ios::binary | |
| 2741 | std::ios::ate); |
| 2742 | std::ifstream::pos_type fileSize = ifs.tellg(); |
| 2743 | if (fileSize < 0) |
| 2744 | { |
| 2745 | messages::generalError(asyncResp->res); |
| 2746 | return; |
| 2747 | } |
| 2748 | ifs.seekg(0, std::ios::beg); |
| 2749 | |
| 2750 | auto crashData = std::make_unique<char[]>( |
| 2751 | static_cast<unsigned int>(fileSize)); |
| 2752 | |
| 2753 | ifs.read(crashData.get(), static_cast<int>(fileSize)); |
| 2754 | |
| 2755 | // The cast to std::string is intentional in order to use the |
| 2756 | // assign() that applies move mechanics |
| 2757 | asyncResp->res.body().assign( |
| 2758 | static_cast<std::string>(crashData.get())); |
| 2759 | |
| 2760 | // Configure this to be a file download when accessed from |
| 2761 | // a browser |
| 2762 | asyncResp->res.addHeader("Content-Disposition", "attachment"); |
| 2763 | }; |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2764 | crow::connections::systemBus->async_method_call( |
Jason M. Bills | 5b61b5e | 2019-10-16 10:59:02 -0700 | [diff] [blame] | 2765 | std::move(getStoredLogCallback), crashdumpObject, |
| 2766 | crashdumpPath + std::string("/") + logID, |
Johnathan Mantey | 043a053 | 2020-03-10 17:15:28 -0700 | [diff] [blame] | 2767 | "org.freedesktop.DBus.Properties", "GetAll", crashdumpInterface); |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2768 | } |
| 2769 | }; |
| 2770 | |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2771 | class OnDemandCrashdump : public Node |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2772 | { |
| 2773 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2774 | OnDemandCrashdump(App& app) : |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2775 | Node(app, |
| 2776 | "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/" |
| 2777 | "Crashdump.OnDemand/") |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2778 | { |
AppaRao Puli | 3946028 | 2020-04-07 17:03:04 +0530 | [diff] [blame] | 2779 | // Note: Deviated from redfish privilege registry for GET & HEAD |
| 2780 | // method for security reasons. |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2781 | entityPrivileges = { |
AppaRao Puli | 3946028 | 2020-04-07 17:03:04 +0530 | [diff] [blame] | 2782 | {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, |
| 2783 | {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, |
| 2784 | {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, |
| 2785 | {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, |
| 2786 | {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, |
| 2787 | {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2788 | } |
| 2789 | |
| 2790 | private: |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2791 | void doPost(crow::Response& res, const crow::Request& req, |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2792 | const std::vector<std::string>&) override |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2793 | { |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2794 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2795 | |
James Feist | fe30672 | 2020-03-12 16:32:08 -0700 | [diff] [blame] | 2796 | auto generateonDemandLogCallback = [asyncResp, |
| 2797 | req](const boost::system::error_code |
| 2798 | ec, |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2799 | const std::string&) { |
James Feist | 4622957 | 2020-02-19 15:11:58 -0800 | [diff] [blame] | 2800 | if (ec) |
| 2801 | { |
| 2802 | if (ec.value() == boost::system::errc::operation_not_supported) |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2803 | { |
James Feist | 4622957 | 2020-02-19 15:11:58 -0800 | [diff] [blame] | 2804 | messages::resourceInStandby(asyncResp->res); |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2805 | } |
James Feist | 4622957 | 2020-02-19 15:11:58 -0800 | [diff] [blame] | 2806 | else if (ec.value() == |
| 2807 | boost::system::errc::device_or_resource_busy) |
| 2808 | { |
| 2809 | messages::serviceTemporarilyUnavailable(asyncResp->res, |
| 2810 | "60"); |
| 2811 | } |
| 2812 | else |
| 2813 | { |
| 2814 | messages::internalError(asyncResp->res); |
| 2815 | } |
| 2816 | return; |
| 2817 | } |
| 2818 | std::shared_ptr<task::TaskData> task = task::TaskData::createTask( |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2819 | [](boost::system::error_code err, sdbusplus::message::message&, |
| 2820 | const std::shared_ptr<task::TaskData>& taskData) { |
James Feist | 66afe4f | 2020-02-24 13:09:58 -0800 | [diff] [blame] | 2821 | if (!err) |
| 2822 | { |
James Feist | e5d5006 | 2020-05-11 17:29:00 -0700 | [diff] [blame] | 2823 | taskData->messages.emplace_back( |
| 2824 | messages::taskCompletedOK( |
| 2825 | std::to_string(taskData->index))); |
James Feist | 831d6b0 | 2020-03-12 16:31:30 -0700 | [diff] [blame] | 2826 | taskData->state = "Completed"; |
James Feist | 66afe4f | 2020-02-24 13:09:58 -0800 | [diff] [blame] | 2827 | } |
James Feist | 32898ce | 2020-03-10 16:16:52 -0700 | [diff] [blame] | 2828 | return task::completed; |
James Feist | 66afe4f | 2020-02-24 13:09:58 -0800 | [diff] [blame] | 2829 | }, |
James Feist | 4622957 | 2020-02-19 15:11:58 -0800 | [diff] [blame] | 2830 | "type='signal',interface='org.freedesktop.DBus.Properties'," |
| 2831 | "member='PropertiesChanged',arg0namespace='com.intel." |
| 2832 | "crashdump'"); |
| 2833 | task->startTimer(std::chrono::minutes(5)); |
| 2834 | task->populateResp(asyncResp->res); |
James Feist | fe30672 | 2020-03-12 16:32:08 -0700 | [diff] [blame] | 2835 | task->payload.emplace(req); |
James Feist | 4622957 | 2020-02-19 15:11:58 -0800 | [diff] [blame] | 2836 | }; |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2837 | crow::connections::systemBus->async_method_call( |
Jason M. Bills | 5b61b5e | 2019-10-16 10:59:02 -0700 | [diff] [blame] | 2838 | std::move(generateonDemandLogCallback), crashdumpObject, |
| 2839 | crashdumpPath, crashdumpOnDemandInterface, "GenerateOnDemandLog"); |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2840 | } |
| 2841 | }; |
| 2842 | |
Kenny L. Ku | 6eda768 | 2020-06-19 09:48:36 -0700 | [diff] [blame] | 2843 | class TelemetryCrashdump : public Node |
| 2844 | { |
| 2845 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2846 | TelemetryCrashdump(App& app) : |
Kenny L. Ku | 6eda768 | 2020-06-19 09:48:36 -0700 | [diff] [blame] | 2847 | Node(app, |
| 2848 | "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/" |
| 2849 | "Crashdump.Telemetry/") |
| 2850 | { |
| 2851 | // Note: Deviated from redfish privilege registry for GET & HEAD |
| 2852 | // method for security reasons. |
| 2853 | entityPrivileges = { |
| 2854 | {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, |
| 2855 | {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, |
| 2856 | {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, |
| 2857 | {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, |
| 2858 | {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, |
| 2859 | {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; |
| 2860 | } |
| 2861 | |
| 2862 | private: |
| 2863 | void doPost(crow::Response& res, const crow::Request& req, |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2864 | const std::vector<std::string>&) override |
Kenny L. Ku | 6eda768 | 2020-06-19 09:48:36 -0700 | [diff] [blame] | 2865 | { |
| 2866 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 2867 | |
| 2868 | auto generateTelemetryLogCallback = [asyncResp, req]( |
| 2869 | const boost::system::error_code |
| 2870 | ec, |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2871 | const std::string&) { |
Kenny L. Ku | 6eda768 | 2020-06-19 09:48:36 -0700 | [diff] [blame] | 2872 | if (ec) |
| 2873 | { |
| 2874 | if (ec.value() == boost::system::errc::operation_not_supported) |
| 2875 | { |
| 2876 | messages::resourceInStandby(asyncResp->res); |
| 2877 | } |
| 2878 | else if (ec.value() == |
| 2879 | boost::system::errc::device_or_resource_busy) |
| 2880 | { |
| 2881 | messages::serviceTemporarilyUnavailable(asyncResp->res, |
| 2882 | "60"); |
| 2883 | } |
| 2884 | else |
| 2885 | { |
| 2886 | messages::internalError(asyncResp->res); |
| 2887 | } |
| 2888 | return; |
| 2889 | } |
| 2890 | std::shared_ptr<task::TaskData> task = task::TaskData::createTask( |
| 2891 | [](boost::system::error_code err, sdbusplus::message::message&, |
| 2892 | const std::shared_ptr<task::TaskData>& taskData) { |
| 2893 | if (!err) |
| 2894 | { |
| 2895 | taskData->messages.emplace_back( |
| 2896 | messages::taskCompletedOK( |
| 2897 | std::to_string(taskData->index))); |
| 2898 | taskData->state = "Completed"; |
| 2899 | } |
| 2900 | return task::completed; |
| 2901 | }, |
| 2902 | "type='signal',interface='org.freedesktop.DBus.Properties'," |
| 2903 | "member='PropertiesChanged',arg0namespace='com.intel." |
| 2904 | "crashdump'"); |
| 2905 | task->startTimer(std::chrono::minutes(5)); |
| 2906 | task->populateResp(asyncResp->res); |
| 2907 | task->payload.emplace(req); |
| 2908 | }; |
| 2909 | crow::connections::systemBus->async_method_call( |
| 2910 | std::move(generateTelemetryLogCallback), crashdumpObject, |
| 2911 | crashdumpPath, crashdumpTelemetryInterface, "GenerateTelemetryLog"); |
| 2912 | } |
| 2913 | }; |
| 2914 | |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2915 | class SendRawPECI : public Node |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2916 | { |
| 2917 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2918 | SendRawPECI(App& app) : |
Jason M. Bills | 424c417 | 2019-03-21 13:50:33 -0700 | [diff] [blame] | 2919 | Node(app, |
| 2920 | "/redfish/v1/Systems/system/LogServices/Crashdump/Actions/Oem/" |
| 2921 | "Crashdump.SendRawPeci/") |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2922 | { |
AppaRao Puli | 3946028 | 2020-04-07 17:03:04 +0530 | [diff] [blame] | 2923 | // Note: Deviated from redfish privilege registry for GET & HEAD |
| 2924 | // method for security reasons. |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2925 | entityPrivileges = { |
| 2926 | {boost::beast::http::verb::get, {{"ConfigureComponents"}}}, |
| 2927 | {boost::beast::http::verb::head, {{"ConfigureComponents"}}}, |
| 2928 | {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, |
| 2929 | {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, |
| 2930 | {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, |
| 2931 | {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; |
| 2932 | } |
| 2933 | |
| 2934 | private: |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2935 | void doPost(crow::Response& res, const crow::Request& req, |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 2936 | const std::vector<std::string>&) override |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2937 | { |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2938 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
Karthick Sundarrajan | 8724c29 | 2020-01-06 09:04:48 -0800 | [diff] [blame] | 2939 | std::vector<std::vector<uint8_t>> peciCommands; |
Ed Tanous | b155642 | 2018-10-16 14:09:17 -0700 | [diff] [blame] | 2940 | |
Karthick Sundarrajan | f0b6ae0 | 2020-01-17 13:32:58 -0800 | [diff] [blame^] | 2941 | if (!json_util::readJson(req, res, "PECICommands", peciCommands)) |
Karthick Sundarrajan | 8724c29 | 2020-01-06 09:04:48 -0800 | [diff] [blame] | 2942 | { |
Karthick Sundarrajan | f0b6ae0 | 2020-01-17 13:32:58 -0800 | [diff] [blame^] | 2943 | return; |
Karthick Sundarrajan | 8724c29 | 2020-01-06 09:04:48 -0800 | [diff] [blame] | 2944 | } |
Karthick Sundarrajan | f0b6ae0 | 2020-01-17 13:32:58 -0800 | [diff] [blame^] | 2945 | uint32_t idx = 0; |
| 2946 | for (auto const& cmd : peciCommands) |
Karthick Sundarrajan | 8724c29 | 2020-01-06 09:04:48 -0800 | [diff] [blame] | 2947 | { |
Karthick Sundarrajan | f0b6ae0 | 2020-01-17 13:32:58 -0800 | [diff] [blame^] | 2948 | if (cmd.size() < 3) |
Karthick Sundarrajan | 8724c29 | 2020-01-06 09:04:48 -0800 | [diff] [blame] | 2949 | { |
Karthick Sundarrajan | f0b6ae0 | 2020-01-17 13:32:58 -0800 | [diff] [blame^] | 2950 | std::string s("["); |
| 2951 | for (auto const& val : cmd) |
| 2952 | { |
| 2953 | if (val != *cmd.begin()) |
| 2954 | { |
| 2955 | s += ","; |
| 2956 | } |
| 2957 | s += std::to_string(val); |
| 2958 | } |
| 2959 | s += "]"; |
| 2960 | messages::actionParameterValueFormatError( |
| 2961 | res, s, "PECICommands[" + std::to_string(idx) + "]", |
| 2962 | "SendRawPeci"); |
Karthick Sundarrajan | 8724c29 | 2020-01-06 09:04:48 -0800 | [diff] [blame] | 2963 | return; |
| 2964 | } |
Karthick Sundarrajan | f0b6ae0 | 2020-01-17 13:32:58 -0800 | [diff] [blame^] | 2965 | idx++; |
Karthick Sundarrajan | 8724c29 | 2020-01-06 09:04:48 -0800 | [diff] [blame] | 2966 | } |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2967 | // Callback to return the Raw PECI response |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2968 | auto sendRawPECICallback = |
| 2969 | [asyncResp](const boost::system::error_code ec, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 2970 | const std::vector<std::vector<uint8_t>>& resp) { |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2971 | if (ec) |
| 2972 | { |
Karthick Sundarrajan | 8724c29 | 2020-01-06 09:04:48 -0800 | [diff] [blame] | 2973 | BMCWEB_LOG_DEBUG << "failed to process PECI commands ec: " |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2974 | << ec.message(); |
Jason M. Bills | f12894f | 2018-10-09 12:45:45 -0700 | [diff] [blame] | 2975 | messages::internalError(asyncResp->res); |
Jason M. Bills | e1f2634 | 2018-07-18 12:12:00 -0700 | [diff] [blame] | 2976 | return; |
| 2977 | } |
| 2978 | asyncResp->res.jsonValue = {{"Name", "PECI Command Response"}, |
| 2979 | {"PECIResponse", resp}}; |
| 2980 | }; |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2981 | // Call the SendRawPECI command with the provided data |
| 2982 | crow::connections::systemBus->async_method_call( |
Jason M. Bills | 5b61b5e | 2019-10-16 10:59:02 -0700 | [diff] [blame] | 2983 | std::move(sendRawPECICallback), crashdumpObject, crashdumpPath, |
Karthick Sundarrajan | 8724c29 | 2020-01-06 09:04:48 -0800 | [diff] [blame] | 2984 | crashdumpRawPECIInterface, "SendRawPeci", peciCommands); |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 2985 | } |
| 2986 | }; |
| 2987 | |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 2988 | /** |
| 2989 | * DBusLogServiceActionsClear class supports POST method for ClearLog action. |
| 2990 | */ |
| 2991 | class DBusLogServiceActionsClear : public Node |
| 2992 | { |
| 2993 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 2994 | DBusLogServiceActionsClear(App& app) : |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 2995 | Node(app, "/redfish/v1/Systems/system/LogServices/EventLog/Actions/" |
Gunnar Mills | 7af9151 | 2020-04-14 22:16:57 -0500 | [diff] [blame] | 2996 | "LogService.ClearLog/") |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 2997 | { |
| 2998 | entityPrivileges = { |
| 2999 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 3000 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 3001 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 3002 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 3003 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 3004 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 3005 | } |
| 3006 | |
| 3007 | private: |
| 3008 | /** |
| 3009 | * Function handles POST method request. |
| 3010 | * The Clear Log actions does not require any parameter.The action deletes |
| 3011 | * all entries found in the Entries collection for this Log Service. |
| 3012 | */ |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 3013 | void doPost(crow::Response& res, const crow::Request&, |
| 3014 | const std::vector<std::string>&) override |
Andrew Geissler | cb92c03 | 2018-08-17 07:56:14 -0700 | [diff] [blame] | 3015 | { |
| 3016 | BMCWEB_LOG_DEBUG << "Do delete all entries."; |
| 3017 | |
| 3018 | auto asyncResp = std::make_shared<AsyncResp>(res); |
| 3019 | // Process response from Logging service. |
| 3020 | auto resp_handler = [asyncResp](const boost::system::error_code ec) { |
| 3021 | BMCWEB_LOG_DEBUG << "doClearLog resp_handler callback: Done"; |
| 3022 | if (ec) |
| 3023 | { |
| 3024 | // TODO Handle for specific error code |
| 3025 | BMCWEB_LOG_ERROR << "doClearLog resp_handler got error " << ec; |
| 3026 | asyncResp->res.result( |
| 3027 | boost::beast::http::status::internal_server_error); |
| 3028 | return; |
| 3029 | } |
| 3030 | |
| 3031 | asyncResp->res.result(boost::beast::http::status::no_content); |
| 3032 | }; |
| 3033 | |
| 3034 | // Make call to Logging service to request Clear Log |
| 3035 | crow::connections::systemBus->async_method_call( |
| 3036 | resp_handler, "xyz.openbmc_project.Logging", |
| 3037 | "/xyz/openbmc_project/logging", |
| 3038 | "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); |
| 3039 | } |
| 3040 | }; |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3041 | |
| 3042 | /**************************************************** |
| 3043 | * Redfish PostCode interfaces |
| 3044 | * using DBUS interface: getPostCodesTS |
| 3045 | ******************************************************/ |
| 3046 | class PostCodesLogService : public Node |
| 3047 | { |
| 3048 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 3049 | PostCodesLogService(App& app) : |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3050 | Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/") |
| 3051 | { |
| 3052 | entityPrivileges = { |
| 3053 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 3054 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 3055 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 3056 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 3057 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 3058 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 3059 | } |
| 3060 | |
| 3061 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 3062 | void doGet(crow::Response& res, const crow::Request&, |
| 3063 | const std::vector<std::string>&) override |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3064 | { |
| 3065 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 3066 | |
| 3067 | asyncResp->res.jsonValue = { |
| 3068 | {"@odata.id", "/redfish/v1/Systems/system/LogServices/PostCodes"}, |
| 3069 | {"@odata.type", "#LogService.v1_1_0.LogService"}, |
| 3070 | {"@odata.context", "/redfish/v1/$metadata#LogService.LogService"}, |
| 3071 | {"Name", "POST Code Log Service"}, |
| 3072 | {"Description", "POST Code Log Service"}, |
| 3073 | {"Id", "BIOS POST Code Log"}, |
| 3074 | {"OverWritePolicy", "WrapsWhenFull"}, |
| 3075 | {"Entries", |
| 3076 | {{"@odata.id", |
| 3077 | "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"}}}}; |
| 3078 | asyncResp->res.jsonValue["Actions"]["#LogService.ClearLog"] = { |
| 3079 | {"target", "/redfish/v1/Systems/system/LogServices/PostCodes/" |
| 3080 | "Actions/LogService.ClearLog"}}; |
| 3081 | } |
| 3082 | }; |
| 3083 | |
| 3084 | class PostCodesClear : public Node |
| 3085 | { |
| 3086 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 3087 | PostCodesClear(App& app) : |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3088 | Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Actions/" |
| 3089 | "LogService.ClearLog/") |
| 3090 | { |
| 3091 | entityPrivileges = { |
| 3092 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 3093 | {boost::beast::http::verb::head, {{"Login"}}}, |
AppaRao Puli | 3946028 | 2020-04-07 17:03:04 +0530 | [diff] [blame] | 3094 | {boost::beast::http::verb::patch, {{"ConfigureComponents"}}}, |
| 3095 | {boost::beast::http::verb::put, {{"ConfigureComponents"}}}, |
| 3096 | {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}}, |
| 3097 | {boost::beast::http::verb::post, {{"ConfigureComponents"}}}}; |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3098 | } |
| 3099 | |
| 3100 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 3101 | void doPost(crow::Response& res, const crow::Request&, |
| 3102 | const std::vector<std::string>&) override |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3103 | { |
| 3104 | BMCWEB_LOG_DEBUG << "Do delete all postcodes entries."; |
| 3105 | |
| 3106 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 3107 | // Make call to post-code service to request clear all |
| 3108 | crow::connections::systemBus->async_method_call( |
| 3109 | [asyncResp](const boost::system::error_code ec) { |
| 3110 | if (ec) |
| 3111 | { |
| 3112 | // TODO Handle for specific error code |
| 3113 | BMCWEB_LOG_ERROR |
| 3114 | << "doClearPostCodes resp_handler got error " << ec; |
| 3115 | asyncResp->res.result( |
| 3116 | boost::beast::http::status::internal_server_error); |
| 3117 | messages::internalError(asyncResp->res); |
| 3118 | return; |
| 3119 | } |
| 3120 | }, |
| 3121 | "xyz.openbmc_project.State.Boot.PostCode", |
| 3122 | "/xyz/openbmc_project/State/Boot/PostCode", |
| 3123 | "xyz.openbmc_project.Collection.DeleteAll", "DeleteAll"); |
| 3124 | } |
| 3125 | }; |
| 3126 | |
| 3127 | static void fillPostCodeEntry( |
| 3128 | std::shared_ptr<AsyncResp> aResp, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 3129 | const boost::container::flat_map<uint64_t, uint64_t>& postcode, |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3130 | const uint16_t bootIndex, const uint64_t codeIndex = 0, |
| 3131 | const uint64_t skip = 0, const uint64_t top = 0) |
| 3132 | { |
| 3133 | // Get the Message from the MessageRegistry |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 3134 | const message_registries::Message* message = |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3135 | message_registries::getMessage("OpenBMC.0.1.BIOSPOSTCode"); |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3136 | |
| 3137 | uint64_t currentCodeIndex = 0; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 3138 | nlohmann::json& logEntryArray = aResp->res.jsonValue["Members"]; |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3139 | |
| 3140 | uint64_t firstCodeTimeUs = 0; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 3141 | for (const std::pair<uint64_t, uint64_t>& code : postcode) |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3142 | { |
| 3143 | currentCodeIndex++; |
| 3144 | std::string postcodeEntryID = |
| 3145 | "B" + std::to_string(bootIndex) + "-" + |
| 3146 | std::to_string(currentCodeIndex); // 1 based index in EntryID string |
| 3147 | |
| 3148 | uint64_t usecSinceEpoch = code.first; |
| 3149 | uint64_t usTimeOffset = 0; |
| 3150 | |
| 3151 | if (1 == currentCodeIndex) |
| 3152 | { // already incremented |
| 3153 | firstCodeTimeUs = code.first; |
| 3154 | } |
| 3155 | else |
| 3156 | { |
| 3157 | usTimeOffset = code.first - firstCodeTimeUs; |
| 3158 | } |
| 3159 | |
| 3160 | // skip if no specific codeIndex is specified and currentCodeIndex does |
| 3161 | // not fall between top and skip |
| 3162 | if ((codeIndex == 0) && |
| 3163 | (currentCodeIndex <= skip || currentCodeIndex > top)) |
| 3164 | { |
| 3165 | continue; |
| 3166 | } |
| 3167 | |
Gunnar Mills | 4e0453b | 2020-07-08 14:00:30 -0500 | [diff] [blame] | 3168 | // skip if a specific codeIndex is specified and does not match the |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3169 | // currentIndex |
| 3170 | if ((codeIndex > 0) && (currentCodeIndex != codeIndex)) |
| 3171 | { |
| 3172 | // This is done for simplicity. 1st entry is needed to calculate |
| 3173 | // time offset. To improve efficiency, one can get to the entry |
| 3174 | // directly (possibly with flatmap's nth method) |
| 3175 | continue; |
| 3176 | } |
| 3177 | |
| 3178 | // currentCodeIndex is within top and skip or equal to specified code |
| 3179 | // index |
| 3180 | |
| 3181 | // Get the Created time from the timestamp |
| 3182 | std::string entryTimeStr; |
Asmitha Karunanithi | 9c620e2 | 2020-08-02 11:55:21 -0500 | [diff] [blame] | 3183 | entryTimeStr = crow::utility::getDateTime( |
| 3184 | static_cast<std::time_t>(usecSinceEpoch / 1000 / 1000)); |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3185 | |
| 3186 | // assemble messageArgs: BootIndex, TimeOffset(100us), PostCode(hex) |
| 3187 | std::ostringstream hexCode; |
| 3188 | hexCode << "0x" << std::setfill('0') << std::setw(2) << std::hex |
| 3189 | << code.second; |
| 3190 | std::ostringstream timeOffsetStr; |
| 3191 | // Set Fixed -Point Notation |
| 3192 | timeOffsetStr << std::fixed; |
| 3193 | // Set precision to 4 digits |
| 3194 | timeOffsetStr << std::setprecision(4); |
| 3195 | // Add double to stream |
| 3196 | timeOffsetStr << static_cast<double>(usTimeOffset) / 1000 / 1000; |
| 3197 | std::vector<std::string> messageArgs = { |
| 3198 | std::to_string(bootIndex), timeOffsetStr.str(), hexCode.str()}; |
| 3199 | |
| 3200 | // Get MessageArgs template from message registry |
| 3201 | std::string msg; |
| 3202 | if (message != nullptr) |
| 3203 | { |
| 3204 | msg = message->message; |
| 3205 | |
| 3206 | // fill in this post code value |
| 3207 | int i = 0; |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 3208 | for (const std::string& messageArg : messageArgs) |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3209 | { |
| 3210 | std::string argStr = "%" + std::to_string(++i); |
| 3211 | size_t argPos = msg.find(argStr); |
| 3212 | if (argPos != std::string::npos) |
| 3213 | { |
| 3214 | msg.replace(argPos, argStr.length(), messageArg); |
| 3215 | } |
| 3216 | } |
| 3217 | } |
| 3218 | |
Tim Lee | d4342a9 | 2020-04-27 11:47:58 +0800 | [diff] [blame] | 3219 | // Get Severity template from message registry |
| 3220 | std::string severity; |
| 3221 | if (message != nullptr) |
| 3222 | { |
| 3223 | severity = message->severity; |
| 3224 | } |
| 3225 | |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3226 | // add to AsyncResp |
| 3227 | logEntryArray.push_back({}); |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 3228 | nlohmann::json& bmcLogEntry = logEntryArray.back(); |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3229 | bmcLogEntry = { |
| 3230 | {"@odata.type", "#LogEntry.v1_4_0.LogEntry"}, |
| 3231 | {"@odata.context", "/redfish/v1/$metadata#LogEntry.LogEntry"}, |
| 3232 | {"@odata.id", "/redfish/v1/Systems/system/LogServices/" |
| 3233 | "PostCodes/Entries/" + |
| 3234 | postcodeEntryID}, |
| 3235 | {"Name", "POST Code Log Entry"}, |
| 3236 | {"Id", postcodeEntryID}, |
| 3237 | {"Message", std::move(msg)}, |
| 3238 | {"MessageId", "OpenBMC.0.1.BIOSPOSTCode"}, |
| 3239 | {"MessageArgs", std::move(messageArgs)}, |
| 3240 | {"EntryType", "Event"}, |
| 3241 | {"Severity", std::move(severity)}, |
Asmitha Karunanithi | 9c620e2 | 2020-08-02 11:55:21 -0500 | [diff] [blame] | 3242 | {"Created", entryTimeStr}}; |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3243 | } |
| 3244 | } |
| 3245 | |
| 3246 | static void getPostCodeForEntry(std::shared_ptr<AsyncResp> aResp, |
| 3247 | const uint16_t bootIndex, |
| 3248 | const uint64_t codeIndex) |
| 3249 | { |
| 3250 | crow::connections::systemBus->async_method_call( |
| 3251 | [aResp, bootIndex, codeIndex]( |
| 3252 | const boost::system::error_code ec, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 3253 | const boost::container::flat_map<uint64_t, uint64_t>& postcode) { |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3254 | if (ec) |
| 3255 | { |
| 3256 | BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; |
| 3257 | messages::internalError(aResp->res); |
| 3258 | return; |
| 3259 | } |
| 3260 | |
| 3261 | // skip the empty postcode boots |
| 3262 | if (postcode.empty()) |
| 3263 | { |
| 3264 | return; |
| 3265 | } |
| 3266 | |
| 3267 | fillPostCodeEntry(aResp, postcode, bootIndex, codeIndex); |
| 3268 | |
| 3269 | aResp->res.jsonValue["Members@odata.count"] = |
| 3270 | aResp->res.jsonValue["Members"].size(); |
| 3271 | }, |
| 3272 | "xyz.openbmc_project.State.Boot.PostCode", |
| 3273 | "/xyz/openbmc_project/State/Boot/PostCode", |
| 3274 | "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", |
| 3275 | bootIndex); |
| 3276 | } |
| 3277 | |
| 3278 | static void getPostCodeForBoot(std::shared_ptr<AsyncResp> aResp, |
| 3279 | const uint16_t bootIndex, |
| 3280 | const uint16_t bootCount, |
| 3281 | const uint64_t entryCount, const uint64_t skip, |
| 3282 | const uint64_t top) |
| 3283 | { |
| 3284 | crow::connections::systemBus->async_method_call( |
| 3285 | [aResp, bootIndex, bootCount, entryCount, skip, |
| 3286 | top](const boost::system::error_code ec, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 3287 | const boost::container::flat_map<uint64_t, uint64_t>& postcode) { |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3288 | if (ec) |
| 3289 | { |
| 3290 | BMCWEB_LOG_DEBUG << "DBUS POST CODE PostCode response error"; |
| 3291 | messages::internalError(aResp->res); |
| 3292 | return; |
| 3293 | } |
| 3294 | |
| 3295 | uint64_t endCount = entryCount; |
| 3296 | if (!postcode.empty()) |
| 3297 | { |
| 3298 | endCount = entryCount + postcode.size(); |
| 3299 | |
| 3300 | if ((skip < endCount) && ((top + skip) > entryCount)) |
| 3301 | { |
| 3302 | uint64_t thisBootSkip = |
| 3303 | std::max(skip, entryCount) - entryCount; |
| 3304 | uint64_t thisBootTop = |
| 3305 | std::min(top + skip, endCount) - entryCount; |
| 3306 | |
| 3307 | fillPostCodeEntry(aResp, postcode, bootIndex, 0, |
| 3308 | thisBootSkip, thisBootTop); |
| 3309 | } |
| 3310 | aResp->res.jsonValue["Members@odata.count"] = endCount; |
| 3311 | } |
| 3312 | |
| 3313 | // continue to previous bootIndex |
| 3314 | if (bootIndex < bootCount) |
| 3315 | { |
| 3316 | getPostCodeForBoot(aResp, static_cast<uint16_t>(bootIndex + 1), |
| 3317 | bootCount, endCount, skip, top); |
| 3318 | } |
| 3319 | else |
| 3320 | { |
| 3321 | aResp->res.jsonValue["Members@odata.nextLink"] = |
| 3322 | "/redfish/v1/Systems/system/LogServices/PostCodes/" |
| 3323 | "Entries?$skip=" + |
| 3324 | std::to_string(skip + top); |
| 3325 | } |
| 3326 | }, |
| 3327 | "xyz.openbmc_project.State.Boot.PostCode", |
| 3328 | "/xyz/openbmc_project/State/Boot/PostCode", |
| 3329 | "xyz.openbmc_project.State.Boot.PostCode", "GetPostCodesWithTimeStamp", |
| 3330 | bootIndex); |
| 3331 | } |
| 3332 | |
| 3333 | static void getCurrentBootNumber(std::shared_ptr<AsyncResp> aResp, |
| 3334 | const uint64_t skip, const uint64_t top) |
| 3335 | { |
| 3336 | uint64_t entryCount = 0; |
| 3337 | crow::connections::systemBus->async_method_call( |
| 3338 | [aResp, entryCount, skip, |
| 3339 | top](const boost::system::error_code ec, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 3340 | const std::variant<uint16_t>& bootCount) { |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3341 | if (ec) |
| 3342 | { |
| 3343 | BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| 3344 | messages::internalError(aResp->res); |
| 3345 | return; |
| 3346 | } |
| 3347 | auto pVal = std::get_if<uint16_t>(&bootCount); |
| 3348 | if (pVal) |
| 3349 | { |
| 3350 | getPostCodeForBoot(aResp, 1, *pVal, entryCount, skip, top); |
| 3351 | } |
| 3352 | else |
| 3353 | { |
| 3354 | BMCWEB_LOG_DEBUG << "Post code boot index failed."; |
| 3355 | } |
| 3356 | }, |
| 3357 | "xyz.openbmc_project.State.Boot.PostCode", |
| 3358 | "/xyz/openbmc_project/State/Boot/PostCode", |
| 3359 | "org.freedesktop.DBus.Properties", "Get", |
| 3360 | "xyz.openbmc_project.State.Boot.PostCode", "CurrentBootCycleCount"); |
| 3361 | } |
| 3362 | |
| 3363 | class PostCodesEntryCollection : public Node |
| 3364 | { |
| 3365 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 3366 | PostCodesEntryCollection(App& app) : |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3367 | Node(app, "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/") |
| 3368 | { |
| 3369 | entityPrivileges = { |
| 3370 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 3371 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 3372 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 3373 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 3374 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 3375 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 3376 | } |
| 3377 | |
| 3378 | private: |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 3379 | void doGet(crow::Response& res, const crow::Request& req, |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 3380 | const std::vector<std::string>&) override |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3381 | { |
| 3382 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 3383 | |
| 3384 | asyncResp->res.jsonValue["@odata.type"] = |
| 3385 | "#LogEntryCollection.LogEntryCollection"; |
| 3386 | asyncResp->res.jsonValue["@odata.context"] = |
| 3387 | "/redfish/v1/" |
| 3388 | "$metadata#LogEntryCollection.LogEntryCollection"; |
| 3389 | asyncResp->res.jsonValue["@odata.id"] = |
| 3390 | "/redfish/v1/Systems/system/LogServices/PostCodes/Entries"; |
| 3391 | asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; |
| 3392 | asyncResp->res.jsonValue["Description"] = |
| 3393 | "Collection of POST Code Log Entries"; |
| 3394 | asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); |
| 3395 | asyncResp->res.jsonValue["Members@odata.count"] = 0; |
| 3396 | |
| 3397 | uint64_t skip = 0; |
| 3398 | uint64_t top = maxEntriesPerPage; // Show max entries by default |
| 3399 | if (!getSkipParam(asyncResp->res, req, skip)) |
| 3400 | { |
| 3401 | return; |
| 3402 | } |
| 3403 | if (!getTopParam(asyncResp->res, req, top)) |
| 3404 | { |
| 3405 | return; |
| 3406 | } |
| 3407 | getCurrentBootNumber(asyncResp, skip, top); |
| 3408 | } |
| 3409 | }; |
| 3410 | |
| 3411 | class PostCodesEntry : public Node |
| 3412 | { |
| 3413 | public: |
Ed Tanous | 52cc112 | 2020-07-18 13:51:21 -0700 | [diff] [blame] | 3414 | PostCodesEntry(App& app) : |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3415 | Node(app, |
| 3416 | "/redfish/v1/Systems/system/LogServices/PostCodes/Entries/<str>/", |
| 3417 | std::string()) |
| 3418 | { |
| 3419 | entityPrivileges = { |
| 3420 | {boost::beast::http::verb::get, {{"Login"}}}, |
| 3421 | {boost::beast::http::verb::head, {{"Login"}}}, |
| 3422 | {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, |
| 3423 | {boost::beast::http::verb::put, {{"ConfigureManager"}}}, |
| 3424 | {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, |
| 3425 | {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; |
| 3426 | } |
| 3427 | |
| 3428 | private: |
Ed Tanous | cb13a39 | 2020-07-25 19:02:03 +0000 | [diff] [blame] | 3429 | void doGet(crow::Response& res, const crow::Request&, |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 3430 | const std::vector<std::string>& params) override |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3431 | { |
| 3432 | std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res); |
| 3433 | if (params.size() != 1) |
| 3434 | { |
| 3435 | messages::internalError(asyncResp->res); |
| 3436 | return; |
| 3437 | } |
| 3438 | |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 3439 | const std::string& targetID = params[0]; |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3440 | |
| 3441 | size_t bootPos = targetID.find('B'); |
| 3442 | if (bootPos == std::string::npos) |
| 3443 | { |
| 3444 | // Requested ID was not found |
| 3445 | messages::resourceMissingAtURI(asyncResp->res, targetID); |
| 3446 | return; |
| 3447 | } |
| 3448 | std::string_view bootIndexStr(targetID); |
| 3449 | bootIndexStr.remove_prefix(bootPos + 1); |
| 3450 | uint16_t bootIndex = 0; |
| 3451 | uint64_t codeIndex = 0; |
| 3452 | size_t dashPos = bootIndexStr.find('-'); |
| 3453 | |
| 3454 | if (dashPos == std::string::npos) |
| 3455 | { |
| 3456 | return; |
| 3457 | } |
| 3458 | std::string_view codeIndexStr(bootIndexStr); |
| 3459 | bootIndexStr.remove_suffix(dashPos); |
| 3460 | codeIndexStr.remove_prefix(dashPos + 1); |
| 3461 | |
| 3462 | bootIndex = static_cast<uint16_t>( |
Ed Tanous | 23a21a1 | 2020-07-25 04:45:05 +0000 | [diff] [blame] | 3463 | strtoul(std::string(bootIndexStr).c_str(), nullptr, 0)); |
| 3464 | codeIndex = strtoul(std::string(codeIndexStr).c_str(), nullptr, 0); |
ZhikuiRen | a3316fc | 2020-01-29 14:58:08 -0800 | [diff] [blame] | 3465 | if (bootIndex == 0 || codeIndex == 0) |
| 3466 | { |
| 3467 | BMCWEB_LOG_DEBUG << "Get Post Code invalid entry string " |
| 3468 | << params[0]; |
| 3469 | } |
| 3470 | |
| 3471 | asyncResp->res.jsonValue["@odata.type"] = "#LogEntry.v1_4_0.LogEntry"; |
| 3472 | asyncResp->res.jsonValue["@odata.context"] = |
| 3473 | "/redfish/v1/$metadata#LogEntry.LogEntry"; |
| 3474 | asyncResp->res.jsonValue["@odata.id"] = |
| 3475 | "/redfish/v1/Systems/system/LogServices/PostCodes/" |
| 3476 | "Entries"; |
| 3477 | asyncResp->res.jsonValue["Name"] = "BIOS POST Code Log Entries"; |
| 3478 | asyncResp->res.jsonValue["Description"] = |
| 3479 | "Collection of POST Code Log Entries"; |
| 3480 | asyncResp->res.jsonValue["Members"] = nlohmann::json::array(); |
| 3481 | asyncResp->res.jsonValue["Members@odata.count"] = 0; |
| 3482 | |
| 3483 | getPostCodeForEntry(asyncResp, bootIndex, codeIndex); |
| 3484 | } |
| 3485 | }; |
| 3486 | |
Ed Tanous | 1da66f7 | 2018-07-27 16:13:37 -0700 | [diff] [blame] | 3487 | } // namespace redfish |