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
|
#pragma once
#include <http_client.hpp>
namespace redfish
{
class RedfishAggregator
{
private:
const std::string retryPolicyName = "RedfishAggregation";
const uint32_t retryAttempts = 5;
const uint32_t retryTimeoutInterval = 0;
RedfishAggregator()
{
getSatelliteConfigs(constructorCallback);
// Setup the retry policy to be used by Redfish Aggregation
crow::HttpClient::getInstance().setRetryConfig(
retryAttempts, retryTimeoutInterval, aggregationRetryHandler,
retryPolicyName);
}
static inline boost::system::error_code
aggregationRetryHandler(unsigned int respCode)
{
// As a default, assume 200X is alright.
// We don't need to retry on a 404
if ((respCode < 200) || ((respCode >= 300) && (respCode != 404)))
{
return boost::system::errc::make_error_code(
boost::system::errc::result_out_of_range);
}
// Return 0 if the response code is valid
return boost::system::errc::make_error_code(
boost::system::errc::success);
}
// Dummy callback used by the Constructor so that it can report the number
// of satellite configs when the class is first created
static void constructorCallback(
const std::unordered_map<std::string, boost::urls::url>& satelliteInfo)
{
BMCWEB_LOG_DEBUG << "There were "
<< std::to_string(satelliteInfo.size())
<< " satellite configs found at startup";
}
// Polls D-Bus to get all available satellite config information
// Expects a handler which interacts with the returned configs
static void getSatelliteConfigs(
const std::function<void(
const std::unordered_map<std::string, boost::urls::url>&)>& handler)
{
BMCWEB_LOG_DEBUG << "Gathering satellite configs";
crow::connections::systemBus->async_method_call(
[handler](const boost::system::error_code ec,
const dbus::utility::ManagedObjectType& objects) {
if (ec)
{
BMCWEB_LOG_ERROR << "DBUS response error " << ec.value() << ", "
<< ec.message();
return;
}
// Maps a chosen alias representing a satellite BMC to a url
// containing the information required to create a http
// connection to the satellite
std::unordered_map<std::string, boost::urls::url> satelliteInfo;
findSatelliteConfigs(objects, satelliteInfo);
if (!satelliteInfo.empty())
{
BMCWEB_LOG_DEBUG << "Redfish Aggregation enabled with "
<< std::to_string(satelliteInfo.size())
<< " satellite BMCs";
}
else
{
BMCWEB_LOG_DEBUG
<< "No satellite BMCs detected. Redfish Aggregation not enabled";
}
handler(satelliteInfo);
},
"xyz.openbmc_project.EntityManager", "/",
"org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
}
// Search D-Bus objects for satellite config objects and add their
// information if valid
static void findSatelliteConfigs(
const dbus::utility::ManagedObjectType& objects,
std::unordered_map<std::string, boost::urls::url>& satelliteInfo)
{
for (const auto& objectPath : objects)
{
for (const auto& interface : objectPath.second)
{
if (interface.first ==
"xyz.openbmc_project.Configuration.SatelliteController")
{
BMCWEB_LOG_DEBUG << "Found Satellite Controller at "
<< objectPath.first.str;
addSatelliteConfig(interface.second, satelliteInfo);
}
}
}
}
// Parse the properties of a satellite config object and add the
// configuration if the properties are valid
static void addSatelliteConfig(
const dbus::utility::DBusPropertiesMap& properties,
std::unordered_map<std::string, boost::urls::url>& satelliteInfo)
{
boost::urls::url url;
std::string name;
for (const auto& prop : properties)
{
if (prop.first == "Name")
{
const std::string* propVal =
std::get_if<std::string>(&prop.second);
if (propVal == nullptr)
{
BMCWEB_LOG_ERROR << "Invalid Name value";
return;
}
// The IDs will become <Name>_<ID> so the name should not
// contain a '_'
if (propVal->find('_') != std::string::npos)
{
BMCWEB_LOG_ERROR << "Name cannot contain a \"_\"";
return;
}
name = *propVal;
}
else if (prop.first == "Hostname")
{
const std::string* propVal =
std::get_if<std::string>(&prop.second);
if (propVal == nullptr)
{
BMCWEB_LOG_ERROR << "Invalid Hostname value";
return;
}
url.set_host(*propVal);
}
else if (prop.first == "Port")
{
const uint64_t* propVal = std::get_if<uint64_t>(&prop.second);
if (propVal == nullptr)
{
BMCWEB_LOG_ERROR << "Invalid Port value";
return;
}
if (*propVal > std::numeric_limits<uint16_t>::max())
{
BMCWEB_LOG_ERROR << "Port value out of range";
return;
}
url.set_port(static_cast<uint16_t>(*propVal));
}
else if (prop.first == "AuthType")
{
const std::string* propVal =
std::get_if<std::string>(&prop.second);
if (propVal == nullptr)
{
BMCWEB_LOG_ERROR << "Invalid AuthType value";
return;
}
// For now assume authentication not required to communicate
// with the satellite BMC
if (*propVal != "None")
{
BMCWEB_LOG_ERROR
<< "Unsupported AuthType value: " << *propVal
<< ", only \"none\" is supported";
return;
}
url.set_scheme("http");
}
} // Finished reading properties
// Make sure all required config information was made available
if (name.empty())
{
BMCWEB_LOG_ERROR << "Satellite config missing Name";
return;
}
if (url.host().empty())
{
BMCWEB_LOG_ERROR << "Satellite config " << name << " missing Host";
return;
}
if (!url.has_port())
{
BMCWEB_LOG_ERROR << "Satellite config " << name << " missing Port";
return;
}
if (!url.has_scheme())
{
BMCWEB_LOG_ERROR << "Satellite config " << name
<< " missing AuthType";
return;
}
std::string resultString;
auto result = satelliteInfo.insert_or_assign(name, std::move(url));
if (result.second)
{
resultString = "Added new satellite config ";
}
else
{
resultString = "Updated existing satellite config ";
}
BMCWEB_LOG_DEBUG << resultString << name << " at "
<< result.first->second.scheme() << "://"
<< result.first->second.encoded_host_and_port();
}
public:
RedfishAggregator(const RedfishAggregator&) = delete;
RedfishAggregator& operator=(const RedfishAggregator&) = delete;
RedfishAggregator(RedfishAggregator&&) = delete;
RedfishAggregator& operator=(RedfishAggregator&&) = delete;
~RedfishAggregator() = default;
static RedfishAggregator& getInstance()
{
static RedfishAggregator handler;
return handler;
}
};
} // namespace redfish
|
