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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
|
From 5512b7bcdb691133d0321779f7d20f5cc1eb3188 Mon Sep 17 00:00:00 2001
From: Przemyslaw Czarnowski <przemyslaw.hawrylewicz.czarnowski@intel.com>
Date: Mon, 7 Mar 2022 19:22:18 +0100
Subject: [PATCH] Apply async dbus API
In order to support new asynchronous dbus API for Virtual Media generic
listener for signals has been introduced.
Using AsynsResp object lifetime expanded by listener waiting for signal
response is passed to user once signal arrives.
This patch covers mounting legacy mode and unmounting both legacy and
proxy mode.
Tested:
Manually in companion with updated service signal is catched and redfish
releases connection with appropriate reply
Signed-off-by: Przemyslaw Czarnowski <przemyslaw.hawrylewicz.czarnowski@intel.com>
---
redfish-core/lib/virtual_media.hpp | 203 ++++++++++++++++++++++++-----
1 file changed, 174 insertions(+), 29 deletions(-)
diff --git a/redfish-core/lib/virtual_media.hpp b/redfish-core/lib/virtual_media.hpp
index 8da40eea..e6ee2b6a 100644
--- a/redfish-core/lib/virtual_media.hpp
+++ b/redfish-core/lib/virtual_media.hpp
@@ -15,10 +15,18 @@
*/
#pragma once
+#include "logging.hpp"
+
#include <app.hpp>
+#include <async_resp.hpp>
+#include <boost/asio/error.hpp>
+#include <boost/asio/io_context.hpp>
+#include <boost/asio/steady_timer.hpp>
#include <boost/container/flat_map.hpp>
#include <boost/process/async_pipe.hpp>
#include <boost/type_traits/has_dereference.hpp>
+#include <dbus_singleton.hpp>
+#include <sdbusplus/bus/match.hpp>
#include <sdbusplus/message/native_types.hpp>
#include <utils/json_utils.hpp>
// for GetObjectType and ManagedObjectType
@@ -28,10 +36,24 @@
#include <registries/privilege_registry.hpp>
#include <chrono>
+#include <memory>
+#include <optional>
namespace redfish
{
+const char* legacyMode = "Legacy";
+const char* proxyMode = "Proxy";
+
+std::string getModeName(bool isLegacy)
+{
+ if (isLegacy)
+ {
+ return legacyMode;
+ }
+ return proxyMode;
+}
+
/**
* @brief Function parses getManagedObject response, finds item, makes generic
* validation and invokes callback handler on this item.
@@ -109,6 +131,7 @@ void findItemAndRunHandler(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
if (handler(service, aResp, item) == true)
{
+
return;
}
}
@@ -382,7 +405,7 @@ inline void getVmData(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
actionsId += "/Actions";
// Check if dbus path is Legacy type
- if (mode.filename() == "Legacy")
+ if (mode.filename() == legacyMode)
{
aResp->res.jsonValue["Actions"]["#VirtualMedia.InsertMedia"]
["target"] =
@@ -760,6 +783,111 @@ class Pipe
Buffer buffer;
};
+/**
+ * @brief holder for dbus signal matchers
+ */
+struct MatchWrapper
+{
+ void stop()
+ {
+ timer->cancel();
+ matcher = std::nullopt;
+ }
+
+ ~MatchWrapper()
+ {
+ BMCWEB_LOG_DEBUG << "~MatchWrapper()";
+ };
+ std::optional<sdbusplus::bus::match::match> matcher{};
+ std::optional<boost::asio::steady_timer> timer;
+};
+
+/**
+ * @brief Function starts waiting for signal completion
+ */
+static inline std::shared_ptr<MatchWrapper>
+ doListenForCompletion(const std::string& name,
+ const std::string& objectPath,
+ const std::string& action, bool legacy,
+ std::shared_ptr<bmcweb::AsyncResp> asyncResp)
+{
+ BMCWEB_LOG_DEBUG << "Start Listening for completion : " << action;
+ std::string matcherString = sdbusplus::bus::match::rules::type::signal();
+
+ std::string interface =
+ std::string("xyz.openbmc_project.VirtualMedia.") + getModeName(legacy);
+
+ matcherString += sdbusplus::bus::match::rules::interface(interface);
+ matcherString += sdbusplus::bus::match::rules::member("Completion");
+ matcherString += sdbusplus::bus::match::rules::sender(
+ "xyz.openbmc_project.VirtualMedia");
+ matcherString += sdbusplus::bus::match::rules::path(objectPath);
+
+ auto matchWrapper = std::make_shared<MatchWrapper>();
+ auto matchHandler = [asyncResp = std::move(asyncResp), name, action,
+ objectPath,
+ matchWrapper](sdbusplus::message::message& m) {
+ int errorCode;
+ try
+ {
+ BMCWEB_LOG_INFO << "Completion signal from " << m.get_path()
+ << " has been received";
+
+ m.read(errorCode);
+ switch (errorCode)
+ {
+ case 0: // success
+ BMCWEB_LOG_INFO << "Signal received: Success";
+ messages::success(asyncResp->res);
+ break;
+ case EPERM:
+ BMCWEB_LOG_ERROR << "Signal received: EPERM";
+ messages::accessDenied(
+ asyncResp->res, crow::utility::urlFromPieces(action));
+ break;
+ case EBUSY:
+ BMCWEB_LOG_ERROR << "Signal received: EAGAIN";
+ messages::resourceInUse(asyncResp->res);
+ break;
+ default:
+ BMCWEB_LOG_ERROR << "Signal received: Other: " << errorCode;
+ messages::operationFailed(asyncResp->res);
+ break;
+ };
+ }
+ catch (sdbusplus::exception::SdBusError& e)
+ {
+ BMCWEB_LOG_ERROR << e.what();
+ };
+ // postpone matcher deletion after callback finishes
+ boost::asio::post(crow::connections::systemBus->get_io_context(),
+ [name, matchWrapper = matchWrapper]()
+
+ {
+ BMCWEB_LOG_DEBUG << "Removing matcher for "
+ << name << " node.";
+ matchWrapper->stop();
+ });
+ };
+ matchWrapper->timer.emplace(crow::connections::systemBus->get_io_context());
+
+ // Safety valve. Clean itself after 3 minutes without signal
+ matchWrapper->timer->expires_after(std::chrono::minutes(3));
+ matchWrapper->timer->async_wait(
+ [matchWrapper](const boost::system::error_code& ec) {
+ if (ec != boost::asio::error::operation_aborted)
+ {
+ BMCWEB_LOG_DEBUG << "Timer expired! Signal did not come";
+ matchWrapper->matcher = std::nullopt;
+ return;
+ }
+ });
+
+ matchWrapper->matcher.emplace(*crow::connections::systemBus, matcherString,
+ matchHandler);
+ return matchWrapper;
+}
+
/**
* @brief Function transceives data with dbus directly.
*
@@ -835,9 +963,15 @@ inline void doMountVmLegacy(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
return;
}
+ const std::string objectPath =
+ "/xyz/openbmc_project/VirtualMedia/Legacy/" + name;
+ const std::string action = "VirtualMedia.Insert";
+ auto wrapper = doListenForCompletion(name, objectPath, action, true,
+ asyncResp);
+
crow::connections::systemBus->async_method_call_timed(
- [asyncResp, secretPipe](const boost::system::error_code ec,
- bool success) {
+ [asyncResp, secretPipe, name, action, wrapper,
+ objectPath](const boost::system::error_code ec, bool success) {
if (ec)
{
BMCWEB_LOG_ERROR << "Bad D-Bus request error: " << ec;
@@ -847,24 +981,25 @@ inline void doMountVmLegacy(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
}
else if (ec == boost::system::errc::permission_denied)
{
- messages::accessDenied(asyncResp->res,
- crow::utility::urlFromPieces(
- "VirtualMedia.Insert"));
+ messages::accessDenied(
+ asyncResp->res,
+ crow::utility::urlFromPieces(action));
}
else
{
messages::internalError(asyncResp->res);
}
+ wrapper->stop();
}
else if (!success)
{
BMCWEB_LOG_ERROR << "Service responded with error ";
- messages::generalError(asyncResp->res);
+ messages::operationFailed(asyncResp->res);
+ wrapper->stop();
}
},
- service, "/xyz/openbmc_project/VirtualMedia/Legacy/" + name,
- "xyz.openbmc_project.VirtualMedia.Legacy", "Mount", *timeout,
- imageUrl, rw, unixFd);
+ service, objectPath, "xyz.openbmc_project.VirtualMedia.Legacy",
+ "Mount", *timeout, imageUrl, rw, unixFd);
},
service, "/xyz/openbmc_project/VirtualMedia/Legacy/" + name,
"org.freedesktop.DBus.Properties", "Get",
@@ -876,17 +1011,17 @@ inline void doMountVmLegacy(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
*
* All BMC state properties will be retrieved before sending reset request.
*/
-inline void doVmAction(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
- const std::string& service, const std::string& name,
- bool legacy)
+inline void doEjectAction(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
+ const std::string& service, const std::string& name,
+ bool legacy)
{
- const std::string vmMode = legacy ? "Legacy" : "Proxy";
+ const std::string vmMode = getModeName(legacy);
const std::string objectPath =
"/xyz/openbmc_project/VirtualMedia/" + vmMode + "/" + name;
const std::string ifaceName = "xyz.openbmc_project.VirtualMedia." + vmMode;
crow::connections::systemBus->async_method_call(
- [asyncResp, service, name, objectPath,
+ [asyncResp, service, name, objectPath, legacy,
ifaceName](const boost::system::error_code ec,
const std::variant<int> timeoutProperty) {
if (ec)
@@ -903,8 +1038,12 @@ inline void doVmAction(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
messages::internalError(asyncResp->res);
return;
}
+ std::string action = "VirtualMedia.Eject";
+ auto wrapper = doListenForCompletion(name, objectPath, action,
+ legacy, asyncResp);
crow::connections::systemBus->async_method_call_timed(
- [asyncResp](const boost::system::error_code ec) {
+ [asyncResp, name, action, objectPath,
+ wrapper](const boost::system::error_code ec, bool success) {
if (ec)
{
BMCWEB_LOG_ERROR << "Bad D-Bus request error: " << ec;
@@ -914,15 +1053,20 @@ inline void doVmAction(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
}
else if (ec == boost::system::errc::permission_denied)
{
- messages::accessDenied(asyncResp->res,
- crow::utility::urlFromPieces(
- "VirtualMedia.Insert"));
+ messages::accessDenied(
+ asyncResp->res,
+ crow::utility::urlFromPieces(action));
}
else
{
messages::internalError(asyncResp->res);
}
- return;
+ wrapper->stop();
+ }
+ else if (!success)
+ {
+ messages::operationFailed(asyncResp->res);
+ wrapper->stop();
}
},
service, objectPath, ifaceName, "Unmount", *timeout);
@@ -951,7 +1095,7 @@ inline void requestNBDVirtualMediaRoutes(App& app)
auto mode = item.first.parent_path();
auto type = mode.parent_path();
// Check if dbus path is Legacy type
- if (mode.filename() == "Legacy")
+ if (mode.filename() == legacyMode)
{
BMCWEB_LOG_DEBUG << "InsertMedia only allowed "
"with POST method "
@@ -961,7 +1105,7 @@ inline void requestNBDVirtualMediaRoutes(App& app)
return true;
}
// Check if dbus path is Proxy type
- if (mode.filename() == "Proxy")
+ if (mode.filename() == proxyMode)
{
// Not possible in proxy mode
BMCWEB_LOG_DEBUG << "InsertMedia not "
@@ -1019,7 +1163,7 @@ inline void requestNBDVirtualMediaRoutes(App& app)
dbus::utility::DBusInteracesMap>& item) {
auto mode = item.first.parent_path();
auto type = mode.parent_path();
- if (mode.filename() == "Proxy")
+ if (mode.filename() == proxyMode)
{
// Not possible in proxy mode
BMCWEB_LOG_DEBUG << "InsertMedia not "
@@ -1131,20 +1275,21 @@ inline void requestNBDVirtualMediaRoutes(App& app)
if (path.substr(lastIndex) == resName)
{
- lastIndex = path.rfind("Proxy");
+ lastIndex = path.rfind(proxyMode);
if (lastIndex != std::string::npos)
{
// Proxy mode
- doVmAction(asyncResp, service,
- resName, false);
+ doEjectAction(asyncResp, service,
+ resName, false);
}
- lastIndex = path.rfind("Legacy");
+ lastIndex = path.rfind(legacyMode);
+
if (lastIndex != std::string::npos)
{
// Legacy mode
- doVmAction(asyncResp, service,
- resName, true);
+ doEjectAction(asyncResp, service,
+ resName, true);
}
return;
--
2.25.1
|
