Struct NamespaceFaultConfig

pub struct NamespaceFaultConfig {
    pub recv_changed_namespace: Receiver<NamespaceChange>,
}

A fault config to trigger spurious namespace change notifications from the controller.

The fault controller listens on the provided channel for notifications containing a u32 value representing the NSID (Namespace Identifier) that has changed. This does not actually modify the namespace; instead, it triggers the controller to process a namespace change notification. The fault is modeled as an RPC, which the controller completes once it has processed the change and sent the corresponding Asynchronous Event Notification (AEN). As per NVMe spec: If multiple namespace changes are notified, only the first triggers an AEN. Subsequent changes do not trigger additional AENs until the driver issues a GET_LOG_PAGE command. For implementation simplicity, namespace fault is not gated by the fault_active flag. Since only test code can send notifications on the fault channel, it is safe to bypass this check.

Example

Send a namespace change notification for NSID 1 and wait for it to be processed.

use mesh::CellUpdater;
use nvme_resources::fault::NamespaceChange;
use nvme_resources::fault::FaultConfiguration;
use nvme_resources::fault::NamespaceFaultConfig;
use nvme_resources::NvmeFaultControllerHandle;
use guid::Guid;
use mesh::rpc::RpcSend;

pub async fn send_namespace_change_fault() {
    let mut fault_start_updater = CellUpdater::new(false);
    let (ns_change_send, ns_change_recv) = mesh::channel::<NamespaceChange>();
    let fault_configuration = FaultConfiguration::new(fault_start_updater.cell())
        .with_namespace_fault(
            NamespaceFaultConfig::new(ns_change_recv),
        );
    // Complete setup
    let fault_controller_handle = NvmeFaultControllerHandle {
        subsystem_id: Guid::new_random(),
        msix_count: 10,
        max_io_queues: 10,
        namespaces: vec![
            // Define `NamespaceDefinitions` here
        ],
        fault_config: fault_configuration,
    };

    // Send the namespace change notification and await processing.
    ns_change_send.call(NamespaceChange::ChangeNotification, 1).await.unwrap();
}

Fields

recv_changed_namespace: Receiver<NamespaceChange>

Receiver for changed namespace notifications

Implementations

impl NamespaceFaultConfig

pub fn new(recv_changed_namespace: Receiver<NamespaceChange>) -> Self

Creates a new NamespaceFaultConfig with a fresh channel.

Trait Implementations

impl DefaultEncoding for NamespaceFaultConfig

type Encoding = TableEncoder

The encoding to use for the serialization.

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

const DECODERS: &'static [ErasedDecoderEntry]

The list of decoder vtables.

impl StructEncodeMetadata<Resource> for NamespaceFaultConfig

const ENCODERS: &'static [ErasedEncoderEntry]

The list of encoder vtables.

impl StructMetadata for NamespaceFaultConfig

const NUMBERS: &'static [u32]

The field numbers for each field.

const OFFSETS: &'static [usize]

The byte offset to each field within the struct.