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