* [RFT PATCH 1/2] xhci: sideband: avoid use-after-free of stale virt device pointer
2026-11-18 12:51 [RFT PATCH 0/2] xhci: sideband: fix use-after-free of stale virt device pointer Mathias Nyman
@ 2026-11-18 12:51 ` Mathias Nyman
2026-11-18 13:13 ` sashiko-bot
2026-11-18 12:51 ` [RFT PATCH 2/2] xhci: sideband: check virt device under xhci lock when stopping endpoints Mathias Nyman
1 sibling, 1 reply; 5+ messages in thread
From: Mathias Nyman @ 2026-11-18 12:51 UTC (permalink / raw)
To: quic_wcheng, hulianqin, selvarasu.g; +Cc: linux-usb, Mathias Nyman
The sideband structure caches vdev, an xhci_virt_device pointer that
the xhci driver may free and reallocate while the sideband is still
registered, leaving the sideband with a dangling sb->vdev pointer.
This can happen during resume, either when the xhci driver detects xHC
power loss and resets the xHC, freeing all virt devices without
informing class drivers, or during reset-resume when usb core
re-enumerates the device and xhci frees and allocates a new virt device.
Store the usb_device pointer (udev) instead. It stays valid across
reset-resume and xHC reset.
Look up the current virt device and ensure it still points to this
sideband before using and dereferencing it in sideband API calls.
Make sure xhci_sideband_unregister() works properly with an invalid
vdev. Don't dereference it, or ask the xHC to stop non-existing
endpoints, but make sure the sideband is properly freed.
Fail other relevant sideband API calls that would access invalid
vdev with -ENODEV.
This solution isn't airtight. It's a huge improvement over the current
situation, but there is still a window between verifying vdev and
actually dereferencing it in many sideband API calls.
Signed-off-by: Mathias Nyman <mathias.nyman@linux.intel.com>
---
drivers/usb/host/xhci-sideband.c | 47 ++++++++++++++++++++-----------
include/linux/usb/xhci-sideband.h | 4 +--
2 files changed, 33 insertions(+), 18 deletions(-)
diff --git a/drivers/usb/host/xhci-sideband.c b/drivers/usb/host/xhci-sideband.c
index a5deeee4d5dc..ad4849903df3 100644
--- a/drivers/usb/host/xhci-sideband.c
+++ b/drivers/usb/host/xhci-sideband.c
@@ -75,6 +75,22 @@ xhci_ring_to_sgtable(struct xhci_sideband *sb, struct xhci_ring *ring)
return NULL;
}
+/* Return the current vdev of sb->udev, or NULL if it was freed or reallocated */
+static struct xhci_virt_device *
+sideband_to_vdev(struct xhci_sideband *sb)
+{
+ struct xhci_virt_device *vdev;
+
+ if (!sb->udev || !sb->udev->slot_id)
+ return NULL;
+
+ vdev = sb->xhci->devs[sb->udev->slot_id];
+ if (vdev && vdev->sideband == sb)
+ return vdev;
+
+ return NULL;
+}
+
/* Caller must hold sb->mutex */
static void
__xhci_sideband_remove_endpoint(struct xhci_sideband *sb, struct xhci_virt_ep *ep)
@@ -146,16 +162,18 @@ int
xhci_sideband_add_endpoint(struct xhci_sideband *sb,
struct usb_host_endpoint *host_ep)
{
+ struct xhci_virt_device *vdev;
struct xhci_virt_ep *ep;
unsigned int ep_index;
guard(mutex)(&sb->mutex);
- if (!sb->vdev)
+ vdev = sideband_to_vdev(sb);
+ if (!vdev)
return -ENODEV;
ep_index = xhci_get_endpoint_index(&host_ep->desc);
- ep = &sb->vdev->eps[ep_index];
+ ep = &vdev->eps[ep_index];
if (ep->ep_state & EP_HAS_STREAMS)
return -EINVAL;
@@ -202,9 +220,10 @@ xhci_sideband_remove_endpoint(struct xhci_sideband *sb,
ep_index = xhci_get_endpoint_index(&host_ep->desc);
ep = sb->eps[ep_index];
- if (!ep || !ep->sideband || ep->sideband != sb)
+ if (!sideband_to_vdev(sb) || !ep || ep->sideband != sb) {
+ sb->eps[ep_index] = NULL;
return -ENODEV;
-
+ }
__xhci_sideband_remove_endpoint(sb, ep);
return 0;
@@ -221,7 +240,7 @@ xhci_sideband_stop_endpoint(struct xhci_sideband *sb,
ep_index = xhci_get_endpoint_index(&host_ep->desc);
ep = sb->eps[ep_index];
- if (!ep || !ep->sideband || ep->sideband != sb)
+ if (!sideband_to_vdev(sb) || !ep || ep->sideband != sb)
return -EINVAL;
return xhci_stop_endpoint_sync(sb->xhci, ep, 0, GFP_KERNEL);
@@ -251,7 +270,7 @@ xhci_sideband_get_endpoint_buffer(struct xhci_sideband *sb,
ep_index = xhci_get_endpoint_index(&host_ep->desc);
ep = sb->eps[ep_index];
- if (!ep || !ep->ring || !ep->sideband || ep->sideband != sb)
+ if (!sideband_to_vdev(sb) || !ep || !ep->ring || ep->sideband != sb)
return NULL;
return xhci_ring_to_sgtable(sb, ep->ring);
@@ -329,9 +348,6 @@ xhci_sideband_create_interrupter(struct xhci_sideband *sb, int num_seg,
guard(mutex)(&sb->mutex);
- if (!sb->vdev)
- return -ENODEV;
-
if (sb->ir)
return -EBUSY;
@@ -436,7 +452,7 @@ xhci_sideband_register(struct usb_interface *intf, enum xhci_sideband_type type,
}
sb->xhci = xhci;
- sb->vdev = vdev;
+ sb->udev = udev;
sb->intf = intf;
sb->type = type;
sb->notify_client = notify_client;
@@ -471,22 +487,21 @@ xhci_sideband_unregister(struct xhci_sideband *sb)
xhci = sb->xhci;
scoped_guard(mutex, &sb->mutex) {
- vdev = sb->vdev;
- if (!vdev)
- return;
+ vdev = sideband_to_vdev(sb);
for (i = 0; i < EP_CTX_PER_DEV; i++)
- if (sb->eps[i])
+ if (vdev && sb->eps[i])
__xhci_sideband_remove_endpoint(sb, sb->eps[i]);
__xhci_sideband_remove_interrupter(sb);
- sb->vdev = NULL;
+ sb->udev = NULL;
}
spin_lock_irq(&xhci->lock);
sb->xhci = NULL;
- vdev->sideband = NULL;
+ if (vdev)
+ vdev->sideband = NULL;
spin_unlock_irq(&xhci->lock);
kfree(sb);
diff --git a/include/linux/usb/xhci-sideband.h b/include/linux/usb/xhci-sideband.h
index 005257085dcb..2d153cb57831 100644
--- a/include/linux/usb/xhci-sideband.h
+++ b/include/linux/usb/xhci-sideband.h
@@ -39,7 +39,7 @@ struct xhci_sideband_event {
/**
* struct xhci_sideband - representation of a sideband accessed usb device.
* @xhci: The xhci host controller the usb device is connected to
- * @vdev: the usb device accessed via sideband
+ * @udev: the usb device accessed via sideband
* @eps: array of endpoints controlled via sideband
* @ir: event handling and buffer for sideband accessed device
* @type: xHCI sideband type
@@ -51,7 +51,7 @@ struct xhci_sideband_event {
*/
struct xhci_sideband {
struct xhci_hcd *xhci;
- struct xhci_virt_device *vdev;
+ struct usb_device *udev;
struct xhci_virt_ep *eps[EP_CTX_PER_DEV];
struct xhci_interrupter *ir;
enum xhci_sideband_type type;
--
2.43.0
^ permalink raw reply related [flat|nested] 5+ messages in thread* [RFT PATCH 2/2] xhci: sideband: check virt device under xhci lock when stopping endpoints
2026-11-18 12:51 [RFT PATCH 0/2] xhci: sideband: fix use-after-free of stale virt device pointer Mathias Nyman
2026-11-18 12:51 ` [RFT PATCH 1/2] xhci: sideband: avoid " Mathias Nyman
@ 2026-11-18 12:51 ` Mathias Nyman
2026-11-18 13:16 ` sashiko-bot
1 sibling, 1 reply; 5+ messages in thread
From: Mathias Nyman @ 2026-11-18 12:51 UTC (permalink / raw)
To: quic_wcheng, hulianqin, selvarasu.g; +Cc: linux-usb, Mathias Nyman
The sideband virt device lookup and the endpoint checks in
xhci_sideband_stop_endpoint(), xhci_sideband_remove_endpoint() and
xhci_sideband_unregister() are done without holding the xhci lock.
The xhci driver may free or reallocate the virt device between the check
and the actual stop endpoint command. This can happen during xHC reset
in resume, reset-resume, or retried enumeration.
Move the stop endpoint code from xhci_stop_endpoint_sync() in xhci.c to
a new sideband_stop_endpoint_sync() helper in xhci-sideband.c. It
verifies the virt device and endpoint, and queues the stop endpoint
command, while holding the xhci lock. Removing an endpoint from the
sideband is done in the same locked section.
xhci_stop_endpoint_sync() has no other users, so remove it.
Also take the sideband mutex in xhci_sideband_stop_endpoint(), and keep
holding it in xhci_sideband_unregister() until the sideband is detached
from the virt device. Doing so serializes these with the other sideband
API calls.
Signed-off-by: Mathias Nyman <mathias.nyman@linux.intel.com>
---
drivers/usb/host/xhci-sideband.c | 110 +++++++++++++++++++++----------
drivers/usb/host/xhci.c | 55 ----------------
drivers/usb/host/xhci.h | 2 -
3 files changed, 76 insertions(+), 91 deletions(-)
diff --git a/drivers/usb/host/xhci-sideband.c b/drivers/usb/host/xhci-sideband.c
index ad4849903df3..39d790bb6a2b 100644
--- a/drivers/usb/host/xhci-sideband.c
+++ b/drivers/usb/host/xhci-sideband.c
@@ -92,19 +92,72 @@ sideband_to_vdev(struct xhci_sideband *sb)
}
/* Caller must hold sb->mutex */
-static void
-__xhci_sideband_remove_endpoint(struct xhci_sideband *sb, struct xhci_virt_ep *ep)
+static int
+sideband_stop_endpoint_sync(struct xhci_sideband *sb, u32 ep_index, bool remove)
{
+ struct xhci_virt_device *vdev;
+ struct xhci_command *cmd;
+ struct xhci_virt_ep *ep;
+ struct xhci_ep_ctx *ctx;
+ unsigned long flags;
+ bool queued = false;
+ int ret = -ENODEV;
+
lockdep_assert_held(&sb->mutex);
- /*
- * Issue a stop endpoint command when an endpoint is removed.
- * The stop ep cmd handler will handle the ring cleanup.
- */
- xhci_stop_endpoint_sync(sb->xhci, ep, 0, GFP_KERNEL);
+ cmd = xhci_alloc_command(sb->xhci, true, GFP_KERNEL);
+ if (!cmd)
+ return -ENOMEM;
+
+ spin_lock_irqsave(&sb->xhci->lock, flags);
+
+ vdev = sideband_to_vdev(sb);
+ ep = sb->eps[ep_index];
+
+ if (remove)
+ sb->eps[ep_index] = NULL;
+
+ /* validate xhci didn't free or replace vdev during resume */
+ if (!vdev || !ep || ep->sideband != sb) {
+ spin_unlock_irqrestore(&sb->xhci->lock, flags);
+ goto out;
+ }
+
+ if (remove) {
+ ep->sideband = NULL;
+ /* endpoint is removed, not running is not an error */
+ ret = 0;
+ }
+
+ /* make sure endpoint is running before stopping it */
+ if (ep->ring) {
+ ctx = xhci_get_ep_ctx(sb->xhci, vdev->out_ctx, ep_index);
+ if (GET_EP_CTX_STATE(ctx) == EP_STATE_RUNNING) {
+ ret = xhci_queue_stop_endpoint(sb->xhci, cmd,
+ vdev->slot_id,
+ ep_index, 0);
+ queued = !ret;
+ if (queued)
+ xhci_ring_cmd_db(sb->xhci);
+ }
+ }
+
+ spin_unlock_irqrestore(&sb->xhci->lock, flags);
+
+ if (!queued)
+ goto out;
+
+ wait_for_completion(cmd->completion);
- ep->sideband = NULL;
- sb->eps[ep->ep_index] = NULL;
+ if (cmd->status == COMP_COMMAND_ABORTED ||
+ cmd->status == COMP_COMMAND_RING_STOPPED) {
+ xhci_warn(sb->xhci, "Timeout while waiting for stop endpoint command\n");
+ ret = -ETIME;
+ }
+out:
+ xhci_free_command(sb->xhci, cmd);
+
+ return ret;
}
/* Caller must hold sb->mutex */
@@ -212,21 +265,13 @@ int
xhci_sideband_remove_endpoint(struct xhci_sideband *sb,
struct usb_host_endpoint *host_ep)
{
- struct xhci_virt_ep *ep;
unsigned int ep_index;
guard(mutex)(&sb->mutex);
ep_index = xhci_get_endpoint_index(&host_ep->desc);
- ep = sb->eps[ep_index];
- if (!sideband_to_vdev(sb) || !ep || ep->sideband != sb) {
- sb->eps[ep_index] = NULL;
- return -ENODEV;
- }
- __xhci_sideband_remove_endpoint(sb, ep);
-
- return 0;
+ return sideband_stop_endpoint_sync(sb, ep_index, true);
}
EXPORT_SYMBOL_GPL(xhci_sideband_remove_endpoint);
@@ -234,16 +279,13 @@ int
xhci_sideband_stop_endpoint(struct xhci_sideband *sb,
struct usb_host_endpoint *host_ep)
{
- struct xhci_virt_ep *ep;
unsigned int ep_index;
- ep_index = xhci_get_endpoint_index(&host_ep->desc);
- ep = sb->eps[ep_index];
+ guard(mutex)(&sb->mutex);
- if (!sideband_to_vdev(sb) || !ep || ep->sideband != sb)
- return -EINVAL;
+ ep_index = xhci_get_endpoint_index(&host_ep->desc);
- return xhci_stop_endpoint_sync(sb->xhci, ep, 0, GFP_KERNEL);
+ return sideband_stop_endpoint_sync(sb, ep_index, false);
}
EXPORT_SYMBOL_GPL(xhci_sideband_stop_endpoint);
@@ -486,24 +528,24 @@ xhci_sideband_unregister(struct xhci_sideband *sb)
xhci = sb->xhci;
- scoped_guard(mutex, &sb->mutex) {
- vdev = sideband_to_vdev(sb);
-
- for (i = 0; i < EP_CTX_PER_DEV; i++)
- if (vdev && sb->eps[i])
- __xhci_sideband_remove_endpoint(sb, sb->eps[i]);
+ mutex_lock(&sb->mutex);
- __xhci_sideband_remove_interrupter(sb);
+ for (i = 0; i < EP_CTX_PER_DEV; i++)
+ if (sb->eps[i])
+ sideband_stop_endpoint_sync(sb, i, true);
- sb->udev = NULL;
- }
+ __xhci_sideband_remove_interrupter(sb);
spin_lock_irq(&xhci->lock);
- sb->xhci = NULL;
+ vdev = sideband_to_vdev(sb);
if (vdev)
vdev->sideband = NULL;
+ sb->udev = NULL;
+ sb->xhci = NULL;
spin_unlock_irq(&xhci->lock);
+ mutex_unlock(&sb->mutex);
+
kfree(sb);
}
EXPORT_SYMBOL_GPL(xhci_sideband_unregister);
diff --git a/drivers/usb/host/xhci.c b/drivers/usb/host/xhci.c
index 30ac1bc4559b..bcb482795bbc 100644
--- a/drivers/usb/host/xhci.c
+++ b/drivers/usb/host/xhci.c
@@ -2883,61 +2883,6 @@ static int xhci_reserve_bandwidth(struct xhci_hcd *xhci,
return -ENOMEM;
}
-/*
- * Synchronous XHCI stop endpoint helper. Issues the stop endpoint command and
- * waits for the command completion before returning. This does not call
- * xhci_handle_cmd_stop_ep(), which has additional handling for 'context error'
- * cases, along with transfer ring cleanup.
- *
- * xhci_stop_endpoint_sync() is intended to be utilized by clients that manage
- * their own transfer ring, such as offload situations.
- */
-int xhci_stop_endpoint_sync(struct xhci_hcd *xhci, struct xhci_virt_ep *ep, int suspend,
- gfp_t gfp_flags)
-{
- struct xhci_command *command;
- struct xhci_ep_ctx *ep_ctx;
- unsigned long flags;
- int ret = -ENODEV;
-
- command = xhci_alloc_command(xhci, true, gfp_flags);
- if (!command)
- return -ENOMEM;
-
- spin_lock_irqsave(&xhci->lock, flags);
-
- /* make sure endpoint exists and is running before stopping it */
- if (ep->ring) {
- ep_ctx = xhci_get_ep_ctx(xhci, ep->vdev->out_ctx, ep->ep_index);
- if (GET_EP_CTX_STATE(ep_ctx) == EP_STATE_RUNNING)
- ret = xhci_queue_stop_endpoint(xhci, command,
- ep->vdev->slot_id,
- ep->ep_index, suspend);
- }
-
- if (ret < 0) {
- spin_unlock_irqrestore(&xhci->lock, flags);
- goto out;
- }
-
- xhci_ring_cmd_db(xhci);
- spin_unlock_irqrestore(&xhci->lock, flags);
-
- wait_for_completion(command->completion);
-
- /* No handling for COMP_CONTEXT_STATE_ERROR done at command completion*/
- if (command->status == COMP_COMMAND_ABORTED ||
- command->status == COMP_COMMAND_RING_STOPPED) {
- xhci_warn(xhci, "Timeout while waiting for stop endpoint command\n");
- ret = -ETIME;
- }
-out:
- xhci_free_command(xhci, command);
-
- return ret;
-}
-EXPORT_SYMBOL_GPL(xhci_stop_endpoint_sync);
-
/*
* xhci_usb_endpoint_maxp - get endpoint max packet size
* @host_ep: USB host endpoint to be checked
diff --git a/drivers/usb/host/xhci.h b/drivers/usb/host/xhci.h
index ec4bfeb4887c..6201b6b24252 100644
--- a/drivers/usb/host/xhci.h
+++ b/drivers/usb/host/xhci.h
@@ -1963,8 +1963,6 @@ void xhci_cleanup_command_queue(struct xhci_hcd *xhci);
void inc_deq(struct xhci_hcd *xhci, struct xhci_ring *ring);
unsigned int count_trbs(u64 addr, u64 len);
unsigned int xhci_num_trbs_free(struct xhci_ring *ring);
-int xhci_stop_endpoint_sync(struct xhci_hcd *xhci, struct xhci_virt_ep *ep,
- int suspend, gfp_t gfp_flags);
void xhci_process_cancelled_tds(struct xhci_hcd *xhci, struct xhci_virt_ep *ep);
void xhci_update_erst_dequeue(struct xhci_hcd *xhci,
struct xhci_interrupter *ir,
--
2.43.0
^ permalink raw reply related [flat|nested] 5+ messages in thread