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