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"
34 #include "../libcounter/shm.h"
35 #include "../libcounter/smp.h"
36 #include "../libcounter/counter.h"
39 * Number of milliseconds to retry before failing metadata writes on
40 * buffer full condition. (10 seconds)
42 #define LTTNG_METADATA_TIMEOUT_MSEC 10000
45 * Channel representation within consumer.
47 struct ustctl_consumer_channel
{
48 struct lttng_ust_channel_buffer
*chan
; /* lttng channel buffers */
50 /* initial attributes */
51 struct ustctl_consumer_channel_attr attr
;
52 int wait_fd
; /* monitor close() */
53 int wakeup_fd
; /* monitor close() */
57 * Stream representation within consumer.
59 struct ustctl_consumer_stream
{
60 struct lttng_ust_shm_handle
*handle
; /* shared-memory handle */
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 __attribute__((visibility("hidden")))
99 extern void lttng_counter_client_percpu_32_modular_init(void);
101 __attribute__((visibility("hidden")))
102 extern void lttng_counter_client_percpu_32_modular_exit(void);
104 __attribute__((visibility("hidden")))
105 extern void lttng_counter_client_percpu_64_modular_init(void);
107 __attribute__((visibility("hidden")))
108 extern void lttng_counter_client_percpu_64_modular_exit(void);
110 int ustctl_release_handle(int sock
, int handle
)
112 struct ustcomm_ust_msg lum
;
113 struct ustcomm_ust_reply lur
;
115 if (sock
< 0 || handle
< 0)
117 memset(&lum
, 0, sizeof(lum
));
119 lum
.cmd
= LTTNG_UST_ABI_RELEASE
;
120 return ustcomm_send_app_cmd(sock
, &lum
, &lur
);
124 * If sock is negative, it means we don't have to notify the other side
125 * (e.g. application has already vanished).
127 int ustctl_release_object(int sock
, struct lttng_ust_abi_object_data
*data
)
134 switch (data
->type
) {
135 case LTTNG_UST_ABI_OBJECT_TYPE_CHANNEL
:
136 if (data
->u
.channel
.wakeup_fd
>= 0) {
137 ret
= close(data
->u
.channel
.wakeup_fd
);
142 data
->u
.channel
.wakeup_fd
= -1;
144 free(data
->u
.channel
.data
);
145 data
->u
.channel
.data
= NULL
;
147 case LTTNG_UST_ABI_OBJECT_TYPE_STREAM
:
148 if (data
->u
.stream
.shm_fd
>= 0) {
149 ret
= close(data
->u
.stream
.shm_fd
);
154 data
->u
.stream
.shm_fd
= -1;
156 if (data
->u
.stream
.wakeup_fd
>= 0) {
157 ret
= close(data
->u
.stream
.wakeup_fd
);
162 data
->u
.stream
.wakeup_fd
= -1;
165 case LTTNG_UST_ABI_OBJECT_TYPE_EVENT
:
166 case LTTNG_UST_ABI_OBJECT_TYPE_CONTEXT
:
167 case LTTNG_UST_ABI_OBJECT_TYPE_EVENT_NOTIFIER_GROUP
:
168 case LTTNG_UST_ABI_OBJECT_TYPE_EVENT_NOTIFIER
:
170 case LTTNG_UST_ABI_OBJECT_TYPE_COUNTER
:
171 free(data
->u
.counter
.data
);
172 data
->u
.counter
.data
= NULL
;
174 case LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_GLOBAL
:
175 if (data
->u
.counter_global
.shm_fd
>= 0) {
176 ret
= close(data
->u
.counter_global
.shm_fd
);
181 data
->u
.counter_global
.shm_fd
= -1;
184 case LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_CPU
:
185 if (data
->u
.counter_cpu
.shm_fd
>= 0) {
186 ret
= close(data
->u
.counter_cpu
.shm_fd
);
191 data
->u
.counter_cpu
.shm_fd
= -1;
197 return ustctl_release_handle(sock
, data
->handle
);
201 * Send registration done packet to the application.
203 int ustctl_register_done(int sock
)
205 struct ustcomm_ust_msg lum
;
206 struct ustcomm_ust_reply lur
;
209 DBG("Sending register done command to %d", sock
);
210 memset(&lum
, 0, sizeof(lum
));
211 lum
.handle
= LTTNG_UST_ABI_ROOT_HANDLE
;
212 lum
.cmd
= LTTNG_UST_ABI_REGISTER_DONE
;
213 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
220 * returns session handle.
222 int ustctl_create_session(int sock
)
224 struct ustcomm_ust_msg lum
;
225 struct ustcomm_ust_reply lur
;
226 int ret
, session_handle
;
229 memset(&lum
, 0, sizeof(lum
));
230 lum
.handle
= LTTNG_UST_ABI_ROOT_HANDLE
;
231 lum
.cmd
= LTTNG_UST_ABI_SESSION
;
232 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
235 session_handle
= lur
.ret_val
;
236 DBG("received session handle %u", session_handle
);
237 return session_handle
;
240 int ustctl_create_event(int sock
, struct lttng_ust_abi_event
*ev
,
241 struct lttng_ust_abi_object_data
*channel_data
,
242 struct lttng_ust_abi_object_data
**_event_data
)
244 struct ustcomm_ust_msg lum
;
245 struct ustcomm_ust_reply lur
;
246 struct lttng_ust_abi_object_data
*event_data
;
249 if (!channel_data
|| !_event_data
)
252 event_data
= zmalloc(sizeof(*event_data
));
255 event_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_EVENT
;
256 memset(&lum
, 0, sizeof(lum
));
257 lum
.handle
= channel_data
->handle
;
258 lum
.cmd
= LTTNG_UST_ABI_EVENT
;
259 strncpy(lum
.u
.event
.name
, ev
->name
,
260 LTTNG_UST_ABI_SYM_NAME_LEN
);
261 lum
.u
.event
.instrumentation
= ev
->instrumentation
;
262 lum
.u
.event
.loglevel_type
= ev
->loglevel_type
;
263 lum
.u
.event
.loglevel
= ev
->loglevel
;
264 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
269 event_data
->handle
= lur
.ret_val
;
270 DBG("received event handle %u", event_data
->handle
);
271 *_event_data
= event_data
;
275 int ustctl_add_context(int sock
, struct lttng_ust_context_attr
*ctx
,
276 struct lttng_ust_abi_object_data
*obj_data
,
277 struct lttng_ust_abi_object_data
**_context_data
)
279 struct ustcomm_ust_msg lum
;
280 struct ustcomm_ust_reply lur
;
281 struct lttng_ust_abi_object_data
*context_data
= NULL
;
286 if (!obj_data
|| !_context_data
) {
291 context_data
= zmalloc(sizeof(*context_data
));
296 context_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_CONTEXT
;
297 memset(&lum
, 0, sizeof(lum
));
298 lum
.handle
= obj_data
->handle
;
299 lum
.cmd
= LTTNG_UST_ABI_CONTEXT
;
301 lum
.u
.context
.ctx
= ctx
->ctx
;
303 case LTTNG_UST_ABI_CONTEXT_PERF_THREAD_COUNTER
:
304 lum
.u
.context
.u
.perf_counter
= ctx
->u
.perf_counter
;
306 case LTTNG_UST_ABI_CONTEXT_APP_CONTEXT
:
308 size_t provider_name_len
= strlen(
309 ctx
->u
.app_ctx
.provider_name
) + 1;
310 size_t ctx_name_len
= strlen(ctx
->u
.app_ctx
.ctx_name
) + 1;
312 lum
.u
.context
.u
.app_ctx
.provider_name_len
= provider_name_len
;
313 lum
.u
.context
.u
.app_ctx
.ctx_name_len
= ctx_name_len
;
315 len
= provider_name_len
+ ctx_name_len
;
321 memcpy(buf
, ctx
->u
.app_ctx
.provider_name
,
323 memcpy(buf
+ provider_name_len
, ctx
->u
.app_ctx
.ctx_name
,
330 ret
= ustcomm_send_app_msg(sock
, &lum
);
334 /* send var len ctx_name */
335 ret
= ustcomm_send_unix_sock(sock
, buf
, len
);
344 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
348 context_data
->handle
= -1;
349 DBG("Context created successfully");
350 *_context_data
= context_data
;
358 int ustctl_set_filter(int sock
, struct lttng_ust_abi_filter_bytecode
*bytecode
,
359 struct lttng_ust_abi_object_data
*obj_data
)
361 struct ustcomm_ust_msg lum
;
362 struct ustcomm_ust_reply lur
;
368 memset(&lum
, 0, sizeof(lum
));
369 lum
.handle
= obj_data
->handle
;
370 lum
.cmd
= LTTNG_UST_ABI_FILTER
;
371 lum
.u
.filter
.data_size
= bytecode
->len
;
372 lum
.u
.filter
.reloc_offset
= bytecode
->reloc_offset
;
373 lum
.u
.filter
.seqnum
= bytecode
->seqnum
;
375 ret
= ustcomm_send_app_msg(sock
, &lum
);
378 /* send var len bytecode */
379 ret
= ustcomm_send_unix_sock(sock
, bytecode
->data
,
384 if (ret
!= bytecode
->len
)
386 return ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
389 int ustctl_set_capture(int sock
, struct lttng_ust_abi_capture_bytecode
*bytecode
,
390 struct lttng_ust_abi_object_data
*obj_data
)
392 struct ustcomm_ust_msg lum
;
393 struct ustcomm_ust_reply lur
;
399 memset(&lum
, 0, sizeof(lum
));
400 lum
.handle
= obj_data
->handle
;
401 lum
.cmd
= LTTNG_UST_ABI_CAPTURE
;
402 lum
.u
.capture
.data_size
= bytecode
->len
;
403 lum
.u
.capture
.reloc_offset
= bytecode
->reloc_offset
;
404 lum
.u
.capture
.seqnum
= bytecode
->seqnum
;
406 ret
= ustcomm_send_app_msg(sock
, &lum
);
409 /* send var len bytecode */
410 ret
= ustcomm_send_unix_sock(sock
, bytecode
->data
,
415 if (ret
!= bytecode
->len
)
417 return ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
420 int ustctl_set_exclusion(int sock
, struct lttng_ust_abi_event_exclusion
*exclusion
,
421 struct lttng_ust_abi_object_data
*obj_data
)
423 struct ustcomm_ust_msg lum
;
424 struct ustcomm_ust_reply lur
;
431 memset(&lum
, 0, sizeof(lum
));
432 lum
.handle
= obj_data
->handle
;
433 lum
.cmd
= LTTNG_UST_ABI_EXCLUSION
;
434 lum
.u
.exclusion
.count
= exclusion
->count
;
436 ret
= ustcomm_send_app_msg(sock
, &lum
);
441 /* send var len exclusion names */
442 ret
= ustcomm_send_unix_sock(sock
,
444 exclusion
->count
* LTTNG_UST_ABI_SYM_NAME_LEN
);
448 if (ret
!= exclusion
->count
* LTTNG_UST_ABI_SYM_NAME_LEN
) {
451 return ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
454 /* Enable event, channel and session ioctl */
455 int ustctl_enable(int sock
, struct lttng_ust_abi_object_data
*object
)
457 struct ustcomm_ust_msg lum
;
458 struct ustcomm_ust_reply lur
;
464 memset(&lum
, 0, sizeof(lum
));
465 lum
.handle
= object
->handle
;
466 lum
.cmd
= LTTNG_UST_ABI_ENABLE
;
467 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
470 DBG("enabled handle %u", object
->handle
);
474 /* Disable event, channel and session ioctl */
475 int ustctl_disable(int sock
, struct lttng_ust_abi_object_data
*object
)
477 struct ustcomm_ust_msg lum
;
478 struct ustcomm_ust_reply lur
;
484 memset(&lum
, 0, sizeof(lum
));
485 lum
.handle
= object
->handle
;
486 lum
.cmd
= LTTNG_UST_ABI_DISABLE
;
487 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
490 DBG("disable handle %u", object
->handle
);
494 int ustctl_start_session(int sock
, int handle
)
496 struct lttng_ust_abi_object_data obj
;
499 return ustctl_enable(sock
, &obj
);
502 int ustctl_stop_session(int sock
, int handle
)
504 struct lttng_ust_abi_object_data obj
;
507 return ustctl_disable(sock
, &obj
);
510 int ustctl_create_event_notifier_group(int sock
, int pipe_fd
,
511 struct lttng_ust_abi_object_data
**_event_notifier_group_data
)
513 struct lttng_ust_abi_object_data
*event_notifier_group_data
;
514 struct ustcomm_ust_msg lum
;
515 struct ustcomm_ust_reply lur
;
519 if (!_event_notifier_group_data
)
522 event_notifier_group_data
= zmalloc(sizeof(*event_notifier_group_data
));
523 if (!event_notifier_group_data
)
526 event_notifier_group_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_EVENT_NOTIFIER_GROUP
;
528 memset(&lum
, 0, sizeof(lum
));
529 lum
.handle
= LTTNG_UST_ABI_ROOT_HANDLE
;
530 lum
.cmd
= LTTNG_UST_ABI_EVENT_NOTIFIER_GROUP_CREATE
;
532 ret
= ustcomm_send_app_msg(sock
, &lum
);
536 /* Send event_notifier notification pipe. */
537 len
= ustcomm_send_fds_unix_sock(sock
, &pipe_fd
, 1);
543 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
547 event_notifier_group_data
->handle
= lur
.ret_val
;
548 DBG("received event_notifier group handle %d", event_notifier_group_data
->handle
);
550 *_event_notifier_group_data
= event_notifier_group_data
;
555 free(event_notifier_group_data
);
561 int ustctl_create_event_notifier(int sock
, struct lttng_ust_abi_event_notifier
*event_notifier
,
562 struct lttng_ust_abi_object_data
*event_notifier_group
,
563 struct lttng_ust_abi_object_data
**_event_notifier_data
)
565 struct ustcomm_ust_msg lum
;
566 struct ustcomm_ust_reply lur
;
567 struct lttng_ust_abi_object_data
*event_notifier_data
;
571 if (!event_notifier_group
|| !_event_notifier_data
)
574 event_notifier_data
= zmalloc(sizeof(*event_notifier_data
));
575 if (!event_notifier_data
)
578 event_notifier_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_EVENT_NOTIFIER
;
580 memset(&lum
, 0, sizeof(lum
));
581 lum
.handle
= event_notifier_group
->handle
;
582 lum
.cmd
= LTTNG_UST_ABI_EVENT_NOTIFIER_CREATE
;
583 lum
.u
.event_notifier
.len
= sizeof(*event_notifier
);
585 ret
= ustcomm_send_app_msg(sock
, &lum
);
587 free(event_notifier_data
);
590 /* Send struct lttng_ust_abi_event_notifier */
591 len
= ustcomm_send_unix_sock(sock
, event_notifier
, sizeof(*event_notifier
));
592 if (len
!= sizeof(*event_notifier
)) {
593 free(event_notifier_data
);
599 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
601 free(event_notifier_data
);
604 event_notifier_data
->handle
= lur
.ret_val
;
605 DBG("received event_notifier handle %u", event_notifier_data
->handle
);
606 *_event_notifier_data
= event_notifier_data
;
611 int ustctl_tracepoint_list(int sock
)
613 struct ustcomm_ust_msg lum
;
614 struct ustcomm_ust_reply lur
;
615 int ret
, tp_list_handle
;
617 memset(&lum
, 0, sizeof(lum
));
618 lum
.handle
= LTTNG_UST_ABI_ROOT_HANDLE
;
619 lum
.cmd
= LTTNG_UST_ABI_TRACEPOINT_LIST
;
620 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
623 tp_list_handle
= lur
.ret_val
;
624 DBG("received tracepoint list handle %u", tp_list_handle
);
625 return tp_list_handle
;
628 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
629 struct lttng_ust_abi_tracepoint_iter
*iter
)
631 struct ustcomm_ust_msg lum
;
632 struct ustcomm_ust_reply lur
;
638 memset(&lum
, 0, sizeof(lum
));
639 lum
.handle
= tp_list_handle
;
640 lum
.cmd
= LTTNG_UST_ABI_TRACEPOINT_LIST_GET
;
641 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
644 DBG("received tracepoint list entry name %s loglevel %d",
645 lur
.u
.tracepoint
.name
,
646 lur
.u
.tracepoint
.loglevel
);
647 memcpy(iter
, &lur
.u
.tracepoint
, sizeof(*iter
));
651 int ustctl_tracepoint_field_list(int sock
)
653 struct ustcomm_ust_msg lum
;
654 struct ustcomm_ust_reply lur
;
655 int ret
, tp_field_list_handle
;
657 memset(&lum
, 0, sizeof(lum
));
658 lum
.handle
= LTTNG_UST_ABI_ROOT_HANDLE
;
659 lum
.cmd
= LTTNG_UST_ABI_TRACEPOINT_FIELD_LIST
;
660 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
663 tp_field_list_handle
= lur
.ret_val
;
664 DBG("received tracepoint field list handle %u", tp_field_list_handle
);
665 return tp_field_list_handle
;
668 int ustctl_tracepoint_field_list_get(int sock
, int tp_field_list_handle
,
669 struct lttng_ust_abi_field_iter
*iter
)
671 struct ustcomm_ust_msg lum
;
672 struct ustcomm_ust_reply lur
;
679 memset(&lum
, 0, sizeof(lum
));
680 lum
.handle
= tp_field_list_handle
;
681 lum
.cmd
= LTTNG_UST_ABI_TRACEPOINT_FIELD_LIST_GET
;
682 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
685 len
= ustcomm_recv_unix_sock(sock
, iter
, sizeof(*iter
));
686 if (len
!= sizeof(*iter
)) {
689 DBG("received tracepoint field list entry event_name %s event_loglevel %d field_name %s field_type %d",
697 int ustctl_tracer_version(int sock
, struct lttng_ust_abi_tracer_version
*v
)
699 struct ustcomm_ust_msg lum
;
700 struct ustcomm_ust_reply lur
;
706 memset(&lum
, 0, sizeof(lum
));
707 lum
.handle
= LTTNG_UST_ABI_ROOT_HANDLE
;
708 lum
.cmd
= LTTNG_UST_ABI_TRACER_VERSION
;
709 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
712 memcpy(v
, &lur
.u
.version
, sizeof(*v
));
713 DBG("received tracer version");
717 int ustctl_wait_quiescent(int sock
)
719 struct ustcomm_ust_msg lum
;
720 struct ustcomm_ust_reply lur
;
723 memset(&lum
, 0, sizeof(lum
));
724 lum
.handle
= LTTNG_UST_ABI_ROOT_HANDLE
;
725 lum
.cmd
= LTTNG_UST_ABI_WAIT_QUIESCENT
;
726 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
729 DBG("waited for quiescent state");
733 int ustctl_calibrate(int sock
, struct lttng_ust_abi_calibrate
*calibrate
)
741 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_abi_object_data
*object
)
743 struct ustcomm_ust_msg lum
;
744 struct ustcomm_ust_reply lur
;
750 memset(&lum
, 0, sizeof(lum
));
751 lum
.handle
= object
->handle
;
752 lum
.cmd
= LTTNG_UST_ABI_FLUSH_BUFFER
;
753 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
756 DBG("flushed buffer handle %u", object
->handle
);
761 int ustctl_send_channel(int sock
,
762 enum lttng_ust_abi_chan_type type
,
772 len
= ustcomm_send_unix_sock(sock
, &size
, sizeof(size
));
773 if (len
!= sizeof(size
)) {
780 /* Send channel type */
781 len
= ustcomm_send_unix_sock(sock
, &type
, sizeof(type
));
782 if (len
!= sizeof(type
)) {
790 /* Send channel data */
791 len
= ustcomm_send_unix_sock(sock
, data
, size
);
800 len
= ustcomm_send_fds_unix_sock(sock
, &wakeup_fd
, 1);
811 int ustctl_send_stream(int sock
,
813 uint64_t memory_map_size
,
814 int shm_fd
, int wakeup_fd
,
822 /* finish iteration */
825 len
= ustcomm_send_unix_sock(sock
, &v
, sizeof(v
));
826 if (len
!= sizeof(v
)) {
836 len
= ustcomm_send_unix_sock(sock
, &memory_map_size
,
837 sizeof(memory_map_size
));
838 if (len
!= sizeof(memory_map_size
)) {
846 len
= ustcomm_send_unix_sock(sock
, &stream_nr
,
848 if (len
!= sizeof(stream_nr
)) {
856 /* Send shm fd and wakeup fd */
859 len
= ustcomm_send_fds_unix_sock(sock
, fds
, 2);
869 int ustctl_recv_channel_from_consumer(int sock
,
870 struct lttng_ust_abi_object_data
**_channel_data
)
872 struct lttng_ust_abi_object_data
*channel_data
;
877 channel_data
= zmalloc(sizeof(*channel_data
));
882 channel_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_CHANNEL
;
883 channel_data
->handle
= -1;
886 len
= ustcomm_recv_unix_sock(sock
, &channel_data
->size
,
887 sizeof(channel_data
->size
));
888 if (len
!= sizeof(channel_data
->size
)) {
896 /* recv channel type */
897 len
= ustcomm_recv_unix_sock(sock
, &channel_data
->u
.channel
.type
,
898 sizeof(channel_data
->u
.channel
.type
));
899 if (len
!= sizeof(channel_data
->u
.channel
.type
)) {
907 /* recv channel data */
908 channel_data
->u
.channel
.data
= zmalloc(channel_data
->size
);
909 if (!channel_data
->u
.channel
.data
) {
913 len
= ustcomm_recv_unix_sock(sock
, channel_data
->u
.channel
.data
,
915 if (len
!= channel_data
->size
) {
920 goto error_recv_data
;
923 len
= ustcomm_recv_fds_unix_sock(sock
, &wakeup_fd
, 1);
927 goto error_recv_data
;
930 goto error_recv_data
;
933 channel_data
->u
.channel
.wakeup_fd
= wakeup_fd
;
934 *_channel_data
= channel_data
;
938 free(channel_data
->u
.channel
.data
);
945 int ustctl_recv_stream_from_consumer(int sock
,
946 struct lttng_ust_abi_object_data
**_stream_data
)
948 struct lttng_ust_abi_object_data
*stream_data
;
953 stream_data
= zmalloc(sizeof(*stream_data
));
959 stream_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_STREAM
;
960 stream_data
->handle
= -1;
963 len
= ustcomm_recv_unix_sock(sock
, &stream_data
->size
,
964 sizeof(stream_data
->size
));
965 if (len
!= sizeof(stream_data
->size
)) {
972 if (stream_data
->size
== -1) {
973 ret
= -LTTNG_UST_ERR_NOENT
;
978 len
= ustcomm_recv_unix_sock(sock
, &stream_data
->u
.stream
.stream_nr
,
979 sizeof(stream_data
->u
.stream
.stream_nr
));
980 if (len
!= sizeof(stream_data
->u
.stream
.stream_nr
)) {
988 /* recv shm fd and wakeup fd */
989 len
= ustcomm_recv_fds_unix_sock(sock
, fds
, 2);
999 stream_data
->u
.stream
.shm_fd
= fds
[0];
1000 stream_data
->u
.stream
.wakeup_fd
= fds
[1];
1001 *_stream_data
= stream_data
;
1010 int ustctl_send_channel_to_ust(int sock
, int session_handle
,
1011 struct lttng_ust_abi_object_data
*channel_data
)
1013 struct ustcomm_ust_msg lum
;
1014 struct ustcomm_ust_reply lur
;
1020 memset(&lum
, 0, sizeof(lum
));
1021 lum
.handle
= session_handle
;
1022 lum
.cmd
= LTTNG_UST_ABI_CHANNEL
;
1023 lum
.u
.channel
.len
= channel_data
->size
;
1024 lum
.u
.channel
.type
= channel_data
->u
.channel
.type
;
1025 ret
= ustcomm_send_app_msg(sock
, &lum
);
1029 ret
= ustctl_send_channel(sock
,
1030 channel_data
->u
.channel
.type
,
1031 channel_data
->u
.channel
.data
,
1033 channel_data
->u
.channel
.wakeup_fd
,
1037 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
1039 channel_data
->handle
= lur
.ret_val
;
1044 int ustctl_send_stream_to_ust(int sock
,
1045 struct lttng_ust_abi_object_data
*channel_data
,
1046 struct lttng_ust_abi_object_data
*stream_data
)
1048 struct ustcomm_ust_msg lum
;
1049 struct ustcomm_ust_reply lur
;
1052 memset(&lum
, 0, sizeof(lum
));
1053 lum
.handle
= channel_data
->handle
;
1054 lum
.cmd
= LTTNG_UST_ABI_STREAM
;
1055 lum
.u
.stream
.len
= stream_data
->size
;
1056 lum
.u
.stream
.stream_nr
= stream_data
->u
.stream
.stream_nr
;
1057 ret
= ustcomm_send_app_msg(sock
, &lum
);
1061 assert(stream_data
);
1062 assert(stream_data
->type
== LTTNG_UST_ABI_OBJECT_TYPE_STREAM
);
1064 ret
= ustctl_send_stream(sock
,
1065 stream_data
->u
.stream
.stream_nr
,
1067 stream_data
->u
.stream
.shm_fd
,
1068 stream_data
->u
.stream
.wakeup_fd
, 1);
1071 return ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
1074 int ustctl_duplicate_ust_object_data(struct lttng_ust_abi_object_data
**dest
,
1075 struct lttng_ust_abi_object_data
*src
)
1077 struct lttng_ust_abi_object_data
*obj
;
1080 if (src
->handle
!= -1) {
1085 obj
= zmalloc(sizeof(*obj
));
1091 obj
->type
= src
->type
;
1092 obj
->handle
= src
->handle
;
1093 obj
->size
= src
->size
;
1095 switch (obj
->type
) {
1096 case LTTNG_UST_ABI_OBJECT_TYPE_CHANNEL
:
1098 obj
->u
.channel
.type
= src
->u
.channel
.type
;
1099 if (src
->u
.channel
.wakeup_fd
>= 0) {
1100 obj
->u
.channel
.wakeup_fd
=
1101 dup(src
->u
.channel
.wakeup_fd
);
1102 if (obj
->u
.channel
.wakeup_fd
< 0) {
1104 goto chan_error_wakeup_fd
;
1107 obj
->u
.channel
.wakeup_fd
=
1108 src
->u
.channel
.wakeup_fd
;
1110 obj
->u
.channel
.data
= zmalloc(obj
->size
);
1111 if (!obj
->u
.channel
.data
) {
1113 goto chan_error_alloc
;
1115 memcpy(obj
->u
.channel
.data
, src
->u
.channel
.data
, obj
->size
);
1119 if (src
->u
.channel
.wakeup_fd
>= 0) {
1122 closeret
= close(obj
->u
.channel
.wakeup_fd
);
1127 chan_error_wakeup_fd
:
1132 case LTTNG_UST_ABI_OBJECT_TYPE_STREAM
:
1134 obj
->u
.stream
.stream_nr
= src
->u
.stream
.stream_nr
;
1135 if (src
->u
.stream
.wakeup_fd
>= 0) {
1136 obj
->u
.stream
.wakeup_fd
=
1137 dup(src
->u
.stream
.wakeup_fd
);
1138 if (obj
->u
.stream
.wakeup_fd
< 0) {
1140 goto stream_error_wakeup_fd
;
1143 obj
->u
.stream
.wakeup_fd
=
1144 src
->u
.stream
.wakeup_fd
;
1147 if (src
->u
.stream
.shm_fd
>= 0) {
1148 obj
->u
.stream
.shm_fd
=
1149 dup(src
->u
.stream
.shm_fd
);
1150 if (obj
->u
.stream
.shm_fd
< 0) {
1152 goto stream_error_shm_fd
;
1155 obj
->u
.stream
.shm_fd
=
1156 src
->u
.stream
.shm_fd
;
1160 stream_error_shm_fd
:
1161 if (src
->u
.stream
.wakeup_fd
>= 0) {
1164 closeret
= close(obj
->u
.stream
.wakeup_fd
);
1169 stream_error_wakeup_fd
:
1173 case LTTNG_UST_ABI_OBJECT_TYPE_COUNTER
:
1175 obj
->u
.counter
.data
= zmalloc(obj
->size
);
1176 if (!obj
->u
.counter
.data
) {
1180 memcpy(obj
->u
.counter
.data
, src
->u
.counter
.data
, obj
->size
);
1184 case LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_GLOBAL
:
1186 if (src
->u
.counter_global
.shm_fd
>= 0) {
1187 obj
->u
.counter_global
.shm_fd
=
1188 dup(src
->u
.counter_global
.shm_fd
);
1189 if (obj
->u
.counter_global
.shm_fd
< 0) {
1197 case LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_CPU
:
1199 obj
->u
.counter_cpu
.cpu_nr
= src
->u
.counter_cpu
.cpu_nr
;
1200 if (src
->u
.counter_cpu
.shm_fd
>= 0) {
1201 obj
->u
.counter_cpu
.shm_fd
=
1202 dup(src
->u
.counter_cpu
.shm_fd
);
1203 if (obj
->u
.counter_cpu
.shm_fd
< 0) {
1226 /* Buffer operations */
1228 int ustctl_get_nr_stream_per_channel(void)
1230 return num_possible_cpus();
1233 struct ustctl_consumer_channel
*
1234 ustctl_create_channel(struct ustctl_consumer_channel_attr
*attr
,
1235 const int *stream_fds
, int nr_stream_fds
)
1237 struct ustctl_consumer_channel
*chan
;
1238 const char *transport_name
;
1239 struct lttng_transport
*transport
;
1241 switch (attr
->type
) {
1242 case LTTNG_UST_ABI_CHAN_PER_CPU
:
1243 if (attr
->output
== LTTNG_UST_ABI_MMAP
) {
1244 if (attr
->overwrite
) {
1245 if (attr
->read_timer_interval
== 0) {
1246 transport_name
= "relay-overwrite-mmap";
1248 transport_name
= "relay-overwrite-rt-mmap";
1251 if (attr
->read_timer_interval
== 0) {
1252 transport_name
= "relay-discard-mmap";
1254 transport_name
= "relay-discard-rt-mmap";
1261 case LTTNG_UST_ABI_CHAN_METADATA
:
1262 if (attr
->output
== LTTNG_UST_ABI_MMAP
)
1263 transport_name
= "relay-metadata-mmap";
1268 transport_name
= "<unknown>";
1272 transport
= lttng_ust_transport_find(transport_name
);
1274 DBG("LTTng transport %s not found\n",
1279 chan
= zmalloc(sizeof(*chan
));
1283 chan
->chan
= transport
->ops
.priv
->channel_create(transport_name
, NULL
,
1284 attr
->subbuf_size
, attr
->num_subbuf
,
1285 attr
->switch_timer_interval
,
1286 attr
->read_timer_interval
,
1287 attr
->uuid
, attr
->chan_id
,
1288 stream_fds
, nr_stream_fds
,
1289 attr
->blocking_timeout
);
1293 chan
->chan
->ops
= &transport
->ops
;
1294 memcpy(&chan
->attr
, attr
, sizeof(chan
->attr
));
1295 chan
->wait_fd
= ustctl_channel_get_wait_fd(chan
);
1296 chan
->wakeup_fd
= ustctl_channel_get_wakeup_fd(chan
);
1304 void ustctl_destroy_channel(struct ustctl_consumer_channel
*chan
)
1306 (void) ustctl_channel_close_wait_fd(chan
);
1307 (void) ustctl_channel_close_wakeup_fd(chan
);
1308 chan
->chan
->ops
->priv
->channel_destroy(chan
->chan
);
1312 int ustctl_send_channel_to_sessiond(int sock
,
1313 struct ustctl_consumer_channel
*channel
)
1315 struct shm_object_table
*table
;
1317 table
= channel
->chan
->handle
->table
;
1318 if (table
->size
<= 0)
1320 return ustctl_send_channel(sock
,
1322 table
->objects
[0].memory_map
,
1323 table
->objects
[0].memory_map_size
,
1328 int ustctl_send_stream_to_sessiond(int sock
,
1329 struct ustctl_consumer_stream
*stream
)
1332 return ustctl_send_stream(sock
, -1U, -1U, -1, -1, 0);
1334 return ustctl_send_stream(sock
,
1336 stream
->memory_map_size
,
1337 stream
->shm_fd
, stream
->wakeup_fd
,
1341 int ustctl_write_metadata_to_channel(
1342 struct ustctl_consumer_channel
*channel
,
1343 const char *metadata_str
, /* NOT null-terminated */
1344 size_t len
) /* metadata length */
1346 struct lttng_ust_lib_ring_buffer_ctx ctx
;
1347 struct lttng_ust_channel_buffer
*lttng_chan_buf
= channel
->chan
;
1348 const char *str
= metadata_str
;
1349 int ret
= 0, waitret
;
1350 size_t reserve_len
, pos
;
1352 for (pos
= 0; pos
< len
; pos
+= reserve_len
) {
1353 reserve_len
= min_t(size_t,
1354 lttng_chan_buf
->ops
->priv
->packet_avail_size(lttng_chan_buf
->chan
, lttng_chan_buf
->handle
),
1356 lib_ring_buffer_ctx_init(&ctx
, lttng_chan_buf
->chan
, NULL
, reserve_len
,
1357 sizeof(char), -1, lttng_chan_buf
->handle
);
1359 * We don't care about metadata buffer's records lost
1360 * count, because we always retry here. Report error if
1361 * we need to bail out after timeout or being
1364 waitret
= wait_cond_interruptible_timeout(
1366 ret
= lttng_chan_buf
->ops
->event_reserve(&ctx
, 0);
1367 ret
!= -ENOBUFS
|| !ret
;
1369 LTTNG_METADATA_TIMEOUT_MSEC
);
1370 if (waitret
== -ETIMEDOUT
|| waitret
== -EINTR
|| ret
) {
1371 DBG("LTTng: Failure to write metadata to buffers (%s)\n",
1372 waitret
== -EINTR
? "interrupted" :
1373 (ret
== -ENOBUFS
? "timeout" : "I/O error"));
1374 if (waitret
== -EINTR
)
1378 lttng_chan_buf
->ops
->event_write(&ctx
, &str
[pos
], reserve_len
);
1379 lttng_chan_buf
->ops
->event_commit(&ctx
);
1386 * Write at most one packet in the channel.
1387 * Returns the number of bytes written on success, < 0 on error.
1389 ssize_t
ustctl_write_one_packet_to_channel(
1390 struct ustctl_consumer_channel
*channel
,
1391 const char *metadata_str
, /* NOT null-terminated */
1392 size_t len
) /* metadata length */
1394 struct lttng_ust_lib_ring_buffer_ctx ctx
;
1395 struct lttng_ust_channel_buffer
*lttng_chan_buf
= channel
->chan
;
1396 const char *str
= metadata_str
;
1397 ssize_t reserve_len
;
1400 reserve_len
= min_t(ssize_t
,
1401 lttng_chan_buf
->ops
->priv
->packet_avail_size(lttng_chan_buf
->chan
, lttng_chan_buf
->handle
),
1403 lib_ring_buffer_ctx_init(&ctx
, lttng_chan_buf
->chan
, NULL
, reserve_len
,
1404 sizeof(char), -1, lttng_chan_buf
->handle
);
1405 ret
= lttng_chan_buf
->ops
->event_reserve(&ctx
, 0);
1407 DBG("LTTng: event reservation failed");
1412 lttng_chan_buf
->ops
->event_write(&ctx
, str
, reserve_len
);
1413 lttng_chan_buf
->ops
->event_commit(&ctx
);
1419 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel
*consumer_chan
)
1421 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1424 chan
= consumer_chan
->chan
->chan
;
1425 ret
= ring_buffer_channel_close_wait_fd(&chan
->backend
.config
,
1426 chan
, chan
->handle
);
1428 consumer_chan
->wait_fd
= -1;
1432 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
)
1434 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1437 chan
= consumer_chan
->chan
->chan
;
1438 ret
= ring_buffer_channel_close_wakeup_fd(&chan
->backend
.config
,
1439 chan
, chan
->handle
);
1441 consumer_chan
->wakeup_fd
= -1;
1445 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream
*stream
)
1447 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1449 chan
= stream
->chan
->chan
->chan
;
1450 return ring_buffer_stream_close_wait_fd(&chan
->backend
.config
,
1451 chan
, stream
->handle
, stream
->cpu
);
1454 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream
*stream
)
1456 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1458 chan
= stream
->chan
->chan
->chan
;
1459 return ring_buffer_stream_close_wakeup_fd(&chan
->backend
.config
,
1460 chan
, stream
->handle
, stream
->cpu
);
1463 struct ustctl_consumer_stream
*
1464 ustctl_create_stream(struct ustctl_consumer_channel
*channel
,
1467 struct ustctl_consumer_stream
*stream
;
1468 struct lttng_ust_shm_handle
*handle
;
1469 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1470 int shm_fd
, wait_fd
, wakeup_fd
;
1471 uint64_t memory_map_size
;
1472 struct lttng_ust_lib_ring_buffer
*buf
;
1477 handle
= channel
->chan
->handle
;
1481 chan
= channel
->chan
->chan
;
1482 buf
= channel_get_ring_buffer(&chan
->backend
.config
,
1483 chan
, cpu
, handle
, &shm_fd
, &wait_fd
,
1484 &wakeup_fd
, &memory_map_size
);
1487 ret
= lib_ring_buffer_open_read(buf
, handle
);
1491 stream
= zmalloc(sizeof(*stream
));
1494 stream
->handle
= handle
;
1496 stream
->chan
= channel
;
1497 stream
->shm_fd
= shm_fd
;
1498 stream
->wait_fd
= wait_fd
;
1499 stream
->wakeup_fd
= wakeup_fd
;
1500 stream
->memory_map_size
= memory_map_size
;
1508 void ustctl_destroy_stream(struct ustctl_consumer_stream
*stream
)
1510 struct lttng_ust_lib_ring_buffer
*buf
;
1511 struct ustctl_consumer_channel
*consumer_chan
;
1515 consumer_chan
= stream
->chan
;
1516 (void) ustctl_stream_close_wait_fd(stream
);
1517 (void) ustctl_stream_close_wakeup_fd(stream
);
1518 lib_ring_buffer_release_read(buf
, consumer_chan
->chan
->handle
);
1522 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel
*chan
)
1526 return shm_get_wait_fd(chan
->chan
->handle
,
1527 &chan
->chan
->handle
->chan
._ref
);
1530 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel
*chan
)
1534 return shm_get_wakeup_fd(chan
->chan
->handle
,
1535 &chan
->chan
->handle
->chan
._ref
);
1538 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream
*stream
)
1540 struct lttng_ust_lib_ring_buffer
*buf
;
1541 struct ustctl_consumer_channel
*consumer_chan
;
1546 consumer_chan
= stream
->chan
;
1547 return shm_get_wait_fd(consumer_chan
->chan
->handle
, &buf
->self
._ref
);
1550 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream
*stream
)
1552 struct lttng_ust_lib_ring_buffer
*buf
;
1553 struct ustctl_consumer_channel
*consumer_chan
;
1558 consumer_chan
= stream
->chan
;
1559 return shm_get_wakeup_fd(consumer_chan
->chan
->handle
, &buf
->self
._ref
);
1562 /* For mmap mode, readable without "get" operation */
1564 void *ustctl_get_mmap_base(struct ustctl_consumer_stream
*stream
)
1566 struct lttng_ust_lib_ring_buffer
*buf
;
1567 struct ustctl_consumer_channel
*consumer_chan
;
1572 consumer_chan
= stream
->chan
;
1573 return shmp(consumer_chan
->chan
->handle
, buf
->backend
.memory_map
);
1576 /* returns the length to mmap. */
1577 int ustctl_get_mmap_len(struct ustctl_consumer_stream
*stream
,
1580 struct ustctl_consumer_channel
*consumer_chan
;
1581 unsigned long mmap_buf_len
;
1582 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1586 consumer_chan
= stream
->chan
;
1587 chan
= consumer_chan
->chan
->chan
;
1588 if (chan
->backend
.config
.output
!= RING_BUFFER_MMAP
)
1590 mmap_buf_len
= chan
->backend
.buf_size
;
1591 if (chan
->backend
.extra_reader_sb
)
1592 mmap_buf_len
+= chan
->backend
.subbuf_size
;
1593 if (mmap_buf_len
> INT_MAX
)
1595 *len
= mmap_buf_len
;
1599 /* returns the maximum size for sub-buffers. */
1600 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream
*stream
,
1603 struct ustctl_consumer_channel
*consumer_chan
;
1604 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1608 consumer_chan
= stream
->chan
;
1609 chan
= consumer_chan
->chan
->chan
;
1610 *len
= chan
->backend
.subbuf_size
;
1615 * For mmap mode, operate on the current packet (between get/put or
1616 * get_next/put_next).
1619 /* returns the offset of the subbuffer belonging to the mmap reader. */
1620 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream
*stream
,
1623 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1624 unsigned long sb_bindex
;
1625 struct lttng_ust_lib_ring_buffer
*buf
;
1626 struct ustctl_consumer_channel
*consumer_chan
;
1627 struct lttng_ust_lib_ring_buffer_backend_pages_shmp
*barray_idx
;
1628 struct lttng_ust_lib_ring_buffer_backend_pages
*pages
;
1633 consumer_chan
= stream
->chan
;
1634 chan
= consumer_chan
->chan
->chan
;
1635 if (chan
->backend
.config
.output
!= RING_BUFFER_MMAP
)
1637 sb_bindex
= subbuffer_id_get_index(&chan
->backend
.config
,
1638 buf
->backend
.buf_rsb
.id
);
1639 barray_idx
= shmp_index(consumer_chan
->chan
->handle
, buf
->backend
.array
,
1643 pages
= shmp(consumer_chan
->chan
->handle
, barray_idx
->shmp
);
1646 *off
= pages
->mmap_offset
;
1650 /* returns the size of the current sub-buffer, without padding (for mmap). */
1651 int ustctl_get_subbuf_size(struct ustctl_consumer_stream
*stream
,
1654 struct ustctl_consumer_channel
*consumer_chan
;
1655 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1656 struct lttng_ust_lib_ring_buffer
*buf
;
1662 consumer_chan
= stream
->chan
;
1663 chan
= consumer_chan
->chan
->chan
;
1664 *len
= lib_ring_buffer_get_read_data_size(&chan
->backend
.config
, buf
,
1665 consumer_chan
->chan
->handle
);
1669 /* returns the size of the current sub-buffer, without padding (for mmap). */
1670 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream
*stream
,
1673 struct ustctl_consumer_channel
*consumer_chan
;
1674 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1675 struct lttng_ust_lib_ring_buffer
*buf
;
1680 consumer_chan
= stream
->chan
;
1681 chan
= consumer_chan
->chan
->chan
;
1682 *len
= lib_ring_buffer_get_read_data_size(&chan
->backend
.config
, buf
,
1683 consumer_chan
->chan
->handle
);
1684 *len
= LTTNG_UST_PAGE_ALIGN(*len
);
1688 /* Get exclusive read access to the next sub-buffer that can be read. */
1689 int ustctl_get_next_subbuf(struct ustctl_consumer_stream
*stream
)
1691 struct lttng_ust_lib_ring_buffer
*buf
;
1692 struct ustctl_consumer_channel
*consumer_chan
;
1697 consumer_chan
= stream
->chan
;
1698 return lib_ring_buffer_get_next_subbuf(buf
,
1699 consumer_chan
->chan
->handle
);
1703 /* Release exclusive sub-buffer access, move consumer forward. */
1704 int ustctl_put_next_subbuf(struct ustctl_consumer_stream
*stream
)
1706 struct lttng_ust_lib_ring_buffer
*buf
;
1707 struct ustctl_consumer_channel
*consumer_chan
;
1712 consumer_chan
= stream
->chan
;
1713 lib_ring_buffer_put_next_subbuf(buf
, consumer_chan
->chan
->handle
);
1719 /* Get a snapshot of the current ring buffer producer and consumer positions */
1720 int ustctl_snapshot(struct ustctl_consumer_stream
*stream
)
1722 struct lttng_ust_lib_ring_buffer
*buf
;
1723 struct ustctl_consumer_channel
*consumer_chan
;
1728 consumer_chan
= stream
->chan
;
1729 return lib_ring_buffer_snapshot(buf
, &buf
->cons_snapshot
,
1730 &buf
->prod_snapshot
, consumer_chan
->chan
->handle
);
1734 * Get a snapshot of the current ring buffer producer and consumer positions
1735 * even if the consumed and produced positions are contained within the same
1738 int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream
*stream
)
1740 struct lttng_ust_lib_ring_buffer
*buf
;
1741 struct ustctl_consumer_channel
*consumer_chan
;
1746 consumer_chan
= stream
->chan
;
1747 return lib_ring_buffer_snapshot_sample_positions(buf
,
1748 &buf
->cons_snapshot
, &buf
->prod_snapshot
,
1749 consumer_chan
->chan
->handle
);
1752 /* Get the consumer position (iteration start) */
1753 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream
*stream
,
1756 struct lttng_ust_lib_ring_buffer
*buf
;
1761 *pos
= buf
->cons_snapshot
;
1765 /* Get the producer position (iteration end) */
1766 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream
*stream
,
1769 struct lttng_ust_lib_ring_buffer
*buf
;
1774 *pos
= buf
->prod_snapshot
;
1778 /* Get exclusive read access to the specified sub-buffer position */
1779 int ustctl_get_subbuf(struct ustctl_consumer_stream
*stream
,
1782 struct lttng_ust_lib_ring_buffer
*buf
;
1783 struct ustctl_consumer_channel
*consumer_chan
;
1788 consumer_chan
= stream
->chan
;
1789 return lib_ring_buffer_get_subbuf(buf
, *pos
,
1790 consumer_chan
->chan
->handle
);
1793 /* Release exclusive sub-buffer access */
1794 int ustctl_put_subbuf(struct ustctl_consumer_stream
*stream
)
1796 struct lttng_ust_lib_ring_buffer
*buf
;
1797 struct ustctl_consumer_channel
*consumer_chan
;
1802 consumer_chan
= stream
->chan
;
1803 lib_ring_buffer_put_subbuf(buf
, consumer_chan
->chan
->handle
);
1807 void ustctl_flush_buffer(struct ustctl_consumer_stream
*stream
,
1808 int producer_active
)
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
,
1817 producer_active
? SWITCH_ACTIVE
: SWITCH_FLUSH
,
1818 consumer_chan
->chan
->handle
);
1821 void ustctl_clear_buffer(struct ustctl_consumer_stream
*stream
)
1823 struct lttng_ust_lib_ring_buffer
*buf
;
1824 struct ustctl_consumer_channel
*consumer_chan
;
1828 consumer_chan
= stream
->chan
;
1829 lib_ring_buffer_switch_slow(buf
, SWITCH_ACTIVE
,
1830 consumer_chan
->chan
->handle
);
1831 lib_ring_buffer_clear_reader(buf
, consumer_chan
->chan
->handle
);
1835 struct lttng_ust_client_lib_ring_buffer_client_cb
*get_client_cb(
1836 struct lttng_ust_lib_ring_buffer
*buf
,
1837 struct lttng_ust_shm_handle
*handle
)
1839 struct lttng_ust_lib_ring_buffer_channel
*chan
;
1840 const struct lttng_ust_lib_ring_buffer_config
*config
;
1841 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1843 chan
= shmp(handle
, buf
->backend
.chan
);
1846 config
= &chan
->backend
.config
;
1847 if (!config
->cb_ptr
)
1849 client_cb
= caa_container_of(config
->cb_ptr
,
1850 struct lttng_ust_client_lib_ring_buffer_client_cb
,
1855 int ustctl_get_timestamp_begin(struct ustctl_consumer_stream
*stream
,
1856 uint64_t *timestamp_begin
)
1858 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1859 struct lttng_ust_lib_ring_buffer
*buf
;
1860 struct lttng_ust_shm_handle
*handle
;
1862 if (!stream
|| !timestamp_begin
)
1865 handle
= stream
->chan
->chan
->handle
;
1866 client_cb
= get_client_cb(buf
, handle
);
1869 return client_cb
->timestamp_begin(buf
, handle
, timestamp_begin
);
1872 int ustctl_get_timestamp_end(struct ustctl_consumer_stream
*stream
,
1873 uint64_t *timestamp_end
)
1875 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1876 struct lttng_ust_lib_ring_buffer
*buf
;
1877 struct lttng_ust_shm_handle
*handle
;
1879 if (!stream
|| !timestamp_end
)
1882 handle
= stream
->chan
->chan
->handle
;
1883 client_cb
= get_client_cb(buf
, handle
);
1886 return client_cb
->timestamp_end(buf
, handle
, timestamp_end
);
1889 int ustctl_get_events_discarded(struct ustctl_consumer_stream
*stream
,
1890 uint64_t *events_discarded
)
1892 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1893 struct lttng_ust_lib_ring_buffer
*buf
;
1894 struct lttng_ust_shm_handle
*handle
;
1896 if (!stream
|| !events_discarded
)
1899 handle
= stream
->chan
->chan
->handle
;
1900 client_cb
= get_client_cb(buf
, handle
);
1903 return client_cb
->events_discarded(buf
, handle
, events_discarded
);
1906 int ustctl_get_content_size(struct ustctl_consumer_stream
*stream
,
1907 uint64_t *content_size
)
1909 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1910 struct lttng_ust_lib_ring_buffer
*buf
;
1911 struct lttng_ust_shm_handle
*handle
;
1913 if (!stream
|| !content_size
)
1916 handle
= stream
->chan
->chan
->handle
;
1917 client_cb
= get_client_cb(buf
, handle
);
1920 return client_cb
->content_size(buf
, handle
, content_size
);
1923 int ustctl_get_packet_size(struct ustctl_consumer_stream
*stream
,
1924 uint64_t *packet_size
)
1926 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1927 struct lttng_ust_lib_ring_buffer
*buf
;
1928 struct lttng_ust_shm_handle
*handle
;
1930 if (!stream
|| !packet_size
)
1933 handle
= stream
->chan
->chan
->handle
;
1934 client_cb
= get_client_cb(buf
, handle
);
1937 return client_cb
->packet_size(buf
, handle
, packet_size
);
1940 int ustctl_get_stream_id(struct ustctl_consumer_stream
*stream
,
1941 uint64_t *stream_id
)
1943 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1944 struct lttng_ust_lib_ring_buffer
*buf
;
1945 struct lttng_ust_shm_handle
*handle
;
1947 if (!stream
|| !stream_id
)
1950 handle
= stream
->chan
->chan
->handle
;
1951 client_cb
= get_client_cb(buf
, handle
);
1954 return client_cb
->stream_id(buf
, handle
, stream_id
);
1957 int ustctl_get_current_timestamp(struct ustctl_consumer_stream
*stream
,
1960 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1961 struct lttng_ust_lib_ring_buffer
*buf
;
1962 struct lttng_ust_shm_handle
*handle
;
1967 handle
= stream
->chan
->chan
->handle
;
1968 client_cb
= get_client_cb(buf
, handle
);
1969 if (!client_cb
|| !client_cb
->current_timestamp
)
1971 return client_cb
->current_timestamp(buf
, handle
, ts
);
1974 int ustctl_get_sequence_number(struct ustctl_consumer_stream
*stream
,
1977 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1978 struct lttng_ust_lib_ring_buffer
*buf
;
1979 struct lttng_ust_shm_handle
*handle
;
1981 if (!stream
|| !seq
)
1984 handle
= stream
->chan
->chan
->handle
;
1985 client_cb
= get_client_cb(buf
, handle
);
1986 if (!client_cb
|| !client_cb
->sequence_number
)
1988 return client_cb
->sequence_number(buf
, handle
, seq
);
1991 int ustctl_get_instance_id(struct ustctl_consumer_stream
*stream
,
1994 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1995 struct lttng_ust_lib_ring_buffer
*buf
;
1996 struct lttng_ust_shm_handle
*handle
;
2001 handle
= stream
->chan
->chan
->handle
;
2002 client_cb
= get_client_cb(buf
, handle
);
2005 return client_cb
->instance_id(buf
, handle
, id
);
2008 #ifdef HAVE_PERF_EVENT
2010 int ustctl_has_perf_counters(void)
2017 int ustctl_has_perf_counters(void)
2026 * Override application pid/uid/gid with unix socket credentials. If
2027 * the application announced a pid matching our view, it means it is
2028 * within the same pid namespace, so expose the ppid provided by the
2032 int get_cred(int sock
,
2033 const struct ustctl_reg_msg
*reg_msg
,
2040 socklen_t ucred_len
= sizeof(struct ucred
);
2043 ret
= getsockopt(sock
, SOL_SOCKET
, SO_PEERCRED
, &ucred
, &ucred_len
);
2045 return -LTTNG_UST_ERR_PEERCRED
;
2047 DBG("Unix socket peercred [ pid: %u, uid: %u, gid: %u ], "
2048 "application registered claiming [ pid: %u, ppid: %u, uid: %u, gid: %u ]",
2049 ucred
.pid
, ucred
.uid
, ucred
.gid
,
2050 reg_msg
->pid
, reg_msg
->ppid
, reg_msg
->uid
, reg_msg
->gid
);
2052 ERR("Unix socket credential pid=0. Refusing application in distinct, non-nested pid namespace.");
2053 return -LTTNG_UST_ERR_PEERCRED_PID
;
2058 if (ucred
.pid
== reg_msg
->pid
) {
2059 *ppid
= reg_msg
->ppid
;
2065 #elif defined(__FreeBSD__)
2066 #include <sys/ucred.h>
2070 * Override application uid/gid with unix socket credentials. Use the
2071 * first group of the cr_groups.
2072 * Use the pid and ppid provided by the application on registration.
2075 int get_cred(int sock
,
2076 const struct ustctl_reg_msg
*reg_msg
,
2082 struct xucred xucred
;
2083 socklen_t xucred_len
= sizeof(struct xucred
);
2086 ret
= getsockopt(sock
, SOL_SOCKET
, LOCAL_PEERCRED
, &xucred
, &xucred_len
);
2088 return -LTTNG_UST_ERR_PEERCRED
;
2090 if (xucred
.cr_version
!= XUCRED_VERSION
|| xucred
.cr_ngroups
< 1) {
2091 return -LTTNG_UST_ERR_PEERCRED
;
2093 DBG("Unix socket peercred [ uid: %u, gid: %u ], "
2094 "application registered claiming [ pid: %d, ppid: %d, uid: %u, gid: %u ]",
2095 xucred
.cr_uid
, xucred
.cr_groups
[0],
2096 reg_msg
->pid
, reg_msg
->ppid
, reg_msg
->uid
, reg_msg
->gid
);
2097 *pid
= reg_msg
->pid
;
2098 *ppid
= reg_msg
->ppid
;
2099 *uid
= xucred
.cr_uid
;
2100 *gid
= xucred
.cr_groups
[0];
2104 #warning "Using insecure fallback: trusting user id provided by registered applications. Please consider implementing use of unix socket credentials on your platform."
2106 int get_cred(int sock
,
2107 const struct ustctl_reg_msg
*reg_msg
,
2113 DBG("Application registered claiming [ pid: %u, ppid: %d, uid: %u, gid: %u ]",
2114 reg_msg
->pid
, reg_msg
->ppid
, reg_msg
->uid
, reg_msg
->gid
);
2115 *pid
= reg_msg
->pid
;
2116 *ppid
= reg_msg
->ppid
;
2117 *uid
= reg_msg
->uid
;
2118 *gid
= reg_msg
->gid
;
2124 * Returns 0 on success, negative error value on error.
2126 int ustctl_recv_reg_msg(int sock
,
2127 enum ustctl_socket_type
*type
,
2134 uint32_t *bits_per_long
,
2135 uint32_t *uint8_t_alignment
,
2136 uint32_t *uint16_t_alignment
,
2137 uint32_t *uint32_t_alignment
,
2138 uint32_t *uint64_t_alignment
,
2139 uint32_t *long_alignment
,
2144 struct ustctl_reg_msg reg_msg
;
2146 len
= ustcomm_recv_unix_sock(sock
, ®_msg
, sizeof(reg_msg
));
2147 if (len
> 0 && len
!= sizeof(reg_msg
))
2154 if (reg_msg
.magic
== LTTNG_UST_ABI_COMM_MAGIC
) {
2155 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
?
2156 BIG_ENDIAN
: LITTLE_ENDIAN
;
2157 } else if (reg_msg
.magic
== bswap_32(LTTNG_UST_ABI_COMM_MAGIC
)) {
2158 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
?
2159 LITTLE_ENDIAN
: BIG_ENDIAN
;
2161 return -LTTNG_UST_ERR_INVAL_MAGIC
;
2163 switch (reg_msg
.socket_type
) {
2164 case 0: *type
= USTCTL_SOCKET_CMD
;
2166 case 1: *type
= USTCTL_SOCKET_NOTIFY
;
2169 return -LTTNG_UST_ERR_INVAL_SOCKET_TYPE
;
2171 *major
= reg_msg
.major
;
2172 *minor
= reg_msg
.minor
;
2173 *bits_per_long
= reg_msg
.bits_per_long
;
2174 *uint8_t_alignment
= reg_msg
.uint8_t_alignment
;
2175 *uint16_t_alignment
= reg_msg
.uint16_t_alignment
;
2176 *uint32_t_alignment
= reg_msg
.uint32_t_alignment
;
2177 *uint64_t_alignment
= reg_msg
.uint64_t_alignment
;
2178 *long_alignment
= reg_msg
.long_alignment
;
2179 memcpy(name
, reg_msg
.name
, LTTNG_UST_ABI_PROCNAME_LEN
);
2180 if (reg_msg
.major
< LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE
||
2181 reg_msg
.major
> LTTNG_UST_ABI_MAJOR_VERSION
) {
2182 return -LTTNG_UST_ERR_UNSUP_MAJOR
;
2184 return get_cred(sock
, ®_msg
, pid
, ppid
, uid
, gid
);
2187 int ustctl_recv_notify(int sock
, enum ustctl_notify_cmd
*notify_cmd
)
2189 struct ustcomm_notify_hdr header
;
2192 len
= ustcomm_recv_unix_sock(sock
, &header
, sizeof(header
));
2193 if (len
> 0 && len
!= sizeof(header
))
2199 switch (header
.notify_cmd
) {
2201 *notify_cmd
= USTCTL_NOTIFY_CMD_EVENT
;
2204 *notify_cmd
= USTCTL_NOTIFY_CMD_CHANNEL
;
2207 *notify_cmd
= USTCTL_NOTIFY_CMD_ENUM
;
2216 * Returns 0 on success, negative error value on error.
2218 int ustctl_recv_register_event(int sock
,
2225 struct ustctl_field
**fields
,
2226 char **model_emf_uri
)
2229 struct ustcomm_notify_event_msg msg
;
2230 size_t signature_len
, fields_len
, model_emf_uri_len
;
2231 char *a_sign
= NULL
, *a_model_emf_uri
= NULL
;
2232 struct ustctl_field
*a_fields
= NULL
;
2234 len
= ustcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
2235 if (len
> 0 && len
!= sizeof(msg
))
2242 *session_objd
= msg
.session_objd
;
2243 *channel_objd
= msg
.channel_objd
;
2244 strncpy(event_name
, msg
.event_name
, LTTNG_UST_ABI_SYM_NAME_LEN
);
2245 event_name
[LTTNG_UST_ABI_SYM_NAME_LEN
- 1] = '\0';
2246 *loglevel
= msg
.loglevel
;
2247 signature_len
= msg
.signature_len
;
2248 fields_len
= msg
.fields_len
;
2250 if (fields_len
% sizeof(*a_fields
) != 0) {
2254 model_emf_uri_len
= msg
.model_emf_uri_len
;
2256 /* recv signature. contains at least \0. */
2257 a_sign
= zmalloc(signature_len
);
2260 len
= ustcomm_recv_unix_sock(sock
, a_sign
, signature_len
);
2261 if (len
> 0 && len
!= signature_len
) {
2263 goto signature_error
;
2267 goto signature_error
;
2270 goto signature_error
;
2272 /* Enforce end of string */
2273 a_sign
[signature_len
- 1] = '\0';
2277 a_fields
= zmalloc(fields_len
);
2280 goto signature_error
;
2282 len
= ustcomm_recv_unix_sock(sock
, a_fields
, fields_len
);
2283 if (len
> 0 && len
!= fields_len
) {
2296 if (model_emf_uri_len
) {
2297 /* recv model_emf_uri_len */
2298 a_model_emf_uri
= zmalloc(model_emf_uri_len
);
2299 if (!a_model_emf_uri
) {
2303 len
= ustcomm_recv_unix_sock(sock
, a_model_emf_uri
,
2305 if (len
> 0 && len
!= model_emf_uri_len
) {
2316 /* Enforce end of string */
2317 a_model_emf_uri
[model_emf_uri_len
- 1] = '\0';
2320 *signature
= a_sign
;
2321 *nr_fields
= fields_len
/ sizeof(*a_fields
);
2323 *model_emf_uri
= a_model_emf_uri
;
2328 free(a_model_emf_uri
);
2337 * Returns 0 on success, negative error value on error.
2339 int ustctl_reply_register_event(int sock
,
2345 struct ustcomm_notify_hdr header
;
2346 struct ustcomm_notify_event_reply r
;
2349 memset(&reply
, 0, sizeof(reply
));
2350 reply
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_EVENT
;
2351 reply
.r
.ret_code
= ret_code
;
2352 reply
.r
.event_id
= id
;
2353 len
= ustcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2354 if (len
> 0 && len
!= sizeof(reply
))
2362 * Returns 0 on success, negative UST or system error value on error.
2364 int ustctl_recv_register_enum(int sock
,
2367 struct ustctl_enum_entry
**entries
,
2371 struct ustcomm_notify_enum_msg msg
;
2373 struct ustctl_enum_entry
*a_entries
= NULL
;
2375 len
= ustcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
2376 if (len
> 0 && len
!= sizeof(msg
))
2383 *session_objd
= msg
.session_objd
;
2384 strncpy(enum_name
, msg
.enum_name
, LTTNG_UST_ABI_SYM_NAME_LEN
);
2385 enum_name
[LTTNG_UST_ABI_SYM_NAME_LEN
- 1] = '\0';
2386 entries_len
= msg
.entries_len
;
2388 if (entries_len
% sizeof(*a_entries
) != 0) {
2394 a_entries
= zmalloc(entries_len
);
2397 len
= ustcomm_recv_unix_sock(sock
, a_entries
, entries_len
);
2398 if (len
> 0 && len
!= entries_len
) {
2410 *nr_entries
= entries_len
/ sizeof(*a_entries
);
2411 *entries
= a_entries
;
2421 * Returns 0 on success, negative error value on error.
2423 int ustctl_reply_register_enum(int sock
,
2429 struct ustcomm_notify_hdr header
;
2430 struct ustcomm_notify_enum_reply r
;
2433 memset(&reply
, 0, sizeof(reply
));
2434 reply
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_ENUM
;
2435 reply
.r
.ret_code
= ret_code
;
2436 reply
.r
.enum_id
= id
;
2437 len
= ustcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2438 if (len
> 0 && len
!= sizeof(reply
))
2446 * Returns 0 on success, negative UST or system error value on error.
2448 int ustctl_recv_register_channel(int sock
,
2449 int *session_objd
, /* session descriptor (output) */
2450 int *channel_objd
, /* channel descriptor (output) */
2452 struct ustctl_field
**fields
)
2455 struct ustcomm_notify_channel_msg msg
;
2457 struct ustctl_field
*a_fields
;
2459 len
= ustcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
2460 if (len
> 0 && len
!= sizeof(msg
))
2467 *session_objd
= msg
.session_objd
;
2468 *channel_objd
= msg
.channel_objd
;
2469 fields_len
= msg
.ctx_fields_len
;
2471 if (fields_len
% sizeof(*a_fields
) != 0) {
2477 a_fields
= zmalloc(fields_len
);
2482 len
= ustcomm_recv_unix_sock(sock
, a_fields
, fields_len
);
2483 if (len
> 0 && len
!= fields_len
) {
2498 *nr_fields
= fields_len
/ sizeof(*a_fields
);
2508 * Returns 0 on success, negative error value on error.
2510 int ustctl_reply_register_channel(int sock
,
2512 enum ustctl_channel_header header_type
,
2517 struct ustcomm_notify_hdr header
;
2518 struct ustcomm_notify_channel_reply r
;
2521 memset(&reply
, 0, sizeof(reply
));
2522 reply
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_CHANNEL
;
2523 reply
.r
.ret_code
= ret_code
;
2524 reply
.r
.chan_id
= chan_id
;
2525 switch (header_type
) {
2526 case USTCTL_CHANNEL_HEADER_COMPACT
:
2527 reply
.r
.header_type
= 1;
2529 case USTCTL_CHANNEL_HEADER_LARGE
:
2530 reply
.r
.header_type
= 2;
2533 reply
.r
.header_type
= 0;
2536 len
= ustcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2537 if (len
> 0 && len
!= sizeof(reply
))
2544 /* Regenerate the statedump. */
2545 int ustctl_regenerate_statedump(int sock
, int handle
)
2547 struct ustcomm_ust_msg lum
;
2548 struct ustcomm_ust_reply lur
;
2551 memset(&lum
, 0, sizeof(lum
));
2552 lum
.handle
= handle
;
2553 lum
.cmd
= LTTNG_UST_ABI_SESSION_STATEDUMP
;
2554 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
2557 DBG("Regenerated statedump for handle %u", handle
);
2561 /* counter operations */
2563 int ustctl_get_nr_cpu_per_counter(void)
2565 return lttng_counter_num_possible_cpus();
2568 struct ustctl_daemon_counter
*
2569 ustctl_create_counter(size_t nr_dimensions
,
2570 const struct ustctl_counter_dimension
*dimensions
,
2571 int64_t global_sum_step
,
2572 int global_counter_fd
,
2573 int nr_counter_cpu_fds
,
2574 const int *counter_cpu_fds
,
2575 enum ustctl_counter_bitness bitness
,
2576 enum ustctl_counter_arithmetic arithmetic
,
2577 uint32_t alloc_flags
,
2580 const char *transport_name
;
2581 struct ustctl_daemon_counter
*counter
;
2582 struct lttng_counter_transport
*transport
;
2583 struct lttng_counter_dimension ust_dim
[LTTNG_COUNTER_DIMENSION_MAX
];
2586 if (nr_dimensions
> LTTNG_COUNTER_DIMENSION_MAX
)
2588 /* Currently, only per-cpu allocation is supported. */
2589 switch (alloc_flags
) {
2590 case USTCTL_COUNTER_ALLOC_PER_CPU
:
2593 case USTCTL_COUNTER_ALLOC_PER_CPU
| USTCTL_COUNTER_ALLOC_GLOBAL
:
2594 case USTCTL_COUNTER_ALLOC_GLOBAL
:
2599 case USTCTL_COUNTER_BITNESS_32
:
2600 switch (arithmetic
) {
2601 case USTCTL_COUNTER_ARITHMETIC_MODULAR
:
2602 transport_name
= "counter-per-cpu-32-modular";
2604 case USTCTL_COUNTER_ARITHMETIC_SATURATION
:
2605 transport_name
= "counter-per-cpu-32-saturation";
2611 case USTCTL_COUNTER_BITNESS_64
:
2612 switch (arithmetic
) {
2613 case USTCTL_COUNTER_ARITHMETIC_MODULAR
:
2614 transport_name
= "counter-per-cpu-64-modular";
2616 case USTCTL_COUNTER_ARITHMETIC_SATURATION
:
2617 transport_name
= "counter-per-cpu-64-saturation";
2627 transport
= lttng_counter_transport_find(transport_name
);
2629 DBG("LTTng transport %s not found\n",
2634 counter
= zmalloc(sizeof(*counter
));
2637 counter
->attr
= zmalloc(sizeof(*counter
->attr
));
2640 counter
->attr
->bitness
= bitness
;
2641 counter
->attr
->arithmetic
= arithmetic
;
2642 counter
->attr
->nr_dimensions
= nr_dimensions
;
2643 counter
->attr
->global_sum_step
= global_sum_step
;
2644 counter
->attr
->coalesce_hits
= coalesce_hits
;
2645 for (i
= 0; i
< nr_dimensions
; i
++)
2646 counter
->attr
->dimensions
[i
] = dimensions
[i
];
2648 for (i
= 0; i
< nr_dimensions
; i
++) {
2649 ust_dim
[i
].size
= dimensions
[i
].size
;
2650 ust_dim
[i
].underflow_index
= dimensions
[i
].underflow_index
;
2651 ust_dim
[i
].overflow_index
= dimensions
[i
].overflow_index
;
2652 ust_dim
[i
].has_underflow
= dimensions
[i
].has_underflow
;
2653 ust_dim
[i
].has_overflow
= dimensions
[i
].has_overflow
;
2655 counter
->counter
= transport
->ops
.counter_create(nr_dimensions
,
2656 ust_dim
, global_sum_step
, global_counter_fd
,
2657 nr_counter_cpu_fds
, counter_cpu_fds
, true);
2658 if (!counter
->counter
)
2660 counter
->ops
= &transport
->ops
;
2664 free(counter
->attr
);
2670 int ustctl_create_counter_data(struct ustctl_daemon_counter
*counter
,
2671 struct lttng_ust_abi_object_data
**_counter_data
)
2673 struct lttng_ust_abi_object_data
*counter_data
;
2674 struct lttng_ust_abi_counter_conf counter_conf
= {0};
2678 switch (counter
->attr
->arithmetic
) {
2679 case USTCTL_COUNTER_ARITHMETIC_MODULAR
:
2680 counter_conf
.arithmetic
= LTTNG_UST_ABI_COUNTER_ARITHMETIC_MODULAR
;
2682 case USTCTL_COUNTER_ARITHMETIC_SATURATION
:
2683 counter_conf
.arithmetic
= LTTNG_UST_ABI_COUNTER_ARITHMETIC_SATURATION
;
2688 switch (counter
->attr
->bitness
) {
2689 case USTCTL_COUNTER_BITNESS_32
:
2690 counter_conf
.bitness
= LTTNG_UST_ABI_COUNTER_BITNESS_32
;
2692 case USTCTL_COUNTER_BITNESS_64
:
2693 counter_conf
.bitness
= LTTNG_UST_ABI_COUNTER_BITNESS_64
;
2698 counter_conf
.number_dimensions
= counter
->attr
->nr_dimensions
;
2699 counter_conf
.global_sum_step
= counter
->attr
->global_sum_step
;
2700 counter_conf
.coalesce_hits
= counter
->attr
->coalesce_hits
;
2701 for (i
= 0; i
< counter
->attr
->nr_dimensions
; i
++) {
2702 counter_conf
.dimensions
[i
].size
= counter
->attr
->dimensions
[i
].size
;
2703 counter_conf
.dimensions
[i
].underflow_index
= counter
->attr
->dimensions
[i
].underflow_index
;
2704 counter_conf
.dimensions
[i
].overflow_index
= counter
->attr
->dimensions
[i
].overflow_index
;
2705 counter_conf
.dimensions
[i
].has_underflow
= counter
->attr
->dimensions
[i
].has_underflow
;
2706 counter_conf
.dimensions
[i
].has_overflow
= counter
->attr
->dimensions
[i
].has_overflow
;
2709 counter_data
= zmalloc(sizeof(*counter_data
));
2710 if (!counter_data
) {
2714 counter_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_COUNTER
;
2715 counter_data
->handle
= -1;
2717 counter_data
->size
= sizeof(counter_conf
);
2718 counter_data
->u
.counter
.data
= zmalloc(sizeof(counter_conf
));
2719 if (!counter_data
->u
.counter
.data
) {
2721 goto error_alloc_data
;
2724 memcpy(counter_data
->u
.counter
.data
, &counter_conf
, sizeof(counter_conf
));
2725 *_counter_data
= counter_data
;
2735 int ustctl_create_counter_global_data(struct ustctl_daemon_counter
*counter
,
2736 struct lttng_ust_abi_object_data
**_counter_global_data
)
2738 struct lttng_ust_abi_object_data
*counter_global_data
;
2742 if (lttng_counter_get_global_shm(counter
->counter
, &fd
, &len
))
2744 counter_global_data
= zmalloc(sizeof(*counter_global_data
));
2745 if (!counter_global_data
) {
2749 counter_global_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_GLOBAL
;
2750 counter_global_data
->handle
= -1;
2751 counter_global_data
->size
= len
;
2752 counter_global_data
->u
.counter_global
.shm_fd
= fd
;
2753 *_counter_global_data
= counter_global_data
;
2760 int ustctl_create_counter_cpu_data(struct ustctl_daemon_counter
*counter
, int cpu
,
2761 struct lttng_ust_abi_object_data
**_counter_cpu_data
)
2763 struct lttng_ust_abi_object_data
*counter_cpu_data
;
2767 if (lttng_counter_get_cpu_shm(counter
->counter
, cpu
, &fd
, &len
))
2769 counter_cpu_data
= zmalloc(sizeof(*counter_cpu_data
));
2770 if (!counter_cpu_data
) {
2774 counter_cpu_data
->type
= LTTNG_UST_ABI_OBJECT_TYPE_COUNTER_CPU
;
2775 counter_cpu_data
->handle
= -1;
2776 counter_cpu_data
->size
= len
;
2777 counter_cpu_data
->u
.counter_cpu
.shm_fd
= fd
;
2778 counter_cpu_data
->u
.counter_cpu
.cpu_nr
= cpu
;
2779 *_counter_cpu_data
= counter_cpu_data
;
2786 void ustctl_destroy_counter(struct ustctl_daemon_counter
*counter
)
2788 counter
->ops
->counter_destroy(counter
->counter
);
2789 free(counter
->attr
);
2793 int ustctl_send_counter_data_to_ust(int sock
, int parent_handle
,
2794 struct lttng_ust_abi_object_data
*counter_data
)
2796 struct ustcomm_ust_msg lum
;
2797 struct ustcomm_ust_reply lur
;
2805 size
= counter_data
->size
;
2806 memset(&lum
, 0, sizeof(lum
));
2807 lum
.handle
= parent_handle
;
2808 lum
.cmd
= LTTNG_UST_ABI_COUNTER
;
2809 lum
.u
.counter
.len
= size
;
2810 ret
= ustcomm_send_app_msg(sock
, &lum
);
2814 /* Send counter data */
2815 len
= ustcomm_send_unix_sock(sock
, counter_data
->u
.counter
.data
, size
);
2823 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
2825 counter_data
->handle
= lur
.ret_val
;
2830 int ustctl_send_counter_global_data_to_ust(int sock
,
2831 struct lttng_ust_abi_object_data
*counter_data
,
2832 struct lttng_ust_abi_object_data
*counter_global_data
)
2834 struct ustcomm_ust_msg lum
;
2835 struct ustcomm_ust_reply lur
;
2840 if (!counter_data
|| !counter_global_data
)
2843 size
= counter_global_data
->size
;
2844 memset(&lum
, 0, sizeof(lum
));
2845 lum
.handle
= counter_data
->handle
; /* parent handle */
2846 lum
.cmd
= LTTNG_UST_ABI_COUNTER_GLOBAL
;
2847 lum
.u
.counter_global
.len
= size
;
2848 ret
= ustcomm_send_app_msg(sock
, &lum
);
2852 shm_fd
[0] = counter_global_data
->u
.counter_global
.shm_fd
;
2853 len
= ustcomm_send_fds_unix_sock(sock
, shm_fd
, 1);
2861 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
2863 counter_global_data
->handle
= lur
.ret_val
;
2868 int ustctl_send_counter_cpu_data_to_ust(int sock
,
2869 struct lttng_ust_abi_object_data
*counter_data
,
2870 struct lttng_ust_abi_object_data
*counter_cpu_data
)
2872 struct ustcomm_ust_msg lum
;
2873 struct ustcomm_ust_reply lur
;
2878 if (!counter_data
|| !counter_cpu_data
)
2881 size
= counter_cpu_data
->size
;
2882 memset(&lum
, 0, sizeof(lum
));
2883 lum
.handle
= counter_data
->handle
; /* parent handle */
2884 lum
.cmd
= LTTNG_UST_ABI_COUNTER_CPU
;
2885 lum
.u
.counter_cpu
.len
= size
;
2886 lum
.u
.counter_cpu
.cpu_nr
= counter_cpu_data
->u
.counter_cpu
.cpu_nr
;
2887 ret
= ustcomm_send_app_msg(sock
, &lum
);
2891 shm_fd
[0] = counter_cpu_data
->u
.counter_global
.shm_fd
;
2892 len
= ustcomm_send_fds_unix_sock(sock
, shm_fd
, 1);
2900 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
2902 counter_cpu_data
->handle
= lur
.ret_val
;
2907 int ustctl_counter_read(struct ustctl_daemon_counter
*counter
,
2908 const size_t *dimension_indexes
,
2909 int cpu
, int64_t *value
,
2910 bool *overflow
, bool *underflow
)
2912 return counter
->ops
->counter_read(counter
->counter
, dimension_indexes
, cpu
,
2913 value
, overflow
, underflow
);
2916 int ustctl_counter_aggregate(struct ustctl_daemon_counter
*counter
,
2917 const size_t *dimension_indexes
,
2919 bool *overflow
, bool *underflow
)
2921 return counter
->ops
->counter_aggregate(counter
->counter
, dimension_indexes
,
2922 value
, overflow
, underflow
);
2925 int ustctl_counter_clear(struct ustctl_daemon_counter
*counter
,
2926 const size_t *dimension_indexes
)
2928 return counter
->ops
->counter_clear(counter
->counter
, dimension_indexes
);
2931 static __attribute__((constructor
))
2932 void ustctl_init(void)
2935 lttng_ust_getenv_init(); /* Needs ust_err_init() to be completed. */
2936 lttng_ust_clock_init();
2937 lttng_ring_buffer_metadata_client_init();
2938 lttng_ring_buffer_client_overwrite_init();
2939 lttng_ring_buffer_client_overwrite_rt_init();
2940 lttng_ring_buffer_client_discard_init();
2941 lttng_ring_buffer_client_discard_rt_init();
2942 lttng_counter_client_percpu_32_modular_init();
2943 lttng_counter_client_percpu_64_modular_init();
2944 lib_ringbuffer_signal_init();
2947 static __attribute__((destructor
))
2948 void ustctl_exit(void)
2950 lttng_ring_buffer_client_discard_rt_exit();
2951 lttng_ring_buffer_client_discard_exit();
2952 lttng_ring_buffer_client_overwrite_rt_exit();
2953 lttng_ring_buffer_client_overwrite_exit();
2954 lttng_ring_buffer_metadata_client_exit();
2955 lttng_counter_client_percpu_32_modular_exit();
2956 lttng_counter_client_percpu_64_modular_exit();