/** * (C) 2016 - 2017 KISTLER INSTRUMENTE AG, Winterthur, Switzerland * (C) 2016 - 2019 Stanislav Angelovic * * @file Connection.cpp * * Created on: Nov 8, 2016 * Project: sdbus-c++ * Description: High-level D-Bus IPC C++ library based on sd-bus * * This file is part of sdbus-c++. * * sdbus-c++ is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation, either version 2.1 of the License, or * (at your option) any later version. * * sdbus-c++ is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with sdbus-c++. If not, see . */ #include "Connection.h" #include "SdBus.h" #include "MessageUtils.h" #include #include #include "ScopeGuard.h" #include #include #include #include namespace sdbus { namespace internal { Connection::Connection(std::unique_ptr&& interface, const BusFactory& busFactory) : iface_(std::move(interface)) , bus_(openBus(busFactory)) { assert(iface_ != nullptr); } Connection::Connection(std::unique_ptr&& interface, system_bus_t) : Connection(std::move(interface), [this](sd_bus** bus){ return iface_->sd_bus_open_system(bus); }) { } Connection::Connection(std::unique_ptr&& interface, session_bus_t) : Connection(std::move(interface), [this](sd_bus** bus){ return iface_->sd_bus_open_user(bus); }) { } Connection::Connection(std::unique_ptr&& interface, remote_system_bus_t, const std::string& host) : Connection(std::move(interface), [this, &host](sd_bus** bus){ return iface_->sd_bus_open_system_remote(bus, host.c_str()); }) { } Connection::~Connection() { leaveProcessingLoop(); } void Connection::requestName(const std::string& name) { auto r = iface_->sd_bus_request_name(bus_.get(), name.c_str(), 0); SDBUS_THROW_ERROR_IF(r < 0, "Failed to request bus name", -r); } void Connection::releaseName(const std::string& name) { auto r = iface_->sd_bus_release_name(bus_.get(), name.c_str()); SDBUS_THROW_ERROR_IF(r < 0, "Failed to release bus name", -r); } std::string Connection::getUniqueName() { const char* unique = nullptr; auto r = iface_->sd_bus_get_unique_name(bus_.get(), &unique); SDBUS_THROW_ERROR_IF(r < 0 || unique == nullptr, "Failed to get unique bus name", -r); return unique; } void Connection::enterProcessingLoop() { while (true) { auto processed = processPendingRequest(); if (processed) continue; // Process next one auto success = waitForNextRequest(); if (!success) break; // Exit processing loop } } void Connection::enterProcessingLoopAsync() { if (!asyncLoopThread_.joinable()) asyncLoopThread_ = std::thread([this](){ enterProcessingLoop(); }); } void Connection::leaveProcessingLoop() { notifyProcessingLoopToExit(); joinWithProcessingLoop(); } sdbus::IConnection::PollData Connection::getProcessLoopPollData() { ISdBus::PollData pollData; auto r = iface_->sd_bus_get_poll_data(bus_.get(), &pollData); SDBUS_THROW_ERROR_IF(r < 0, "Failed to get bus poll data", -r); return {pollData.fd, pollData.events, pollData.timeout_usec}; } const ISdBus& Connection::getSdBusInterface() const { return *iface_.get(); } ISdBus& Connection::getSdBusInterface() { return *iface_.get(); } void Connection::addObjectManager(const std::string& objectPath) { Connection::addObjectManager(objectPath, nullptr); } SlotPtr Connection::addObjectManager(const std::string& objectPath, void* /*dummy*/) { sd_bus_slot *slot{}; auto r = iface_->sd_bus_add_object_manager( bus_.get() , &slot , objectPath.c_str() ); SDBUS_THROW_ERROR_IF(r < 0, "Failed to add object manager", -r); return {slot, [this](void *slot){ iface_->sd_bus_slot_unref((sd_bus_slot*)slot); }}; } void Connection::setMethodCallTimeout(uint64_t timeout) { auto r = iface_->sd_bus_set_method_call_timeout(bus_.get(), timeout); SDBUS_THROW_ERROR_IF(r < 0, "Failed to set method call timeout", -r); } uint64_t Connection::getMethodCallTimeout() const { uint64_t timeout; auto r = iface_->sd_bus_get_method_call_timeout(bus_.get(), &timeout); SDBUS_THROW_ERROR_IF(r < 0, "Failed to get method call timeout", -r); return timeout; } SlotPtr Connection::addObjectVTable( const std::string& objectPath , const std::string& interfaceName , const sd_bus_vtable* vtable , void* userData ) { sd_bus_slot *slot{}; auto r = iface_->sd_bus_add_object_vtable( bus_.get() , &slot , objectPath.c_str() , interfaceName.c_str() , vtable , userData ); SDBUS_THROW_ERROR_IF(r < 0, "Failed to register object vtable", -r); return {slot, [this](void *slot){ iface_->sd_bus_slot_unref((sd_bus_slot*)slot); }}; } MethodCall Connection::createMethodCall( const std::string& destination , const std::string& objectPath , const std::string& interfaceName , const std::string& methodName ) const { sd_bus_message *sdbusMsg{}; auto r = iface_->sd_bus_message_new_method_call( bus_.get() , &sdbusMsg , destination.c_str() , objectPath.c_str() , interfaceName.c_str() , methodName.c_str() ); SDBUS_THROW_ERROR_IF(r < 0, "Failed to create method call", -r); return Message::Factory::create(sdbusMsg, iface_.get(), adopt_message); } Signal Connection::createSignal( const std::string& objectPath , const std::string& interfaceName , const std::string& signalName ) const { sd_bus_message *sdbusSignal{}; auto r = iface_->sd_bus_message_new_signal( bus_.get() , &sdbusSignal , objectPath.c_str() , interfaceName.c_str() , signalName.c_str() ); SDBUS_THROW_ERROR_IF(r < 0, "Failed to create signal", -r); return Message::Factory::create(sdbusSignal, iface_.get(), adopt_message); } void Connection::emitPropertiesChangedSignal( const std::string& objectPath , const std::string& interfaceName , const std::vector& propNames ) { auto names = to_strv(propNames); auto r = iface_->sd_bus_emit_properties_changed_strv( bus_.get() , objectPath.c_str() , interfaceName.c_str() , propNames.empty() ? nullptr : &names[0] ); SDBUS_THROW_ERROR_IF(r < 0, "Failed to emit PropertiesChanged signal", -r); } void Connection::emitInterfacesAddedSignal(const std::string& objectPath) { auto r = iface_->sd_bus_emit_object_added(bus_.get(), objectPath.c_str()); SDBUS_THROW_ERROR_IF(r < 0, "Failed to emit InterfacesAdded signal for all registered interfaces", -r); } void Connection::emitInterfacesAddedSignal( const std::string& objectPath , const std::vector& interfaces ) { auto names = to_strv(interfaces); auto r = iface_->sd_bus_emit_interfaces_added_strv( bus_.get() , objectPath.c_str() , interfaces.empty() ? nullptr : &names[0] ); SDBUS_THROW_ERROR_IF(r < 0, "Failed to emit InterfacesAdded signal", -r); } void Connection::emitInterfacesRemovedSignal(const std::string& objectPath) { auto r = iface_->sd_bus_emit_object_removed(bus_.get(), objectPath.c_str()); SDBUS_THROW_ERROR_IF(r < 0, "Failed to emit InterfacesRemoved signal for all registered interfaces", -r); } void Connection::emitInterfacesRemovedSignal( const std::string& objectPath , const std::vector& interfaces ) { auto names = to_strv(interfaces); auto r = iface_->sd_bus_emit_interfaces_removed_strv( bus_.get() , objectPath.c_str() , interfaces.empty() ? nullptr : &names[0] ); SDBUS_THROW_ERROR_IF(r < 0, "Failed to emit InterfacesRemoved signal", -r); } SlotPtr Connection::registerSignalHandler( const std::string& objectPath , const std::string& interfaceName , const std::string& signalName , sd_bus_message_handler_t callback , void* userData ) { sd_bus_slot *slot{}; auto filter = composeSignalMatchFilter(objectPath, interfaceName, signalName); auto r = iface_->sd_bus_add_match(bus_.get(), &slot, filter.c_str(), callback, userData); SDBUS_THROW_ERROR_IF(r < 0, "Failed to register signal handler", -r); return {slot, [this](void *slot){ iface_->sd_bus_slot_unref((sd_bus_slot*)slot); }}; } Connection::BusPtr Connection::openBus(const BusFactory& busFactory) { sd_bus* bus{}; int r = busFactory(&bus); SDBUS_THROW_ERROR_IF(r < 0, "Failed to open bus", -r); BusPtr busPtr{bus, [this](sd_bus* bus){ return iface_->sd_bus_flush_close_unref(bus); }}; finishHandshake(busPtr.get()); return busPtr; } void Connection::finishHandshake(sd_bus* bus) { // Process all requests that are part of the initial handshake, // like processing the Hello message response, authentication etc., // to avoid connection authentication timeout in dbus daemon. assert(bus != nullptr); auto r = iface_->sd_bus_flush(bus); SDBUS_THROW_ERROR_IF(r < 0, "Failed to flush bus on opening", -r); } void Connection::notifyProcessingLoopToExit() { assert(loopExitFd_.fd >= 0); uint64_t value = 1; auto r = write(loopExitFd_.fd, &value, sizeof(value)); SDBUS_THROW_ERROR_IF(r < 0, "Failed to notify processing loop", -errno); } void Connection::clearExitNotification() { uint64_t value{}; auto r = read(loopExitFd_.fd, &value, sizeof(value)); SDBUS_THROW_ERROR_IF(r < 0, "Failed to read from the event descriptor", -errno); } void Connection::joinWithProcessingLoop() { if (asyncLoopThread_.joinable()) asyncLoopThread_.join(); } bool Connection::processPendingRequest() { auto bus = bus_.get(); assert(bus != nullptr); int r = iface_->sd_bus_process(bus, nullptr); SDBUS_THROW_ERROR_IF(r < 0, "Failed to process bus requests", -r); return r > 0; } bool Connection::waitForNextRequest() { auto bus = bus_.get(); assert(bus != nullptr); assert(loopExitFd_.fd != 0); auto sdbusPollData = getProcessLoopPollData(); struct pollfd fds[] = {{sdbusPollData.fd, sdbusPollData.events, 0}, {loopExitFd_.fd, POLLIN, 0}}; auto fdsCount = sizeof(fds)/sizeof(fds[0]); auto timeout = sdbusPollData.timeout_usec == (uint64_t) -1 ? (uint64_t)-1 : (sdbusPollData.timeout_usec+999)/1000; auto r = poll(fds, fdsCount, timeout); if (r < 0 && errno == EINTR) return true; // Try again SDBUS_THROW_ERROR_IF(r < 0, "Failed to wait on the bus", -errno); if (fds[1].revents & POLLIN) { clearExitNotification(); return false; } return true; } std::string Connection::composeSignalMatchFilter( const std::string& objectPath , const std::string& interfaceName , const std::string& signalName ) { std::string filter; filter += "type='signal',"; filter += "interface='" + interfaceName + "',"; filter += "member='" + signalName + "',"; filter += "path='" + objectPath + "'"; return filter; } std::vector Connection::to_strv(const std::vector& strings) { std::vector strv; for (auto& str : strings) strv.push_back(const_cast(str.c_str())); strv.push_back(nullptr); return strv; } Connection::LoopExitEventFd::LoopExitEventFd() { fd = eventfd(0, EFD_SEMAPHORE | EFD_CLOEXEC | EFD_NONBLOCK); SDBUS_THROW_ERROR_IF(fd < 0, "Failed to create event object", -errno); } Connection::LoopExitEventFd::~LoopExitEventFd() { assert(fd >= 0); close(fd); } }} namespace sdbus { std::unique_ptr createConnection() { return createSystemBusConnection(); } std::unique_ptr createConnection(const std::string& name) { return createSystemBusConnection(name); } std::unique_ptr createSystemBusConnection() { auto interface = std::make_unique(); assert(interface != nullptr); constexpr sdbus::internal::Connection::system_bus_t system_bus; return std::make_unique(std::move(interface), system_bus); } std::unique_ptr createSystemBusConnection(const std::string& name) { auto conn = createSystemBusConnection(); conn->requestName(name); return conn; } std::unique_ptr createSessionBusConnection() { auto interface = std::make_unique(); assert(interface != nullptr); constexpr sdbus::internal::Connection::session_bus_t session_bus; return std::make_unique(std::move(interface), session_bus); } std::unique_ptr createSessionBusConnection(const std::string& name) { auto conn = createSessionBusConnection(); conn->requestName(name); return conn; } std::unique_ptr createRemoteSystemBusConnection(const std::string& host) { auto interface = std::make_unique(); assert(interface != nullptr); constexpr sdbus::internal::Connection::remote_system_bus_t remote_system_bus; return std::make_unique(std::move(interface), remote_system_bus, host); } }