Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vertexclique/cuneiform
Cache & In-Memory optimizations for Rust, revived from the slabs of Sumer.
https://github.com/vertexclique/cuneiform
cache-coherence cache-optimization concurrency data-structures rust-lang
Last synced: 27 days ago
JSON representation
Cache & In-Memory optimizations for Rust, revived from the slabs of Sumer.
- Host: GitHub
- URL: https://github.com/vertexclique/cuneiform
- Owner: vertexclique
- License: apache-2.0
- Created: 2019-12-29T03:24:51.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-22T22:59:03.000Z (over 4 years ago)
- Last Synced: 2024-10-07T08:39:59.042Z (about 1 month ago)
- Topics: cache-coherence, cache-optimization, concurrency, data-structures, rust-lang
- Language: Rust
- Homepage: https://docs.rs/cuneiform
- Size: 2.01 MB
- Stars: 30
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
In memory optimizations for Rust, revived from the slabs of Sumer.
[](https://github.com/vertexclique/cuneiform/actions)
[](https://crates.io/crates/cuneiform)
[](https://docs.rs/cuneiform/)
This crate provides proc macro attributes to improve in memory data access times.
Cuneiform's main macro can take various arguments at attribute position:
* `hermetic = true|false` (default is `true` when `#[cuneiform]`)
* Hermetic enables cuneiform to detect cache sizes from OSes which have API to fetch.
* Currently, hermetic argument works only Linux kernel 2.6.32 and above.
* If system is different than supported systems it falls back to `slab`s.
* `slab = "board_or_architecture_name` (e.g. `#[cuneiform(slab = "powerpc_mpc8xx")]`)
* Slabs are either embedded system boards or other specific architecture.
* Slab checking have two stages:
* First, it checks the given board/architecture if exist.
* If not slabs fall back to Rust supported architectures.
* Still architecture is not detected, it will fall back to default values.
* `force = u8` (e.g. `#[cuneiform(force = 16)]`)
* Forces a given cache alignment. Overrides all other systems mentioned above.
```toml
[dependencies]
cuneiform = "0.1"
```
## Examples
Basic usage can be:
```rust
// Defaults to `hermetic = true`
#[cuneiform]
pub struct Varying {
data: u8,
data_2: u16,
}
```
Targeting specific architecture:
```rust
#[cuneiform(slab = "powerpc_mpc8xx")]
pub struct SlabBased {
data: u8,
data_2: u16,
}
```
Overriding the default cache alignment:
```rust
#[cuneiform(force = 16)]
pub struct Forced {
data: u8,
data_2: u16,
}
```
## Field level cache optimizations
Check out [cuneiform-fields](https://github.com/vertexclique/cuneiform-fields) for field level optimizations.
## Design choices
* Cuneiform doesn't have specific instruction or architecture specific code.
* Works with crates like `#![no_std]`. Ease your pain for cache optimizations. With allocator you can compile on the board too.
* Not based on assumptions. Based on Linux tree, OS checks, provider manuals and related documentation.
## Before opening a PR
* If it is big.LITTLE architecture, separate both parts in slabs. Apply the naming conventions.
* Check existing slabs before opening a PR. Please update it when you add one.
* If you come up with instructionless detection for hermetic alignment. Be sure that tests are included and not breaking existing platforms.
## Existing Slabs
* powerpc_mpc8xx
* powerpc64bridge
* powerpc_e500mc
* power_7
* power_8
* power_9
* exynos_big
* exynos_LITTLE
* krait
* neoverse_n1