mirror of
https://github.com/bitcoin/bitcoin.git
synced 2026-04-04 04:45:10 +02:00
This fixes behavior reported by Antoine Poinsot <darosior@protonmail.com> https://github.com/bitcoin/bitcoin/pull/29409#issuecomment-2546088852 where if an IPC client is connected, the node will wait forever for it to disconnect before exiting.
117 lines
4.0 KiB
C++
117 lines
4.0 KiB
C++
// Copyright (c) 2021 The Bitcoin Core developers
|
||
// Distributed under the MIT software license, see the accompanying
|
||
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||
|
||
#include <interfaces/init.h>
|
||
#include <ipc/capnp/context.h>
|
||
#include <ipc/capnp/init.capnp.h>
|
||
#include <ipc/capnp/init.capnp.proxy.h>
|
||
#include <ipc/capnp/protocol.h>
|
||
#include <ipc/exception.h>
|
||
#include <ipc/protocol.h>
|
||
#include <kj/async.h>
|
||
#include <logging.h>
|
||
#include <mp/proxy-io.h>
|
||
#include <mp/proxy-types.h>
|
||
#include <mp/util.h>
|
||
#include <util/threadnames.h>
|
||
|
||
#include <cassert>
|
||
#include <cerrno>
|
||
#include <future>
|
||
#include <memory>
|
||
#include <mutex>
|
||
#include <optional>
|
||
#include <string>
|
||
#include <sys/socket.h>
|
||
#include <system_error>
|
||
#include <thread>
|
||
|
||
namespace ipc {
|
||
namespace capnp {
|
||
namespace {
|
||
void IpcLogFn(bool raise, std::string message)
|
||
{
|
||
LogDebug(BCLog::IPC, "%s\n", message);
|
||
if (raise) throw Exception(message);
|
||
}
|
||
|
||
class CapnpProtocol : public Protocol
|
||
{
|
||
public:
|
||
~CapnpProtocol() noexcept(true)
|
||
{
|
||
m_loop_ref.reset();
|
||
if (m_loop_thread.joinable()) m_loop_thread.join();
|
||
assert(!m_loop);
|
||
};
|
||
std::unique_ptr<interfaces::Init> connect(int fd, const char* exe_name) override
|
||
{
|
||
startLoop(exe_name);
|
||
return mp::ConnectStream<messages::Init>(*m_loop, fd);
|
||
}
|
||
void listen(int listen_fd, const char* exe_name, interfaces::Init& init) override
|
||
{
|
||
startLoop(exe_name);
|
||
if (::listen(listen_fd, /*backlog=*/5) != 0) {
|
||
throw std::system_error(errno, std::system_category());
|
||
}
|
||
mp::ListenConnections<messages::Init>(*m_loop, listen_fd, init);
|
||
}
|
||
void serve(int fd, const char* exe_name, interfaces::Init& init, const std::function<void()>& ready_fn = {}) override
|
||
{
|
||
assert(!m_loop);
|
||
mp::g_thread_context.thread_name = mp::ThreadName(exe_name);
|
||
m_loop.emplace(exe_name, &IpcLogFn, &m_context);
|
||
if (ready_fn) ready_fn();
|
||
mp::ServeStream<messages::Init>(*m_loop, fd, init);
|
||
m_parent_connection = &m_loop->m_incoming_connections.back();
|
||
m_loop->loop();
|
||
m_loop.reset();
|
||
}
|
||
void disconnectIncoming() override
|
||
{
|
||
if (!m_loop) return;
|
||
// Delete incoming connections, except the connection to a parent
|
||
// process (if there is one), since a parent process should be able to
|
||
// monitor and control this process, even during shutdown.
|
||
m_loop->sync([&] {
|
||
m_loop->m_incoming_connections.remove_if([this](mp::Connection& c) { return &c != m_parent_connection; });
|
||
});
|
||
}
|
||
void addCleanup(std::type_index type, void* iface, std::function<void()> cleanup) override
|
||
{
|
||
mp::ProxyTypeRegister::types().at(type)(iface).cleanup_fns.emplace_back(std::move(cleanup));
|
||
}
|
||
Context& context() override { return m_context; }
|
||
void startLoop(const char* exe_name)
|
||
{
|
||
if (m_loop) return;
|
||
std::promise<void> promise;
|
||
m_loop_thread = std::thread([&] {
|
||
util::ThreadRename("capnp-loop");
|
||
m_loop.emplace(exe_name, &IpcLogFn, &m_context);
|
||
m_loop_ref.emplace(*m_loop);
|
||
promise.set_value();
|
||
m_loop->loop();
|
||
m_loop.reset();
|
||
});
|
||
promise.get_future().wait();
|
||
}
|
||
Context m_context;
|
||
std::thread m_loop_thread;
|
||
//! EventLoop object which manages I/O events for all connections.
|
||
std::optional<mp::EventLoop> m_loop;
|
||
//! Reference to the same EventLoop. Increments the loop’s refcount on
|
||
//! creation, decrements on destruction. The loop thread exits when the
|
||
//! refcount reaches 0. Other IPC objects also hold their own EventLoopRef.
|
||
std::optional<mp::EventLoopRef> m_loop_ref;
|
||
//! Connection to parent, if this is a child process spawned by a parent process.
|
||
mp::Connection* m_parent_connection{nullptr};
|
||
};
|
||
} // namespace
|
||
|
||
std::unique_ptr<Protocol> MakeCapnpProtocol() { return std::make_unique<CapnpProtocol>(); }
|
||
} // namespace capnp
|
||
} // namespace ipc
|