admin/StephanvanSchaik-windows-kernel-rs
1
0
Fork 0
mirror of https://github.com/StephanvanSchaik/windows-kernel-rs synced 2026-08-09 12:23:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

README: add list of features and add note about articles

Browse Source
This commit is contained in:
S.J.R. van Schaik
2021-10-28 02:08:17 -04:00
parent 04c8d5dcd3
commit 814d706534
1 changed files with 28 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+28 -1
View File
@@ -4,7 +4,34 @@
This is a Windows kernel framework in Rust that consists of [windows-kernel-sys](windows-kernel-sys), a crate that provides low-level unsafe bindings generated using [bindgen](https://github.com/rust-lang/rust-bindgen), and [windows-kernel-rs](windows-kernel-rs), a crate that provides safe abstractions in Rust on top.
In addition, there are articles that covers implementing Windows kernel drivers in Rust from the ground up, including corresponding examples provided as part of this repository:
## Features
To give you an idea of whether these crates are useful to you, here is a non-exhaustive overview of the features that are currently supported and that are more or less planned:
* [x] `KernelModule` to provide safe entry and exit points to your driver.
* [x] Batteries included: panic handler, global allocator, etc.
* [x] Rust error handling using `Result`.
* [x] Device API to quickly set up with devices with a trait to provide the various callbacks.
* [x] Support for reading from and writing to devices.
* [x] Support for handling device I/O controls.
* [x] Basic safe abstraction on top of I/O Request Packets (IRPs) using Rust ownership to model their lifetimes.
* [x] Basic support for Memory Descriptor Lists (MDLs).
* [x] Version API to query the current version of Microsoft Windows.
* [x] Affinity API to run closures on a specific CPU or all CPUs in the system.
* [x] Device API
* [x] `FastMutex` (similar to [`Mutex`](https://doc.rust-lang.org/std/sync/struct.Mutex.html)) based on the `FAST_MUTEX` API.
* [x] `PushLock` (similar to [`RwLock`](https://doc.rust-lang.org/std/sync/struct.RwLock.html)) based on the `EX_PUSH_LOCK` API.
* [x] Abstraction for processes and process attachments to execute code in the context of a process.
* [x] Abstraction for sections.
* [x] Basic x86-64 intrinsics.
* [ ] More complete model of IRP handling.
* [ ] Support for x86 and AArch64.
## Articles
**Note**: this framework may progress faster than I can keep my articles up-to-date. They may currently be due for a bit of a rewrite to reflect some of the changes that made it into this repository since I have written the articles.
In addition, there are articles that cover implementing Windows kernel drivers in Rust from the ground up, including corresponding examples provided as part of this repository:
1. [Prerequisites](https://codentium.com/guides/windows-dev/windows-drivers-in-rust-prerequisites)
2. [Hello World](https://codentium.com/guides/windows-dev/windows-drivers-in-rust-hello-world) - [02-hello-world](02-hello-world)