Commit dc892f73 authored by Steven Rostedt's avatar Steven Rostedt Committed by Steven Rostedt
Browse files

ring-buffer: remove ring_buffer_event_discard 



The function ring_buffer_event_discard can be used on any item in the
ring buffer, even after the item was committed. This function provides
no safety nets and is very race prone.

An item may be safely removed from the ring buffer before it is committed
with the ring_buffer_discard_commit.

Since there are currently no users of this function, and because this
function is racey and error prone, this patch removes it altogether.

Note, removing this function also allows the counters to ignore
all discarded events (patches will follow).

Signed-off-by: default avatarSteven Rostedt <rostedt@goodmis.org>
parent 7e9391cf

include/linux/ring_buffer.h

+0 −14
Original line number Diff line number Diff line
@@ -74,20 +74,6 @@ ring_buffer_event_time_delta(struct ring_buffer_event *event) 
	return event->time_delta;

}



/*

 * ring_buffer_event_discard can discard any event in the ring buffer.

 *   it is up to the caller to protect against a reader from

 *   consuming it or a writer from wrapping and replacing it.

 *

 * No external protection is needed if this is called before

 * the event is commited. But in that case it would be better to

 * use ring_buffer_discard_commit.

 *

 * Note, if an event that has not been committed is discarded

 * with ring_buffer_event_discard, it must still be committed.

 */

void ring_buffer_event_discard(struct ring_buffer_event *event);



/*

 * ring_buffer_discard_commit will remove an event that has not

 *   ben committed yet. If this is used, then ring_buffer_unlock_commit

kernel/trace/ring_buffer.c

+6 −21
Original line number Diff line number Diff line
@@ -2327,32 +2327,17 @@ static inline void rb_event_discard(struct ring_buffer_event *event) 
		event->time_delta = 1;

}



/**

 * ring_buffer_event_discard - discard any event in the ring buffer

 * @event: the event to discard

 *

 * Sometimes a event that is in the ring buffer needs to be ignored.

 * This function lets the user discard an event in the ring buffer

 * and then that event will not be read later.

 *

 * Note, it is up to the user to be careful with this, and protect

 * against races. If the user discards an event that has been consumed

 * it is possible that it could corrupt the ring buffer.

 */

void ring_buffer_event_discard(struct ring_buffer_event *event)

{

	rb_event_discard(event);

}

EXPORT_SYMBOL_GPL(ring_buffer_event_discard);



/**

 * ring_buffer_commit_discard - discard an event that has not been committed

 * @buffer: the ring buffer

 * @event: non committed event to discard

 *

 * This is similar to ring_buffer_event_discard but must only be

 * performed on an event that has not been committed yet. The difference

 * is that this will also try to free the event from the ring buffer

 * Sometimes an event that is in the ring buffer needs to be ignored.

 * This function lets the user discard an event in the ring buffer

 * and then that event will not be read later.

 *

 * This function only works if it is called before the the item has been

 * committed. It will try to free the event from the ring buffer

 * if another event has not been added behind it.

 *

 * If another event has been added behind it, it will set the event

CRA Git | Maintained and supported by SUSTech CRA and CCSE