blob: 668e6a92be1cd0b37476bd0bdeb63911f05a9da0 [file] [log] [blame]
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +02001/*
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 <error_messages.hpp>
19#include <utils/json_utils.hpp>
20#include "node.hpp"
21#include "boost/container/flat_map.hpp"
22
23namespace redfish {
24
25/**
26 * SystemAsyncResp
27 * Gathers data needed for response processing after async calls are done
28 */
29class SystemAsyncResp {
30 public:
Ed Tanous55c7b7a2018-05-22 15:27:24 -070031 SystemAsyncResp(crow::Response &response) : res(response) {}
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +020032
33 ~SystemAsyncResp() {
34 if (res.result() != (boost::beast::http::status::ok)) {
35 // Reset the json object to clear out any data that made it in before the
36 // error happened
37 // todo(ed) handle error condition with proper code
Ed Tanous55c7b7a2018-05-22 15:27:24 -070038 res.jsonValue = messages::internalError();
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +020039 }
40 res.end();
41 }
42
43 void setErrorStatus() {
44 res.result(boost::beast::http::status::internal_server_error);
45 }
46
Ed Tanous55c7b7a2018-05-22 15:27:24 -070047 crow::Response &res;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +020048};
49
50/**
51 * OnDemandSystemsProvider
52 * Board provider class that retrieves data directly from dbus, before seting
53 * it into JSON output. This does not cache any data.
54 *
55 * Class can be a good example on how to scale different data providing
56 * solutions to produce single schema output.
57 *
58 * TODO(Pawel)
59 * This perhaps shall be different file, which has to be chosen on compile time
60 * depending on OEM needs
61 */
62class OnDemandSystemsProvider {
63 public:
64 template <typename CallbackFunc>
65 void getBaseboardList(CallbackFunc &&callback) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -070066 BMCWEB_LOG_DEBUG << "Get list of available boards.";
67 crow::connections::systemBus->async_method_call(
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +020068 [callback{std::move(callback)}](const boost::system::error_code ec,
69 const std::vector<std::string> &resp) {
70 // Callback requires vector<string> to retrieve all available board
71 // list.
72 std::vector<std::string> board_list;
73 if (ec) {
74 // Something wrong on DBus, the error_code is not important at this
75 // moment, just return success=false, and empty output. Since size
76 // of vector may vary depending on information from Entity Manager,
77 // and empty output could not be treated same way as error.
78 callback(false, board_list);
79 return;
80 }
Ed Tanous55c7b7a2018-05-22 15:27:24 -070081 BMCWEB_LOG_DEBUG << "Got " << resp.size() << " boards.";
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +020082 // Iterate over all retrieved ObjectPaths.
83 for (const std::string &objpath : resp) {
84 std::size_t last_pos = objpath.rfind("/");
85 if (last_pos != std::string::npos) {
86 board_list.emplace_back(objpath.substr(last_pos + 1));
87 }
88 }
89 // Finally make a callback with useful data
90 callback(true, board_list);
91 },
92 "xyz.openbmc_project.ObjectMapper",
93 "/xyz/openbmc_project/object_mapper",
94 "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
95 "/xyz/openbmc_project/inventory", int32_t(0),
96 std::array<const char *, 1>{
97 "xyz.openbmc_project.Inventory.Item.Board"});
98 };
99
100 /**
101 * @brief Retrieves computer system properties over dbus
102 *
103 * @param[in] aResp Shared pointer for completing asynchronous calls
104 * @param[in] name Computer system name from request
105 *
106 * @return None.
107 */
108 void getComputerSystem(std::shared_ptr<SystemAsyncResp> aResp,
109 const std::string &name) {
110 const std::array<const char *, 5> interfaces = {
111 "xyz.openbmc_project.Inventory.Decorator.Asset",
112 "xyz.openbmc_project.Inventory.Item.Cpu",
113 "xyz.openbmc_project.Inventory.Item.Dimm",
114 "xyz.openbmc_project.Inventory.Item.System",
115 "xyz.openbmc_project.Common.UUID",
116 };
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700117 BMCWEB_LOG_DEBUG << "Get available system components.";
118 crow::connections::systemBus->async_method_call(
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200119 [ name, aResp{std::move(aResp)} ](
120 const boost::system::error_code ec,
121 const std::vector<std::pair<
122 std::string,
123 std::vector<std::pair<std::string, std::vector<std::string>>>>>
124 &subtree) {
125 if (ec) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700126 BMCWEB_LOG_DEBUG << "DBUS response error";
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200127 aResp->setErrorStatus();
128 return;
129 }
130 bool foundName = false;
131 // Iterate over all retrieved ObjectPaths.
132 for (const std::pair<std::string,
133 std::vector<std::pair<std::string,
134 std::vector<std::string>>>>
135 &object : subtree) {
136 const std::string &path = object.first;
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700137 BMCWEB_LOG_DEBUG << "Got path: " << path;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200138 const std::vector<std::pair<std::string, std::vector<std::string>>>
139 &connectionNames = object.second;
140 if (connectionNames.size() < 1) {
141 continue;
142 }
143 // Check if computer system exist
144 if (boost::ends_with(path, name)) {
145 foundName = true;
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700146 BMCWEB_LOG_DEBUG << "Found name: " << name;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200147 const std::string connectionName = connectionNames[0].first;
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700148 crow::connections::systemBus->async_method_call(
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200149 [ aResp, name(std::string(name)) ](
150 const boost::system::error_code ec,
151 const std::vector<std::pair<std::string, VariantType>>
152 &propertiesList) {
153 if (ec) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700154 BMCWEB_LOG_ERROR << "DBUS response error: " << ec;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200155 aResp->setErrorStatus();
156 return;
157 }
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700158 BMCWEB_LOG_DEBUG << "Got " << propertiesList.size()
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200159 << "properties for system";
160 for (const std::pair<std::string, VariantType> &property :
161 propertiesList) {
162 const std::string *value =
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700163 mapbox::getPtr<const std::string>(property.second);
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200164 if (value != nullptr) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700165 aResp->res.jsonValue[property.first] = *value;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200166 }
167 }
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700168 aResp->res.jsonValue["Name"] = name;
169 aResp->res.jsonValue["Id"] =
170 aResp->res.jsonValue["SerialNumber"];
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200171 },
172 connectionName, path, "org.freedesktop.DBus.Properties",
173 "GetAll", "xyz.openbmc_project.Inventory.Decorator.Asset");
174 } else {
175 // This is not system, so check if it's cpu, dimm, UUID or BiosVer
176 for (auto const &s : connectionNames) {
177 for (auto const &i : s.second) {
178 if (boost::ends_with(i, "Dimm")) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700179 BMCWEB_LOG_DEBUG << "Found Dimm, now get it properties.";
180 crow::connections::systemBus->async_method_call(
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200181 [&, aResp](const boost::system::error_code ec,
182 const std::vector<std::pair<
183 std::string, VariantType>> &properties) {
184 if (ec) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700185 BMCWEB_LOG_ERROR << "DBUS response error " << ec;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200186 aResp->setErrorStatus();
187 return;
188 }
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700189 BMCWEB_LOG_DEBUG << "Got " << properties.size()
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200190 << "Dimm properties.";
191 for (const auto &p : properties) {
192 if (p.first == "MemorySize") {
193 const std::string *value =
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700194 mapbox::getPtr<const std::string>(p.second);
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200195 if ((value != nullptr) && (*value != "NULL")) {
196 // Remove units char
197 int32_t unitCoeff;
198 if (boost::ends_with(*value, "MB")) {
199 unitCoeff = 1000;
200 } else if (boost::ends_with(*value, "KB")) {
201 unitCoeff = 1000000;
202 } else {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700203 BMCWEB_LOG_ERROR << "Unsupported memory units";
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200204 aResp->setErrorStatus();
205 return;
206 }
207
208 auto memSize = boost::lexical_cast<int>(
209 value->substr(0, value->length() - 2));
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700210 aResp->res.jsonValue["TotalSystemMemoryGiB"] +=
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200211 memSize * unitCoeff;
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700212 aResp->res.jsonValue["MemorySummary"]["Status"]
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200213 ["State"] = "Enabled";
214 }
215 }
216 }
217 },
218 s.first, path, "org.freedesktop.DBus.Properties",
219 "GetAll", "xyz.openbmc_project.Inventory.Item.Dimm");
220 } else if (boost::ends_with(i, "Cpu")) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700221 BMCWEB_LOG_DEBUG << "Found Cpu, now get it properties.";
222 crow::connections::systemBus->async_method_call(
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200223 [&, aResp](const boost::system::error_code ec,
224 const std::vector<std::pair<
225 std::string, VariantType>> &properties) {
226 if (ec) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700227 BMCWEB_LOG_ERROR << "DBUS response error " << ec;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200228 aResp->setErrorStatus();
229 return;
230 }
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700231 BMCWEB_LOG_DEBUG << "Got " << properties.size()
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200232 << "Cpu properties.";
233 for (const auto &p : properties) {
234 if (p.first == "ProcessorFamily") {
235 const std::string *value =
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700236 mapbox::getPtr<const std::string>(p.second);
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200237 if (value != nullptr) {
238 aResp->res
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700239 .jsonValue["ProcessorSummary"]["Count"] =
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200240 aResp->res
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700241 .jsonValue["ProcessorSummary"]["Count"]
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200242 .get<int>() +
243 1;
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700244 aResp->res.jsonValue["ProcessorSummary"]
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200245 ["Status"]["State"] =
246 "Enabled";
247 aResp->res
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700248 .jsonValue["ProcessorSummary"]["Model"] =
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200249 *value;
250 }
251 }
252 }
253 },
254 s.first, path, "org.freedesktop.DBus.Properties",
255 "GetAll", "xyz.openbmc_project.Inventory.Item.Cpu");
256 } else if (boost::ends_with(i, "UUID")) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700257 BMCWEB_LOG_DEBUG << "Found UUID, now get it properties.";
258 crow::connections::systemBus->async_method_call(
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200259 [aResp](const boost::system::error_code ec,
260 const std::vector<std::pair<
261 std::string, VariantType>> &properties) {
262 if (ec) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700263 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200264 aResp->setErrorStatus();
265 return;
266 }
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700267 BMCWEB_LOG_DEBUG << "Got " << properties.size()
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200268 << "UUID properties.";
269 for (const std::pair<std::string, VariantType> &p :
270 properties) {
271 if (p.first == "BIOSVer") {
272 const std::string *value =
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700273 mapbox::getPtr<const std::string>(p.second);
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200274 if (value != nullptr) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700275 aResp->res.jsonValue["BiosVersion"] = *value;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200276 }
277 }
278 if (p.first == "UUID") {
279 const std::string *value =
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700280 mapbox::getPtr<const std::string>(p.second);
281 BMCWEB_LOG_DEBUG << "UUID = " << *value
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200282 << " length " << value->length();
283 if (value != nullptr) {
284 // Workaround for to short return str in smbios
285 // demo app, 32 bytes are described by spec
286 if (value->length() > 0 &&
287 value->length() < 32) {
288 std::string correctedValue = *value;
289 correctedValue.append(32 - value->length(),
290 '0');
291 value = &correctedValue;
292 } else if (value->length() == 32) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700293 aResp->res.jsonValue["UUID"] =
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200294 value->substr(0, 8) + "-" +
295 value->substr(8, 4) + "-" +
296 value->substr(12, 4) + "-" +
297 value->substr(16, 4) + "-" +
298 value->substr(20, 12);
299 }
300 }
301 }
302 }
303 },
304 s.first, path, "org.freedesktop.DBus.Properties",
305 "GetAll", "xyz.openbmc_project.Common.UUID");
306 }
307 }
308 }
309 }
310 }
311 if (foundName == false) {
312 aResp->setErrorStatus();
313 }
314 },
315 "xyz.openbmc_project.ObjectMapper",
316 "/xyz/openbmc_project/object_mapper",
317 "xyz.openbmc_project.ObjectMapper", "GetSubTree",
318 "/xyz/openbmc_project/inventory", int32_t(0), interfaces);
319 }
320
321 /**
322 * @brief Retrieves identify led group properties over dbus
323 *
324 * @param[in] aResp Shared pointer for completing asynchronous calls.
325 * @param[in] callback Callback for process retrieved data.
326 *
327 * @return None.
328 */
329 template <typename CallbackFunc>
330 void getLedGroupIdentify(std::shared_ptr<SystemAsyncResp> aResp,
331 CallbackFunc &&callback) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700332 BMCWEB_LOG_DEBUG << "Get led groups";
333 crow::connections::systemBus->async_method_call(
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200334 [
335 aResp{std::move(aResp)}, &callback
336 ](const boost::system::error_code &ec, const ManagedObjectsType &resp) {
337 if (ec) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700338 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200339 aResp->setErrorStatus();
340 return;
341 }
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700342 BMCWEB_LOG_DEBUG << "Got " << resp.size() << "led group objects.";
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200343 for (const auto &objPath : resp) {
344 const std::string &path = objPath.first;
345 if (path.rfind("enclosure_identify") != std::string::npos) {
346 for (const auto &interface : objPath.second) {
347 if (interface.first == "xyz.openbmc_project.Led.Group") {
348 for (const auto &property : interface.second) {
349 if (property.first == "Asserted") {
350 const bool *asserted =
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700351 mapbox::getPtr<const bool>(property.second);
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200352 if (nullptr != asserted) {
353 callback(*asserted, aResp);
354 } else {
355 callback(false, aResp);
356 }
357 }
358 }
359 }
360 }
361 }
362 }
363 },
364 "xyz.openbmc_project.LED.GroupManager",
365 "/xyz/openbmc_project/led/groups", "org.freedesktop.DBus.ObjectManager",
366 "GetManagedObjects");
367 }
368
369 template <typename CallbackFunc>
370 void getLedIdentify(std::shared_ptr<SystemAsyncResp> aResp,
371 CallbackFunc &&callback) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700372 BMCWEB_LOG_DEBUG << "Get identify led properties";
373 crow::connections::systemBus->async_method_call(
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200374 [ aResp{std::move(aResp)}, &callback ](
375 const boost::system::error_code ec,
376 const PropertiesType &properties) {
377 if (ec) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700378 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200379 aResp->setErrorStatus();
380 return;
381 }
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700382 BMCWEB_LOG_DEBUG << "Got " << properties.size() << "led properties.";
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200383 std::string output;
384 for (const auto &property : properties) {
385 if (property.first == "State") {
386 const std::string *s =
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700387 mapbox::getPtr<std::string>(property.second);
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200388 if (nullptr != s) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700389 BMCWEB_LOG_DEBUG << "Identify Led State: " << *s;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200390 const auto pos = s->rfind('.');
391 if (pos != std::string::npos) {
392 auto led = s->substr(pos + 1);
393 for (const std::pair<const char *, const char *> &p :
394 std::array<std::pair<const char *, const char *>, 3>{
395 {{"On", "Lit"},
396 {"Blink", "Blinking"},
397 {"Off", "Off"}}}) {
398 if (led == p.first) {
399 output = p.second;
400 }
401 }
402 }
403 }
404 }
405 }
406 callback(output, aResp);
407 },
408 "xyz.openbmc_project.LED.Controller.identify",
409 "/xyz/openbmc_project/led/physical/identify",
410 "org.freedesktop.DBus.Properties", "GetAll",
411 "xyz.openbmc_project.Led.Physical");
412 }
413
414 /**
415 * @brief Retrieves host state properties over dbus
416 *
417 * @param[in] aResp Shared pointer for completing asynchronous calls.
418 *
419 * @return None.
420 */
421 void getHostState(std::shared_ptr<SystemAsyncResp> aResp) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700422 BMCWEB_LOG_DEBUG << "Get host information.";
423 crow::connections::systemBus->async_method_call(
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200424 [aResp{std::move(aResp)}](const boost::system::error_code ec,
425 const PropertiesType &properties) {
426 if (ec) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700427 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200428 aResp->setErrorStatus();
429 return;
430 }
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700431 BMCWEB_LOG_DEBUG << "Got " << properties.size() << "host properties.";
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200432 for (const auto &property : properties) {
433 if (property.first == "CurrentHostState") {
434 const std::string *s =
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700435 mapbox::getPtr<const std::string>(property.second);
436 BMCWEB_LOG_DEBUG << "Host state: " << *s;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200437 if (nullptr != s) {
438 const auto pos = s->rfind('.');
439 if (pos != std::string::npos) {
440 // Verify Host State
441 if (s->substr(pos + 1) == "Running") {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700442 aResp->res.jsonValue["PowerState"] = "On";
443 aResp->res.jsonValue["Status"]["State"] = "Enabled";
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200444 } else {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700445 aResp->res.jsonValue["PowerState"] = "Off";
446 aResp->res.jsonValue["Status"]["State"] = "Disabled";
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200447 }
448 }
449 }
450 }
451 }
452 },
453 "xyz.openbmc_project.State.Host", "/xyz/openbmc_project/state/host0",
454 "org.freedesktop.DBus.Properties", "GetAll",
455 "xyz.openbmc_project.State.Host");
456 }
457};
458
459/**
460 * SystemsCollection derived class for delivering ComputerSystems Collection
461 * Schema
462 */
463class SystemsCollection : public Node {
464 public:
465 SystemsCollection(CrowApp &app) : Node(app, "/redfish/v1/Systems/") {
466 Node::json["@odata.type"] =
467 "#ComputerSystemCollection.ComputerSystemCollection";
468 Node::json["@odata.id"] = "/redfish/v1/Systems";
469 Node::json["@odata.context"] =
470 "/redfish/v1/"
471 "$metadata#ComputerSystemCollection.ComputerSystemCollection";
472 Node::json["Name"] = "Computer System Collection";
473
474 entityPrivileges = {
475 {boost::beast::http::verb::get, {{"Login"}}},
476 {boost::beast::http::verb::head, {{"Login"}}},
477 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
478 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
479 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
480 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
481 }
482
483 private:
484 /**
485 * Functions triggers appropriate requests on DBus
486 */
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700487 void doGet(crow::Response &res, const crow::Request &req,
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200488 const std::vector<std::string> &params) override {
489 // Get board list, and call the below callback for JSON preparation
490 provider.getBaseboardList(
491 [&](const bool &success, const std::vector<std::string> &output) {
492 if (success) {
493 // ... prepare json array with appropriate @odata.id links
494 nlohmann::json boardArray = nlohmann::json::array();
495 for (const std::string &board_item : output) {
496 boardArray.push_back(
497 {{"@odata.id", "/redfish/v1/Systems/" + board_item}});
498 }
499 // Then attach members, count size and return,
500 Node::json["Members"] = boardArray;
501 Node::json["Members@odata.count"] = boardArray.size();
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700502 res.jsonValue = Node::json;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200503 } else {
504 // ... otherwise, return INTERNALL ERROR
505 res.result(boost::beast::http::status::internal_server_error);
506 }
507 res.end();
508 });
509 }
510
511 OnDemandSystemsProvider provider;
512};
513
514/**
515 * Systems override class for delivering ComputerSystems Schema
516 */
517class Systems : public Node {
518 public:
519 /*
520 * Default Constructor
521 */
522 Systems(CrowApp &app)
523 : Node(app, "/redfish/v1/Systems/<str>/", std::string()) {
524 Node::json["@odata.type"] = "#ComputerSystem.v1_3_0.ComputerSystem";
525 Node::json["@odata.context"] =
526 "/redfish/v1/$metadata#ComputerSystem.ComputerSystem";
527 Node::json["SystemType"] = "Physical";
528 Node::json["Description"] = "Computer System";
529 Node::json["Boot"]["BootSourceOverrideEnabled"] =
530 "Disabled"; // TODO(Dawid), get real boot data
531 Node::json["Boot"]["BootSourceOverrideTarget"] =
532 "None"; // TODO(Dawid), get real boot data
533 Node::json["Boot"]["BootSourceOverrideMode"] =
534 "Legacy"; // TODO(Dawid), get real boot data
535 Node::json["Boot"]["BootSourceOverrideTarget@Redfish.AllowableValues"] = {
536 "None", "Pxe", "Hdd", "Cd",
537 "BiosSetup", "UefiShell", "Usb"}; // TODO(Dawid), get real boot data
538 Node::json["ProcessorSummary"]["Count"] = int(0);
539 Node::json["ProcessorSummary"]["Status"]["State"] = "Disabled";
540 Node::json["MemorySummary"]["TotalSystemMemoryGiB"] = int(0);
541 Node::json["MemorySummary"]["Status"]["State"] = "Disabled";
542
543 entityPrivileges = {
544 {boost::beast::http::verb::get, {{"Login"}}},
545 {boost::beast::http::verb::head, {{"Login"}}},
546 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
547 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
548 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
549 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
550 }
551
552 private:
553 OnDemandSystemsProvider provider;
554
555 /**
556 * Functions triggers appropriate requests on DBus
557 */
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700558 void doGet(crow::Response &res, const crow::Request &req,
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200559 const std::vector<std::string> &params) override {
560 // Check if there is required param, truly entering this shall be
561 // impossible
562 if (params.size() != 1) {
563 res.result(boost::beast::http::status::internal_server_error);
564 res.end();
565 return;
566 }
567
568 const std::string &name = params[0];
569
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700570 res.jsonValue = Node::json;
571 res.jsonValue["@odata.id"] = "/redfish/v1/Systems/" + name;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200572
573 auto asyncResp = std::make_shared<SystemAsyncResp>(res);
574
575 provider.getLedGroupIdentify(
576 asyncResp, [&](const bool &asserted,
577 const std::shared_ptr<SystemAsyncResp> &aResp) {
578 if (asserted) {
579 // If led group is asserted, then another call is needed to
580 // get led status
581 provider.getLedIdentify(
582 aResp, [](const std::string &ledStatus,
583 const std::shared_ptr<SystemAsyncResp> &aResp) {
584 if (!ledStatus.empty()) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700585 aResp->res.jsonValue["IndicatorLED"] = ledStatus;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200586 }
587 });
588 } else {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700589 aResp->res.jsonValue["IndicatorLED"] = "Off";
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200590 }
591 });
592 provider.getComputerSystem(asyncResp, name);
593 provider.getHostState(asyncResp);
594 }
595
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700596 void doPatch(crow::Response &res, const crow::Request &req,
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200597 const std::vector<std::string> &params) override {
598 // Check if there is required param, truly entering this shall be
599 // impossible
600 if (params.size() != 1) {
601 res.result(boost::beast::http::status::internal_server_error);
602 res.end();
603 return;
604 }
605 // Parse JSON request body
606 nlohmann::json patch;
607 if (!json_util::processJsonFromRequest(res, req, patch)) {
608 return;
609 }
610 // Find key with new led value
611 const std::string &name = params[0];
612 const std::string *reqLedState = nullptr;
613 json_util::Result r = json_util::getString(
614 "IndicatorLED", patch, reqLedState,
615 static_cast<int>(json_util::MessageSetting::TYPE_ERROR) |
616 static_cast<int>(json_util::MessageSetting::MISSING),
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700617 res.jsonValue, std::string("/" + name + "/IndicatorLED"));
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200618 if ((r != json_util::Result::SUCCESS) || (reqLedState == nullptr)) {
619 res.result(boost::beast::http::status::bad_request);
620 res.end();
621 return;
622 }
623 // Verify key value
624 std::string dbusLedState;
625 for (const auto &p : boost::container::flat_map<const char *, const char *>{
626 {"On", "Lit"}, {"Blink", "Blinking"}, {"Off", "Off"}}) {
627 if (*reqLedState == p.second) {
628 dbusLedState = p.first;
629 }
630 }
631
632 // Update led status
633 auto asyncResp = std::make_shared<SystemAsyncResp>(res);
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700634 res.jsonValue = Node::json;
635 res.jsonValue["@odata.id"] = "/redfish/v1/Systems/" + name;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200636
637 provider.getHostState(asyncResp);
638 provider.getComputerSystem(asyncResp, name);
639
640 if (dbusLedState.empty()) {
641 messages::addMessageToJsonRoot(
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700642 res.jsonValue,
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200643 messages::propertyValueNotInList(*reqLedState, "IndicatorLED"));
644 } else {
645 // Update led group
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700646 BMCWEB_LOG_DEBUG << "Update led group.";
647 crow::connections::systemBus->async_method_call(
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200648 [&, asyncResp{std::move(asyncResp)} ](
649 const boost::system::error_code ec) {
650 if (ec) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700651 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200652 asyncResp->setErrorStatus();
653 return;
654 }
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700655 BMCWEB_LOG_DEBUG << "Led group update done.";
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200656 },
657 "xyz.openbmc_project.LED.GroupManager",
658 "/xyz/openbmc_project/led/groups/enclosure_identify",
659 "org.freedesktop.DBus.Properties", "Set",
660 "xyz.openbmc_project.Led.Group", "Asserted",
661 sdbusplus::message::variant<bool>(
662 (dbusLedState == "Off" ? false : true)));
663 // Update identify led status
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700664 BMCWEB_LOG_DEBUG << "Update led SoftwareInventoryCollection.";
665 crow::connections::systemBus->async_method_call(
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200666 [&, asyncResp{std::move(asyncResp)} ](
667 const boost::system::error_code ec) {
668 if (ec) {
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700669 BMCWEB_LOG_DEBUG << "DBUS response error " << ec;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200670 asyncResp->setErrorStatus();
671 return;
672 }
Ed Tanous55c7b7a2018-05-22 15:27:24 -0700673 BMCWEB_LOG_DEBUG << "Led state update done.";
674 res.jsonValue["IndicatorLED"] = *reqLedState;
Lewanczyk, Dawidc5b2abe2018-05-30 16:59:42 +0200675 },
676 "xyz.openbmc_project.LED.Controller.identify",
677 "/xyz/openbmc_project/led/physical/identify",
678 "org.freedesktop.DBus.Properties", "Set",
679 "xyz.openbmc_project.Led.Physical", "State",
680 sdbusplus::message::variant<std::string>(
681 "xyz.openbmc_project.Led.Physical.Action." + dbusLedState));
682 }
683 }
684};
685} // namespace redfish