iov_iter: Adjust styling/location of new splice functions
Subsystems (13)
v3 cover iov_iter: Adjust styling/location of new splice functions
Hi Jens, Al, Christoph,
Here are patches to make some changes that Christoph requested[1] to the new generic file splice functions that I implemented[2]. Apart from one functional change, they just altering the styling and move one of the functions to a different file:
(1) Rename the main functions:
generic_file_buffered_splice_read() -> filemap_splice_read() generic_file_direct_splice_read() -> direct_splice_read()
(2) Abstract out the calculation of the location of the head pipe buffer into a helper function in linux/pipe_fs_i.h.
(3) Use init_sync_kiocb() in filemap_splice_read().
This is where the functional change is. Some kiocb fields are then filled in where they were set to 0 before, including setting ki_flags from f_iocb_flags.
(4) Move filemap_splice_read() to mm/filemap.c. filemap_get_pages() can then be made static again.
(5) Fix splice-read for a number of filesystems that don't provide a
->read_folio() op and for which filemap_get_pages() cannot be used.
I've pushed the patches here also:
https://git.kernel.org/pub/scm/linux/kernel/git/dhowells/linux-fs.git/log/?h=iov-extract-3
I've also updated worked the changes into the commits on my iov-extract branch if that would be preferable, though that means Jens would need to update his for-6.3/iov-extract again.
David
Changes
=======
ver #3)
- Fix filesystems/drivers that don't have ->read_folio().
ver #2)
- Don't attempt to filter IOCB_* flags in filemap_splice_read().
David Howells (5):
splice: Rename new splice functions
splice: Provide pipe_head_buf() helper
splice: Use init_sync_kiocb() in filemap_splice_read()
splice: Move filemap_read_splice() to mm/filemap.c shmem, overlayfs, coda, tty, proc, kernfs, random: Fix splice-read
drivers/char/random.c | 4 +- drivers/tty/tty_io.c | 4 +- fs/coda/file.c | 36 +++++++++- fs/kernfs/file.c | 2 +- fs/overlayfs/file.c | 36 +++++++++- fs/proc/inode.c | 4 +- fs/proc/proc_sysctl.c | 2 +- fs/proc_namespace.c | 6 +- fs/splice.c | 146 ++------------------------------------ include/linux/fs.h | 6 ++ include/linux/pagemap.h | 2 - include/linux/pipe_fs_i.h | 20 ++++++ mm/filemap.c | 136 +++++++++++++++++++++++++++++++++-- mm/internal.h | 6 ++ mm/shmem.c | 124 +++++++++++++++++++++++++++++++- 15 files changed, 373 insertions(+), 161 deletions(-)
PATCH v3 1/5 splice: Rename new splice functions
Rename generic_file_buffered_splice_read() to filemap_splice_read().
Rename generic_file_direct_splice_read() to direct_splice_read().
--- fs/splice.c | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-)
fs/splice.c +8 -9
@@ -287,9 +287,9 @@ void splice_shrink_spd(struct splice_pipe_desc *spd)* Splice data from an O_DIRECT file into pages and then add them to the output * pipe. */ -static ssize_t generic_file_direct_splice_read (struct file *in,loff_t *ppos, -struct pipe_inode_info *pipe, -size_t len,unsigned int flags) +static ssize_t direct_splice_read (struct file *in,loff_t *ppos, +struct pipe_inode_info *pipe, +size_t len,unsigned int flags) {struct iov_iter to;struct bio_vec *bv;
@@ -417,10 +417,9 @@ static size_t splice_folio_into_pipe(struct pipe_inode_info *pipe,* Splice folios from the pagecache of a buffered (ie. non-O_DIRECT) file into * a pipe. */ -static ssize_t generic_file_buffered_splice_read (struct file *in,loff_t *ppos, -struct pipe_inode_info *pipe, -size_t len, -unsigned int flags) +static ssize_t filemap_splice_read (struct file *in,loff_t *ppos, +struct pipe_inode_info *pipe, +size_t len,unsigned int flags) {struct folio_batch fbatch;size_t total_spliced =0 , used, npages;
@@ -529,8 +528,8 @@ ssize_t generic_file_splice_read(struct file *in, loff_t *ppos,if (unlikely (!len))return 0 ;if (in->f_flags &O_DIRECT ) -return generic_file_direct_splice_read (in, ppos, pipe, len, flags); -return generic_file_buffered_splice_read (in, ppos, pipe, len, flags); +return direct_splice_read (in, ppos, pipe, len, flags); +return filemap_splice_read (in, ppos, pipe, len, flags); }EXPORT_SYMBOL (generic_file_splice_read);
PATCH v3 2/5 splice: Provide pipe_head_buf() helper
In reply to David HowellsProvide a helper, pipe_head_buf(), to get the current head buffer from a pipe. Implement this as a wrapper around a more general function, pipe_buf(), that gets a specified buffer.
--- fs/splice.c | 9 +++------ include/linux/pipe_fs_i.h | 20 ++++++++++++++++++++ 2 files changed, 23 insertions(+), 6 deletions(-)
fs/splice.c +3 -6
@@ -295,7 +295,6 @@ static ssize_t direct_splice_read(struct file *in, loff_t *ppos,struct bio_vec *bv;struct kiocb kiocb;struct page **pages; -unsigned int head;ssize_t ret;size_t used, npages, chunk, remain, reclaim;int i;
@@ -358,9 +357,8 @@ static ssize_t direct_splice_read(struct file *in, loff_t *ppos, }/* Push the remaining pages into the pipe. */ - head = pipe->head;for (i =0 ; i < npages; i++) { -struct pipe_buffer *buf = &pipe->bufs[head & (pipe->ring_size -1 )]; +struct pipe_buffer *buf =pipe_head_buf (pipe); chunk =min_t (size_t, remain,PAGE_SIZE ); *buf = (struct pipe_buffer ) {
@@ -369,10 +367,9 @@ static ssize_t direct_splice_read(struct file *in, loff_t *ppos, .offset = 0, .len = chunk, }; - head++; + pipe->head++; remain -= chunk; } - pipe->head = head;kfree (bv);return ret;
@@ -394,7 +391,7 @@ static size_t splice_folio_into_pipe(struct pipe_inode_info *pipe,while (spliced < size && !pipe_full (pipe->head, pipe->tail, pipe->max_usage)) { -struct pipe_buffer *buf = &pipe->bufs[pipe->head & (pipe->ring_size -1 )]; +struct pipe_buffer *buf =pipe_head_buf (pipe);size_t part =min_t (size_t,PAGE_SIZE - offset, size - spliced); *buf = (struct pipe_buffer ) {
include/linux/pipe_fs_i.h +20 -0
@@ -156,6 +156,26 @@ static inline bool pipe_full(unsigned int head, unsigned int tail,return pipe_occupancy (head, tail) >= limit; } +/** +* pipe_buf - Return the pipe buffer for the specified slot in the pipe ring +* @pipe: The pipe to access +* @slot: The slot of interest +*/ +static inline struct pipe_buffer *pipe_buf (const struct pipe_inode_info *pipe, +unsigned int slot) +{ +return &pipe->bufs[slot & (pipe->ring_size -1 )]; +} + +/** +* pipe_head_buf - Return the pipe buffer at the head of the pipe ring +* @pipe: The pipe to access +*/ +static inline struct pipe_buffer *pipe_head_buf (const struct pipe_inode_info *pipe) +{ +return pipe_buf (pipe, pipe->head); +} +/** * pipe_buf_get - get a reference to a pipe_buffer * @pipe: the pipe that the buffer belongs to
PATCH v3 3/5 splice: Use init_sync_kiocb() in filemap_splice_read()
In reply to David HowellsUse init_sync_kiocb() in filemap_splice_read() rather than open coding it.
---
Notes:
ver #2)
- Don't attempt to filter IOCB_* flags.
fs/splice.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)
fs/splice.c +3 -4
@@ -419,15 +419,14 @@ static ssize_t filemap_splice_read(struct file *in, loff_t *ppos, size_t len, unsigned int flags) {struct folio_batch fbatch; +struct kiocb iocb;size_t total_spliced =0 , used, npages;loff_t isize, end_offset;bool writably_mapped;int i, error =0 ; -struct kiocb iocb = { - .ki_filp = in, - .ki_pos = *ppos, - }; +init_sync_kiocb (&iocb, in); + iocb.ki_pos = *ppos;/* Work out how much data we can actually add into the pipe */ used =pipe_occupancy (pipe->head, pipe->tail);
PATCH v3 4/5 splice: Move filemap_read_splice() to mm/filemap.c
In reply to David HowellsMove filemap_read_splice() to mm/filemap.c and make filemap_get_pages() static again.
--- fs/splice.c | 127 ------------------------------------- include/linux/pagemap.h | 2 - include/linux/splice.h | 4 ++ mm/filemap.c | 137 ++++++++++++++++++++++++++++++++++++++-- 4 files changed, 135 insertions(+), 135 deletions(-)
fs/splice.c +0 -127
@@ -375,133 +375,6 @@ static ssize_t direct_splice_read(struct file *in, loff_t *ppos,return ret; } -/* -* Splice subpages from a folio into a pipe. -*/ -static size_t splice_folio_into_pipe (struct pipe_inode_info *pipe, -struct folio *folio, -loff_t fpos,size_t size) -{ -struct page *page; -size_t spliced =0 , offset =offset_in_folio (folio, fpos); - - page =folio_page (folio, offset /PAGE_SIZE ); - size =min (size,folio_size (folio) - offset); - offset %=PAGE_SIZE ; - -while (spliced < size && - !pipe_full (pipe->head, pipe->tail, pipe->max_usage)) { -struct pipe_buffer *buf =pipe_head_buf (pipe); -size_t part =min_t (size_t,PAGE_SIZE - offset, size - spliced); - - *buf = (struct pipe_buffer ) { - .ops = &page_cache_pipe_buf_ops, - .page = page, - .offset = offset, - .len = part, - }; -folio_get (folio); - pipe->head++; - page++; - spliced += part; - offset =0 ; - } - -return spliced; -} - -/* -* Splice folios from the pagecache of a buffered (ie. non-O_DIRECT) file into -* a pipe. -*/ -static ssize_t filemap_splice_read (struct file *in,loff_t *ppos, -struct pipe_inode_info *pipe, -size_t len,unsigned int flags) -{ -struct folio_batch fbatch; -struct kiocb iocb; -size_t total_spliced =0 , used, npages; -loff_t isize, end_offset; -bool writably_mapped; -int i, error =0 ; - -init_sync_kiocb (&iocb, in); - iocb.ki_pos = *ppos; - -/* Work out how much data we can actually add into the pipe */ - used =pipe_occupancy (pipe->head, pipe->tail); - npages =max_t (ssize_t, pipe->max_usage - used,0 ); - len =min_t (size_t, len, npages *PAGE_SIZE ); - -folio_batch_init (&fbatch); - -do { -cond_resched (); - -if (*ppos >=i_size_read (file_inode (in))) -break ; - - iocb.ki_pos = *ppos; - error =filemap_get_pages (&iocb, len, &fbatch, true); -if (error <0 ) -break ; - -/* -* i_size must be checked after we know the pages are Uptodate. -* -* Checking i_size after the check allows us to calculate -* the correct value for "nr", which means the zero-filled -* part of the page is not copied back to userspace (unless -* another truncate extends the file - this is desired though). -*/ - isize =i_size_read (file_inode (in)); -if (unlikely (*ppos >= isize)) -break ; - end_offset =min_t (loff_t, isize, *ppos + len); - -/* -* Once we start copying data, we don't want to be touching any -* cachelines that might be contended: -*/ - writably_mapped =mapping_writably_mapped (in->f_mapping); - -for (i =0 ; i <folio_batch_count (&fbatch); i++) { -struct folio *folio = fbatch.folios[i]; -size_t n; - -if (folio_pos (folio) >= end_offset) - goto out; -folio_mark_accessed (folio); - -/* -* If users can be writing to this folio using arbitrary -* virtual addresses, take care of potential aliasing -* before reading the folio on the kernel side. -*/ -if (writably_mapped) -flush_dcache_folio (folio); - - n =splice_folio_into_pipe (pipe, folio, *ppos, len); -if (!n) - goto out; - len -= n; - total_spliced += n; - *ppos += n; - in->f_ra.prev_pos = *ppos; -if (pipe_full (pipe->head, pipe->tail, pipe->max_usage)) - goto out; - } - -folio_batch_release (&fbatch); - }while (len); - -out: -folio_batch_release (&fbatch); -file_accessed (in); - -return total_spliced ? total_spliced : error; -} -/** * generic_file_splice_read - splice data from file to a pipe * @in: file to splice from
include/linux/pagemap.h +0 -2
@@ -748,8 +748,6 @@ struct page *read_cache_page(struct address_space *, pgoff_t index, filler_t *filler, struct file *file);extern struct page *read_cache_page_gfp (struct address_space *mapping,pgoff_t index,gfp_t gfp_mask); -int filemap_get_pages (struct kiocb *iocb,size_t count, -struct folio_batch *fbatch,bool need_uptodate);static inline struct page *read_mapping_page (struct address_space *mapping,pgoff_t index,struct file *file)
include/linux/splice.h +4 -0
@@ -67,6 +67,10 @@ typedef int (splice_actor)(struct pipe_inode_info *, struct pipe_buffer *,typedef int (splice_direct_actor )(struct pipe_inode_info *,struct splice_desc *); +ssize_t filemap_splice_read (struct file *in,loff_t *ppos, +struct pipe_inode_info *pipe, +size_t len,unsigned int flags); +extern ssize_t splice_from_pipe (struct pipe_inode_info *,struct file *,loff_t *,size_t ,unsigned int ,splice_actor *);
mm/filemap.c +131 -6
155 lines not on this page · raw message
PATCH v3 5/5 shmem, overlayfs, coda, tty, proc, kernfs, random: Fix splice-read
In reply to David HowellsThe new filemap_splice_read() has an implicit expectation via filemap_get_pages() that ->read_folio() exists if ->readahead() doesn't fully populate the pagecache of the file it is reading from[1], potentially leading to a jump to NULL if this doesn't exist.
A filesystem or driver shouldn't suffer from this if:
- It doesn't set ->splice_read()
- It implements ->read_folio()
- It implements its own ->splice_read()
Note that some filesystems set generic_file_splice_read() and generic_file_read_iter() but don't set ->read_folio(). g_f_read_iter() will fall back to filemap_read_iter() which looks like it should suffer from the same issue.
Certain drivers, can just use direct_splice_read() rather than generic_file_splice_read() as that creates an output buffer and then just calls their ->read_iter() function:
- random & urandom
- tty
- kernfs
- proc
- proc_namespace
Stacked filesystems just need to pass the operation down a layer:
- coda
- overlayfs
And finally, there's shmem (used in tmpfs, ramfs, rootfs). This needs its own splice-read implementation, based on filemap_splice_read(), but able to paste in zero_page when there's a page missing.
--- drivers/char/random.c | 4 +- drivers/tty/tty_io.c | 4 +- fs/coda/file.c | 36 +++++++++++- fs/kernfs/file.c | 2 +- fs/overlayfs/file.c | 36 +++++++++++- fs/proc/inode.c | 4 +- fs/proc/proc_sysctl.c | 2 +- fs/proc_namespace.c | 6 +- fs/splice.c | 6 +- include/linux/fs.h | 6 ++ include/linux/splice.h | 4 -- mm/filemap.c | 5 +- mm/internal.h | 6 ++ mm/shmem.c | 124 ++++++++++++++++++++++++++++++++++++++++- 14 files changed, 221 insertions(+), 24 deletions(-)
drivers/char/random.c +2 -2
@@ -1546,7 +1546,7 @@ const struct file_operations random_fops = { .compat_ioctl = compat_ptr_ioctl, .fasync = random_fasync, .llseek = noop_llseek, - .splice_read = generic_file_splice_read, + .splice_read = direct_splice_read, .splice_write = iter_file_splice_write, };
@@ -1557,7 +1557,7 @@ const struct file_operations urandom_fops = { .compat_ioctl = compat_ptr_ioctl, .fasync = random_fasync, .llseek = noop_llseek, - .splice_read = generic_file_splice_read, + .splice_read = direct_splice_read, .splice_write = iter_file_splice_write, };
drivers/tty/tty_io.c +2 -2
@@ -466,7 +466,7 @@ static const struct file_operations tty_fops = { .llseek = no_llseek, .read_iter = tty_read, .write_iter = tty_write, - .splice_read = generic_file_splice_read, + .splice_read = direct_splice_read, .splice_write = iter_file_splice_write, .poll = tty_poll, .unlocked_ioctl = tty_ioctl,
@@ -481,7 +481,7 @@ static const struct file_operations console_fops = { .llseek = no_llseek, .read_iter = tty_read, .write_iter = redirected_tty_write, - .splice_read = generic_file_splice_read, + .splice_read = direct_splice_read, .splice_write = iter_file_splice_write, .poll = tty_poll, .unlocked_ioctl = tty_ioctl,
fs/coda/file.c +35 -1
@@ -23,6 +23,7 @@#include <linux/slab.h> #include <linux/uaccess.h> #include <linux/uio.h> +#include <linux/splice.h> #include <linux/coda.h> #include "coda_psdev.h"
@@ -94,6 +95,39 @@ coda_file_write_iter(struct kiocb *iocb, struct iov_iter *to)return ret; } +static ssize_t +coda_file_splice_read (struct file *coda_file,loff_t *ppos, +struct pipe_inode_info *pipe, +size_t len,unsigned int flags) +{ +struct inode *coda_inode =file_inode (coda_file); +struct coda_file_info *cfi =coda_ftoc (coda_file); +struct file *in = cfi->cfi_container; +loff_t ki_pos = *ppos; +ssize_t ret; + +if (!in->f_op->splice_read) +return -EINVAL ; + + ret =rw_verify_area (READ , in, ppos, len); +if (unlikely (ret <0 )) +return ret; + + ret =venus_access_intent (coda_inode->i_sb,coda_i2f (coda_inode), + &cfi->cfi_access_intent, + len, ki_pos,CODA_ACCESS_TYPE_READ ); +if (ret) + goto finish_read; + + ret = in->f_op->splice_read (in, ppos, pipe, len, flags); + +finish_read: +venus_access_intent (coda_inode->i_sb,coda_i2f (coda_inode), + &cfi->cfi_access_intent, + len, ki_pos,CODA_ACCESS_TYPE_READ_FINISH ); +return ret; +} +static void coda_vm_open (struct vm_area_struct *vma) {
@@ -302,5 +336,5 @@ const struct file_operations coda_file_operations = { .open = coda_open, .release = coda_release, .fsync = coda_fsync, - .splice_read = generic_file_splice_read, + .splice_read = coda_file_splice_read, };
fs/kernfs/file.c +1 -1
@@ -1011,7 +1011,7 @@ const struct file_operations kernfs_file_fops = { .release = kernfs_fop_release, .poll = kernfs_fop_poll, .fsync = noop_fsync, - .splice_read = generic_file_splice_read, + .splice_read = direct_splice_read, .splice_write = iter_file_splice_write, };
fs/overlayfs/file.c +35 -1
@@ -419,6 +419,40 @@ static ssize_t ovl_write_iter(struct kiocb *iocb, struct iov_iter *iter)return ret; } +static ssize_t ovl_splice_read (struct file *in,loff_t *ppos, +struct pipe_inode_info *pipe,size_t len, +unsigned int flags) +{ +const struct cred *old_cred; +struct fd real; +ssize_t ret; + + ret =ovl_real_fdget (in, &real); +if (ret) +return ret; + + ret = -EINVAL ; +if (in->f_flags &O_DIRECT && + !(real.file->f_mode &FMODE_CAN_ODIRECT )) + goto out_fdput; +if (!real.file->f_op->splice_read) + goto out_fdput; + + ret =rw_verify_area (READ , in, ppos, len); +if (unlikely (ret <0 )) +return ret; + + old_cred =ovl_override_creds (file_inode (in)->i_sb); + ret = real.file->f_op->splice_read (real.file, ppos, pipe, len, flags); + +revert_creds (old_cred); +ovl_file_accessed (in); +out_fdput: +fdput (real); + +return ret; +} +/* * Calling iter_file_splice_write() directly from overlay's f_op may deadlock * due to lock order inversion between pipe->mutex in iter_file_splice_write()
@@ -695,7 +729,7 @@ const struct file_operations ovl_file_operations = { .fallocate = ovl_fallocate, .fadvise = ovl_fadvise, .flush = ovl_flush, - .splice_read = generic_file_splice_read, + .splice_read = ovl_splice_read, .splice_write = ovl_splice_write, .copy_file_range = ovl_copy_file_range,
fs/proc/inode.c +2 -2
@@ -591,7 +591,7 @@ static const struct file_operations proc_iter_file_ops = { .llseek = proc_reg_llseek, .read_iter = proc_reg_read_iter, .write = proc_reg_write, - .splice_read = generic_file_splice_read, + .splice_read = direct_splice_read, .poll = proc_reg_poll, .unlocked_ioctl = proc_reg_unlocked_ioctl, .mmap = proc_reg_mmap,
@@ -617,7 +617,7 @@ static const struct file_operations proc_reg_file_ops_compat = {static const struct file_operations proc_iter_file_ops_compat = { .llseek = proc_reg_llseek, .read_iter = proc_reg_read_iter, - .splice_read = generic_file_splice_read, + .splice_read = direct_splice_read, .write = proc_reg_write, .poll = proc_reg_poll, .unlocked_ioctl = proc_reg_unlocked_ioctl,
fs/proc/proc_sysctl.c +1 -1
@@ -869,7 +869,7 @@ static const struct file_operations proc_sys_file_operations = { .poll = proc_sys_poll, .read_iter = proc_sys_read, .write_iter = proc_sys_write, - .splice_read = generic_file_splice_read, + .splice_read = direct_splice_read, .splice_write = iter_file_splice_write, .llseek = default_llseek, };
fs/proc_namespace.c +3 -3
@@ -324,7 +324,7 @@ static int mountstats_open(struct inode *inode, struct file *file)const struct file_operations proc_mounts_operations = { .open = mounts_open, .read_iter = seq_read_iter, - .splice_read = generic_file_splice_read, + .splice_read = direct_splice_read, .llseek = seq_lseek, .release = mounts_release, .poll = mounts_poll,
@@ -333,7 +333,7 @@ const struct file_operations proc_mounts_operations = {const struct file_operations proc_mountinfo_operations = { .open = mountinfo_open, .read_iter = seq_read_iter, - .splice_read = generic_file_splice_read, + .splice_read = direct_splice_read, .llseek = seq_lseek, .release = mounts_release, .poll = mounts_poll,
@@ -342,7 +342,7 @@ const struct file_operations proc_mountinfo_operations = {const struct file_operations proc_mountstats_operations = { .open = mountstats_open, .read_iter = seq_read_iter, - .splice_read = generic_file_splice_read, + .splice_read = direct_splice_read, .llseek = seq_lseek, .release = mounts_release, };
fs/splice.c +3 -3
@@ -287,9 +287,9 @@ void splice_shrink_spd(struct splice_pipe_desc *spd)* Splice data from an O_DIRECT file into pages and then add them to the output * pipe. */ -static ssize_t direct_splice_read (struct file *in,loff_t *ppos, -struct pipe_inode_info *pipe, -size_t len,unsigned int flags) +ssize_t direct_splice_read (struct file *in,loff_t *ppos, +struct pipe_inode_info *pipe, +size_t len,unsigned int flags) {struct iov_iter to;struct bio_vec *bv;
include/linux/fs.h +6 -0
@@ -3163,6 +3163,12 @@ ssize_t vfs_iocb_iter_write(struct file *file, struct kiocb *iocb, struct iov_iter *iter);/* fs/splice.c */ +ssize_t filemap_splice_read (struct file *in,loff_t *ppos, +struct pipe_inode_info *pipe, +size_t len,unsigned int flags); +ssize_t direct_splice_read (struct file *in,loff_t *ppos, +struct pipe_inode_info *pipe, +size_t len,unsigned int flags);extern ssize_t generic_file_splice_read (struct file *,loff_t *,struct pipe_inode_info *,size_t ,unsigned int ); extern ssize_t iter_file_splice_write(struct pipe_inode_info *,
include/linux/splice.h +0 -4
@@ -67,10 +67,6 @@ typedef int (splice_actor)(struct pipe_inode_info *, struct pipe_buffer *,typedef int (splice_direct_actor )(struct pipe_inode_info *,struct splice_desc *); -ssize_t filemap_splice_read (struct file *in,loff_t *ppos, -struct pipe_inode_info *pipe, -size_t len,unsigned int flags); -extern ssize_t splice_from_pipe (struct pipe_inode_info *,struct file *,loff_t *,size_t ,unsigned int ,splice_actor *);
mm/filemap.c +2 -3
@@ -2846,9 +2846,8 @@ EXPORT_SYMBOL(generic_file_read_iter);/* * Splice subpages from a folio into a pipe. */ -static size_t splice_folio_into_pipe (struct pipe_inode_info *pipe, -struct folio *folio, -loff_t fpos,size_t size) +size_t splice_folio_into_pipe (struct pipe_inode_info *pipe, +struct folio *folio,loff_t fpos,size_t size) {struct page *page;size_t spliced =0 , offset =offset_in_folio (folio, fpos);
mm/internal.h +6 -0
@@ -794,6 +794,12 @@ struct migration_target_control {gfp_t gfp_mask; }; +/* +* mm/filemap.c +*/ +size_t splice_folio_into_pipe (struct pipe_inode_info *pipe, +struct folio *folio,loff_t fpos,size_t size); +/* * mm/vmalloc.c */
mm/shmem.c +123 -1
136 lines not on this page · raw message
Re: [PATCH v3 5/5] shmem, overlayfs, coda, tty, proc, kernfs, random: Fix splice-read
Quoted 57 lines · David Howells
The new
filemap_splice_read()has an implicit expectation viafilemap_get_pages()that ->read_folio() exists if ->readahead() doesn't fully populate the pagecache of the file it is reading from[1], potentially leading to a jump to NULL if this doesn't exist.A filesystem or driver shouldn't suffer from this if:
- It doesn't set ->splice_read()
- It implements ->read_folio()
- It implements its own ->splice_read()Note that some filesystems set
generic_file_splice_read()andgeneric_file_read_iter()but don't set ->read_folio().g_f_read_iter()will fall back tofilemap_read_iter()which looks like it should suffer from the same issue.Certain drivers, can just use
direct_splice_read()rather thangeneric_file_splice_read()as that creates an output buffer and then just calls their ->read_iter() function:- random & urandom
- tty
- kernfs
- proc
-proc_namespaceStacked filesystems just need to pass the operation down a layer:
- coda
- overlayfsAnd finally, there's shmem (used in tmpfs, ramfs, rootfs). This needs its own splice-read implementation, based on
filemap_splice_read(), but able to paste inzero_pagewhen there's a page missing.Fixes d9722a475711 ("splice: Do splice read from a buffered file without using ITER_PIPE")Signed-off-by David Howells <[email protected]>cc Daniel Golle <[email protected]>cc Guenter Roeck <[email protected]>cc Christoph Hellwig <[email protected]>cc Jens Axboe <[email protected]>cc Al Viro <[email protected]>cc John Hubbard <[email protected]>cc David Hildenbrand <[email protected]>cc Matthew Wilcox <[email protected]>cc Miklos Szeredi <[email protected]>cc Hugh Dickins <[email protected]>cc Jan Harkes <[email protected]>cc Arnd Bergmann <[email protected]>cc Greg Kroah-Hartman <[email protected]>
Quoted 1 line
---
Daniel Golle
Tested-byRe: [PATCH v3 5/5] shmem, overlayfs, coda, tty, proc, kernfs, random: Fix splice-read
Quoted 60 lines · Greg Kroah-Hartman
Quoted 57 lines · David Howells
The new
filemap_splice_read()has an implicit expectation viafilemap_get_pages()that ->read_folio() exists if ->readahead() doesn't fully populate the pagecache of the file it is reading from[1], potentially leading to a jump to NULL if this doesn't exist.A filesystem or driver shouldn't suffer from this if:
- It doesn't set ->splice_read()
- It implements ->read_folio()
- It implements its own ->splice_read()Note that some filesystems set
generic_file_splice_read()andgeneric_file_read_iter()but don't set ->read_folio().g_f_read_iter()will fall back tofilemap_read_iter()which looks like it should suffer from the same issue.Certain drivers, can just use
direct_splice_read()rather thangeneric_file_splice_read()as that creates an output buffer and then just calls their ->read_iter() function:- random & urandom
- tty
- kernfs
- proc
-proc_namespaceStacked filesystems just need to pass the operation down a layer:
- coda
- overlayfsAnd finally, there's shmem (used in tmpfs, ramfs, rootfs). This needs its own splice-read implementation, based on
filemap_splice_read(), but able to paste inzero_pagewhen there's a page missing.Fixes d9722a475711 ("splice: Do splice read from a buffered file without using ITER_PIPE")Signed-off-by David Howells <[email protected]>cc Daniel Golle <[email protected]>cc Guenter Roeck <[email protected]>cc Christoph Hellwig <[email protected]>cc Jens Axboe <[email protected]>cc Al Viro <[email protected]>cc John Hubbard <[email protected]>cc David Hildenbrand <[email protected]>cc Matthew Wilcox <[email protected]>cc Miklos Szeredi <[email protected]>cc Hugh Dickins <[email protected]>cc Jan Harkes <[email protected]>cc Arnd Bergmann <[email protected]>cc Greg Kroah-Hartman <[email protected]>Quoted 1 line
---
Quoted 1 line
Confirming that the above indeed fixes the NULL pointer bug.
Miklos Szeredi
maintainerRe: [PATCH v3 5/5] shmem, overlayfs, coda, tty, proc, kernfs, random: Fix splice-read
In reply to David HowellsQuoted 29 lines · David Howells
The new
filemap_splice_read()has an implicit expectation viafilemap_get_pages()that ->read_folio() exists if ->readahead() doesn't fully populate the pagecache of the file it is reading from[1], potentially leading to a jump to NULL if this doesn't exist.A filesystem or driver shouldn't suffer from this if:
- It doesn't set ->splice_read()
- It implements ->read_folio()
- It implements its own ->splice_read()Note that some filesystems set
generic_file_splice_read()andgeneric_file_read_iter()but don't set ->read_folio().g_f_read_iter()will fall back tofilemap_read_iter()which looks like it should suffer from the same issue.Certain drivers, can just use
direct_splice_read()rather thangeneric_file_splice_read()as that creates an output buffer and then just calls their ->read_iter() function:- random & urandom
- tty
- kernfs
- proc
-proc_namespaceStacked filesystems just need to pass the operation down a layer:
Quoted 8 lines
- coda
- overlayfsAnd finally, there's shmem (used in tmpfs, ramfs, rootfs). This needs its own splice-read implementation, based on
filemap_splice_read(), but able to paste inzero_pagewhen there's a page missing.Fixes d9722a475711 ("splice: Do splice read from a buffered file without using ITER_PIPE")
The fixed commit is not upstream. In fact it seems to be on the same branch as this one. Please reorder the patches so that a Fixes tag is not needed.
Thanks,
Miklos
Quoted 45 lines · David Howells
Hi Jens, Al, Christoph,
Here are patches to make some changes that Christoph requested[1] to the new generic file splice functions that I implemented[2]. Apart from one functional change, they just altering the styling and move one of the functions to a different file:
(1) Rename the main functions:
generic_file_buffered_splice_read() -> filemap_splice_read() generic_file_direct_splice_read() -> direct_splice_read()(2) Abstract out the calculation of the location of the head pipe buffer into a helper function in
linux/pipe_fs_i.h.(3) Use
init_sync_kiocb()infilemap_splice_read().This is where the functional change is. Some kiocb fields are then filled in where they were set to 0 before, including setting
ki_flagsfromf_iocb_flags.(4) Move
filemap_splice_read()tomm/filemap.c.filemap_get_pages()can then be made static again.(5) Fix splice-read for a number of filesystems that don't provide a
->read_folio() op and for which filemap_get_pages() cannot be used.I've pushed the patches here also:
https://git.kernel.org/pub/scm/linux/kernel/git/dhowells/linux-fs.git/log/?h=iov-extract-3
I've also updated worked the changes into the commits on my iov-extract branch if that would be preferable, though that means Jens would need to update his for-6.3/iov-extract again.
David
Changes
=======
ver #3)
- Fix filesystems/drivers that don't have ->read_folio().
Quoted 5 lines
ver #2)
- Don't attempt to filter IOCB_* flags infilemap_splice_read().
You ignored my RB's :(
.. but unrelated, what's the plan with this now? As Jens mentioned, it might be better to wait for 6.4 for the full series, in which case folding this series into the other series would be better.
Signature · 3 lines
Thanks, David / dhildenb
Jens Axboe
maintainerQuoted 49 lines · David Hildenbrand
Quoted 48 lines · David Howells
Hi Jens, Al, Christoph,
Here are patches to make some changes that Christoph requested[1] to the new generic file splice functions that I implemented[2]. Apart from one functional change, they just altering the styling and move one of the functions to a different file:
(1) Rename the main functions:
generic_file_buffered_splice_read() -> filemap_splice_read() generic_file_direct_splice_read() -> direct_splice_read()(2) Abstract out the calculation of the location of the head pipe buffer into a helper function in
linux/pipe_fs_i.h.(3) Use
init_sync_kiocb()infilemap_splice_read().This is where the functional change is. Some kiocb fields are then filled in where they were set to 0 before, including setting
ki_flagsfromf_iocb_flags.(4) Move
filemap_splice_read()tomm/filemap.c.filemap_get_pages()can then be made static again.(5) Fix splice-read for a number of filesystems that don't provide a
->read_folio() op and for which filemap_get_pages() cannot be used.I've pushed the patches here also:
https://git.kernel.org/pub/scm/linux/kernel/git/dhowells/linux-fs.git/log/?h=iov-extract-3
I've also updated worked the changes into the commits on my iov-extract branch if that would be preferable, though that means Jens would need to update his for-6.3/iov-extract again.
David
Changes
=======
ver #3)
- Fix filesystems/drivers that don't have ->read_folio().ver #2)
- Don't attempt to filter IOCB_* flags infilemap_splice_read().
Quoted 8 lines
Quoted 2 lines
You ignored my RB's :(
.. but unrelated, what's the plan with this now? As Jens mentioned, it might be better to wait for 6.4 for the full series, in which case folding this series into the other series would be better.
That is indeed the question, and unanswered so far... Let's turn it into one clean series, and get it stuffed into for-next and most likely target 6.4 for inclusion at this point.
Signature · 1 line
Jens Axboe
Quoted 3 lines · Jens Axboe
That is indeed the question, and unanswered so far... Let's turn it into one clean series, and get it stuffed into for-next and most likely target 6.4 for inclusion at this point.
I was waiting to see if the patch worked for Daniel (which it does) and Guenter (no answer yet) before answering. It appears to fix shmem - I've tested it with:
dd if=/dev/zero of=/tmp/sparse count=1 seek=401 bs=4096 just-splice /tmp/sparse 11234000 | sha1sum
where just-splice.c is attached (note that piping the output into another program is important to make the splice work).
Meanwhile, I'm working on working the changes into my patchset at appropriate points.
David
---
#define _GNU_SOURCE
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <fcntl.h>
#include <sys/sendfile.h>
#include <sys/wait.h>
static char *prog;
int main(int argc, char *argv[])
{
unsigned int iflags = 0;
ssize_t spliced, remain;
int in, out;
prog = argv[0];
if (argc > 1 && strcmp(argv[1], "-d") == 0) {
iflags |= O_DIRECT;
argv++;
argc--;
}
if (argc != 3 || !argv[1][0] || !argv[2][0]) {
fprintf(stderr, "Usage: %s <file> <amount>\n", prog);
exit(2);
}
in = open(argv[1], O_RDONLY | O_NOFOLLOW | iflags);
if (in < 0) {
perror("open");
exit(1);
}
remain = strtoul(argv[2], NULL, 0);
while (remain > 0) {
spliced = splice(in, NULL, 1, NULL, remain, 0);
if (spliced < 0) {
perror("splice");
exit(1);
}
if (spliced == 0)
break;
remain -= spliced;
}
exit(0);
}