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
|
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright OpenBMC Authors
// SPDX-FileCopyrightText: Copyright 2018 Intel Corporation
#pragma once
#include "async_resp.hpp"
#include "boost_formatters.hpp"
#include "dbus_singleton.hpp"
#include <boost/system/error_code.hpp>
#include <sdbusplus/asio/connection.hpp>
#include <sdbusplus/asio/property.hpp>
#include <sdbusplus/message/native_types.hpp>
#include <cstddef>
#include <cstdint>
#include <functional>
#include <memory>
#include <span>
#include <string>
#include <string_view>
#include <tuple>
#include <utility>
#include <variant>
#include <vector>
namespace dbus
{
namespace utility
{
// clang-format off
using DbusVariantType = std::variant<
std::vector<std::tuple<std::string, std::string, std::string>>,
std::vector<std::string>,
std::vector<double>,
std::string,
int64_t,
uint64_t,
double,
int32_t,
uint32_t,
int16_t,
uint16_t,
uint8_t,
bool,
std::vector<uint32_t>,
std::vector<uint16_t>,
sdbusplus::message::object_path,
std::tuple<uint64_t, std::vector<std::tuple<std::string, double, uint64_t>>>,
std::vector<sdbusplus::message::object_path>,
std::vector<std::tuple<std::string, std::string>>,
std::vector<std::tuple<uint32_t, std::vector<uint32_t>>>,
std::vector<std::tuple<uint32_t, size_t>>,
std::vector<std::tuple<
std::vector<std::tuple<sdbusplus::message::object_path, std::string>>,
std::string, std::string, uint64_t>>,
std::vector<std::pair<sdbusplus::message::object_path, std::string>>,
std::vector<std::tuple<std::string, uint64_t, std::string, double>>,
std::vector<std::tuple<std::string, std::string, uint64_t, std::string>>
>;
// clang-format on
using DBusPropertiesMap = std::vector<std::pair<std::string, DbusVariantType>>;
using DBusInterfacesMap =
std::vector<std::pair<std::string, DBusPropertiesMap>>;
using ManagedObjectType =
std::vector<std::pair<sdbusplus::message::object_path, DBusInterfacesMap>>;
// Map of service name to list of interfaces
using MapperServiceMap =
std::vector<std::pair<std::string, std::vector<std::string>>>;
// Map of object paths to MapperServiceMaps
using MapperGetSubTreeResponse =
std::vector<std::pair<std::string, MapperServiceMap>>;
using MapperGetObject =
std::vector<std::pair<std::string, std::vector<std::string>>>;
using MapperGetAncestorsResponse = std::vector<
std::pair<std::string,
std::vector<std::pair<std::string, std::vector<std::string>>>>>;
using MapperGetSubTreePathsResponse = std::vector<std::string>;
using MapperEndPoints = std::vector<std::string>;
void escapePathForDbus(std::string& path);
void logError(const boost::system::error_code& ec);
// gets the string N strings deep into a path
// i.e. /0th/1st/2nd/3rd
bool getNthStringFromPath(const std::string& path, int index,
std::string& result);
void getAllProperties(const std::string& service, const std::string& objectPath,
const std::string& interface,
std::function<void(const boost::system::error_code&,
const DBusPropertiesMap&)>&& callback);
template <typename MessageHandler, typename... InputArgs>
// NOLINTNEXTLINE(readability-identifier-naming)
void async_method_call(MessageHandler&& handler, const std::string& service,
const std::string& objpath, const std::string& interf,
const std::string& method, const InputArgs&... a)
{
crow::connections::systemBus->async_method_call(
std::forward<MessageHandler>(handler), service, objpath, interf, method,
a...);
}
template <typename MessageHandler, typename... InputArgs>
// NOLINTNEXTLINE(readability-identifier-naming)
void async_method_call(const std::shared_ptr<bmcweb::AsyncResp>& /*asyncResp*/,
MessageHandler&& handler, const std::string& service,
const std::string& objpath, const std::string& interf,
const std::string& method, const InputArgs&... a)
{
crow::connections::systemBus->async_method_call(
std::forward<MessageHandler>(handler), service, objpath, interf, method,
a...);
}
template <typename PropertyType>
void getProperty(const std::string& service, const std::string& objectPath,
const std::string& interface, const std::string& propertyName,
std::function<void(const boost::system::error_code&,
const PropertyType&)>&& callback)
{
sdbusplus::asio::getProperty<PropertyType>(
*crow::connections::systemBus, service, objectPath, interface,
propertyName, std::move(callback));
}
template <typename PropertyType>
void getProperty(sdbusplus::asio::connection& /*conn*/,
const std::string& service, const std::string& objectPath,
const std::string& interface, const std::string& propertyName,
std::function<void(const boost::system::error_code&,
const PropertyType&)>&& callback)
{
getProperty(service, objectPath, interface, propertyName,
std::move(callback));
}
void getAllProperties(sdbusplus::asio::connection& /*conn*/,
const std::string& service, const std::string& objectPath,
const std::string& interface,
std::function<void(const boost::system::error_code&,
const DBusPropertiesMap&)>&& callback);
void checkDbusPathExists(const std::string& path,
std::function<void(bool)>&& callback);
void getSubTree(
const std::string& path, int32_t depth,
std::span<const std::string_view> interfaces,
std::function<void(const boost::system::error_code&,
const MapperGetSubTreeResponse&)>&& callback);
void getSubTreePaths(
const std::string& path, int32_t depth,
std::span<const std::string_view> interfaces,
std::function<void(const boost::system::error_code&,
const MapperGetSubTreePathsResponse&)>&& callback);
void getAssociatedSubTree(
const sdbusplus::message::object_path& associatedPath,
const sdbusplus::message::object_path& path, int32_t depth,
std::span<const std::string_view> interfaces,
std::function<void(const boost::system::error_code&,
const MapperGetSubTreeResponse&)>&& callback);
void getAssociatedSubTreePaths(
const sdbusplus::message::object_path& associatedPath,
const sdbusplus::message::object_path& path, int32_t depth,
std::span<const std::string_view> interfaces,
std::function<void(const boost::system::error_code&,
const MapperGetSubTreePathsResponse&)>&& callback);
void getAssociatedSubTreeById(
const std::string& id, const std::string& path,
std::span<const std::string_view> subtreeInterfaces,
std::string_view association,
std::span<const std::string_view> endpointInterfaces,
std::function<void(const boost::system::error_code&,
const MapperGetSubTreeResponse&)>&& callback);
void getAssociatedSubTreePathsById(
const std::string& id, const std::string& path,
std::span<const std::string_view> subtreeInterfaces,
std::string_view association,
std::span<const std::string_view> endpointInterfaces,
std::function<void(const boost::system::error_code&,
const MapperGetSubTreePathsResponse&)>&& callback);
void getDbusObject(const std::string& path,
std::span<const std::string_view> interfaces,
std::function<void(const boost::system::error_code&,
const MapperGetObject&)>&& callback);
void getAssociationEndPoints(
const std::string& path,
std::function<void(const boost::system::error_code&,
const MapperEndPoints&)>&& callback);
void getManagedObjects(
const std::string& service, const sdbusplus::message::object_path& path,
std::function<void(const boost::system::error_code&,
const ManagedObjectType&)>&& callback);
} // namespace utility
} // namespace dbus
|
