Skip to content

Commit

Permalink
chore: Add more READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
fasterthanlime committed Oct 3, 2023
1 parent 1afe948 commit ce533ed
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 0 deletions.
19 changes: 19 additions & 0 deletions crates/fluke-buffet/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# fluke-buffet

This crate is mostly a terrible idea, but it's doing buffer management
for `fluke`.

It's designed to memmap a big chunk of memory and then, well, hand out
reference-counted (non-thread-safe) pieces of it. It was faster than stack
allocation in some benchmark I did a while ago.

Also, it's compatible with io_uring in that you can give ownership of one of the
pieces to a read/write operation and nobody else is able to use it until that
operation is done, which is really neat.

There's a bunch of splitting operations that try to maintain reference count
and the general "one mutable reference XOR multiple read-only references" vibe
of the whole endeavor.

I'm not honestly convinced buffet is the optimal way to go about this, but it
works for now, it's io_uring and fallback-codepath friendly... ah well.
1 change: 1 addition & 0 deletions crates/fluke-maybe-uring/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ edition = "2021"
license = "MIT OR Apache-2.0"
repository = "https://github.com/hapsoc/fluke"
documentation = "https://docs.rs/fluke-maybe-uring"
readme = "README.md"
description = """
Replicates some tokio-uring types to allow building code without it
"""
Expand Down
5 changes: 5 additions & 0 deletions crates/fluke-maybe-uring/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# fluke-maybe-uring

fluke uses [tokio-uring](https://crates.io/crates/tokio-uring), but it also
tries to function on platforms where io_uring is not available: this crate
abstracts over "classic tokio" I/O types and tokio-uring types.

0 comments on commit ce533ed

Please sign in to comment.