Crate wdk_mutex

An idiomatic Rust mutex type for Windows kernel driver development.

The crate will safely check IRQL before doing operations which would cause a STOP CODE of IRQL NOT LESS OR EQUAL (except for RAII dropping of scoped Mutex Guards). In those cases, the API will return an error of the internal type DriverMutexError.

This crate is a work in progress to implement additional mutex types and functionality as required. Contributions, issues, and discussions are welcome.

This crate is not affiliated with the WDK crates provided by Microsoft, but is designed to work with them for Windows Rust Kernel Driver development.

Additional features:

• debug: Enabling this feature will print debug messages to an attached debugger or kernel message viewer when an IRQL error occurs.

Planned updates

• Critical Sections: An idiomatic implementation for entering and leaving a mutex critical section where no underlying T is protected.

Tests

Tests have been conducted on public modules.

All tests are carried out at wdk_mutex_tests, a separate repository which is built as a driver to test all functionality of the wdk-mutex crate. If you wish to run the tests yourself, or contribute, please check that repository.

As this crate integrates into the wdk ecosystem, Microsoft stipulate: This project is still in early stages of development and is not yet recommended for production use.

This is licenced with an MIT Licence, conditions can be found in LICENCE in the crate GitHub repository.

Modules

• errors
  Error types used by wdk-mutex
• fast_mutex
  A Rust idiomatic Windows Kernel Driver FAST_MUTEX type which protects the inner type T
• grt
  GRT - Global Reference Tracker - a module to allow for global allocations of mutex objects with an easy to use API. Easier than manually adding and tracking all static allocations.
• kmutex
  A Rust idiomatic Windows Kernel Driver KMUTEX type which protects the inner type T