include/linux/ring_buffer.h

1 /* SPDX-License-Identifier: GPL-2.0 */
24  * enum ring_buffer_type - internal ring buffer types
29  *				  size is variable depending on how much
33  *				  size = 4 + length (bytes)
37  *				 size = 8 bytes
44  *				 size = 8 bytes
51  *				  size = 4 + length (bytes)
54  *				  array[0..(length+3)/4-1] holds data
55  *				  size = 4 + length (bytes)
66 u64 ring_buffer_event_time_stamp(struct trace_buffer *buffer,
73  *   will try to remove the event from the ring buffer completely
79  *    ring_buffer_discard_commit(buffer, event);
81  *    ring_buffer_unlock_commit(buffer, event);
83 void ring_buffer_discard_commit(struct trace_buffer *buffer,
87  * size is in bytes for each per CPU buffer.
90 __ring_buffer_alloc(unsigned long size, unsigned flags, struct lock_class_key *key);
92 struct trace_buffer *__ring_buffer_alloc_range(unsigned long size, unsigned flags,
97 bool ring_buffer_last_boot_delta(struct trace_buffer *buffer, long *text,
101  * Because the ring buffer is generic, if other users of the ring buffer get
103  * ring buffer's lock class separate.
105 #define ring_buffer_alloc(size, flags)			\  argument
108 	__ring_buffer_alloc((size), (flags), &__key);	\
112  * Because the ring buffer is generic, if other users of the ring buffer get
114  * ring buffer's lock class separate.
116 #define ring_buffer_alloc_range(size, flags, order, start, range_size)	\  argument
119 	__ring_buffer_alloc_range((size), (flags), (order), (start),	\
124 int ring_buffer_wait(struct trace_buffer *buffer, int cpu, int full,
126 __poll_t ring_buffer_poll_wait(struct trace_buffer *buffer, int cpu,
128 void ring_buffer_wake_waiters(struct trace_buffer *buffer, int cpu);
130 #define RING_BUFFER_ALL_CPUS -1
132 void ring_buffer_free(struct trace_buffer *buffer);
134 int ring_buffer_resize(struct trace_buffer *buffer, unsigned long size, int cpu);
136 void ring_buffer_change_overwrite(struct trace_buffer *buffer, int val);
138 struct ring_buffer_event *ring_buffer_lock_reserve(struct trace_buffer *buffer,
140 int ring_buffer_unlock_commit(struct trace_buffer *buffer);
141 int ring_buffer_write(struct trace_buffer *buffer,
144 void ring_buffer_nest_start(struct trace_buffer *buffer);
145 void ring_buffer_nest_end(struct trace_buffer *buffer);
148 ring_buffer_peek(struct trace_buffer *buffer, int cpu, u64 *ts,
151 ring_buffer_consume(struct trace_buffer *buffer, int cpu, u64 *ts,
155 ring_buffer_read_prepare(struct trace_buffer *buffer, int cpu, gfp_t flags);
167 unsigned long ring_buffer_size(struct trace_buffer *buffer, int cpu);
168 unsigned long ring_buffer_max_event_size(struct trace_buffer *buffer);
170 void ring_buffer_reset_cpu(struct trace_buffer *buffer, int cpu);
171 void ring_buffer_reset_online_cpus(struct trace_buffer *buffer);
172 void ring_buffer_reset(struct trace_buffer *buffer);
182 	return -ENODEV;  in ring_buffer_swap_cpu()
186 bool ring_buffer_empty(struct trace_buffer *buffer);
187 bool ring_buffer_empty_cpu(struct trace_buffer *buffer, int cpu);
189 void ring_buffer_record_disable(struct trace_buffer *buffer);
190 void ring_buffer_record_enable(struct trace_buffer *buffer);
191 void ring_buffer_record_off(struct trace_buffer *buffer);
192 void ring_buffer_record_on(struct trace_buffer *buffer);
193 bool ring_buffer_record_is_on(struct trace_buffer *buffer);
194 bool ring_buffer_record_is_set_on(struct trace_buffer *buffer);
195 void ring_buffer_record_disable_cpu(struct trace_buffer *buffer, int cpu);
196 void ring_buffer_record_enable_cpu(struct trace_buffer *buffer, int cpu);
198 u64 ring_buffer_oldest_event_ts(struct trace_buffer *buffer, int cpu);
199 unsigned long ring_buffer_bytes_cpu(struct trace_buffer *buffer, int cpu);
200 unsigned long ring_buffer_entries(struct trace_buffer *buffer);
201 unsigned long ring_buffer_overruns(struct trace_buffer *buffer);
202 unsigned long ring_buffer_entries_cpu(struct trace_buffer *buffer, int cpu);
203 unsigned long ring_buffer_overrun_cpu(struct trace_buffer *buffer, int cpu);
204 unsigned long ring_buffer_commit_overrun_cpu(struct trace_buffer *buffer, int cpu);
205 unsigned long ring_buffer_dropped_events_cpu(struct trace_buffer *buffer, int cpu);
206 unsigned long ring_buffer_read_events_cpu(struct trace_buffer *buffer, int cpu);
208 u64 ring_buffer_time_stamp(struct trace_buffer *buffer);
209 void ring_buffer_normalize_time_stamp(struct trace_buffer *buffer,
211 void ring_buffer_set_clock(struct trace_buffer *buffer,
213 void ring_buffer_set_time_stamp_abs(struct trace_buffer *buffer, bool abs);
214 bool ring_buffer_time_stamp_abs(struct trace_buffer *buffer);
216 size_t ring_buffer_nr_dirty_pages(struct trace_buffer *buffer, int cpu);
220 ring_buffer_alloc_read_page(struct trace_buffer *buffer, int cpu);
221 void ring_buffer_free_read_page(struct trace_buffer *buffer, int cpu,
223 int ring_buffer_read_page(struct trace_buffer *buffer,
231 int ring_buffer_print_page_header(struct trace_buffer *buffer, struct trace_seq *s);
233 int ring_buffer_subbuf_order_get(struct trace_buffer *buffer);
234 int ring_buffer_subbuf_order_set(struct trace_buffer *buffer, int order);
235 int ring_buffer_subbuf_size_get(struct trace_buffer *buffer);
247 int ring_buffer_map(struct trace_buffer *buffer, int cpu,
249 int ring_buffer_unmap(struct trace_buffer *buffer, int cpu);
250 int ring_buffer_map_get_reader(struct trace_buffer *buffer, int cpu);