1 #ifndef _LTTNG_RING_BUFFER_FRONTEND_API_H
2 #define _LTTNG_RING_BUFFER_FRONTEND_API_H
5 * libringbuffer/frontend_api.h
7 * Copyright (C) 2005-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; only
12 * version 2.1 of the License.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 * Ring Buffer Library Synchronization Header (buffer write API).
26 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
28 * See ring_buffer_frontend.c for more information on wait-free
30 * See frontend.h for channel allocation and read-side API.
35 #include <urcu/compiler.h>
38 * lib_ring_buffer_get_cpu - Precedes ring buffer reserve/commit.
40 * Keeps a ring buffer nesting count as supplementary safety net to
41 * ensure tracer client code will never trigger an endless recursion.
42 * Returns the processor ID on success, -EPERM on failure (nesting count
45 * asm volatile and "memory" clobber prevent the compiler from moving
46 * instructions out of the ring buffer nesting count. This is required to ensure
47 * that probe side-effects which can cause recursion (e.g. unforeseen traps,
48 * divisions by 0, ...) are triggered within the incremented nesting count
52 int lib_ring_buffer_get_cpu(const struct lttng_ust_lib_ring_buffer_config
*config
)
56 cpu
= lttng_ust_get_cpu();
57 nesting
= ++URCU_TLS(lib_ring_buffer_nesting
);
60 if (caa_unlikely(nesting
> 4)) {
62 URCU_TLS(lib_ring_buffer_nesting
)--;
69 * lib_ring_buffer_put_cpu - Follows ring buffer reserve/commit.
72 void lib_ring_buffer_put_cpu(const struct lttng_ust_lib_ring_buffer_config
*config
)
75 URCU_TLS(lib_ring_buffer_nesting
)--; /* TLS */
79 * lib_ring_buffer_try_reserve is called by lib_ring_buffer_reserve(). It is not
80 * part of the API per se.
82 * returns 0 if reserve ok, or 1 if the slow path must be taken.
85 int lib_ring_buffer_try_reserve(const struct lttng_ust_lib_ring_buffer_config
*config
,
86 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
87 unsigned long *o_begin
, unsigned long *o_end
,
88 unsigned long *o_old
, size_t *before_hdr_pad
)
90 struct channel
*chan
= ctx
->chan
;
91 struct lttng_ust_lib_ring_buffer
*buf
= ctx
->buf
;
92 *o_begin
= v_read(config
, &buf
->offset
);
95 ctx
->tsc
= lib_ring_buffer_clock_read(chan
);
96 if ((int64_t) ctx
->tsc
== -EIO
)
100 * Prefetch cacheline for read because we have to read the previous
101 * commit counter to increment it and commit seq value to compare it to
102 * the commit counter.
104 //prefetch(&buf->commit_hot[subbuf_index(*o_begin, chan)]);
106 if (last_tsc_overflow(config
, buf
, ctx
->tsc
))
107 ctx
->rflags
|= RING_BUFFER_RFLAG_FULL_TSC
;
109 if (caa_unlikely(subbuf_offset(*o_begin
, chan
) == 0))
112 ctx
->slot_size
= record_header_size(config
, chan
, *o_begin
,
113 before_hdr_pad
, ctx
);
115 lib_ring_buffer_align(*o_begin
+ ctx
->slot_size
,
116 ctx
->largest_align
) + ctx
->data_size
;
117 if (caa_unlikely((subbuf_offset(*o_begin
, chan
) + ctx
->slot_size
)
118 > chan
->backend
.subbuf_size
))
122 * Record fits in the current buffer and we are not on a switch
123 * boundary. It's safe to write.
125 *o_end
= *o_begin
+ ctx
->slot_size
;
127 if (caa_unlikely((subbuf_offset(*o_end
, chan
)) == 0))
129 * The offset_end will fall at the very beginning of the next
138 * lib_ring_buffer_reserve - Reserve space in a ring buffer.
139 * @config: ring buffer instance configuration.
140 * @ctx: ring buffer context. (input and output) Must be already initialized.
142 * Atomic wait-free slot reservation. The reserved space starts at the context
143 * "pre_offset". Its length is "slot_size". The associated time-stamp is "tsc".
147 * -EAGAIN if channel is disabled.
148 * -ENOSPC if event size is too large for packet.
149 * -ENOBUFS if there is currently not enough space in buffer for the event.
150 * -EIO if data cannot be written into the buffer for any other reason.
154 int lib_ring_buffer_reserve(const struct lttng_ust_lib_ring_buffer_config
*config
,
155 struct lttng_ust_lib_ring_buffer_ctx
*ctx
)
157 struct channel
*chan
= ctx
->chan
;
158 struct lttng_ust_shm_handle
*handle
= ctx
->handle
;
159 struct lttng_ust_lib_ring_buffer
*buf
;
160 unsigned long o_begin
, o_end
, o_old
;
161 size_t before_hdr_pad
= 0;
163 if (caa_unlikely(uatomic_read(&chan
->record_disabled
)))
166 if (config
->alloc
== RING_BUFFER_ALLOC_PER_CPU
)
167 buf
= shmp(handle
, chan
->backend
.buf
[ctx
->cpu
].shmp
);
169 buf
= shmp(handle
, chan
->backend
.buf
[0].shmp
);
170 if (caa_unlikely(!buf
))
172 if (caa_unlikely(uatomic_read(&buf
->record_disabled
)))
177 * Perform retryable operations.
179 if (caa_unlikely(lib_ring_buffer_try_reserve(config
, ctx
, &o_begin
,
180 &o_end
, &o_old
, &before_hdr_pad
)))
183 if (caa_unlikely(v_cmpxchg(config
, &ctx
->buf
->offset
, o_old
, o_end
)
188 * Atomically update last_tsc. This update races against concurrent
189 * atomic updates, but the race will always cause supplementary full TSC
190 * record headers, never the opposite (missing a full TSC record header
191 * when it would be needed).
193 save_last_tsc(config
, ctx
->buf
, ctx
->tsc
);
196 * Push the reader if necessary
198 lib_ring_buffer_reserve_push_reader(ctx
->buf
, chan
, o_end
- 1);
201 * Clear noref flag for this subbuffer.
203 lib_ring_buffer_clear_noref(config
, &ctx
->buf
->backend
,
204 subbuf_index(o_end
- 1, chan
), handle
);
206 ctx
->pre_offset
= o_begin
;
207 ctx
->buf_offset
= o_begin
+ before_hdr_pad
;
210 return lib_ring_buffer_reserve_slow(ctx
);
214 * lib_ring_buffer_switch - Perform a sub-buffer switch for a per-cpu buffer.
215 * @config: ring buffer instance configuration.
217 * @mode: buffer switch mode (SWITCH_ACTIVE or SWITCH_FLUSH)
219 * This operation is completely reentrant : can be called while tracing is
220 * active with absolutely no lock held.
222 * Note, however, that as a v_cmpxchg is used for some atomic operations and
223 * requires to be executed locally for per-CPU buffers, this function must be
224 * called from the CPU which owns the buffer for a ACTIVE flush, with preemption
225 * disabled, for RING_BUFFER_SYNC_PER_CPU configuration.
228 void lib_ring_buffer_switch(const struct lttng_ust_lib_ring_buffer_config
*config
,
229 struct lttng_ust_lib_ring_buffer
*buf
, enum switch_mode mode
,
230 struct lttng_ust_shm_handle
*handle
)
232 lib_ring_buffer_switch_slow(buf
, mode
, handle
);
235 /* See ring_buffer_frontend_api.h for lib_ring_buffer_reserve(). */
238 * lib_ring_buffer_commit - Commit an record.
239 * @config: ring buffer instance configuration.
240 * @ctx: ring buffer context. (input arguments only)
242 * Atomic unordered slot commit. Increments the commit count in the
243 * specified sub-buffer, and delivers it if necessary.
246 void lib_ring_buffer_commit(const struct lttng_ust_lib_ring_buffer_config
*config
,
247 const struct lttng_ust_lib_ring_buffer_ctx
*ctx
)
249 struct channel
*chan
= ctx
->chan
;
250 struct lttng_ust_shm_handle
*handle
= ctx
->handle
;
251 struct lttng_ust_lib_ring_buffer
*buf
= ctx
->buf
;
252 unsigned long offset_end
= ctx
->buf_offset
;
253 unsigned long endidx
= subbuf_index(offset_end
- 1, chan
);
254 unsigned long commit_count
;
255 struct commit_counters_hot
*cc_hot
= shmp_index(handle
,
256 buf
->commit_hot
, endidx
);
258 if (caa_unlikely(!cc_hot
))
262 * Must count record before incrementing the commit count.
264 subbuffer_count_record(config
, ctx
, &buf
->backend
, endidx
, handle
);
267 * Order all writes to buffer before the commit count update that will
268 * determine that the subbuffer is full.
272 v_add(config
, ctx
->slot_size
, &cc_hot
->cc
);
275 * commit count read can race with concurrent OOO commit count updates.
276 * This is only needed for lib_ring_buffer_check_deliver (for
277 * non-polling delivery only) and for
278 * lib_ring_buffer_write_commit_counter. The race can only cause the
279 * counter to be read with the same value more than once, which could
281 * - Multiple delivery for the same sub-buffer (which is handled
282 * gracefully by the reader code) if the value is for a full
283 * sub-buffer. It's important that we can never miss a sub-buffer
284 * delivery. Re-reading the value after the v_add ensures this.
285 * - Reading a commit_count with a higher value that what was actually
286 * added to it for the lib_ring_buffer_write_commit_counter call
287 * (again caused by a concurrent committer). It does not matter,
288 * because this function is interested in the fact that the commit
289 * count reaches back the reserve offset for a specific sub-buffer,
290 * which is completely independent of the order.
292 commit_count
= v_read(config
, &cc_hot
->cc
);
294 lib_ring_buffer_check_deliver(config
, buf
, chan
, offset_end
- 1,
295 commit_count
, endidx
, handle
, ctx
->tsc
);
297 * Update used size at each commit. It's needed only for extracting
298 * ring_buffer buffers from vmcore, after crash.
300 lib_ring_buffer_write_commit_counter(config
, buf
, chan
,
301 offset_end
, commit_count
, handle
, cc_hot
);
305 * lib_ring_buffer_try_discard_reserve - Try discarding a record.
306 * @config: ring buffer instance configuration.
307 * @ctx: ring buffer context. (input arguments only)
309 * Only succeeds if no other record has been written after the record to
310 * discard. If discard fails, the record must be committed to the buffer.
312 * Returns 0 upon success, -EPERM if the record cannot be discarded.
315 int lib_ring_buffer_try_discard_reserve(const struct lttng_ust_lib_ring_buffer_config
*config
,
316 const struct lttng_ust_lib_ring_buffer_ctx
*ctx
)
318 struct lttng_ust_lib_ring_buffer
*buf
= ctx
->buf
;
319 unsigned long end_offset
= ctx
->pre_offset
+ ctx
->slot_size
;
322 * We need to ensure that if the cmpxchg succeeds and discards the
323 * record, the next record will record a full TSC, because it cannot
324 * rely on the last_tsc associated with the discarded record to detect
325 * overflows. The only way to ensure this is to set the last_tsc to 0
326 * (assuming no 64-bit TSC overflow), which forces to write a 64-bit
327 * timestamp in the next record.
329 * Note: if discard fails, we must leave the TSC in the record header.
330 * It is needed to keep track of TSC overflows for the following
333 save_last_tsc(config
, buf
, 0ULL);
335 if (caa_likely(v_cmpxchg(config
, &buf
->offset
, end_offset
, ctx
->pre_offset
)
343 void channel_record_disable(const struct lttng_ust_lib_ring_buffer_config
*config
,
344 struct channel
*chan
)
346 uatomic_inc(&chan
->record_disabled
);
350 void channel_record_enable(const struct lttng_ust_lib_ring_buffer_config
*config
,
351 struct channel
*chan
)
353 uatomic_dec(&chan
->record_disabled
);
357 void lib_ring_buffer_record_disable(const struct lttng_ust_lib_ring_buffer_config
*config
,
358 struct lttng_ust_lib_ring_buffer
*buf
)
360 uatomic_inc(&buf
->record_disabled
);
364 void lib_ring_buffer_record_enable(const struct lttng_ust_lib_ring_buffer_config
*config
,
365 struct lttng_ust_lib_ring_buffer
*buf
)
367 uatomic_dec(&buf
->record_disabled
);
370 #endif /* _LTTNG_RING_BUFFER_FRONTEND_API_H */