Calculate context length outside of retry loop
[lttng-ust.git] / libringbuffer / frontend_internal.h
CommitLineData
e92f3e28
MD
1#ifndef _LTTNG_RING_BUFFER_FRONTEND_INTERNAL_H
2#define _LTTNG_RING_BUFFER_FRONTEND_INTERNAL_H
852c2936
MD
3
4/*
e92f3e28 5 * libringbuffer/frontend_internal.h
852c2936
MD
6 *
7 * Ring Buffer Library Synchronization Header (internal helpers).
8 *
e92f3e28
MD
9 * Copyright (C) 2005-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 *
11 * This library is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public
13 * License as published by the Free Software Foundation; only
14 * version 2.1 of the License.
15 *
16 * This library is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
20 *
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with this library; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 *
25 *
852c2936
MD
26 * Author:
27 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
28 *
29 * See ring_buffer_frontend.c for more information on wait-free algorithms.
30 *
31 * Dual LGPL v2.1/GPL v2 license.
32 */
33
14641deb 34#include <urcu/compiler.h>
8c90a710 35#include <urcu/tls-compat.h>
2c44f5b9
MD
36#include <signal.h>
37#include <pthread.h>
14641deb 38
4318ae1b 39#include <lttng/ringbuffer-config.h>
4931a13e
MD
40#include "backend_types.h"
41#include "frontend_types.h"
a6352fd4 42#include "shm.h"
852c2936
MD
43
44/* Buffer offset macros */
45
46/* buf_trunc mask selects only the buffer number. */
47static inline
48unsigned long buf_trunc(unsigned long offset, struct channel *chan)
49{
50 return offset & ~(chan->backend.buf_size - 1);
51
52}
53
54/* Select the buffer number value (counter). */
55static inline
56unsigned long buf_trunc_val(unsigned long offset, struct channel *chan)
57{
58 return buf_trunc(offset, chan) >> chan->backend.buf_size_order;
59}
60
61/* buf_offset mask selects only the offset within the current buffer. */
62static inline
63unsigned long buf_offset(unsigned long offset, struct channel *chan)
64{
65 return offset & (chan->backend.buf_size - 1);
66}
67
68/* subbuf_offset mask selects the offset within the current subbuffer. */
69static inline
70unsigned long subbuf_offset(unsigned long offset, struct channel *chan)
71{
72 return offset & (chan->backend.subbuf_size - 1);
73}
74
75/* subbuf_trunc mask selects the subbuffer number. */
76static inline
77unsigned long subbuf_trunc(unsigned long offset, struct channel *chan)
78{
79 return offset & ~(chan->backend.subbuf_size - 1);
80}
81
82/* subbuf_align aligns the offset to the next subbuffer. */
83static inline
84unsigned long subbuf_align(unsigned long offset, struct channel *chan)
85{
86 return (offset + chan->backend.subbuf_size)
87 & ~(chan->backend.subbuf_size - 1);
88}
89
90/* subbuf_index returns the index of the current subbuffer within the buffer. */
91static inline
92unsigned long subbuf_index(unsigned long offset, struct channel *chan)
93{
94 return buf_offset(offset, chan) >> chan->backend.subbuf_size_order;
95}
96
97/*
98 * Last TSC comparison functions. Check if the current TSC overflows tsc_bits
99 * bits from the last TSC read. When overflows are detected, the full 64-bit
100 * timestamp counter should be written in the record header. Reads and writes
101 * last_tsc atomically.
102 */
103
14641deb 104#if (CAA_BITS_PER_LONG == 32)
852c2936 105static inline
4cfec15c 106void save_last_tsc(const struct lttng_ust_lib_ring_buffer_config *config,
2fed87ae 107 struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc)
852c2936
MD
108{
109 if (config->tsc_bits == 0 || config->tsc_bits == 64)
110 return;
111
112 /*
113 * Ensure the compiler performs this update in a single instruction.
114 */
115 v_set(config, &buf->last_tsc, (unsigned long)(tsc >> config->tsc_bits));
116}
117
118static inline
4cfec15c 119int last_tsc_overflow(const struct lttng_ust_lib_ring_buffer_config *config,
2fed87ae 120 struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc)
852c2936
MD
121{
122 unsigned long tsc_shifted;
123
124 if (config->tsc_bits == 0 || config->tsc_bits == 64)
125 return 0;
126
127 tsc_shifted = (unsigned long)(tsc >> config->tsc_bits);
b5a3dfa5 128 if (caa_unlikely(tsc_shifted
852c2936
MD
129 - (unsigned long)v_read(config, &buf->last_tsc)))
130 return 1;
131 else
132 return 0;
133}
134#else
135static inline
4cfec15c 136void save_last_tsc(const struct lttng_ust_lib_ring_buffer_config *config,
2fed87ae 137 struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc)
852c2936
MD
138{
139 if (config->tsc_bits == 0 || config->tsc_bits == 64)
140 return;
141
142 v_set(config, &buf->last_tsc, (unsigned long)tsc);
143}
144
145static inline
4cfec15c 146int last_tsc_overflow(const struct lttng_ust_lib_ring_buffer_config *config,
2fed87ae 147 struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc)
852c2936
MD
148{
149 if (config->tsc_bits == 0 || config->tsc_bits == 64)
150 return 0;
151
b5a3dfa5 152 if (caa_unlikely((tsc - v_read(config, &buf->last_tsc))
852c2936
MD
153 >> config->tsc_bits))
154 return 1;
155 else
156 return 0;
157}
158#endif
159
160extern
e56bb47c
MD
161int lib_ring_buffer_reserve_slow(struct lttng_ust_lib_ring_buffer_ctx *ctx,
162 void *client_ctx);
852c2936
MD
163
164extern
4cfec15c 165void lib_ring_buffer_switch_slow(struct lttng_ust_lib_ring_buffer *buf,
1d498196 166 enum switch_mode mode,
38fae1d3 167 struct lttng_ust_shm_handle *handle);
852c2936 168
b07cd987
MD
169void lib_ring_buffer_check_deliver_slow(const struct lttng_ust_lib_ring_buffer_config *config,
170 struct lttng_ust_lib_ring_buffer *buf,
171 struct channel *chan,
172 unsigned long offset,
173 unsigned long commit_count,
174 unsigned long idx,
175 struct lttng_ust_shm_handle *handle,
176 uint64_t tsc);
177
852c2936
MD
178/* Buffer write helpers */
179
180static inline
4cfec15c 181void lib_ring_buffer_reserve_push_reader(struct lttng_ust_lib_ring_buffer *buf,
852c2936
MD
182 struct channel *chan,
183 unsigned long offset)
184{
185 unsigned long consumed_old, consumed_new;
186
187 do {
14641deb 188 consumed_old = uatomic_read(&buf->consumed);
852c2936
MD
189 /*
190 * If buffer is in overwrite mode, push the reader consumed
191 * count if the write position has reached it and we are not
192 * at the first iteration (don't push the reader farther than
193 * the writer). This operation can be done concurrently by many
194 * writers in the same buffer, the writer being at the farthest
195 * write position sub-buffer index in the buffer being the one
196 * which will win this loop.
197 */
b5a3dfa5 198 if (caa_unlikely(subbuf_trunc(offset, chan)
852c2936
MD
199 - subbuf_trunc(consumed_old, chan)
200 >= chan->backend.buf_size))
201 consumed_new = subbuf_align(consumed_old, chan);
202 else
203 return;
b5a3dfa5 204 } while (caa_unlikely(uatomic_cmpxchg(&buf->consumed, consumed_old,
852c2936
MD
205 consumed_new) != consumed_old));
206}
207
852c2936 208static inline
4cfec15c
MD
209int lib_ring_buffer_pending_data(const struct lttng_ust_lib_ring_buffer_config *config,
210 struct lttng_ust_lib_ring_buffer *buf,
852c2936
MD
211 struct channel *chan)
212{
213 return !!subbuf_offset(v_read(config, &buf->offset), chan);
214}
215
216static inline
4cfec15c
MD
217unsigned long lib_ring_buffer_get_data_size(const struct lttng_ust_lib_ring_buffer_config *config,
218 struct lttng_ust_lib_ring_buffer *buf,
1d498196 219 unsigned long idx,
38fae1d3 220 struct lttng_ust_shm_handle *handle)
852c2936 221{
1d498196 222 return subbuffer_get_data_size(config, &buf->backend, idx, handle);
852c2936
MD
223}
224
225/*
226 * Check if all space reservation in a buffer have been committed. This helps
227 * knowing if an execution context is nested (for per-cpu buffers only).
228 * This is a very specific ftrace use-case, so we keep this as "internal" API.
229 */
230static inline
4cfec15c
MD
231int lib_ring_buffer_reserve_committed(const struct lttng_ust_lib_ring_buffer_config *config,
232 struct lttng_ust_lib_ring_buffer *buf,
1d498196 233 struct channel *chan,
38fae1d3 234 struct lttng_ust_shm_handle *handle)
852c2936
MD
235{
236 unsigned long offset, idx, commit_count;
15500a1b 237 struct commit_counters_hot *cc_hot = shmp_index(handle, buf->commit_hot, idx);
852c2936
MD
238
239 CHAN_WARN_ON(chan, config->alloc != RING_BUFFER_ALLOC_PER_CPU);
240 CHAN_WARN_ON(chan, config->sync != RING_BUFFER_SYNC_PER_CPU);
241
15500a1b
MD
242 if (caa_unlikely(!cc_hot))
243 return 0;
244
852c2936
MD
245 /*
246 * Read offset and commit count in a loop so they are both read
247 * atomically wrt interrupts. By deal with interrupt concurrency by
248 * restarting both reads if the offset has been pushed. Note that given
249 * we only have to deal with interrupt concurrency here, an interrupt
250 * modifying the commit count will also modify "offset", so it is safe
251 * to only check for offset modifications.
252 */
253 do {
254 offset = v_read(config, &buf->offset);
255 idx = subbuf_index(offset, chan);
15500a1b 256 commit_count = v_read(config, &cc_hot->cc);
852c2936
MD
257 } while (offset != v_read(config, &buf->offset));
258
259 return ((buf_trunc(offset, chan) >> chan->backend.num_subbuf_order)
260 - (commit_count & chan->commit_count_mask) == 0);
261}
262
1b7b0501
MD
263/*
264 * Receive end of subbuffer TSC as parameter. It has been read in the
265 * space reservation loop of either reserve or switch, which ensures it
266 * progresses monotonically with event records in the buffer. Therefore,
267 * it ensures that the end timestamp of a subbuffer is <= begin
268 * timestamp of the following subbuffers.
269 */
852c2936 270static inline
4cfec15c
MD
271void lib_ring_buffer_check_deliver(const struct lttng_ust_lib_ring_buffer_config *config,
272 struct lttng_ust_lib_ring_buffer *buf,
852c2936
MD
273 struct channel *chan,
274 unsigned long offset,
275 unsigned long commit_count,
1d498196 276 unsigned long idx,
1b7b0501
MD
277 struct lttng_ust_shm_handle *handle,
278 uint64_t tsc)
852c2936
MD
279{
280 unsigned long old_commit_count = commit_count
281 - chan->backend.subbuf_size;
852c2936
MD
282
283 /* Check if all commits have been done */
b5a3dfa5 284 if (caa_unlikely((buf_trunc(offset, chan) >> chan->backend.num_subbuf_order)
b07cd987
MD
285 - (old_commit_count & chan->commit_count_mask) == 0))
286 lib_ring_buffer_check_deliver_slow(config, buf, chan, offset,
287 commit_count, idx, handle, tsc);
852c2936
MD
288}
289
290/*
291 * lib_ring_buffer_write_commit_counter
292 *
293 * For flight recording. must be called after commit.
294 * This function increments the subbuffer's commit_seq counter each time the
295 * commit count reaches back the reserve offset (modulo subbuffer size). It is
296 * useful for crash dump.
297 */
298static inline
4cfec15c
MD
299void lib_ring_buffer_write_commit_counter(const struct lttng_ust_lib_ring_buffer_config *config,
300 struct lttng_ust_lib_ring_buffer *buf,
852c2936 301 struct channel *chan,
852c2936
MD
302 unsigned long buf_offset,
303 unsigned long commit_count,
d2fe4771
MD
304 struct lttng_ust_shm_handle *handle,
305 struct commit_counters_hot *cc_hot)
852c2936 306{
80249235 307 unsigned long commit_seq_old;
852c2936
MD
308
309 if (config->oops != RING_BUFFER_OOPS_CONSISTENCY)
310 return;
311
852c2936
MD
312 /*
313 * subbuf_offset includes commit_count_mask. We can simply
314 * compare the offsets within the subbuffer without caring about
315 * buffer full/empty mismatch because offset is never zero here
316 * (subbuffer header and record headers have non-zero length).
317 */
80249235 318 if (caa_unlikely(subbuf_offset(buf_offset - commit_count, chan)))
852c2936
MD
319 return;
320
d2fe4771 321 commit_seq_old = v_read(config, &cc_hot->seq);
16ec84c8 322 if (caa_likely((long) (commit_seq_old - commit_count) < 0))
d2fe4771 323 v_set(config, &cc_hot->seq, commit_count);
852c2936
MD
324}
325
4cfec15c 326extern int lib_ring_buffer_create(struct lttng_ust_lib_ring_buffer *buf,
a6352fd4 327 struct channel_backend *chanb, int cpu,
38fae1d3 328 struct lttng_ust_shm_handle *handle,
1d498196 329 struct shm_object *shmobj);
4cfec15c 330extern void lib_ring_buffer_free(struct lttng_ust_lib_ring_buffer *buf,
38fae1d3 331 struct lttng_ust_shm_handle *handle);
852c2936
MD
332
333/* Keep track of trap nesting inside ring buffer code */
8c90a710 334extern DECLARE_URCU_TLS(unsigned int, lib_ring_buffer_nesting);
852c2936 335
e92f3e28 336#endif /* _LTTNG_RING_BUFFER_FRONTEND_INTERNAL_H */
This page took 0.042794 seconds and 4 git commands to generate.