2 * SPDX-License-Identifier: GPL-2.0-only
4 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
5 * Copyright (C) 2011-2013 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
12 #include <sys/types.h>
13 #include <sys/socket.h>
15 #include <lttng/ust-config.h>
16 #include <lttng/ust-ctl.h>
17 #include <lttng/ust-abi.h>
18 #include <lttng/ust-endian.h>
20 #include <usterr-signal-safe.h>
22 #include <ust-helper.h>
23 #include "ust-compat.h"
25 #include "../libringbuffer/backend.h"
26 #include "../libringbuffer/frontend.h"
27 #include "../liblttng-ust/ust-events-internal.h"
28 #include "../liblttng-ust/wait.h"
29 #include "../liblttng-ust/lttng-rb-clients.h"
30 #include "../liblttng-ust/clock.h"
31 #include "../liblttng-ust/getenv.h"
32 #include "../liblttng-ust/lttng-tracer-core.h"
33 #include "../liblttng-ust/lttng-counter-client.h"
35 #include "../libcounter/shm.h"
36 #include "../libcounter/smp.h"
37 #include "../libcounter/counter.h"
40 * Number of milliseconds to retry before failing metadata writes on
41 * buffer full condition. (10 seconds)
43 #define LTTNG_METADATA_TIMEOUT_MSEC 10000
46 * Channel representation within consumer.
48 struct ustctl_consumer_channel
{
49 struct lttng_ust_channel_buffer
*chan
; /* lttng channel buffers */
51 /* initial attributes */
52 struct ustctl_consumer_channel_attr attr
;
53 int wait_fd
; /* monitor close() */
54 int wakeup_fd
; /* monitor close() */
58 * Stream representation within consumer.
60 struct ustctl_consumer_stream
{
61 struct lttng_ust_lib_ring_buffer
*buf
;
62 struct ustctl_consumer_channel
*chan
;
63 int shm_fd
, wait_fd
, wakeup_fd
;
65 uint64_t memory_map_size
;
68 #define USTCTL_COUNTER_ATTR_DIMENSION_MAX 8
69 struct ustctl_counter_attr
{
70 enum ustctl_counter_arithmetic arithmetic
;
71 enum ustctl_counter_bitness bitness
;
72 uint32_t nr_dimensions
;
73 int64_t global_sum_step
;
74 struct ustctl_counter_dimension dimensions
[USTCTL_COUNTER_ATTR_DIMENSION_MAX
];
79 * Counter representation within daemon.
81 struct ustctl_daemon_counter
{
82 struct lib_counter
*counter
;
83 const struct lttng_counter_ops
*ops
;
84 struct ustctl_counter_attr
*attr
; /* initial attributes */
87 extern void lttng_ring_buffer_client_overwrite_init(void);
88 extern void lttng_ring_buffer_client_overwrite_rt_init(void);
89 extern void lttng_ring_buffer_client_discard_init(void);
90 extern void lttng_ring_buffer_client_discard_rt_init(void);
91 extern void lttng_ring_buffer_metadata_client_init(void);
92 extern void lttng_ring_buffer_client_overwrite_exit(void);
93 extern void lttng_ring_buffer_client_overwrite_rt_exit(void);
94 extern void lttng_ring_buffer_client_discard_exit(void);
95 extern void lttng_ring_buffer_client_discard_rt_exit(void);
96 extern void lttng_ring_buffer_metadata_client_exit(void);
98 int ustctl_release_handle(int sock
, int handle
)
100 struct ustcomm_ust_msg lum
;
101 struct ustcomm_ust_reply lur
;
103 if (sock
< 0 || handle
< 0)
105 memset(&lum
, 0, sizeof(lum
));
107 lum
.cmd
= LTTNG_UST_ABI_RELEASE
;
108 return ustcomm_send_app_cmd(sock
, &lum
, &lur
);
112 * If sock is negative, it means we don't have to notify the other side
113 * (e.g. application has already vanished).
115 int ustctl_release_object(int sock
, struct lttng_ust_abi_object_data
*data
)
122 switch (data
->type
) {
123 case LTTNG_UST_ABI_OBJECT_TYPE_CHANNEL
:
124 if (data
->u
.channel
.wakeup_fd
>= 0) {
125 ret
= close(data
->u
.channel
.wakeup_fd
);
130 data
->u
.channel
.wakeup_fd
= -1;
132 free(data
->u
.channel
.data
);
133 data
->u
.channel
.data
= NULL
;
135 case LTTNG_UST_ABI_OBJECT_TYPE_STREAM
:
136 if (data
->u
.stream
.shm_fd
>= 0) {
137 ret
= close(data
->u
.stream
.shm_fd
);
142 data
->u
.stream
.shm_fd
= -1;
144 if (data
->u
.stream
.wakeup_fd
>= 0) {
145 ret
= close(data
->u
.stream
.wakeup_fd
);
150 data
->u
.stream
.wakeup_fd
= -1;
153 case LTTNG_UST_ABI_OBJECT_TYPE_EVENT
:
154 case LTTNG_UST_ABI_OBJECT_TYPE_CONTEXT
:
155 case LTTNG_UST_ABI_OBJECT_TYPE_EVENT_NOTIFIER_GROUP
:
156 case LTTNG_UST_ABI_OBJECT_TYPE_EVENT_NOTIFIER
:
158 case LTTNG_UST_ABI_OBJECT_TYPE_COUNTER
:
159 free(data
->u
.counter
.data
);
160 data
->u
.counter
.data
= NULL
;
162 case LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_GLOBAL
:
163 if (data
->u
.counter_global
.shm_fd
>= 0) {
164 ret
= close(data
->u
.counter_global
.shm_fd
);
169 data
->u
.counter_global
.shm_fd
= -1;
172 case LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_CPU
:
173 if (data
->u
.counter_cpu
.shm_fd
>= 0) {
174 ret
= close(data
->u
.counter_cpu
.shm_fd
);
179 data
->u
.counter_cpu
.shm_fd
= -1;
185 return ustctl_release_handle(sock
, data
->handle
);
189 * Send registration done packet to the application.
191 int ustctl_register_done(int sock
)
193 struct ustcomm_ust_msg lum
;
194 struct ustcomm_ust_reply lur
;
197 DBG("Sending register done command to %d", sock
);
198 memset(&lum
, 0, sizeof(lum
));
199 lum
.handle
= LTTNG_UST_ABI_ROOT_HANDLE
;
200 lum
.cmd
= LTTNG_UST_ABI_REGISTER_DONE
;
201 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
208 * returns session handle.
210 int ustctl_create_session(int sock
)
212 struct ustcomm_ust_msg lum
;
213 struct ustcomm_ust_reply lur
;
214 int ret
, session_handle
;
217 memset(&lum
, 0, sizeof(lum
));
218 lum
.handle
= LTTNG_UST_ABI_ROOT_HANDLE
;
219 lum
.cmd
= LTTNG_UST_ABI_SESSION
;
220 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
223 session_handle
= lur
.ret_val
;
224 DBG("received session handle %u", session_handle
);
225 return session_handle
;
228 int ustctl_create_event(int sock
, struct lttng_ust_abi_event
*ev
,
229 struct lttng_ust_abi_object_data
*channel_data
,
230 struct lttng_ust_abi_object_data
**_event_data
)
232 struct ustcomm_ust_msg lum
;
233 struct ustcomm_ust_reply lur
;
234 struct lttng_ust_abi_object_data
*event_data
;
237 if (!channel_data
|| !_event_data
)
240 event_data
= zmalloc(sizeof(*event_data
));
243 event_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_EVENT
;
244 memset(&lum
, 0, sizeof(lum
));
245 lum
.handle
= channel_data
->handle
;
246 lum
.cmd
= LTTNG_UST_ABI_EVENT
;
247 strncpy(lum
.u
.event
.name
, ev
->name
,
248 LTTNG_UST_ABI_SYM_NAME_LEN
);
249 lum
.u
.event
.instrumentation
= ev
->instrumentation
;
250 lum
.u
.event
.loglevel_type
= ev
->loglevel_type
;
251 lum
.u
.event
.loglevel
= ev
->loglevel
;
252 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
257 event_data
->handle
= lur
.ret_val
;
258 DBG("received event handle %u", event_data
->handle
);
259 *_event_data
= event_data
;
263 int ustctl_add_context(int sock
, struct lttng_ust_context_attr
*ctx
,
264 struct lttng_ust_abi_object_data
*obj_data
,
265 struct lttng_ust_abi_object_data
**_context_data
)
267 struct ustcomm_ust_msg lum
;
268 struct ustcomm_ust_reply lur
;
269 struct lttng_ust_abi_object_data
*context_data
= NULL
;
274 if (!obj_data
|| !_context_data
) {
279 context_data
= zmalloc(sizeof(*context_data
));
284 context_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_CONTEXT
;
285 memset(&lum
, 0, sizeof(lum
));
286 lum
.handle
= obj_data
->handle
;
287 lum
.cmd
= LTTNG_UST_ABI_CONTEXT
;
289 lum
.u
.context
.ctx
= ctx
->ctx
;
291 case LTTNG_UST_ABI_CONTEXT_PERF_THREAD_COUNTER
:
292 lum
.u
.context
.u
.perf_counter
= ctx
->u
.perf_counter
;
294 case LTTNG_UST_ABI_CONTEXT_APP_CONTEXT
:
296 size_t provider_name_len
= strlen(
297 ctx
->u
.app_ctx
.provider_name
) + 1;
298 size_t ctx_name_len
= strlen(ctx
->u
.app_ctx
.ctx_name
) + 1;
300 lum
.u
.context
.u
.app_ctx
.provider_name_len
= provider_name_len
;
301 lum
.u
.context
.u
.app_ctx
.ctx_name_len
= ctx_name_len
;
303 len
= provider_name_len
+ ctx_name_len
;
309 memcpy(buf
, ctx
->u
.app_ctx
.provider_name
,
311 memcpy(buf
+ provider_name_len
, ctx
->u
.app_ctx
.ctx_name
,
318 ret
= ustcomm_send_app_msg(sock
, &lum
);
322 /* send var len ctx_name */
323 ret
= ustcomm_send_unix_sock(sock
, buf
, len
);
332 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
336 context_data
->handle
= -1;
337 DBG("Context created successfully");
338 *_context_data
= context_data
;
346 int ustctl_set_filter(int sock
, struct lttng_ust_abi_filter_bytecode
*bytecode
,
347 struct lttng_ust_abi_object_data
*obj_data
)
349 struct ustcomm_ust_msg lum
;
350 struct ustcomm_ust_reply lur
;
356 memset(&lum
, 0, sizeof(lum
));
357 lum
.handle
= obj_data
->handle
;
358 lum
.cmd
= LTTNG_UST_ABI_FILTER
;
359 lum
.u
.filter
.data_size
= bytecode
->len
;
360 lum
.u
.filter
.reloc_offset
= bytecode
->reloc_offset
;
361 lum
.u
.filter
.seqnum
= bytecode
->seqnum
;
363 ret
= ustcomm_send_app_msg(sock
, &lum
);
366 /* send var len bytecode */
367 ret
= ustcomm_send_unix_sock(sock
, bytecode
->data
,
372 if (ret
!= bytecode
->len
)
374 return ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
377 int ustctl_set_capture(int sock
, struct lttng_ust_abi_capture_bytecode
*bytecode
,
378 struct lttng_ust_abi_object_data
*obj_data
)
380 struct ustcomm_ust_msg lum
;
381 struct ustcomm_ust_reply lur
;
387 memset(&lum
, 0, sizeof(lum
));
388 lum
.handle
= obj_data
->handle
;
389 lum
.cmd
= LTTNG_UST_ABI_CAPTURE
;
390 lum
.u
.capture
.data_size
= bytecode
->len
;
391 lum
.u
.capture
.reloc_offset
= bytecode
->reloc_offset
;
392 lum
.u
.capture
.seqnum
= bytecode
->seqnum
;
394 ret
= ustcomm_send_app_msg(sock
, &lum
);
397 /* send var len bytecode */
398 ret
= ustcomm_send_unix_sock(sock
, bytecode
->data
,
403 if (ret
!= bytecode
->len
)
405 return ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
408 int ustctl_set_exclusion(int sock
, struct lttng_ust_abi_event_exclusion
*exclusion
,
409 struct lttng_ust_abi_object_data
*obj_data
)
411 struct ustcomm_ust_msg lum
;
412 struct ustcomm_ust_reply lur
;
419 memset(&lum
, 0, sizeof(lum
));
420 lum
.handle
= obj_data
->handle
;
421 lum
.cmd
= LTTNG_UST_ABI_EXCLUSION
;
422 lum
.u
.exclusion
.count
= exclusion
->count
;
424 ret
= ustcomm_send_app_msg(sock
, &lum
);
429 /* send var len exclusion names */
430 ret
= ustcomm_send_unix_sock(sock
,
432 exclusion
->count
* LTTNG_UST_ABI_SYM_NAME_LEN
);
436 if (ret
!= exclusion
->count
* LTTNG_UST_ABI_SYM_NAME_LEN
) {
439 return ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
442 /* Enable event, channel and session ioctl */
443 int ustctl_enable(int sock
, struct lttng_ust_abi_object_data
*object
)
445 struct ustcomm_ust_msg lum
;
446 struct ustcomm_ust_reply lur
;
452 memset(&lum
, 0, sizeof(lum
));
453 lum
.handle
= object
->handle
;
454 lum
.cmd
= LTTNG_UST_ABI_ENABLE
;
455 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
458 DBG("enabled handle %u", object
->handle
);
462 /* Disable event, channel and session ioctl */
463 int ustctl_disable(int sock
, struct lttng_ust_abi_object_data
*object
)
465 struct ustcomm_ust_msg lum
;
466 struct ustcomm_ust_reply lur
;
472 memset(&lum
, 0, sizeof(lum
));
473 lum
.handle
= object
->handle
;
474 lum
.cmd
= LTTNG_UST_ABI_DISABLE
;
475 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
478 DBG("disable handle %u", object
->handle
);
482 int ustctl_start_session(int sock
, int handle
)
484 struct lttng_ust_abi_object_data obj
;
487 return ustctl_enable(sock
, &obj
);
490 int ustctl_stop_session(int sock
, int handle
)
492 struct lttng_ust_abi_object_data obj
;
495 return ustctl_disable(sock
, &obj
);
498 int ustctl_create_event_notifier_group(int sock
, int pipe_fd
,
499 struct lttng_ust_abi_object_data
**_event_notifier_group_data
)
501 struct lttng_ust_abi_object_data
*event_notifier_group_data
;
502 struct ustcomm_ust_msg lum
;
503 struct ustcomm_ust_reply lur
;
507 if (!_event_notifier_group_data
)
510 event_notifier_group_data
= zmalloc(sizeof(*event_notifier_group_data
));
511 if (!event_notifier_group_data
)
514 event_notifier_group_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_EVENT_NOTIFIER_GROUP
;
516 memset(&lum
, 0, sizeof(lum
));
517 lum
.handle
= LTTNG_UST_ABI_ROOT_HANDLE
;
518 lum
.cmd
= LTTNG_UST_ABI_EVENT_NOTIFIER_GROUP_CREATE
;
520 ret
= ustcomm_send_app_msg(sock
, &lum
);
524 /* Send event_notifier notification pipe. */
525 len
= ustcomm_send_fds_unix_sock(sock
, &pipe_fd
, 1);
531 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
535 event_notifier_group_data
->handle
= lur
.ret_val
;
536 DBG("received event_notifier group handle %d", event_notifier_group_data
->handle
);
538 *_event_notifier_group_data
= event_notifier_group_data
;
543 free(event_notifier_group_data
);
549 int ustctl_create_event_notifier(int sock
, struct lttng_ust_abi_event_notifier
*event_notifier
,
550 struct lttng_ust_abi_object_data
*event_notifier_group
,
551 struct lttng_ust_abi_object_data
**_event_notifier_data
)
553 struct ustcomm_ust_msg lum
;
554 struct ustcomm_ust_reply lur
;
555 struct lttng_ust_abi_object_data
*event_notifier_data
;
559 if (!event_notifier_group
|| !_event_notifier_data
)
562 event_notifier_data
= zmalloc(sizeof(*event_notifier_data
));
563 if (!event_notifier_data
)
566 event_notifier_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_EVENT_NOTIFIER
;
568 memset(&lum
, 0, sizeof(lum
));
569 lum
.handle
= event_notifier_group
->handle
;
570 lum
.cmd
= LTTNG_UST_ABI_EVENT_NOTIFIER_CREATE
;
571 lum
.u
.event_notifier
.len
= sizeof(*event_notifier
);
573 ret
= ustcomm_send_app_msg(sock
, &lum
);
575 free(event_notifier_data
);
578 /* Send struct lttng_ust_abi_event_notifier */
579 len
= ustcomm_send_unix_sock(sock
, event_notifier
, sizeof(*event_notifier
));
580 if (len
!= sizeof(*event_notifier
)) {
581 free(event_notifier_data
);
587 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
589 free(event_notifier_data
);
592 event_notifier_data
->handle
= lur
.ret_val
;
593 DBG("received event_notifier handle %u", event_notifier_data
->handle
);
594 *_event_notifier_data
= event_notifier_data
;
599 int ustctl_tracepoint_list(int sock
)
601 struct ustcomm_ust_msg lum
;
602 struct ustcomm_ust_reply lur
;
603 int ret
, tp_list_handle
;
605 memset(&lum
, 0, sizeof(lum
));
606 lum
.handle
= LTTNG_UST_ABI_ROOT_HANDLE
;
607 lum
.cmd
= LTTNG_UST_ABI_TRACEPOINT_LIST
;
608 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
611 tp_list_handle
= lur
.ret_val
;
612 DBG("received tracepoint list handle %u", tp_list_handle
);
613 return tp_list_handle
;
616 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
617 struct lttng_ust_abi_tracepoint_iter
*iter
)
619 struct ustcomm_ust_msg lum
;
620 struct ustcomm_ust_reply lur
;
626 memset(&lum
, 0, sizeof(lum
));
627 lum
.handle
= tp_list_handle
;
628 lum
.cmd
= LTTNG_UST_ABI_TRACEPOINT_LIST_GET
;
629 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
632 DBG("received tracepoint list entry name %s loglevel %d",
633 lur
.u
.tracepoint
.name
,
634 lur
.u
.tracepoint
.loglevel
);
635 memcpy(iter
, &lur
.u
.tracepoint
, sizeof(*iter
));
639 int ustctl_tracepoint_field_list(int sock
)
641 struct ustcomm_ust_msg lum
;
642 struct ustcomm_ust_reply lur
;
643 int ret
, tp_field_list_handle
;
645 memset(&lum
, 0, sizeof(lum
));
646 lum
.handle
= LTTNG_UST_ABI_ROOT_HANDLE
;
647 lum
.cmd
= LTTNG_UST_ABI_TRACEPOINT_FIELD_LIST
;
648 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
651 tp_field_list_handle
= lur
.ret_val
;
652 DBG("received tracepoint field list handle %u", tp_field_list_handle
);
653 return tp_field_list_handle
;
656 int ustctl_tracepoint_field_list_get(int sock
, int tp_field_list_handle
,
657 struct lttng_ust_abi_field_iter
*iter
)
659 struct ustcomm_ust_msg lum
;
660 struct ustcomm_ust_reply lur
;
667 memset(&lum
, 0, sizeof(lum
));
668 lum
.handle
= tp_field_list_handle
;
669 lum
.cmd
= LTTNG_UST_ABI_TRACEPOINT_FIELD_LIST_GET
;
670 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
673 len
= ustcomm_recv_unix_sock(sock
, iter
, sizeof(*iter
));
674 if (len
!= sizeof(*iter
)) {
677 DBG("received tracepoint field list entry event_name %s event_loglevel %d field_name %s field_type %d",
685 int ustctl_tracer_version(int sock
, struct lttng_ust_abi_tracer_version
*v
)
687 struct ustcomm_ust_msg lum
;
688 struct ustcomm_ust_reply lur
;
694 memset(&lum
, 0, sizeof(lum
));
695 lum
.handle
= LTTNG_UST_ABI_ROOT_HANDLE
;
696 lum
.cmd
= LTTNG_UST_ABI_TRACER_VERSION
;
697 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
700 memcpy(v
, &lur
.u
.version
, sizeof(*v
));
701 DBG("received tracer version");
705 int ustctl_wait_quiescent(int sock
)
707 struct ustcomm_ust_msg lum
;
708 struct ustcomm_ust_reply lur
;
711 memset(&lum
, 0, sizeof(lum
));
712 lum
.handle
= LTTNG_UST_ABI_ROOT_HANDLE
;
713 lum
.cmd
= LTTNG_UST_ABI_WAIT_QUIESCENT
;
714 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
717 DBG("waited for quiescent state");
721 int ustctl_calibrate(int sock
, struct lttng_ust_abi_calibrate
*calibrate
)
729 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_abi_object_data
*object
)
731 struct ustcomm_ust_msg lum
;
732 struct ustcomm_ust_reply lur
;
738 memset(&lum
, 0, sizeof(lum
));
739 lum
.handle
= object
->handle
;
740 lum
.cmd
= LTTNG_UST_ABI_FLUSH_BUFFER
;
741 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
744 DBG("flushed buffer handle %u", object
->handle
);
749 int ustctl_send_channel(int sock
,
750 enum lttng_ust_abi_chan_type type
,
760 len
= ustcomm_send_unix_sock(sock
, &size
, sizeof(size
));
761 if (len
!= sizeof(size
)) {
768 /* Send channel type */
769 len
= ustcomm_send_unix_sock(sock
, &type
, sizeof(type
));
770 if (len
!= sizeof(type
)) {
778 /* Send channel data */
779 len
= ustcomm_send_unix_sock(sock
, data
, size
);
788 len
= ustcomm_send_fds_unix_sock(sock
, &wakeup_fd
, 1);
799 int ustctl_send_stream(int sock
,
801 uint64_t memory_map_size
,
802 int shm_fd
, int wakeup_fd
,
810 /* finish iteration */
813 len
= ustcomm_send_unix_sock(sock
, &v
, sizeof(v
));
814 if (len
!= sizeof(v
)) {
824 len
= ustcomm_send_unix_sock(sock
, &memory_map_size
,
825 sizeof(memory_map_size
));
826 if (len
!= sizeof(memory_map_size
)) {
834 len
= ustcomm_send_unix_sock(sock
, &stream_nr
,
836 if (len
!= sizeof(stream_nr
)) {
844 /* Send shm fd and wakeup fd */
847 len
= ustcomm_send_fds_unix_sock(sock
, fds
, 2);
857 int ustctl_recv_channel_from_consumer(int sock
,
858 struct lttng_ust_abi_object_data
**_channel_data
)
860 struct lttng_ust_abi_object_data
*channel_data
;
865 channel_data
= zmalloc(sizeof(*channel_data
));
870 channel_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_CHANNEL
;
871 channel_data
->handle
= -1;
874 len
= ustcomm_recv_unix_sock(sock
, &channel_data
->size
,
875 sizeof(channel_data
->size
));
876 if (len
!= sizeof(channel_data
->size
)) {
884 /* recv channel type */
885 len
= ustcomm_recv_unix_sock(sock
, &channel_data
->u
.channel
.type
,
886 sizeof(channel_data
->u
.channel
.type
));
887 if (len
!= sizeof(channel_data
->u
.channel
.type
)) {
895 /* recv channel data */
896 channel_data
->u
.channel
.data
= zmalloc(channel_data
->size
);
897 if (!channel_data
->u
.channel
.data
) {
901 len
= ustcomm_recv_unix_sock(sock
, channel_data
->u
.channel
.data
,
903 if (len
!= channel_data
->size
) {
908 goto error_recv_data
;
911 len
= ustcomm_recv_fds_unix_sock(sock
, &wakeup_fd
, 1);
915 goto error_recv_data
;
918 goto error_recv_data
;
921 channel_data
->u
.channel
.wakeup_fd
= wakeup_fd
;
922 *_channel_data
= channel_data
;
926 free(channel_data
->u
.channel
.data
);
933 int ustctl_recv_stream_from_consumer(int sock
,
934 struct lttng_ust_abi_object_data
**_stream_data
)
936 struct lttng_ust_abi_object_data
*stream_data
;
941 stream_data
= zmalloc(sizeof(*stream_data
));
947 stream_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_STREAM
;
948 stream_data
->handle
= -1;
951 len
= ustcomm_recv_unix_sock(sock
, &stream_data
->size
,
952 sizeof(stream_data
->size
));
953 if (len
!= sizeof(stream_data
->size
)) {
960 if (stream_data
->size
== -1) {
961 ret
= -LTTNG_UST_ERR_NOENT
;
966 len
= ustcomm_recv_unix_sock(sock
, &stream_data
->u
.stream
.stream_nr
,
967 sizeof(stream_data
->u
.stream
.stream_nr
));
968 if (len
!= sizeof(stream_data
->u
.stream
.stream_nr
)) {
976 /* recv shm fd and wakeup fd */
977 len
= ustcomm_recv_fds_unix_sock(sock
, fds
, 2);
987 stream_data
->u
.stream
.shm_fd
= fds
[0];
988 stream_data
->u
.stream
.wakeup_fd
= fds
[1];
989 *_stream_data
= stream_data
;
998 int ustctl_send_channel_to_ust(int sock
, int session_handle
,
999 struct lttng_ust_abi_object_data
*channel_data
)
1001 struct ustcomm_ust_msg lum
;
1002 struct ustcomm_ust_reply lur
;
1008 memset(&lum
, 0, sizeof(lum
));
1009 lum
.handle
= session_handle
;
1010 lum
.cmd
= LTTNG_UST_ABI_CHANNEL
;
1011 lum
.u
.channel
.len
= channel_data
->size
;
1012 lum
.u
.channel
.type
= channel_data
->u
.channel
.type
;
1013 ret
= ustcomm_send_app_msg(sock
, &lum
);
1017 ret
= ustctl_send_channel(sock
,
1018 channel_data
->u
.channel
.type
,
1019 channel_data
->u
.channel
.data
,
1021 channel_data
->u
.channel
.wakeup_fd
,
1025 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
1027 channel_data
->handle
= lur
.ret_val
;
1032 int ustctl_send_stream_to_ust(int sock
,
1033 struct lttng_ust_abi_object_data
*channel_data
,
1034 struct lttng_ust_abi_object_data
*stream_data
)
1036 struct ustcomm_ust_msg lum
;
1037 struct ustcomm_ust_reply lur
;
1040 memset(&lum
, 0, sizeof(lum
));
1041 lum
.handle
= channel_data
->handle
;
1042 lum
.cmd
= LTTNG_UST_ABI_STREAM
;
1043 lum
.u
.stream
.len
= stream_data
->size
;
1044 lum
.u
.stream
.stream_nr
= stream_data
->u
.stream
.stream_nr
;
1045 ret
= ustcomm_send_app_msg(sock
, &lum
);
1049 assert(stream_data
);
1050 assert(stream_data
->type
== LTTNG_UST_ABI_OBJECT_TYPE_STREAM
);
1052 ret
= ustctl_send_stream(sock
,
1053 stream_data
->u
.stream
.stream_nr
,
1055 stream_data
->u
.stream
.shm_fd
,
1056 stream_data
->u
.stream
.wakeup_fd
, 1);
1059 return ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
1062 int ustctl_duplicate_ust_object_data(struct lttng_ust_abi_object_data
**dest
,
1063 struct lttng_ust_abi_object_data
*src
)
1065 struct lttng_ust_abi_object_data
*obj
;
1068 if (src
->handle
!= -1) {
1073 obj
= zmalloc(sizeof(*obj
));
1079 obj
->type
= src
->type
;
1080 obj
->handle
= src
->handle
;
1081 obj
->size
= src
->size
;
1083 switch (obj
->type
) {
1084 case LTTNG_UST_ABI_OBJECT_TYPE_CHANNEL
:
1086 obj
->u
.channel
.type
= src
->u
.channel
.type
;
1087 if (src
->u
.channel
.wakeup_fd
>= 0) {
1088 obj
->u
.channel
.wakeup_fd
=
1089 dup(src
->u
.channel
.wakeup_fd
);
1090 if (obj
->u
.channel
.wakeup_fd
< 0) {
1092 goto chan_error_wakeup_fd
;
1095 obj
->u
.channel
.wakeup_fd
=
1096 src
->u
.channel
.wakeup_fd
;
1098 obj
->u
.channel
.data
= zmalloc(obj
->size
);
1099 if (!obj
->u
.channel
.data
) {
1101 goto chan_error_alloc
;
1103 memcpy(obj
->u
.channel
.data
, src
->u
.channel
.data
, obj
->size
);
1107 if (src
->u
.channel
.wakeup_fd
>= 0) {
1110 closeret
= close(obj
->u
.channel
.wakeup_fd
);
1115 chan_error_wakeup_fd
:
1120 case LTTNG_UST_ABI_OBJECT_TYPE_STREAM
:
1122 obj
->u
.stream
.stream_nr
= src
->u
.stream
.stream_nr
;
1123 if (src
->u
.stream
.wakeup_fd
>= 0) {
1124 obj
->u
.stream
.wakeup_fd
=
1125 dup(src
->u
.stream
.wakeup_fd
);
1126 if (obj
->u
.stream
.wakeup_fd
< 0) {
1128 goto stream_error_wakeup_fd
;
1131 obj
->u
.stream
.wakeup_fd
=
1132 src
->u
.stream
.wakeup_fd
;
1135 if (src
->u
.stream
.shm_fd
>= 0) {
1136 obj
->u
.stream
.shm_fd
=
1137 dup(src
->u
.stream
.shm_fd
);
1138 if (obj
->u
.stream
.shm_fd
< 0) {
1140 goto stream_error_shm_fd
;
1143 obj
->u
.stream
.shm_fd
=
1144 src
->u
.stream
.shm_fd
;
1148 stream_error_shm_fd
:
1149 if (src
->u
.stream
.wakeup_fd
>= 0) {
1152 closeret
= close(obj
->u
.stream
.wakeup_fd
);
1157 stream_error_wakeup_fd
:
1161 case LTTNG_UST_ABI_OBJECT_TYPE_COUNTER
:
1163 obj
->u
.counter
.data
= zmalloc(obj
->size
);
1164 if (!obj
->u
.counter
.data
) {
1168 memcpy(obj
->u
.counter
.data
, src
->u
.counter
.data
, obj
->size
);
1172 case LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_GLOBAL
:
1174 if (src
->u
.counter_global
.shm_fd
>= 0) {
1175 obj
->u
.counter_global
.shm_fd
=
1176 dup(src
->u
.counter_global
.shm_fd
);
1177 if (obj
->u
.counter_global
.shm_fd
< 0) {
1185 case LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_CPU
:
1187 obj
->u
.counter_cpu
.cpu_nr
= src
->u
.counter_cpu
.cpu_nr
;
1188 if (src
->u
.counter_cpu
.shm_fd
>= 0) {
1189 obj
->u
.counter_cpu
.shm_fd
=
1190 dup(src
->u
.counter_cpu
.shm_fd
);
1191 if (obj
->u
.counter_cpu
.shm_fd
< 0) {
1214 /* Buffer operations */
1216 int ustctl_get_nr_stream_per_channel(void)
1218 return num_possible_cpus();
1221 struct ustctl_consumer_channel
*
1222 ustctl_create_channel(struct ustctl_consumer_channel_attr
*attr
,
1223 const int *stream_fds
, int nr_stream_fds
)
1225 struct ustctl_consumer_channel
*chan
;
1226 const char *transport_name
;
1227 struct lttng_transport
*transport
;
1229 switch (attr
->type
) {
1230 case LTTNG_UST_ABI_CHAN_PER_CPU
:
1231 if (attr
->output
== LTTNG_UST_ABI_MMAP
) {
1232 if (attr
->overwrite
) {
1233 if (attr
->read_timer_interval
== 0) {
1234 transport_name
= "relay-overwrite-mmap";
1236 transport_name
= "relay-overwrite-rt-mmap";
1239 if (attr
->read_timer_interval
== 0) {
1240 transport_name
= "relay-discard-mmap";
1242 transport_name
= "relay-discard-rt-mmap";
1249 case LTTNG_UST_ABI_CHAN_METADATA
:
1250 if (attr
->output
== LTTNG_UST_ABI_MMAP
)
1251 transport_name
= "relay-metadata-mmap";
1256 transport_name
= "<unknown>";
1260 transport
= lttng_ust_transport_find(transport_name
);
1262 DBG("LTTng transport %s not found\n",
1267 chan
= zmalloc(sizeof(*chan
));
1271 chan
->chan
= transport
->ops
.priv
->channel_create(transport_name
, NULL
,
1272 attr
->subbuf_size
, attr
->num_subbuf
,
1273 attr
->switch_timer_interval
,
1274 attr
->read_timer_interval
,
1275 attr
->uuid
, attr
->chan_id
,
1276 stream_fds
, nr_stream_fds
,
1277 attr
->blocking_timeout
);
1281 chan
->chan
->ops
= &transport
->ops
;
1282 memcpy(&chan
->attr
, attr
, sizeof(chan
->attr
));
1283 chan
->wait_fd
= ustctl_channel_get_wait_fd(chan
);
1284 chan
->wakeup_fd
= ustctl_channel_get_wakeup_fd(chan
);
1292 void ustctl_destroy_channel(struct ustctl_consumer_channel
*chan
)
1294 (void) ustctl_channel_close_wait_fd(chan
);
1295 (void) ustctl_channel_close_wakeup_fd(chan
);
1296 chan
->chan
->ops
->priv
->channel_destroy(chan
->chan
);
1300 int ustctl_send_channel_to_sessiond(int sock
,
1301 struct ustctl_consumer_channel
*channel
)
1303 struct shm_object_table
*table
;
1305 table
= channel
->chan
->priv
->rb_chan
->handle
->table
;
1306 if (table
->size
<= 0)
1308 return ustctl_send_channel(sock
,
1310 table
->objects
[0].memory_map
,
1311 table
->objects
[0].memory_map_size
,
1316 int ustctl_send_stream_to_sessiond(int sock
,
1317 struct ustctl_consumer_stream
*stream
)
1320 return ustctl_send_stream(sock
, -1U, -1U, -1, -1, 0);
1322 return ustctl_send_stream(sock
,
1324 stream
->memory_map_size
,
1325 stream
->shm_fd
, stream
->wakeup_fd
,
1329 int ustctl_write_metadata_to_channel(
1330 struct ustctl_consumer_channel
*channel
,
1331 const char *metadata_str
, /* NOT null-terminated */
1332 size_t len
) /* metadata length */
1334 struct lttng_ust_lib_ring_buffer_ctx ctx
;
1335 struct lttng_ust_channel_buffer
*lttng_chan_buf
= channel
->chan
;
1336 struct lttng_ust_lib_ring_buffer_channel
*rb_chan
= lttng_chan_buf
->priv
->rb_chan
;
1337 const char *str
= metadata_str
;
1338 int ret
= 0, waitret
;
1339 size_t reserve_len
, pos
;
1341 for (pos
= 0; pos
< len
; pos
+= reserve_len
) {
1342 reserve_len
= min_t(size_t,
1343 lttng_chan_buf
->ops
->priv
->packet_avail_size(lttng_chan_buf
),
1345 lttng_ust_lib_ring_buffer_ctx_init(&ctx
, rb_chan
, reserve_len
, sizeof(char), NULL
);
1347 * We don't care about metadata buffer's records lost
1348 * count, because we always retry here. Report error if
1349 * we need to bail out after timeout or being
1352 waitret
= wait_cond_interruptible_timeout(
1354 ret
= lttng_chan_buf
->ops
->event_reserve(&ctx
);
1355 ret
!= -ENOBUFS
|| !ret
;
1357 LTTNG_METADATA_TIMEOUT_MSEC
);
1358 if (waitret
== -ETIMEDOUT
|| waitret
== -EINTR
|| ret
) {
1359 DBG("LTTng: Failure to write metadata to buffers (%s)\n",
1360 waitret
== -EINTR
? "interrupted" :
1361 (ret
== -ENOBUFS
? "timeout" : "I/O error"));
1362 if (waitret
== -EINTR
)
1366 lttng_chan_buf
->ops
->event_write(&ctx
, &str
[pos
], reserve_len
, 1);
1367 lttng_chan_buf
->ops
->event_commit(&ctx
);
1374 * Write at most one packet in the channel.
1375 * Returns the number of bytes written on success, < 0 on error.
1377 ssize_t
ustctl_write_one_packet_to_channel(
1378 struct ustctl_consumer_channel
*channel
,
1379 const char *metadata_str
, /* NOT null-terminated */
1380 size_t len
) /* metadata length */
1382 struct lttng_ust_lib_ring_buffer_ctx ctx
;
1383 struct lttng_ust_channel_buffer
*lttng_chan_buf
= channel
->chan
;
1384 struct lttng_ust_lib_ring_buffer_channel
*rb_chan
= lttng_chan_buf
->priv
->rb_chan
;
1385 const char *str
= metadata_str
;
1386 ssize_t reserve_len
;
1389 reserve_len
= min_t(ssize_t
,
1390 lttng_chan_buf
->ops
->priv
->packet_avail_size(lttng_chan_buf
),
1392 lttng_ust_lib_ring_buffer_ctx_init(&ctx
, rb_chan
, reserve_len
, sizeof(char), NULL
);
1393 ret
= lttng_chan_buf
->ops
->event_reserve(&ctx
);
1395 DBG("LTTng: event reservation failed");
1400 lttng_chan_buf
->ops
->event_write(&ctx
, str
, reserve_len
, 1);
1401 lttng_chan_buf
->ops
->event_commit(&ctx
);
1407 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel
*consumer_chan
)
1409 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1412 chan
= consumer_chan
->chan
->priv
->rb_chan
;
1413 ret
= ring_buffer_channel_close_wait_fd(&chan
->backend
.config
,
1414 chan
, chan
->handle
);
1416 consumer_chan
->wait_fd
= -1;
1420 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
)
1422 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1425 chan
= consumer_chan
->chan
->priv
->rb_chan
;
1426 ret
= ring_buffer_channel_close_wakeup_fd(&chan
->backend
.config
,
1427 chan
, chan
->handle
);
1429 consumer_chan
->wakeup_fd
= -1;
1433 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream
*stream
)
1435 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1437 chan
= stream
->chan
->chan
->priv
->rb_chan
;
1438 return ring_buffer_stream_close_wait_fd(&chan
->backend
.config
,
1439 chan
, chan
->handle
, stream
->cpu
);
1442 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream
*stream
)
1444 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1446 chan
= stream
->chan
->chan
->priv
->rb_chan
;
1447 return ring_buffer_stream_close_wakeup_fd(&chan
->backend
.config
,
1448 chan
, chan
->handle
, stream
->cpu
);
1451 struct ustctl_consumer_stream
*
1452 ustctl_create_stream(struct ustctl_consumer_channel
*channel
,
1455 struct ustctl_consumer_stream
*stream
;
1456 struct lttng_ust_shm_handle
*handle
;
1457 struct lttng_ust_lib_ring_buffer_channel
*rb_chan
;
1458 int shm_fd
, wait_fd
, wakeup_fd
;
1459 uint64_t memory_map_size
;
1460 struct lttng_ust_lib_ring_buffer
*buf
;
1465 rb_chan
= channel
->chan
->priv
->rb_chan
;
1466 handle
= rb_chan
->handle
;
1470 buf
= channel_get_ring_buffer(&rb_chan
->backend
.config
,
1471 rb_chan
, cpu
, handle
, &shm_fd
, &wait_fd
,
1472 &wakeup_fd
, &memory_map_size
);
1475 ret
= lib_ring_buffer_open_read(buf
, handle
);
1479 stream
= zmalloc(sizeof(*stream
));
1483 stream
->chan
= channel
;
1484 stream
->shm_fd
= shm_fd
;
1485 stream
->wait_fd
= wait_fd
;
1486 stream
->wakeup_fd
= wakeup_fd
;
1487 stream
->memory_map_size
= memory_map_size
;
1495 void ustctl_destroy_stream(struct ustctl_consumer_stream
*stream
)
1497 struct lttng_ust_lib_ring_buffer
*buf
;
1498 struct ustctl_consumer_channel
*consumer_chan
;
1502 consumer_chan
= stream
->chan
;
1503 (void) ustctl_stream_close_wait_fd(stream
);
1504 (void) ustctl_stream_close_wakeup_fd(stream
);
1505 lib_ring_buffer_release_read(buf
, consumer_chan
->chan
->priv
->rb_chan
->handle
);
1509 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel
*chan
)
1513 return shm_get_wait_fd(chan
->chan
->priv
->rb_chan
->handle
,
1514 &chan
->chan
->priv
->rb_chan
->handle
->chan
._ref
);
1517 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel
*chan
)
1521 return shm_get_wakeup_fd(chan
->chan
->priv
->rb_chan
->handle
,
1522 &chan
->chan
->priv
->rb_chan
->handle
->chan
._ref
);
1525 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream
*stream
)
1527 struct lttng_ust_lib_ring_buffer
*buf
;
1528 struct ustctl_consumer_channel
*consumer_chan
;
1533 consumer_chan
= stream
->chan
;
1534 return shm_get_wait_fd(consumer_chan
->chan
->priv
->rb_chan
->handle
, &buf
->self
._ref
);
1537 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream
*stream
)
1539 struct lttng_ust_lib_ring_buffer
*buf
;
1540 struct ustctl_consumer_channel
*consumer_chan
;
1545 consumer_chan
= stream
->chan
;
1546 return shm_get_wakeup_fd(consumer_chan
->chan
->priv
->rb_chan
->handle
, &buf
->self
._ref
);
1549 /* For mmap mode, readable without "get" operation */
1551 void *ustctl_get_mmap_base(struct ustctl_consumer_stream
*stream
)
1553 struct lttng_ust_lib_ring_buffer
*buf
;
1554 struct ustctl_consumer_channel
*consumer_chan
;
1559 consumer_chan
= stream
->chan
;
1560 return shmp(consumer_chan
->chan
->priv
->rb_chan
->handle
, buf
->backend
.memory_map
);
1563 /* returns the length to mmap. */
1564 int ustctl_get_mmap_len(struct ustctl_consumer_stream
*stream
,
1567 struct ustctl_consumer_channel
*consumer_chan
;
1568 unsigned long mmap_buf_len
;
1569 struct lttng_ust_lib_ring_buffer_channel
*rb_chan
;
1573 consumer_chan
= stream
->chan
;
1574 rb_chan
= consumer_chan
->chan
->priv
->rb_chan
;
1575 if (rb_chan
->backend
.config
.output
!= RING_BUFFER_MMAP
)
1577 mmap_buf_len
= rb_chan
->backend
.buf_size
;
1578 if (rb_chan
->backend
.extra_reader_sb
)
1579 mmap_buf_len
+= rb_chan
->backend
.subbuf_size
;
1580 if (mmap_buf_len
> INT_MAX
)
1582 *len
= mmap_buf_len
;
1586 /* returns the maximum size for sub-buffers. */
1587 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream
*stream
,
1590 struct ustctl_consumer_channel
*consumer_chan
;
1591 struct lttng_ust_lib_ring_buffer_channel
*rb_chan
;
1595 consumer_chan
= stream
->chan
;
1596 rb_chan
= consumer_chan
->chan
->priv
->rb_chan
;
1597 *len
= rb_chan
->backend
.subbuf_size
;
1602 * For mmap mode, operate on the current packet (between get/put or
1603 * get_next/put_next).
1606 /* returns the offset of the subbuffer belonging to the mmap reader. */
1607 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream
*stream
,
1610 struct lttng_ust_lib_ring_buffer_channel
*rb_chan
;
1611 unsigned long sb_bindex
;
1612 struct lttng_ust_lib_ring_buffer
*buf
;
1613 struct ustctl_consumer_channel
*consumer_chan
;
1614 struct lttng_ust_lib_ring_buffer_backend_pages_shmp
*barray_idx
;
1615 struct lttng_ust_lib_ring_buffer_backend_pages
*pages
;
1620 consumer_chan
= stream
->chan
;
1621 rb_chan
= consumer_chan
->chan
->priv
->rb_chan
;
1622 if (rb_chan
->backend
.config
.output
!= RING_BUFFER_MMAP
)
1624 sb_bindex
= subbuffer_id_get_index(&rb_chan
->backend
.config
,
1625 buf
->backend
.buf_rsb
.id
);
1626 barray_idx
= shmp_index(rb_chan
->handle
, buf
->backend
.array
,
1630 pages
= shmp(rb_chan
->handle
, barray_idx
->shmp
);
1633 *off
= pages
->mmap_offset
;
1637 /* returns the size of the current sub-buffer, without padding (for mmap). */
1638 int ustctl_get_subbuf_size(struct ustctl_consumer_stream
*stream
,
1641 struct ustctl_consumer_channel
*consumer_chan
;
1642 struct lttng_ust_lib_ring_buffer_channel
*rb_chan
;
1643 struct lttng_ust_lib_ring_buffer
*buf
;
1649 consumer_chan
= stream
->chan
;
1650 rb_chan
= consumer_chan
->chan
->priv
->rb_chan
;
1651 *len
= lib_ring_buffer_get_read_data_size(&rb_chan
->backend
.config
, buf
,
1656 /* returns the size of the current sub-buffer, without padding (for mmap). */
1657 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream
*stream
,
1660 struct ustctl_consumer_channel
*consumer_chan
;
1661 struct lttng_ust_lib_ring_buffer_channel
*rb_chan
;
1662 struct lttng_ust_lib_ring_buffer
*buf
;
1667 consumer_chan
= stream
->chan
;
1668 rb_chan
= consumer_chan
->chan
->priv
->rb_chan
;
1669 *len
= lib_ring_buffer_get_read_data_size(&rb_chan
->backend
.config
, buf
,
1671 *len
= LTTNG_UST_PAGE_ALIGN(*len
);
1675 /* Get exclusive read access to the next sub-buffer that can be read. */
1676 int ustctl_get_next_subbuf(struct ustctl_consumer_stream
*stream
)
1678 struct lttng_ust_lib_ring_buffer
*buf
;
1679 struct ustctl_consumer_channel
*consumer_chan
;
1684 consumer_chan
= stream
->chan
;
1685 return lib_ring_buffer_get_next_subbuf(buf
,
1686 consumer_chan
->chan
->priv
->rb_chan
->handle
);
1690 /* Release exclusive sub-buffer access, move consumer forward. */
1691 int ustctl_put_next_subbuf(struct ustctl_consumer_stream
*stream
)
1693 struct lttng_ust_lib_ring_buffer
*buf
;
1694 struct ustctl_consumer_channel
*consumer_chan
;
1699 consumer_chan
= stream
->chan
;
1700 lib_ring_buffer_put_next_subbuf(buf
, consumer_chan
->chan
->priv
->rb_chan
->handle
);
1706 /* Get a snapshot of the current ring buffer producer and consumer positions */
1707 int ustctl_snapshot(struct ustctl_consumer_stream
*stream
)
1709 struct lttng_ust_lib_ring_buffer
*buf
;
1710 struct ustctl_consumer_channel
*consumer_chan
;
1715 consumer_chan
= stream
->chan
;
1716 return lib_ring_buffer_snapshot(buf
, &buf
->cons_snapshot
,
1717 &buf
->prod_snapshot
, consumer_chan
->chan
->priv
->rb_chan
->handle
);
1721 * Get a snapshot of the current ring buffer producer and consumer positions
1722 * even if the consumed and produced positions are contained within the same
1725 int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream
*stream
)
1727 struct lttng_ust_lib_ring_buffer
*buf
;
1728 struct ustctl_consumer_channel
*consumer_chan
;
1733 consumer_chan
= stream
->chan
;
1734 return lib_ring_buffer_snapshot_sample_positions(buf
,
1735 &buf
->cons_snapshot
, &buf
->prod_snapshot
,
1736 consumer_chan
->chan
->priv
->rb_chan
->handle
);
1739 /* Get the consumer position (iteration start) */
1740 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream
*stream
,
1743 struct lttng_ust_lib_ring_buffer
*buf
;
1748 *pos
= buf
->cons_snapshot
;
1752 /* Get the producer position (iteration end) */
1753 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream
*stream
,
1756 struct lttng_ust_lib_ring_buffer
*buf
;
1761 *pos
= buf
->prod_snapshot
;
1765 /* Get exclusive read access to the specified sub-buffer position */
1766 int ustctl_get_subbuf(struct ustctl_consumer_stream
*stream
,
1769 struct lttng_ust_lib_ring_buffer
*buf
;
1770 struct ustctl_consumer_channel
*consumer_chan
;
1775 consumer_chan
= stream
->chan
;
1776 return lib_ring_buffer_get_subbuf(buf
, *pos
,
1777 consumer_chan
->chan
->priv
->rb_chan
->handle
);
1780 /* Release exclusive sub-buffer access */
1781 int ustctl_put_subbuf(struct ustctl_consumer_stream
*stream
)
1783 struct lttng_ust_lib_ring_buffer
*buf
;
1784 struct ustctl_consumer_channel
*consumer_chan
;
1789 consumer_chan
= stream
->chan
;
1790 lib_ring_buffer_put_subbuf(buf
, consumer_chan
->chan
->priv
->rb_chan
->handle
);
1794 void ustctl_flush_buffer(struct ustctl_consumer_stream
*stream
,
1795 int producer_active
)
1797 struct lttng_ust_lib_ring_buffer
*buf
;
1798 struct ustctl_consumer_channel
*consumer_chan
;
1802 consumer_chan
= stream
->chan
;
1803 lib_ring_buffer_switch_slow(buf
,
1804 producer_active
? SWITCH_ACTIVE
: SWITCH_FLUSH
,
1805 consumer_chan
->chan
->priv
->rb_chan
->handle
);
1808 void ustctl_clear_buffer(struct ustctl_consumer_stream
*stream
)
1810 struct lttng_ust_lib_ring_buffer
*buf
;
1811 struct ustctl_consumer_channel
*consumer_chan
;
1815 consumer_chan
= stream
->chan
;
1816 lib_ring_buffer_switch_slow(buf
, SWITCH_ACTIVE
,
1817 consumer_chan
->chan
->priv
->rb_chan
->handle
);
1818 lib_ring_buffer_clear_reader(buf
, consumer_chan
->chan
->priv
->rb_chan
->handle
);
1822 struct lttng_ust_client_lib_ring_buffer_client_cb
*get_client_cb(
1823 struct lttng_ust_lib_ring_buffer
*buf
,
1824 struct lttng_ust_lib_ring_buffer_channel
*chan
)
1826 const struct lttng_ust_lib_ring_buffer_config
*config
;
1827 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1829 config
= &chan
->backend
.config
;
1830 if (!config
->cb_ptr
)
1832 client_cb
= caa_container_of(config
->cb_ptr
,
1833 struct lttng_ust_client_lib_ring_buffer_client_cb
,
1838 int ustctl_get_timestamp_begin(struct ustctl_consumer_stream
*stream
,
1839 uint64_t *timestamp_begin
)
1841 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1842 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1843 struct lttng_ust_lib_ring_buffer
*buf
;
1845 if (!stream
|| !timestamp_begin
)
1848 chan
= stream
->chan
->chan
->priv
->rb_chan
;
1849 client_cb
= get_client_cb(buf
, chan
);
1852 return client_cb
->timestamp_begin(buf
, chan
, timestamp_begin
);
1855 int ustctl_get_timestamp_end(struct ustctl_consumer_stream
*stream
,
1856 uint64_t *timestamp_end
)
1858 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1859 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1860 struct lttng_ust_lib_ring_buffer
*buf
;
1862 if (!stream
|| !timestamp_end
)
1865 chan
= stream
->chan
->chan
->priv
->rb_chan
;
1866 client_cb
= get_client_cb(buf
, chan
);
1869 return client_cb
->timestamp_end(buf
, chan
, timestamp_end
);
1872 int ustctl_get_events_discarded(struct ustctl_consumer_stream
*stream
,
1873 uint64_t *events_discarded
)
1875 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1876 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1877 struct lttng_ust_lib_ring_buffer
*buf
;
1879 if (!stream
|| !events_discarded
)
1882 chan
= stream
->chan
->chan
->priv
->rb_chan
;
1883 client_cb
= get_client_cb(buf
, chan
);
1886 return client_cb
->events_discarded(buf
, chan
, events_discarded
);
1889 int ustctl_get_content_size(struct ustctl_consumer_stream
*stream
,
1890 uint64_t *content_size
)
1892 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1893 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1894 struct lttng_ust_lib_ring_buffer
*buf
;
1896 if (!stream
|| !content_size
)
1899 chan
= stream
->chan
->chan
->priv
->rb_chan
;
1900 client_cb
= get_client_cb(buf
, chan
);
1903 return client_cb
->content_size(buf
, chan
, content_size
);
1906 int ustctl_get_packet_size(struct ustctl_consumer_stream
*stream
,
1907 uint64_t *packet_size
)
1909 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1910 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1911 struct lttng_ust_lib_ring_buffer
*buf
;
1913 if (!stream
|| !packet_size
)
1916 chan
= stream
->chan
->chan
->priv
->rb_chan
;
1917 client_cb
= get_client_cb(buf
, chan
);
1920 return client_cb
->packet_size(buf
, chan
, packet_size
);
1923 int ustctl_get_stream_id(struct ustctl_consumer_stream
*stream
,
1924 uint64_t *stream_id
)
1926 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1927 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1928 struct lttng_ust_lib_ring_buffer
*buf
;
1930 if (!stream
|| !stream_id
)
1933 chan
= stream
->chan
->chan
->priv
->rb_chan
;
1934 client_cb
= get_client_cb(buf
, chan
);
1937 return client_cb
->stream_id(buf
, chan
, stream_id
);
1940 int ustctl_get_current_timestamp(struct ustctl_consumer_stream
*stream
,
1943 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1944 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1945 struct lttng_ust_lib_ring_buffer
*buf
;
1950 chan
= stream
->chan
->chan
->priv
->rb_chan
;
1951 client_cb
= get_client_cb(buf
, chan
);
1952 if (!client_cb
|| !client_cb
->current_timestamp
)
1954 return client_cb
->current_timestamp(buf
, chan
, ts
);
1957 int ustctl_get_sequence_number(struct ustctl_consumer_stream
*stream
,
1960 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1961 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1962 struct lttng_ust_lib_ring_buffer
*buf
;
1964 if (!stream
|| !seq
)
1967 chan
= stream
->chan
->chan
->priv
->rb_chan
;
1968 client_cb
= get_client_cb(buf
, chan
);
1969 if (!client_cb
|| !client_cb
->sequence_number
)
1971 return client_cb
->sequence_number(buf
, chan
, seq
);
1974 int ustctl_get_instance_id(struct ustctl_consumer_stream
*stream
,
1977 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1978 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1979 struct lttng_ust_lib_ring_buffer
*buf
;
1984 chan
= stream
->chan
->chan
->priv
->rb_chan
;
1985 client_cb
= get_client_cb(buf
, chan
);
1988 return client_cb
->instance_id(buf
, chan
, id
);
1991 #ifdef HAVE_LINUX_PERF_EVENT_H
1993 int ustctl_has_perf_counters(void)
2000 int ustctl_has_perf_counters(void)
2009 * Override application pid/uid/gid with unix socket credentials. If
2010 * the application announced a pid matching our view, it means it is
2011 * within the same pid namespace, so expose the ppid provided by the
2015 int get_cred(int sock
,
2016 const struct ustctl_reg_msg
*reg_msg
,
2023 socklen_t ucred_len
= sizeof(struct ucred
);
2026 ret
= getsockopt(sock
, SOL_SOCKET
, SO_PEERCRED
, &ucred
, &ucred_len
);
2028 return -LTTNG_UST_ERR_PEERCRED
;
2030 DBG("Unix socket peercred [ pid: %u, uid: %u, gid: %u ], "
2031 "application registered claiming [ pid: %u, ppid: %u, uid: %u, gid: %u ]",
2032 ucred
.pid
, ucred
.uid
, ucred
.gid
,
2033 reg_msg
->pid
, reg_msg
->ppid
, reg_msg
->uid
, reg_msg
->gid
);
2035 ERR("Unix socket credential pid=0. Refusing application in distinct, non-nested pid namespace.");
2036 return -LTTNG_UST_ERR_PEERCRED_PID
;
2041 if (ucred
.pid
== reg_msg
->pid
) {
2042 *ppid
= reg_msg
->ppid
;
2048 #elif defined(__FreeBSD__)
2049 #include <sys/ucred.h>
2053 * Override application uid/gid with unix socket credentials. Use the
2054 * first group of the cr_groups.
2055 * Use the pid and ppid provided by the application on registration.
2058 int get_cred(int sock
,
2059 const struct ustctl_reg_msg
*reg_msg
,
2065 struct xucred xucred
;
2066 socklen_t xucred_len
= sizeof(struct xucred
);
2069 ret
= getsockopt(sock
, SOL_SOCKET
, LOCAL_PEERCRED
, &xucred
, &xucred_len
);
2071 return -LTTNG_UST_ERR_PEERCRED
;
2073 if (xucred
.cr_version
!= XUCRED_VERSION
|| xucred
.cr_ngroups
< 1) {
2074 return -LTTNG_UST_ERR_PEERCRED
;
2076 DBG("Unix socket peercred [ uid: %u, gid: %u ], "
2077 "application registered claiming [ pid: %d, ppid: %d, uid: %u, gid: %u ]",
2078 xucred
.cr_uid
, xucred
.cr_groups
[0],
2079 reg_msg
->pid
, reg_msg
->ppid
, reg_msg
->uid
, reg_msg
->gid
);
2080 *pid
= reg_msg
->pid
;
2081 *ppid
= reg_msg
->ppid
;
2082 *uid
= xucred
.cr_uid
;
2083 *gid
= xucred
.cr_groups
[0];
2087 #warning "Using insecure fallback: trusting user id provided by registered applications. Please consider implementing use of unix socket credentials on your platform."
2089 int get_cred(int sock
,
2090 const struct ustctl_reg_msg
*reg_msg
,
2096 DBG("Application registered claiming [ pid: %u, ppid: %d, uid: %u, gid: %u ]",
2097 reg_msg
->pid
, reg_msg
->ppid
, reg_msg
->uid
, reg_msg
->gid
);
2098 *pid
= reg_msg
->pid
;
2099 *ppid
= reg_msg
->ppid
;
2100 *uid
= reg_msg
->uid
;
2101 *gid
= reg_msg
->gid
;
2107 * Returns 0 on success, negative error value on error.
2109 int ustctl_recv_reg_msg(int sock
,
2110 enum ustctl_socket_type
*type
,
2117 uint32_t *bits_per_long
,
2118 uint32_t *uint8_t_alignment
,
2119 uint32_t *uint16_t_alignment
,
2120 uint32_t *uint32_t_alignment
,
2121 uint32_t *uint64_t_alignment
,
2122 uint32_t *long_alignment
,
2127 struct ustctl_reg_msg reg_msg
;
2129 len
= ustcomm_recv_unix_sock(sock
, ®_msg
, sizeof(reg_msg
));
2130 if (len
> 0 && len
!= sizeof(reg_msg
))
2137 if (reg_msg
.magic
== LTTNG_UST_ABI_COMM_MAGIC
) {
2138 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
?
2139 BIG_ENDIAN
: LITTLE_ENDIAN
;
2140 } else if (reg_msg
.magic
== bswap_32(LTTNG_UST_ABI_COMM_MAGIC
)) {
2141 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
?
2142 LITTLE_ENDIAN
: BIG_ENDIAN
;
2144 return -LTTNG_UST_ERR_INVAL_MAGIC
;
2146 switch (reg_msg
.socket_type
) {
2147 case 0: *type
= USTCTL_SOCKET_CMD
;
2149 case 1: *type
= USTCTL_SOCKET_NOTIFY
;
2152 return -LTTNG_UST_ERR_INVAL_SOCKET_TYPE
;
2154 *major
= reg_msg
.major
;
2155 *minor
= reg_msg
.minor
;
2156 *bits_per_long
= reg_msg
.bits_per_long
;
2157 *uint8_t_alignment
= reg_msg
.uint8_t_alignment
;
2158 *uint16_t_alignment
= reg_msg
.uint16_t_alignment
;
2159 *uint32_t_alignment
= reg_msg
.uint32_t_alignment
;
2160 *uint64_t_alignment
= reg_msg
.uint64_t_alignment
;
2161 *long_alignment
= reg_msg
.long_alignment
;
2162 memcpy(name
, reg_msg
.name
, LTTNG_UST_ABI_PROCNAME_LEN
);
2163 if (reg_msg
.major
< LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE
||
2164 reg_msg
.major
> LTTNG_UST_ABI_MAJOR_VERSION
) {
2165 return -LTTNG_UST_ERR_UNSUP_MAJOR
;
2167 return get_cred(sock
, ®_msg
, pid
, ppid
, uid
, gid
);
2170 int ustctl_recv_notify(int sock
, enum ustctl_notify_cmd
*notify_cmd
)
2172 struct ustcomm_notify_hdr header
;
2175 len
= ustcomm_recv_unix_sock(sock
, &header
, sizeof(header
));
2176 if (len
> 0 && len
!= sizeof(header
))
2182 switch (header
.notify_cmd
) {
2184 *notify_cmd
= USTCTL_NOTIFY_CMD_EVENT
;
2187 *notify_cmd
= USTCTL_NOTIFY_CMD_CHANNEL
;
2190 *notify_cmd
= USTCTL_NOTIFY_CMD_ENUM
;
2199 * Returns 0 on success, negative error value on error.
2201 int ustctl_recv_register_event(int sock
,
2208 struct ustctl_field
**fields
,
2209 char **model_emf_uri
)
2212 struct ustcomm_notify_event_msg msg
;
2213 size_t signature_len
, fields_len
, model_emf_uri_len
;
2214 char *a_sign
= NULL
, *a_model_emf_uri
= NULL
;
2215 struct ustctl_field
*a_fields
= NULL
;
2217 len
= ustcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
2218 if (len
> 0 && len
!= sizeof(msg
))
2225 *session_objd
= msg
.session_objd
;
2226 *channel_objd
= msg
.channel_objd
;
2227 strncpy(event_name
, msg
.event_name
, LTTNG_UST_ABI_SYM_NAME_LEN
);
2228 event_name
[LTTNG_UST_ABI_SYM_NAME_LEN
- 1] = '\0';
2229 *loglevel
= msg
.loglevel
;
2230 signature_len
= msg
.signature_len
;
2231 fields_len
= msg
.fields_len
;
2233 if (fields_len
% sizeof(*a_fields
) != 0) {
2237 model_emf_uri_len
= msg
.model_emf_uri_len
;
2239 /* recv signature. contains at least \0. */
2240 a_sign
= zmalloc(signature_len
);
2243 len
= ustcomm_recv_unix_sock(sock
, a_sign
, signature_len
);
2244 if (len
> 0 && len
!= signature_len
) {
2246 goto signature_error
;
2250 goto signature_error
;
2253 goto signature_error
;
2255 /* Enforce end of string */
2256 a_sign
[signature_len
- 1] = '\0';
2260 a_fields
= zmalloc(fields_len
);
2263 goto signature_error
;
2265 len
= ustcomm_recv_unix_sock(sock
, a_fields
, fields_len
);
2266 if (len
> 0 && len
!= fields_len
) {
2279 if (model_emf_uri_len
) {
2280 /* recv model_emf_uri_len */
2281 a_model_emf_uri
= zmalloc(model_emf_uri_len
);
2282 if (!a_model_emf_uri
) {
2286 len
= ustcomm_recv_unix_sock(sock
, a_model_emf_uri
,
2288 if (len
> 0 && len
!= model_emf_uri_len
) {
2299 /* Enforce end of string */
2300 a_model_emf_uri
[model_emf_uri_len
- 1] = '\0';
2303 *signature
= a_sign
;
2304 *nr_fields
= fields_len
/ sizeof(*a_fields
);
2306 *model_emf_uri
= a_model_emf_uri
;
2311 free(a_model_emf_uri
);
2320 * Returns 0 on success, negative error value on error.
2322 int ustctl_reply_register_event(int sock
,
2328 struct ustcomm_notify_hdr header
;
2329 struct ustcomm_notify_event_reply r
;
2332 memset(&reply
, 0, sizeof(reply
));
2333 reply
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_EVENT
;
2334 reply
.r
.ret_code
= ret_code
;
2335 reply
.r
.event_id
= id
;
2336 len
= ustcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2337 if (len
> 0 && len
!= sizeof(reply
))
2345 * Returns 0 on success, negative UST or system error value on error.
2347 int ustctl_recv_register_enum(int sock
,
2350 struct ustctl_enum_entry
**entries
,
2354 struct ustcomm_notify_enum_msg msg
;
2356 struct ustctl_enum_entry
*a_entries
= NULL
;
2358 len
= ustcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
2359 if (len
> 0 && len
!= sizeof(msg
))
2366 *session_objd
= msg
.session_objd
;
2367 strncpy(enum_name
, msg
.enum_name
, LTTNG_UST_ABI_SYM_NAME_LEN
);
2368 enum_name
[LTTNG_UST_ABI_SYM_NAME_LEN
- 1] = '\0';
2369 entries_len
= msg
.entries_len
;
2371 if (entries_len
% sizeof(*a_entries
) != 0) {
2377 a_entries
= zmalloc(entries_len
);
2380 len
= ustcomm_recv_unix_sock(sock
, a_entries
, entries_len
);
2381 if (len
> 0 && len
!= entries_len
) {
2393 *nr_entries
= entries_len
/ sizeof(*a_entries
);
2394 *entries
= a_entries
;
2404 * Returns 0 on success, negative error value on error.
2406 int ustctl_reply_register_enum(int sock
,
2412 struct ustcomm_notify_hdr header
;
2413 struct ustcomm_notify_enum_reply r
;
2416 memset(&reply
, 0, sizeof(reply
));
2417 reply
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_ENUM
;
2418 reply
.r
.ret_code
= ret_code
;
2419 reply
.r
.enum_id
= id
;
2420 len
= ustcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2421 if (len
> 0 && len
!= sizeof(reply
))
2429 * Returns 0 on success, negative UST or system error value on error.
2431 int ustctl_recv_register_channel(int sock
,
2432 int *session_objd
, /* session descriptor (output) */
2433 int *channel_objd
, /* channel descriptor (output) */
2435 struct ustctl_field
**fields
)
2438 struct ustcomm_notify_channel_msg msg
;
2440 struct ustctl_field
*a_fields
;
2442 len
= ustcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
2443 if (len
> 0 && len
!= sizeof(msg
))
2450 *session_objd
= msg
.session_objd
;
2451 *channel_objd
= msg
.channel_objd
;
2452 fields_len
= msg
.ctx_fields_len
;
2454 if (fields_len
% sizeof(*a_fields
) != 0) {
2460 a_fields
= zmalloc(fields_len
);
2465 len
= ustcomm_recv_unix_sock(sock
, a_fields
, fields_len
);
2466 if (len
> 0 && len
!= fields_len
) {
2481 *nr_fields
= fields_len
/ sizeof(*a_fields
);
2491 * Returns 0 on success, negative error value on error.
2493 int ustctl_reply_register_channel(int sock
,
2495 enum ustctl_channel_header header_type
,
2500 struct ustcomm_notify_hdr header
;
2501 struct ustcomm_notify_channel_reply r
;
2504 memset(&reply
, 0, sizeof(reply
));
2505 reply
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_CHANNEL
;
2506 reply
.r
.ret_code
= ret_code
;
2507 reply
.r
.chan_id
= chan_id
;
2508 switch (header_type
) {
2509 case USTCTL_CHANNEL_HEADER_COMPACT
:
2510 reply
.r
.header_type
= 1;
2512 case USTCTL_CHANNEL_HEADER_LARGE
:
2513 reply
.r
.header_type
= 2;
2516 reply
.r
.header_type
= 0;
2519 len
= ustcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2520 if (len
> 0 && len
!= sizeof(reply
))
2527 /* Regenerate the statedump. */
2528 int ustctl_regenerate_statedump(int sock
, int handle
)
2530 struct ustcomm_ust_msg lum
;
2531 struct ustcomm_ust_reply lur
;
2534 memset(&lum
, 0, sizeof(lum
));
2535 lum
.handle
= handle
;
2536 lum
.cmd
= LTTNG_UST_ABI_SESSION_STATEDUMP
;
2537 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
2540 DBG("Regenerated statedump for handle %u", handle
);
2544 /* counter operations */
2546 int ustctl_get_nr_cpu_per_counter(void)
2548 return lttng_counter_num_possible_cpus();
2551 struct ustctl_daemon_counter
*
2552 ustctl_create_counter(size_t nr_dimensions
,
2553 const struct ustctl_counter_dimension
*dimensions
,
2554 int64_t global_sum_step
,
2555 int global_counter_fd
,
2556 int nr_counter_cpu_fds
,
2557 const int *counter_cpu_fds
,
2558 enum ustctl_counter_bitness bitness
,
2559 enum ustctl_counter_arithmetic arithmetic
,
2560 uint32_t alloc_flags
,
2563 const char *transport_name
;
2564 struct ustctl_daemon_counter
*counter
;
2565 struct lttng_counter_transport
*transport
;
2566 struct lttng_counter_dimension ust_dim
[LTTNG_COUNTER_DIMENSION_MAX
];
2569 if (nr_dimensions
> LTTNG_COUNTER_DIMENSION_MAX
)
2571 /* Currently, only per-cpu allocation is supported. */
2572 switch (alloc_flags
) {
2573 case USTCTL_COUNTER_ALLOC_PER_CPU
:
2576 case USTCTL_COUNTER_ALLOC_PER_CPU
| USTCTL_COUNTER_ALLOC_GLOBAL
:
2577 case USTCTL_COUNTER_ALLOC_GLOBAL
:
2582 case USTCTL_COUNTER_BITNESS_32
:
2583 switch (arithmetic
) {
2584 case USTCTL_COUNTER_ARITHMETIC_MODULAR
:
2585 transport_name
= "counter-per-cpu-32-modular";
2587 case USTCTL_COUNTER_ARITHMETIC_SATURATION
:
2588 transport_name
= "counter-per-cpu-32-saturation";
2594 case USTCTL_COUNTER_BITNESS_64
:
2595 switch (arithmetic
) {
2596 case USTCTL_COUNTER_ARITHMETIC_MODULAR
:
2597 transport_name
= "counter-per-cpu-64-modular";
2599 case USTCTL_COUNTER_ARITHMETIC_SATURATION
:
2600 transport_name
= "counter-per-cpu-64-saturation";
2610 transport
= lttng_counter_transport_find(transport_name
);
2612 DBG("LTTng transport %s not found\n",
2617 counter
= zmalloc(sizeof(*counter
));
2620 counter
->attr
= zmalloc(sizeof(*counter
->attr
));
2623 counter
->attr
->bitness
= bitness
;
2624 counter
->attr
->arithmetic
= arithmetic
;
2625 counter
->attr
->nr_dimensions
= nr_dimensions
;
2626 counter
->attr
->global_sum_step
= global_sum_step
;
2627 counter
->attr
->coalesce_hits
= coalesce_hits
;
2628 for (i
= 0; i
< nr_dimensions
; i
++)
2629 counter
->attr
->dimensions
[i
] = dimensions
[i
];
2631 for (i
= 0; i
< nr_dimensions
; i
++) {
2632 ust_dim
[i
].size
= dimensions
[i
].size
;
2633 ust_dim
[i
].underflow_index
= dimensions
[i
].underflow_index
;
2634 ust_dim
[i
].overflow_index
= dimensions
[i
].overflow_index
;
2635 ust_dim
[i
].has_underflow
= dimensions
[i
].has_underflow
;
2636 ust_dim
[i
].has_overflow
= dimensions
[i
].has_overflow
;
2638 counter
->counter
= transport
->ops
.counter_create(nr_dimensions
,
2639 ust_dim
, global_sum_step
, global_counter_fd
,
2640 nr_counter_cpu_fds
, counter_cpu_fds
, true);
2641 if (!counter
->counter
)
2643 counter
->ops
= &transport
->ops
;
2647 free(counter
->attr
);
2653 int ustctl_create_counter_data(struct ustctl_daemon_counter
*counter
,
2654 struct lttng_ust_abi_object_data
**_counter_data
)
2656 struct lttng_ust_abi_object_data
*counter_data
;
2657 struct lttng_ust_abi_counter_conf counter_conf
= {0};
2661 switch (counter
->attr
->arithmetic
) {
2662 case USTCTL_COUNTER_ARITHMETIC_MODULAR
:
2663 counter_conf
.arithmetic
= LTTNG_UST_ABI_COUNTER_ARITHMETIC_MODULAR
;
2665 case USTCTL_COUNTER_ARITHMETIC_SATURATION
:
2666 counter_conf
.arithmetic
= LTTNG_UST_ABI_COUNTER_ARITHMETIC_SATURATION
;
2671 switch (counter
->attr
->bitness
) {
2672 case USTCTL_COUNTER_BITNESS_32
:
2673 counter_conf
.bitness
= LTTNG_UST_ABI_COUNTER_BITNESS_32
;
2675 case USTCTL_COUNTER_BITNESS_64
:
2676 counter_conf
.bitness
= LTTNG_UST_ABI_COUNTER_BITNESS_64
;
2681 counter_conf
.number_dimensions
= counter
->attr
->nr_dimensions
;
2682 counter_conf
.global_sum_step
= counter
->attr
->global_sum_step
;
2683 counter_conf
.coalesce_hits
= counter
->attr
->coalesce_hits
;
2684 for (i
= 0; i
< counter
->attr
->nr_dimensions
; i
++) {
2685 counter_conf
.dimensions
[i
].size
= counter
->attr
->dimensions
[i
].size
;
2686 counter_conf
.dimensions
[i
].underflow_index
= counter
->attr
->dimensions
[i
].underflow_index
;
2687 counter_conf
.dimensions
[i
].overflow_index
= counter
->attr
->dimensions
[i
].overflow_index
;
2688 counter_conf
.dimensions
[i
].has_underflow
= counter
->attr
->dimensions
[i
].has_underflow
;
2689 counter_conf
.dimensions
[i
].has_overflow
= counter
->attr
->dimensions
[i
].has_overflow
;
2692 counter_data
= zmalloc(sizeof(*counter_data
));
2693 if (!counter_data
) {
2697 counter_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_COUNTER
;
2698 counter_data
->handle
= -1;
2700 counter_data
->size
= sizeof(counter_conf
);
2701 counter_data
->u
.counter
.data
= zmalloc(sizeof(counter_conf
));
2702 if (!counter_data
->u
.counter
.data
) {
2704 goto error_alloc_data
;
2707 memcpy(counter_data
->u
.counter
.data
, &counter_conf
, sizeof(counter_conf
));
2708 *_counter_data
= counter_data
;
2718 int ustctl_create_counter_global_data(struct ustctl_daemon_counter
*counter
,
2719 struct lttng_ust_abi_object_data
**_counter_global_data
)
2721 struct lttng_ust_abi_object_data
*counter_global_data
;
2725 if (lttng_counter_get_global_shm(counter
->counter
, &fd
, &len
))
2727 counter_global_data
= zmalloc(sizeof(*counter_global_data
));
2728 if (!counter_global_data
) {
2732 counter_global_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_GLOBAL
;
2733 counter_global_data
->handle
= -1;
2734 counter_global_data
->size
= len
;
2735 counter_global_data
->u
.counter_global
.shm_fd
= fd
;
2736 *_counter_global_data
= counter_global_data
;
2743 int ustctl_create_counter_cpu_data(struct ustctl_daemon_counter
*counter
, int cpu
,
2744 struct lttng_ust_abi_object_data
**_counter_cpu_data
)
2746 struct lttng_ust_abi_object_data
*counter_cpu_data
;
2750 if (lttng_counter_get_cpu_shm(counter
->counter
, cpu
, &fd
, &len
))
2752 counter_cpu_data
= zmalloc(sizeof(*counter_cpu_data
));
2753 if (!counter_cpu_data
) {
2757 counter_cpu_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_CPU
;
2758 counter_cpu_data
->handle
= -1;
2759 counter_cpu_data
->size
= len
;
2760 counter_cpu_data
->u
.counter_cpu
.shm_fd
= fd
;
2761 counter_cpu_data
->u
.counter_cpu
.cpu_nr
= cpu
;
2762 *_counter_cpu_data
= counter_cpu_data
;
2769 void ustctl_destroy_counter(struct ustctl_daemon_counter
*counter
)
2771 counter
->ops
->counter_destroy(counter
->counter
);
2772 free(counter
->attr
);
2776 int ustctl_send_counter_data_to_ust(int sock
, int parent_handle
,
2777 struct lttng_ust_abi_object_data
*counter_data
)
2779 struct ustcomm_ust_msg lum
;
2780 struct ustcomm_ust_reply lur
;
2788 size
= counter_data
->size
;
2789 memset(&lum
, 0, sizeof(lum
));
2790 lum
.handle
= parent_handle
;
2791 lum
.cmd
= LTTNG_UST_ABI_COUNTER
;
2792 lum
.u
.counter
.len
= size
;
2793 ret
= ustcomm_send_app_msg(sock
, &lum
);
2797 /* Send counter data */
2798 len
= ustcomm_send_unix_sock(sock
, counter_data
->u
.counter
.data
, size
);
2806 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
2808 counter_data
->handle
= lur
.ret_val
;
2813 int ustctl_send_counter_global_data_to_ust(int sock
,
2814 struct lttng_ust_abi_object_data
*counter_data
,
2815 struct lttng_ust_abi_object_data
*counter_global_data
)
2817 struct ustcomm_ust_msg lum
;
2818 struct ustcomm_ust_reply lur
;
2823 if (!counter_data
|| !counter_global_data
)
2826 size
= counter_global_data
->size
;
2827 memset(&lum
, 0, sizeof(lum
));
2828 lum
.handle
= counter_data
->handle
; /* parent handle */
2829 lum
.cmd
= LTTNG_UST_ABI_COUNTER_GLOBAL
;
2830 lum
.u
.counter_global
.len
= size
;
2831 ret
= ustcomm_send_app_msg(sock
, &lum
);
2835 shm_fd
[0] = counter_global_data
->u
.counter_global
.shm_fd
;
2836 len
= ustcomm_send_fds_unix_sock(sock
, shm_fd
, 1);
2844 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
2846 counter_global_data
->handle
= lur
.ret_val
;
2851 int ustctl_send_counter_cpu_data_to_ust(int sock
,
2852 struct lttng_ust_abi_object_data
*counter_data
,
2853 struct lttng_ust_abi_object_data
*counter_cpu_data
)
2855 struct ustcomm_ust_msg lum
;
2856 struct ustcomm_ust_reply lur
;
2861 if (!counter_data
|| !counter_cpu_data
)
2864 size
= counter_cpu_data
->size
;
2865 memset(&lum
, 0, sizeof(lum
));
2866 lum
.handle
= counter_data
->handle
; /* parent handle */
2867 lum
.cmd
= LTTNG_UST_ABI_COUNTER_CPU
;
2868 lum
.u
.counter_cpu
.len
= size
;
2869 lum
.u
.counter_cpu
.cpu_nr
= counter_cpu_data
->u
.counter_cpu
.cpu_nr
;
2870 ret
= ustcomm_send_app_msg(sock
, &lum
);
2874 shm_fd
[0] = counter_cpu_data
->u
.counter_global
.shm_fd
;
2875 len
= ustcomm_send_fds_unix_sock(sock
, shm_fd
, 1);
2883 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
2885 counter_cpu_data
->handle
= lur
.ret_val
;
2890 int ustctl_counter_read(struct ustctl_daemon_counter
*counter
,
2891 const size_t *dimension_indexes
,
2892 int cpu
, int64_t *value
,
2893 bool *overflow
, bool *underflow
)
2895 return counter
->ops
->counter_read(counter
->counter
, dimension_indexes
, cpu
,
2896 value
, overflow
, underflow
);
2899 int ustctl_counter_aggregate(struct ustctl_daemon_counter
*counter
,
2900 const size_t *dimension_indexes
,
2902 bool *overflow
, bool *underflow
)
2904 return counter
->ops
->counter_aggregate(counter
->counter
, dimension_indexes
,
2905 value
, overflow
, underflow
);
2908 int ustctl_counter_clear(struct ustctl_daemon_counter
*counter
,
2909 const size_t *dimension_indexes
)
2911 return counter
->ops
->counter_clear(counter
->counter
, dimension_indexes
);
2914 static __attribute__((constructor
))
2915 void ustctl_init(void)
2918 lttng_ust_getenv_init(); /* Needs ust_err_init() to be completed. */
2919 lttng_ust_clock_init();
2920 lttng_ring_buffer_metadata_client_init();
2921 lttng_ring_buffer_client_overwrite_init();
2922 lttng_ring_buffer_client_overwrite_rt_init();
2923 lttng_ring_buffer_client_discard_init();
2924 lttng_ring_buffer_client_discard_rt_init();
2925 lttng_counter_client_percpu_32_modular_init();
2926 lttng_counter_client_percpu_64_modular_init();
2927 lib_ringbuffer_signal_init();
2930 static __attribute__((destructor
))
2931 void ustctl_exit(void)
2933 lttng_ring_buffer_client_discard_rt_exit();
2934 lttng_ring_buffer_client_discard_exit();
2935 lttng_ring_buffer_client_overwrite_rt_exit();
2936 lttng_ring_buffer_client_overwrite_exit();
2937 lttng_ring_buffer_metadata_client_exit();
2938 lttng_counter_client_percpu_32_modular_exit();
2939 lttng_counter_client_percpu_64_modular_exit();