1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
/*
// Copyright (c) 2019 Intel Corporation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
*/
#pragma once
#include "app.hpp"
#include "async_resp.hpp"
#include "dbus_singleton.hpp"
#include "dbus_utility.hpp"
#include <nlohmann/json.hpp>
#include <array>
#include <string_view>
#include <variant>
namespace redfish
{
struct HealthPopulate : std::enable_shared_from_this<HealthPopulate>
{
// By default populate status to "/Status" of |asyncResp->res.jsonValue|.
explicit HealthPopulate(
const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn) :
asyncResp(asyncRespIn),
statusPtr("/Status")
{}
// Takes a JSON pointer rather than a reference. This is pretty useful when
// the address of the status JSON might change, for example, elements in an
// array.
HealthPopulate(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
const nlohmann::json::json_pointer& ptr) :
asyncResp(asyncRespIn),
statusPtr(ptr)
{}
HealthPopulate(const HealthPopulate&) = delete;
HealthPopulate(HealthPopulate&&) = delete;
HealthPopulate& operator=(const HealthPopulate&) = delete;
HealthPopulate& operator=(const HealthPopulate&&) = delete;
~HealthPopulate()
{
nlohmann::json& jsonStatus = asyncResp->res.jsonValue[statusPtr];
nlohmann::json& health = jsonStatus["Health"];
nlohmann::json& rollup = jsonStatus["HealthRollup"];
health = "OK";
rollup = "OK";
for (const std::shared_ptr<HealthPopulate>& healthChild : children)
{
healthChild->globalInventoryPath = globalInventoryPath;
healthChild->statuses = statuses;
}
for (const auto& [path, interfaces] : statuses)
{
bool isSelf = false;
if (selfPath)
{
if (boost::equals(path.str, *selfPath) ||
path.str.starts_with(*selfPath + "/"))
{
isSelf = true;
}
}
// managers inventory is all the inventory, don't skip any
if (!isManagersHealth && !isSelf)
{
// We only want to look at this association if either the path
// of this association is an inventory item, or one of the
// endpoints in this association is a child
bool isChild = false;
for (const std::string& child : inventory)
{
if (path.str.starts_with(child))
{
isChild = true;
break;
}
}
if (!isChild)
{
for (const auto& [interface, association] : interfaces)
{
if (interface != "xyz.openbmc_project.Association")
{
continue;
}
for (const auto& [name, value] : association)
{
if (name != "endpoints")
{
continue;
}
const std::vector<std::string>* endpoints =
std::get_if<std::vector<std::string>>(&value);
if (endpoints == nullptr)
{
BMCWEB_LOG_ERROR << "Illegal association at "
<< path.str;
continue;
}
bool containsChild = false;
for (const std::string& endpoint : *endpoints)
{
if (std::find(inventory.begin(),
inventory.end(),
endpoint) != inventory.end())
{
containsChild = true;
break;
}
}
if (!containsChild)
{
continue;
}
}
}
}
}
if (path.str.starts_with(globalInventoryPath) &&
path.str.ends_with("critical"))
{
health = "Critical";
rollup = "Critical";
return;
}
if (path.str.starts_with(globalInventoryPath) &&
path.str.ends_with("warning"))
{
health = "Warning";
if (rollup != "Critical")
{
rollup = "Warning";
}
}
else if (path.str.ends_with("critical"))
{
rollup = "Critical";
if (isSelf)
{
health = "Critical";
return;
}
}
else if (path.str.ends_with("warning"))
{
if (rollup != "Critical")
{
rollup = "Warning";
}
if (isSelf)
{
health = "Warning";
}
}
}
}
// this should only be called once per url, others should get updated by
// being added as children to the 'main' health object for the page
void populate()
{
if (populated)
{
return;
}
populated = true;
getAllStatusAssociations();
getGlobalPath();
}
void getGlobalPath()
{
constexpr std::array<std::string_view, 1> interfaces = {
"xyz.openbmc_project.Inventory.Item.Global"};
std::shared_ptr<HealthPopulate> self = shared_from_this();
dbus::utility::getSubTreePaths(
"/", 0, interfaces,
[self](const boost::system::error_code& ec,
const dbus::utility::MapperGetSubTreePathsResponse& resp) {
if (ec || resp.size() != 1)
{
// no global item, or too many
return;
}
self->globalInventoryPath = resp[0];
});
}
void getAllStatusAssociations()
{
std::shared_ptr<HealthPopulate> self = shared_from_this();
sdbusplus::message::object_path path("/");
dbus::utility::getManagedObjects(
"xyz.openbmc_project.ObjectMapper", path,
[self](const boost::system::error_code& ec,
const dbus::utility::ManagedObjectType& resp) {
if (ec)
{
return;
}
self->statuses = resp;
for (auto it = self->statuses.begin(); it != self->statuses.end();)
{
if (it->first.str.ends_with("critical") ||
it->first.str.ends_with("warning"))
{
it++;
continue;
}
it = self->statuses.erase(it);
}
});
}
std::shared_ptr<bmcweb::AsyncResp> asyncResp;
// Will populate the health status into |asyncResp_json[statusPtr]|
nlohmann::json::json_pointer statusPtr;
// we store pointers to other HealthPopulate items so we can update their
// members and reduce dbus calls. As we hold a shared_ptr to them, they get
// destroyed last, and they need not call populate()
std::vector<std::shared_ptr<HealthPopulate>> children;
// self is used if health is for an individual items status, as this is the
// 'lowest most' item, the rollup will equal the health
std::optional<std::string> selfPath;
std::vector<std::string> inventory;
bool isManagersHealth = false;
dbus::utility::ManagedObjectType statuses;
std::string globalInventoryPath = "-"; // default to illegal dbus path
bool populated = false;
};
} // namespace redfish
|
