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
|
/*
// Copyright (c) 2018 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 "dbus_singleton.hpp"
#include <boost/system/error_code.hpp> // IWYU pragma: keep
#include <sdbusplus/message/native_types.hpp>
#include <array>
#include <cstddef>
#include <cstdint>
#include <filesystem>
#include <functional>
#include <regex>
#include <span>
#include <sstream>
#include <string>
#include <string_view>
#include <tuple>
#include <utility>
#include <variant>
#include <vector>
// IWYU pragma: no_include <stddef.h>
// IWYU pragma: no_include <stdint.h>
// IWYU pragma: no_include <boost/system/detail/error_code.hpp>
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,
sdbusplus::message::unix_fd,
std::vector<uint32_t>,
std::vector<uint16_t>,
sdbusplus::message::object_path,
std::tuple<uint64_t, std::vector<std::tuple<std::string, std::string, double, uint64_t>>>,
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<sdbusplus::message::object_path, std::string,
std::string, std::string>>
>;
// clang-format on
using DBusPropertiesMap = std::vector<std::pair<std::string, DbusVariantType>>;
using DBusInteracesMap = std::vector<std::pair<std::string, DBusPropertiesMap>>;
using ManagedObjectType =
std::vector<std::pair<sdbusplus::message::object_path, DBusInteracesMap>>;
// 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>;
inline void escapePathForDbus(std::string& path)
{
const std::regex reg("[^A-Za-z0-9_/]");
std::regex_replace(path.begin(), path.begin(), path.end(), reg, "_");
}
// gets the string N strings deep into a path
// i.e. /0th/1st/2nd/3rd
inline bool getNthStringFromPath(const std::string& path, int index,
std::string& result)
{
if (index < 0)
{
return false;
}
std::filesystem::path p1(path);
int count = -1;
for (auto const& element : p1)
{
if (element.has_filename())
{
++count;
if (count == index)
{
result = element.stem().string();
break;
}
}
}
return count >= index;
}
template <typename Callback>
inline void checkDbusPathExists(const std::string& path, Callback&& callback)
{
crow::connections::systemBus->async_method_call(
[callback{std::forward<Callback>(callback)}](
const boost::system::error_code& ec,
const dbus::utility::MapperGetObject& objectNames) {
callback(!ec && !objectNames.empty());
},
"xyz.openbmc_project.ObjectMapper",
"/xyz/openbmc_project/object_mapper",
"xyz.openbmc_project.ObjectMapper", "GetObject", path,
std::array<std::string, 0>());
}
inline 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)
{
crow::connections::systemBus->async_method_call(
[callback{std::move(callback)}](
const boost::system::error_code& ec,
const MapperGetSubTreeResponse& subtree) { callback(ec, subtree); },
"xyz.openbmc_project.ObjectMapper",
"/xyz/openbmc_project/object_mapper",
"xyz.openbmc_project.ObjectMapper", "GetSubTree", path, depth,
interfaces);
}
inline 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)
{
crow::connections::systemBus->async_method_call(
[callback{std::move(callback)}](
const boost::system::error_code& ec,
const MapperGetSubTreePathsResponse& subtreePaths) {
callback(ec, subtreePaths);
},
"xyz.openbmc_project.ObjectMapper",
"/xyz/openbmc_project/object_mapper",
"xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", path, depth,
interfaces);
}
inline void
getDbusObject(const std::string& path,
std::span<const std::string_view> interfaces,
std::function<void(const boost::system::error_code&,
const MapperGetObject&)>&& callback)
{
crow::connections::systemBus->async_method_call(
[callback{std::move(callback)}](const boost::system::error_code& ec,
const MapperGetObject& object) {
callback(ec, object);
},
"xyz.openbmc_project.ObjectMapper",
"/xyz/openbmc_project/object_mapper",
"xyz.openbmc_project.ObjectMapper", "GetObject", path, interfaces);
}
} // namespace utility
} // namespace dbus
|
