fscache,erofs: fscache-based on-demand read semantics
Subsystems (6)
v7 cover fscache,erofs: fscache-based on-demand read semantics
changes since v6:
- rebased to latest upstream branch
- cachefiles: move calling of cachefiles_ondemand_clean_object() into cachefiles_withdraw_cookie() (it is called in cachefiles_clean_up_object() previously), so that the previously anon_fd could be withdrawed if the looking up phase failed ( object->file is still NULL while a previous OPEN request has been sent to user daemon) (patch 3)
- cachefiles: rename "cinit" (response of OPEN request) to "copen" (patch 2)
- cachefiles: "fscache: export fscache_end_operation()" is still needed. Since it has been pull requested for 5.18 (not merged yet), it's not included in this patchset.
- erofs: register fscache volume for each erofs filesystem (patch 9)
- erofs: rename erofs_is_nodev_mode() to erofs_is_fscache_mode (patch 8)
- erofs: remove erofs_fscache_read_folio() helper (patch 12)
- erofs: remove erofs_fscache_get_map() helper, and no new field is needed in "struct erofs_map_blocks" now (patch 16)
- erofs: fold several helper functions, and other miscellaneous fixes regarding to comments from Gao Xiang
Kernel Patchset
---------------
Git tree:
https://github.com/lostjeffle/linux.git jingbo/dev-erofs-fscache-v7
Gitweb:
https://github.com/lostjeffle/linux/commits/jingbo/dev-erofs-fscache-v7
User Daemon for Quick Test
--------------------------
Git tree:
https://github.com/lostjeffle/demand-read-cachefilesd.git main
Gitweb:
https://github.com/lostjeffle/demand-read-cachefilesd
RFC: https://lore.kernel.org/all/[email protected]/t/
v1: https://lore.kernel.org/lkml/[email protected]/T/
v2: https://lore.kernel.org/all/[email protected]/t/
v3: https://lore.kernel.org/lkml/[email protected]/T/
v4: https://lore.kernel.org/lkml/[email protected]/T/#t
v5: https://lore.kernel.org/lkml/[email protected]/T/
v6: https://lore.kernel.org/lkml/[email protected]/T/
[Background]
============
Nydus [1] is an image distribution service especially optimized for distribution over network. Nydus is an excellent container image acceleration solution, since it only pulls data from remote when needed, a.k.a. on-demand reading and it also supports chunk-based deduplication, compression, etc.
erofs (Enhanced Read-Only File System) is a filesystem designed for read-only scenarios. (Documentation/filesystem/erofs.rst)
Over the past months we've been focusing on supporting Nydus image service with in-kernel erofs format[2]. In that case, each container image will be organized in one bootstrap (metadata) and (optional) multiple data blobs in erofs format. Massive container images will be stored on one machine.
To accelerate the container startup (fetching container images from remote and then start the container), we do hope that the bootstrap & blob files could support on-demand read. That is, erofs can be mounted and accessed even when the bootstrap/data blob files have not been fully downloaded. Then it'll have native performance after data is available locally.
That means we have to manage the cache state of the bootstrap/data blob files (if cache hit, read directly from the local cache; if cache miss, fetch the data somehow). It would be painful and may be dumb for erofs to implement the cache management itself. Thus we prefer fscache/cachefiles to do the cache management instead.
The fscache on-demand read feature aims to be implemented in a generic way so that it can benefit other use cases and/or filesystems if it's implemented in the fscache subsystem.
[1] https://nydus.dev
[2] https://sched.co/pcdL
[Overall Design]
================
Please refer to patch 7 ("cachefiles: document on-demand read mode") for more details.
When working in the original mode, cachefiles mainly serves as a local cache for remote networking fs, while in on-demand read mode, cachefiles can work in the scenario where on-demand read semantics is needed, e.g. container image distribution.
The essential difference between these two modes is that, in original mode, when cache miss, netfs itself will fetch data from remote, and then write the fetched data into cache file. While in on-demand read mode, a user daemon is responsible for fetching data and then feeds to the kernel fscache side.
The on-demand read mode relies on a simple protocol used for communication between kernel and user daemon.
The proposed implementation relies on the anonymous fd mechanism to avoid the dependence on the format of cache file. When a fscache cachefile is opened for the first time, an anon_fd associated with the cache file is sent to the user daemon. With the given anon_fd, user daemon could fetch and write data into the cache file in the background, even when kernel has not triggered the cache miss. Besides, the write() syscall to the anon_fd will finally call cachefiles kernel module, which will write data to cache file in the latest format of cache file.
1. cache miss
When cache miss, cachefiles kernel module will notify user daemon with the anon_fd, along with the requested file range. When notified, user daemon needs to fetch data of the requested file range, and then write the fetched data into cache file with the given anonymous fd. When finished processing the request, user daemon needs to notify the kernel.
After notifying the user daemon, the kernel read routine will hang there, until the request is handled by user daemon. When it's awaken by the notification from user daemon, i.e. the corresponding hole has been filled by the user daemon, it will retry to read from the same file range.
2. cache hit
Once data is already ready in cache file, netfs will read from cache file directly.
[Advantage of fscache-based on-demand read]
========================================
1. Asynchronous Prefetch
In current mechanism, fscache is responsible for cache state management, while the data plane (fetch data from local/remote on cache miss) is done on the user daemon side.
If data has already been ready in the backing file, netfs (e.g. erofs) will read from the backing file directly and won't be trapped to user space anymore. Thus the user daemon could fetch data (from remote) asynchronously on the background, and thus accelerate the backing file accessing in some degree.
2. Support massive blob files
Besides this mechanism supports a large amount of backing files, and thus can benefit the densely employed scenario.
In our using scenario, one container image can correspond to one bootstrap file (required) and multiple data blob files (optional). For example, one container image for node.js will corresponds to ~20 files in total. In densely employed environment, there could be as many as hundreds of containers and thus thousands of backing files on one machine.
Jeffle Xu (19):
cachefiles: extract write routine
cachefiles: notify user daemon with anon_fd when looking up cookie
cachefiles: notify user daemon when withdrawing cookie
cachefiles: implement on-demand read
cachefiles: enable on-demand read mode
cachefiles: document on-demand read mode
erofs: make erofs_map_blocks() generally available
erofs: add mode checking helper
erofs: register fscache volume
erofs: add fscache context helper functions
erofs: add anonymous inode managing page cache for data blob
erofs: add erofs_fscache_read_folios() helper
erofs: register fscache context for primary data blob
erofs: register fscache context for extra data blobs
erofs: implement fscache-based metadata read
erofs: implement fscache-based data read for non-inline layout
erofs: implement fscache-based data read for inline layout
erofs: implement fscache-based data readahead
erofs: add 'fsid' mount option
.../filesystems/caching/cachefiles.rst | 166 ++++++ fs/cachefiles/Kconfig | 11 + fs/cachefiles/Makefile | 1 + fs/cachefiles/daemon.c | 90 +++- fs/cachefiles/interface.c | 2 + fs/cachefiles/internal.h | 67 +++ fs/cachefiles/io.c | 72 ++- fs/cachefiles/namei.c | 16 +- fs/cachefiles/ondemand.c | 473 ++++++++++++++++++ fs/erofs/Kconfig | 10 + fs/erofs/Makefile | 1 + fs/erofs/data.c | 27 +- fs/erofs/fscache.c | 369 ++++++++++++++ fs/erofs/inode.c | 5 + fs/erofs/internal.h | 55 ++ fs/erofs/super.c | 99 +++- include/linux/fscache.h | 1 + include/linux/netfs.h | 1 + include/trace/events/cachefiles.h | 2 + include/uapi/linux/cachefiles.h | 57 +++ 20 files changed, 1457 insertions(+), 68 deletions(-) create mode 100644 fs/cachefiles/ondemand.c create mode 100644 fs/erofs/fscache.c create mode 100644 include/uapi/linux/cachefiles.h
Signature · 1 line
2.27.0
PATCH v7 1/19 cachefiles: extract write routine
Extract the generic routine of writing data to cache files, and make it generally available.
This will be used by the following patch implementing on-demand read mode. Since it's called inside cachefiles module in this case, make the interface generic and unrelated to netfs_cache_resources.
It is worth nothing that, ki->inval_counter is not initialized after this cleanup. It shall not make any visible difference, since inval_counter is no longer used in the write completion routine, i.e. cachefiles_write_complete().
--- fs/cachefiles/internal.h | 10 +++++++ fs/cachefiles/io.c | 61 +++++++++++++++++++++++----------------- 2 files changed, 45 insertions(+), 26 deletions(-)
fs/cachefiles/internal.h +10 -0
@@ -201,6 +201,16 @@ extern void cachefiles_put_object(struct cachefiles_object *object,*/ extern bool cachefiles_begin_operation (struct netfs_cache_resources *cres,enum fscache_want_state want_state); +extern int __cachefiles_prepare_write (struct cachefiles_object *object, +struct file *file, +loff_t *_start,size_t *_len, +bool no_space_allocated_yet); +extern int __cachefiles_write (struct cachefiles_object *object, +struct file *file, +loff_t start_pos, +struct iov_iter *iter, +netfs_io_terminated_t term_func, +void *term_func_priv);/* * key.c
fs/cachefiles/io.c +35 -26
109 lines not on this page · raw message
Signature · 1 line
2.27.0
PATCH v7 2/19 cachefiles: notify user daemon with anon_fd when looking up cookie
In reply to Jeffle XuFscache/cachefiles used to serve as a local cache for remote fs. This patch, along with the following patches, introduces a new on-demand read mode for cachefiles, which can boost the scenario where on-demand read semantics is needed, e.g. container image distribution.
The essential difference between the original mode and on-demand read mode is that, in the original mode, when cache miss, netfs itself will fetch data from remote, and then write the fetched data into cache file. While in on-demand read mode, a user daemon is responsible for fetching data and then writing to the cache file.
As the first step, notify user daemon with anon_fd when looking up cookie.
Send the anonymous fd to user daemon when looking up cookie, no matter whether the cache file exists there or not. With the given anonymous fd, user daemon can fetch and then write data into cache file in advance, even when cache miss has not happened yet.
Also add one advisory flag (FSCACHE_ADV_WANT_CACHE_SIZE) suggesting that cache file size shall be retrieved at runtime. This helps the scenario where one cache file can contain multiple netfs files for the purpose of deduplication, e.g. In this case, netfs itself has no idea the cache file size, whilst user daemon needs to offer the hint on the cache file size.
--- fs/cachefiles/Kconfig | 11 + fs/cachefiles/Makefile | 1 + fs/cachefiles/daemon.c | 77 +++++-- fs/cachefiles/internal.h | 43 ++++ fs/cachefiles/namei.c | 16 +- fs/cachefiles/ondemand.c | 358 ++++++++++++++++++++++++++++++ include/linux/fscache.h | 1 + include/trace/events/cachefiles.h | 2 + include/uapi/linux/cachefiles.h | 39 ++++ 9 files changed, 533 insertions(+), 15 deletions(-) create mode 100644 fs/cachefiles/ondemand.c create mode 100644 include/uapi/linux/cachefiles.h
fs/cachefiles/Kconfig +11 -0
@@ -26,3 +26,14 @@ config CACHEFILES_ERROR_INJECTION help This permits error injection to be enabled in cachefiles whilst a cache is in service. + +config CACHEFILES_ONDEMAND + bool "Support for on-demand read" + depends on CACHEFILES + default n + help + This permits on-demand read mode of cachefiles. In this mode, when + cache miss, the cachefiles backend instead of netfs, is responsible + for fetching data, e.g. through user daemon. + + If unsure, say N.
fs/cachefiles/Makefile +1 -0
@@ -16,5 +16,6 @@ cachefiles-y := \ xattr.o cachefiles-$(CONFIG_CACHEFILES_ERROR_INJECTION) += error_inject.o +cachefiles-$(CONFIG_CACHEFILES_ONDEMAND) += ondemand.o obj-$(CONFIG_CACHEFILES) := cachefiles.o
fs/cachefiles/daemon.c +64 -13
125 lines not on this page · raw message
fs/cachefiles/internal.h +43 -0
72 lines not on this page · raw message
fs/cachefiles/namei.c +14 -2
@@ -452,10 +452,9 @@ struct file *cachefiles_create_tmpfile(struct cachefiles_object *object)struct dentry *fan = volume->fanout[(u8 )object->cookie->key_hash];struct file *file;struct path path; -uint64_t ni_size = object->cookie->object_size; +uint64_t ni_size;long ret; - ni_size =round_up (ni_size,CACHEFILES_DIO_BLOCK_SIZE );cachefiles_begin_secure (cache, &saved_cred);
@@ -481,6 +480,15 @@ struct file *cachefiles_create_tmpfile(struct cachefiles_object *object) goto out_dput; } + ret =cachefiles_ondemand_init_object (object); +if (ret <0 ) { + file =ERR_PTR (ret); + goto out_unuse; + } + + ni_size = object->cookie->object_size; + ni_size =round_up (ni_size,CACHEFILES_DIO_BLOCK_SIZE ); +if (ni_size >0 ) {trace_cachefiles_trunc (object,d_backing_inode (path.dentry),0 , ni_size, cachefiles_trunc_expand_tmpfile);
@@ -586,6 +594,10 @@ static bool cachefiles_open_file(struct cachefiles_object *object, }_debug ("file -> %pd positive" , dentry); + ret =cachefiles_ondemand_init_object (object); +if (ret <0 ) + goto error_fput; + ret =cachefiles_check_auxdata (object, file);if (ret <0 ) goto check_failed;
fs/cachefiles/ondemand.c new file +358 -0
358 lines not on this page · raw message
include/linux/fscache.h +1 -0
@@ -39,6 +39,7 @@ struct fscache_cookie;#define FSCACHE_ADV_SINGLE_CHUNK 0x01/* The object is a single chunk of data */ #define FSCACHE_ADV_WRITE_CACHE 0x00/* Do cache if written to locally */ #define FSCACHE_ADV_WRITE_NOCACHE 0x02/* Don't cache if written to locally */ +#define FSCACHE_ADV_WANT_CACHE_SIZE 0x04/* Retrieve cache size at runtime */ #define FSCACHE_INVAL_DIO_WRITE 0x01/* Invalidate due to DIO write */
include/trace/events/cachefiles.h +2 -0
@@ -31,6 +31,8 @@ enum cachefiles_obj_ref_trace { cachefiles_obj_see_lookup_failed, cachefiles_obj_see_withdraw_cookie, cachefiles_obj_see_withdrawal, + cachefiles_obj_get_ondemand_fd, + cachefiles_obj_put_ondemand_fd, }; enum fscache_why_object_killed {
include/uapi/linux/cachefiles.h new file +39 -0
@@ -0,0 +1,39 @@ +/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ +#ifndef _LINUX_CACHEFILES_H +#define _LINUX_CACHEFILES_H + +#include <linux/types.h> + +/* +* Fscache ensures that the maximum length of cookie key is 255. The volume key +* is controlled by netfs, and generally no bigger than 255. +*/ +#define CACHEFILES_MSG_MAX_SIZE 1024 + +enum cachefiles_opcode { +CACHEFILES_OP_OPEN , +}; + +/* +* @id identifying position of this message in the radix tree +* @opcode message type, CACHEFILE_OP_* +* @len message length, including message header and following data +* @data message type specific payload +*/ +struct cachefiles_msg { +__u32 id; +__u32 opcode; +__u32 len; +__u8 data[]; +}; + +struct cachefiles_open { +__u32 volume_key_len; +__u32 cookie_key_len; +__u32 fd; +__u32 flags; +/* following data contains volume_key and cookie_key in sequence */ +__u8 data[]; +}; + +#endif
Signature · 1 line
2.27.0
Re: [PATCH v7 02/19] cachefiles: notify user daemon with anon_fd when looking up cookie
fs/cachefiles/namei.c struct file *cachefiles_create_tmpfile(struct cachefiles_object *object) · line 488
Quoted 7 lines · Jeffle Xu
fs/cachefiles/namei.c +6
-0+ ret =cachefiles_ondemand_init_object (object); +if (ret <0 ) { + file =ERR_PTR (ret); + goto out_unuse; + } +
Sorry, this patch really depends on [1] which introduces "out_unuse" label.
[1] https://www.spinics.net/lists/linux-cachefs/msg05972.html
My git branch has already contained this commit [2].
[2]
https://github.com/lostjeffle/linux/commit/3c71705e777fa75d37f784640a232db14ce62c31
Signature · 2 lines
Thanks, Jeffle
PATCH v7 3/19 cachefiles: notify user daemon when withdrawing cookie
In reply to Jeffle XuNotify user daemon that cookie is going to be withdrawn, providing a hint that the associated anon_fd can be closed. The anon_fd attached in the CLOSE request shall be same with that in the previous OPEN request.
Be noted that this is only a hint. User daemon can close the anon_fd when receiving the CLOSE request, then it will receive another anon_fd if the cookie gets looked up. Or it can also ignore the CLOSE request, and keep writing data into the anon_fd. However the next time cookie gets looked up, the user daemon will still receive another anon_fd.
--- fs/cachefiles/interface.c | 2 ++ fs/cachefiles/internal.h | 5 +++++ fs/cachefiles/ondemand.c | 34 +++++++++++++++++++++++++++++++++ include/uapi/linux/cachefiles.h | 5 +++++ 4 files changed, 46 insertions(+)
fs/cachefiles/interface.c +2 -0
@@ -362,6 +362,8 @@ static void cachefiles_withdraw_cookie(struct fscache_cookie *cookie)spin_unlock (&cache->object_list_lock); } +cachefiles_ondemand_clean_object (object); +if (object->file) {cachefiles_begin_secure (cache, &saved_cred);cachefiles_clean_up_object (object, cache);
fs/cachefiles/internal.h +5 -0
@@ -279,6 +279,7 @@ extern int cachefiles_ondemand_copen(struct cachefiles_cache *cache, char *args);extern int cachefiles_ondemand_init_object (struct cachefiles_object *object); +extern void cachefiles_ondemand_clean_object (struct cachefiles_object *object);#else static inline ssize_t cachefiles_ondemand_daemon_read(struct cachefiles_cache *cache,
@@ -291,6 +292,10 @@ static inline int cachefiles_ondemand_init_object(struct cachefiles_object *obje {return 0 ; } + +static inline void cachefiles_ondemand_clean_object (struct cachefiles_object *object) +{ +}#endif /*
fs/cachefiles/ondemand.c +34 -0
@@ -209,6 +209,12 @@ ssize_t cachefiles_ondemand_daemon_read(struct cachefiles_cache *cache, goto err_put_fd; } +/* CLOSE request has no reply */ +if (msg->opcode ==CACHEFILES_OP_CLOSE ) { +xa_erase (&cache->reqs, id); +complete (&req->done); + } +return n; err_put_fd:
@@ -332,6 +338,26 @@ static int init_open_req(struct cachefiles_req *req, void *private)return 0 ; } +static int init_close_req (struct cachefiles_req *req,void *private) +{ +struct cachefiles_object *object = req->object; +struct cachefiles_close *load = (void *)req->msg.data; +int fd = object->fd; + +if (WARN_ON_ONCE (fd ==-1 )) +return -EIO ; + +/* +* It's possible if the cookie looking up phase failed before READ +* request has ever been sent. +*/ +if (fd ==0 ) +return -ENOENT ; + + load->fd = fd; +return 0 ; +} +int cachefiles_ondemand_init_object (struct cachefiles_object *object) {struct fscache_cookie *cookie = object->cookie;
@@ -356,3 +382,11 @@ int cachefiles_ondemand_init_object(struct cachefiles_object *object)CACHEFILES_OP_OPEN , data_len, init_open_req, NULL); } + +void cachefiles_ondemand_clean_object (struct cachefiles_object *object) +{ +cachefiles_ondemand_send_req (object, +CACHEFILES_OP_CLOSE , +sizeof (struct cachefiles_close ), + init_close_req,NULL ); +}
include/uapi/linux/cachefiles.h +5 -0
@@ -12,6 +12,7 @@enum cachefiles_opcode {CACHEFILES_OP_OPEN , +CACHEFILES_OP_CLOSE , };/*
@@ -36,4 +37,8 @@ struct cachefiles_open { __u8 data[]; }; +struct cachefiles_close { +__u32 fd; +}; +#endif
Signature · 1 line
2.27.0
PATCH v7 4/19 cachefiles: implement on-demand read
In reply to Jeffle XuImplement the data plane of on-demand read mode.
A new NETFS_READ_HOLE_ONDEMAND flag is introduced to indicate that on-demand read should be done when a cache miss encountered. In this case, the read routine will send a READ request to user daemon, along with the anonymous fd and the file range that shall be read. Now user daemon is responsible for fetching data in the given file range, and then writing the fetched data into cache file with the given anonymous fd.
After sending the READ request, the read routine will hang there, until the READ request is handled by user daemon. Then it will retry to read from the same file range. If a cache miss is encountered again on the same file range, the read routine will fail then.
--- fs/cachefiles/internal.h | 9 ++++ fs/cachefiles/io.c | 11 +++++ fs/cachefiles/ondemand.c | 81 +++++++++++++++++++++++++++++++++ include/linux/netfs.h | 1 + include/uapi/linux/cachefiles.h | 13 ++++++ 5 files changed, 115 insertions(+)
fs/cachefiles/internal.h +9 -0
@@ -281,6 +281,9 @@ extern int cachefiles_ondemand_copen(struct cachefiles_cache *cache,extern int cachefiles_ondemand_init_object (struct cachefiles_object *object);extern void cachefiles_ondemand_clean_object (struct cachefiles_object *object); +extern int cachefiles_ondemand_read (struct cachefiles_object *object, +loff_t pos,size_t len); +#else static inline ssize_t cachefiles_ondemand_daemon_read (struct cachefiles_cache *cache,char __user *_buffer,size_t buflen)
@@ -296,6 +299,12 @@ static inline int cachefiles_ondemand_init_object(struct cachefiles_object *objestatic inline void cachefiles_ondemand_clean_object (struct cachefiles_object *object) { } + +static inline int cachefiles_ondemand_read (struct cachefiles_object *object, +loff_t pos,size_t len) +{ +return -EOPNOTSUPP ; +}#endif /*
fs/cachefiles/io.c +11 -0
@@ -95,6 +95,7 @@ static int cachefiles_read(struct netfs_cache_resources *cres, file,file_inode (file)->i_ino, start_pos, len, i_size_read(file_inode(file))); +retry:/* If the caller asked us to seek for data before doing the read, then * we should do that now. If we find a gap, we fill it with zeros. */
@@ -119,6 +120,16 @@ static int cachefiles_read(struct netfs_cache_resources *cres,if (read_hole ==NETFS_READ_HOLE_FAIL ) goto presubmission_error; +if (read_hole ==NETFS_READ_HOLE_ONDEMAND ) { + ret =cachefiles_ondemand_read (object, off, len); +if (ret) + goto presubmission_error; + +/* fail the read if no progress achieved */ + read_hole =NETFS_READ_HOLE_FAIL ; + goto retry; + } +iov_iter_zero (len, iter); skipped = len; ret =0 ;
fs/cachefiles/ondemand.c +81 -0
120 lines not on this page · raw message
include/linux/netfs.h +1 -0
@@ -203,6 +203,7 @@ enum netfs_read_from_hole {NETFS_READ_HOLE_IGNORE ,NETFS_READ_HOLE_CLEAR ,NETFS_READ_HOLE_FAIL , + NETFS_READ_HOLE_ONDEMAND, };/*
include/uapi/linux/cachefiles.h +13 -0
@@ -3,6 +3,7 @@#define _LINUX_CACHEFILES_H#include <linux/types.h> +#include <linux/ioctl.h> /* * Fscache ensures that the maximum length of cookie key is 255. The volume key
@@ -13,6 +14,7 @@enum cachefiles_opcode {CACHEFILES_OP_OPEN ,CACHEFILES_OP_CLOSE , +CACHEFILES_OP_READ , };/*
@@ -41,4 +43,15 @@ struct cachefiles_close { __u32 fd; }; +struct cachefiles_read { +__u64 off; +__u64 len; +__u32 fd; +}; + +/* +* For CACHEFILES_IOC_CREAD, arg is the @id field of corresponding READ request. +*/ +#define CACHEFILES_IOC_CREAD _IOW(0x98, 1, int) +#endif
Signature · 1 line
2.27.0
PATCH v7 5/19 cachefiles: enable on-demand read mode
In reply to Jeffle XuEnable on-demand read mode by adding an optional parameter to the "bind" command.
On-demand mode will be turned on when this parameter is "ondemand", i.e. "bind ondemand". Otherwise cachefiles will work in the original mode.
--- fs/cachefiles/daemon.c | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-)
fs/cachefiles/daemon.c +8 -5
@@ -738,11 +738,6 @@ static int cachefiles_daemon_bind(struct cachefiles_cache *cache, char *args) cache->brun_percent >= 100)return -ERANGE ; -if (*args) { -pr_err ("'bind' command doesn't take an argument\n" ); -return -EINVAL ; - } -if (!cache->rootdirname) {pr_err ("No cache directory specified\n" );return -EINVAL ;
@@ -754,6 +749,14 @@ static int cachefiles_daemon_bind(struct cachefiles_cache *cache, char *args)return -EBUSY ; } +if (IS_ENABLED (CONFIG_CACHEFILES_ONDEMAND ) && + !strcmp (args,"ondemand" )) { +set_bit (CACHEFILES_ONDEMAND_MODE , &cache->flags); + }else if (*args) { +pr_err ("'bind' command doesn't take an argument\n" ); +return -EINVAL ; + } +/* Make sure we have copies of the tag string */ if (!cache->tag) {/*
Signature · 1 line
2.27.0
PATCH v7 6/19 cachefiles: document on-demand read mode
In reply to Jeffle XuDocument new user interface introduced by on-demand read mode.
--- .../filesystems/caching/cachefiles.rst | 166 ++++++++++++++++++ 1 file changed, 166 insertions(+)
Documentation/filesystems/caching/cachefiles.rst +166 -0
@@ -28,6 +28,8 @@ Cache on Already Mounted Filesystem (*) Debugging. + (*) On-demand Read. + Overview
@@ -482,3 +484,167 @@ the control file. For example:: echo $((1|4|8)) >/sys/module/cachefiles/parameters/debug will turn on all function entry debugging. + + +On-demand Read +============== + +When working in original mode, cachefiles mainly serves as a local cache for +remote networking fs, while in on-demand read mode, cachefiles can boost the +scenario where on-demand read semantics is needed, e.g. container image +distribution. + +The essential difference between these two modes is that, in original mode, +when cache miss, netfs itself will fetch data from remote, and then write the +fetched data into cache file. While in on-demand read mode, a user daemon is +responsible for fetching data and then writing to the cache file. + +``CONFIG_CACHEFILES_ONDEMAND`` shall be enabled to support on-demand read mode. + + +Protocol Communication +---------------------- + +The on-demand read mode relies on a simple protocol used for communication +between kernel and user daemon. The model is like:: + + kernel --[request]--> user daemon --[reply]--> kernel + +The cachefiles kernel module will send requests to user daemon when needed. +User daemon needs to poll on the devnode ('/dev/cachefiles') to check if +there's pending request to be processed. A POLLIN event will be returned +when there's pending request. + +Then user daemon needs to read the devnode to fetch one request and process it +accordingly. It is worth nothing that each read only gets one request. When +finished processing the request, user daemon needs to write the reply to the +devnode. + +Each request is started with a message header like:: + + struct cachefiles_msg { + __u32 id; + __u32 opcode; + __u32 len; + __u8 data[]; + }; + + * ``id`` identifies the position of this request in an internal xarray + managing all pending requests. + + * ``opcode`` identifies the type of this request. + + * ``data`` identifies the payload of this request. + + * ``len`` identifies the whole length of this request, including the + header and following type specific payload. + + +Turn on On-demand Mode +---------------------- + +An optional parameter is added to "bind" command:: + + bind [ondemand] + +When "bind" command takes without argument, it defaults to the original mode. +When "bind" command takes with "ondemand" argument, i.e. "bind ondemand", +on-demand read mode will be enabled. + + +OPEN Request +------------ + +When netfs opens a cache file for the first time, a request with +CACHEFILES_OP_OPEN opcode, a.k.a OPEN request will be sent to user daemon. The +payload format is like:: + + struct cachefiles_open { + __u32 volume_key_len; + __u32 cookie_key_len; + __u32 fd; + __u32 flags; + __u8 data[]; + }; + + * ``data`` contains volume_key and cookie_key in sequence. + + * ``volume_key_len`` identifies the length of the volume key of the + cache file, in bytes. volume_key is of string format, with a suffix + '\0'. + + * ``cookie_key_len`` identifies the length of the cookie key of the + cache file, in bytes. The format of cookie_key is netfs specific. It + can be of binary format. + + * ``fd`` identifies the anonymous fd of the cache file, with which user + daemon can perform write/llseek file operations on the cache file. + + +OPEN request contains (volume_key, cookie_key, anon_fd) triple for corresponding +cache file. With this triple, user daemon could fetch and write data into the +cache file in the background, even when kernel has not triggered the cache miss +yet. User daemon is able to distinguish the requested cache file with the given +(volume_key, cookie_key), and write the fetched data into cache file with the +given anon_fd. + +After recording the (volume_key, cookie_key, anon_fd) triple, user daemon shall +reply with "copen" (complete open) command:: + + copen <id>,<cache_size> + + * ``id`` is exactly the id field of the previous OPEN request. + + * When >= 0, ``cache_size`` identifies the size of the cache file; + when < 0, ``cache_size`` identifies the error code ecountered by the + user daemon. + + +CLOSE Request +------------- +When cookie withdrawed, a request with CACHEFILES_OP_CLOSE opcode, a.k.a CLOSE +request, will be sent to user daemon. It will notify user daemon to close the +attached anon_fd. The payload format is like:: + + struct cachefiles_close { + __u32 fd; + }; + + * ``fd`` identifies the anon_fd to be closed, which is exactly the same + with that in OPEN request. + + +READ Request +------------ + +When on-demand read mode is turned on, and cache miss encountered, kernel will +send a request with CACHEFILES_OP_READ opcode, a.k.a READ request, to user +daemon. It will notify user daemon to fetch data in the requested file range. +The payload format is like:: + + struct cachefiles_read { + __u64 off; + __u64 len; + __u32 fd; + }; + + * ``off`` identifies the starting offset of the requested file range. + + * ``len`` identifies the length of the requested file range. + + * ``fd`` identifies the anonymous fd of the requested cache file. It is + guaranteed that it shall be the same with the fd field in the previous + OPEN request. + +When receiving one READ request, user daemon needs to fetch data of the +requested file range, and then write the fetched data into cache file with the +given anonymous fd. + +When finished processing the READ request, user daemon needs to reply with +CACHEFILES_IOC_CREAD ioctl on the corresponding anon_fd:: + + ioctl(fd, CACHEFILES_IOC_CREAD, id); + + * ``fd`` is exactly the fd field of the previous READ request. + + * ``id`` is exactly the id field of the previous READ request.
Signature · 1 line
2.27.0
PATCH v7 7/19 erofs: make erofs_map_blocks() generally available
In reply to Jeffle Xu... so that it can be used in the following introduced fscache mode.
--- fs/erofs/data.c | 4 ++-- fs/erofs/internal.h | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-)
fs/erofs/data.c +2 -2
@@ -110,8 +110,8 @@ static int erofs_map_blocks_flatmode(struct inode *inode,return 0 ; } -static int erofs_map_blocks (struct inode *inode, -struct erofs_map_blocks *map,int flags) +int erofs_map_blocks (struct inode *inode, +struct erofs_map_blocks *map,int flags) {struct super_block *sb = inode->i_sb;struct erofs_inode *vi =EROFS_I (inode);
fs/erofs/internal.h +2 -0
@@ -486,6 +486,8 @@ void *erofs_read_metabuf(struct erofs_buf *buf, struct super_block *sb,int erofs_map_dev (struct super_block *sb,struct erofs_map_dev *dev);int erofs_fiemap (struct inode *inode,struct fiemap_extent_info *fieinfo,u64 start,u64 len); +int erofs_map_blocks (struct inode *inode, +struct erofs_map_blocks *map,int flags);/* inode.c */ static inline unsigned long erofs_inode_hash (erofs_nid_t nid)
Signature · 1 line
2.27.0
PATCH v7 8/19 erofs: add mode checking helper
In reply to Jeffle XuUntil then erofs is exactly blockdev based filesystem.
A new fscache-based mode is going to be introduced for erofs to support scenarios where on-demand read semantics is needed, e.g. container image distribution. In this case, erofs could be mounted from data blobs through fscache.
Add a helper checking which mode erofs works in.
--- fs/erofs/internal.h | 5 +++++ 1 file changed, 5 insertions(+)
fs/erofs/internal.h +5 -0
@@ -161,6 +161,11 @@ struct erofs_sb_info {#define set_opt (opt, option) ((opt)->mount_opt |= EROFS_MOUNT_##option)#define test_opt (opt, option) ((opt)->mount_opt & EROFS_MOUNT_##option) +static inline bool erofs_is_fscache_mode (struct super_block *sb) +{ +return IS_ENABLED (CONFIG_EROFS_FS_ONDEMAND ) && !sb->s_bdev; +} +enum {EROFS_ZIP_CACHE_DISABLED ,EROFS_ZIP_CACHE_READAHEAD ,
Signature · 1 line
2.27.0
PATCH v7 9/19 erofs: register fscache volume
In reply to Jeffle XuA new fscache based mode is going to be introduced for erofs, in which case on-demand read semantics is implemented through fscache.
As the first step, register fscache volume for each erofs filesystem. That means, data blobs can not be shared among erofs filesystems. In the following iteration, we are going to introduce the domain semantics, in which case several erofs filesystems can belong to one domain, and data blobs can be shared among these erofs filesystems of one domain.
--- fs/erofs/Kconfig | 10 ++++++++++ fs/erofs/Makefile | 1 + fs/erofs/fscache.c | 37 +++++++++++++++++++++++++++++++++++++ fs/erofs/internal.h | 13 +++++++++++++ fs/erofs/super.c | 7 +++++++ 5 files changed, 68 insertions(+) create mode 100644 fs/erofs/fscache.c
fs/erofs/Kconfig +10 -0
@@ -98,3 +98,13 @@ config EROFS_FS_ZIP_LZMA systems will be readable without selecting this option. If unsure, say N. + +config EROFS_FS_ONDEMAND + bool "EROFS fscache-based ondemand-read" + depends on CACHEFILES_ONDEMAND && (EROFS_FS=m && FSCACHE || EROFS_FS=y && FSCACHE=y) + default n + help + EROFS is mounted from data blobs and on-demand read semantics is + implemented through fscache. + + If unsure, say N.
fs/erofs/Makefile +1 -0
@@ -5,3 +5,4 @@ erofs-objs := super.o inode.o data.o namei.o dir.o utils.o pcpubuf.o sysfs.o erofs-$(CONFIG_EROFS_FS_XATTR) += xattr.o erofs-$(CONFIG_EROFS_FS_ZIP) += decompressor.o zmap.o zdata.o erofs-$(CONFIG_EROFS_FS_ZIP_LZMA) += decompressor_lzma.o +erofs-$(CONFIG_EROFS_FS_ONDEMAND) += fscache.o
fs/erofs/fscache.c new file +37 -0
@@ -0,0 +1,37 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* +* Copyright (C) 2022, Alibaba Cloud +*/ +#include <linux/fscache.h> +#include "internal.h" + +int erofs_fscache_register_fs (struct super_block *sb) +{ +struct erofs_sb_info *sbi =EROFS_SB (sb); +struct fscache_volume *volume; +char *name; +int ret =0 ; + + name =kasprintf (GFP_KERNEL ,"erofs,%s" , sbi->opt.fsid); +if (!name) +return -ENOMEM ; + + volume =fscache_acquire_volume (name,NULL ,NULL ,0 ); +if (IS_ERR_OR_NULL (volume)) { +erofs_err (sb,"failed to register volume for %s" , name); + ret = volume ?PTR_ERR (volume) : -EOPNOTSUPP ; + volume =NULL ; + } + + sbi->volume = volume; +kfree (name); +return ret; +} + +void erofs_fscache_unregister_fs (struct super_block *sb) +{ +struct erofs_sb_info *sbi =EROFS_SB (sb); + +fscache_relinquish_volume (sbi->volume,NULL , false); + sbi->volume =NULL ; +}
fs/erofs/internal.h +13 -0
@@ -74,6 +74,7 @@ struct erofs_mount_opts {unsigned int max_sync_decompress_pages;#endif unsigned int mount_opt; +char *fsid; };struct erofs_dev_context {
@@ -146,6 +147,9 @@ struct erofs_sb_info {/* sysfs support */ struct kobject s_kobj;/* /sys/fs/erofs/<devname> */ struct completion s_kobj_unregister; + +/* fscache support */ +struct fscache_volume *volume; };#define EROFS_SB (sb) ((struct erofs_sb_info *)(sb)->s_fs_info)
@@ -618,6 +622,15 @@ static inline int z_erofs_load_lzma_config(struct super_block *sb, }#endif /* !CONFIG_EROFS_FS_ZIP */ +/* fscache.c */ +#ifdef CONFIG_EROFS_FS_ONDEMAND +int erofs_fscache_register_fs (struct super_block *sb); +void erofs_fscache_unregister_fs (struct super_block *sb); +#else +static inline int erofs_fscache_register_fs (struct super_block *sb) {return 0 ; } +static inline void erofs_fscache_unregister_fs (struct super_block *sb) {} +#endif +#define EFSCORRUPTED EUCLEAN/* Filesystem is corrupted */ #endif /* __EROFS_INTERNAL_H */
fs/erofs/super.c +7 -0
@@ -601,6 +601,12 @@ static int erofs_fc_fill_super(struct super_block *sb, struct fs_context *fc) sbi->devs = ctx->devs; ctx->devs =NULL ; +if (erofs_is_fscache_mode (sb)) { + err =erofs_fscache_register_fs (sb); +if (err) +return err; + } + err =erofs_read_superblock (sb);if (err)return err;
@@ -757,6 +763,7 @@ static void erofs_kill_sb(struct super_block *sb)erofs_free_dev_context (sbi->devs);fs_put_dax (sbi->dax_dev); +erofs_fscache_unregister_fs (sb);kfree (sbi); sb->s_fs_info =NULL ; }
Signature · 1 line
2.27.0
PATCH v7 10/19 erofs: add fscache context helper functions
In reply to Jeffle XuIntroduce a context structure for managing data blobs, and helper functions for initializing and cleaning up this context structure.
--- fs/erofs/fscache.c | 46 +++++++++++++++++++++++++++++++++++++++++++++ fs/erofs/internal.h | 19 +++++++++++++++++++ 2 files changed, 65 insertions(+)
fs/erofs/fscache.c +46 -0
@@ -5,6 +5,52 @@#include <linux/fscache.h> #include "internal.h" +/* +* Create an fscache context for data blob. +* Return: 0 on success and allocated fscache context is assigned to @fscache, +* negative error number on failure. +*/ +int erofs_fscache_register_cookie (struct super_block *sb, +struct erofs_fscache **fscache,char *name) +{ +struct fscache_volume *volume =EROFS_SB (sb)->volume; +struct erofs_fscache *ctx; +struct fscache_cookie *cookie; + + ctx =kzalloc (sizeof (*ctx),GFP_KERNEL ); +if (!ctx) +return -ENOMEM ; + + cookie =fscache_acquire_cookie (volume,FSCACHE_ADV_WANT_CACHE_SIZE , + name,strlen (name),NULL ,0 ,0 ); +if (!cookie) { +erofs_err (sb,"failed to get cookie for %s" , name); +kfree (name); +return -EINVAL ; + } + +fscache_use_cookie (cookie, false); + ctx->cookie = cookie; + + *fscache = ctx; +return 0 ; +} + +void erofs_fscache_unregister_cookie (struct erofs_fscache **fscache) +{ +struct erofs_fscache *ctx = *fscache; + +if (!ctx) +return ; + +fscache_unuse_cookie (ctx->cookie,NULL ,NULL ); +fscache_relinquish_cookie (ctx->cookie, false); + ctx->cookie =NULL ; + +kfree (ctx); + *fscache =NULL ; +} +int erofs_fscache_register_fs (struct super_block *sb) {struct erofs_sb_info *sbi =EROFS_SB (sb);
fs/erofs/internal.h +19 -0
@@ -97,6 +97,10 @@ struct erofs_sb_lz4_info {u16 max_pclusterblks; }; +struct erofs_fscache { +struct fscache_cookie *cookie; +}; +struct erofs_sb_info {struct erofs_mount_opts opt;/* options */ #ifdef CONFIG_EROFS_FS_ZIP
@@ -626,9 +630,24 @@ static inline int z_erofs_load_lzma_config(struct super_block *sb,#ifdef CONFIG_EROFS_FS_ONDEMAND int erofs_fscache_register_fs (struct super_block *sb);void erofs_fscache_unregister_fs (struct super_block *sb); + +int erofs_fscache_register_cookie (struct super_block *sb, +struct erofs_fscache **fscache,char *name); +void erofs_fscache_unregister_cookie (struct erofs_fscache **fscache);#else static inline int erofs_fscache_register_fs (struct super_block *sb) {return 0 ; }static inline void erofs_fscache_unregister_fs (struct super_block *sb) {} + +static inline int erofs_fscache_register_cookie (struct super_block *sb, +struct erofs_fscache **fscache, +char *name) +{ +return -EOPNOTSUPP ; +} + +static inline void erofs_fscache_unregister_cookie (struct erofs_fscache **fscache) +{ +}#endif #define EFSCORRUPTED EUCLEAN/* Filesystem is corrupted */
Signature · 1 line
2.27.0
PATCH v7 11/19 erofs: add anonymous inode managing page cache for data blob
In reply to Jeffle XuIntroduce one anonymous inode managing page cache for data blob. Then erofs could read directly from the address space of the anonymous inode when cache hit.
--- fs/erofs/fscache.c | 39 ++++++++++++++++++++++++++++++++++++--- fs/erofs/internal.h | 6 ++++-- 2 files changed, 40 insertions(+), 5 deletions(-)
fs/erofs/fscache.c +36 -3
@@ -5,17 +5,22 @@#include <linux/fscache.h> #include "internal.h" +static const struct address_space_operations erofs_fscache_meta_aops = { +}; +/* * Create an fscache context for data blob. * Return: 0 on success and allocated fscache context is assigned to @fscache, * negative error number on failure. */ int erofs_fscache_register_cookie (struct super_block *sb, -struct erofs_fscache **fscache,char *name) +struct erofs_fscache **fscache, +char *name,bool need_inode) {struct fscache_volume *volume =EROFS_SB (sb)->volume;struct erofs_fscache *ctx;struct fscache_cookie *cookie; +int ret; ctx =kzalloc (sizeof (*ctx),GFP_KERNEL );if (!ctx)
@@ -25,15 +30,40 @@ int erofs_fscache_register_cookie(struct super_block *sb, name, strlen(name), NULL, 0, 0);if (!cookie) {erofs_err (sb,"failed to get cookie for %s" , name); -kfree (name); -return -EINVAL ; + ret = -EINVAL ; + goto err; }fscache_use_cookie (cookie, false); ctx->cookie = cookie; +if (need_inode) { +struct inode *const inode =new_inode (sb); + +if (!inode) { +erofs_err (sb,"failed to get anon inode for %s" , name); + ret = -ENOMEM ; + goto err_cookie; + } + +set_nlink (inode,1 ); + inode->i_size =OFFSET_MAX ; + inode->i_mapping->a_ops = &erofs_fscache_meta_aops; +mapping_set_gfp_mask (inode->i_mapping,GFP_NOFS ); + + ctx->inode = inode; + } + *fscache = ctx;return 0 ; + +err_cookie: +fscache_unuse_cookie (ctx->cookie,NULL ,NULL ); +fscache_relinquish_cookie (ctx->cookie, false); + ctx->cookie =NULL ; +err: +kfree (ctx); +return ret; }void erofs_fscache_unregister_cookie (struct erofs_fscache **fscache)
@@ -47,6 +77,9 @@ void erofs_fscache_unregister_cookie(struct erofs_fscache **fscache)fscache_relinquish_cookie (ctx->cookie, false); ctx->cookie =NULL ; +iput (ctx->inode); + ctx->inode =NULL ; +kfree (ctx); *fscache =NULL ; }
fs/erofs/internal.h +4 -2
@@ -99,6 +99,7 @@ struct erofs_sb_lz4_info {struct erofs_fscache {struct fscache_cookie *cookie; +struct inode *inode; };struct erofs_sb_info {
@@ -632,7 +633,8 @@ int erofs_fscache_register_fs(struct super_block *sb);void erofs_fscache_unregister_fs (struct super_block *sb);int erofs_fscache_register_cookie (struct super_block *sb, -struct erofs_fscache **fscache,char *name); +struct erofs_fscache **fscache, +char *name,bool need_inode);void erofs_fscache_unregister_cookie (struct erofs_fscache **fscache);#else static inline int erofs_fscache_register_fs (struct super_block *sb) {return 0 ; }
@@ -640,7 +642,7 @@ static inline void erofs_fscache_unregister_fs(struct super_block *sb) {}static inline int erofs_fscache_register_cookie (struct super_block *sb,struct erofs_fscache **fscache, -char *name) +char *name,bool need_inode) {return -EOPNOTSUPP ; }
Signature · 1 line
2.27.0
PATCH v7 12/19 erofs: add erofs_fscache_read_folios() helper
In reply to Jeffle XuAdd erofs_fscache_read_folios() helper reading from fscache. It supports on-demand read semantics. That is, it will make the backend prepare for the data when cache miss. Once data ready, it will reinitiate a read from the cache.
This helper can then be used to implement .readpage()/.readahead() of on-demand read semantics.
--- fs/erofs/fscache.c | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+)
fs/erofs/fscache.c +29 -0
@@ -5,6 +5,35 @@#include <linux/fscache.h> #include "internal.h" +/* +* Read data from fscache and fill the read data into page cache described by +* @start/len, which shall be both aligned with PAGE_SIZE. @pstart describes +* the start physical address in the cache file. +*/ +static int erofs_fscache_read_folios (struct fscache_cookie *cookie, +struct address_space *mapping, +loff_t start,size_t len, +loff_t pstart) +{ +struct netfs_cache_resources cres; +struct iov_iter iter; +int ret; + +memset (&cres,0 ,sizeof (cres)); + + ret =fscache_begin_read_operation (&cres, cookie); +if (ret) +return ret; + +iov_iter_xarray (&iter,READ , &mapping->i_pages, start, len); + + ret =fscache_read (&cres, pstart, &iter, +NETFS_READ_HOLE_ONDEMAND ,NULL ,NULL ); + +fscache_end_operation (&cres); +return ret; +} +static const struct address_space_operations erofs_fscache_meta_aops = { };
Signature · 1 line
2.27.0
PATCH v7 13/19 erofs: register fscache context for primary data blob
In reply to Jeffle XuRegisters fscache context for primary data blob. Also move the initialization of s_op and related fields forward, since anonymous inode will be allocated under the super block when registering the fscache context.
Something worth mentioning about the cleanup routine.
1. The fscache context will instantiate anonymous inodes under the super block. Release these anonymous inodes when .put_super() is called, or we'll get "VFS: Busy inodes after unmount." warning.
2. The fscache context is initialized prior to the root inode. If .kill_sb() is called when mount failed, .put_super() won't be called when root inode has not been initialized yet. Thus .kill_sb() shall also contain the cleanup routine.
--- fs/erofs/internal.h | 1 + fs/erofs/super.c | 15 +++++++++++---- 2 files changed, 12 insertions(+), 4 deletions(-)
fs/erofs/internal.h +1 -0
@@ -155,6 +155,7 @@ struct erofs_sb_info {/* fscache support */ struct fscache_volume *volume; +struct erofs_fscache *s_fscache; };#define EROFS_SB (sb) ((struct erofs_sb_info *)(sb)->s_fs_info)
fs/erofs/super.c +11 -4
@@ -585,6 +585,9 @@ static int erofs_fc_fill_super(struct super_block *sb, struct fs_context *fc)int err; sb->s_magic =EROFS_SUPER_MAGIC ; + sb->s_flags |=SB_RDONLY |SB_NOATIME ; + sb->s_maxbytes =MAX_LFS_FILESIZE ; + sb->s_op = &erofs_sops;if (!sb_set_blocksize (sb,EROFS_BLKSIZ )) {erofs_err (sb,"failed to set erofs blksize" );
@@ -605,6 +608,11 @@ static int erofs_fc_fill_super(struct super_block *sb, struct fs_context *fc) err =erofs_fscache_register_fs (sb);if (err)return err; + + err =erofs_fscache_register_cookie (sb, &sbi->s_fscache, + sbi->opt.fsid, true); +if (err) +return err; } err =erofs_read_superblock (sb);
@@ -619,11 +627,8 @@ static int erofs_fc_fill_super(struct super_block *sb, struct fs_context *fc)clear_opt (&sbi->opt,DAX_ALWAYS ); } } - sb->s_flags |=SB_RDONLY |SB_NOATIME ; - sb->s_maxbytes =MAX_LFS_FILESIZE ; - sb->s_time_gran =1 ; - sb->s_op = &erofs_sops; + sb->s_time_gran =1 ; sb->s_xattr = erofs_xattr_handlers;if (test_opt (&sbi->opt,POSIX_ACL ))
@@ -763,6 +768,7 @@ static void erofs_kill_sb(struct super_block *sb)erofs_free_dev_context (sbi->devs);fs_put_dax (sbi->dax_dev); +erofs_fscache_unregister_cookie (&sbi->s_fscache);erofs_fscache_unregister_fs (sb);kfree (sbi); sb->s_fs_info =NULL ;
@@ -781,6 +787,7 @@ static void erofs_put_super(struct super_block *sb)iput (sbi->managed_cache); sbi->managed_cache =NULL ;#endif +erofs_fscache_unregister_cookie (&sbi->s_fscache); }static struct file_system_type erofs_fs_type = {
Signature · 1 line
2.27.0
PATCH v7 14/19 erofs: register fscache context for extra data blobs
In reply to Jeffle XuSimilar to the multi device mode, erofs could be mounted from one primary data blob (mandatory) and multiple extra data blobs (optional).
Register fscache context for each extra data blob.
--- fs/erofs/data.c | 3 +++ fs/erofs/internal.h | 2 ++ fs/erofs/super.c | 25 +++++++++++++++++-------- 3 files changed, 22 insertions(+), 8 deletions(-)
fs/erofs/data.c +3 -0
@@ -199,6 +199,7 @@ int erofs_map_dev(struct super_block *sb, struct erofs_map_dev *map) map->m_bdev = sb->s_bdev; map->m_daxdev =EROFS_SB (sb)->dax_dev; map->m_dax_part_off =EROFS_SB (sb)->dax_part_off; + map->m_fscache =EROFS_SB (sb)->s_fscache;if (map->m_deviceid) {down_read (&devs->rwsem);
@@ -210,6 +211,7 @@ int erofs_map_dev(struct super_block *sb, struct erofs_map_dev *map) map->m_bdev = dif->bdev; map->m_daxdev = dif->dax_dev; map->m_dax_part_off = dif->dax_part_off; + map->m_fscache = dif->fscache;up_read (&devs->rwsem); }else if (devs->extra_devices) {down_read (&devs->rwsem);
@@ -227,6 +229,7 @@ int erofs_map_dev(struct super_block *sb, struct erofs_map_dev *map) map->m_bdev = dif->bdev; map->m_daxdev = dif->dax_dev; map->m_dax_part_off = dif->dax_part_off; + map->m_fscache = dif->fscache;break ; } }
fs/erofs/internal.h +2 -0
@@ -49,6 +49,7 @@ typedef u32 erofs_blk_t;struct erofs_device_info {char *path; +struct erofs_fscache *fscache;struct block_device *bdev;struct dax_device *dax_dev;u64 dax_part_off;
@@ -482,6 +483,7 @@ static inline int z_erofs_map_blocks_iter(struct inode *inode,#endif /* !CONFIG_EROFS_FS_ZIP */ struct erofs_map_dev { +struct erofs_fscache *m_fscache;struct block_device *m_bdev;struct dax_device *m_daxdev;u64 m_dax_part_off;
fs/erofs/super.c +17 -8
@@ -259,15 +259,23 @@ static int erofs_init_devices(struct super_block *sb, } dis = ptr +erofs_blkoff (pos); - bdev =blkdev_get_by_path (dif->path, -FMODE_READ |FMODE_EXCL , - sb->s_type); -if (IS_ERR (bdev)) { - err =PTR_ERR (bdev); -break ; +if (erofs_is_fscache_mode (sb)) { + err =erofs_fscache_register_cookie (sb, &dif->fscache, + dif->path, false); +if (err) +break ; + }else { + bdev =blkdev_get_by_path (dif->path, +FMODE_READ |FMODE_EXCL , + sb->s_type); +if (IS_ERR (bdev)) { + err =PTR_ERR (bdev); +break ; + } + dif->bdev = bdev; + dif->dax_dev =fs_dax_get_by_bdev (bdev, &dif->dax_part_off); } - dif->bdev = bdev; - dif->dax_dev =fs_dax_get_by_bdev (bdev, &dif->dax_part_off); + dif->blocks =le32_to_cpu (dis->blocks); dif->mapped_blkaddr =le32_to_cpu (dis->mapped_blkaddr); sbi->total_blocks += dif->blocks;
@@ -701,6 +709,7 @@ static int erofs_release_device_info(int id, void *ptr, void *data)fs_put_dax (dif->dax_dev);if (dif->bdev)blkdev_put (dif->bdev,FMODE_READ |FMODE_EXCL ); +erofs_fscache_unregister_cookie (&dif->fscache);kfree (dif->path);kfree (dif);return 0 ;
Signature · 1 line
2.27.0
PATCH v7 15/19 erofs: implement fscache-based metadata read
In reply to Jeffle XuImplement the data plane of reading metadata from primary data blob over fscache.
--- fs/erofs/data.c | 20 ++++++++++++++++++-- fs/erofs/fscache.c | 38 ++++++++++++++++++++++++++++++++++++++ fs/erofs/internal.h | 9 +++++++++ 3 files changed, 65 insertions(+), 2 deletions(-)
fs/erofs/data.c +18 -2
@@ -31,15 +31,26 @@ void erofs_put_metabuf(struct erofs_buf *buf)void *erofs_bread (struct erofs_buf *buf,struct inode *inode,erofs_blk_t blkaddr,enum erofs_kmap_type type) { -struct address_space *const mapping = inode->i_mapping;erofs_off_t offset =blknr_to_addr (blkaddr);pgoff_t index = offset >>PAGE_SHIFT ;struct page *page = buf->page;if (!page || page->index != index) {erofs_put_metabuf (buf); - page =read_cache_page_gfp (mapping, index, +if (buf->sb) { +struct folio *folio; + + folio =erofs_fscache_get_folio (buf->sb, index); +if (IS_ERR (folio)) + page =ERR_CAST (folio); +else + page =folio_page (folio,0 ); + }else { +struct address_space *const mapping = inode->i_mapping; + + page =read_cache_page_gfp (mapping, index,mapping_gfp_constraint (mapping, ~__GFP_FS)); + }if (IS_ERR (page))return page;/* should already be PageUptodate, no need to lock page */
@@ -63,6 +74,11 @@ void *erofs_bread(struct erofs_buf *buf, struct inode *inode,void *erofs_read_metabuf (struct erofs_buf *buf,struct super_block *sb,erofs_blk_t blkaddr,enum erofs_kmap_type type) { +if (erofs_is_fscache_mode (sb)) { + buf->sb = sb; +return erofs_bread (buf,NULL , blkaddr, type); + } +return erofs_bread (buf, sb->s_bdev->bd_inode, blkaddr, type); }
fs/erofs/fscache.c +38 -0
@@ -34,9 +34,47 @@ static int erofs_fscache_read_folios(struct fscache_cookie *cookie,return ret; } +static int erofs_fscache_meta_readpage (struct file *data,struct page *page) +{ +int ret; +struct super_block *sb = (struct super_block *)data; +struct folio *folio =page_folio (page); +struct erofs_map_dev mdev = { + .m_deviceid =0 , + .m_pa =folio_pos (folio), + }; + + ret =erofs_map_dev (sb, &mdev); +if (ret) + goto out; + + ret =erofs_fscache_read_folios (mdev.m_fscache->cookie, +folio_file_mapping (folio),folio_pos (folio), +folio_size (folio), mdev.m_pa); +if (ret) + goto out; + +folio_mark_uptodate (folio); +out: +folio_unlock (folio); +return ret; +} +static const struct address_space_operations erofs_fscache_meta_aops = { + .readpage = erofs_fscache_meta_readpage, }; +/* +* Get the page cache of data blob at the index offset. +* Return: up to date page on success, ERR_PTR() on failure. +*/ +struct folio *erofs_fscache_get_folio (struct super_block *sb,pgoff_t index) +{ +struct erofs_fscache *ctx =EROFS_SB (sb)->s_fscache; + +return read_mapping_folio (ctx->inode->i_mapping, index, (void *)sb); +} +/* * Create an fscache context for data blob. * Return: 0 on success and allocated fscache context is assigned to @fscache,
fs/erofs/internal.h +9 -0
@@ -276,6 +276,7 @@ enum erofs_kmap_type { };struct erofs_buf { +struct super_block *sb;struct page *page;void *base;enum erofs_kmap_type kmap_type;
@@ -639,6 +640,8 @@ int erofs_fscache_register_cookie(struct super_block *sb,struct erofs_fscache **fscache, char *name, bool need_inode);void erofs_fscache_unregister_cookie (struct erofs_fscache **fscache); + +struct folio *erofs_fscache_get_folio (struct super_block *sb,pgoff_t index);#else static inline int erofs_fscache_register_fs (struct super_block *sb) {return 0 ; }static inline void erofs_fscache_unregister_fs (struct super_block *sb) {}
@@ -653,6 +656,12 @@ static inline int erofs_fscache_register_cookie(struct super_block *sb,static inline void erofs_fscache_unregister_cookie (struct erofs_fscache **fscache) { } + +static inline struct folio *erofs_fscache_get_folio (struct super_block *sb, +pgoff_t index) +{ +return ERR_PTR (-EOPNOTSUPP ); +}#endif #define EFSCORRUPTED EUCLEAN/* Filesystem is corrupted */
Signature · 1 line
2.27.0
PATCH v7 16/19 erofs: implement fscache-based data read for non-inline layout
In reply to Jeffle XuImplement the data plane of reading data from data blobs over fscache for non-inline layout.
--- fs/erofs/fscache.c | 52 +++++++++++++++++++++++++++++++++++++++++++++ fs/erofs/inode.c | 5 +++++ fs/erofs/internal.h | 2 ++ 3 files changed, 59 insertions(+)
fs/erofs/fscache.c +52 -0
@@ -60,10 +60,62 @@ static int erofs_fscache_meta_readpage(struct file *data, struct page *page)return ret; } +static int erofs_fscache_readpage (struct file *file,struct page *page) +{ +struct folio *folio =page_folio (page); +struct inode *inode =folio_file_mapping (folio)->host; +struct super_block *sb = inode->i_sb; +struct erofs_map_blocks map; +struct erofs_map_dev mdev; +erofs_off_t pos; +loff_t pstart; +int ret =0 ; + +DBG_BUGON (folio_size (folio) !=EROFS_BLKSIZ ); + + pos =folio_pos (folio); + map.m_la = pos; + + ret =erofs_map_blocks (inode, &map,EROFS_GET_BLOCKS_RAW ); +if (ret) + goto out_unlock; + +if (!(map.m_flags &EROFS_MAP_MAPPED )) { +folio_zero_range (folio,0 ,folio_size (folio)); + goto out_uptodate; + } + +/* no-inline readpage */ + mdev = (struct erofs_map_dev ) { + .m_deviceid = map.m_deviceid, + .m_pa = map.m_pa, + }; + + ret =erofs_map_dev (sb, &mdev); +if (ret) + goto out_unlock; + + pstart = mdev.m_pa + (pos - map.m_la); + ret =erofs_fscache_read_folios (mdev.m_fscache->cookie, +folio_file_mapping (folio),folio_pos (folio), +folio_size (folio), pstart); + +out_uptodate: +if (!ret) +folio_mark_uptodate (folio); +out_unlock: +folio_unlock (folio); +return ret; +} +static const struct address_space_operations erofs_fscache_meta_aops = { .readpage = erofs_fscache_meta_readpage, }; +const struct address_space_operations erofs_fscache_access_aops = { + .readpage = erofs_fscache_readpage, +}; +/* * Get the page cache of data blob at the index offset. * Return: up to date page on success, ERR_PTR() on failure.
fs/erofs/inode.c +5 -0
@@ -296,7 +296,12 @@ static int erofs_fill_inode(struct inode *inode, int isdir) err =z_erofs_fill_inode (inode); goto out_unlock; } + inode->i_mapping->a_ops = &erofs_raw_access_aops; +#ifdef CONFIG_EROFS_FS_ONDEMAND +if (erofs_is_fscache_mode (inode->i_sb)) + inode->i_mapping->a_ops = &erofs_fscache_access_aops; +#endif out_unlock:erofs_put_metabuf (&buf);
fs/erofs/internal.h +2 -0
@@ -642,6 +642,8 @@ int erofs_fscache_register_cookie(struct super_block *sb,void erofs_fscache_unregister_cookie (struct erofs_fscache **fscache);struct folio *erofs_fscache_get_folio (struct super_block *sb,pgoff_t index); + +extern const struct address_space_operations erofs_fscache_access_aops;#else static inline int erofs_fscache_register_fs (struct super_block *sb) {return 0 ; }static inline void erofs_fscache_unregister_fs (struct super_block *sb) {}
Signature · 1 line
2.27.0
PATCH v7 17/19 erofs: implement fscache-based data read for inline layout
In reply to Jeffle XuImplement the data plane of reading data from data blobs over fscache for inline layout.
For the heading non-inline part, the data plane for non-inline layout is reused, while only the tail packing part needs special handling.
--- fs/erofs/fscache.c | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+)
fs/erofs/fscache.c +40 -0
@@ -60,6 +60,40 @@ static int erofs_fscache_meta_readpage(struct file *data, struct page *page)return ret; } +static int erofs_fscache_readpage_inline (struct folio *folio, +struct erofs_map_blocks *map) +{ +struct inode *inode =folio_file_mapping (folio)->host; +struct super_block *sb = inode->i_sb; +struct erofs_buf buf = __EROFS_BUF_INITIALIZER; +erofs_blk_t blknr; +size_t offset, len; +void *src, *dst; + +/* +* For inline (tail packing) layout, the offset may be non-zero, which +* can be calculated from corresponding physical address directly. +*/ + offset =erofs_blkoff (map->m_pa); + blknr =erofs_blknr (map->m_pa); + len = map->m_llen; + + src =erofs_read_metabuf (&buf, sb, blknr,EROFS_KMAP ); +if (IS_ERR (src)) +return PTR_ERR (src); + +DBG_BUGON (folio_size (folio) !=PAGE_SIZE ); + + dst =kmap (folio_page (folio,0 )); +memcpy (dst, src + offset, len); +memset (dst + len,0 ,PAGE_SIZE - len); +kunmap (folio_page (folio,0 )); + +erofs_put_metabuf (&buf); + +return 0 ; +} +static int erofs_fscache_readpage (struct file *file,struct page *page) {struct folio *folio =page_folio (page);
@@ -85,6 +119,12 @@ static int erofs_fscache_readpage(struct file *file, struct page *page) goto out_uptodate; } +/* inline readpage */ +if (map.m_flags &EROFS_MAP_META ) { + ret =erofs_fscache_readpage_inline (folio, &map); + goto out_uptodate; + } +/* no-inline readpage */ mdev = (struct erofs_map_dev ) { .m_deviceid = map.m_deviceid,
Signature · 1 line
2.27.0
PATCH v7 18/19 erofs: implement fscache-based data readahead
In reply to Jeffle XuImplement fscache-based data readahead. Also registers an individual bdi for each erofs instance to enable readahead.
--- fs/erofs/fscache.c | 94 ++++++++++++++++++++++++++++++++++++++++++++++ fs/erofs/super.c | 4 ++ 2 files changed, 98 insertions(+)
fs/erofs/fscache.c +94 -0
@@ -148,12 +148,106 @@ static int erofs_fscache_readpage(struct file *file, struct page *page)return ret; } +static inline void erofs_fscache_unlock_folios (struct readahead_control *rac, +size_t len) +{ +while (len) { +struct folio *folio =readahead_folio (rac); + + len -=folio_size (folio); +folio_mark_uptodate (folio); +folio_unlock (folio); + } +} + +static void erofs_fscache_readahead (struct readahead_control *rac) +{ +struct inode *inode = rac->mapping->host; +struct super_block *sb = inode->i_sb; +size_t len, count, done =0 ; +erofs_off_t pos; +loff_t start, offset; +int ret; + +if (!readahead_count (rac)) +return ; + + start =readahead_pos (rac); + len =readahead_length (rac); + +do { +struct erofs_map_blocks map; +struct erofs_map_dev mdev; + + pos = start + done; + map.m_la = pos; + + ret =erofs_map_blocks (inode, &map,EROFS_GET_BLOCKS_RAW ); +if (ret) +return ; + +/* +* 1) For CHUNK_BASED layout, the output m_la is rounded down to +* the nearest chunk boundary, and the output m_llen actually +* starts from the start of the containing chunk. +* 2) For other cases, the output m_la is equal to o_la. +*/ + offset = start + done; + count =min_t (size_t, map.m_llen - (pos - map.m_la), len - done); + +/* Read-ahead Hole */ +if (!(map.m_flags &EROFS_MAP_MAPPED )) { +struct iov_iter iter; + +iov_iter_xarray (&iter,READ , &rac->mapping->i_pages, + offset, count); +iov_iter_zero (count, &iter); + +erofs_fscache_unlock_folios (rac, count); + ret = count; +continue ; + } + +/* Read-ahead Inline */ +if (map.m_flags &EROFS_MAP_META ) { +struct folio *folio =readahead_folio (rac); + + ret =erofs_fscache_readpage_inline (folio, &map); +if (!ret) { +folio_mark_uptodate (folio); + ret =folio_size (folio); + } + +folio_unlock (folio); +continue ; + } + +/* Read-ahead No-inline */ + mdev = (struct erofs_map_dev ) { + .m_deviceid = map.m_deviceid, + .m_pa = map.m_pa, + }; + ret =erofs_map_dev (sb, &mdev); +if (ret) +return ; + + ret =erofs_fscache_read_folios (mdev.m_fscache->cookie, + rac->mapping, offset, count, + mdev.m_pa + (pos - map.m_la)); +if (!ret) { +erofs_fscache_unlock_folios (rac, count); + ret = count; + } + }while (ret >0 && ((done += ret) < len)); +} +static const struct address_space_operations erofs_fscache_meta_aops = { .readpage = erofs_fscache_meta_readpage, };const struct address_space_operations erofs_fscache_access_aops = { .readpage = erofs_fscache_readpage, + .readahead = erofs_fscache_readahead, };/*
fs/erofs/super.c +4 -0
@@ -621,6 +621,10 @@ static int erofs_fc_fill_super(struct super_block *sb, struct fs_context *fc) sbi->opt.fsid, true);if (err)return err; + + err =super_setup_bdi (sb); +if (err) +return err; } err =erofs_read_superblock (sb);
Signature · 1 line
2.27.0
PATCH v7 19/19 erofs: add 'fsid' mount option
In reply to Jeffle XuIntroduce 'fsid' mount option to enable on-demand read sementics, in which case, erofs will be mounted from data blobs. Users could specify the name of primary data blob by this mount option.
--- fs/erofs/super.c | 48 ++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 42 insertions(+), 6 deletions(-)
fs/erofs/super.c +42 -6
@@ -398,6 +398,7 @@ enum { Opt_dax, Opt_dax_enum, Opt_device, + Opt_fsid, Opt_err };
@@ -422,6 +423,7 @@ static const struct fs_parameter_spec erofs_fs_parameters[] = {fsparam_flag ("dax" , Opt_dax),fsparam_enum ("dax" , Opt_dax_enum, erofs_dax_param_enums),fsparam_string ("device" , Opt_device), + fsparam_string("fsid", Opt_fsid), {} };
@@ -517,6 +519,16 @@ static int erofs_fc_parse_param(struct fs_context *fc, } ++ctx->devs->extra_devices;break ; +case Opt_fsid: +#ifdef CONFIG_EROFS_FS_ONDEMAND +kfree (ctx->opt.fsid); + ctx->opt.fsid =kstrdup (param->string,GFP_KERNEL ); +if (!ctx->opt.fsid) +return -ENOMEM ; +#else +errorfc (fc,"fsid option not supported" ); +#endif +break ;default :return -ENOPARAM ; }
@@ -597,9 +609,14 @@ static int erofs_fc_fill_super(struct super_block *sb, struct fs_context *fc) sb->s_maxbytes =MAX_LFS_FILESIZE ; sb->s_op = &erofs_sops; -if (!sb_set_blocksize (sb,EROFS_BLKSIZ )) { -erofs_err (sb,"failed to set erofs blksize" ); -return -EINVAL ; +if (erofs_is_fscache_mode (sb)) { + sb->s_blocksize =EROFS_BLKSIZ ; + sb->s_blocksize_bits =LOG_BLOCK_SIZE ; + }else { +if (!sb_set_blocksize (sb,EROFS_BLKSIZ )) { +erofs_err (sb,"failed to set erofs blksize" ); +return -EINVAL ; + } } sbi =kzalloc (sizeof (*sbi),GFP_KERNEL );
@@ -608,7 +625,7 @@ static int erofs_fc_fill_super(struct super_block *sb, struct fs_context *fc) sb->s_fs_info = sbi; sbi->opt = ctx->opt; - sbi->dax_dev =fs_dax_get_by_bdev (sb->s_bdev, &sbi->dax_part_off); + ctx->opt.fsid =NULL ; sbi->devs = ctx->devs; ctx->devs =NULL ;
@@ -625,6 +642,8 @@ static int erofs_fc_fill_super(struct super_block *sb, struct fs_context *fc) err =super_setup_bdi (sb);if (err)return err; + }else { + sbi->dax_dev =fs_dax_get_by_bdev (sb->s_bdev, &sbi->dax_part_off); } err =erofs_read_superblock (sb);
@@ -684,6 +703,11 @@ static int erofs_fc_fill_super(struct super_block *sb, struct fs_context *fc)static int erofs_fc_get_tree (struct fs_context *fc) { +struct erofs_fs_context *ctx = fc->fs_private; + +if (IS_ENABLED (CONFIG_EROFS_FS_ONDEMAND ) && ctx->opt.fsid) +return get_tree_nodev (fc, erofs_fc_fill_super); +return get_tree_bdev (fc, erofs_fc_fill_super); }
@@ -733,6 +757,7 @@ static void erofs_fc_free(struct fs_context *fc)struct erofs_fs_context *ctx = fc->fs_private;erofs_free_dev_context (ctx->devs); +kfree (ctx->opt.fsid);kfree (ctx); }
@@ -773,7 +798,10 @@ static void erofs_kill_sb(struct super_block *sb)WARN_ON (sb->s_magic !=EROFS_SUPER_MAGIC ); -kill_block_super (sb); +if (erofs_is_fscache_mode (sb)) +generic_shutdown_super (sb); +else +kill_block_super (sb); sbi =EROFS_SB (sb);if (!sbi)
@@ -783,6 +811,7 @@ static void erofs_kill_sb(struct super_block *sb)fs_put_dax (sbi->dax_dev);erofs_fscache_unregister_cookie (&sbi->s_fscache);erofs_fscache_unregister_fs (sb); +kfree (sbi->opt.fsid);kfree (sbi); sb->s_fs_info =NULL ; }
@@ -884,7 +913,10 @@ static int erofs_statfs(struct dentry *dentry, struct kstatfs *buf) {struct super_block *sb = dentry->d_sb;struct erofs_sb_info *sbi =EROFS_SB (sb); -u64 id =huge_encode_dev (sb->s_bdev->bd_dev); +u64 id =0 ; + +if (!erofs_is_fscache_mode (sb)) + id =huge_encode_dev (sb->s_bdev->bd_dev); buf->f_type = sb->s_magic; buf->f_bsize =EROFS_BLKSIZ ;
@@ -929,6 +961,10 @@ static int erofs_show_options(struct seq_file *seq, struct dentry *root)seq_puts (seq,",dax=always" );if (test_opt (opt,DAX_NEVER ))seq_puts (seq,",dax=never" ); +#ifdef CONFIG_EROFS_FS_ONDEMAND +if (opt->fsid) +seq_printf (seq,",fsid=%s" , opt->fsid); +#endif return 0 ; }
Signature · 1 line
2.27.0
Quoted 11 lines · Jeffle Xu
changes since v6:
- cachefiles: "fscache: exportfscache_end_operation()" is still needed. Since it has been pull requested for 5.18 (not merged yet), it's not included in this patchset.Kernel Patchset
---------------
Git tree:
Quoted 7 lines
https://github.com/lostjeffle/linux.git jingbo/dev-erofs-fscache-v7
Gitweb:
https://github.com/lostjeffle/linux/commits/jingbo/dev-erofs-fscache-v7
I have rebased it to the latest upstream, which has contained David's PR on fscache/cachefiles. There's no git conflic when rebasing.
Signature · 2 lines
Thanks, Jeffle