Commit | Line | Data |
---|---|---|
3d1fc7fd | 1 | /* |
7dd08bec | 2 | * lttng-ring-buffer-client.h |
3d1fc7fd | 3 | * |
3d1fc7fd MD |
4 | * LTTng lib ring buffer client template. |
5 | * | |
e92f3e28 MD |
6 | * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
7 | * | |
8 | * This library is free software; you can redistribute it and/or | |
9 | * modify it under the terms of the GNU Lesser General Public | |
10 | * License as published by the Free Software Foundation; only | |
11 | * version 2.1 of the License. | |
12 | * | |
13 | * This library is distributed in the hope that it will be useful, | |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
16 | * Lesser General Public License for more details. | |
17 | * | |
18 | * You should have received a copy of the GNU Lesser General Public | |
19 | * License along with this library; if not, write to the Free Software | |
20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
3d1fc7fd MD |
21 | */ |
22 | ||
b4051ad8 | 23 | #include <stddef.h> |
9f3fdbc6 | 24 | #include <stdint.h> |
4318ae1b MD |
25 | #include <lttng/ust-events.h> |
26 | #include "lttng/bitfield.h" | |
b728d87e | 27 | #include "clock.h" |
7dd08bec | 28 | #include "lttng-tracer.h" |
9f3fdbc6 | 29 | #include "../libringbuffer/frontend_types.h" |
3d1fc7fd | 30 | |
79dfbf42 MD |
31 | #define LTTNG_COMPACT_EVENT_BITS 5 |
32 | #define LTTNG_COMPACT_TSC_BITS 27 | |
33 | ||
ce7352a2 MD |
34 | enum app_ctx_mode { |
35 | APP_CTX_DISABLED, | |
36 | APP_CTX_ENABLED, | |
37 | }; | |
38 | ||
3d1fc7fd MD |
39 | /* |
40 | * Keep the natural field alignment for _each field_ within this structure if | |
41 | * you ever add/remove a field from this header. Packed attribute is not used | |
42 | * because gcc generates poor code on at least powerpc and mips. Don't ever | |
43 | * let gcc add padding between the structure elements. | |
44 | */ | |
45 | ||
46 | struct packet_header { | |
47 | /* Trace packet header */ | |
48 | uint32_t magic; /* | |
49 | * Trace magic number. | |
50 | * contains endianness information. | |
51 | */ | |
19d8b1b3 | 52 | uint8_t uuid[LTTNG_UST_UUID_LEN]; |
3d1fc7fd | 53 | uint32_t stream_id; |
2d94adc5 | 54 | uint64_t stream_instance_id; |
3d1fc7fd MD |
55 | |
56 | struct { | |
57 | /* Stream packet context */ | |
58 | uint64_t timestamp_begin; /* Cycle count at subbuffer start */ | |
59 | uint64_t timestamp_end; /* Cycle count at subbuffer end */ | |
0c00a107 MD |
60 | uint64_t content_size; /* Size of data in subbuffer */ |
61 | uint64_t packet_size; /* Subbuffer size (include padding) */ | |
1ff31389 | 62 | uint64_t packet_seq_num; /* Packet sequence number */ |
18fc8d71 | 63 | unsigned long events_discarded; /* |
3d1fc7fd MD |
64 | * Events lost in this subbuffer since |
65 | * the beginning of the trace. | |
66 | * (may overflow) | |
67 | */ | |
3d1fc7fd MD |
68 | uint32_t cpu_id; /* CPU id associated with stream */ |
69 | uint8_t header_end; /* End of header */ | |
70 | } ctx; | |
71 | }; | |
72 | ||
e56bb47c MD |
73 | struct lttng_client_ctx { |
74 | size_t packet_context_len; | |
75 | size_t event_context_len; | |
76 | }; | |
3d1fc7fd | 77 | |
23c8854a | 78 | static inline uint64_t lib_ring_buffer_clock_read(struct channel *chan) |
3d1fc7fd MD |
79 | { |
80 | return trace_clock_read64(); | |
81 | } | |
82 | ||
83 | static inline | |
e56bb47c MD |
84 | size_t ctx_get_aligned_size(size_t offset, struct lttng_ctx *ctx, |
85 | size_t ctx_len) | |
3d1fc7fd | 86 | { |
3d1fc7fd MD |
87 | size_t orig_offset = offset; |
88 | ||
b5a3dfa5 | 89 | if (caa_likely(!ctx)) |
3d1fc7fd | 90 | return 0; |
b2cc986a | 91 | offset += lib_ring_buffer_align(offset, ctx->largest_align); |
e56bb47c MD |
92 | offset += ctx_len; |
93 | return offset - orig_offset; | |
94 | } | |
95 | ||
96 | static inline | |
97 | void ctx_get_struct_size(struct lttng_ctx *ctx, size_t *ctx_len, | |
98 | enum app_ctx_mode mode) | |
99 | { | |
100 | int i; | |
101 | size_t offset = 0; | |
102 | ||
103 | if (caa_likely(!ctx)) { | |
104 | *ctx_len = 0; | |
105 | return; | |
106 | } | |
ce7352a2 MD |
107 | for (i = 0; i < ctx->nr_fields; i++) { |
108 | if (mode == APP_CTX_ENABLED) { | |
109 | offset += ctx->fields[i].get_size(&ctx->fields[i], offset); | |
110 | } else { | |
111 | if (lttng_context_is_app(ctx->fields[i].event_field.name)) { | |
112 | /* | |
113 | * Before UST 2.8, we cannot use the | |
114 | * application context, because we | |
115 | * cannot trust that the handler used | |
116 | * for get_size is the same used for | |
117 | * ctx_record, which would result in | |
118 | * corrupted traces when tracing | |
119 | * concurrently with application context | |
120 | * register/unregister. | |
121 | */ | |
122 | offset += lttng_ust_dummy_get_size(&ctx->fields[i], offset); | |
123 | } else { | |
124 | offset += ctx->fields[i].get_size(&ctx->fields[i], offset); | |
125 | } | |
126 | } | |
127 | } | |
e56bb47c | 128 | *ctx_len = offset; |
3d1fc7fd MD |
129 | } |
130 | ||
131 | static inline | |
4cfec15c | 132 | void ctx_record(struct lttng_ust_lib_ring_buffer_ctx *bufctx, |
7dd08bec | 133 | struct lttng_channel *chan, |
ce7352a2 MD |
134 | struct lttng_ctx *ctx, |
135 | enum app_ctx_mode mode) | |
3d1fc7fd MD |
136 | { |
137 | int i; | |
138 | ||
b5a3dfa5 | 139 | if (caa_likely(!ctx)) |
3d1fc7fd | 140 | return; |
b2cc986a | 141 | lib_ring_buffer_align_ctx(bufctx, ctx->largest_align); |
ce7352a2 MD |
142 | for (i = 0; i < ctx->nr_fields; i++) { |
143 | if (mode == APP_CTX_ENABLED) { | |
144 | ctx->fields[i].record(&ctx->fields[i], bufctx, chan); | |
145 | } else { | |
146 | if (lttng_context_is_app(ctx->fields[i].event_field.name)) { | |
147 | /* | |
148 | * Before UST 2.8, we cannot use the | |
149 | * application context, because we | |
150 | * cannot trust that the handler used | |
151 | * for get_size is the same used for | |
152 | * ctx_record, which would result in | |
153 | * corrupted traces when tracing | |
154 | * concurrently with application context | |
155 | * register/unregister. | |
156 | */ | |
157 | lttng_ust_dummy_record(&ctx->fields[i], bufctx, chan); | |
158 | } else { | |
159 | ctx->fields[i].record(&ctx->fields[i], bufctx, chan); | |
160 | } | |
161 | } | |
162 | } | |
3d1fc7fd MD |
163 | } |
164 | ||
165 | /* | |
166 | * record_header_size - Calculate the header size and padding necessary. | |
167 | * @config: ring buffer instance configuration | |
168 | * @chan: channel | |
169 | * @offset: offset in the write buffer | |
170 | * @pre_header_padding: padding to add before the header (output) | |
171 | * @ctx: reservation context | |
172 | * | |
173 | * Returns the event header size (including padding). | |
174 | * | |
175 | * The payload must itself determine its own alignment from the biggest type it | |
176 | * contains. | |
177 | */ | |
178 | static __inline__ | |
8ca68914 | 179 | size_t record_header_size(const struct lttng_ust_lib_ring_buffer_config *config, |
3d1fc7fd MD |
180 | struct channel *chan, size_t offset, |
181 | size_t *pre_header_padding, | |
e56bb47c MD |
182 | struct lttng_ust_lib_ring_buffer_ctx *ctx, |
183 | struct lttng_client_ctx *client_ctx) | |
3d1fc7fd | 184 | { |
7dd08bec | 185 | struct lttng_channel *lttng_chan = channel_get_private(chan); |
ce7352a2 | 186 | struct lttng_event *event = ctx->priv; |
ba1c40c6 | 187 | struct lttng_stack_ctx *lttng_ctx = ctx->priv2; |
3d1fc7fd MD |
188 | size_t orig_offset = offset; |
189 | size_t padding; | |
190 | ||
7dd08bec | 191 | switch (lttng_chan->header_type) { |
3d1fc7fd | 192 | case 1: /* compact */ |
1dbfff0c | 193 | padding = lib_ring_buffer_align(offset, lttng_alignof(uint32_t)); |
3d1fc7fd | 194 | offset += padding; |
7dd08bec | 195 | if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) { |
3d1fc7fd MD |
196 | offset += sizeof(uint32_t); /* id and timestamp */ |
197 | } else { | |
79dfbf42 MD |
198 | /* Minimum space taken by LTTNG_COMPACT_EVENT_BITS id */ |
199 | offset += (LTTNG_COMPACT_EVENT_BITS + CHAR_BIT - 1) / CHAR_BIT; | |
3d1fc7fd | 200 | /* Align extended struct on largest member */ |
1dbfff0c | 201 | offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t)); |
3d1fc7fd | 202 | offset += sizeof(uint32_t); /* id */ |
1dbfff0c | 203 | offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t)); |
3d1fc7fd MD |
204 | offset += sizeof(uint64_t); /* timestamp */ |
205 | } | |
206 | break; | |
207 | case 2: /* large */ | |
1dbfff0c | 208 | padding = lib_ring_buffer_align(offset, lttng_alignof(uint16_t)); |
3d1fc7fd MD |
209 | offset += padding; |
210 | offset += sizeof(uint16_t); | |
7dd08bec | 211 | if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) { |
1dbfff0c | 212 | offset += lib_ring_buffer_align(offset, lttng_alignof(uint32_t)); |
3d1fc7fd MD |
213 | offset += sizeof(uint32_t); /* timestamp */ |
214 | } else { | |
215 | /* Align extended struct on largest member */ | |
1dbfff0c | 216 | offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t)); |
3d1fc7fd | 217 | offset += sizeof(uint32_t); /* id */ |
1dbfff0c | 218 | offset += lib_ring_buffer_align(offset, lttng_alignof(uint64_t)); |
3d1fc7fd MD |
219 | offset += sizeof(uint64_t); /* timestamp */ |
220 | } | |
221 | break; | |
222 | default: | |
9f3fdbc6 | 223 | padding = 0; |
3d1fc7fd MD |
224 | WARN_ON_ONCE(1); |
225 | } | |
ce7352a2 MD |
226 | if (lttng_ctx) { |
227 | /* 2.8+ probe ABI. */ | |
e56bb47c MD |
228 | offset += ctx_get_aligned_size(offset, lttng_ctx->chan_ctx, |
229 | client_ctx->packet_context_len); | |
230 | offset += ctx_get_aligned_size(offset, lttng_ctx->event_ctx, | |
231 | client_ctx->event_context_len); | |
ce7352a2 MD |
232 | } else { |
233 | /* Pre 2.8 probe ABI. */ | |
e56bb47c MD |
234 | offset += ctx_get_aligned_size(offset, lttng_chan->ctx, |
235 | client_ctx->packet_context_len); | |
236 | offset += ctx_get_aligned_size(offset, event->ctx, | |
237 | client_ctx->event_context_len); | |
ce7352a2 | 238 | } |
3d1fc7fd MD |
239 | *pre_header_padding = padding; |
240 | return offset - orig_offset; | |
241 | } | |
242 | ||
9f3fdbc6 | 243 | #include "../libringbuffer/api.h" |
82b9bde8 | 244 | #include "lttng-rb-clients.h" |
3d1fc7fd | 245 | |
9f3fdbc6 | 246 | static |
7dd08bec | 247 | void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config *config, |
4cfec15c | 248 | struct lttng_ust_lib_ring_buffer_ctx *ctx, |
3d1fc7fd MD |
249 | uint32_t event_id); |
250 | ||
251 | /* | |
7dd08bec | 252 | * lttng_write_event_header |
3d1fc7fd MD |
253 | * |
254 | * Writes the event header to the offset (already aligned on 32-bits). | |
255 | * | |
256 | * @config: ring buffer instance configuration | |
257 | * @ctx: reservation context | |
258 | * @event_id: event ID | |
259 | */ | |
260 | static __inline__ | |
7dd08bec | 261 | void lttng_write_event_header(const struct lttng_ust_lib_ring_buffer_config *config, |
4cfec15c | 262 | struct lttng_ust_lib_ring_buffer_ctx *ctx, |
3d1fc7fd MD |
263 | uint32_t event_id) |
264 | { | |
7dd08bec | 265 | struct lttng_channel *lttng_chan = channel_get_private(ctx->chan); |
ce7352a2 | 266 | struct lttng_event *event = ctx->priv; |
53569322 | 267 | struct lttng_stack_ctx *lttng_ctx = ctx->priv2; |
3d1fc7fd | 268 | |
b5a3dfa5 | 269 | if (caa_unlikely(ctx->rflags)) |
3d1fc7fd MD |
270 | goto slow_path; |
271 | ||
7dd08bec | 272 | switch (lttng_chan->header_type) { |
3d1fc7fd MD |
273 | case 1: /* compact */ |
274 | { | |
275 | uint32_t id_time = 0; | |
276 | ||
79dfbf42 MD |
277 | bt_bitfield_write(&id_time, uint32_t, |
278 | 0, | |
279 | LTTNG_COMPACT_EVENT_BITS, | |
280 | event_id); | |
281 | bt_bitfield_write(&id_time, uint32_t, | |
282 | LTTNG_COMPACT_EVENT_BITS, | |
283 | LTTNG_COMPACT_TSC_BITS, | |
284 | ctx->tsc); | |
3d1fc7fd MD |
285 | lib_ring_buffer_write(config, ctx, &id_time, sizeof(id_time)); |
286 | break; | |
287 | } | |
288 | case 2: /* large */ | |
289 | { | |
290 | uint32_t timestamp = (uint32_t) ctx->tsc; | |
291 | uint16_t id = event_id; | |
292 | ||
293 | lib_ring_buffer_write(config, ctx, &id, sizeof(id)); | |
1dbfff0c | 294 | lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint32_t)); |
3d1fc7fd MD |
295 | lib_ring_buffer_write(config, ctx, ×tamp, sizeof(timestamp)); |
296 | break; | |
297 | } | |
298 | default: | |
299 | WARN_ON_ONCE(1); | |
300 | } | |
301 | ||
ce7352a2 MD |
302 | if (lttng_ctx) { |
303 | /* 2.8+ probe ABI. */ | |
304 | ctx_record(ctx, lttng_chan, lttng_ctx->chan_ctx, APP_CTX_ENABLED); | |
305 | ctx_record(ctx, lttng_chan, lttng_ctx->event_ctx, APP_CTX_ENABLED); | |
306 | } else { | |
307 | /* Pre 2.8 probe ABI. */ | |
308 | ctx_record(ctx, lttng_chan, lttng_chan->ctx, APP_CTX_DISABLED); | |
309 | ctx_record(ctx, lttng_chan, event->ctx, APP_CTX_DISABLED); | |
310 | } | |
d3b2c3e0 | 311 | lib_ring_buffer_align_ctx(ctx, ctx->largest_align); |
3d1fc7fd MD |
312 | |
313 | return; | |
314 | ||
315 | slow_path: | |
7dd08bec | 316 | lttng_write_event_header_slow(config, ctx, event_id); |
3d1fc7fd MD |
317 | } |
318 | ||
9f3fdbc6 | 319 | static |
7dd08bec | 320 | void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config *config, |
4cfec15c | 321 | struct lttng_ust_lib_ring_buffer_ctx *ctx, |
3d1fc7fd MD |
322 | uint32_t event_id) |
323 | { | |
7dd08bec | 324 | struct lttng_channel *lttng_chan = channel_get_private(ctx->chan); |
ce7352a2 | 325 | struct lttng_event *event = ctx->priv; |
53569322 | 326 | struct lttng_stack_ctx *lttng_ctx = ctx->priv2; |
3d1fc7fd | 327 | |
7dd08bec | 328 | switch (lttng_chan->header_type) { |
3d1fc7fd | 329 | case 1: /* compact */ |
7dd08bec | 330 | if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) { |
3d1fc7fd MD |
331 | uint32_t id_time = 0; |
332 | ||
79dfbf42 MD |
333 | bt_bitfield_write(&id_time, uint32_t, |
334 | 0, | |
335 | LTTNG_COMPACT_EVENT_BITS, | |
336 | event_id); | |
337 | bt_bitfield_write(&id_time, uint32_t, | |
338 | LTTNG_COMPACT_EVENT_BITS, | |
339 | LTTNG_COMPACT_TSC_BITS, | |
340 | ctx->tsc); | |
3d1fc7fd MD |
341 | lib_ring_buffer_write(config, ctx, &id_time, sizeof(id_time)); |
342 | } else { | |
343 | uint8_t id = 0; | |
344 | uint64_t timestamp = ctx->tsc; | |
345 | ||
79dfbf42 MD |
346 | bt_bitfield_write(&id, uint8_t, |
347 | 0, | |
348 | LTTNG_COMPACT_EVENT_BITS, | |
349 | 31); | |
3d1fc7fd MD |
350 | lib_ring_buffer_write(config, ctx, &id, sizeof(id)); |
351 | /* Align extended struct on largest member */ | |
1dbfff0c | 352 | lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t)); |
3d1fc7fd | 353 | lib_ring_buffer_write(config, ctx, &event_id, sizeof(event_id)); |
1dbfff0c | 354 | lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t)); |
3d1fc7fd MD |
355 | lib_ring_buffer_write(config, ctx, ×tamp, sizeof(timestamp)); |
356 | } | |
357 | break; | |
358 | case 2: /* large */ | |
359 | { | |
7dd08bec | 360 | if (!(ctx->rflags & (RING_BUFFER_RFLAG_FULL_TSC | LTTNG_RFLAG_EXTENDED))) { |
3d1fc7fd MD |
361 | uint32_t timestamp = (uint32_t) ctx->tsc; |
362 | uint16_t id = event_id; | |
363 | ||
364 | lib_ring_buffer_write(config, ctx, &id, sizeof(id)); | |
1dbfff0c | 365 | lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint32_t)); |
3d1fc7fd MD |
366 | lib_ring_buffer_write(config, ctx, ×tamp, sizeof(timestamp)); |
367 | } else { | |
368 | uint16_t id = 65535; | |
369 | uint64_t timestamp = ctx->tsc; | |
370 | ||
371 | lib_ring_buffer_write(config, ctx, &id, sizeof(id)); | |
372 | /* Align extended struct on largest member */ | |
1dbfff0c | 373 | lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t)); |
3d1fc7fd | 374 | lib_ring_buffer_write(config, ctx, &event_id, sizeof(event_id)); |
1dbfff0c | 375 | lib_ring_buffer_align_ctx(ctx, lttng_alignof(uint64_t)); |
3d1fc7fd MD |
376 | lib_ring_buffer_write(config, ctx, ×tamp, sizeof(timestamp)); |
377 | } | |
378 | break; | |
379 | } | |
380 | default: | |
381 | WARN_ON_ONCE(1); | |
382 | } | |
ce7352a2 MD |
383 | if (lttng_ctx) { |
384 | /* 2.8+ probe ABI. */ | |
385 | ctx_record(ctx, lttng_chan, lttng_ctx->chan_ctx, APP_CTX_ENABLED); | |
386 | ctx_record(ctx, lttng_chan, lttng_ctx->event_ctx, APP_CTX_ENABLED); | |
387 | } else { | |
388 | /* Pre 2.8 probe ABI. */ | |
389 | ctx_record(ctx, lttng_chan, lttng_chan->ctx, APP_CTX_DISABLED); | |
390 | ctx_record(ctx, lttng_chan, event->ctx, APP_CTX_DISABLED); | |
391 | } | |
d3b2c3e0 | 392 | lib_ring_buffer_align_ctx(ctx, ctx->largest_align); |
3d1fc7fd MD |
393 | } |
394 | ||
4cfec15c | 395 | static const struct lttng_ust_lib_ring_buffer_config client_config; |
3d1fc7fd | 396 | |
23c8854a | 397 | static uint64_t client_ring_buffer_clock_read(struct channel *chan) |
3d1fc7fd MD |
398 | { |
399 | return lib_ring_buffer_clock_read(chan); | |
400 | } | |
401 | ||
402 | static | |
4cfec15c | 403 | size_t client_record_header_size(const struct lttng_ust_lib_ring_buffer_config *config, |
3d1fc7fd MD |
404 | struct channel *chan, size_t offset, |
405 | size_t *pre_header_padding, | |
e56bb47c MD |
406 | struct lttng_ust_lib_ring_buffer_ctx *ctx, |
407 | void *client_ctx) | |
3d1fc7fd MD |
408 | { |
409 | return record_header_size(config, chan, offset, | |
e56bb47c | 410 | pre_header_padding, ctx, client_ctx); |
3d1fc7fd MD |
411 | } |
412 | ||
413 | /** | |
414 | * client_packet_header_size - called on buffer-switch to a new sub-buffer | |
415 | * | |
416 | * Return header size without padding after the structure. Don't use packed | |
417 | * structure because gcc generates inefficient code on some architectures | |
418 | * (powerpc, mips..) | |
419 | */ | |
420 | static size_t client_packet_header_size(void) | |
421 | { | |
422 | return offsetof(struct packet_header, ctx.header_end); | |
423 | } | |
424 | ||
23c8854a | 425 | static void client_buffer_begin(struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc, |
1d498196 | 426 | unsigned int subbuf_idx, |
38fae1d3 | 427 | struct lttng_ust_shm_handle *handle) |
3d1fc7fd | 428 | { |
1d498196 | 429 | struct channel *chan = shmp(handle, buf->backend.chan); |
3d1fc7fd MD |
430 | struct packet_header *header = |
431 | (struct packet_header *) | |
432 | lib_ring_buffer_offset_address(&buf->backend, | |
1d498196 MD |
433 | subbuf_idx * chan->backend.subbuf_size, |
434 | handle); | |
7dd08bec | 435 | struct lttng_channel *lttng_chan = channel_get_private(chan); |
1ff31389 | 436 | uint64_t cnt = shmp_index(handle, buf->backend.buf_cnt, subbuf_idx)->seq_cnt; |
3d1fc7fd | 437 | |
34daae3e MD |
438 | assert(header); |
439 | if (!header) | |
440 | return; | |
3d1fc7fd | 441 | header->magic = CTF_MAGIC_NUMBER; |
7dd08bec MD |
442 | memcpy(header->uuid, lttng_chan->uuid, sizeof(lttng_chan->uuid)); |
443 | header->stream_id = lttng_chan->id; | |
2d94adc5 | 444 | header->stream_instance_id = buf->backend.cpu; |
3d1fc7fd MD |
445 | header->ctx.timestamp_begin = tsc; |
446 | header->ctx.timestamp_end = 0; | |
0c00a107 MD |
447 | header->ctx.content_size = ~0ULL; /* for debugging */ |
448 | header->ctx.packet_size = ~0ULL; | |
1ff31389 | 449 | header->ctx.packet_seq_num = chan->backend.num_subbuf * cnt + subbuf_idx; |
3d1fc7fd | 450 | header->ctx.events_discarded = 0; |
3d1fc7fd MD |
451 | header->ctx.cpu_id = buf->backend.cpu; |
452 | } | |
453 | ||
454 | /* | |
455 | * offset is assumed to never be 0 here : never deliver a completely empty | |
456 | * subbuffer. data_size is between 1 and subbuf_size. | |
457 | */ | |
23c8854a | 458 | static void client_buffer_end(struct lttng_ust_lib_ring_buffer *buf, uint64_t tsc, |
1d498196 | 459 | unsigned int subbuf_idx, unsigned long data_size, |
38fae1d3 | 460 | struct lttng_ust_shm_handle *handle) |
3d1fc7fd | 461 | { |
1d498196 | 462 | struct channel *chan = shmp(handle, buf->backend.chan); |
3d1fc7fd MD |
463 | struct packet_header *header = |
464 | (struct packet_header *) | |
465 | lib_ring_buffer_offset_address(&buf->backend, | |
1d498196 MD |
466 | subbuf_idx * chan->backend.subbuf_size, |
467 | handle); | |
3d1fc7fd MD |
468 | unsigned long records_lost = 0; |
469 | ||
34daae3e MD |
470 | assert(header); |
471 | if (!header) | |
472 | return; | |
3d1fc7fd | 473 | header->ctx.timestamp_end = tsc; |
b1830883 MD |
474 | header->ctx.content_size = |
475 | (uint64_t) data_size * CHAR_BIT; /* in bits */ | |
476 | header->ctx.packet_size = | |
477 | (uint64_t) PAGE_ALIGN(data_size) * CHAR_BIT; /* in bits */ | |
04489ab4 MD |
478 | |
479 | records_lost += lib_ring_buffer_get_records_lost_full(&client_config, buf); | |
3d1fc7fd MD |
480 | records_lost += lib_ring_buffer_get_records_lost_wrap(&client_config, buf); |
481 | records_lost += lib_ring_buffer_get_records_lost_big(&client_config, buf); | |
482 | header->ctx.events_discarded = records_lost; | |
483 | } | |
484 | ||
4cfec15c | 485 | static int client_buffer_create(struct lttng_ust_lib_ring_buffer *buf, void *priv, |
38fae1d3 | 486 | int cpu, const char *name, struct lttng_ust_shm_handle *handle) |
3d1fc7fd MD |
487 | { |
488 | return 0; | |
489 | } | |
490 | ||
4cfec15c | 491 | static void client_buffer_finalize(struct lttng_ust_lib_ring_buffer *buf, void *priv, int cpu, struct lttng_ust_shm_handle *handle) |
3d1fc7fd MD |
492 | { |
493 | } | |
494 | ||
a9ff648c MD |
495 | static void client_content_size_field(const struct lttng_ust_lib_ring_buffer_config *config, |
496 | size_t *offset, size_t *length) | |
497 | { | |
498 | *offset = offsetof(struct packet_header, ctx.content_size); | |
499 | *length = sizeof(((struct packet_header *) NULL)->ctx.content_size); | |
500 | } | |
501 | ||
502 | static void client_packet_size_field(const struct lttng_ust_lib_ring_buffer_config *config, | |
503 | size_t *offset, size_t *length) | |
504 | { | |
505 | *offset = offsetof(struct packet_header, ctx.packet_size); | |
506 | *length = sizeof(((struct packet_header *) NULL)->ctx.packet_size); | |
507 | } | |
508 | ||
b2f3252a JD |
509 | static struct packet_header *client_packet_header(struct lttng_ust_lib_ring_buffer *buf, |
510 | struct lttng_ust_shm_handle *handle) | |
511 | { | |
c4d6bd10 | 512 | return lib_ring_buffer_read_offset_address(&buf->backend, 0, handle); |
b2f3252a JD |
513 | } |
514 | ||
515 | static int client_timestamp_begin(struct lttng_ust_lib_ring_buffer *buf, | |
516 | struct lttng_ust_shm_handle *handle, | |
517 | uint64_t *timestamp_begin) | |
518 | { | |
519 | struct packet_header *header; | |
520 | ||
521 | header = client_packet_header(buf, handle); | |
34daae3e MD |
522 | if (!header) |
523 | return -1; | |
b2f3252a JD |
524 | *timestamp_begin = header->ctx.timestamp_begin; |
525 | return 0; | |
526 | } | |
527 | ||
528 | static int client_timestamp_end(struct lttng_ust_lib_ring_buffer *buf, | |
529 | struct lttng_ust_shm_handle *handle, | |
530 | uint64_t *timestamp_end) | |
531 | { | |
532 | struct packet_header *header; | |
533 | ||
534 | header = client_packet_header(buf, handle); | |
34daae3e MD |
535 | if (!header) |
536 | return -1; | |
b2f3252a JD |
537 | *timestamp_end = header->ctx.timestamp_end; |
538 | return 0; | |
539 | } | |
540 | ||
541 | static int client_events_discarded(struct lttng_ust_lib_ring_buffer *buf, | |
542 | struct lttng_ust_shm_handle *handle, | |
543 | uint64_t *events_discarded) | |
544 | { | |
545 | struct packet_header *header; | |
546 | ||
547 | header = client_packet_header(buf, handle); | |
34daae3e MD |
548 | if (!header) |
549 | return -1; | |
b2f3252a JD |
550 | *events_discarded = header->ctx.events_discarded; |
551 | return 0; | |
552 | } | |
553 | ||
554 | static int client_content_size(struct lttng_ust_lib_ring_buffer *buf, | |
555 | struct lttng_ust_shm_handle *handle, | |
556 | uint64_t *content_size) | |
557 | { | |
558 | struct packet_header *header; | |
559 | ||
560 | header = client_packet_header(buf, handle); | |
34daae3e MD |
561 | if (!header) |
562 | return -1; | |
b2f3252a JD |
563 | *content_size = header->ctx.content_size; |
564 | return 0; | |
565 | } | |
566 | ||
567 | static int client_packet_size(struct lttng_ust_lib_ring_buffer *buf, | |
568 | struct lttng_ust_shm_handle *handle, | |
569 | uint64_t *packet_size) | |
570 | { | |
571 | struct packet_header *header; | |
572 | ||
573 | header = client_packet_header(buf, handle); | |
34daae3e MD |
574 | if (!header) |
575 | return -1; | |
b2f3252a JD |
576 | *packet_size = header->ctx.packet_size; |
577 | return 0; | |
578 | } | |
579 | ||
580 | static int client_stream_id(struct lttng_ust_lib_ring_buffer *buf, | |
581 | struct lttng_ust_shm_handle *handle, | |
582 | uint64_t *stream_id) | |
583 | { | |
db95cf8b MD |
584 | struct channel *chan = shmp(handle, buf->backend.chan); |
585 | struct lttng_channel *lttng_chan = channel_get_private(chan); | |
586 | ||
587 | *stream_id = lttng_chan->id; | |
b2f3252a | 588 | |
b2f3252a JD |
589 | return 0; |
590 | } | |
591 | ||
fca361e8 JD |
592 | static int client_current_timestamp(struct lttng_ust_lib_ring_buffer *buf, |
593 | struct lttng_ust_shm_handle *handle, | |
594 | uint64_t *ts) | |
595 | { | |
596 | struct channel *chan; | |
597 | ||
598 | chan = shmp(handle, handle->chan); | |
599 | *ts = client_ring_buffer_clock_read(chan); | |
600 | ||
601 | return 0; | |
602 | } | |
603 | ||
1ff31389 JD |
604 | static int client_sequence_number(struct lttng_ust_lib_ring_buffer *buf, |
605 | struct lttng_ust_shm_handle *handle, | |
606 | uint64_t *seq) | |
607 | { | |
608 | struct packet_header *header; | |
609 | ||
610 | header = client_packet_header(buf, handle); | |
3e1db88d MD |
611 | if (!header) |
612 | return -1; | |
1ff31389 JD |
613 | *seq = header->ctx.packet_seq_num; |
614 | return 0; | |
615 | } | |
616 | ||
45a00b05 JD |
617 | static int client_instance_id(struct lttng_ust_lib_ring_buffer *buf, |
618 | struct lttng_ust_shm_handle *handle, | |
619 | uint64_t *id) | |
620 | { | |
db95cf8b | 621 | *id = buf->backend.cpu; |
45a00b05 | 622 | |
45a00b05 JD |
623 | return 0; |
624 | } | |
625 | ||
82b9bde8 JD |
626 | static const |
627 | struct lttng_ust_client_lib_ring_buffer_client_cb client_cb = { | |
628 | .parent = { | |
629 | .ring_buffer_clock_read = client_ring_buffer_clock_read, | |
630 | .record_header_size = client_record_header_size, | |
631 | .subbuffer_header_size = client_packet_header_size, | |
632 | .buffer_begin = client_buffer_begin, | |
633 | .buffer_end = client_buffer_end, | |
634 | .buffer_create = client_buffer_create, | |
635 | .buffer_finalize = client_buffer_finalize, | |
a9ff648c MD |
636 | .content_size_field = client_content_size_field, |
637 | .packet_size_field = client_packet_size_field, | |
82b9bde8 | 638 | }, |
b2f3252a JD |
639 | .timestamp_begin = client_timestamp_begin, |
640 | .timestamp_end = client_timestamp_end, | |
641 | .events_discarded = client_events_discarded, | |
642 | .content_size = client_content_size, | |
643 | .packet_size = client_packet_size, | |
644 | .stream_id = client_stream_id, | |
fca361e8 | 645 | .current_timestamp = client_current_timestamp, |
1ff31389 | 646 | .sequence_number = client_sequence_number, |
45a00b05 | 647 | .instance_id = client_instance_id, |
82b9bde8 JD |
648 | }; |
649 | ||
4cfec15c | 650 | static const struct lttng_ust_lib_ring_buffer_config client_config = { |
3d1fc7fd MD |
651 | .cb.ring_buffer_clock_read = client_ring_buffer_clock_read, |
652 | .cb.record_header_size = client_record_header_size, | |
653 | .cb.subbuffer_header_size = client_packet_header_size, | |
654 | .cb.buffer_begin = client_buffer_begin, | |
655 | .cb.buffer_end = client_buffer_end, | |
656 | .cb.buffer_create = client_buffer_create, | |
657 | .cb.buffer_finalize = client_buffer_finalize, | |
a9ff648c MD |
658 | .cb.content_size_field = client_content_size_field, |
659 | .cb.packet_size_field = client_packet_size_field, | |
3d1fc7fd | 660 | |
79dfbf42 | 661 | .tsc_bits = LTTNG_COMPACT_TSC_BITS, |
3d1fc7fd | 662 | .alloc = RING_BUFFER_ALLOC_PER_CPU, |
5d61a504 | 663 | .sync = RING_BUFFER_SYNC_GLOBAL, |
3d1fc7fd MD |
664 | .mode = RING_BUFFER_MODE_TEMPLATE, |
665 | .backend = RING_BUFFER_PAGE, | |
5d61a504 | 666 | .output = RING_BUFFER_MMAP, |
3d1fc7fd | 667 | .oops = RING_BUFFER_OOPS_CONSISTENCY, |
5d61a504 | 668 | .ipi = RING_BUFFER_NO_IPI_BARRIER, |
34a91bdb | 669 | .wakeup = LTTNG_CLIENT_WAKEUP, |
c1fca457 | 670 | .client_type = LTTNG_CLIENT_TYPE, |
82b9bde8 JD |
671 | |
672 | .cb_ptr = &client_cb.parent, | |
3d1fc7fd MD |
673 | }; |
674 | ||
82b9bde8 | 675 | const struct lttng_ust_client_lib_ring_buffer_client_cb *LTTNG_CLIENT_CALLBACKS = &client_cb; |
c1fca457 | 676 | |
3d1fc7fd | 677 | static |
7dd08bec | 678 | struct lttng_channel *_channel_create(const char *name, |
a3f61e7f | 679 | void *buf_addr, |
3d1fc7fd MD |
680 | size_t subbuf_size, size_t num_subbuf, |
681 | unsigned int switch_timer_interval, | |
193183fb | 682 | unsigned int read_timer_interval, |
6ca18e66 | 683 | unsigned char *uuid, |
a9ff648c | 684 | uint32_t chan_id, |
b2c5f61a MD |
685 | const int *stream_fds, int nr_stream_fds, |
686 | int64_t blocking_timeout) | |
3d1fc7fd | 687 | { |
74d81a6c | 688 | struct lttng_channel chan_priv_init; |
a3f61e7f | 689 | struct lttng_ust_shm_handle *handle; |
74d81a6c MD |
690 | struct lttng_channel *lttng_chan; |
691 | void *priv; | |
a3f61e7f | 692 | |
74d81a6c MD |
693 | memset(&chan_priv_init, 0, sizeof(chan_priv_init)); |
694 | memcpy(chan_priv_init.uuid, uuid, LTTNG_UST_UUID_LEN); | |
6ca18e66 | 695 | chan_priv_init.id = chan_id; |
a3f61e7f | 696 | handle = channel_create(&client_config, name, |
8824f307 MD |
697 | &priv, __alignof__(struct lttng_channel), |
698 | sizeof(struct lttng_channel), | |
74d81a6c | 699 | &chan_priv_init, |
a3f61e7f | 700 | buf_addr, subbuf_size, num_subbuf, |
a9ff648c | 701 | switch_timer_interval, read_timer_interval, |
b2c5f61a | 702 | stream_fds, nr_stream_fds, blocking_timeout); |
a3f61e7f | 703 | if (!handle) |
afdf9825 | 704 | return NULL; |
7dd08bec MD |
705 | lttng_chan = priv; |
706 | lttng_chan->handle = handle; | |
74d81a6c | 707 | lttng_chan->chan = shmp(handle, handle->chan); |
7dd08bec | 708 | return lttng_chan; |
3d1fc7fd MD |
709 | } |
710 | ||
711 | static | |
74d81a6c | 712 | void lttng_channel_destroy(struct lttng_channel *chan) |
3d1fc7fd | 713 | { |
74d81a6c | 714 | channel_destroy(chan->chan, chan->handle, 1); |
3d1fc7fd MD |
715 | } |
716 | ||
717 | static | |
7dd08bec | 718 | int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx *ctx, |
3d1fc7fd MD |
719 | uint32_t event_id) |
720 | { | |
7dd08bec | 721 | struct lttng_channel *lttng_chan = channel_get_private(ctx->chan); |
e56bb47c MD |
722 | struct lttng_event *event = ctx->priv; |
723 | struct lttng_stack_ctx *lttng_ctx = ctx->priv2; | |
724 | struct lttng_client_ctx client_ctx; | |
3d1fc7fd MD |
725 | int ret, cpu; |
726 | ||
e56bb47c MD |
727 | /* Compute internal size of context structures. */ |
728 | ||
729 | if (lttng_ctx) { | |
730 | /* 2.8+ probe ABI. */ | |
731 | ctx_get_struct_size(lttng_ctx->chan_ctx, &client_ctx.packet_context_len, | |
732 | APP_CTX_ENABLED); | |
733 | ctx_get_struct_size(lttng_ctx->event_ctx, &client_ctx.event_context_len, | |
734 | APP_CTX_ENABLED); | |
735 | } else { | |
736 | /* Pre 2.8 probe ABI. */ | |
737 | ctx_get_struct_size(lttng_chan->ctx, &client_ctx.packet_context_len, | |
738 | APP_CTX_DISABLED); | |
739 | ctx_get_struct_size(event->ctx, &client_ctx.event_context_len, | |
740 | APP_CTX_DISABLED); | |
741 | } | |
742 | ||
3d1fc7fd MD |
743 | cpu = lib_ring_buffer_get_cpu(&client_config); |
744 | if (cpu < 0) | |
745 | return -EPERM; | |
746 | ctx->cpu = cpu; | |
747 | ||
7dd08bec | 748 | switch (lttng_chan->header_type) { |
3d1fc7fd MD |
749 | case 1: /* compact */ |
750 | if (event_id > 30) | |
7dd08bec | 751 | ctx->rflags |= LTTNG_RFLAG_EXTENDED; |
3d1fc7fd MD |
752 | break; |
753 | case 2: /* large */ | |
754 | if (event_id > 65534) | |
7dd08bec | 755 | ctx->rflags |= LTTNG_RFLAG_EXTENDED; |
3d1fc7fd MD |
756 | break; |
757 | default: | |
758 | WARN_ON_ONCE(1); | |
759 | } | |
760 | ||
e56bb47c | 761 | ret = lib_ring_buffer_reserve(&client_config, ctx, &client_ctx); |
630d6836 | 762 | if (caa_unlikely(ret)) |
3d1fc7fd | 763 | goto put; |
a3492932 MD |
764 | if (caa_likely(ctx->ctx_len |
765 | >= sizeof(struct lttng_ust_lib_ring_buffer_ctx))) { | |
766 | if (lib_ring_buffer_backend_get_pages(&client_config, ctx, | |
767 | &ctx->backend_pages)) { | |
768 | ret = -EPERM; | |
769 | goto put; | |
770 | } | |
771 | } | |
7dd08bec | 772 | lttng_write_event_header(&client_config, ctx, event_id); |
3d1fc7fd MD |
773 | return 0; |
774 | put: | |
775 | lib_ring_buffer_put_cpu(&client_config); | |
776 | return ret; | |
777 | } | |
778 | ||
779 | static | |
7dd08bec | 780 | void lttng_event_commit(struct lttng_ust_lib_ring_buffer_ctx *ctx) |
3d1fc7fd MD |
781 | { |
782 | lib_ring_buffer_commit(&client_config, ctx); | |
783 | lib_ring_buffer_put_cpu(&client_config); | |
784 | } | |
785 | ||
786 | static | |
7dd08bec | 787 | void lttng_event_write(struct lttng_ust_lib_ring_buffer_ctx *ctx, const void *src, |
3d1fc7fd MD |
788 | size_t len) |
789 | { | |
790 | lib_ring_buffer_write(&client_config, ctx, src, len); | |
791 | } | |
792 | ||
a44c74d9 MD |
793 | static |
794 | void lttng_event_strcpy(struct lttng_ust_lib_ring_buffer_ctx *ctx, const char *src, | |
795 | size_t len) | |
796 | { | |
797 | lib_ring_buffer_strcpy(&client_config, ctx, src, len, '#'); | |
798 | } | |
799 | ||
9f3fdbc6 | 800 | #if 0 |
3d1fc7fd | 801 | static |
7dd08bec | 802 | wait_queue_head_t *lttng_get_reader_wait_queue(struct channel *chan) |
3d1fc7fd MD |
803 | { |
804 | return &chan->read_wait; | |
805 | } | |
806 | ||
807 | static | |
7dd08bec | 808 | wait_queue_head_t *lttng_get_hp_wait_queue(struct channel *chan) |
3d1fc7fd MD |
809 | { |
810 | return &chan->hp_wait; | |
811 | } | |
9f3fdbc6 | 812 | #endif //0 |
3d1fc7fd MD |
813 | |
814 | static | |
7dd08bec | 815 | int lttng_is_finalized(struct channel *chan) |
3d1fc7fd MD |
816 | { |
817 | return lib_ring_buffer_channel_is_finalized(chan); | |
818 | } | |
819 | ||
820 | static | |
7dd08bec | 821 | int lttng_is_disabled(struct channel *chan) |
3d1fc7fd MD |
822 | { |
823 | return lib_ring_buffer_channel_is_disabled(chan); | |
824 | } | |
825 | ||
43861eab | 826 | static |
7dd08bec | 827 | int lttng_flush_buffer(struct channel *chan, struct lttng_ust_shm_handle *handle) |
43861eab | 828 | { |
4cfec15c | 829 | struct lttng_ust_lib_ring_buffer *buf; |
43861eab MD |
830 | int cpu; |
831 | ||
832 | for_each_channel_cpu(cpu, chan) { | |
74d81a6c MD |
833 | int shm_fd, wait_fd, wakeup_fd; |
834 | uint64_t memory_map_size; | |
43861eab MD |
835 | |
836 | buf = channel_get_ring_buffer(&client_config, chan, | |
837 | cpu, handle, &shm_fd, &wait_fd, | |
74d81a6c | 838 | &wakeup_fd, &memory_map_size); |
43861eab MD |
839 | lib_ring_buffer_switch(&client_config, buf, |
840 | SWITCH_ACTIVE, handle); | |
841 | } | |
842 | return 0; | |
843 | } | |
844 | ||
7dd08bec | 845 | static struct lttng_transport lttng_relay_transport = { |
818173b9 | 846 | .name = "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap", |
3d1fc7fd MD |
847 | .ops = { |
848 | .channel_create = _channel_create, | |
7dd08bec | 849 | .channel_destroy = lttng_channel_destroy, |
a44c74d9 | 850 | .u.has_strcpy = 1, |
7dd08bec MD |
851 | .event_reserve = lttng_event_reserve, |
852 | .event_commit = lttng_event_commit, | |
853 | .event_write = lttng_event_write, | |
3d1fc7fd | 854 | .packet_avail_size = NULL, /* Would be racy anyway */ |
7dd08bec MD |
855 | //.get_reader_wait_queue = lttng_get_reader_wait_queue, |
856 | //.get_hp_wait_queue = lttng_get_hp_wait_queue, | |
857 | .is_finalized = lttng_is_finalized, | |
858 | .is_disabled = lttng_is_disabled, | |
859 | .flush_buffer = lttng_flush_buffer, | |
a44c74d9 | 860 | .event_strcpy = lttng_event_strcpy, |
3d1fc7fd | 861 | }, |
74d81a6c | 862 | .client_config = &client_config, |
3d1fc7fd MD |
863 | }; |
864 | ||
edaa1431 | 865 | void RING_BUFFER_MODE_TEMPLATE_INIT(void) |
3d1fc7fd | 866 | { |
34a91bdb MD |
867 | DBG("LTT : ltt ring buffer client \"%s\" init\n", |
868 | "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap"); | |
7dd08bec | 869 | lttng_transport_register(<tng_relay_transport); |
3d1fc7fd MD |
870 | } |
871 | ||
edaa1431 | 872 | void RING_BUFFER_MODE_TEMPLATE_EXIT(void) |
3d1fc7fd | 873 | { |
34a91bdb MD |
874 | DBG("LTT : ltt ring buffer client \"%s\" exit\n", |
875 | "relay-" RING_BUFFER_MODE_TEMPLATE_STRING "-mmap"); | |
7dd08bec | 876 | lttng_transport_unregister(<tng_relay_transport); |
3d1fc7fd | 877 | } |