hub / github.com/bootreer/vroom

github.com/bootreer/vroom @main

93 symbols 193 edges 8 files 32 documented · 34%

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

vroom

vroom is a userspace NVMe driver written in Rust. It aims to be as fast as the SPDK NVMe driver, while minimizing unsafe code and offering a simplified API. vroom currently serves as a proof of concept.

My thesis contains some details about the implementation.

Build instructions

You will need Rust, as well as its package manager cargo which you can install with:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Huge pages need to be enabled:

cd vroom
sudo ./setup-hugetlbfs.sh

To build the driver, as well as any examples run:

cargo build --release --all-targets

e.g. to run the hello world example (root rights are needed for DMA):

sudo ./target/release/examples/hello_world 0000:00:07.0

Disclaimer

This is by no means production-ready. Do not use it in critical environments. DMA may corrupt memory.

Related projects

Redox's NVMe driver

Extension points exported contracts — how you extend this code

DmaSlice (Interface)

Trait for types that can be viewed as DMA slices [1 implementers]

src/memory.rs

Core symbols most depended-on inside this repo

write

called by 10

src/nvme.rs

submit_and_complete_admin

Shape

Method 54

Function 23

Class 12

Enum 3

Interface 1

Languages

Rust100%

Modules by API surface

src/nvme.rs29 symbols

src/pci.rs15 symbols

src/cmd.rs15 symbols

src/memory.rs14 symbols

src/queues.rs12 symbols

examples/io_test.rs4 symbols

src/lib.rs3 symbols

examples/hello_world.rs1 symbols

For agents

$ claude mcp add vroom \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact