Struct IoQueueFaultConfig

pub struct IoQueueFaultConfig {
    pub io_completion_queue_faults: Vec<(CommandMatch, IoQueueFaultBehavior)>,
    pub fault_active: Cell<bool>,
}

A fault configuration to inject faults into the io completions.

This struct maintains a mapping from CommandMatch to IoQueueFaultBehavior for completions. When a command match is found, (and fault_active == true) the associated fault is applied. If there is more than one match for a given command, the match defined first is prioritized. Faults are added via the with_completion_queue_fault method and calls can be chained. IoQueueFaultConfig::new() creates an empty fault.

Panics

Panics if a duplicate CommandMatch is added

Example

Panic when RESERVATION_REPORT command is seen.

use mesh::CellUpdater;
use nvme_resources::fault::IoQueueFaultConfig;
use nvme_resources::fault::CommandMatch;
use nvme_resources::fault::FaultConfiguration;
use nvme_resources::fault::IoQueueFaultBehavior;
use nvme_spec::Command;
use nvme_spec::nvm;
use zerocopy::FromZeros;
use zerocopy::IntoBytes;

pub fn build_admin_queue_fault() -> FaultConfiguration {
    let mut fault_start_updater = CellUpdater::new(false);

    // Setup command matches
    let mut command_io_queue = Command::new_zeroed();
    let mut command_log_page = Command::new_zeroed();
    let mut mask = Command::new_zeroed();

    command_io_queue.cdw0 = command_io_queue.cdw0.with_opcode(nvm::NvmOpcode::RESERVATION_REPORT.0);
    mask.cdw0 = mask.cdw0.with_opcode(u8::MAX);

    return FaultConfiguration::new(fault_start_updater.cell())
        .with_io_queue_fault(
            IoQueueFaultConfig::new(fault_start_updater.cell()).with_completion_queue_fault(
                CommandMatch {
                    command: command_io_queue,
                    mask: mask.as_bytes().try_into().expect("mask should be 64 bytes"),
                },
                IoQueueFaultBehavior::Panic("Received a RESERVATION_REPORT command".to_string()),
            )
        );
}

Fields

io_completion_queue_faults: Vec<(CommandMatch, IoQueueFaultBehavior)>

A map of NVME opcodes to the completion fault behavior for each.

fault_active: Cell<bool>

Fault active state. (Repeated here because FaultConfiguration is not Cloneable).

Implementations

impl IoQueueFaultConfig

pub fn new(fault_active: Cell<bool>) -> Self

Create an empty IO queue fault configuration

pub fn with_completion_queue_fault( self, pattern: CommandMatch, behaviour: IoQueueFaultBehavior, ) -> Self

Add a CommandMatch -> IoQueueFaultBehavior mapping for the completion queue.

Panics

Panics if an identical CommandMatch has already been configured.

Trait Implementations

impl Clone for IoQueueFaultConfig

fn clone(&self) -> IoQueueFaultConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DefaultEncoding for IoQueueFaultConfig

type Encoding = TableEncoder

The encoding to use for the serialization.

impl<'encoding> StructDecodeMetadata<'encoding, Resource> for IoQueueFaultConfig

const DECODERS: &'static [ErasedDecoderEntry]

The list of decoder vtables.

impl StructEncodeMetadata<Resource> for IoQueueFaultConfig

const ENCODERS: &'static [ErasedEncoderEntry]

The list of encoder vtables.

impl StructMetadata for IoQueueFaultConfig

const NUMBERS: &'static [u32]

The field numbers for each field.

const OFFSETS: &'static [usize]

The byte offset to each field within the struct.