1 #ifndef _LTTNG_RING_BUFFER_FRONTEND_TYPES_H
2 #define _LTTNG_RING_BUFFER_FRONTEND_TYPES_H
5 * libringbuffer/frontend_types.h
7 * Ring Buffer Library Synchronization Header (types).
9 * Copyright (C) 2005-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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.
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.
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
26 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
28 * See ring_buffer_frontend.c for more information on wait-free algorithms.
32 #include <time.h> /* for timer_t */
34 #include <urcu/list.h>
35 #include <urcu/uatomic.h>
37 #include <lttng/ringbuffer-config.h>
38 #include <usterr-signal-safe.h>
39 #include "backend_types.h"
40 #include "shm_internal.h"
41 #include "shm_types.h"
45 * A switch is done during tracing or as a final flush after tracing (so it
46 * won't write in the new sub-buffer).
48 enum switch_mode
{ SWITCH_ACTIVE
, SWITCH_FLUSH
};
50 /* channel: collection of per-cpu ring buffers. */
51 #define RB_CHANNEL_PADDING 32
54 unsigned long commit_count_mask
; /*
55 * Commit count mask, removing
56 * the MSBs corresponding to
57 * bits used to represent the
61 unsigned long switch_timer_interval
; /* Buffer flush (us) */
63 int switch_timer_enabled
;
65 unsigned long read_timer_interval
; /* Reader wakeup (us) */
67 int read_timer_enabled
;
69 int finalized
; /* Has channel been finalized */
70 size_t priv_data_offset
;
71 unsigned int nr_streams
; /* Number of streams */
72 struct lttng_ust_shm_handle
*handle
;
73 /* Extended options. */
76 int32_t blocking_timeout_ms
;
78 char padding
[RB_CHANNEL_PADDING
];
81 * Associated backend contains a variable-length array. Needs to
84 struct channel_backend backend
; /* Associated backend */
85 } __attribute__((aligned(CAA_CACHE_LINE_SIZE
)));
87 /* Per-subbuffer commit counters used on the hot path */
88 #define RB_COMMIT_COUNT_HOT_PADDING 16
89 struct commit_counters_hot
{
90 union v_atomic cc
; /* Commit counter */
91 union v_atomic seq
; /* Consecutive commits */
92 char padding
[RB_COMMIT_COUNT_HOT_PADDING
];
93 } __attribute__((aligned(CAA_CACHE_LINE_SIZE
)));
95 /* Per-subbuffer commit counters used only on cold paths */
96 #define RB_COMMIT_COUNT_COLD_PADDING 24
97 struct commit_counters_cold
{
98 union v_atomic cc_sb
; /* Incremented _once_ at sb switch */
99 char padding
[RB_COMMIT_COUNT_COLD_PADDING
];
100 } __attribute__((aligned(CAA_CACHE_LINE_SIZE
)));
102 /* ring buffer state */
103 #define RB_CRASH_DUMP_ABI_LEN 256
104 #define RB_RING_BUFFER_PADDING 60
106 #define RB_CRASH_DUMP_ABI_MAGIC_LEN 16
109 * The 128-bit magic number is xor'd in the process data so it does not
110 * cause a false positive when searching for buffers by scanning memory.
111 * The actual magic number is:
112 * 0x17, 0x7B, 0xF1, 0x77, 0xBF, 0x17, 0x7B, 0xF1,
113 * 0x77, 0xBF, 0x17, 0x7B, 0xF1, 0x77, 0xBF, 0x17,
115 #define RB_CRASH_DUMP_ABI_MAGIC_XOR \
117 0x17 ^ 0xFF, 0x7B ^ 0xFF, 0xF1 ^ 0xFF, 0x77 ^ 0xFF, \
118 0xBF ^ 0xFF, 0x17 ^ 0xFF, 0x7B ^ 0xFF, 0xF1 ^ 0xFF, \
119 0x77 ^ 0xFF, 0xBF ^ 0xFF, 0x17 ^ 0xFF, 0x7B ^ 0xFF, \
120 0xF1 ^ 0xFF, 0x77 ^ 0xFF, 0xBF ^ 0xFF, 0x17 ^ 0xFF, \
123 #define RB_CRASH_ENDIAN 0x1234
125 #define RB_CRASH_DUMP_ABI_MAJOR 0
126 #define RB_CRASH_DUMP_ABI_MINOR 0
128 enum lttng_crash_type
{
129 LTTNG_CRASH_TYPE_UST
= 0,
130 LTTNG_CRASH_TYPE_KERNEL
= 1,
133 struct lttng_crash_abi
{
134 uint8_t magic
[RB_CRASH_DUMP_ABI_MAGIC_LEN
];
135 uint64_t mmap_length
; /* Overall lenght of crash record */
137 * { 0x12, 0x34 }: big endian
138 * { 0x34, 0x12 }: little endian
140 uint16_t major
; /* Major number. */
141 uint16_t minor
; /* Minor number. */
142 uint8_t word_size
; /* Word size (bytes). */
143 uint8_t layout_type
; /* enum lttng_crash_type */
146 uint32_t prod_offset
;
147 uint32_t consumed_offset
;
148 uint32_t commit_hot_array
;
149 uint32_t commit_hot_seq
;
150 uint32_t buf_wsb_array
;
153 uint32_t sb_array_shmp_offset
;
154 uint32_t sb_backend_p_offset
;
155 uint32_t content_size
;
156 uint32_t packet_size
;
157 } __attribute__((packed
)) offset
;
160 uint8_t consumed_offset
;
161 uint8_t commit_hot_seq
;
163 uint8_t sb_array_shmp_offset
;
164 uint8_t sb_backend_p_offset
;
165 uint8_t content_size
;
167 } __attribute__((packed
)) length
;
169 uint32_t commit_hot_array
;
170 uint32_t buf_wsb_array
;
172 } __attribute__((packed
)) stride
;
174 uint64_t buf_size
; /* Size of the buffer */
175 uint64_t subbuf_size
; /* Sub-buffer size */
176 uint64_t num_subbuf
; /* Number of sub-buffers for writer */
177 uint32_t mode
; /* Buffer mode: 0: overwrite, 1: discard */
178 } __attribute__((packed
));
180 struct lttng_ust_lib_ring_buffer
{
181 /* First 32 bytes are for the buffer crash dump ABI */
182 struct lttng_crash_abi crash_abi
;
184 /* 32 bytes cache-hot cacheline */
185 union v_atomic
__attribute__((aligned(32))) offset
;
186 /* Current offset in the buffer */
187 DECLARE_SHMP(struct commit_counters_hot
, commit_hot
);
188 /* Commit count per sub-buffer */
190 * Current offset in the buffer
191 * standard atomic access (shared)
194 /* End of cache-hot 32 bytes cacheline */
196 union v_atomic last_tsc
; /*
197 * Last timestamp written in the buffer.
200 struct lttng_ust_lib_ring_buffer_backend backend
;
201 /* Associated backend */
203 DECLARE_SHMP(struct commit_counters_cold
, commit_cold
);
204 /* Commit count per sub-buffer */
205 long active_readers
; /*
206 * Active readers count
207 * standard atomic access (shared)
209 /* Dropped records */
210 union v_atomic records_lost_full
; /* Buffer full */
211 union v_atomic records_lost_wrap
; /* Nested wrap-around */
212 union v_atomic records_lost_big
; /* Events too big */
213 union v_atomic records_count
; /* Number of records written */
214 union v_atomic records_overrun
; /* Number of overwritten records */
215 //wait_queue_head_t read_wait; /* reader buffer-level wait queue */
216 int finalized
; /* buffer has been finalized */
217 unsigned long get_subbuf_consumed
; /* Read-side consumed */
218 unsigned long prod_snapshot
; /* Producer count snapshot */
219 unsigned long cons_snapshot
; /* Consumer count snapshot */
220 unsigned int get_subbuf
:1; /* Sub-buffer being held by reader */
221 /* shmp pointer to self */
222 DECLARE_SHMP(struct lttng_ust_lib_ring_buffer
, self
);
223 char padding
[RB_RING_BUFFER_PADDING
];
224 } __attribute__((aligned(CAA_CACHE_LINE_SIZE
)));
227 void *channel_get_private(struct channel
*chan
)
229 return ((char *) chan
) + chan
->priv_data_offset
;
232 #ifndef __rb_same_type
233 #define __rb_same_type(a, b) __builtin_types_compatible_p(typeof(a), typeof(b))
237 * Issue warnings and disable channels upon internal error.
238 * Can receive struct lttng_ust_lib_ring_buffer or struct lttng_ust_lib_ring_buffer_backend
241 #define CHAN_WARN_ON(c, cond) \
243 struct channel *__chan; \
244 int _____ret = caa_unlikely(cond); \
246 if (__rb_same_type(*(c), struct channel_backend)) \
247 __chan = caa_container_of((void *) (c), \
250 else if (__rb_same_type(*(c), struct channel)) \
251 __chan = (void *) (c); \
254 uatomic_inc(&__chan->record_disabled); \
257 _____ret = _____ret; /* For clang "unused result". */ \
260 #endif /* _LTTNG_RING_BUFFER_FRONTEND_TYPES_H */