Commit bc1a72af authored by Steven Rostedt (VMware)'s avatar Steven Rostedt (VMware)
Browse files

ring-buffer: Rename ring_buffer_read() to read_buffer_iter_advance() 

When the ring buffer was first created, the iterator followed the normal
producer/consumer operations where it had both a peek() operation, that just
returned the event at the current location, and a read(), that would return
the event at the current location and also increment the iterator such that
the next peek() or read() will return the next event.

The only use of the ring_buffer_read() is currently to move the iterator to
the next location and nothing now actually reads the event it returns.
Rename this function to its actual use case to ring_buffer_iter_advance(),
which also adds the "iter" part to the name, which is more meaningful. As
the timestamp returned by ring_buffer_read() was never used, there's no
reason that this new version should bother having returning it. It will also
become a void function.

Link: http://lkml.kernel.org/r/20200317213416.018928618@goodmis.org



Signed-off-by: default avatarSteven Rostedt (VMware) <rostedt@goodmis.org>
parent ead6ecfd

include/linux/ring_buffer.h

+1 −2
Original line number Diff line number Diff line
@@ -135,8 +135,7 @@ void ring_buffer_read_finish(struct ring_buffer_iter *iter); 


struct ring_buffer_event *

ring_buffer_iter_peek(struct ring_buffer_iter *iter, u64 *ts);

struct ring_buffer_event *

ring_buffer_read(struct ring_buffer_iter *iter, u64 *ts);

void ring_buffer_iter_advance(struct ring_buffer_iter *iter);

void ring_buffer_iter_reset(struct ring_buffer_iter *iter);

int ring_buffer_iter_empty(struct ring_buffer_iter *iter);

kernel/trace/ring_buffer.c

+6 −17
Original line number Diff line number Diff line
@@ -4318,35 +4318,24 @@ ring_buffer_read_finish(struct ring_buffer_iter *iter) 
EXPORT_SYMBOL_GPL(ring_buffer_read_finish);



/**

 * ring_buffer_read - read the next item in the ring buffer by the iterator

 * ring_buffer_iter_advance - advance the iterator to the next location

 * @iter: The ring buffer iterator

 * @ts: The time stamp of the event read.

 *

 * This reads the next event in the ring buffer and increments the iterator.

 * Move the location of the iterator such that the next read will

 * be the next location of the iterator.

 */

struct ring_buffer_event *

ring_buffer_read(struct ring_buffer_iter *iter, u64 *ts)

void ring_buffer_iter_advance(struct ring_buffer_iter *iter)

{

	struct ring_buffer_event *event;

	struct ring_buffer_per_cpu *cpu_buffer = iter->cpu_buffer;

	unsigned long flags;



	raw_spin_lock_irqsave(&cpu_buffer->reader_lock, flags);

 again:

	event = rb_iter_peek(iter, ts);

	if (!event)

		goto out;



	if (event->type_len == RINGBUF_TYPE_PADDING)

		goto again;



	rb_advance_iter(iter);

 out:

	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);



	return event;

	raw_spin_unlock_irqrestore(&cpu_buffer->reader_lock, flags);

}

EXPORT_SYMBOL_GPL(ring_buffer_read);

EXPORT_SYMBOL_GPL(ring_buffer_iter_advance);



/**

 * ring_buffer_size - return the size of the ring buffer (in bytes)

kernel/trace/trace.c

+2 −2
Original line number Diff line number Diff line
@@ -3378,7 +3378,7 @@ static void trace_iterator_increment(struct trace_iterator *iter) 


	iter->idx++;

	if (buf_iter)

		ring_buffer_read(buf_iter, NULL);

		ring_buffer_iter_advance(buf_iter);

}



static struct trace_entry *
@@ -3562,7 +3562,7 @@ void tracing_iter_reset(struct trace_iterator *iter, int cpu) 
		if (ts >= iter->array_buffer->time_start)

			break;

		entries++;

		ring_buffer_read(buf_iter, NULL);

		ring_buffer_iter_advance(buf_iter);

	}



	per_cpu_ptr(iter->array_buffer->data, cpu)->skipped_entries = entries;

kernel/trace/trace_functions_graph.c

+1 −1
Original line number Diff line number Diff line
@@ -482,7 +482,7 @@ get_return_for_leaf(struct trace_iterator *iter, 


	/* this is a leaf, now advance the iterator */

	if (ring_iter)

		ring_buffer_read(ring_iter, NULL);

		ring_buffer_iter_advance(ring_iter);



	return next;

}

CRA Git | Maintained and supported by SUSTech CRA and CCSE