tracing: Fix buffer_ref pipe ops
PATCH 1/1 tracing: Fix buffer_ref pipe ops
This fixes multiple issues in buffer_pipe_buf_ops:
- The ->steal() handler must not return zero unless the pipe buffer has the only reference to the page. But generic_pipe_buf_steal() assumes that every reference to the pipe is tracked by the page's refcount, which isn't true for these buffers - buffer_pipe_buf_get(), which duplicates a buffer, doesn't touch the page's refcount.
Fix it by using generic_pipe_buf_nosteal(), which refuses every attempted theft. It should be easy to actually support ->steal, but the only current users of pipe_buf_steal() are the virtio console and FUSE, and they also only use it as an optimization. So it's probably not worth the effort.
- The ->get() and ->release() handlers can be invoked concurrently on pipe buffers backed by the same struct buffer_ref. Make them safe against concurrency by using refcount_t.
- The pointers stored in ->private were only zeroed out when the last reference to the buffer_ref was dropped. As far as I know, this shouldn't be necessary anyway, but if we do it, let's always do it.
---
Completely untested (apart from compiling it). I don't really know anything about how the tracing subsystem works.
fs/splice.c | 4 ++-- include/linux/pipe_fs_i.h | 1 + kernel/trace/trace.c | 28 ++++++++++++++-------------- 3 files changed, 17 insertions(+), 16 deletions(-)
fs/splice.c +2 -2
@@ -330,8 +330,8 @@ const struct pipe_buf_operations default_pipe_buf_ops = { .get = generic_pipe_buf_get, }; -static int generic_pipe_buf_nosteal (struct pipe_inode_info *pipe, -struct pipe_buffer *buf) +int generic_pipe_buf_nosteal (struct pipe_inode_info *pipe, +struct pipe_buffer *buf) {return 1 ; }
include/linux/pipe_fs_i.h +1 -0
@@ -174,6 +174,7 @@ void free_pipe_info(struct pipe_inode_info *);void generic_pipe_buf_get (struct pipe_inode_info *,struct pipe_buffer *);int generic_pipe_buf_confirm (struct pipe_inode_info *,struct pipe_buffer *);int generic_pipe_buf_steal (struct pipe_inode_info *,struct pipe_buffer *); +int generic_pipe_buf_nosteal (struct pipe_inode_info *,struct pipe_buffer *);void generic_pipe_buf_release (struct pipe_inode_info *,struct pipe_buffer *);void pipe_buf_mark_unmergeable (struct pipe_buffer *buf);
kernel/trace/trace.c +14 -14
@@ -7025,19 +7025,23 @@ struct buffer_ref {struct ring_buffer *buffer;void *page;int cpu; -int ref; +refcount_t refcount; }; +static void buffer_ref_release (struct buffer_ref *ref) +{ +if (!refcount_dec_and_test (&ref->refcount)) +return ; +ring_buffer_free_read_page (ref->buffer, ref->cpu, ref->page); +kfree (ref); +} +static void buffer_pipe_buf_release (struct pipe_inode_info *pipe,struct pipe_buffer *buf) {struct buffer_ref *ref = (struct buffer_ref *)buf->private; -if (--ref->ref) -return ; - -ring_buffer_free_read_page (ref->buffer, ref->cpu, ref->page); -kfree (ref); +buffer_ref_release (ref); buf->private =0 ; }
@@ -7046,14 +7050,14 @@ static void buffer_pipe_buf_get(struct pipe_inode_info *pipe, {struct buffer_ref *ref = (struct buffer_ref *)buf->private; - ref->ref++; +refcount_inc (&ref->refcount); }/* Pipe buffer operations for a buffer. */ static const struct pipe_buf_operations buffer_pipe_buf_ops = { .confirm = generic_pipe_buf_confirm, .release = buffer_pipe_buf_release, - .steal = generic_pipe_buf_steal, + .steal = generic_pipe_buf_nosteal, .get = buffer_pipe_buf_get, };
@@ -7066,11 +7070,7 @@ static void buffer_spd_release(struct splice_pipe_desc *spd, unsigned int i)struct buffer_ref *ref = (struct buffer_ref *)spd->partial[i].private; -if (--ref->ref) -return ; - -ring_buffer_free_read_page (ref->buffer, ref->cpu, ref->page); -kfree (ref); +buffer_ref_release (ref); spd->partial[i].private =0 ; }
@@ -7125,7 +7125,7 @@ tracing_buffers_splice_read(struct file *file, loff_t *ppos,break ; } - ref->ref =1 ; +refcount_set (&ref->refcount,1 ); ref->buffer = iter->trace_buffer->buffer; ref->page =ring_buffer_alloc_read_page (ref->buffer, iter->cpu_file);if (IS_ERR (ref->page)) {
Signature · 1 line
2.21.0.392.gf8f6787159e-goog
Steven Rostedt
maintainerQuoted 18 lines · On Thu, 4 Apr 2019 23:59:25 +0200 Jann Horn <[email protected]> wrote:
This fixes multiple issues in
buffer_pipe_buf_ops:- The ->steal() handler must not return zero unless the pipe buffer has the only reference to the page. But
generic_pipe_buf_steal()assumes that every reference to the pipe is tracked by the page's refcount, which isn't true for these buffers -buffer_pipe_buf_get(), which duplicates a buffer, doesn't touch the page's refcount.
Fix it by usinggeneric_pipe_buf_nosteal(), which refuses every attempted theft. It should be easy to actually support ->steal, but the only current users ofpipe_buf_steal()are the virtio console and FUSE, and they also only use it as an optimization. So it's probably not worth the effort.
- The ->get() and ->release() handlers can be invoked concurrently on pipe buffers backed by the same structbuffer_ref. Make them safe against concurrency by usingrefcount_t.
- The pointers stored in ->private were only zeroed out when the last reference to thebuffer_refwas dropped. As far as I know, this shouldn't be necessary anyway, but if we do it, let's always do it.
Honestly, the entire implementation of the splice code for me was very confusing. Not much documentation on it, so I just looked at what others did and tried my best to copy them, bugs and all ;-)
Quoted 6 lines
Cc [email protected] # v4.11Signed-off-by Jann Horn <[email protected]>---
Completely untested (apart from compiling it). I don't really know anything about how the tracing subsystem works.
I applied this and ran it through my suite of trace-cmd tests which uses the splice code quite heavily, and it didn't trigger any bugs.
I don't see anything wrong with this patch, so I'll pull it and run it through the rest of my tests.
Thanks!
-- Steve
Quoted 106 lines
fs/splice.c | 4 ++-- include/linux/pipe_fs_i.h | 1 + kernel/trace/trace.c | 28 ++++++++++++++-------------- 3 files changed, 17 insertions(+), 16 deletions(-)fs/splice.c +2
-2@@ -330,8 +330,8 @@ const struct pipe_buf_operations default_pipe_buf_ops = { .get = generic_pipe_buf_get, }; -static int generic_pipe_buf_nosteal (struct pipe_inode_info *pipe, -struct pipe_buffer *buf) +int generic_pipe_buf_nosteal (struct pipe_inode_info *pipe, +struct pipe_buffer *buf) {return 1 ; }include/linux/pipe_fs_i.h +1
-0@@ -174,6 +174,7 @@ void free_pipe_info(struct pipe_inode_info *);void generic_pipe_buf_get (struct pipe_inode_info *,struct pipe_buffer *);int generic_pipe_buf_confirm (struct pipe_inode_info *,struct pipe_buffer *);int generic_pipe_buf_steal (struct pipe_inode_info *,struct pipe_buffer *); +int generic_pipe_buf_nosteal (struct pipe_inode_info *,struct pipe_buffer *);void generic_pipe_buf_release (struct pipe_inode_info *,struct pipe_buffer *);void pipe_buf_mark_unmergeable (struct pipe_buffer *buf);kernel/trace/trace.c +14
-14@@ -7025,19 +7025,23 @@ struct buffer_ref {struct ring_buffer *buffer;void *page;int cpu; -int ref; +refcount_t refcount; }; +static void buffer_ref_release (struct buffer_ref *ref) +{ +if (!refcount_dec_and_test (&ref->refcount)) +return ; +ring_buffer_free_read_page (ref->buffer, ref->cpu, ref->page); +kfree (ref); +} +static void buffer_pipe_buf_release (struct pipe_inode_info *pipe,struct pipe_buffer *buf) {struct buffer_ref *ref = (struct buffer_ref *)buf->private; -if (--ref->ref) -return ; - -ring_buffer_free_read_page (ref->buffer, ref->cpu, ref->page); -kfree (ref); +buffer_ref_release (ref); buf->private =0 ; }@@ -7046,14 +7050,14 @@ static void buffer_pipe_buf_get(struct pipe_inode_info *pipe, {struct buffer_ref *ref = (struct buffer_ref *)buf->private; - ref->ref++; +refcount_inc (&ref->refcount); }/* Pipe buffer operations for a buffer. */ static const struct pipe_buf_operations buffer_pipe_buf_ops = { .confirm = generic_pipe_buf_confirm, .release = buffer_pipe_buf_release, - .steal = generic_pipe_buf_steal, + .steal = generic_pipe_buf_nosteal, .get = buffer_pipe_buf_get, };@@ -7066,11 +7070,7 @@ static void buffer_spd_release(struct splice_pipe_desc *spd, unsigned int i)struct buffer_ref *ref = (struct buffer_ref *)spd->partial[i].private; -if (--ref->ref) -return ; - -ring_buffer_free_read_page (ref->buffer, ref->cpu, ref->page); -kfree (ref); +buffer_ref_release (ref); spd->partial[i].private =0 ; }@@ -7125,7 +7125,7 @@ tracing_buffers_splice_read(struct file *file, loff_t *ppos,break ; } - ref->ref =1 ; +refcount_set (&ref->refcount,1 ); ref->buffer = iter->trace_buffer->buffer; ref->page =ring_buffer_alloc_read_page (ref->buffer, iter->cpu_file);if (IS_ERR (ref->page)) {
Steven Rostedt
maintainerQuoted 2 lines · On Fri, 5 Apr 2019 11:18:55 -0400 Steven Rostedt <[email protected]> wrote:
Quoted 2 lines
Cc [email protected] # v4.11
Instead of saying 4.11, can you specify the exact commit that this fixes? Most of the splice code goes back to 3.7 or ever further.
Thanks!
-- Steve