Commit | Line | Data |
---|---|---|
3d1fc7fd | 1 | /* |
c0c0989a | 2 | * SPDX-License-Identifier: LGPL-2.1-only |
3d1fc7fd | 3 | * |
e92f3e28 MD |
4 | * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
5 | * | |
c0c0989a | 6 | * LTTng lib ring buffer client template. |
3d1fc7fd MD |
7 | */ |
8 | ||
9af5d97a | 9 | #include <limits.h> |
b4051ad8 | 10 | #include <stddef.h> |
9f3fdbc6 | 11 | #include <stdint.h> |
7753d283 MJ |
12 | |
13 | #include <ust-events-internal.h> | |
9d315d6d MJ |
14 | #include "common/bitfield.h" |
15 | #include "common/align.h" | |
7dd08bec | 16 | #include "lttng-tracer.h" |
e4db8f98 | 17 | #include "common/ringbuffer/frontend_types.h" |
8936b6c0 | 18 | #include <urcu/tls-compat.h> |
3d1fc7fd MD |
19 | |
20 | struct metadata_packet_header { | |
21 | uint32_t magic; /* 0x75D11D57 */ | |
19d8b1b3 | 22 | uint8_t uuid[LTTNG_UST_UUID_LEN]; /* Unique Universal Identifier */ |
3d1fc7fd MD |
23 | uint32_t checksum; /* 0 if unused */ |
24 | uint32_t content_size; /* in bits */ | |
25 | uint32_t packet_size; /* in bits */ | |
26 | uint8_t compression_scheme; /* 0 if unused */ | |
27 | uint8_t encryption_scheme; /* 0 if unused */ | |
28 | uint8_t checksum_scheme; /* 0 if unused */ | |
8a98a75d MD |
29 | uint8_t major; /* CTF spec major version number */ |
30 | uint8_t minor; /* CTF spec minor version number */ | |
3d1fc7fd MD |
31 | uint8_t header_end[0]; |
32 | }; | |
33 | ||
34 | struct metadata_record_header { | |
35 | uint8_t header_end[0]; /* End of header */ | |
36 | }; | |
37 | ||
4cfec15c | 38 | static const struct lttng_ust_lib_ring_buffer_config client_config; |
3d1fc7fd | 39 | |
8936b6c0 MD |
40 | /* No nested use supported for metadata ring buffer. */ |
41 | static DEFINE_URCU_TLS(struct lttng_ust_lib_ring_buffer_ctx_private, private_ctx); | |
42 | ||
2208d8b5 MJ |
43 | static inline uint64_t lib_ring_buffer_clock_read( |
44 | struct lttng_ust_lib_ring_buffer_channel *chan __attribute__((unused))) | |
3d1fc7fd MD |
45 | { |
46 | return 0; | |
47 | } | |
48 | ||
49 | static inline | |
2208d8b5 MJ |
50 | size_t record_header_size( |
51 | const struct lttng_ust_lib_ring_buffer_config *config __attribute__((unused)), | |
52 | struct lttng_ust_lib_ring_buffer_channel *chan __attribute__((unused)), | |
53 | size_t offset __attribute__((unused)), | |
54 | size_t *pre_header_padding __attribute__((unused)), | |
55 | struct lttng_ust_lib_ring_buffer_ctx *ctx __attribute__((unused)), | |
56 | void *client_ctx __attribute__((unused))) | |
3d1fc7fd MD |
57 | { |
58 | return 0; | |
59 | } | |
60 | ||
e4db8f98 | 61 | #include "common/ringbuffer/api.h" |
82b9bde8 | 62 | #include "lttng-rb-clients.h" |
3d1fc7fd | 63 | |
2208d8b5 MJ |
64 | static uint64_t client_ring_buffer_clock_read( |
65 | struct lttng_ust_lib_ring_buffer_channel *chan __attribute__((unused))) | |
3d1fc7fd MD |
66 | { |
67 | return 0; | |
68 | } | |
69 | ||
70 | static | |
2208d8b5 MJ |
71 | size_t client_record_header_size( |
72 | const struct lttng_ust_lib_ring_buffer_config *config __attribute__((unused)), | |
73 | struct lttng_ust_lib_ring_buffer_channel *chan __attribute__((unused)), | |
74 | size_t offset __attribute__((unused)), | |
75 | size_t *pre_header_padding __attribute__((unused)), | |
76 | struct lttng_ust_lib_ring_buffer_ctx *ctx __attribute__((unused)), | |
77 | void *client_ctx __attribute__((unused))) | |
3d1fc7fd MD |
78 | { |
79 | return 0; | |
80 | } | |
81 | ||
82 | /** | |
83 | * client_packet_header_size - called on buffer-switch to a new sub-buffer | |
84 | * | |
85 | * Return header size without padding after the structure. Don't use packed | |
86 | * structure because gcc generates inefficient code on some architectures | |
87 | * (powerpc, mips..) | |
88 | */ | |
89 | static size_t client_packet_header_size(void) | |
90 | { | |
91 | return offsetof(struct metadata_packet_header, header_end); | |
92 | } | |
93 | ||
2208d8b5 MJ |
94 | static void client_buffer_begin(struct lttng_ust_lib_ring_buffer *buf, |
95 | uint64_t tsc __attribute__((unused)), | |
96 | unsigned int subbuf_idx, | |
97 | struct lttng_ust_shm_handle *handle) | |
3d1fc7fd | 98 | { |
5198080d | 99 | struct lttng_ust_lib_ring_buffer_channel *chan = shmp(handle, buf->backend.chan); |
3d1fc7fd MD |
100 | struct metadata_packet_header *header = |
101 | (struct metadata_packet_header *) | |
102 | lib_ring_buffer_offset_address(&buf->backend, | |
1d498196 MD |
103 | subbuf_idx * chan->backend.subbuf_size, |
104 | handle); | |
e7bc0ef6 | 105 | struct lttng_ust_channel_buffer *lttng_chan = channel_get_private(chan); |
3d1fc7fd | 106 | |
34daae3e MD |
107 | assert(header); |
108 | if (!header) | |
109 | return; | |
3d1fc7fd | 110 | header->magic = TSDL_MAGIC_NUMBER; |
e7bc0ef6 | 111 | memcpy(header->uuid, lttng_chan->priv->uuid, sizeof(lttng_chan->priv->uuid)); |
3d1fc7fd MD |
112 | header->checksum = 0; /* 0 if unused */ |
113 | header->content_size = 0xFFFFFFFF; /* in bits, for debugging */ | |
114 | header->packet_size = 0xFFFFFFFF; /* in bits, for debugging */ | |
115 | header->compression_scheme = 0; /* 0 if unused */ | |
116 | header->encryption_scheme = 0; /* 0 if unused */ | |
117 | header->checksum_scheme = 0; /* 0 if unused */ | |
8a98a75d MD |
118 | header->major = CTF_SPEC_MAJOR; |
119 | header->minor = CTF_SPEC_MINOR; | |
3d1fc7fd MD |
120 | } |
121 | ||
122 | /* | |
123 | * offset is assumed to never be 0 here : never deliver a completely empty | |
124 | * subbuffer. data_size is between 1 and subbuf_size. | |
125 | */ | |
2208d8b5 MJ |
126 | static void client_buffer_end(struct lttng_ust_lib_ring_buffer *buf, |
127 | uint64_t tsc __attribute__((unused)), | |
128 | unsigned int subbuf_idx, unsigned long data_size, | |
129 | struct lttng_ust_shm_handle *handle) | |
3d1fc7fd | 130 | { |
5198080d | 131 | struct lttng_ust_lib_ring_buffer_channel *chan = shmp(handle, buf->backend.chan); |
3d1fc7fd MD |
132 | struct metadata_packet_header *header = |
133 | (struct metadata_packet_header *) | |
134 | lib_ring_buffer_offset_address(&buf->backend, | |
1d498196 MD |
135 | subbuf_idx * chan->backend.subbuf_size, |
136 | handle); | |
3d1fc7fd MD |
137 | unsigned long records_lost = 0; |
138 | ||
34daae3e MD |
139 | assert(header); |
140 | if (!header) | |
141 | return; | |
3d1fc7fd | 142 | header->content_size = data_size * CHAR_BIT; /* in bits */ |
b72687b8 | 143 | header->packet_size = LTTNG_UST_PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */ |
04489ab4 MD |
144 | /* |
145 | * We do not care about the records lost count, because the metadata | |
146 | * channel waits and retry. | |
147 | */ | |
148 | (void) lib_ring_buffer_get_records_lost_full(&client_config, buf); | |
3d1fc7fd MD |
149 | records_lost += lib_ring_buffer_get_records_lost_wrap(&client_config, buf); |
150 | records_lost += lib_ring_buffer_get_records_lost_big(&client_config, buf); | |
151 | WARN_ON_ONCE(records_lost != 0); | |
152 | } | |
153 | ||
2208d8b5 MJ |
154 | static int client_buffer_create( |
155 | struct lttng_ust_lib_ring_buffer *buf __attribute__((unused)), | |
156 | void *priv __attribute__((unused)), | |
157 | int cpu __attribute__((unused)), | |
158 | const char *name __attribute__((unused)), | |
159 | struct lttng_ust_shm_handle *handle __attribute__((unused))) | |
3d1fc7fd MD |
160 | { |
161 | return 0; | |
162 | } | |
163 | ||
2208d8b5 MJ |
164 | static void client_buffer_finalize( |
165 | struct lttng_ust_lib_ring_buffer *buf __attribute__((unused)), | |
166 | void *priv __attribute__((unused)), | |
167 | int cpu __attribute__((unused)), | |
168 | struct lttng_ust_shm_handle *handle __attribute__((unused))) | |
3d1fc7fd MD |
169 | { |
170 | } | |
171 | ||
82b9bde8 JD |
172 | static const |
173 | struct lttng_ust_client_lib_ring_buffer_client_cb client_cb = { | |
174 | .parent = { | |
175 | .ring_buffer_clock_read = client_ring_buffer_clock_read, | |
176 | .record_header_size = client_record_header_size, | |
177 | .subbuffer_header_size = client_packet_header_size, | |
178 | .buffer_begin = client_buffer_begin, | |
179 | .buffer_end = client_buffer_end, | |
180 | .buffer_create = client_buffer_create, | |
181 | .buffer_finalize = client_buffer_finalize, | |
182 | }, | |
183 | }; | |
184 | ||
4cfec15c | 185 | static const struct lttng_ust_lib_ring_buffer_config client_config = { |
3d1fc7fd MD |
186 | .cb.ring_buffer_clock_read = client_ring_buffer_clock_read, |
187 | .cb.record_header_size = client_record_header_size, | |
188 | .cb.subbuffer_header_size = client_packet_header_size, | |
189 | .cb.buffer_begin = client_buffer_begin, | |
190 | .cb.buffer_end = client_buffer_end, | |
191 | .cb.buffer_create = client_buffer_create, | |
192 | .cb.buffer_finalize = client_buffer_finalize, | |
193 | ||
194 | .tsc_bits = 0, | |
195 | .alloc = RING_BUFFER_ALLOC_GLOBAL, | |
196 | .sync = RING_BUFFER_SYNC_GLOBAL, | |
197 | .mode = RING_BUFFER_MODE_TEMPLATE, | |
198 | .backend = RING_BUFFER_PAGE, | |
5d61a504 | 199 | .output = RING_BUFFER_MMAP, |
3d1fc7fd | 200 | .oops = RING_BUFFER_OOPS_CONSISTENCY, |
5d61a504 MD |
201 | .ipi = RING_BUFFER_NO_IPI_BARRIER, |
202 | .wakeup = RING_BUFFER_WAKEUP_BY_WRITER, | |
c1fca457 | 203 | .client_type = LTTNG_CLIENT_TYPE, |
82b9bde8 JD |
204 | |
205 | .cb_ptr = &client_cb.parent, | |
3d1fc7fd MD |
206 | }; |
207 | ||
208 | static | |
e7bc0ef6 | 209 | struct lttng_ust_channel_buffer *_channel_create(const char *name, |
a3f61e7f | 210 | void *buf_addr, |
3d1fc7fd MD |
211 | size_t subbuf_size, size_t num_subbuf, |
212 | unsigned int switch_timer_interval, | |
193183fb | 213 | unsigned int read_timer_interval, |
6ca18e66 | 214 | unsigned char *uuid, |
a9ff648c | 215 | uint32_t chan_id, |
b2c5f61a MD |
216 | const int *stream_fds, int nr_stream_fds, |
217 | int64_t blocking_timeout) | |
3d1fc7fd | 218 | { |
f0fde1c3 | 219 | struct lttng_ust_abi_channel_config chan_priv_init; |
a3f61e7f | 220 | struct lttng_ust_shm_handle *handle; |
e7bc0ef6 | 221 | struct lttng_ust_channel_buffer *lttng_chan_buf; |
f0fde1c3 | 222 | |
e7bc0ef6 MD |
223 | lttng_chan_buf = lttng_ust_alloc_channel_buffer(); |
224 | if (!lttng_chan_buf) | |
f0fde1c3 | 225 | return NULL; |
e7bc0ef6 MD |
226 | memcpy(lttng_chan_buf->priv->uuid, uuid, LTTNG_UST_UUID_LEN); |
227 | lttng_chan_buf->priv->id = chan_id; | |
a3f61e7f | 228 | |
74d81a6c MD |
229 | memset(&chan_priv_init, 0, sizeof(chan_priv_init)); |
230 | memcpy(chan_priv_init.uuid, uuid, LTTNG_UST_UUID_LEN); | |
6ca18e66 | 231 | chan_priv_init.id = chan_id; |
f0fde1c3 | 232 | |
a3f61e7f | 233 | handle = channel_create(&client_config, name, |
e7bc0ef6 MD |
234 | __alignof__(struct lttng_ust_channel_buffer), |
235 | sizeof(struct lttng_ust_channel_buffer), | |
74d81a6c | 236 | &chan_priv_init, |
e7bc0ef6 | 237 | lttng_chan_buf, buf_addr, subbuf_size, num_subbuf, |
a9ff648c | 238 | switch_timer_interval, read_timer_interval, |
b2c5f61a | 239 | stream_fds, nr_stream_fds, blocking_timeout); |
a3f61e7f | 240 | if (!handle) |
f0fde1c3 | 241 | goto error; |
07539b34 | 242 | lttng_chan_buf->priv->rb_chan = shmp(handle, handle->chan); |
e7bc0ef6 | 243 | return lttng_chan_buf; |
f0fde1c3 MD |
244 | |
245 | error: | |
e7bc0ef6 | 246 | lttng_ust_free_channel_common(lttng_chan_buf->parent); |
f0fde1c3 | 247 | return NULL; |
3d1fc7fd MD |
248 | } |
249 | ||
250 | static | |
e7bc0ef6 | 251 | void lttng_channel_destroy(struct lttng_ust_channel_buffer *lttng_chan_buf) |
3d1fc7fd | 252 | { |
07539b34 | 253 | channel_destroy(lttng_chan_buf->priv->rb_chan, lttng_chan_buf->priv->rb_chan->handle, 1); |
e7bc0ef6 | 254 | lttng_ust_free_channel_common(lttng_chan_buf->parent); |
3d1fc7fd MD |
255 | } |
256 | ||
257 | static | |
8936b6c0 | 258 | int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx) |
3d1fc7fd | 259 | { |
a3492932 MD |
260 | int ret; |
261 | ||
f37bd904 MD |
262 | memset(&URCU_TLS(private_ctx), 0, sizeof(struct lttng_ust_lib_ring_buffer_ctx_private)); |
263 | URCU_TLS(private_ctx).pub = ctx; | |
264 | URCU_TLS(private_ctx).chan = ctx->client_priv; | |
265 | ctx->priv = &URCU_TLS(private_ctx); | |
e56bb47c | 266 | ret = lib_ring_buffer_reserve(&client_config, ctx, NULL); |
a3492932 MD |
267 | if (ret) |
268 | return ret; | |
2b7080aa | 269 | if (lib_ring_buffer_backend_get_pages(&client_config, ctx, |
8936b6c0 | 270 | &ctx->priv->backend_pages)) |
2b7080aa | 271 | return -EPERM; |
a3492932 | 272 | return 0; |
3d1fc7fd MD |
273 | } |
274 | ||
275 | static | |
7dd08bec | 276 | void lttng_event_commit(struct lttng_ust_lib_ring_buffer_ctx *ctx) |
3d1fc7fd MD |
277 | { |
278 | lib_ring_buffer_commit(&client_config, ctx); | |
279 | } | |
280 | ||
281 | static | |
8936b6c0 MD |
282 | void lttng_event_write(struct lttng_ust_lib_ring_buffer_ctx *ctx, |
283 | const void *src, size_t len, size_t alignment) | |
3d1fc7fd | 284 | { |
8936b6c0 | 285 | lttng_ust_lib_ring_buffer_align_ctx(ctx, alignment); |
3d1fc7fd MD |
286 | lib_ring_buffer_write(&client_config, ctx, src, len); |
287 | } | |
288 | ||
289 | static | |
07539b34 | 290 | size_t lttng_packet_avail_size(struct lttng_ust_channel_buffer *chan) |
3d1fc7fd | 291 | { |
07539b34 | 292 | struct lttng_ust_lib_ring_buffer_channel *rb_chan = chan->priv->rb_chan; |
3d1fc7fd | 293 | unsigned long o_begin; |
4cfec15c | 294 | struct lttng_ust_lib_ring_buffer *buf; |
3d1fc7fd | 295 | |
07539b34 | 296 | buf = shmp(rb_chan->handle, rb_chan->backend.buf[0].shmp); /* Only for global buffer ! */ |
3d1fc7fd | 297 | o_begin = v_read(&client_config, &buf->offset); |
07539b34 MD |
298 | if (subbuf_offset(o_begin, rb_chan) != 0) { |
299 | return rb_chan->backend.subbuf_size - subbuf_offset(o_begin, rb_chan); | |
3d1fc7fd | 300 | } else { |
07539b34 | 301 | return rb_chan->backend.subbuf_size - subbuf_offset(o_begin, rb_chan) |
3d1fc7fd MD |
302 | - sizeof(struct metadata_packet_header); |
303 | } | |
304 | } | |
305 | ||
306 | static | |
07539b34 | 307 | int lttng_is_finalized(struct lttng_ust_channel_buffer *chan) |
3d1fc7fd | 308 | { |
07539b34 | 309 | struct lttng_ust_lib_ring_buffer_channel *rb_chan = chan->priv->rb_chan; |
3d1fc7fd | 310 | |
07539b34 | 311 | return lib_ring_buffer_channel_is_finalized(rb_chan); |
3d1fc7fd MD |
312 | } |
313 | ||
314 | static | |
07539b34 | 315 | int lttng_is_disabled(struct lttng_ust_channel_buffer *chan) |
3d1fc7fd | 316 | { |
07539b34 | 317 | struct lttng_ust_lib_ring_buffer_channel *rb_chan = chan->priv->rb_chan; |
3d1fc7fd | 318 | |
07539b34 | 319 | return lib_ring_buffer_channel_is_disabled(rb_chan); |
3d1fc7fd MD |
320 | } |
321 | ||
43861eab | 322 | static |
07539b34 | 323 | int lttng_flush_buffer(struct lttng_ust_channel_buffer *chan) |
43861eab | 324 | { |
07539b34 | 325 | struct lttng_ust_lib_ring_buffer_channel *rb_chan = chan->priv->rb_chan; |
4cfec15c | 326 | struct lttng_ust_lib_ring_buffer *buf; |
74d81a6c MD |
327 | int shm_fd, wait_fd, wakeup_fd; |
328 | uint64_t memory_map_size; | |
43861eab | 329 | |
07539b34 MD |
330 | buf = channel_get_ring_buffer(&client_config, rb_chan, |
331 | 0, rb_chan->handle, &shm_fd, &wait_fd, &wakeup_fd, | |
43861eab MD |
332 | &memory_map_size); |
333 | lib_ring_buffer_switch(&client_config, buf, | |
07539b34 | 334 | SWITCH_ACTIVE, rb_chan->handle); |
43861eab MD |
335 | return 0; |
336 | } | |
337 | ||
7dd08bec | 338 | static struct lttng_transport lttng_relay_transport = { |
818173b9 | 339 | .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap", |
3d1fc7fd | 340 | .ops = { |
14b6f891 | 341 | .struct_size = sizeof(struct lttng_ust_channel_buffer_ops), |
49926dbd | 342 | |
14b6f891 | 343 | .priv = __LTTNG_COMPOUND_LITERAL(struct lttng_ust_channel_buffer_ops_private, { |
a880bae5 MD |
344 | .pub = <tng_relay_transport.ops, |
345 | .channel_create = _channel_create, | |
346 | .channel_destroy = lttng_channel_destroy, | |
347 | .packet_avail_size = lttng_packet_avail_size, | |
348 | .is_finalized = lttng_is_finalized, | |
349 | .is_disabled = lttng_is_disabled, | |
350 | .flush_buffer = lttng_flush_buffer, | |
351 | }), | |
7dd08bec MD |
352 | .event_reserve = lttng_event_reserve, |
353 | .event_commit = lttng_event_commit, | |
354 | .event_write = lttng_event_write, | |
3d1fc7fd | 355 | }, |
74d81a6c | 356 | .client_config = &client_config, |
3d1fc7fd MD |
357 | }; |
358 | ||
edaa1431 | 359 | void RING_BUFFER_MODE_TEMPLATE_INIT(void) |
3d1fc7fd | 360 | { |
34a91bdb MD |
361 | DBG("LTT : ltt ring buffer client \"%s\" init\n", |
362 | "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap"); | |
7dd08bec | 363 | lttng_transport_register(<tng_relay_transport); |
3d1fc7fd MD |
364 | } |
365 | ||
edaa1431 | 366 | void RING_BUFFER_MODE_TEMPLATE_EXIT(void) |
3d1fc7fd | 367 | { |
34a91bdb MD |
368 | DBG("LTT : ltt ring buffer client \"%s\" exit\n", |
369 | "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap"); | |
7dd08bec | 370 | lttng_transport_unregister(<tng_relay_transport); |
3d1fc7fd | 371 | } |