Crate hermit_sync

Overview

hermit-sync provides synchronization primitives targeted at operating system kernels.

Interrupts

without_interrupts runs a closure with disabled interrupts.

Mutexes

This crate provides three kinds of mutexes based on lock_api::RawMutex:

• RawSpinMutex is a simple test and test-and-set spinlock with exponential backoff.
• RawTicketMutex is a fair ticket lock with exponential backoff.
• RawInterruptMutex wraps another mutex and disables interrupts while locked.

For API documentation see lock_api::Mutex.

Initializing Static Data

There are two primitives for safely initializing static data based on generic_once_cell and RawSpinMutex:

• OnceCell can be written to only once and can then be accessed without locking.
• Lazy wraps a OnceCell and is initialized on the first access from a closure.

For API documentation see generic_once_cell::OnceCell and generic_once_cell::Lazy.

Type Definitions

This crate provides a lot of type definitions for ease of use:

RawMutex	Base	With RawInterruptMutex
RawSpinMutex	SpinMutex	InterruptSpinMutex
	SpinMutexGuard	InterruptSpinMutexGuard
	OnceCell	InterruptOnceCell
	Lazy	InterruptLazy
RawTicketMutex	TicketMutex	InterruptTicketMutex
	TicketMutexGuard	InterruptTicketMutexGuard

Structs

RawInterruptMutex

An interrupt-safe mutex.

RawSpinMutex

A simple test and test-and-set spinlock with exponential backoff.

RawTicketMutex

A fair ticket lock with exponential backoff.

Functions

without_interrupts

Run a closure with disabled interrupts.

Type Definitions

InterruptLazy

InterruptMutex

InterruptMutexGuard

InterruptOnceCell

InterruptSpinMutex

InterruptSpinMutexGuard

InterruptTicketMutex

InterruptTicketMutexGuard

Lazy

OnceCell

SpinMutex

SpinMutexGuard

TicketMutex

TicketMutexGuard