From: Bernd Schubert <bschubert@ddn.com>
To: Stephen Rothwell <sfr@canb.auug.org.au>,
Miklos Szeredi <miklos@szeredi.hu>
Cc: bernd@bsbernd.com, linux-kernel@vger.kernel.org,
linux-next@vger.kernel.org, Bernd Schubert <bschubert@ddn.com>
Subject: [PATCH] fuse: Fix Documentation/filesystems/fuse-io-uring.rst
Date: Tue, 21 Jan 2025 09:37:46 +0100 [thread overview]
Message-ID: <20250121083746.2196931-1-bschubert@ddn.com> (raw)
In-Reply-To: <20250121174848.382cc2c6@canb.auug.org.au>
This adds several documentation updates I had missed after
renaming functions and also fixes 'make htmldocs'.
Signed-off-by: Bernd Schubert <bschubert@ddn.com>
---
Documentation/filesystems/fuse-io-uring.rst | 84 ++++++++++-----------
Documentation/filesystems/index.rst | 1 +
2 files changed, 42 insertions(+), 43 deletions(-)
diff --git a/Documentation/filesystems/fuse-io-uring.rst b/Documentation/filesystems/fuse-io-uring.rst
index 3c6b127d68a7..d73dd0dbd238 100644
--- a/Documentation/filesystems/fuse-io-uring.rst
+++ b/Documentation/filesystems/fuse-io-uring.rst
@@ -15,8 +15,8 @@ Limitations
===========
As of now not all requests types are supported through io-uring, userspace
is required to also handle requests through /dev/fuse after io-uring setup
-is complete. Specifically notifications (initiated from the daemon side)
- and interrupts.
+is complete. Specifically notifications (initiated from the daemon side)
+and interrupts.
Fuse io-uring configuration
===========================
@@ -40,7 +40,7 @@ pending requests waiting the request will be immediately submitted
to the daemon again.
Initial SQE
------------
+-----------::
| | FUSE filesystem daemon
| |
@@ -52,50 +52,48 @@ Initial SQE
| | >io_uring_submit_and_wait()
| |
| >fuse_uring_cmd() |
- | >fuse_uring_fetch() |
- | >fuse_uring_ent_release() |
+ | >fuse_uring_register() |
Sending requests with CQEs
---------------------------
+--------------------------::
- | | FUSE filesystem daemon
- | | [waiting for CQEs]
- | "rm /mnt/fuse/file" |
- | |
- | >sys_unlink() |
- | >fuse_unlink() |
- | [allocate request] |
- | >__fuse_request_send() |
- | ... |
- | >fuse_uring_queue_fuse_req |
- | [queue request on fg or |
- | bg queue] |
- | >fuse_uring_assign_ring_entry() |
- | >fuse_uring_send_to_ring() |
- | >fuse_uring_copy_to_ring() |
- | >io_uring_cmd_done() |
- | >request_wait_answer() |
- | [sleep on req->waitq] |
- | | [receives and handles CQE]
- | | [submit result and fetch next]
- | | >io_uring_submit()
- | | IORING_OP_URING_CMD/
- | | FUSE_URING_CMD_COMMIT_AND_FETCH
- | >fuse_uring_cmd() |
- | >fuse_uring_commit_and_release() |
- | >fuse_uring_copy_from_ring() |
- | [ copy the result to the fuse req] |
- | >fuse_uring_req_end_and_get_next() |
- | >fuse_request_end() |
- | [wake up req->waitq] |
- | >fuse_uring_ent_release_and_fetch()|
- | [wait or handle next req] |
- | |
- | |
- | [req->waitq woken up] |
- | <fuse_unlink() |
- | <sys_unlink() |
+ | | FUSE filesystem daemon
+ | | [waiting for CQEs]
+ | "rm /mnt/fuse/file" |
+ | |
+ | >sys_unlink() |
+ | >fuse_unlink() |
+ | [allocate request] |
+ | >fuse_send_one() |
+ | ... |
+ | >fuse_uring_queue_fuse_req |
+ | [queue request on fg queue] |
+ | >fuse_uring_add_req_to_ring_ent() |
+ | ... |
+ | >fuse_uring_copy_to_ring() |
+ | >io_uring_cmd_done() |
+ | >request_wait_answer() |
+ | [sleep on req->waitq] |
+ | | [receives and handles CQE]
+ | | [submit result and fetch next]
+ | | >io_uring_submit()
+ | | IORING_OP_URING_CMD/
+ | | FUSE_URING_CMD_COMMIT_AND_FETCH
+ | >fuse_uring_cmd() |
+ | >fuse_uring_commit_fetch() |
+ | >fuse_uring_commit() |
+ | >fuse_uring_copy_from_ring() |
+ | [ copy the result to the fuse req] |
+ | >fuse_uring_req_end() |
+ | >fuse_request_end() |
+ | [wake up req->waitq] |
+ | >fuse_uring_next_fuse_req |
+ | [wait or handle next req] |
+ | |
+ | [req->waitq woken up] |
+ | <fuse_unlink() |
+ | <sys_unlink() |
diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
index 44e9e77ffe0d..2636f2a41bd3 100644
--- a/Documentation/filesystems/index.rst
+++ b/Documentation/filesystems/index.rst
@@ -98,6 +98,7 @@ Documentation for filesystem implementations.
hpfs
fuse
fuse-io
+ fuse-io-uring
inotify
isofs
nilfs2
--
2.43.0
next prev parent reply other threads:[~2025-01-21 8:38 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-01-21 6:48 linux-next: build warnings after merge of the fuse tree Stephen Rothwell
2025-01-21 8:37 ` Bernd Schubert [this message]
2025-01-21 9:27 ` [PATCH] fuse: Fix Documentation/filesystems/fuse-io-uring.rst Miklos Szeredi
2025-01-21 11:15 ` Bernd Schubert
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=20250121083746.2196931-1-bschubert@ddn.com \
--to=bschubert@ddn.com \
--cc=bernd@bsbernd.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=miklos@szeredi.hu \
--cc=sfr@canb.auug.org.au \
/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