/* 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 "boost_formatters.hpp" #include "dbus_singleton.hpp" #include "logging.hpp" #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace dbus { namespace utility { // clang-format off using DbusVariantType = std::variant< std::vector>, std::vector, std::vector, std::string, int64_t, uint64_t, double, int32_t, uint32_t, int16_t, uint16_t, uint8_t, bool, sdbusplus::message::unix_fd, std::vector, std::vector, sdbusplus::message::object_path, std::tuple>>, std::vector, std::vector>, std::vector>>, std::vector>, std::vector>, std::string, std::string, uint64_t>> >; // clang-format on using DBusPropertiesMap = std::vector>; using DBusInterfacesMap = std::vector>; using ManagedObjectType = std::vector>; // Map of service name to list of interfaces using MapperServiceMap = std::vector>>; // Map of object paths to MapperServiceMaps using MapperGetSubTreeResponse = std::vector>; using MapperGetObject = std::vector>>; using MapperGetAncestorsResponse = std::vector< std::pair>>>>; using MapperGetSubTreePathsResponse = std::vector; using MapperEndPoints = std::vector; inline void escapePathForDbus(std::string& path) { const static std::regex reg("[^A-Za-z0-9_/]"); std::regex_replace(path.begin(), path.begin(), path.end(), reg, "_"); } inline void logError(const boost::system::error_code& ec) { if (ec) { BMCWEB_LOG_ERROR("DBus error: {}, cannot call method", ec); } } // 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 (const auto& element : p1) { if (element.has_filename()) { ++count; if (count == index) { result = element.stem().string(); break; } } } return count >= index; } template inline void checkDbusPathExists(const std::string& path, Callback&& callback) { crow::connections::systemBus->async_method_call( [callback = std::forward(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()); } inline void getSubTree(const std::string& path, int32_t depth, std::span interfaces, std::function&& 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 interfaces, std::function&& 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 getAssociatedSubTree( const sdbusplus::message::object_path& associatedPath, const sdbusplus::message::object_path& path, int32_t depth, std::span interfaces, std::function&& 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", "GetAssociatedSubTree", associatedPath, path, depth, interfaces); } inline void getAssociatedSubTreePaths( const sdbusplus::message::object_path& associatedPath, const sdbusplus::message::object_path& path, int32_t depth, std::span interfaces, std::function&& 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", "GetAssociatedSubTreePaths", associatedPath, path, depth, interfaces); } inline void getAssociatedSubTreeById( const std::string& id, const std::string& path, std::span subtreeInterfaces, std::string_view association, std::span endpointInterfaces, std::function&& 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", "GetAssociatedSubTreeById", id, path, subtreeInterfaces, association, endpointInterfaces); } inline void getAssociatedSubTreePathsById( const std::string& id, const std::string& path, std::span subtreeInterfaces, std::string_view association, std::span endpointInterfaces, std::function&& 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", "GetAssociatedSubTreePathsById", id, path, subtreeInterfaces, association, endpointInterfaces); } inline void getDbusObject( const std::string& path, std::span interfaces, std::function&& 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); } inline void getAssociationEndPoints( const std::string& path, std::function&& callback) { sdbusplus::asio::getProperty( *crow::connections::systemBus, "xyz.openbmc_project.ObjectMapper", path, "xyz.openbmc_project.Association", "endpoints", std::move(callback)); } inline void getManagedObjects( const std::string& service, const sdbusplus::message::object_path& path, std::function&& callback) { crow::connections::systemBus->async_method_call( [callback{std::move(callback)}](const boost::system::error_code& ec, const ManagedObjectType& objects) { callback(ec, objects); }, service, path, "org.freedesktop.DBus.ObjectManager", "GetManagedObjects"); } } // namespace utility } // namespace dbus