2 * lttng-ring-buffer-client.h
4 * LTTng lib ring buffer client template.
6 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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.
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.
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
25 #include <lttng/ust-events.h>
26 #include "lttng/bitfield.h"
28 #include "lttng-tracer.h"
29 #include "../libringbuffer/frontend_types.h"
31 #define LTTNG_COMPACT_EVENT_BITS 5
32 #define LTTNG_COMPACT_TSC_BITS 27
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.
46 struct packet_header
{
47 /* Trace packet header */
50 * contains endianness information.
52 uint8_t uuid
[LTTNG_UST_UUID_LEN
];
54 uint64_t stream_instance_id
;
57 /* Stream packet context */
58 uint64_t timestamp_begin
; /* Cycle count at subbuffer start */
59 uint64_t timestamp_end
; /* Cycle count at subbuffer end */
60 uint64_t content_size
; /* Size of data in subbuffer */
61 uint64_t packet_size
; /* Subbuffer size (include padding) */
62 uint64_t packet_seq_num
; /* Packet sequence number */
63 unsigned long events_discarded
; /*
64 * Events lost in this subbuffer since
65 * the beginning of the trace.
68 uint32_t cpu_id
; /* CPU id associated with stream */
69 uint8_t header_end
; /* End of header */
73 struct lttng_client_ctx
{
74 size_t packet_context_len
;
75 size_t event_context_len
;
78 static inline uint64_t lib_ring_buffer_clock_read(struct channel
*chan
)
80 return trace_clock_read64();
84 size_t ctx_get_aligned_size(size_t offset
, struct lttng_ctx
*ctx
,
87 size_t orig_offset
= offset
;
91 offset
+= lib_ring_buffer_align(offset
, ctx
->largest_align
);
93 return offset
- orig_offset
;
97 void ctx_get_struct_size(struct lttng_ctx
*ctx
, size_t *ctx_len
,
98 enum app_ctx_mode mode
)
103 if (caa_likely(!ctx
)) {
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
);
111 if (lttng_context_is_app(ctx
->fields
[i
].event_field
.name
)) {
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.
122 offset
+= lttng_ust_dummy_get_size(&ctx
->fields
[i
], offset
);
124 offset
+= ctx
->fields
[i
].get_size(&ctx
->fields
[i
], offset
);
132 void ctx_record(struct lttng_ust_lib_ring_buffer_ctx
*bufctx
,
133 struct lttng_channel
*chan
,
134 struct lttng_ctx
*ctx
,
135 enum app_ctx_mode mode
)
139 if (caa_likely(!ctx
))
141 lib_ring_buffer_align_ctx(bufctx
, ctx
->largest_align
);
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
);
146 if (lttng_context_is_app(ctx
->fields
[i
].event_field
.name
)) {
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.
157 lttng_ust_dummy_record(&ctx
->fields
[i
], bufctx
, chan
);
159 ctx
->fields
[i
].record(&ctx
->fields
[i
], bufctx
, chan
);
166 * record_header_size - Calculate the header size and padding necessary.
167 * @config: ring buffer instance configuration
169 * @offset: offset in the write buffer
170 * @pre_header_padding: padding to add before the header (output)
171 * @ctx: reservation context
173 * Returns the event header size (including padding).
175 * The payload must itself determine its own alignment from the biggest type it
179 size_t record_header_size(const struct lttng_ust_lib_ring_buffer_config
*config
,
180 struct channel
*chan
, size_t offset
,
181 size_t *pre_header_padding
,
182 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
183 struct lttng_client_ctx
*client_ctx
)
185 struct lttng_channel
*lttng_chan
= channel_get_private(chan
);
186 struct lttng_event
*event
= ctx
->priv
;
187 struct lttng_stack_ctx
*lttng_ctx
= ctx
->priv2
;
188 size_t orig_offset
= offset
;
191 switch (lttng_chan
->header_type
) {
192 case 1: /* compact */
193 padding
= lib_ring_buffer_align(offset
, lttng_alignof(uint32_t));
195 if (!(ctx
->rflags
& (RING_BUFFER_RFLAG_FULL_TSC
| LTTNG_RFLAG_EXTENDED
))) {
196 offset
+= sizeof(uint32_t); /* id and timestamp */
198 /* Minimum space taken by LTTNG_COMPACT_EVENT_BITS id */
199 offset
+= (LTTNG_COMPACT_EVENT_BITS
+ CHAR_BIT
- 1) / CHAR_BIT
;
200 /* Align extended struct on largest member */
201 offset
+= lib_ring_buffer_align(offset
, lttng_alignof(uint64_t));
202 offset
+= sizeof(uint32_t); /* id */
203 offset
+= lib_ring_buffer_align(offset
, lttng_alignof(uint64_t));
204 offset
+= sizeof(uint64_t); /* timestamp */
208 padding
= lib_ring_buffer_align(offset
, lttng_alignof(uint16_t));
210 offset
+= sizeof(uint16_t);
211 if (!(ctx
->rflags
& (RING_BUFFER_RFLAG_FULL_TSC
| LTTNG_RFLAG_EXTENDED
))) {
212 offset
+= lib_ring_buffer_align(offset
, lttng_alignof(uint32_t));
213 offset
+= sizeof(uint32_t); /* timestamp */
215 /* Align extended struct on largest member */
216 offset
+= lib_ring_buffer_align(offset
, lttng_alignof(uint64_t));
217 offset
+= sizeof(uint32_t); /* id */
218 offset
+= lib_ring_buffer_align(offset
, lttng_alignof(uint64_t));
219 offset
+= sizeof(uint64_t); /* timestamp */
227 /* 2.8+ probe ABI. */
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
);
233 /* Pre 2.8 probe ABI. */
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
);
239 *pre_header_padding
= padding
;
240 return offset
- orig_offset
;
243 #include "../libringbuffer/api.h"
244 #include "lttng-rb-clients.h"
247 void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config
*config
,
248 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
252 * lttng_write_event_header
254 * Writes the event header to the offset (already aligned on 32-bits).
256 * @config: ring buffer instance configuration
257 * @ctx: reservation context
258 * @event_id: event ID
261 void lttng_write_event_header(const struct lttng_ust_lib_ring_buffer_config
*config
,
262 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
265 struct lttng_channel
*lttng_chan
= channel_get_private(ctx
->chan
);
266 struct lttng_event
*event
= ctx
->priv
;
267 struct lttng_stack_ctx
*lttng_ctx
= ctx
->priv2
;
269 if (caa_unlikely(ctx
->rflags
))
272 switch (lttng_chan
->header_type
) {
273 case 1: /* compact */
275 uint32_t id_time
= 0;
277 bt_bitfield_write(&id_time
, uint32_t,
279 LTTNG_COMPACT_EVENT_BITS
,
281 bt_bitfield_write(&id_time
, uint32_t,
282 LTTNG_COMPACT_EVENT_BITS
,
283 LTTNG_COMPACT_TSC_BITS
,
285 lib_ring_buffer_write(config
, ctx
, &id_time
, sizeof(id_time
));
290 uint32_t timestamp
= (uint32_t) ctx
->tsc
;
291 uint16_t id
= event_id
;
293 lib_ring_buffer_write(config
, ctx
, &id
, sizeof(id
));
294 lib_ring_buffer_align_ctx(ctx
, lttng_alignof(uint32_t));
295 lib_ring_buffer_write(config
, ctx
, ×tamp
, sizeof(timestamp
));
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
);
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
);
311 lib_ring_buffer_align_ctx(ctx
, ctx
->largest_align
);
316 lttng_write_event_header_slow(config
, ctx
, event_id
);
320 void lttng_write_event_header_slow(const struct lttng_ust_lib_ring_buffer_config
*config
,
321 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
324 struct lttng_channel
*lttng_chan
= channel_get_private(ctx
->chan
);
325 struct lttng_event
*event
= ctx
->priv
;
326 struct lttng_stack_ctx
*lttng_ctx
= ctx
->priv2
;
328 switch (lttng_chan
->header_type
) {
329 case 1: /* compact */
330 if (!(ctx
->rflags
& (RING_BUFFER_RFLAG_FULL_TSC
| LTTNG_RFLAG_EXTENDED
))) {
331 uint32_t id_time
= 0;
333 bt_bitfield_write(&id_time
, uint32_t,
335 LTTNG_COMPACT_EVENT_BITS
,
337 bt_bitfield_write(&id_time
, uint32_t,
338 LTTNG_COMPACT_EVENT_BITS
,
339 LTTNG_COMPACT_TSC_BITS
,
341 lib_ring_buffer_write(config
, ctx
, &id_time
, sizeof(id_time
));
344 uint64_t timestamp
= ctx
->tsc
;
346 bt_bitfield_write(&id
, uint8_t,
348 LTTNG_COMPACT_EVENT_BITS
,
350 lib_ring_buffer_write(config
, ctx
, &id
, sizeof(id
));
351 /* Align extended struct on largest member */
352 lib_ring_buffer_align_ctx(ctx
, lttng_alignof(uint64_t));
353 lib_ring_buffer_write(config
, ctx
, &event_id
, sizeof(event_id
));
354 lib_ring_buffer_align_ctx(ctx
, lttng_alignof(uint64_t));
355 lib_ring_buffer_write(config
, ctx
, ×tamp
, sizeof(timestamp
));
360 if (!(ctx
->rflags
& (RING_BUFFER_RFLAG_FULL_TSC
| LTTNG_RFLAG_EXTENDED
))) {
361 uint32_t timestamp
= (uint32_t) ctx
->tsc
;
362 uint16_t id
= event_id
;
364 lib_ring_buffer_write(config
, ctx
, &id
, sizeof(id
));
365 lib_ring_buffer_align_ctx(ctx
, lttng_alignof(uint32_t));
366 lib_ring_buffer_write(config
, ctx
, ×tamp
, sizeof(timestamp
));
369 uint64_t timestamp
= ctx
->tsc
;
371 lib_ring_buffer_write(config
, ctx
, &id
, sizeof(id
));
372 /* Align extended struct on largest member */
373 lib_ring_buffer_align_ctx(ctx
, lttng_alignof(uint64_t));
374 lib_ring_buffer_write(config
, ctx
, &event_id
, sizeof(event_id
));
375 lib_ring_buffer_align_ctx(ctx
, lttng_alignof(uint64_t));
376 lib_ring_buffer_write(config
, ctx
, ×tamp
, sizeof(timestamp
));
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
);
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
);
392 lib_ring_buffer_align_ctx(ctx
, ctx
->largest_align
);
395 static const struct lttng_ust_lib_ring_buffer_config client_config
;
397 static uint64_t client_ring_buffer_clock_read(struct channel
*chan
)
399 return lib_ring_buffer_clock_read(chan
);
403 size_t client_record_header_size(const struct lttng_ust_lib_ring_buffer_config
*config
,
404 struct channel
*chan
, size_t offset
,
405 size_t *pre_header_padding
,
406 struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
409 return record_header_size(config
, chan
, offset
,
410 pre_header_padding
, ctx
, client_ctx
);
414 * client_packet_header_size - called on buffer-switch to a new sub-buffer
416 * Return header size without padding after the structure. Don't use packed
417 * structure because gcc generates inefficient code on some architectures
420 static size_t client_packet_header_size(void)
422 return offsetof(struct packet_header
, ctx
.header_end
);
425 static void client_buffer_begin(struct lttng_ust_lib_ring_buffer
*buf
, uint64_t tsc
,
426 unsigned int subbuf_idx
,
427 struct lttng_ust_shm_handle
*handle
)
429 struct channel
*chan
= shmp(handle
, buf
->backend
.chan
);
430 struct packet_header
*header
=
431 (struct packet_header
*)
432 lib_ring_buffer_offset_address(&buf
->backend
,
433 subbuf_idx
* chan
->backend
.subbuf_size
,
435 struct lttng_channel
*lttng_chan
= channel_get_private(chan
);
436 uint64_t cnt
= shmp_index(handle
, buf
->backend
.buf_cnt
, subbuf_idx
)->seq_cnt
;
441 header
->magic
= CTF_MAGIC_NUMBER
;
442 memcpy(header
->uuid
, lttng_chan
->uuid
, sizeof(lttng_chan
->uuid
));
443 header
->stream_id
= lttng_chan
->id
;
444 header
->stream_instance_id
= buf
->backend
.cpu
;
445 header
->ctx
.timestamp_begin
= tsc
;
446 header
->ctx
.timestamp_end
= 0;
447 header
->ctx
.content_size
= ~0ULL; /* for debugging */
448 header
->ctx
.packet_size
= ~0ULL;
449 header
->ctx
.packet_seq_num
= chan
->backend
.num_subbuf
* cnt
+ subbuf_idx
;
450 header
->ctx
.events_discarded
= 0;
451 header
->ctx
.cpu_id
= buf
->backend
.cpu
;
455 * offset is assumed to never be 0 here : never deliver a completely empty
456 * subbuffer. data_size is between 1 and subbuf_size.
458 static void client_buffer_end(struct lttng_ust_lib_ring_buffer
*buf
, uint64_t tsc
,
459 unsigned int subbuf_idx
, unsigned long data_size
,
460 struct lttng_ust_shm_handle
*handle
)
462 struct channel
*chan
= shmp(handle
, buf
->backend
.chan
);
463 struct packet_header
*header
=
464 (struct packet_header
*)
465 lib_ring_buffer_offset_address(&buf
->backend
,
466 subbuf_idx
* chan
->backend
.subbuf_size
,
468 unsigned long records_lost
= 0;
473 header
->ctx
.timestamp_end
= tsc
;
474 header
->ctx
.content_size
=
475 (uint64_t) data_size
* CHAR_BIT
; /* in bits */
476 header
->ctx
.packet_size
=
477 (uint64_t) LTTNG_UST_PAGE_ALIGN(data_size
) * CHAR_BIT
; /* in bits */
479 records_lost
+= lib_ring_buffer_get_records_lost_full(&client_config
, buf
);
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
;
485 static int client_buffer_create(struct lttng_ust_lib_ring_buffer
*buf
, void *priv
,
486 int cpu
, const char *name
, struct lttng_ust_shm_handle
*handle
)
491 static void client_buffer_finalize(struct lttng_ust_lib_ring_buffer
*buf
, void *priv
, int cpu
, struct lttng_ust_shm_handle
*handle
)
495 static void client_content_size_field(const struct lttng_ust_lib_ring_buffer_config
*config
,
496 size_t *offset
, size_t *length
)
498 *offset
= offsetof(struct packet_header
, ctx
.content_size
);
499 *length
= sizeof(((struct packet_header
*) NULL
)->ctx
.content_size
);
502 static void client_packet_size_field(const struct lttng_ust_lib_ring_buffer_config
*config
,
503 size_t *offset
, size_t *length
)
505 *offset
= offsetof(struct packet_header
, ctx
.packet_size
);
506 *length
= sizeof(((struct packet_header
*) NULL
)->ctx
.packet_size
);
509 static struct packet_header
*client_packet_header(struct lttng_ust_lib_ring_buffer
*buf
,
510 struct lttng_ust_shm_handle
*handle
)
512 return lib_ring_buffer_read_offset_address(&buf
->backend
, 0, handle
);
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
)
519 struct packet_header
*header
;
521 header
= client_packet_header(buf
, handle
);
524 *timestamp_begin
= header
->ctx
.timestamp_begin
;
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
)
532 struct packet_header
*header
;
534 header
= client_packet_header(buf
, handle
);
537 *timestamp_end
= header
->ctx
.timestamp_end
;
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
)
545 struct packet_header
*header
;
547 header
= client_packet_header(buf
, handle
);
550 *events_discarded
= header
->ctx
.events_discarded
;
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
)
558 struct packet_header
*header
;
560 header
= client_packet_header(buf
, handle
);
563 *content_size
= header
->ctx
.content_size
;
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
)
571 struct packet_header
*header
;
573 header
= client_packet_header(buf
, handle
);
576 *packet_size
= header
->ctx
.packet_size
;
580 static int client_stream_id(struct lttng_ust_lib_ring_buffer
*buf
,
581 struct lttng_ust_shm_handle
*handle
,
584 struct channel
*chan
= shmp(handle
, buf
->backend
.chan
);
585 struct lttng_channel
*lttng_chan
= channel_get_private(chan
);
587 *stream_id
= lttng_chan
->id
;
592 static int client_current_timestamp(struct lttng_ust_lib_ring_buffer
*buf
,
593 struct lttng_ust_shm_handle
*handle
,
596 struct channel
*chan
;
598 chan
= shmp(handle
, handle
->chan
);
599 *ts
= client_ring_buffer_clock_read(chan
);
604 static int client_sequence_number(struct lttng_ust_lib_ring_buffer
*buf
,
605 struct lttng_ust_shm_handle
*handle
,
608 struct packet_header
*header
;
610 header
= client_packet_header(buf
, handle
);
613 *seq
= header
->ctx
.packet_seq_num
;
617 static int client_instance_id(struct lttng_ust_lib_ring_buffer
*buf
,
618 struct lttng_ust_shm_handle
*handle
,
621 *id
= buf
->backend
.cpu
;
627 struct lttng_ust_client_lib_ring_buffer_client_cb client_cb
= {
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
,
636 .content_size_field
= client_content_size_field
,
637 .packet_size_field
= client_packet_size_field
,
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
,
645 .current_timestamp
= client_current_timestamp
,
646 .sequence_number
= client_sequence_number
,
647 .instance_id
= client_instance_id
,
650 static const struct lttng_ust_lib_ring_buffer_config client_config
= {
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
,
658 .cb
.content_size_field
= client_content_size_field
,
659 .cb
.packet_size_field
= client_packet_size_field
,
661 .tsc_bits
= LTTNG_COMPACT_TSC_BITS
,
662 .alloc
= RING_BUFFER_ALLOC_PER_CPU
,
663 .sync
= RING_BUFFER_SYNC_GLOBAL
,
664 .mode
= RING_BUFFER_MODE_TEMPLATE
,
665 .backend
= RING_BUFFER_PAGE
,
666 .output
= RING_BUFFER_MMAP
,
667 .oops
= RING_BUFFER_OOPS_CONSISTENCY
,
668 .ipi
= RING_BUFFER_NO_IPI_BARRIER
,
669 .wakeup
= LTTNG_CLIENT_WAKEUP
,
670 .client_type
= LTTNG_CLIENT_TYPE
,
672 .cb_ptr
= &client_cb
.parent
,
675 const struct lttng_ust_client_lib_ring_buffer_client_cb
*LTTNG_CLIENT_CALLBACKS
= &client_cb
;
678 struct lttng_channel
*_channel_create(const char *name
,
680 size_t subbuf_size
, size_t num_subbuf
,
681 unsigned int switch_timer_interval
,
682 unsigned int read_timer_interval
,
685 const int *stream_fds
, int nr_stream_fds
,
686 int64_t blocking_timeout
)
688 struct lttng_channel chan_priv_init
;
689 struct lttng_ust_shm_handle
*handle
;
690 struct lttng_channel
*lttng_chan
;
693 memset(&chan_priv_init
, 0, sizeof(chan_priv_init
));
694 memcpy(chan_priv_init
.uuid
, uuid
, LTTNG_UST_UUID_LEN
);
695 chan_priv_init
.id
= chan_id
;
696 handle
= channel_create(&client_config
, name
,
697 &priv
, __alignof__(struct lttng_channel
),
698 sizeof(struct lttng_channel
),
700 buf_addr
, subbuf_size
, num_subbuf
,
701 switch_timer_interval
, read_timer_interval
,
702 stream_fds
, nr_stream_fds
, blocking_timeout
);
706 lttng_chan
->handle
= handle
;
707 lttng_chan
->chan
= shmp(handle
, handle
->chan
);
712 void lttng_channel_destroy(struct lttng_channel
*chan
)
714 channel_destroy(chan
->chan
, chan
->handle
, 1);
718 int lttng_event_reserve(struct lttng_ust_lib_ring_buffer_ctx
*ctx
,
721 struct lttng_channel
*lttng_chan
= channel_get_private(ctx
->chan
);
722 struct lttng_event
*event
= ctx
->priv
;
723 struct lttng_stack_ctx
*lttng_ctx
= ctx
->priv2
;
724 struct lttng_client_ctx client_ctx
;
727 /* Compute internal size of context structures. */
730 /* 2.8+ probe ABI. */
731 ctx_get_struct_size(lttng_ctx
->chan_ctx
, &client_ctx
.packet_context_len
,
733 ctx_get_struct_size(lttng_ctx
->event_ctx
, &client_ctx
.event_context_len
,
736 /* Pre 2.8 probe ABI. */
737 ctx_get_struct_size(lttng_chan
->ctx
, &client_ctx
.packet_context_len
,
739 ctx_get_struct_size(event
->ctx
, &client_ctx
.event_context_len
,
743 cpu
= lib_ring_buffer_get_cpu(&client_config
);
748 switch (lttng_chan
->header_type
) {
749 case 1: /* compact */
751 ctx
->rflags
|= LTTNG_RFLAG_EXTENDED
;
754 if (event_id
> 65534)
755 ctx
->rflags
|= LTTNG_RFLAG_EXTENDED
;
761 ret
= lib_ring_buffer_reserve(&client_config
, ctx
, &client_ctx
);
762 if (caa_unlikely(ret
))
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
)) {
772 lttng_write_event_header(&client_config
, ctx
, event_id
);
775 lib_ring_buffer_put_cpu(&client_config
);
780 void lttng_event_commit(struct lttng_ust_lib_ring_buffer_ctx
*ctx
)
782 lib_ring_buffer_commit(&client_config
, ctx
);
783 lib_ring_buffer_put_cpu(&client_config
);
787 void lttng_event_write(struct lttng_ust_lib_ring_buffer_ctx
*ctx
, const void *src
,
790 lib_ring_buffer_write(&client_config
, ctx
, src
, len
);
794 void lttng_event_strcpy(struct lttng_ust_lib_ring_buffer_ctx
*ctx
, const char *src
,
797 lib_ring_buffer_strcpy(&client_config
, ctx
, src
, len
, '#');
802 wait_queue_head_t
*lttng_get_reader_wait_queue(struct channel
*chan
)
804 return &chan
->read_wait
;
808 wait_queue_head_t
*lttng_get_hp_wait_queue(struct channel
*chan
)
810 return &chan
->hp_wait
;
815 int lttng_is_finalized(struct channel
*chan
)
817 return lib_ring_buffer_channel_is_finalized(chan
);
821 int lttng_is_disabled(struct channel
*chan
)
823 return lib_ring_buffer_channel_is_disabled(chan
);
827 int lttng_flush_buffer(struct channel
*chan
, struct lttng_ust_shm_handle
*handle
)
829 struct lttng_ust_lib_ring_buffer
*buf
;
832 for_each_channel_cpu(cpu
, chan
) {
833 int shm_fd
, wait_fd
, wakeup_fd
;
834 uint64_t memory_map_size
;
836 buf
= channel_get_ring_buffer(&client_config
, chan
,
837 cpu
, handle
, &shm_fd
, &wait_fd
,
838 &wakeup_fd
, &memory_map_size
);
839 lib_ring_buffer_switch(&client_config
, buf
,
840 SWITCH_ACTIVE
, handle
);
845 static struct lttng_transport lttng_relay_transport
= {
846 .name
= "relay-" RING_BUFFER_MODE_TEMPLATE_STRING
"-mmap",
848 .channel_create
= _channel_create
,
849 .channel_destroy
= lttng_channel_destroy
,
850 .event_reserve
= lttng_event_reserve
,
851 .event_commit
= lttng_event_commit
,
852 .event_write
= lttng_event_write
,
853 .packet_avail_size
= NULL
, /* Would be racy anyway */
854 .is_finalized
= lttng_is_finalized
,
855 .is_disabled
= lttng_is_disabled
,
856 .flush_buffer
= lttng_flush_buffer
,
857 .event_strcpy
= lttng_event_strcpy
,
859 .client_config
= &client_config
,
862 void RING_BUFFER_MODE_TEMPLATE_INIT(void)
864 DBG("LTT : ltt ring buffer client \"%s\" init\n",
865 "relay-" RING_BUFFER_MODE_TEMPLATE_STRING
"-mmap");
866 lttng_transport_register(<tng_relay_transport
);
869 void RING_BUFFER_MODE_TEMPLATE_EXIT(void)
871 DBG("LTT : ltt ring buffer client \"%s\" exit\n",
872 "relay-" RING_BUFFER_MODE_TEMPLATE_STRING
"-mmap");
873 lttng_transport_unregister(<tng_relay_transport
);