Skip to main content

MsiRoute

Struct MsiRoute 

Source
pub struct MsiRoute { /* private fields */ }
Expand description

A kernel-mediated MSI interrupt route for a single vector.

Each route has an associated event. Signaling the event causes the hypervisor to inject the configured MSI into the guest without a userspace transition. This is used for device passthrough (VFIO) where the physical device signals the event on interrupt.

Implementations§

Source§

impl MsiRoute

Source

pub fn event(&self) -> &Event

Returns the event that triggers interrupt injection when signaled.

Pass this to VFIO map_msix or any other interrupt source.

Source

pub fn enable(&self, address: u64, data: u32)

Configures the MSI address and data for this route, using the route’s default requester ID (secondary_bus << 8) + rid_offset.

If the resolved bus falls outside the assigned bus range, the route is left disabled and a ratelimited warning is emitted.

Source

pub fn enable_with_rid(&self, rid: u16, address: u64, data: u32)

Configures the MSI address and data for this route, using an explicit segment-local BDF (rid) as the requester ID.

Use this for multi-function devices whose functions span multiple buses: the caller composes the full (bus << 8) | devfn itself from whatever bus range it owns. The route’s own default devfn is bypassed.

The bus portion of rid is validated against the route’s assigned bus range; if it falls outside the range the route is left disabled and a ratelimited warning is emitted.

Source

pub fn disable(&self)

Disables the MSI route. Interrupts that arrive while disabled remain pending on the event and will be delivered when enable is called, or can be drained via consume_pending.

Source

pub fn consume_pending(&self) -> bool

Drains pending interrupt state and returns whether an interrupt was pending while the route was masked.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more