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
|
#pragma once
#include "events.hpp"
#include "functor.hpp"
#include "interface_ops.hpp"
#include "serialize.hpp"
#include "types.hpp"
#include <any>
#include <map>
#include <memory>
#include <sdbusplus/server.hpp>
#include <string>
#include <vector>
#include <xyz/openbmc_project/Inventory/Manager/server.hpp>
namespace sdbusplus
{
namespace bus
{
class bus;
}
} // namespace sdbusplus
namespace phosphor
{
namespace inventory
{
namespace manager
{
template <typename T>
using ServerObject = T;
using ManagerIface =
sdbusplus::xyz::openbmc_project::Inventory::server::Manager;
/** @class Manager
* @brief OpenBMC inventory manager implementation.
*
* A concrete implementation for the xyz.openbmc_project.Inventory.Manager
* DBus API.
*/
class Manager final : public ServerObject<ManagerIface>
{
public:
Manager() = delete;
Manager(const Manager&) = delete;
Manager& operator=(const Manager&) = delete;
Manager(Manager&&) = default;
Manager& operator=(Manager&&) = default;
~Manager() = default;
/** @brief Construct an inventory manager.
*
* @param[in] bus - An sdbusplus bus connection.
* @param[in] busname - The DBus busname to own.
* @param[in] root - The DBus path on which to implement
* an inventory manager.
* @param[in] iface - The DBus inventory interface to implement.
*/
Manager(sdbusplus::bus::bus&&, const char*, const char*, const char*);
using EventInfo =
std::tuple<std::vector<EventBasePtr>, std::vector<Action>>;
/** @brief Start processing DBus messages. */
void run() noexcept;
/** @brief Provided for testing only. */
void shutdown() noexcept;
/** @brief sd_bus Notify method implementation callback. */
void
notify(std::map<sdbusplus::message::object_path, Object> objs) override;
/** @brief Event processing entry point. */
void handleEvent(sdbusplus::message::message&, const Event& event,
const EventInfo& info);
/** @brief Drop one or more objects from DBus. */
void destroyObjects(const std::vector<const char*>& paths);
/** @brief Add objects to DBus. */
void createObjects(
const std::map<sdbusplus::message::object_path, Object>& objs);
/** @brief Add or update objects on DBus. */
void updateObjects(
const std::map<sdbusplus::message::object_path, Object>& objs,
bool restoreFromCache = false);
/** @brief Restore persistent inventory items */
void restore();
/** @brief Invoke an sdbusplus server binding method.
*
* Invoke the requested method with a reference to the requested
* sdbusplus server binding interface as a parameter.
*
* @tparam T - The sdbusplus server binding interface type.
* @tparam U - The type of the sdbusplus server binding member.
* @tparam Args - Argument types of the binding member.
*
* @param[in] path - The DBus path on which the method should
* be invoked.
* @param[in] interface - The DBus interface hosting the method.
* @param[in] member - Pointer to sdbusplus server binding member.
* @param[in] args - Arguments to forward to the binding member.
*
* @returns - The return/value type of the binding method being
* called.
*/
template <typename T, typename U, typename... Args>
decltype(auto) invokeMethod(const char* path, const char* interface,
U&& member, Args&&... args)
{
auto& iface = getInterface<T>(path, interface);
return (iface.*member)(std::forward<Args>(args)...);
}
using SigArgs = std::vector<std::unique_ptr<
std::tuple<Manager*, const DbusSignal*, const EventInfo*>>>;
using SigArg = SigArgs::value_type::element_type;
private:
using InterfaceComposite = std::map<std::string, std::any>;
using ObjectReferences = std::map<std::string, InterfaceComposite>;
using Events = std::vector<EventInfo>;
// The int instantiations are safe since the signature of these
// functions don't change from one instantiation to the next.
using Makers =
std::map<std::string, std::tuple<MakeInterfaceType, AssignInterfaceType,
SerializeInterfaceType<SerialOps>,
DeserializeInterfaceType<SerialOps>>>;
/** @brief Provides weak references to interface holders.
*
* Common code for all types for the templated getInterface
* methods.
*
* @param[in] path - The DBus path for which the interface
* holder instance should be provided.
* @param[in] interface - The DBus interface for which the
* holder instance should be provided.
*
* @returns A weak reference to the holder instance.
*/
const std::any& getInterfaceHolder(const char*, const char*) const;
std::any& getInterfaceHolder(const char*, const char*);
/** @brief Provides weak references to interface holders.
*
* @tparam T - The sdbusplus server binding interface type.
*
* @param[in] path - The DBus path for which the interface
* should be provided.
* @param[in] interface - The DBus interface to obtain.
*
* @returns A weak reference to the interface holder.
*/
template <typename T>
auto& getInterface(const char* path, const char* interface)
{
auto& holder = getInterfaceHolder(path, interface);
return *std::any_cast<std::shared_ptr<T>&>(holder);
}
template <typename T>
auto& getInterface(const char* path, const char* interface) const
{
auto& holder = getInterfaceHolder(path, interface);
return *std::any_cast<T>(holder);
}
/** @brief Add or update interfaces on DBus. */
void updateInterfaces(const sdbusplus::message::object_path& path,
const Object& interfaces,
ObjectReferences::iterator pos,
bool emitSignals = true,
bool restoreFromCache = false);
/** @brief Provided for testing only. */
volatile bool _shutdown;
/** @brief Path prefix applied to any relative paths. */
const char* _root;
/** @brief A container of sdbusplus server interface references. */
ObjectReferences _refs;
/** @brief A container contexts for signal callbacks. */
SigArgs _sigargs;
/** @brief A container of sdbusplus signal matches. */
std::vector<sdbusplus::bus::match_t> _matches;
/** @brief Persistent sdbusplus DBus bus connection. */
sdbusplus::bus::bus _bus;
/** @brief sdbusplus org.freedesktop.DBus.ObjectManager reference. */
sdbusplus::server::manager::manager _manager;
/** @brief A container of pimgen generated events and responses. */
static const Events _events;
/** @brief A container of pimgen generated factory methods. */
static const Makers _makers;
};
} // namespace manager
} // namespace inventory
} // namespace phosphor
// vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
|
