nvdimm: virtio_pmem: fix request lifetime and converge broken queue failures
cover nvdimm: virtio_pmem: fix request lifetime and converge broken queue failures
Hi,
The virtio-pmem flush path uses a virtqueue cookie/token to carry a per-request context through completion. Under broken virtqueue / notify failure conditions, the submitter can return and free the request object while the host/backend may still complete the published request. The IRQ completion handler then dereferences freed memory when waking waiters, which is reported by KASAN as a slab-use-after-free and may manifest as lock corruption (e.g. "BUG: spinlock already unlocked") without KASAN.
In addition, the flush path has two wait sites: one for virtqueue descriptor availability (-ENOSPC from virtqueue_add_sgs()) and one for request completion. If the virtqueue becomes broken, forward progress is no longer guaranteed and these waiters may sleep indefinitely unless the driver converges the failure and wakes all wait sites.
This series addresses both issues:
1/4 nvdimm: virtio_pmem: always wake -ENOSPC waiters Wake one -ENOSPC waiter for each reclaimed used buffer, decoupled from token completion, and use READ_ONCE()/WRITE_ONCE() for wait flags.
2/4 nvdimm: virtio_pmem: refcount requests for token lifetime Refcount request objects so the token lifetime spans the window where it is reachable through the virtqueue until completion/drain drops the virtqueue reference.
3/4 nvdimm: virtio_pmem: converge broken virtqueue to -EIO Track a device-level broken state to converge broken/notify failures to -EIO: wake all waiters and drain/detach outstanding requests to complete them with an error, and fail-fast new requests.
4/4 nvdimm: virtio_pmem: drain requests in freeze Drain outstanding requests in freeze() before tearing down virtqueues so waiters do not sleep indefinitely.
Testing was done on QEMU x86_64 with a virtio-pmem device exported as /dev/pmem0, formatted with ext4 (-O fast_commit), mounted with DAX, and stressed with fsync-heavy workloads.
Thanks,
Li Chen
Li Chen (4):
nvdimm: virtio_pmem: always wake -ENOSPC waiters
nvdimm: virtio_pmem: refcount requests for token lifetime
nvdimm: virtio_pmem: converge broken virtqueue to -EIO
nvdimm: virtio_pmem: drain requests in freeze
drivers/nvdimm/nd_virtio.c | 134 +++++++++++++++++++++++++++++------ drivers/nvdimm/virtio_pmem.c | 14 ++++ drivers/nvdimm/virtio_pmem.h | 6 ++ 3 files changed, 133 insertions(+), 21 deletions(-)
Signature · 1 line
2.51.0
PATCH 1/4 nvdimm: virtio_pmem: always wake -ENOSPC waiters
virtio_pmem_host_ack() reclaims virtqueue descriptors with virtqueue_get_buf(). The -ENOSPC waiter wakeup is tied to completing the returned token.
If token completion is skipped for any reason, reclaimed descriptors may not wake a waiter and the submitter may sleep forever waiting for a free slot.
Always wake one -ENOSPC waiter for each virtqueue completion before touching the returned token.
Use READ_ONCE()/WRITE_ONCE() for the wait_event() flags (done and wq_buf_avail). They are observed by waiters without pmem_lock, so make the accesses explicit single loads/stores and avoid compiler reordering/caching across the wait/wake paths.
--- drivers/nvdimm/nd_virtio.c | 35 +++++++++++++++++++++-------------- 1 file changed, 21 insertions(+), 14 deletions(-)
drivers/nvdimm/nd_virtio.c +21 -14
@@ -9,26 +9,33 @@#include "virtio_pmem.h" #include "nd.h" +static void virtio_pmem_wake_one_waiter (struct virtio_pmem *vpmem) +{ +struct virtio_pmem_request *req_buf; + +if (list_empty (&vpmem->req_list)) +return ; + + req_buf =list_first_entry (&vpmem->req_list, + struct virtio_pmem_request, list); +list_del_init (&req_buf->list); +WRITE_ONCE (req_buf->wq_buf_avail, true); +wake_up (&req_buf->wq_buf); +} +/* The interrupt handler */ void virtio_pmem_host_ack (struct virtqueue *vq) {struct virtio_pmem *vpmem = vq->vdev->priv; -struct virtio_pmem_request *req_data, *req_buf; +struct virtio_pmem_request *req_data;unsigned long flags;unsigned int len;spin_lock_irqsave (&vpmem->pmem_lock, flags);while ((req_data =virtqueue_get_buf (vq, &len)) !=NULL ) { - req_data->done = true; +virtio_pmem_wake_one_waiter (vpmem); +WRITE_ONCE (req_data->done, true);wake_up (&req_data->host_acked); - -if (!list_empty (&vpmem->req_list)) { - req_buf =list_first_entry (&vpmem->req_list, - struct virtio_pmem_request, list); - req_buf->wq_buf_avail = true; -wake_up (&req_buf->wq_buf); -list_del (&req_buf->list); - } }spin_unlock_irqrestore (&vpmem->pmem_lock, flags); }
@@ -58,7 +65,7 @@ static int virtio_pmem_flush(struct nd_region *nd_region)if (!req_data)return -ENOMEM ; - req_data->done = false; +WRITE_ONCE (req_data->done, false);init_waitqueue_head (&req_data->host_acked);init_waitqueue_head (&req_data->wq_buf);INIT_LIST_HEAD (&req_data->list);
@@ -79,12 +86,12 @@ static int virtio_pmem_flush(struct nd_region *nd_region) GFP_ATOMIC)) == -ENOSPC) {dev_info (&vdev->dev,"failed to send command to virtio pmem device, no free slots in the virtqueue\n" ); - req_data->wq_buf_avail = false; +WRITE_ONCE (req_data->wq_buf_avail, false);list_add_tail (&req_data->list, &vpmem->req_list);spin_unlock_irqrestore (&vpmem->pmem_lock, flags);/* A host response results in "host_ack" getting called */ -wait_event (req_data->wq_buf, req_data->wq_buf_avail); +wait_event (req_data->wq_buf,READ_ONCE (req_data->wq_buf_avail));spin_lock_irqsave (&vpmem->pmem_lock, flags); } err1 =virtqueue_kick (vpmem->req_vq);
@@ -98,7 +105,7 @@ static int virtio_pmem_flush(struct nd_region *nd_region) err = -EIO ; }else {/* A host response results in "host_ack" getting called */ -wait_event (req_data->host_acked, req_data->done); +wait_event (req_data->host_acked,READ_ONCE (req_data->done)); err =le32_to_cpu (req_data->resp.ret); }
Signature · 1 line
2.51.0
PATCH 2/4 nvdimm: virtio_pmem: refcount requests for token lifetime
In reply to Li ChenKASAN reports a slab use-after-free from virtio_pmem_host_ack(). It happens when it wakes a request that has already been freed by the submitter.
This happens when the request token is still reachable via the virtqueue, but virtio_pmem_flush() returns and frees it.
Fix the token lifetime by refcounting struct virtio_pmem_request. virtio_pmem_flush() holds a submitter reference, and the virtqueue holds an extra reference once the request is queued. The completion path drops the virtqueue reference, and the submitter drops its reference before returning.
--- drivers/nvdimm/nd_virtio.c | 34 +++++++++++++++++++++++++++++----- drivers/nvdimm/virtio_pmem.h | 2 ++ 2 files changed, 31 insertions(+), 5 deletions(-)
drivers/nvdimm/nd_virtio.c +29 -5
@@ -9,6 +9,14 @@#include "virtio_pmem.h" #include "nd.h" +static void virtio_pmem_req_release (struct kref *kref) +{ +struct virtio_pmem_request *req; + + req = container_of(kref, struct virtio_pmem_request, kref); +kfree (req); +} +static void virtio_pmem_wake_one_waiter (struct virtio_pmem *vpmem) {struct virtio_pmem_request *req_buf;
@@ -36,6 +44,7 @@ void virtio_pmem_host_ack(struct virtqueue *vq)virtio_pmem_wake_one_waiter (vpmem);WRITE_ONCE (req_data->done, true);wake_up (&req_data->host_acked); +kref_put (&req_data->kref, virtio_pmem_req_release); }spin_unlock_irqrestore (&vpmem->pmem_lock, flags); }
@@ -65,6 +74,7 @@ static int virtio_pmem_flush(struct nd_region *nd_region)if (!req_data)return -ENOMEM ; +kref_init (&req_data->kref);WRITE_ONCE (req_data->done, false);init_waitqueue_head (&req_data->host_acked);init_waitqueue_head (&req_data->wq_buf);
@@ -82,10 +92,23 @@ static int virtio_pmem_flush(struct nd_region *nd_region)* to req_list and wait for host_ack to wake us up when free * slots are available. */ -while ((err =virtqueue_add_sgs (vpmem->req_vq, sgs,1 ,1 , req_data, -GFP_ATOMIC )) == -ENOSPC ) { - -dev_info (&vdev->dev,"failed to send command to virtio pmem device, no free slots in the virtqueue\n" ); +for (;;) { + err =virtqueue_add_sgs (vpmem->req_vq, sgs,1 ,1 , req_data, +GFP_ATOMIC ); +if (!err) { +/* +* Take the virtqueue reference while @pmem_lock is +* held so completion cannot run concurrently. +*/ +kref_get (&req_data->kref); +break ; + } + +if (err != -ENOSPC ) +break ; + +dev_info_ratelimited (&vdev->dev, +"failed to send command to virtio pmem device, no free slots in the virtqueue\n" );WRITE_ONCE (req_data->wq_buf_avail, false);list_add_tail (&req_data->list, &vpmem->req_list);spin_unlock_irqrestore (&vpmem->pmem_lock, flags);
@@ -94,6 +117,7 @@ static int virtio_pmem_flush(struct nd_region *nd_region)wait_event (req_data->wq_buf,READ_ONCE (req_data->wq_buf_avail));spin_lock_irqsave (&vpmem->pmem_lock, flags); } + err1 =virtqueue_kick (vpmem->req_vq);spin_unlock_irqrestore (&vpmem->pmem_lock, flags);/*
@@ -109,7 +133,7 @@ static int virtio_pmem_flush(struct nd_region *nd_region) err =le32_to_cpu (req_data->resp.ret); } -kfree (req_data); +kref_put (&req_data->kref, virtio_pmem_req_release);return err; };
drivers/nvdimm/virtio_pmem.h +2 -0
@@ -12,10 +12,12 @@#include <linux/module.h> #include <uapi/linux/virtio_pmem.h> +#include <linux/kref.h> #include <linux/libnvdimm.h> #include <linux/spinlock.h> struct virtio_pmem_request { +struct kref kref;struct virtio_pmem_req req;struct virtio_pmem_resp resp;
Signature · 1 line
2.51.0
PATCH 3/4 nvdimm: virtio_pmem: converge broken virtqueue to -EIO
In reply to Li Chenvirtio_pmem_flush() waits for either a free virtqueue descriptor (-ENOSPC) or a host completion. If the request virtqueue becomes broken (e.g. virtqueue_kick() notify failure), those waiters may never make progress.
Track a device-level broken state and converge all error paths to -EIO. Fail fast for new requests, wake all -ENOSPC waiters, and drain/detach outstanding request tokens to complete them with an error.
--- drivers/nvdimm/nd_virtio.c | 73 +++++++++++++++++++++++++++++++++--- drivers/nvdimm/virtio_pmem.c | 7 ++++ drivers/nvdimm/virtio_pmem.h | 4 ++ 3 files changed, 78 insertions(+), 6 deletions(-)
drivers/nvdimm/nd_virtio.c +67 -6
@@ -17,6 +17,18 @@ static void virtio_pmem_req_release(struct kref *kref)kfree (req); } +static void virtio_pmem_signal_done (struct virtio_pmem_request *req) +{ +WRITE_ONCE (req->done, true); +wake_up (&req->host_acked); +} + +static void virtio_pmem_complete_err (struct virtio_pmem_request *req) +{ + req->resp.ret =cpu_to_le32 (1 ); +virtio_pmem_signal_done (req); +} +static void virtio_pmem_wake_one_waiter (struct virtio_pmem *vpmem) {struct virtio_pmem_request *req_buf;
@@ -31,6 +43,40 @@ static void virtio_pmem_wake_one_waiter(struct virtio_pmem *vpmem)wake_up (&req_buf->wq_buf); } +static void virtio_pmem_wake_all_waiters (struct virtio_pmem *vpmem) +{ +struct virtio_pmem_request *req, *tmp; + +list_for_each_entry_safe (req, tmp, &vpmem->req_list, list) { +WRITE_ONCE (req->wq_buf_avail, true); +wake_up (&req->wq_buf); +list_del_init (&req->list); + } +} + +void virtio_pmem_mark_broken_and_drain (struct virtio_pmem *vpmem) +{ +struct virtio_pmem_request *req; +unsigned int len; + +if (READ_ONCE (vpmem->broken)) +return ; + +WRITE_ONCE (vpmem->broken, true); +dev_err_once (&vpmem->vdev->dev,"virtqueue is broken\n" ); +virtio_pmem_wake_all_waiters (vpmem); + +while ((req =virtqueue_get_buf (vpmem->req_vq, &len)) !=NULL ) { +virtio_pmem_complete_err (req); +kref_put (&req->kref, virtio_pmem_req_release); + } + +while ((req =virtqueue_detach_unused_buf (vpmem->req_vq)) !=NULL ) { +virtio_pmem_complete_err (req); +kref_put (&req->kref, virtio_pmem_req_release); + } +} +/* The interrupt handler */ void virtio_pmem_host_ack (struct virtqueue *vq) {
@@ -42,8 +88,7 @@ void virtio_pmem_host_ack(struct virtqueue *vq)spin_lock_irqsave (&vpmem->pmem_lock, flags);while ((req_data =virtqueue_get_buf (vq, &len)) !=NULL ) {virtio_pmem_wake_one_waiter (vpmem); -WRITE_ONCE (req_data->done, true); -wake_up (&req_data->host_acked); +virtio_pmem_signal_done (req_data);kref_put (&req_data->kref, virtio_pmem_req_release); }spin_unlock_irqrestore (&vpmem->pmem_lock, flags);
@@ -69,6 +114,9 @@ static int virtio_pmem_flush(struct nd_region *nd_region)return -EIO ; } +if (READ_ONCE (vpmem->broken)) +return -EIO ; +might_sleep (); req_data =kmalloc (sizeof (*req_data),GFP_KERNEL );if (!req_data)
@@ -114,22 +162,35 @@ static int virtio_pmem_flush(struct nd_region *nd_region)spin_unlock_irqrestore (&vpmem->pmem_lock, flags);/* A host response results in "host_ack" getting called */ -wait_event (req_data->wq_buf,READ_ONCE (req_data->wq_buf_avail)); +wait_event (req_data->wq_buf,READ_ONCE (req_data->wq_buf_avail) || +READ_ONCE (vpmem->broken));spin_lock_irqsave (&vpmem->pmem_lock, flags); + +if (READ_ONCE (vpmem->broken)) +break ; } - err1 =virtqueue_kick (vpmem->req_vq); +if (err == -EIO ||virtqueue_is_broken (vpmem->req_vq)) +virtio_pmem_mark_broken_and_drain (vpmem); + + err1 = true; +if (!err && !READ_ONCE (vpmem->broken)) { + err1 =virtqueue_kick (vpmem->req_vq); +if (!err1) +virtio_pmem_mark_broken_and_drain (vpmem); + }spin_unlock_irqrestore (&vpmem->pmem_lock, flags);/* * virtqueue_add_sgs failed with error different than -ENOSPC, we can't * do anything about that. */ -if (err || !err1) { +if (READ_ONCE (vpmem->broken) || err || !err1) {dev_info (&vdev->dev,"failed to send command to virtio pmem device\n" ); err = -EIO ; }else {/* A host response results in "host_ack" getting called */ -wait_event (req_data->host_acked,READ_ONCE (req_data->done)); +wait_event (req_data->host_acked,READ_ONCE (req_data->done) || +READ_ONCE (vpmem->broken)); err =le32_to_cpu (req_data->resp.ret); }
drivers/nvdimm/virtio_pmem.c +7 -0
@@ -25,6 +25,7 @@ static int init_vq(struct virtio_pmem *vpmem)spin_lock_init (&vpmem->pmem_lock);INIT_LIST_HEAD (&vpmem->req_list); +WRITE_ONCE (vpmem->broken, false);return 0 ; };
@@ -137,6 +138,12 @@ static int virtio_pmem_probe(struct virtio_device *vdev)static void virtio_pmem_remove (struct virtio_device *vdev) {struct nvdimm_bus *nvdimm_bus =dev_get_drvdata (&vdev->dev); +struct virtio_pmem *vpmem = vdev->priv; +unsigned long flags; + +spin_lock_irqsave (&vpmem->pmem_lock, flags); +virtio_pmem_mark_broken_and_drain (vpmem); +spin_unlock_irqrestore (&vpmem->pmem_lock, flags);nvdimm_bus_unregister (nvdimm_bus); vdev->config->del_vqs (vdev);
drivers/nvdimm/virtio_pmem.h +4 -0
@@ -44,6 +44,9 @@ struct virtio_pmem {/* List to store deferred work if virtqueue is full */ struct list_head req_list; +/* Fail fast and wake waiters if the request virtqueue is broken. */ +bool broken; +/* Synchronize virtqueue data */ spinlock_t pmem_lock;
@@ -53,5 +56,6 @@ struct virtio_pmem { };void virtio_pmem_host_ack (struct virtqueue *vq); +void virtio_pmem_mark_broken_and_drain (struct virtio_pmem *vpmem);int async_pmem_flush (struct nd_region *nd_region,struct bio *bio);#endif
Signature · 1 line
2.51.0
kernel test robot
build botRe: [PATCH 3/4] nvdimm: virtio_pmem: converge broken virtqueue to -EIO
kernel test robot noticed the following build errors:
Hi Li,
kernel test robot noticed the following build errors:
[auto build test ERROR on nvdimm/libnvdimm-for-next]
[also build test ERROR on linus/master v6.19-rc2]
[cannot apply to nvdimm/dax-misc]
[If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Li-Chen/nvdimm-virtio_pmem-always-wake-ENOSPC-waiters/20251220-163909 base: https://git.kernel.org/pub/scm/linux/kernel/git/nvdimm/nvdimm.git libnvdimm-for-next patch link: https://lore.kernel.org/r/20251220083441.313737-4-me%40linux.beauty patch subject: [PATCH 3/4] nvdimm: virtio_pmem: converge broken virtqueue to -EIO config: riscv-randconfig-r052-20251224 (https://download.01.org/0day-ci/archive/20251225/[email protected]/config) compiler: riscv64-linux-gcc (GCC) 13.4.0 reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20251225/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All errors (new ones prefixed by >>, old ones prefixed by <<):
>> ERROR: modpost: "virtio_pmem_mark_broken_and_drain" [drivers/nvdimm/virtio_pmem.ko] undefined!
Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki
PATCH 4/4 nvdimm: virtio_pmem: drain requests in freeze
In reply to Li Chenvirtio_pmem_freeze() deletes virtqueues and resets the device without waking threads waiting for a virtqueue descriptor or a host completion.
Mark the request virtqueue broken and drain outstanding requests under pmem_lock before teardown so waiters can make progress and return -EIO.
--- drivers/nvdimm/virtio_pmem.c | 7 +++++++ 1 file changed, 7 insertions(+)
drivers/nvdimm/virtio_pmem.c +7 -0
@@ -152,6 +152,13 @@ static void virtio_pmem_remove(struct virtio_device *vdev)static int virtio_pmem_freeze (struct virtio_device *vdev) { +struct virtio_pmem *vpmem = vdev->priv; +unsigned long flags; + +spin_lock_irqsave (&vpmem->pmem_lock, flags); +virtio_pmem_mark_broken_and_drain (vpmem); +spin_unlock_irqrestore (&vpmem->pmem_lock, flags); + vdev->config->del_vqs (vdev);virtio_reset_device (vdev);
Signature · 1 line
2.51.0