Derick Eddington
08844cf184
This resolves issues: -111cf90(`handler` is not async-signal-safe) -c8e0300(`libc::signal` should not be used) -b91c6c3(Mutex can cause signals to be missed) The API of `radicle-signals` is the same as before, and so uses of it don't need to be and aren't changed. The behavior is slightly different in that: - If the channel is full then signals will not be lost, which is an improvement. This is achieved without blocking in the signal handler. This is possible because of the counters approach along with the internal receipts-processing thread of the `signals_receipts` crate. - `install()` and `uninstall()` might block very briefly if necessary to acquire the mutex, which is now internal to and managed by the `signals_receipts` crate, only if there are concurrent calls to them (which is unlikely), but such blocking is guaranteed to be bounded to be very brief. This is done so they no longer can fail to do their purpose, which is an improvement. They still return errors if the handling is already installed or uninstalled, respectively, which preserves the previous use cases. - The new `finish()` function is introduced. This is provided in case it's ever needed to completely clean-up the facility, by terminating the internal receipts-processing thread, to be like it hadn't been installed before. - The user must ensure that the notifications channel is disconnected, by dropping the receiver(s), when doing `uninstall()` or `finish()`. Such dropping usually occurs naturally, and already occurs for all the preexisting uses of `radicle_signals`. (The `signals_receipts` crate is capable of a more robust approach, but this commit doesn't use that, to avoid changing the preexisting uses of `radicle_signals`.) - The `TryFrom` impl for `Signal` is of `SignalNumber` which is `c_int`, instead of `i32`, because `c_int` (the type of signal numbers) might not be `i32` on all platforms (POSIX only requires `c_int` to be at least 32-bit). The version of `radicle_signals` is incremented, to reflect those changes and the substantially different internal implementation. The new dependency on the `base64` crate is needed by the `signals_receipts` crate for it to work on macOS, because its dependency on the `sem_safe` crate uses `base64` as part of creating anonymous semaphores on macOS (which lacks support for unnamed semaphores (in violation of POSIX)). Signed-off-by: Derick Eddington <kcired@pm.me>
❤️🪵
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 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.xyz/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 radicle-cli --force --locked --root ~/.radicle
cargo install --path radicle-node --force --locked --root ~/.radicle
cargo install --path radicle-remote-helper --force --locked --root ~/.radicle
Or directly from our seed node:
cargo install --force --locked --root ~/.radicle \
--git https://seed.radicle.xyz/z3gqcJUoA1n9HaHKufZs5FCSGazv5.git \
radicle-cli radicle-node 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.
Contributing
See CONTRIBUTING.md and HACKING.md for an introduction to contributing to Radicle.
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.