reclaim

Crates.ioreclaim
lib.rsreclaim
version0.2.2
sourcesrc
created_at2019-06-13 19:44:09.903097
updated_at2019-07-16 19:52:40.074205
descriptiontrait-based abstract interface for memory reclamation
homepage
repositoryhttps://github.com/oliver-giersch/reclaim.git
max_upload_size
id140917
size186,694
(oliver-giersch)

documentation

https://docs.rs/reclaim

README

Reclaim - Concurrent memory reclamation

A unified abstract interface for concurrent memory reclamation that leverages Rust's type system in order to expose a public API that is largely safe.

Build Status Latest version Documentation License Rust 1.36+

Usage

Add the following to your Cargo.toml

[dependencies]
reclaim = "0.2.0"

Minimum Supported Rust Version (MSRV)

The minimum supported rust version for this crate is 1.36.0.

Features

This crate is no_std + alloc compatible. The std feature (enabled by default) must be disabled when this crate is intended for use in a #[no_std] environment.

Reclamation Scheme Implementations

The following list contains the currently available reclamation scheme implementations based on this crate's API and interface:

Down the Road

The ultimate goal of this crate is to allow fully generic memory reclamation based only on the traits Reclaim/LocalReclaim and Protect. This will allow writers of lock-free data structures to parametrize their code over the reclamation scheme they use, making it easily exchangeable. This is currently not possible due to the lack of GAT (generic associated types).

Likewise, since const generics are currently not available in stable Rust, the crate's type safe pointer tagging mechanism has to rely on the typenum crate. This is also bound change in the future.

In some cases, the implementation for Record has to rely on the memoffset crate and its offset_of! macro, which exhibits UB. Once a fully sound alternative becomes available, it will be adapted. Note, that the macro is only used for record types with an non-zero size header.

License

Reclaim 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.

Commit count: 136

cargo fmt