Struct ostd::trap::softirq::SoftIrqLine

pub struct SoftIrqLine { /* private fields */ }

A representation of a software interrupt (softirq) line.

Overview

Softirq is an interrupt mechanism in the kernel that enables bottom-half processing; they are cheaper to execute compared to regular interrupts because softirqs are less time-critical and thus can be processed in a more flexible manner.

The SoftIrqLine struct encapsulates the data and functionality associated with each softirq line, including an identifier and an associated callback that gets triggered when the softirq is raised.

The SoftIrqLine with the smaller ID has the higher execution priority.

Example

// Define an unused softirq id.
const MY_SOFTIRQ_ID: u8 = 4;
// Enable the softirq line of this id.
SoftIrqLine::get(MY_SOFTIRQ_ID).enable(|| {
    // Define the action to take when the softirq with MY_SOFTIRQ_ID is raised
    // ...
});
// Later on:
SoftIrqLine::get(MY_SOFTIRQ_ID).raise(); // This will trigger the registered callback

Implementations

impl SoftIrqLine

pub fn get(id: u8) -> &'static SoftIrqLine

Gets a softirq line.

The value of id must be within 0..NR_LINES.

pub fn id(&self) -> u8

Gets the ID of this softirq line.

pub fn raise(&self)

Raises the softirq, marking it as pending.

If this line is not enabled yet, the method has no effect.

pub fn enable<F>(&self, callback: F)

where F: Fn() + 'static + Sync + Send,

Enables a softirq line by registering its callback.

Panics

Each softirq can only be enabled once.

pub fn is_enabled(&self) -> bool

Returns whether this softirq line is enabled.