20 releases (7 stable)

3.0.0 Aug 5, 2021
2.2.0 May 28, 2020
2.1.2 Jun 20, 2019
2.0.0 Jan 3, 2019
0.0.3 Nov 30, 2016

#55 in Concurrency

Download history 18482/week @ 2021-07-01 20083/week @ 2021-07-08 20884/week @ 2021-07-15 20038/week @ 2021-07-22 22111/week @ 2021-07-29 22592/week @ 2021-08-05 21432/week @ 2021-08-12 24497/week @ 2021-08-19 24220/week @ 2021-08-26 22373/week @ 2021-09-02 28062/week @ 2021-09-09 27330/week @ 2021-09-16 27906/week @ 2021-09-23 27507/week @ 2021-09-30 30281/week @ 2021-10-07 24854/week @ 2021-10-14

80,943 downloads per month
Used in 187 crates (26 directly)

MIT license

74KB
1.5K SLoC

region-rs

Cross-platform virtual memory API

GitHub CI Status crates.io version Documentation License

This crate provides a cross-platform Rust API for allocating, querying and manipulating virtual memory. It is a thin abstraction, with the underlying interaction implemented using platform specific APIs (e.g VirtualQuery, VirtualAlloc, VirtualLock, mprotect, mmap, mlock).

Platforms

This library is continuously tested against these targets:

  • Linux
    • aarch64-linux-android
    • armv7-unknown-linux-gnueabihf
    • i686-unknown-linux-gnu
    • mips-unknown-linux-gnu
    • x86_64-unknown-linux-gnu
    • x86_64-unknown-linux-musl
  • Windows
    • i686-pc-windows-gnu
    • i686-pc-windows-msvc
    • x86_64-pc-windows-gnu
    • x86_64-pc-windows-msvc
  • macOS
    • x86_64-apple-darwin
  • FreeBSD
    • x86_64-unknown-freebsd
  • OpenBSD
    • x86_64-unknown-openbsd

... and continuously checked against these targets:

  • Illumos
    • x86_64-unknown-illumos

Beyond the aformentioned target triplets, the library is also expected to work against a multitude of omitted architectures.

Installation

Add this to your Cargo.toml:

[dependencies]
region = "3.0.0"

Example

  • Cross-platform equivalents:
let data = [0xDE, 0xAD, 0xBE, 0xEF];

// Page size
let pz = region::page::size();

// VirtualQuery | '/proc/self/maps'
let q  = region::query(data.as_ptr())?;
let qr = region::query_range(data.as_ptr(), data.len())?;

// VirtualAlloc | mmap
let alloc = region::alloc(100, Protection::READ_WRITE)?;

// VirtualProtect | mprotect
region::protect(data.as_ptr(), data.len(), Protection::READ_WRITE_EXECUTE)?;

// ... you can also temporarily change one or more pages' protection
let handle = region::protect_with_handle(data.as_ptr(), data.len(), Protection::READ_WRITE_EXECUTE)?;

// VirtualLock | mlock
let guard = region::lock(data.as_ptr(), data.len())?;

Dependencies

~110KB