patch 'vhost: fix FD entries cleanup' has been queued to stable release 24.11.2

[Kevin Traynor <ktraynor@redhat.com>]

Hi,

FYI, your patch has been queued to stable release 24.11.2

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 02/17/25. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/kevintraynor/dpdk-stable

This queued commit can be viewed at:
https://github.com/kevintraynor/dpdk-stable/commit/17320be508658dba6e61ab78b3154c85749464fe

Thanks.

Kevin

---
From 17320be508658dba6e61ab78b3154c85749464fe Mon Sep 17 00:00:00 2001
From: Maxime Coquelin <maxime.coquelin@redhat.com>
Date: Thu, 6 Feb 2025 09:41:54 +0100
Subject: [PATCH] vhost: fix FD entries cleanup

[ upstream commit 50966930caf2d1a82655f2c3415c093421d70072 ]

With the recent rework of the FD manager to use epoll,
an error message is emitted with Vhost-user at FD entry
removal:

ERR|VHOST_FDMAN: could not remove 102 fd from 101 epfd: No such file or directory

It occurs because the read callback closes the file
descriptor before it is removed from the FD set.
This patch defers the close() after the FD entry is removed
from the set.

Fixes: 0e38b42bf61c ("vhost: manage FD with epoll")

Signed-off-by: David Marchand <david.marchand@redhat.com>
Signed-off-by: Maxime Coquelin <maxime.coquelin@redhat.com>
Reviewed-by: Chenbo Xia <chenbox@nvidia.com>
---
 lib/vhost/fd_man.c | 12 +++++++-----
 lib/vhost/fd_man.h |  2 +-
 lib/vhost/socket.c | 11 +++++------
 lib/vhost/vduse.c  |  9 ++++-----
 4 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/lib/vhost/fd_man.c b/lib/vhost/fd_man.c
index 9bc7e50b93..f9147edee7 100644
--- a/lib/vhost/fd_man.c
+++ b/lib/vhost/fd_man.c
@@ -334,5 +334,5 @@ fdset_event_dispatch(void *arg)
 	void *dat;
 	int fd, numfds;
-	int remove1, remove2;
+	int close1, close2;
 	struct fdset *pfdset = arg;
 
@@ -358,5 +358,5 @@ fdset_event_dispatch(void *arg)
 			}
 
-			remove1 = remove2 = 0;
+			close1 = close2 = 0;
 
 			rcb = pfdentry->rcb;
@@ -368,7 +368,7 @@ fdset_event_dispatch(void *arg)
 
 			if (rcb && events[i].events & (EPOLLIN | EPOLLERR | EPOLLHUP))
-				rcb(fd, dat, &remove1);
+				rcb(fd, dat, &close1);
 			if (wcb && events[i].events & (EPOLLOUT | EPOLLERR | EPOLLHUP))
-				wcb(fd, dat, &remove2);
+				wcb(fd, dat, &close2);
 			pfdentry->busy = 0;
 			/*
@@ -382,6 +382,8 @@ fdset_event_dispatch(void *arg)
 			 * fdset_del_locked().
 			 */
-			if (remove1 || remove2)
+			if (close1 || close2) {
 				fdset_del(pfdset, fd);
+				close(fd);
+			}
 		}
 
diff --git a/lib/vhost/fd_man.h b/lib/vhost/fd_man.h
index 6398343a6a..eadcc6fb42 100644
--- a/lib/vhost/fd_man.h
+++ b/lib/vhost/fd_man.h
@@ -13,5 +13,5 @@ struct fdset;
 #define MAX_FDS 1024
 
-typedef void (*fd_cb)(int fd, void *dat, int *remove);
+typedef void (*fd_cb)(int fd, void *dat, int *close);
 
 struct fdset *fdset_init(const char *name);
diff --git a/lib/vhost/socket.c b/lib/vhost/socket.c
index 05a7e5902f..799c6b0590 100644
--- a/lib/vhost/socket.c
+++ b/lib/vhost/socket.c
@@ -85,6 +85,6 @@ struct vhost_user {
 #define MAX_VIRTIO_BACKLOG 128
 
-static void vhost_user_server_new_connection(int fd, void *data, int *remove);
-static void vhost_user_read_cb(int fd, void *dat, int *remove);
+static void vhost_user_server_new_connection(int fd, void *data, int *close);
+static void vhost_user_read_cb(int fd, void *dat, int *close);
 static int create_unix_socket(struct vhost_user_socket *vsocket);
 static int vhost_user_start_client(struct vhost_user_socket *vsocket);
@@ -291,5 +291,5 @@ err:
 /* call back when there is new vhost-user connection from client  */
 static void
-vhost_user_server_new_connection(int fd, void *dat, int *remove __rte_unused)
+vhost_user_server_new_connection(int fd, void *dat, int *close __rte_unused)
 {
 	struct vhost_user_socket *vsocket = dat;
@@ -304,5 +304,5 @@ vhost_user_server_new_connection(int fd, void *dat, int *remove __rte_unused)
 
 static void
-vhost_user_read_cb(int connfd, void *dat, int *remove)
+vhost_user_read_cb(int connfd, void *dat, int *close)
 {
 	struct vhost_user_connection *conn = dat;
@@ -314,6 +314,5 @@ vhost_user_read_cb(int connfd, void *dat, int *remove)
 		struct virtio_net *dev = get_device(conn->vid);
 
-		close(connfd);
-		*remove = 1;
+		*close = 1;
 
 		if (dev)
diff --git a/lib/vhost/vduse.c b/lib/vhost/vduse.c
index be548f051e..801674be42 100644
--- a/lib/vhost/vduse.c
+++ b/lib/vhost/vduse.c
@@ -118,5 +118,5 @@ static struct vhost_backend_ops vduse_backend_ops = {
 
 static void
-vduse_control_queue_event(int fd, void *arg, int *remove __rte_unused)
+vduse_control_queue_event(int fd, void *arg, int *close __rte_unused)
 {
 	struct virtio_net *dev = arg;
@@ -352,5 +352,5 @@ vduse_device_stop(struct virtio_net *dev)
 
 static void
-vduse_events_handler(int fd, void *arg, int *remove __rte_unused)
+vduse_events_handler(int fd, void *arg, int *close __rte_unused)
 {
 	struct virtio_net *dev = arg;
@@ -565,5 +565,5 @@ vduse_reconnect_log_check(struct virtio_net *dev, uint64_t features, uint32_t to
 
 static void
-vduse_reconnect_handler(int fd, void *arg, int *remove)
+vduse_reconnect_handler(int fd __rte_unused, void *arg, int *close)
 {
 	struct virtio_net *dev = arg;
@@ -571,6 +571,5 @@ vduse_reconnect_handler(int fd, void *arg, int *remove)
 	vduse_device_start(dev, true);
 
-	close(fd);
-	*remove = 1;
+	*close = 1;
 }
 
-- 
2.48.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2025-02-12 17:29:40.812387807 +0000
+++ 0059-vhost-fix-FD-entries-cleanup.patch	2025-02-12 17:29:34.382946121 +0000
@@ -1 +1 @@
-From 50966930caf2d1a82655f2c3415c093421d70072 Mon Sep 17 00:00:00 2001
+From 17320be508658dba6e61ab78b3154c85749464fe Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit 50966930caf2d1a82655f2c3415c093421d70072 ]
+
@@ -18 +19,0 @@
-Cc: stable@dpdk.org
@@ -80 +81 @@
-index 894a0f0dcb..4c6c551c3d 100644
+index 05a7e5902f..799c6b0590 100644