NVMe: Enable IO queue deletion plus some init/reset cleanup. (#58)

Author: luqmana

propolis/src/hw/nvme/admin.rs

@@ -2,6 +2,7 @@ use std::cmp::min;
 use std::mem::size_of;
 
 use super::bits::{self, *};
+use super::queue::{QueueId, ADMIN_QUEUE_ID};
 use crate::common::GuestAddr;
 use crate::{common::PAGE_SIZE, dispatch::DispCtx};
 
@@ -16,6 +17,14 @@ impl NvmeCtrl {
         cmd: &cmds::CreateIOCQCmd,
         ctx: &DispCtx,
     ) -> cmds::Completion {
+        // If the host hasn't specified an IOCQES, fail this request
+        if self.ctrl.cc.iocqes() == 0 {
+            return cmds::Completion::specific_err(
+                StatusCodeType::CmdSpecific,
+                STS_CREATE_IO_Q_INVAL_QSIZE,
+            );
+        }
+
         if cmd.intr_vector >= super::NVME_MSIX_COUNT {
             return cmds::Completion::specific_err(
                 StatusCodeType::CmdSpecific,
@@ -57,6 +66,14 @@ impl NvmeCtrl {
         cmd: &cmds::CreateIOSQCmd,
         ctx: &DispCtx,
     ) -> cmds::Completion {
+        // If the host hasn't specified an IOSQES, fail this request
+        if self.ctrl.cc.iosqes() == 0 {
+            return cmds::Completion::specific_err(
+                StatusCodeType::CmdSpecific,
+                STS_CREATE_IO_Q_INVAL_QSIZE,
+            );
+        }
+
         // We only support physical contiguous queues
         if !cmd.phys_contig {
             return cmds::Completion::generic_err(bits::STS_INVAL_FIELD);
@@ -89,6 +106,79 @@ impl NvmeCtrl {
         }
     }
 
+    /// Service I/O Delete Completion Queue command.
+    ///
+    /// See NVMe 1.0e Section 5.5 Delete I/O Submission Queue command
+    pub(super) fn acmd_delete_io_cq(
+        &mut self,
+        cqid: QueueId,
+        _ctx: &DispCtx,
+    ) -> cmds::Completion {
+        // Not allowed to delete the Admin Completion Queue
+        if cqid == ADMIN_QUEUE_ID {
+            return cmds::Completion::specific_err(
+                StatusCodeType::CmdSpecific,
+                STS_DELETE_IO_Q_INVAL_QID,
+            );
+        }
+
+        // Remove the CQ from our list of active CQs.
+        // At this point, all associated SQs should've been deleted
+        // otherwise we'll return an error.
+        match self.delete_cq(cqid) {
+            Ok(()) => cmds::Completion::success(),
+            Err(NvmeError::InvalidCompQueue(_)) => {
+                cmds::Completion::specific_err(
+                    StatusCodeType::CmdSpecific,
+                    STS_DELETE_IO_Q_INVAL_QID,
+                )
+            }
+            Err(NvmeError::AssociatedSubQueuesStillExist(_, _)) => {
+                cmds::Completion::specific_err(
+                    StatusCodeType::CmdSpecific,
+                    STS_DELETE_IO_Q_INVAL_Q_DELETION,
+                )
+            }
+            _ => cmds::Completion::generic_err(STS_INTERNAL_ERR),
+        }
+    }
+
+    /// Service I/O Delete Submission Queue command.
+    ///
+    /// See NVMe 1.0e Section 5.6 Delete I/O Submission Queue command
+    pub(super) fn acmd_delete_io_sq(
+        &mut self,
+        sqid: QueueId,
+        _ctx: &DispCtx,
+    ) -> cmds::Completion {
+        // Not allowed to delete the Admin Submission Queue
+        if sqid == ADMIN_QUEUE_ID {
+            return cmds::Completion::specific_err(
+                StatusCodeType::CmdSpecific,
+                STS_DELETE_IO_Q_INVAL_QID,
+            );
+        }
+
+        // Remove the SQ from our list of active SQs which will stop
+        // us from accepting any new requests for it.
+        // That should be the only strong ref left to the SubQueue
+        // Any in-flight I/O requests that haven't been completed yet
+        // only hold a weak ref (via CompQueueEntryPermit).
+        // Note: The NVMe 1.0e spec says "The command causes all commands
+        //       submitted to the indicated Submission Queue that are still in
+        //       progress to be aborted."
+        match self.delete_sq(sqid) {
+            Ok(()) => cmds::Completion::success(),
+            Err(NvmeError::InvalidSubQueue(_)) => {
+                cmds::Completion::specific_err(
+                    StatusCodeType::CmdSpecific,
+                    STS_DELETE_IO_Q_INVAL_QID,
+                )
+            }
+            _ => cmds::Completion::generic_err(STS_INTERNAL_ERR),
+        }
+    }
+
     /// Service Get Log Page command.
     ///
     /// See NVMe 1.0e Section 5.10 Get Log Page command

propolis/src/hw/nvme/bits.rs

@@ -235,7 +235,7 @@ bitstruct! {
     /// Representation of the Controller Configuration (CC) register.
     ///
     /// See NVMe 1.0e Section 3.1.5 Offset 14h: CC - Controller Configuration
-    #[derive(Clone, Copy, Debug, Default)]
+    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
     pub struct Configuration(pub u32) {
         /// Enable (EN)
         ///
@@ -291,7 +291,7 @@ bitstruct! {
 }
 
 // Selected IO Command Set
-#[derive(Clone, Copy, Debug)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
 pub enum IOCommandSet {
     Nvm,
     Reserved(u8),
@@ -317,7 +317,7 @@ impl bitstruct::IntoRaw<u8, IOCommandSet> for Configuration {
 }
 
 /// Arbitration Mechanisms
-#[derive(Clone, Copy, Debug)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
 pub enum ArbitrationMechanism {
     RoundRobin,
     WeightedRoundRobinWithUrgent,
@@ -583,15 +583,21 @@ pub const STS_COMMAND_SEQ_ERR: u8 = 0xC;
 /// Completion Queue Invalid
 pub const STS_CREATE_IO_Q_INVAL_CQ: u8 = 0x0;
 
-/// Invalid Queue Identifier
+/// Invalid Queue Identifier (Queue Creation)
 pub const STS_CREATE_IO_Q_INVAL_QID: u8 = 0x1;
 
-/// Invalid Queue Size
+/// Invalid Queue Size (Queue Creation)
 pub const STS_CREATE_IO_Q_INVAL_QSIZE: u8 = 0x2;
 
-/// Invalid Interrupt Vector
+/// Invalid Interrupt Vector (Queue Creation)
 pub const STS_CREATE_IO_Q_INVAL_INT_VEC: u8 = 0x8;
 
+/// Invalid Queue Identifier (Queue Deletion)
+pub const STS_DELETE_IO_Q_INVAL_QID: u8 = 0x1;
+
+/// Invalid Queue Deletion
+pub const STS_DELETE_IO_Q_INVAL_Q_DELETION: u8 = 0xC;
+
 // NVM Command Specific Status values
 // See NVMe 1.0e Section 4.5.1.2.2, Figure 20 Status Code - Command Specific Status Values, NVM Command Set
 

propolis/src/hw/nvme/cmds.rs

@@ -784,6 +784,12 @@ impl From<QueueCreateErr> for Completion {
                 StatusCodeType::CmdSpecific,
                 bits::STS_CREATE_IO_Q_INVAL_QSIZE,
             ),
+            QueueCreateErr::SubQueueIdAlreadyExists(_) => {
+                Completion::specific_err(
+                    StatusCodeType::CmdSpecific,
+                    bits::STS_CREATE_IO_Q_INVAL_QID,
+                )
+            }
         }
     }
 }