2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Copyright (C) 2011-2013 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; version 2 of the License only.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include <lttng/ust-config.h>
26 #include <lttng/ust-ctl.h>
27 #include <lttng/ust-abi.h>
28 #include <lttng/ust-events.h>
29 #include <usterr-signal-safe.h>
33 #include "../libringbuffer/backend.h"
34 #include "../libringbuffer/frontend.h"
35 #include "../liblttng-ust/wait.h"
36 #include "../liblttng-ust/lttng-rb-clients.h"
37 #include "../liblttng-ust/clock.h"
38 #include "../liblttng-ust/getenv.h"
41 * Number of milliseconds to retry before failing metadata writes on
42 * buffer full condition. (10 seconds)
44 #define LTTNG_METADATA_TIMEOUT_MSEC 10000
47 * Channel representation within consumer.
49 struct ustctl_consumer_channel
{
50 struct lttng_channel
*chan
; /* lttng channel buffers */
52 /* initial attributes */
53 struct ustctl_consumer_channel_attr attr
;
54 int wait_fd
; /* monitor close() */
55 int wakeup_fd
; /* monitor close() */
59 * Stream representation within consumer.
61 struct ustctl_consumer_stream
{
62 struct lttng_ust_shm_handle
*handle
; /* shared-memory handle */
63 struct lttng_ust_lib_ring_buffer
*buf
;
64 struct ustctl_consumer_channel
*chan
;
65 int shm_fd
, wait_fd
, wakeup_fd
;
67 uint64_t memory_map_size
;
70 extern void lttng_ring_buffer_client_overwrite_init(void);
71 extern void lttng_ring_buffer_client_overwrite_rt_init(void);
72 extern void lttng_ring_buffer_client_discard_init(void);
73 extern void lttng_ring_buffer_client_discard_rt_init(void);
74 extern void lttng_ring_buffer_metadata_client_init(void);
75 extern void lttng_ring_buffer_client_overwrite_exit(void);
76 extern void lttng_ring_buffer_client_overwrite_rt_exit(void);
77 extern void lttng_ring_buffer_client_discard_exit(void);
78 extern void lttng_ring_buffer_client_discard_rt_exit(void);
79 extern void lttng_ring_buffer_metadata_client_exit(void);
81 int ustctl_release_handle(int sock
, int handle
)
83 struct ustcomm_ust_msg lum
;
84 struct ustcomm_ust_reply lur
;
86 if (sock
< 0 || handle
< 0)
88 memset(&lum
, 0, sizeof(lum
));
90 lum
.cmd
= LTTNG_UST_RELEASE
;
91 return ustcomm_send_app_cmd(sock
, &lum
, &lur
);
95 * If sock is negative, it means we don't have to notify the other side
96 * (e.g. application has already vanished).
98 int ustctl_release_object(int sock
, struct lttng_ust_object_data
*data
)
105 switch (data
->type
) {
106 case LTTNG_UST_OBJECT_TYPE_CHANNEL
:
107 if (data
->u
.channel
.wakeup_fd
>= 0) {
108 ret
= close(data
->u
.channel
.wakeup_fd
);
114 free(data
->u
.channel
.data
);
116 case LTTNG_UST_OBJECT_TYPE_STREAM
:
117 if (data
->u
.stream
.shm_fd
>= 0) {
118 ret
= close(data
->u
.stream
.shm_fd
);
124 if (data
->u
.stream
.wakeup_fd
>= 0) {
125 ret
= close(data
->u
.stream
.wakeup_fd
);
132 case LTTNG_UST_OBJECT_TYPE_EVENT
:
133 case LTTNG_UST_OBJECT_TYPE_CONTEXT
:
138 return ustctl_release_handle(sock
, data
->handle
);
142 * Send registration done packet to the application.
144 int ustctl_register_done(int sock
)
146 struct ustcomm_ust_msg lum
;
147 struct ustcomm_ust_reply lur
;
150 DBG("Sending register done command to %d", sock
);
151 memset(&lum
, 0, sizeof(lum
));
152 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
153 lum
.cmd
= LTTNG_UST_REGISTER_DONE
;
154 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
161 * returns session handle.
163 int ustctl_create_session(int sock
)
165 struct ustcomm_ust_msg lum
;
166 struct ustcomm_ust_reply lur
;
167 int ret
, session_handle
;
170 memset(&lum
, 0, sizeof(lum
));
171 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
172 lum
.cmd
= LTTNG_UST_SESSION
;
173 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
176 session_handle
= lur
.ret_val
;
177 DBG("received session handle %u", session_handle
);
178 return session_handle
;
181 int ustctl_create_event(int sock
, struct lttng_ust_event
*ev
,
182 struct lttng_ust_object_data
*channel_data
,
183 struct lttng_ust_object_data
**_event_data
)
185 struct ustcomm_ust_msg lum
;
186 struct ustcomm_ust_reply lur
;
187 struct lttng_ust_object_data
*event_data
;
190 if (!channel_data
|| !_event_data
)
193 event_data
= zmalloc(sizeof(*event_data
));
196 event_data
->type
= LTTNG_UST_OBJECT_TYPE_EVENT
;
197 memset(&lum
, 0, sizeof(lum
));
198 lum
.handle
= channel_data
->handle
;
199 lum
.cmd
= LTTNG_UST_EVENT
;
200 strncpy(lum
.u
.event
.name
, ev
->name
,
201 LTTNG_UST_SYM_NAME_LEN
);
202 lum
.u
.event
.instrumentation
= ev
->instrumentation
;
203 lum
.u
.event
.loglevel_type
= ev
->loglevel_type
;
204 lum
.u
.event
.loglevel
= ev
->loglevel
;
205 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
210 event_data
->handle
= lur
.ret_val
;
211 DBG("received event handle %u", event_data
->handle
);
212 *_event_data
= event_data
;
216 int ustctl_add_context(int sock
, struct lttng_ust_context_attr
*ctx
,
217 struct lttng_ust_object_data
*obj_data
,
218 struct lttng_ust_object_data
**_context_data
)
220 struct ustcomm_ust_msg lum
;
221 struct ustcomm_ust_reply lur
;
222 struct lttng_ust_object_data
*context_data
= NULL
;
227 if (!obj_data
|| !_context_data
) {
232 context_data
= zmalloc(sizeof(*context_data
));
237 context_data
->type
= LTTNG_UST_OBJECT_TYPE_CONTEXT
;
238 memset(&lum
, 0, sizeof(lum
));
239 lum
.handle
= obj_data
->handle
;
240 lum
.cmd
= LTTNG_UST_CONTEXT
;
242 lum
.u
.context
.ctx
= ctx
->ctx
;
244 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
245 lum
.u
.context
.u
.perf_counter
= ctx
->u
.perf_counter
;
247 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
249 size_t provider_name_len
= strlen(
250 ctx
->u
.app_ctx
.provider_name
) + 1;
251 size_t ctx_name_len
= strlen(ctx
->u
.app_ctx
.ctx_name
) + 1;
253 lum
.u
.context
.u
.app_ctx
.provider_name_len
= provider_name_len
;
254 lum
.u
.context
.u
.app_ctx
.ctx_name_len
= ctx_name_len
;
256 len
= provider_name_len
+ ctx_name_len
;
262 memcpy(buf
, ctx
->u
.app_ctx
.provider_name
,
264 memcpy(buf
+ provider_name_len
, ctx
->u
.app_ctx
.ctx_name
,
271 ret
= ustcomm_send_app_msg(sock
, &lum
);
275 /* send var len ctx_name */
276 ret
= ustcomm_send_unix_sock(sock
, buf
, len
);
285 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
289 context_data
->handle
= -1;
290 DBG("Context created successfully");
291 *_context_data
= context_data
;
299 int ustctl_set_filter(int sock
, struct lttng_ust_filter_bytecode
*bytecode
,
300 struct lttng_ust_object_data
*obj_data
)
302 struct ustcomm_ust_msg lum
;
303 struct ustcomm_ust_reply lur
;
309 memset(&lum
, 0, sizeof(lum
));
310 lum
.handle
= obj_data
->handle
;
311 lum
.cmd
= LTTNG_UST_FILTER
;
312 lum
.u
.filter
.data_size
= bytecode
->len
;
313 lum
.u
.filter
.reloc_offset
= bytecode
->reloc_offset
;
314 lum
.u
.filter
.seqnum
= bytecode
->seqnum
;
316 ret
= ustcomm_send_app_msg(sock
, &lum
);
319 /* send var len bytecode */
320 ret
= ustcomm_send_unix_sock(sock
, bytecode
->data
,
325 if (ret
!= bytecode
->len
)
327 return ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
330 int ustctl_set_exclusion(int sock
, struct lttng_ust_event_exclusion
*exclusion
,
331 struct lttng_ust_object_data
*obj_data
)
333 struct ustcomm_ust_msg lum
;
334 struct ustcomm_ust_reply lur
;
341 memset(&lum
, 0, sizeof(lum
));
342 lum
.handle
= obj_data
->handle
;
343 lum
.cmd
= LTTNG_UST_EXCLUSION
;
344 lum
.u
.exclusion
.count
= exclusion
->count
;
346 ret
= ustcomm_send_app_msg(sock
, &lum
);
351 /* send var len exclusion names */
352 ret
= ustcomm_send_unix_sock(sock
,
354 exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
);
358 if (ret
!= exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) {
361 return ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
364 /* Enable event, channel and session ioctl */
365 int ustctl_enable(int sock
, struct lttng_ust_object_data
*object
)
367 struct ustcomm_ust_msg lum
;
368 struct ustcomm_ust_reply lur
;
374 memset(&lum
, 0, sizeof(lum
));
375 lum
.handle
= object
->handle
;
376 lum
.cmd
= LTTNG_UST_ENABLE
;
377 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
380 DBG("enabled handle %u", object
->handle
);
384 /* Disable event, channel and session ioctl */
385 int ustctl_disable(int sock
, struct lttng_ust_object_data
*object
)
387 struct ustcomm_ust_msg lum
;
388 struct ustcomm_ust_reply lur
;
394 memset(&lum
, 0, sizeof(lum
));
395 lum
.handle
= object
->handle
;
396 lum
.cmd
= LTTNG_UST_DISABLE
;
397 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
400 DBG("disable handle %u", object
->handle
);
404 int ustctl_start_session(int sock
, int handle
)
406 struct lttng_ust_object_data obj
;
409 return ustctl_enable(sock
, &obj
);
412 int ustctl_stop_session(int sock
, int handle
)
414 struct lttng_ust_object_data obj
;
417 return ustctl_disable(sock
, &obj
);
420 int ustctl_tracepoint_list(int sock
)
422 struct ustcomm_ust_msg lum
;
423 struct ustcomm_ust_reply lur
;
424 int ret
, tp_list_handle
;
426 memset(&lum
, 0, sizeof(lum
));
427 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
428 lum
.cmd
= LTTNG_UST_TRACEPOINT_LIST
;
429 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
432 tp_list_handle
= lur
.ret_val
;
433 DBG("received tracepoint list handle %u", tp_list_handle
);
434 return tp_list_handle
;
437 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
438 struct lttng_ust_tracepoint_iter
*iter
)
440 struct ustcomm_ust_msg lum
;
441 struct ustcomm_ust_reply lur
;
447 memset(&lum
, 0, sizeof(lum
));
448 lum
.handle
= tp_list_handle
;
449 lum
.cmd
= LTTNG_UST_TRACEPOINT_LIST_GET
;
450 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
453 DBG("received tracepoint list entry name %s loglevel %d",
454 lur
.u
.tracepoint
.name
,
455 lur
.u
.tracepoint
.loglevel
);
456 memcpy(iter
, &lur
.u
.tracepoint
, sizeof(*iter
));
460 int ustctl_tracepoint_field_list(int sock
)
462 struct ustcomm_ust_msg lum
;
463 struct ustcomm_ust_reply lur
;
464 int ret
, tp_field_list_handle
;
466 memset(&lum
, 0, sizeof(lum
));
467 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
468 lum
.cmd
= LTTNG_UST_TRACEPOINT_FIELD_LIST
;
469 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
472 tp_field_list_handle
= lur
.ret_val
;
473 DBG("received tracepoint field list handle %u", tp_field_list_handle
);
474 return tp_field_list_handle
;
477 int ustctl_tracepoint_field_list_get(int sock
, int tp_field_list_handle
,
478 struct lttng_ust_field_iter
*iter
)
480 struct ustcomm_ust_msg lum
;
481 struct ustcomm_ust_reply lur
;
488 memset(&lum
, 0, sizeof(lum
));
489 lum
.handle
= tp_field_list_handle
;
490 lum
.cmd
= LTTNG_UST_TRACEPOINT_FIELD_LIST_GET
;
491 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
494 len
= ustcomm_recv_unix_sock(sock
, iter
, sizeof(*iter
));
495 if (len
!= sizeof(*iter
)) {
498 DBG("received tracepoint field list entry event_name %s event_loglevel %d field_name %s field_type %d",
506 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
)
508 struct ustcomm_ust_msg lum
;
509 struct ustcomm_ust_reply lur
;
515 memset(&lum
, 0, sizeof(lum
));
516 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
517 lum
.cmd
= LTTNG_UST_TRACER_VERSION
;
518 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
521 memcpy(v
, &lur
.u
.version
, sizeof(*v
));
522 DBG("received tracer version");
526 int ustctl_wait_quiescent(int sock
)
528 struct ustcomm_ust_msg lum
;
529 struct ustcomm_ust_reply lur
;
532 memset(&lum
, 0, sizeof(lum
));
533 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
534 lum
.cmd
= LTTNG_UST_WAIT_QUIESCENT
;
535 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
538 DBG("waited for quiescent state");
542 int ustctl_calibrate(int sock
, struct lttng_ust_calibrate
*calibrate
)
550 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_object_data
*object
)
552 struct ustcomm_ust_msg lum
;
553 struct ustcomm_ust_reply lur
;
559 memset(&lum
, 0, sizeof(lum
));
560 lum
.handle
= object
->handle
;
561 lum
.cmd
= LTTNG_UST_FLUSH_BUFFER
;
562 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
565 DBG("flushed buffer handle %u", object
->handle
);
570 int ustctl_send_channel(int sock
,
571 enum lttng_ust_chan_type type
,
581 len
= ustcomm_send_unix_sock(sock
, &size
, sizeof(size
));
582 if (len
!= sizeof(size
)) {
589 /* Send channel type */
590 len
= ustcomm_send_unix_sock(sock
, &type
, sizeof(type
));
591 if (len
!= sizeof(type
)) {
599 /* Send channel data */
600 len
= ustcomm_send_unix_sock(sock
, data
, size
);
609 len
= ustcomm_send_fds_unix_sock(sock
, &wakeup_fd
, 1);
620 int ustctl_send_stream(int sock
,
622 uint64_t memory_map_size
,
623 int shm_fd
, int wakeup_fd
,
631 /* finish iteration */
634 len
= ustcomm_send_unix_sock(sock
, &v
, sizeof(v
));
635 if (len
!= sizeof(v
)) {
645 len
= ustcomm_send_unix_sock(sock
, &memory_map_size
,
646 sizeof(memory_map_size
));
647 if (len
!= sizeof(memory_map_size
)) {
655 len
= ustcomm_send_unix_sock(sock
, &stream_nr
,
657 if (len
!= sizeof(stream_nr
)) {
665 /* Send shm fd and wakeup fd */
668 len
= ustcomm_send_fds_unix_sock(sock
, fds
, 2);
678 int ustctl_recv_channel_from_consumer(int sock
,
679 struct lttng_ust_object_data
**_channel_data
)
681 struct lttng_ust_object_data
*channel_data
;
686 channel_data
= zmalloc(sizeof(*channel_data
));
691 channel_data
->type
= LTTNG_UST_OBJECT_TYPE_CHANNEL
;
692 channel_data
->handle
= -1;
695 len
= ustcomm_recv_unix_sock(sock
, &channel_data
->size
,
696 sizeof(channel_data
->size
));
697 if (len
!= sizeof(channel_data
->size
)) {
705 /* recv channel type */
706 len
= ustcomm_recv_unix_sock(sock
, &channel_data
->u
.channel
.type
,
707 sizeof(channel_data
->u
.channel
.type
));
708 if (len
!= sizeof(channel_data
->u
.channel
.type
)) {
716 /* recv channel data */
717 channel_data
->u
.channel
.data
= zmalloc(channel_data
->size
);
718 if (!channel_data
->u
.channel
.data
) {
722 len
= ustcomm_recv_unix_sock(sock
, channel_data
->u
.channel
.data
,
724 if (len
!= channel_data
->size
) {
729 goto error_recv_data
;
732 len
= ustcomm_recv_fds_unix_sock(sock
, &wakeup_fd
, 1);
736 goto error_recv_data
;
739 goto error_recv_data
;
742 channel_data
->u
.channel
.wakeup_fd
= wakeup_fd
;
743 *_channel_data
= channel_data
;
747 free(channel_data
->u
.channel
.data
);
754 int ustctl_recv_stream_from_consumer(int sock
,
755 struct lttng_ust_object_data
**_stream_data
)
757 struct lttng_ust_object_data
*stream_data
;
762 stream_data
= zmalloc(sizeof(*stream_data
));
768 stream_data
->type
= LTTNG_UST_OBJECT_TYPE_STREAM
;
769 stream_data
->handle
= -1;
772 len
= ustcomm_recv_unix_sock(sock
, &stream_data
->size
,
773 sizeof(stream_data
->size
));
774 if (len
!= sizeof(stream_data
->size
)) {
781 if (stream_data
->size
== -1) {
782 ret
= -LTTNG_UST_ERR_NOENT
;
787 len
= ustcomm_recv_unix_sock(sock
, &stream_data
->u
.stream
.stream_nr
,
788 sizeof(stream_data
->u
.stream
.stream_nr
));
789 if (len
!= sizeof(stream_data
->u
.stream
.stream_nr
)) {
797 /* recv shm fd and wakeup fd */
798 len
= ustcomm_recv_fds_unix_sock(sock
, fds
, 2);
808 stream_data
->u
.stream
.shm_fd
= fds
[0];
809 stream_data
->u
.stream
.wakeup_fd
= fds
[1];
810 *_stream_data
= stream_data
;
819 int ustctl_send_channel_to_ust(int sock
, int session_handle
,
820 struct lttng_ust_object_data
*channel_data
)
822 struct ustcomm_ust_msg lum
;
823 struct ustcomm_ust_reply lur
;
829 memset(&lum
, 0, sizeof(lum
));
830 lum
.handle
= session_handle
;
831 lum
.cmd
= LTTNG_UST_CHANNEL
;
832 lum
.u
.channel
.len
= channel_data
->size
;
833 lum
.u
.channel
.type
= channel_data
->u
.channel
.type
;
834 ret
= ustcomm_send_app_msg(sock
, &lum
);
838 ret
= ustctl_send_channel(sock
,
839 channel_data
->u
.channel
.type
,
840 channel_data
->u
.channel
.data
,
842 channel_data
->u
.channel
.wakeup_fd
,
846 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
848 channel_data
->handle
= lur
.ret_val
;
853 int ustctl_send_stream_to_ust(int sock
,
854 struct lttng_ust_object_data
*channel_data
,
855 struct lttng_ust_object_data
*stream_data
)
857 struct ustcomm_ust_msg lum
;
858 struct ustcomm_ust_reply lur
;
861 memset(&lum
, 0, sizeof(lum
));
862 lum
.handle
= channel_data
->handle
;
863 lum
.cmd
= LTTNG_UST_STREAM
;
864 lum
.u
.stream
.len
= stream_data
->size
;
865 lum
.u
.stream
.stream_nr
= stream_data
->u
.stream
.stream_nr
;
866 ret
= ustcomm_send_app_msg(sock
, &lum
);
871 assert(stream_data
->type
== LTTNG_UST_OBJECT_TYPE_STREAM
);
873 ret
= ustctl_send_stream(sock
,
874 stream_data
->u
.stream
.stream_nr
,
876 stream_data
->u
.stream
.shm_fd
,
877 stream_data
->u
.stream
.wakeup_fd
, 1);
880 return ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
883 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data
**dest
,
884 struct lttng_ust_object_data
*src
)
886 struct lttng_ust_object_data
*obj
;
889 if (src
->handle
!= -1) {
894 obj
= zmalloc(sizeof(*obj
));
900 obj
->type
= src
->type
;
901 obj
->handle
= src
->handle
;
902 obj
->size
= src
->size
;
905 case LTTNG_UST_OBJECT_TYPE_CHANNEL
:
907 obj
->u
.channel
.type
= src
->u
.channel
.type
;
908 if (src
->u
.channel
.wakeup_fd
>= 0) {
909 obj
->u
.channel
.wakeup_fd
=
910 dup(src
->u
.channel
.wakeup_fd
);
911 if (obj
->u
.channel
.wakeup_fd
< 0) {
913 goto chan_error_wakeup_fd
;
916 obj
->u
.channel
.wakeup_fd
=
917 src
->u
.channel
.wakeup_fd
;
919 obj
->u
.channel
.data
= zmalloc(obj
->size
);
920 if (!obj
->u
.channel
.data
) {
922 goto chan_error_alloc
;
924 memcpy(obj
->u
.channel
.data
, src
->u
.channel
.data
, obj
->size
);
928 if (src
->u
.channel
.wakeup_fd
>= 0) {
931 closeret
= close(obj
->u
.channel
.wakeup_fd
);
936 chan_error_wakeup_fd
:
941 case LTTNG_UST_OBJECT_TYPE_STREAM
:
943 obj
->u
.stream
.stream_nr
= src
->u
.stream
.stream_nr
;
944 if (src
->u
.stream
.wakeup_fd
>= 0) {
945 obj
->u
.stream
.wakeup_fd
=
946 dup(src
->u
.stream
.wakeup_fd
);
947 if (obj
->u
.stream
.wakeup_fd
< 0) {
949 goto stream_error_wakeup_fd
;
952 obj
->u
.stream
.wakeup_fd
=
953 src
->u
.stream
.wakeup_fd
;
956 if (src
->u
.stream
.shm_fd
>= 0) {
957 obj
->u
.stream
.shm_fd
=
958 dup(src
->u
.stream
.shm_fd
);
959 if (obj
->u
.stream
.shm_fd
< 0) {
961 goto stream_error_shm_fd
;
964 obj
->u
.stream
.shm_fd
=
965 src
->u
.stream
.shm_fd
;
970 if (src
->u
.stream
.wakeup_fd
>= 0) {
973 closeret
= close(obj
->u
.stream
.wakeup_fd
);
978 stream_error_wakeup_fd
:
997 /* Buffer operations */
999 int ustctl_get_nr_stream_per_channel(void)
1001 return num_possible_cpus();
1004 struct ustctl_consumer_channel
*
1005 ustctl_create_channel(struct ustctl_consumer_channel_attr
*attr
,
1006 const int *stream_fds
, int nr_stream_fds
)
1008 struct ustctl_consumer_channel
*chan
;
1009 const char *transport_name
;
1010 struct lttng_transport
*transport
;
1012 switch (attr
->type
) {
1013 case LTTNG_UST_CHAN_PER_CPU
:
1014 if (attr
->output
== LTTNG_UST_MMAP
) {
1015 if (attr
->overwrite
) {
1016 if (attr
->read_timer_interval
== 0) {
1017 transport_name
= "relay-overwrite-mmap";
1019 transport_name
= "relay-overwrite-rt-mmap";
1022 if (attr
->read_timer_interval
== 0) {
1023 transport_name
= "relay-discard-mmap";
1025 transport_name
= "relay-discard-rt-mmap";
1032 case LTTNG_UST_CHAN_METADATA
:
1033 if (attr
->output
== LTTNG_UST_MMAP
)
1034 transport_name
= "relay-metadata-mmap";
1039 transport_name
= "<unknown>";
1043 transport
= lttng_transport_find(transport_name
);
1045 DBG("LTTng transport %s not found\n",
1050 chan
= zmalloc(sizeof(*chan
));
1054 chan
->chan
= transport
->ops
.channel_create(transport_name
, NULL
,
1055 attr
->subbuf_size
, attr
->num_subbuf
,
1056 attr
->switch_timer_interval
,
1057 attr
->read_timer_interval
,
1058 attr
->uuid
, attr
->chan_id
,
1059 stream_fds
, nr_stream_fds
,
1060 attr
->blocking_timeout
);
1064 chan
->chan
->ops
= &transport
->ops
;
1065 memcpy(&chan
->attr
, attr
, sizeof(chan
->attr
));
1066 chan
->wait_fd
= ustctl_channel_get_wait_fd(chan
);
1067 chan
->wakeup_fd
= ustctl_channel_get_wakeup_fd(chan
);
1075 void ustctl_destroy_channel(struct ustctl_consumer_channel
*chan
)
1077 (void) ustctl_channel_close_wait_fd(chan
);
1078 (void) ustctl_channel_close_wakeup_fd(chan
);
1079 chan
->chan
->ops
->channel_destroy(chan
->chan
);
1083 int ustctl_send_channel_to_sessiond(int sock
,
1084 struct ustctl_consumer_channel
*channel
)
1086 struct shm_object_table
*table
;
1088 table
= channel
->chan
->handle
->table
;
1089 if (table
->size
<= 0)
1091 return ustctl_send_channel(sock
,
1093 table
->objects
[0].memory_map
,
1094 table
->objects
[0].memory_map_size
,
1099 int ustctl_send_stream_to_sessiond(int sock
,
1100 struct ustctl_consumer_stream
*stream
)
1103 return ustctl_send_stream(sock
, -1U, -1U, -1, -1, 0);
1105 return ustctl_send_stream(sock
,
1107 stream
->memory_map_size
,
1108 stream
->shm_fd
, stream
->wakeup_fd
,
1112 int ustctl_write_metadata_to_channel(
1113 struct ustctl_consumer_channel
*channel
,
1114 const char *metadata_str
, /* NOT null-terminated */
1115 size_t len
) /* metadata length */
1117 struct lttng_ust_lib_ring_buffer_ctx ctx
;
1118 struct lttng_channel
*chan
= channel
->chan
;
1119 const char *str
= metadata_str
;
1120 int ret
= 0, waitret
;
1121 size_t reserve_len
, pos
;
1123 for (pos
= 0; pos
< len
; pos
+= reserve_len
) {
1124 reserve_len
= min_t(size_t,
1125 chan
->ops
->packet_avail_size(chan
->chan
, chan
->handle
),
1127 lib_ring_buffer_ctx_init(&ctx
, chan
->chan
, NULL
, reserve_len
,
1128 sizeof(char), -1, chan
->handle
, NULL
);
1130 * We don't care about metadata buffer's records lost
1131 * count, because we always retry here. Report error if
1132 * we need to bail out after timeout or being
1135 waitret
= wait_cond_interruptible_timeout(
1137 ret
= chan
->ops
->event_reserve(&ctx
, 0);
1138 ret
!= -ENOBUFS
|| !ret
;
1140 LTTNG_METADATA_TIMEOUT_MSEC
);
1141 if (waitret
== -ETIMEDOUT
|| waitret
== -EINTR
|| ret
) {
1142 DBG("LTTng: Failure to write metadata to buffers (%s)\n",
1143 waitret
== -EINTR
? "interrupted" :
1144 (ret
== -ENOBUFS
? "timeout" : "I/O error"));
1145 if (waitret
== -EINTR
)
1149 chan
->ops
->event_write(&ctx
, &str
[pos
], reserve_len
);
1150 chan
->ops
->event_commit(&ctx
);
1157 * Write at most one packet in the channel.
1158 * Returns the number of bytes written on success, < 0 on error.
1160 ssize_t
ustctl_write_one_packet_to_channel(
1161 struct ustctl_consumer_channel
*channel
,
1162 const char *metadata_str
, /* NOT null-terminated */
1163 size_t len
) /* metadata length */
1165 struct lttng_ust_lib_ring_buffer_ctx ctx
;
1166 struct lttng_channel
*chan
= channel
->chan
;
1167 const char *str
= metadata_str
;
1168 ssize_t reserve_len
;
1171 reserve_len
= min_t(ssize_t
,
1172 chan
->ops
->packet_avail_size(chan
->chan
, chan
->handle
),
1174 lib_ring_buffer_ctx_init(&ctx
, chan
->chan
, NULL
, reserve_len
,
1175 sizeof(char), -1, chan
->handle
, NULL
);
1176 ret
= chan
->ops
->event_reserve(&ctx
, 0);
1178 DBG("LTTng: event reservation failed");
1183 chan
->ops
->event_write(&ctx
, str
, reserve_len
);
1184 chan
->ops
->event_commit(&ctx
);
1190 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel
*consumer_chan
)
1192 struct channel
*chan
;
1195 chan
= consumer_chan
->chan
->chan
;
1196 ret
= ring_buffer_channel_close_wait_fd(&chan
->backend
.config
,
1197 chan
, chan
->handle
);
1199 consumer_chan
->wait_fd
= -1;
1203 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel
*consumer_chan
)
1205 struct channel
*chan
;
1208 chan
= consumer_chan
->chan
->chan
;
1209 ret
= ring_buffer_channel_close_wakeup_fd(&chan
->backend
.config
,
1210 chan
, chan
->handle
);
1212 consumer_chan
->wakeup_fd
= -1;
1216 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream
*stream
)
1218 struct channel
*chan
;
1220 chan
= stream
->chan
->chan
->chan
;
1221 return ring_buffer_stream_close_wait_fd(&chan
->backend
.config
,
1222 chan
, stream
->handle
, stream
->cpu
);
1225 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream
*stream
)
1227 struct channel
*chan
;
1229 chan
= stream
->chan
->chan
->chan
;
1230 return ring_buffer_stream_close_wakeup_fd(&chan
->backend
.config
,
1231 chan
, stream
->handle
, stream
->cpu
);
1234 struct ustctl_consumer_stream
*
1235 ustctl_create_stream(struct ustctl_consumer_channel
*channel
,
1238 struct ustctl_consumer_stream
*stream
;
1239 struct lttng_ust_shm_handle
*handle
;
1240 struct channel
*chan
;
1241 int shm_fd
, wait_fd
, wakeup_fd
;
1242 uint64_t memory_map_size
;
1243 struct lttng_ust_lib_ring_buffer
*buf
;
1248 handle
= channel
->chan
->handle
;
1252 chan
= channel
->chan
->chan
;
1253 buf
= channel_get_ring_buffer(&chan
->backend
.config
,
1254 chan
, cpu
, handle
, &shm_fd
, &wait_fd
,
1255 &wakeup_fd
, &memory_map_size
);
1258 ret
= lib_ring_buffer_open_read(buf
, handle
);
1262 stream
= zmalloc(sizeof(*stream
));
1265 stream
->handle
= handle
;
1267 stream
->chan
= channel
;
1268 stream
->shm_fd
= shm_fd
;
1269 stream
->wait_fd
= wait_fd
;
1270 stream
->wakeup_fd
= wakeup_fd
;
1271 stream
->memory_map_size
= memory_map_size
;
1279 void ustctl_destroy_stream(struct ustctl_consumer_stream
*stream
)
1281 struct lttng_ust_lib_ring_buffer
*buf
;
1282 struct ustctl_consumer_channel
*consumer_chan
;
1286 consumer_chan
= stream
->chan
;
1287 (void) ustctl_stream_close_wait_fd(stream
);
1288 (void) ustctl_stream_close_wakeup_fd(stream
);
1289 lib_ring_buffer_release_read(buf
, consumer_chan
->chan
->handle
);
1293 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel
*chan
)
1297 return shm_get_wait_fd(chan
->chan
->handle
,
1298 &chan
->chan
->handle
->chan
._ref
);
1301 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel
*chan
)
1305 return shm_get_wakeup_fd(chan
->chan
->handle
,
1306 &chan
->chan
->handle
->chan
._ref
);
1309 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream
*stream
)
1311 struct lttng_ust_lib_ring_buffer
*buf
;
1312 struct ustctl_consumer_channel
*consumer_chan
;
1317 consumer_chan
= stream
->chan
;
1318 return shm_get_wait_fd(consumer_chan
->chan
->handle
, &buf
->self
._ref
);
1321 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream
*stream
)
1323 struct lttng_ust_lib_ring_buffer
*buf
;
1324 struct ustctl_consumer_channel
*consumer_chan
;
1329 consumer_chan
= stream
->chan
;
1330 return shm_get_wakeup_fd(consumer_chan
->chan
->handle
, &buf
->self
._ref
);
1333 /* For mmap mode, readable without "get" operation */
1335 void *ustctl_get_mmap_base(struct ustctl_consumer_stream
*stream
)
1337 struct lttng_ust_lib_ring_buffer
*buf
;
1338 struct ustctl_consumer_channel
*consumer_chan
;
1343 consumer_chan
= stream
->chan
;
1344 return shmp(consumer_chan
->chan
->handle
, buf
->backend
.memory_map
);
1347 /* returns the length to mmap. */
1348 int ustctl_get_mmap_len(struct ustctl_consumer_stream
*stream
,
1351 struct ustctl_consumer_channel
*consumer_chan
;
1352 unsigned long mmap_buf_len
;
1353 struct channel
*chan
;
1357 consumer_chan
= stream
->chan
;
1358 chan
= consumer_chan
->chan
->chan
;
1359 if (chan
->backend
.config
.output
!= RING_BUFFER_MMAP
)
1361 mmap_buf_len
= chan
->backend
.buf_size
;
1362 if (chan
->backend
.extra_reader_sb
)
1363 mmap_buf_len
+= chan
->backend
.subbuf_size
;
1364 if (mmap_buf_len
> INT_MAX
)
1366 *len
= mmap_buf_len
;
1370 /* returns the maximum size for sub-buffers. */
1371 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream
*stream
,
1374 struct ustctl_consumer_channel
*consumer_chan
;
1375 struct channel
*chan
;
1379 consumer_chan
= stream
->chan
;
1380 chan
= consumer_chan
->chan
->chan
;
1381 *len
= chan
->backend
.subbuf_size
;
1386 * For mmap mode, operate on the current packet (between get/put or
1387 * get_next/put_next).
1390 /* returns the offset of the subbuffer belonging to the mmap reader. */
1391 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream
*stream
,
1394 struct channel
*chan
;
1395 unsigned long sb_bindex
;
1396 struct lttng_ust_lib_ring_buffer
*buf
;
1397 struct ustctl_consumer_channel
*consumer_chan
;
1398 struct lttng_ust_lib_ring_buffer_backend_pages_shmp
*barray_idx
;
1399 struct lttng_ust_lib_ring_buffer_backend_pages
*pages
;
1404 consumer_chan
= stream
->chan
;
1405 chan
= consumer_chan
->chan
->chan
;
1406 if (chan
->backend
.config
.output
!= RING_BUFFER_MMAP
)
1408 sb_bindex
= subbuffer_id_get_index(&chan
->backend
.config
,
1409 buf
->backend
.buf_rsb
.id
);
1410 barray_idx
= shmp_index(consumer_chan
->chan
->handle
, buf
->backend
.array
,
1414 pages
= shmp(consumer_chan
->chan
->handle
, barray_idx
->shmp
);
1417 *off
= pages
->mmap_offset
;
1421 /* returns the size of the current sub-buffer, without padding (for mmap). */
1422 int ustctl_get_subbuf_size(struct ustctl_consumer_stream
*stream
,
1425 struct ustctl_consumer_channel
*consumer_chan
;
1426 struct channel
*chan
;
1427 struct lttng_ust_lib_ring_buffer
*buf
;
1433 consumer_chan
= stream
->chan
;
1434 chan
= consumer_chan
->chan
->chan
;
1435 *len
= lib_ring_buffer_get_read_data_size(&chan
->backend
.config
, buf
,
1436 consumer_chan
->chan
->handle
);
1440 /* returns the size of the current sub-buffer, without padding (for mmap). */
1441 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream
*stream
,
1444 struct ustctl_consumer_channel
*consumer_chan
;
1445 struct channel
*chan
;
1446 struct lttng_ust_lib_ring_buffer
*buf
;
1451 consumer_chan
= stream
->chan
;
1452 chan
= consumer_chan
->chan
->chan
;
1453 *len
= lib_ring_buffer_get_read_data_size(&chan
->backend
.config
, buf
,
1454 consumer_chan
->chan
->handle
);
1455 *len
= PAGE_ALIGN(*len
);
1459 /* Get exclusive read access to the next sub-buffer that can be read. */
1460 int ustctl_get_next_subbuf(struct ustctl_consumer_stream
*stream
)
1462 struct lttng_ust_lib_ring_buffer
*buf
;
1463 struct ustctl_consumer_channel
*consumer_chan
;
1468 consumer_chan
= stream
->chan
;
1469 return lib_ring_buffer_get_next_subbuf(buf
,
1470 consumer_chan
->chan
->handle
);
1474 /* Release exclusive sub-buffer access, move consumer forward. */
1475 int ustctl_put_next_subbuf(struct ustctl_consumer_stream
*stream
)
1477 struct lttng_ust_lib_ring_buffer
*buf
;
1478 struct ustctl_consumer_channel
*consumer_chan
;
1483 consumer_chan
= stream
->chan
;
1484 lib_ring_buffer_put_next_subbuf(buf
, consumer_chan
->chan
->handle
);
1490 /* Get a snapshot of the current ring buffer producer and consumer positions */
1491 int ustctl_snapshot(struct ustctl_consumer_stream
*stream
)
1493 struct lttng_ust_lib_ring_buffer
*buf
;
1494 struct ustctl_consumer_channel
*consumer_chan
;
1499 consumer_chan
= stream
->chan
;
1500 return lib_ring_buffer_snapshot(buf
, &buf
->cons_snapshot
,
1501 &buf
->prod_snapshot
, consumer_chan
->chan
->handle
);
1505 * Get a snapshot of the current ring buffer producer and consumer positions
1506 * even if the consumed and produced positions are contained within the same
1509 int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream
*stream
)
1511 struct lttng_ust_lib_ring_buffer
*buf
;
1512 struct ustctl_consumer_channel
*consumer_chan
;
1517 consumer_chan
= stream
->chan
;
1518 return lib_ring_buffer_snapshot_sample_positions(buf
,
1519 &buf
->cons_snapshot
, &buf
->prod_snapshot
,
1520 consumer_chan
->chan
->handle
);
1523 /* Get the consumer position (iteration start) */
1524 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream
*stream
,
1527 struct lttng_ust_lib_ring_buffer
*buf
;
1532 *pos
= buf
->cons_snapshot
;
1536 /* Get the producer position (iteration end) */
1537 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream
*stream
,
1540 struct lttng_ust_lib_ring_buffer
*buf
;
1545 *pos
= buf
->prod_snapshot
;
1549 /* Get exclusive read access to the specified sub-buffer position */
1550 int ustctl_get_subbuf(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 lib_ring_buffer_get_subbuf(buf
, *pos
,
1561 consumer_chan
->chan
->handle
);
1564 /* Release exclusive sub-buffer access */
1565 int ustctl_put_subbuf(struct ustctl_consumer_stream
*stream
)
1567 struct lttng_ust_lib_ring_buffer
*buf
;
1568 struct ustctl_consumer_channel
*consumer_chan
;
1573 consumer_chan
= stream
->chan
;
1574 lib_ring_buffer_put_subbuf(buf
, consumer_chan
->chan
->handle
);
1578 void ustctl_flush_buffer(struct ustctl_consumer_stream
*stream
,
1579 int producer_active
)
1581 struct lttng_ust_lib_ring_buffer
*buf
;
1582 struct ustctl_consumer_channel
*consumer_chan
;
1586 consumer_chan
= stream
->chan
;
1587 lib_ring_buffer_switch_slow(buf
,
1588 producer_active
? SWITCH_ACTIVE
: SWITCH_FLUSH
,
1589 consumer_chan
->chan
->handle
);
1592 void ustctl_clear_buffer(struct ustctl_consumer_stream
*stream
)
1594 struct lttng_ust_lib_ring_buffer
*buf
;
1595 struct ustctl_consumer_channel
*consumer_chan
;
1599 consumer_chan
= stream
->chan
;
1600 lib_ring_buffer_switch_slow(buf
, SWITCH_ACTIVE
,
1601 consumer_chan
->chan
->handle
);
1602 lib_ring_buffer_clear_reader(buf
, consumer_chan
->chan
->handle
);
1606 struct lttng_ust_client_lib_ring_buffer_client_cb
*get_client_cb(
1607 struct lttng_ust_lib_ring_buffer
*buf
,
1608 struct lttng_ust_shm_handle
*handle
)
1610 struct channel
*chan
;
1611 const struct lttng_ust_lib_ring_buffer_config
*config
;
1612 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1614 chan
= shmp(handle
, buf
->backend
.chan
);
1617 config
= &chan
->backend
.config
;
1618 if (!config
->cb_ptr
)
1620 client_cb
= caa_container_of(config
->cb_ptr
,
1621 struct lttng_ust_client_lib_ring_buffer_client_cb
,
1626 int ustctl_get_timestamp_begin(struct ustctl_consumer_stream
*stream
,
1627 uint64_t *timestamp_begin
)
1629 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1630 struct lttng_ust_lib_ring_buffer
*buf
;
1631 struct lttng_ust_shm_handle
*handle
;
1633 if (!stream
|| !timestamp_begin
)
1636 handle
= stream
->chan
->chan
->handle
;
1637 client_cb
= get_client_cb(buf
, handle
);
1640 return client_cb
->timestamp_begin(buf
, handle
, timestamp_begin
);
1643 int ustctl_get_timestamp_end(struct ustctl_consumer_stream
*stream
,
1644 uint64_t *timestamp_end
)
1646 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1647 struct lttng_ust_lib_ring_buffer
*buf
;
1648 struct lttng_ust_shm_handle
*handle
;
1650 if (!stream
|| !timestamp_end
)
1653 handle
= stream
->chan
->chan
->handle
;
1654 client_cb
= get_client_cb(buf
, handle
);
1657 return client_cb
->timestamp_end(buf
, handle
, timestamp_end
);
1660 int ustctl_get_events_discarded(struct ustctl_consumer_stream
*stream
,
1661 uint64_t *events_discarded
)
1663 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1664 struct lttng_ust_lib_ring_buffer
*buf
;
1665 struct lttng_ust_shm_handle
*handle
;
1667 if (!stream
|| !events_discarded
)
1670 handle
= stream
->chan
->chan
->handle
;
1671 client_cb
= get_client_cb(buf
, handle
);
1674 return client_cb
->events_discarded(buf
, handle
, events_discarded
);
1677 int ustctl_get_content_size(struct ustctl_consumer_stream
*stream
,
1678 uint64_t *content_size
)
1680 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1681 struct lttng_ust_lib_ring_buffer
*buf
;
1682 struct lttng_ust_shm_handle
*handle
;
1684 if (!stream
|| !content_size
)
1687 handle
= stream
->chan
->chan
->handle
;
1688 client_cb
= get_client_cb(buf
, handle
);
1691 return client_cb
->content_size(buf
, handle
, content_size
);
1694 int ustctl_get_packet_size(struct ustctl_consumer_stream
*stream
,
1695 uint64_t *packet_size
)
1697 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1698 struct lttng_ust_lib_ring_buffer
*buf
;
1699 struct lttng_ust_shm_handle
*handle
;
1701 if (!stream
|| !packet_size
)
1704 handle
= stream
->chan
->chan
->handle
;
1705 client_cb
= get_client_cb(buf
, handle
);
1708 return client_cb
->packet_size(buf
, handle
, packet_size
);
1711 int ustctl_get_stream_id(struct ustctl_consumer_stream
*stream
,
1712 uint64_t *stream_id
)
1714 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1715 struct lttng_ust_lib_ring_buffer
*buf
;
1716 struct lttng_ust_shm_handle
*handle
;
1718 if (!stream
|| !stream_id
)
1721 handle
= stream
->chan
->chan
->handle
;
1722 client_cb
= get_client_cb(buf
, handle
);
1725 return client_cb
->stream_id(buf
, handle
, stream_id
);
1728 int ustctl_get_current_timestamp(struct ustctl_consumer_stream
*stream
,
1731 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1732 struct lttng_ust_lib_ring_buffer
*buf
;
1733 struct lttng_ust_shm_handle
*handle
;
1738 handle
= stream
->chan
->chan
->handle
;
1739 client_cb
= get_client_cb(buf
, handle
);
1740 if (!client_cb
|| !client_cb
->current_timestamp
)
1742 return client_cb
->current_timestamp(buf
, handle
, ts
);
1745 int ustctl_get_sequence_number(struct ustctl_consumer_stream
*stream
,
1748 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1749 struct lttng_ust_lib_ring_buffer
*buf
;
1750 struct lttng_ust_shm_handle
*handle
;
1752 if (!stream
|| !seq
)
1755 handle
= stream
->chan
->chan
->handle
;
1756 client_cb
= get_client_cb(buf
, handle
);
1757 if (!client_cb
|| !client_cb
->sequence_number
)
1759 return client_cb
->sequence_number(buf
, handle
, seq
);
1762 int ustctl_get_instance_id(struct ustctl_consumer_stream
*stream
,
1765 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1766 struct lttng_ust_lib_ring_buffer
*buf
;
1767 struct lttng_ust_shm_handle
*handle
;
1772 handle
= stream
->chan
->chan
->handle
;
1773 client_cb
= get_client_cb(buf
, handle
);
1776 return client_cb
->instance_id(buf
, handle
, id
);
1779 #ifdef LTTNG_UST_HAVE_PERF_EVENT
1781 int ustctl_has_perf_counters(void)
1788 int ustctl_has_perf_counters(void)
1796 * Returns 0 on success, negative error value on error.
1798 int ustctl_recv_reg_msg(int sock
,
1799 enum ustctl_socket_type
*type
,
1806 uint32_t *bits_per_long
,
1807 uint32_t *uint8_t_alignment
,
1808 uint32_t *uint16_t_alignment
,
1809 uint32_t *uint32_t_alignment
,
1810 uint32_t *uint64_t_alignment
,
1811 uint32_t *long_alignment
,
1816 struct ustctl_reg_msg reg_msg
;
1818 len
= ustcomm_recv_unix_sock(sock
, ®_msg
, sizeof(reg_msg
));
1819 if (len
> 0 && len
!= sizeof(reg_msg
))
1826 if (reg_msg
.magic
== LTTNG_UST_COMM_MAGIC
) {
1827 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
?
1828 BIG_ENDIAN
: LITTLE_ENDIAN
;
1829 } else if (reg_msg
.magic
== bswap_32(LTTNG_UST_COMM_MAGIC
)) {
1830 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
?
1831 LITTLE_ENDIAN
: BIG_ENDIAN
;
1833 return -LTTNG_UST_ERR_INVAL_MAGIC
;
1835 switch (reg_msg
.socket_type
) {
1836 case 0: *type
= USTCTL_SOCKET_CMD
;
1838 case 1: *type
= USTCTL_SOCKET_NOTIFY
;
1841 return -LTTNG_UST_ERR_INVAL_SOCKET_TYPE
;
1843 *major
= reg_msg
.major
;
1844 *minor
= reg_msg
.minor
;
1846 *ppid
= reg_msg
.ppid
;
1849 *bits_per_long
= reg_msg
.bits_per_long
;
1850 *uint8_t_alignment
= reg_msg
.uint8_t_alignment
;
1851 *uint16_t_alignment
= reg_msg
.uint16_t_alignment
;
1852 *uint32_t_alignment
= reg_msg
.uint32_t_alignment
;
1853 *uint64_t_alignment
= reg_msg
.uint64_t_alignment
;
1854 *long_alignment
= reg_msg
.long_alignment
;
1855 memcpy(name
, reg_msg
.name
, LTTNG_UST_ABI_PROCNAME_LEN
);
1856 if (reg_msg
.major
!= LTTNG_UST_ABI_MAJOR_VERSION
) {
1857 return -LTTNG_UST_ERR_UNSUP_MAJOR
;
1863 int ustctl_recv_notify(int sock
, enum ustctl_notify_cmd
*notify_cmd
)
1865 struct ustcomm_notify_hdr header
;
1868 len
= ustcomm_recv_unix_sock(sock
, &header
, sizeof(header
));
1869 if (len
> 0 && len
!= sizeof(header
))
1875 switch (header
.notify_cmd
) {
1877 *notify_cmd
= USTCTL_NOTIFY_CMD_EVENT
;
1880 *notify_cmd
= USTCTL_NOTIFY_CMD_CHANNEL
;
1883 *notify_cmd
= USTCTL_NOTIFY_CMD_ENUM
;
1892 * Returns 0 on success, negative error value on error.
1894 int ustctl_recv_register_event(int sock
,
1901 struct ustctl_field
**fields
,
1902 char **model_emf_uri
)
1905 struct ustcomm_notify_event_msg msg
;
1906 size_t signature_len
, fields_len
, model_emf_uri_len
;
1907 char *a_sign
= NULL
, *a_model_emf_uri
= NULL
;
1908 struct ustctl_field
*a_fields
= NULL
;
1910 len
= ustcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1911 if (len
> 0 && len
!= sizeof(msg
))
1918 *session_objd
= msg
.session_objd
;
1919 *channel_objd
= msg
.channel_objd
;
1920 strncpy(event_name
, msg
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
1921 event_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1922 *loglevel
= msg
.loglevel
;
1923 signature_len
= msg
.signature_len
;
1924 fields_len
= msg
.fields_len
;
1926 if (fields_len
% sizeof(*a_fields
) != 0) {
1930 model_emf_uri_len
= msg
.model_emf_uri_len
;
1932 /* recv signature. contains at least \0. */
1933 a_sign
= zmalloc(signature_len
);
1936 len
= ustcomm_recv_unix_sock(sock
, a_sign
, signature_len
);
1937 if (len
> 0 && len
!= signature_len
) {
1939 goto signature_error
;
1943 goto signature_error
;
1946 goto signature_error
;
1948 /* Enforce end of string */
1949 a_sign
[signature_len
- 1] = '\0';
1953 a_fields
= zmalloc(fields_len
);
1956 goto signature_error
;
1958 len
= ustcomm_recv_unix_sock(sock
, a_fields
, fields_len
);
1959 if (len
> 0 && len
!= fields_len
) {
1972 if (model_emf_uri_len
) {
1973 /* recv model_emf_uri_len */
1974 a_model_emf_uri
= zmalloc(model_emf_uri_len
);
1975 if (!a_model_emf_uri
) {
1979 len
= ustcomm_recv_unix_sock(sock
, a_model_emf_uri
,
1981 if (len
> 0 && len
!= model_emf_uri_len
) {
1992 /* Enforce end of string */
1993 a_model_emf_uri
[model_emf_uri_len
- 1] = '\0';
1996 *signature
= a_sign
;
1997 *nr_fields
= fields_len
/ sizeof(*a_fields
);
1999 *model_emf_uri
= a_model_emf_uri
;
2004 free(a_model_emf_uri
);
2013 * Returns 0 on success, negative error value on error.
2015 int ustctl_reply_register_event(int sock
,
2021 struct ustcomm_notify_hdr header
;
2022 struct ustcomm_notify_event_reply r
;
2025 memset(&reply
, 0, sizeof(reply
));
2026 reply
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_EVENT
;
2027 reply
.r
.ret_code
= ret_code
;
2028 reply
.r
.event_id
= id
;
2029 len
= ustcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2030 if (len
> 0 && len
!= sizeof(reply
))
2038 * Returns 0 on success, negative UST or system error value on error.
2040 int ustctl_recv_register_enum(int sock
,
2043 struct ustctl_enum_entry
**entries
,
2047 struct ustcomm_notify_enum_msg msg
;
2049 struct ustctl_enum_entry
*a_entries
= NULL
;
2051 len
= ustcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
2052 if (len
> 0 && len
!= sizeof(msg
))
2059 *session_objd
= msg
.session_objd
;
2060 strncpy(enum_name
, msg
.enum_name
, LTTNG_UST_SYM_NAME_LEN
);
2061 enum_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
2062 entries_len
= msg
.entries_len
;
2064 if (entries_len
% sizeof(*a_entries
) != 0) {
2070 a_entries
= zmalloc(entries_len
);
2073 len
= ustcomm_recv_unix_sock(sock
, a_entries
, entries_len
);
2074 if (len
> 0 && len
!= entries_len
) {
2086 *nr_entries
= entries_len
/ sizeof(*a_entries
);
2087 *entries
= a_entries
;
2097 * Returns 0 on success, negative error value on error.
2099 int ustctl_reply_register_enum(int sock
,
2105 struct ustcomm_notify_hdr header
;
2106 struct ustcomm_notify_enum_reply r
;
2109 memset(&reply
, 0, sizeof(reply
));
2110 reply
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_ENUM
;
2111 reply
.r
.ret_code
= ret_code
;
2112 reply
.r
.enum_id
= id
;
2113 len
= ustcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2114 if (len
> 0 && len
!= sizeof(reply
))
2122 * Returns 0 on success, negative UST or system error value on error.
2124 int ustctl_recv_register_channel(int sock
,
2125 int *session_objd
, /* session descriptor (output) */
2126 int *channel_objd
, /* channel descriptor (output) */
2128 struct ustctl_field
**fields
)
2131 struct ustcomm_notify_channel_msg msg
;
2133 struct ustctl_field
*a_fields
;
2135 len
= ustcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
2136 if (len
> 0 && len
!= sizeof(msg
))
2143 *session_objd
= msg
.session_objd
;
2144 *channel_objd
= msg
.channel_objd
;
2145 fields_len
= msg
.ctx_fields_len
;
2147 if (fields_len
% sizeof(*a_fields
) != 0) {
2153 a_fields
= zmalloc(fields_len
);
2158 len
= ustcomm_recv_unix_sock(sock
, a_fields
, fields_len
);
2159 if (len
> 0 && len
!= fields_len
) {
2174 *nr_fields
= fields_len
/ sizeof(*a_fields
);
2184 * Returns 0 on success, negative error value on error.
2186 int ustctl_reply_register_channel(int sock
,
2188 enum ustctl_channel_header header_type
,
2193 struct ustcomm_notify_hdr header
;
2194 struct ustcomm_notify_channel_reply r
;
2197 memset(&reply
, 0, sizeof(reply
));
2198 reply
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_CHANNEL
;
2199 reply
.r
.ret_code
= ret_code
;
2200 reply
.r
.chan_id
= chan_id
;
2201 switch (header_type
) {
2202 case USTCTL_CHANNEL_HEADER_COMPACT
:
2203 reply
.r
.header_type
= 1;
2205 case USTCTL_CHANNEL_HEADER_LARGE
:
2206 reply
.r
.header_type
= 2;
2209 reply
.r
.header_type
= 0;
2212 len
= ustcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2213 if (len
> 0 && len
!= sizeof(reply
))
2220 /* Regenerate the statedump. */
2221 int ustctl_regenerate_statedump(int sock
, int handle
)
2223 struct ustcomm_ust_msg lum
;
2224 struct ustcomm_ust_reply lur
;
2227 memset(&lum
, 0, sizeof(lum
));
2228 lum
.handle
= handle
;
2229 lum
.cmd
= LTTNG_UST_SESSION_STATEDUMP
;
2230 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
2233 DBG("Regenerated statedump for handle %u", handle
);
2237 static __attribute__((constructor
))
2238 void ustctl_init(void)
2241 lttng_ust_getenv_init(); /* Needs init_usterr() to be completed. */
2242 lttng_ust_clock_init();
2243 lttng_ring_buffer_metadata_client_init();
2244 lttng_ring_buffer_client_overwrite_init();
2245 lttng_ring_buffer_client_overwrite_rt_init();
2246 lttng_ring_buffer_client_discard_init();
2247 lttng_ring_buffer_client_discard_rt_init();
2248 lib_ringbuffer_signal_init();
2251 static __attribute__((destructor
))
2252 void ustctl_exit(void)
2254 lttng_ring_buffer_client_discard_rt_exit();
2255 lttng_ring_buffer_client_discard_exit();
2256 lttng_ring_buffer_client_overwrite_rt_exit();
2257 lttng_ring_buffer_client_overwrite_exit();
2258 lttng_ring_buffer_metadata_client_exit();