From: Cindy Lu <lulu@redhat.com>
To: lulu@redhat.com, jasowang@redhat.com, mst@redhat.com,
linux-kernel@vger.kernel.org,
virtualization@lists.linux-foundation.org
Subject: [PATCH v5 5/5] Documentation: Add reconnect process for VDUSE
Date: Fri, 12 Apr 2024 21:28:25 +0800 [thread overview]
Message-ID: <20240412133017.483407-6-lulu@redhat.com> (raw)
In-Reply-To: <20240412133017.483407-1-lulu@redhat.com>
Add a document explaining the reconnect process, including what the
Userspace App needs to do and how it works with the kernel.
Signed-off-by: Cindy Lu <lulu@redhat.com>
---
Documentation/userspace-api/vduse.rst | 41 +++++++++++++++++++++++++++
1 file changed, 41 insertions(+)
diff --git a/Documentation/userspace-api/vduse.rst b/Documentation/userspace-api/vduse.rst
index bdb880e01132..7faa83462e78 100644
--- a/Documentation/userspace-api/vduse.rst
+++ b/Documentation/userspace-api/vduse.rst
@@ -231,3 +231,44 @@ able to start the dataplane processing as follows:
after the used ring is filled.
For more details on the uAPI, please see include/uapi/linux/vduse.h.
+
+HOW VDUSE devices reconnection works
+------------------------------------
+1. What is reconnection?
+
+ When the userspace application loads, it should establish a connection
+ to the vduse kernel device. Sometimes,the userspace application exists,
+ and we want to support its restart and connect to the kernel device again
+
+2. How can I support reconnection in a userspace application?
+
+2.1 During initialization, the userspace application should first verify the
+ existence of the device "/dev/vduse/vduse_name".
+ If it doesn't exist, it means this is the first-time for connection. goto step 2.2
+ If it exists, it means this is a reconnection, and we should goto step 2.3
+
+2.2 Create a new VDUSE instance with ioctl(VDUSE_CREATE_DEV) on
+ /dev/vduse/control.
+ When ioctl(VDUSE_CREATE_DEV) is called, kernel allocates memory for
+ the reconnect information. The total memory size is PAGE_SIZE*vq_mumber.
+
+2.3 Check if the information is suitable for reconnect
+ If this is reconnection :
+ Before attempting to reconnect, The userspace application needs to use the
+ ioctl(VDUSE_DEV_GET_CONFIG, VDUSE_DEV_GET_STATUS, VDUSE_DEV_GET_FEATURES...)
+ to get the information from kernel.
+ Please review the information and confirm if it is suitable to reconnect.
+
+2.4 Userspace application needs to mmap the memory to userspace
+ The userspace application requires mapping one page for every vq. These pages
+ should be used to save vq-related information during system running. Additionally,
+ the application must define its own structure to store information for reconnection.
+
+2.5 Completed the initialization and running the application.
+ While the application is running, it is important to store relevant information
+ about reconnections in mapped pages. When calling the ioctl VDUSE_VQ_GET_INFO to
+ get vq information, it's necessary to check whether it's a reconnection. If it is
+ a reconnection, the vq-related information must be get from the mapped pages.
+
+2.6 When the Userspace application exits, it is necessary to unmap all the
+ pages for reconnection
--
2.43.0
next prev parent reply other threads:[~2024-04-12 13:31 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-12 13:28 [PATCH v5 0/5] vduse: Add support for reconnection Cindy Lu
2024-04-12 13:28 ` [PATCH v5 1/5] vduse: Add new ioctl VDUSE_DEV_GET_CONFIG Cindy Lu
2024-04-12 13:28 ` [PATCH v5 2/5] vduse: Add new ioctl VDUSE_DEV_GET_STATUS Cindy Lu
2024-04-12 13:28 ` [PATCH v5 3/5] vduse: Add function to get/free the pages for reconnection Cindy Lu
2024-04-17 9:29 ` Michael S. Tsirkin
2024-04-18 0:57 ` Jason Wang
2024-04-22 20:05 ` Michael S. Tsirkin
2024-04-23 3:09 ` Jason Wang
2024-04-23 8:42 ` Michael S. Tsirkin
2024-04-24 0:44 ` Jason Wang
2024-04-24 3:14 ` Cindy Lu
2024-04-24 3:51 ` Jason Wang
2024-04-24 9:51 ` Michael S. Tsirkin
2024-04-25 1:35 ` Jason Wang
2024-04-25 10:26 ` Michael S. Tsirkin
2024-04-12 13:28 ` [PATCH v5 4/5] vduse: Add file operation for mmap Cindy Lu
2024-04-12 13:28 ` Cindy Lu [this message]
2024-04-16 3:46 ` [PATCH v5 5/5] Documentation: Add reconnect process for VDUSE Jason Wang
2024-04-17 8:46 ` Cindy Lu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240412133017.483407-6-lulu@redhat.com \
--to=lulu@redhat.com \
--cc=jasowang@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=mst@redhat.com \
--cc=virtualization@lists.linux-foundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).