A transport whose peer has gone away is never terminated, and the reactor then spins on it at 100% of a core. On every iteration the reactor [re-registers the socket with whatever interests the transport still reports][1], `poll` returns it as ready immediately, and the I/O handlers do nothing with it. The service thread stops serving the control socket, so `rad node status` times out and the node looks offline while its container is still up. Restarting a node only helps until the next peer disconnect. How the transport loses track of the socket: 1. A peer resets the connection between `poll` returning and the event being handled. The event carries no error flag, so the reactor [hands it to the transport instead of reaping it][2]. 2. On the writable event the transport [first asks whether the session is established][3]. That answer is [derived from the session artifact][4], which for a TCP stream [comes from `getpeername`][5]. On a reset socket that fails with ENOTCONN, so the transport takes the "handshake in progress" branch. 3. That branch [pokes the session with a zero-length write and discards the result][6]. The write [passes straight through to the socket][7], and a zero-length send is exactly what surfaces the pending ECONNRESET. The one signal that the peer is gone is thrown away, and the transport [re-arms its write interest][8] instead. 4. On the readable event the read also [passes straight through to the socket][9] and returns zero bytes, which the transport [ignores as well][10]. Nothing ever [marks the transport terminated][11], so its [interest set][12] stays READABLE and WRITABLE on a closed socket forever. On an affected node, strace shows thousands of failing `getpeername` calls in 5 seconds, 5 per iteration, with `epoll_pwait` returning 1,200 times a second. Two changes: - Propagate a real error from the handshake-branch zero-length write as a termination instead of discarding it. WouldBlock, Interrupted and WriteZero stay non-fatal, matching the established branch. A socket whose error was already consumed elsewhere reports EPIPE here, so this also reaps transports that are already stuck. - Treat a zero-byte read as end-of-file once the transport is [active][13]. From that point reads pass straight through to the socket. During the handshake the protocol layer [returns zero after consuming a handshake step][14], so that case keeps its current behaviour. Without this a half-closed peer also spins, until the service's [stale connection reaper][15] disconnects it about [2 minutes][16] later. The termination event [reaches the wire layer][17], which [unregisters the transport whether or not it has a peer entry for it][18]. That covers inbound connections that die mid-handshake, which have no node ID and so are invisible to the stale reaper. Tests use real loopback sockets: a peer that resets (SO_LINGER 0), the same after the pending error has already been taken, and a peer that half-closes. All three failed before this change. [1]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/reactor.rs#L350 [2]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/reactor.rs#L444 [3]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/reactor/transport.rs#L206 [4]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/reactor/session.rs#L21 [5]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/reactor/session.rs#L180 [6]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/reactor/transport.rs#L207 [7]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/reactor/session.rs#L109 [8]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/reactor/transport.rs#L208 [9]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/reactor/session.rs#L78 [10]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/reactor/transport.rs#L298 [11]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/reactor/transport.rs#L144 [12]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/reactor/transport.rs#L317 [13]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/reactor/transport.rs#L45 [14]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/reactor/session.rs#L99 [15]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-protocol/src/service.rs#L2417 [16]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-protocol/src/service.rs#L91 [17]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/wire.rs#L819 [18]: https://radicle.network/nodes/seed.radicle.garden/rad:z3gqcJUoA1n9HaHKufZs5FCSGazv5/tree/0e5a56f25f51d07290613a9363bd8c0c9fc8e0be/crates/radicle-node/src/wire.rs#L356
❤️🪵
Radicle Heartwood Protocol & Stack
Heartwood is the third iteration of the Radicle Protocol, a powerful
peer-to-peer code collaboration and publishing stack. The repository contains a
full implementation of Heartwood, complete with a user-friendly command-line
interface (rad) and network daemon (radicle-node).
Radicle was designed to be a secure, decentralized and powerful alternative to code forges such as GitHub and GitLab that preserves user sovereignty and freedom.
See the Radicle home page for general information, and the Zulip chat to talk to the project.
See the Protocol Guide for an in-depth description of how Radicle works.
Installation
Requirements
- Linux or Unix based operating system.
- Git 2.34 or later
- OpenSSH 9.1 or later with
ssh-agent
📀 From binaries
Requires
curlandtar.
Run the following command to install the latest binary release:
curl -sSf https://radicle.dev/install | sh
Or visit our download page.
📦 From source
Requires the Rust toolchain.
You can install the Radicle stack from source, by running the following commands from inside this repository:
cargo install --path crates/radicle-cli --force --locked --root ~/.radicle
cargo install --path crates/radicle-node --force --locked --root ~/.radicle
cargo install --path crates/radicle-remote-helper --force --locked --root ~/.radicle
Or directly from our seed node:
cargo install --force --locked --root ~/.radicle \
--git https://seed.radicle.dev/z3gqcJUoA1n9HaHKufZs5FCSGazv5.git \
crates/radicle-cli crates/radicle-node crates/radicle-remote-helper
Running
Systemd unit files are provided for the node under the /systemd folder.
They can be used as a starting point for further customization.
For running in debug mode, see HACKING.md.
Feedback
If you have feedback, feel free to create issues using rad issue, join
our Zulip, or email feedback@radicle.dev.
Emails sent to this address are automatically posted to
our public #feedback channel on Zulip, revealing the
From header (which usually contains your name and email
address). This allows us to discuss your feedback on Zulip, and, if necessary,
respond to you via email.
Contributing
See CONTRIBUTING.md and HACKING.md for an introduction to contributing to Radicle.
Packages
Community members maintain packages for various package managers. This makes it a lot easier to install Radicle and allows tighter integration of Radicle with various distributions. Thanks!
APT (Debian, etc.)
See https://radicle.dev/apt/ and rad:z2nDKoCF4hg6xVrv7v93LmWHDJKUr maintained by Lars Wirzenius and Richard Levitte
Arch
See archlinux.org/packages and gitlab.archlinux.org maintained by tippfehlr and kpcyrd.
NixOS
See search.nixos.org/packages and search.nixos.org/options maintained by @NixOS/radicle.
Also see home-manager-options.extranix.com for usage with home-manager.
License
Radicle is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
See LICENSE-APACHE and LICENSE-MIT for details.