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.
21 #include <lttng/ust-config.h>
22 #include <lttng/ust-ctl.h>
23 #include <lttng/ust-abi.h>
24 #include <lttng/ust-events.h>
28 #include <usterr-signal-safe.h>
32 #include "../libringbuffer/backend.h"
33 #include "../libringbuffer/frontend.h"
34 #include "../liblttng-ust/wait.h"
35 #include "../liblttng-ust/lttng-rb-clients.h"
36 #include "../liblttng-ust/clock.h"
37 #include "../liblttng-ust/getenv.h"
40 * Number of milliseconds to retry before failing metadata writes on
41 * buffer full condition. (10 seconds)
43 #define LTTNG_METADATA_TIMEOUT_MSEC 10000
46 * Channel representation within consumer.
48 struct ustctl_consumer_channel
{
49 struct lttng_channel
*chan
; /* lttng channel buffers */
51 /* initial attributes */
52 struct ustctl_consumer_channel_attr attr
;
53 int wait_fd
; /* monitor close() */
54 int wakeup_fd
; /* monitor close() */
58 * Stream representation within consumer.
60 struct ustctl_consumer_stream
{
61 struct lttng_ust_shm_handle
*handle
; /* shared-memory handle */
62 struct lttng_ust_lib_ring_buffer
*buf
;
63 struct ustctl_consumer_channel
*chan
;
64 int shm_fd
, wait_fd
, wakeup_fd
;
66 uint64_t memory_map_size
;
69 extern void lttng_ring_buffer_client_overwrite_init(void);
70 extern void lttng_ring_buffer_client_overwrite_rt_init(void);
71 extern void lttng_ring_buffer_client_discard_init(void);
72 extern void lttng_ring_buffer_client_discard_rt_init(void);
73 extern void lttng_ring_buffer_metadata_client_init(void);
74 extern void lttng_ring_buffer_client_overwrite_exit(void);
75 extern void lttng_ring_buffer_client_overwrite_rt_exit(void);
76 extern void lttng_ring_buffer_client_discard_exit(void);
77 extern void lttng_ring_buffer_client_discard_rt_exit(void);
78 extern void lttng_ring_buffer_metadata_client_exit(void);
80 volatile enum ust_loglevel ust_loglevel
;
82 int ustctl_release_handle(int sock
, int handle
)
84 struct ustcomm_ust_msg lum
;
85 struct ustcomm_ust_reply lur
;
87 if (sock
< 0 || handle
< 0)
89 memset(&lum
, 0, sizeof(lum
));
91 lum
.cmd
= LTTNG_UST_RELEASE
;
92 return ustcomm_send_app_cmd(sock
, &lum
, &lur
);
96 * If sock is negative, it means we don't have to notify the other side
97 * (e.g. application has already vanished).
99 int ustctl_release_object(int sock
, struct lttng_ust_object_data
*data
)
106 switch (data
->type
) {
107 case LTTNG_UST_OBJECT_TYPE_CHANNEL
:
108 if (data
->u
.channel
.wakeup_fd
>= 0) {
109 ret
= close(data
->u
.channel
.wakeup_fd
);
115 free(data
->u
.channel
.data
);
117 case LTTNG_UST_OBJECT_TYPE_STREAM
:
118 if (data
->u
.stream
.shm_fd
>= 0) {
119 ret
= close(data
->u
.stream
.shm_fd
);
125 if (data
->u
.stream
.wakeup_fd
>= 0) {
126 ret
= close(data
->u
.stream
.wakeup_fd
);
133 case LTTNG_UST_OBJECT_TYPE_EVENT
:
134 case LTTNG_UST_OBJECT_TYPE_CONTEXT
:
139 return ustctl_release_handle(sock
, data
->handle
);
143 * Send registration done packet to the application.
145 int ustctl_register_done(int sock
)
147 struct ustcomm_ust_msg lum
;
148 struct ustcomm_ust_reply lur
;
151 DBG("Sending register done command to %d", sock
);
152 memset(&lum
, 0, sizeof(lum
));
153 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
154 lum
.cmd
= LTTNG_UST_REGISTER_DONE
;
155 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
162 * returns session handle.
164 int ustctl_create_session(int sock
)
166 struct ustcomm_ust_msg lum
;
167 struct ustcomm_ust_reply lur
;
168 int ret
, session_handle
;
171 memset(&lum
, 0, sizeof(lum
));
172 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
173 lum
.cmd
= LTTNG_UST_SESSION
;
174 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
177 session_handle
= lur
.ret_val
;
178 DBG("received session handle %u", session_handle
);
179 return session_handle
;
182 int ustctl_create_event(int sock
, struct lttng_ust_event
*ev
,
183 struct lttng_ust_object_data
*channel_data
,
184 struct lttng_ust_object_data
**_event_data
)
186 struct ustcomm_ust_msg lum
;
187 struct ustcomm_ust_reply lur
;
188 struct lttng_ust_object_data
*event_data
;
191 if (!channel_data
|| !_event_data
)
194 event_data
= zmalloc(sizeof(*event_data
));
197 event_data
->type
= LTTNG_UST_OBJECT_TYPE_EVENT
;
198 memset(&lum
, 0, sizeof(lum
));
199 lum
.handle
= channel_data
->handle
;
200 lum
.cmd
= LTTNG_UST_EVENT
;
201 strncpy(lum
.u
.event
.name
, ev
->name
,
202 LTTNG_UST_SYM_NAME_LEN
);
203 lum
.u
.event
.instrumentation
= ev
->instrumentation
;
204 lum
.u
.event
.loglevel_type
= ev
->loglevel_type
;
205 lum
.u
.event
.loglevel
= ev
->loglevel
;
206 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
211 event_data
->handle
= lur
.ret_val
;
212 DBG("received event handle %u", event_data
->handle
);
213 *_event_data
= event_data
;
217 int ustctl_add_context(int sock
, struct lttng_ust_context_attr
*ctx
,
218 struct lttng_ust_object_data
*obj_data
,
219 struct lttng_ust_object_data
**_context_data
)
221 struct ustcomm_ust_msg lum
;
222 struct ustcomm_ust_reply lur
;
223 struct lttng_ust_object_data
*context_data
= NULL
;
228 if (!obj_data
|| !_context_data
) {
233 context_data
= zmalloc(sizeof(*context_data
));
238 context_data
->type
= LTTNG_UST_OBJECT_TYPE_CONTEXT
;
239 memset(&lum
, 0, sizeof(lum
));
240 lum
.handle
= obj_data
->handle
;
241 lum
.cmd
= LTTNG_UST_CONTEXT
;
243 lum
.u
.context
.ctx
= ctx
->ctx
;
245 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
246 lum
.u
.context
.u
.perf_counter
= ctx
->u
.perf_counter
;
248 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
250 size_t provider_name_len
= strlen(
251 ctx
->u
.app_ctx
.provider_name
) + 1;
252 size_t ctx_name_len
= strlen(ctx
->u
.app_ctx
.ctx_name
) + 1;
254 lum
.u
.context
.u
.app_ctx
.provider_name_len
= provider_name_len
;
255 lum
.u
.context
.u
.app_ctx
.ctx_name_len
= ctx_name_len
;
257 len
= provider_name_len
+ ctx_name_len
;
263 memcpy(buf
, ctx
->u
.app_ctx
.provider_name
,
265 memcpy(buf
+ provider_name_len
, ctx
->u
.app_ctx
.ctx_name
,
272 ret
= ustcomm_send_app_msg(sock
, &lum
);
276 /* send var len ctx_name */
277 ret
= ustcomm_send_unix_sock(sock
, buf
, len
);
286 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
290 context_data
->handle
= -1;
291 DBG("Context created successfully");
292 *_context_data
= context_data
;
300 int ustctl_set_filter(int sock
, struct lttng_ust_filter_bytecode
*bytecode
,
301 struct lttng_ust_object_data
*obj_data
)
303 struct ustcomm_ust_msg lum
;
304 struct ustcomm_ust_reply lur
;
310 memset(&lum
, 0, sizeof(lum
));
311 lum
.handle
= obj_data
->handle
;
312 lum
.cmd
= LTTNG_UST_FILTER
;
313 lum
.u
.filter
.data_size
= bytecode
->len
;
314 lum
.u
.filter
.reloc_offset
= bytecode
->reloc_offset
;
315 lum
.u
.filter
.seqnum
= bytecode
->seqnum
;
317 ret
= ustcomm_send_app_msg(sock
, &lum
);
320 /* send var len bytecode */
321 ret
= ustcomm_send_unix_sock(sock
, bytecode
->data
,
326 if (ret
!= bytecode
->len
)
328 return ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
331 int ustctl_set_exclusion(int sock
, struct lttng_ust_event_exclusion
*exclusion
,
332 struct lttng_ust_object_data
*obj_data
)
334 struct ustcomm_ust_msg lum
;
335 struct ustcomm_ust_reply lur
;
342 memset(&lum
, 0, sizeof(lum
));
343 lum
.handle
= obj_data
->handle
;
344 lum
.cmd
= LTTNG_UST_EXCLUSION
;
345 lum
.u
.exclusion
.count
= exclusion
->count
;
347 ret
= ustcomm_send_app_msg(sock
, &lum
);
352 /* send var len exclusion names */
353 ret
= ustcomm_send_unix_sock(sock
,
355 exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
);
359 if (ret
!= exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) {
362 return ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
365 /* Enable event, channel and session ioctl */
366 int ustctl_enable(int sock
, struct lttng_ust_object_data
*object
)
368 struct ustcomm_ust_msg lum
;
369 struct ustcomm_ust_reply lur
;
375 memset(&lum
, 0, sizeof(lum
));
376 lum
.handle
= object
->handle
;
377 lum
.cmd
= LTTNG_UST_ENABLE
;
378 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
381 DBG("enabled handle %u", object
->handle
);
385 /* Disable event, channel and session ioctl */
386 int ustctl_disable(int sock
, struct lttng_ust_object_data
*object
)
388 struct ustcomm_ust_msg lum
;
389 struct ustcomm_ust_reply lur
;
395 memset(&lum
, 0, sizeof(lum
));
396 lum
.handle
= object
->handle
;
397 lum
.cmd
= LTTNG_UST_DISABLE
;
398 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
401 DBG("disable handle %u", object
->handle
);
405 int ustctl_start_session(int sock
, int handle
)
407 struct lttng_ust_object_data obj
;
410 return ustctl_enable(sock
, &obj
);
413 int ustctl_stop_session(int sock
, int handle
)
415 struct lttng_ust_object_data obj
;
418 return ustctl_disable(sock
, &obj
);
421 int ustctl_tracepoint_list(int sock
)
423 struct ustcomm_ust_msg lum
;
424 struct ustcomm_ust_reply lur
;
425 int ret
, tp_list_handle
;
427 memset(&lum
, 0, sizeof(lum
));
428 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
429 lum
.cmd
= LTTNG_UST_TRACEPOINT_LIST
;
430 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
433 tp_list_handle
= lur
.ret_val
;
434 DBG("received tracepoint list handle %u", tp_list_handle
);
435 return tp_list_handle
;
438 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
439 struct lttng_ust_tracepoint_iter
*iter
)
441 struct ustcomm_ust_msg lum
;
442 struct ustcomm_ust_reply lur
;
448 memset(&lum
, 0, sizeof(lum
));
449 lum
.handle
= tp_list_handle
;
450 lum
.cmd
= LTTNG_UST_TRACEPOINT_LIST_GET
;
451 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
454 DBG("received tracepoint list entry name %s loglevel %d",
455 lur
.u
.tracepoint
.name
,
456 lur
.u
.tracepoint
.loglevel
);
457 memcpy(iter
, &lur
.u
.tracepoint
, sizeof(*iter
));
461 int ustctl_tracepoint_field_list(int sock
)
463 struct ustcomm_ust_msg lum
;
464 struct ustcomm_ust_reply lur
;
465 int ret
, tp_field_list_handle
;
467 memset(&lum
, 0, sizeof(lum
));
468 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
469 lum
.cmd
= LTTNG_UST_TRACEPOINT_FIELD_LIST
;
470 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
473 tp_field_list_handle
= lur
.ret_val
;
474 DBG("received tracepoint field list handle %u", tp_field_list_handle
);
475 return tp_field_list_handle
;
478 int ustctl_tracepoint_field_list_get(int sock
, int tp_field_list_handle
,
479 struct lttng_ust_field_iter
*iter
)
481 struct ustcomm_ust_msg lum
;
482 struct ustcomm_ust_reply lur
;
489 memset(&lum
, 0, sizeof(lum
));
490 lum
.handle
= tp_field_list_handle
;
491 lum
.cmd
= LTTNG_UST_TRACEPOINT_FIELD_LIST_GET
;
492 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
495 len
= ustcomm_recv_unix_sock(sock
, iter
, sizeof(*iter
));
496 if (len
!= sizeof(*iter
)) {
499 DBG("received tracepoint field list entry event_name %s event_loglevel %d field_name %s field_type %d",
507 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
)
509 struct ustcomm_ust_msg lum
;
510 struct ustcomm_ust_reply lur
;
516 memset(&lum
, 0, sizeof(lum
));
517 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
518 lum
.cmd
= LTTNG_UST_TRACER_VERSION
;
519 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
522 memcpy(v
, &lur
.u
.version
, sizeof(*v
));
523 DBG("received tracer version");
527 int ustctl_wait_quiescent(int sock
)
529 struct ustcomm_ust_msg lum
;
530 struct ustcomm_ust_reply lur
;
533 memset(&lum
, 0, sizeof(lum
));
534 lum
.handle
= LTTNG_UST_ROOT_HANDLE
;
535 lum
.cmd
= LTTNG_UST_WAIT_QUIESCENT
;
536 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
539 DBG("waited for quiescent state");
543 int ustctl_calibrate(int sock
, struct lttng_ust_calibrate
*calibrate
)
551 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_object_data
*object
)
553 struct ustcomm_ust_msg lum
;
554 struct ustcomm_ust_reply lur
;
560 memset(&lum
, 0, sizeof(lum
));
561 lum
.handle
= object
->handle
;
562 lum
.cmd
= LTTNG_UST_FLUSH_BUFFER
;
563 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
566 DBG("flushed buffer handle %u", object
->handle
);
571 int ustctl_send_channel(int sock
,
572 enum lttng_ust_chan_type type
,
582 len
= ustcomm_send_unix_sock(sock
, &size
, sizeof(size
));
583 if (len
!= sizeof(size
)) {
590 /* Send channel type */
591 len
= ustcomm_send_unix_sock(sock
, &type
, sizeof(type
));
592 if (len
!= sizeof(type
)) {
600 /* Send channel data */
601 len
= ustcomm_send_unix_sock(sock
, data
, size
);
610 len
= ustcomm_send_fds_unix_sock(sock
, &wakeup_fd
, 1);
621 int ustctl_send_stream(int sock
,
623 uint64_t memory_map_size
,
624 int shm_fd
, int wakeup_fd
,
632 /* finish iteration */
635 len
= ustcomm_send_unix_sock(sock
, &v
, sizeof(v
));
636 if (len
!= sizeof(v
)) {
646 len
= ustcomm_send_unix_sock(sock
, &memory_map_size
,
647 sizeof(memory_map_size
));
648 if (len
!= sizeof(memory_map_size
)) {
656 len
= ustcomm_send_unix_sock(sock
, &stream_nr
,
658 if (len
!= sizeof(stream_nr
)) {
666 /* Send shm fd and wakeup fd */
669 len
= ustcomm_send_fds_unix_sock(sock
, fds
, 2);
679 int ustctl_recv_channel_from_consumer(int sock
,
680 struct lttng_ust_object_data
**_channel_data
)
682 struct lttng_ust_object_data
*channel_data
;
687 channel_data
= zmalloc(sizeof(*channel_data
));
692 channel_data
->type
= LTTNG_UST_OBJECT_TYPE_CHANNEL
;
693 channel_data
->handle
= -1;
696 len
= ustcomm_recv_unix_sock(sock
, &channel_data
->size
,
697 sizeof(channel_data
->size
));
698 if (len
!= sizeof(channel_data
->size
)) {
706 /* recv channel type */
707 len
= ustcomm_recv_unix_sock(sock
, &channel_data
->u
.channel
.type
,
708 sizeof(channel_data
->u
.channel
.type
));
709 if (len
!= sizeof(channel_data
->u
.channel
.type
)) {
717 /* recv channel data */
718 channel_data
->u
.channel
.data
= zmalloc(channel_data
->size
);
719 if (!channel_data
->u
.channel
.data
) {
723 len
= ustcomm_recv_unix_sock(sock
, channel_data
->u
.channel
.data
,
725 if (len
!= channel_data
->size
) {
730 goto error_recv_data
;
733 len
= ustcomm_recv_fds_unix_sock(sock
, &wakeup_fd
, 1);
737 goto error_recv_data
;
740 goto error_recv_data
;
743 channel_data
->u
.channel
.wakeup_fd
= wakeup_fd
;
744 *_channel_data
= channel_data
;
748 free(channel_data
->u
.channel
.data
);
755 int ustctl_recv_stream_from_consumer(int sock
,
756 struct lttng_ust_object_data
**_stream_data
)
758 struct lttng_ust_object_data
*stream_data
;
763 stream_data
= zmalloc(sizeof(*stream_data
));
769 stream_data
->type
= LTTNG_UST_OBJECT_TYPE_STREAM
;
770 stream_data
->handle
= -1;
773 len
= ustcomm_recv_unix_sock(sock
, &stream_data
->size
,
774 sizeof(stream_data
->size
));
775 if (len
!= sizeof(stream_data
->size
)) {
782 if (stream_data
->size
== -1) {
783 ret
= -LTTNG_UST_ERR_NOENT
;
788 len
= ustcomm_recv_unix_sock(sock
, &stream_data
->u
.stream
.stream_nr
,
789 sizeof(stream_data
->u
.stream
.stream_nr
));
790 if (len
!= sizeof(stream_data
->u
.stream
.stream_nr
)) {
798 /* recv shm fd and wakeup fd */
799 len
= ustcomm_recv_fds_unix_sock(sock
, fds
, 2);
809 stream_data
->u
.stream
.shm_fd
= fds
[0];
810 stream_data
->u
.stream
.wakeup_fd
= fds
[1];
811 *_stream_data
= stream_data
;
820 int ustctl_send_channel_to_ust(int sock
, int session_handle
,
821 struct lttng_ust_object_data
*channel_data
)
823 struct ustcomm_ust_msg lum
;
824 struct ustcomm_ust_reply lur
;
830 memset(&lum
, 0, sizeof(lum
));
831 lum
.handle
= session_handle
;
832 lum
.cmd
= LTTNG_UST_CHANNEL
;
833 lum
.u
.channel
.len
= channel_data
->size
;
834 lum
.u
.channel
.type
= channel_data
->u
.channel
.type
;
835 ret
= ustcomm_send_app_msg(sock
, &lum
);
839 ret
= ustctl_send_channel(sock
,
840 channel_data
->u
.channel
.type
,
841 channel_data
->u
.channel
.data
,
843 channel_data
->u
.channel
.wakeup_fd
,
847 ret
= ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
849 channel_data
->handle
= lur
.ret_val
;
854 int ustctl_send_stream_to_ust(int sock
,
855 struct lttng_ust_object_data
*channel_data
,
856 struct lttng_ust_object_data
*stream_data
)
858 struct ustcomm_ust_msg lum
;
859 struct ustcomm_ust_reply lur
;
862 memset(&lum
, 0, sizeof(lum
));
863 lum
.handle
= channel_data
->handle
;
864 lum
.cmd
= LTTNG_UST_STREAM
;
865 lum
.u
.stream
.len
= stream_data
->size
;
866 lum
.u
.stream
.stream_nr
= stream_data
->u
.stream
.stream_nr
;
867 ret
= ustcomm_send_app_msg(sock
, &lum
);
872 assert(stream_data
->type
== LTTNG_UST_OBJECT_TYPE_STREAM
);
874 ret
= ustctl_send_stream(sock
,
875 stream_data
->u
.stream
.stream_nr
,
877 stream_data
->u
.stream
.shm_fd
,
878 stream_data
->u
.stream
.wakeup_fd
, 1);
881 return ustcomm_recv_app_reply(sock
, &lur
, lum
.handle
, lum
.cmd
);
884 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data
**dest
,
885 struct lttng_ust_object_data
*src
)
887 struct lttng_ust_object_data
*obj
;
890 if (src
->handle
!= -1) {
895 obj
= zmalloc(sizeof(*obj
));
901 obj
->type
= src
->type
;
902 obj
->handle
= src
->handle
;
903 obj
->size
= src
->size
;
906 case LTTNG_UST_OBJECT_TYPE_CHANNEL
:
908 obj
->u
.channel
.type
= src
->u
.channel
.type
;
909 if (src
->u
.channel
.wakeup_fd
>= 0) {
910 obj
->u
.channel
.wakeup_fd
=
911 dup(src
->u
.channel
.wakeup_fd
);
912 if (obj
->u
.channel
.wakeup_fd
< 0) {
914 goto chan_error_wakeup_fd
;
917 obj
->u
.channel
.wakeup_fd
=
918 src
->u
.channel
.wakeup_fd
;
920 obj
->u
.channel
.data
= zmalloc(obj
->size
);
921 if (!obj
->u
.channel
.data
) {
923 goto chan_error_alloc
;
925 memcpy(obj
->u
.channel
.data
, src
->u
.channel
.data
, obj
->size
);
929 if (src
->u
.channel
.wakeup_fd
>= 0) {
932 closeret
= close(obj
->u
.channel
.wakeup_fd
);
937 chan_error_wakeup_fd
:
942 case LTTNG_UST_OBJECT_TYPE_STREAM
:
944 obj
->u
.stream
.stream_nr
= src
->u
.stream
.stream_nr
;
945 if (src
->u
.stream
.wakeup_fd
>= 0) {
946 obj
->u
.stream
.wakeup_fd
=
947 dup(src
->u
.stream
.wakeup_fd
);
948 if (obj
->u
.stream
.wakeup_fd
< 0) {
950 goto stream_error_wakeup_fd
;
953 obj
->u
.stream
.wakeup_fd
=
954 src
->u
.stream
.wakeup_fd
;
957 if (src
->u
.stream
.shm_fd
>= 0) {
958 obj
->u
.stream
.shm_fd
=
959 dup(src
->u
.stream
.shm_fd
);
960 if (obj
->u
.stream
.shm_fd
< 0) {
962 goto stream_error_shm_fd
;
965 obj
->u
.stream
.shm_fd
=
966 src
->u
.stream
.shm_fd
;
971 if (src
->u
.stream
.wakeup_fd
>= 0) {
974 closeret
= close(obj
->u
.stream
.wakeup_fd
);
979 stream_error_wakeup_fd
:
998 /* Buffer operations */
1000 int ustctl_get_nr_stream_per_channel(void)
1002 return num_possible_cpus();
1005 struct ustctl_consumer_channel
*
1006 ustctl_create_channel(struct ustctl_consumer_channel_attr
*attr
,
1007 const int *stream_fds
, int nr_stream_fds
)
1009 struct ustctl_consumer_channel
*chan
;
1010 const char *transport_name
;
1011 struct lttng_transport
*transport
;
1013 switch (attr
->type
) {
1014 case LTTNG_UST_CHAN_PER_CPU
:
1015 if (attr
->output
== LTTNG_UST_MMAP
) {
1016 if (attr
->overwrite
) {
1017 if (attr
->read_timer_interval
== 0) {
1018 transport_name
= "relay-overwrite-mmap";
1020 transport_name
= "relay-overwrite-rt-mmap";
1023 if (attr
->read_timer_interval
== 0) {
1024 transport_name
= "relay-discard-mmap";
1026 transport_name
= "relay-discard-rt-mmap";
1033 case LTTNG_UST_CHAN_METADATA
:
1034 if (attr
->output
== LTTNG_UST_MMAP
)
1035 transport_name
= "relay-metadata-mmap";
1040 transport_name
= "<unknown>";
1044 transport
= lttng_transport_find(transport_name
);
1046 DBG("LTTng transport %s not found\n",
1051 chan
= zmalloc(sizeof(*chan
));
1055 chan
->chan
= transport
->ops
.channel_create(transport_name
, NULL
,
1056 attr
->subbuf_size
, attr
->num_subbuf
,
1057 attr
->switch_timer_interval
,
1058 attr
->read_timer_interval
,
1059 attr
->uuid
, attr
->chan_id
,
1060 stream_fds
, nr_stream_fds
);
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
);
1504 /* Get the consumer position (iteration start) */
1505 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream
*stream
,
1508 struct lttng_ust_lib_ring_buffer
*buf
;
1513 *pos
= buf
->cons_snapshot
;
1517 /* Get the producer position (iteration end) */
1518 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream
*stream
,
1521 struct lttng_ust_lib_ring_buffer
*buf
;
1526 *pos
= buf
->prod_snapshot
;
1530 /* Get exclusive read access to the specified sub-buffer position */
1531 int ustctl_get_subbuf(struct ustctl_consumer_stream
*stream
,
1534 struct lttng_ust_lib_ring_buffer
*buf
;
1535 struct ustctl_consumer_channel
*consumer_chan
;
1540 consumer_chan
= stream
->chan
;
1541 return lib_ring_buffer_get_subbuf(buf
, *pos
,
1542 consumer_chan
->chan
->handle
);
1545 /* Release exclusive sub-buffer access */
1546 int ustctl_put_subbuf(struct ustctl_consumer_stream
*stream
)
1548 struct lttng_ust_lib_ring_buffer
*buf
;
1549 struct ustctl_consumer_channel
*consumer_chan
;
1554 consumer_chan
= stream
->chan
;
1555 lib_ring_buffer_put_subbuf(buf
, consumer_chan
->chan
->handle
);
1559 void ustctl_flush_buffer(struct ustctl_consumer_stream
*stream
,
1560 int producer_active
)
1562 struct lttng_ust_lib_ring_buffer
*buf
;
1563 struct ustctl_consumer_channel
*consumer_chan
;
1567 consumer_chan
= stream
->chan
;
1568 lib_ring_buffer_switch_slow(buf
,
1569 producer_active
? SWITCH_ACTIVE
: SWITCH_FLUSH
,
1570 consumer_chan
->chan
->handle
);
1574 struct lttng_ust_client_lib_ring_buffer_client_cb
*get_client_cb(
1575 struct lttng_ust_lib_ring_buffer
*buf
,
1576 struct lttng_ust_shm_handle
*handle
)
1578 struct channel
*chan
;
1579 const struct lttng_ust_lib_ring_buffer_config
*config
;
1580 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1582 chan
= shmp(handle
, buf
->backend
.chan
);
1585 config
= &chan
->backend
.config
;
1586 if (!config
->cb_ptr
)
1588 client_cb
= caa_container_of(config
->cb_ptr
,
1589 struct lttng_ust_client_lib_ring_buffer_client_cb
,
1594 int ustctl_get_timestamp_begin(struct ustctl_consumer_stream
*stream
,
1595 uint64_t *timestamp_begin
)
1597 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1598 struct lttng_ust_lib_ring_buffer
*buf
;
1599 struct lttng_ust_shm_handle
*handle
;
1601 if (!stream
|| !timestamp_begin
)
1604 handle
= stream
->chan
->chan
->handle
;
1605 client_cb
= get_client_cb(buf
, handle
);
1608 return client_cb
->timestamp_begin(buf
, handle
, timestamp_begin
);
1611 int ustctl_get_timestamp_end(struct ustctl_consumer_stream
*stream
,
1612 uint64_t *timestamp_end
)
1614 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1615 struct lttng_ust_lib_ring_buffer
*buf
;
1616 struct lttng_ust_shm_handle
*handle
;
1618 if (!stream
|| !timestamp_end
)
1621 handle
= stream
->chan
->chan
->handle
;
1622 client_cb
= get_client_cb(buf
, handle
);
1625 return client_cb
->timestamp_end(buf
, handle
, timestamp_end
);
1628 int ustctl_get_events_discarded(struct ustctl_consumer_stream
*stream
,
1629 uint64_t *events_discarded
)
1631 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1632 struct lttng_ust_lib_ring_buffer
*buf
;
1633 struct lttng_ust_shm_handle
*handle
;
1635 if (!stream
|| !events_discarded
)
1638 handle
= stream
->chan
->chan
->handle
;
1639 client_cb
= get_client_cb(buf
, handle
);
1642 return client_cb
->events_discarded(buf
, handle
, events_discarded
);
1645 int ustctl_get_content_size(struct ustctl_consumer_stream
*stream
,
1646 uint64_t *content_size
)
1648 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1649 struct lttng_ust_lib_ring_buffer
*buf
;
1650 struct lttng_ust_shm_handle
*handle
;
1652 if (!stream
|| !content_size
)
1655 handle
= stream
->chan
->chan
->handle
;
1656 client_cb
= get_client_cb(buf
, handle
);
1659 return client_cb
->content_size(buf
, handle
, content_size
);
1662 int ustctl_get_packet_size(struct ustctl_consumer_stream
*stream
,
1663 uint64_t *packet_size
)
1665 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1666 struct lttng_ust_lib_ring_buffer
*buf
;
1667 struct lttng_ust_shm_handle
*handle
;
1669 if (!stream
|| !packet_size
)
1672 handle
= stream
->chan
->chan
->handle
;
1673 client_cb
= get_client_cb(buf
, handle
);
1676 return client_cb
->packet_size(buf
, handle
, packet_size
);
1679 int ustctl_get_stream_id(struct ustctl_consumer_stream
*stream
,
1680 uint64_t *stream_id
)
1682 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1683 struct lttng_ust_lib_ring_buffer
*buf
;
1684 struct lttng_ust_shm_handle
*handle
;
1686 if (!stream
|| !stream_id
)
1689 handle
= stream
->chan
->chan
->handle
;
1690 client_cb
= get_client_cb(buf
, handle
);
1693 return client_cb
->stream_id(buf
, handle
, stream_id
);
1696 int ustctl_get_current_timestamp(struct ustctl_consumer_stream
*stream
,
1699 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1700 struct lttng_ust_lib_ring_buffer
*buf
;
1701 struct lttng_ust_shm_handle
*handle
;
1706 handle
= stream
->chan
->chan
->handle
;
1707 client_cb
= get_client_cb(buf
, handle
);
1708 if (!client_cb
|| !client_cb
->current_timestamp
)
1710 return client_cb
->current_timestamp(buf
, handle
, ts
);
1713 int ustctl_get_sequence_number(struct ustctl_consumer_stream
*stream
,
1716 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1717 struct lttng_ust_lib_ring_buffer
*buf
;
1718 struct lttng_ust_shm_handle
*handle
;
1720 if (!stream
|| !seq
)
1723 handle
= stream
->chan
->chan
->handle
;
1724 client_cb
= get_client_cb(buf
, handle
);
1725 if (!client_cb
|| !client_cb
->sequence_number
)
1727 return client_cb
->sequence_number(buf
, handle
, seq
);
1730 int ustctl_get_instance_id(struct ustctl_consumer_stream
*stream
,
1733 struct lttng_ust_client_lib_ring_buffer_client_cb
*client_cb
;
1734 struct lttng_ust_lib_ring_buffer
*buf
;
1735 struct lttng_ust_shm_handle
*handle
;
1740 handle
= stream
->chan
->chan
->handle
;
1741 client_cb
= get_client_cb(buf
, handle
);
1744 return client_cb
->instance_id(buf
, handle
, id
);
1747 #ifdef LTTNG_UST_HAVE_PERF_EVENT
1749 int ustctl_has_perf_counters(void)
1756 int ustctl_has_perf_counters(void)
1764 * Returns 0 on success, negative error value on error.
1766 int ustctl_recv_reg_msg(int sock
,
1767 enum ustctl_socket_type
*type
,
1774 uint32_t *bits_per_long
,
1775 uint32_t *uint8_t_alignment
,
1776 uint32_t *uint16_t_alignment
,
1777 uint32_t *uint32_t_alignment
,
1778 uint32_t *uint64_t_alignment
,
1779 uint32_t *long_alignment
,
1784 struct ustctl_reg_msg reg_msg
;
1786 len
= ustcomm_recv_unix_sock(sock
, ®_msg
, sizeof(reg_msg
));
1787 if (len
> 0 && len
!= sizeof(reg_msg
))
1794 if (reg_msg
.magic
== LTTNG_UST_COMM_MAGIC
) {
1795 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
?
1796 BIG_ENDIAN
: LITTLE_ENDIAN
;
1797 } else if (reg_msg
.magic
== bswap_32(LTTNG_UST_COMM_MAGIC
)) {
1798 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
?
1799 LITTLE_ENDIAN
: BIG_ENDIAN
;
1801 return -LTTNG_UST_ERR_INVAL_MAGIC
;
1803 switch (reg_msg
.socket_type
) {
1804 case 0: *type
= USTCTL_SOCKET_CMD
;
1806 case 1: *type
= USTCTL_SOCKET_NOTIFY
;
1809 return -LTTNG_UST_ERR_INVAL_SOCKET_TYPE
;
1811 *major
= reg_msg
.major
;
1812 *minor
= reg_msg
.minor
;
1814 *ppid
= reg_msg
.ppid
;
1817 *bits_per_long
= reg_msg
.bits_per_long
;
1818 *uint8_t_alignment
= reg_msg
.uint8_t_alignment
;
1819 *uint16_t_alignment
= reg_msg
.uint16_t_alignment
;
1820 *uint32_t_alignment
= reg_msg
.uint32_t_alignment
;
1821 *uint64_t_alignment
= reg_msg
.uint64_t_alignment
;
1822 *long_alignment
= reg_msg
.long_alignment
;
1823 memcpy(name
, reg_msg
.name
, LTTNG_UST_ABI_PROCNAME_LEN
);
1824 if (reg_msg
.major
!= LTTNG_UST_ABI_MAJOR_VERSION
) {
1825 return -LTTNG_UST_ERR_UNSUP_MAJOR
;
1831 int ustctl_recv_notify(int sock
, enum ustctl_notify_cmd
*notify_cmd
)
1833 struct ustcomm_notify_hdr header
;
1836 len
= ustcomm_recv_unix_sock(sock
, &header
, sizeof(header
));
1837 if (len
> 0 && len
!= sizeof(header
))
1843 switch (header
.notify_cmd
) {
1845 *notify_cmd
= USTCTL_NOTIFY_CMD_EVENT
;
1848 *notify_cmd
= USTCTL_NOTIFY_CMD_CHANNEL
;
1851 *notify_cmd
= USTCTL_NOTIFY_CMD_ENUM
;
1860 * Returns 0 on success, negative error value on error.
1862 int ustctl_recv_register_event(int sock
,
1869 struct ustctl_field
**fields
,
1870 char **model_emf_uri
)
1873 struct ustcomm_notify_event_msg msg
;
1874 size_t signature_len
, fields_len
, model_emf_uri_len
;
1875 char *a_sign
= NULL
, *a_model_emf_uri
= NULL
;
1876 struct ustctl_field
*a_fields
= NULL
;
1878 len
= ustcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1879 if (len
> 0 && len
!= sizeof(msg
))
1886 *session_objd
= msg
.session_objd
;
1887 *channel_objd
= msg
.channel_objd
;
1888 strncpy(event_name
, msg
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
1889 event_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1890 *loglevel
= msg
.loglevel
;
1891 signature_len
= msg
.signature_len
;
1892 fields_len
= msg
.fields_len
;
1894 if (fields_len
% sizeof(*a_fields
) != 0) {
1898 model_emf_uri_len
= msg
.model_emf_uri_len
;
1900 /* recv signature. contains at least \0. */
1901 a_sign
= zmalloc(signature_len
);
1904 len
= ustcomm_recv_unix_sock(sock
, a_sign
, signature_len
);
1905 if (len
> 0 && len
!= signature_len
) {
1907 goto signature_error
;
1911 goto signature_error
;
1914 goto signature_error
;
1916 /* Enforce end of string */
1917 a_sign
[signature_len
- 1] = '\0';
1921 a_fields
= zmalloc(fields_len
);
1924 goto signature_error
;
1926 len
= ustcomm_recv_unix_sock(sock
, a_fields
, fields_len
);
1927 if (len
> 0 && len
!= fields_len
) {
1940 if (model_emf_uri_len
) {
1941 /* recv model_emf_uri_len */
1942 a_model_emf_uri
= zmalloc(model_emf_uri_len
);
1943 if (!a_model_emf_uri
) {
1947 len
= ustcomm_recv_unix_sock(sock
, a_model_emf_uri
,
1949 if (len
> 0 && len
!= model_emf_uri_len
) {
1960 /* Enforce end of string */
1961 a_model_emf_uri
[model_emf_uri_len
- 1] = '\0';
1964 *signature
= a_sign
;
1965 *nr_fields
= fields_len
/ sizeof(*a_fields
);
1967 *model_emf_uri
= a_model_emf_uri
;
1972 free(a_model_emf_uri
);
1981 * Returns 0 on success, negative error value on error.
1983 int ustctl_reply_register_event(int sock
,
1989 struct ustcomm_notify_hdr header
;
1990 struct ustcomm_notify_event_reply r
;
1993 memset(&reply
, 0, sizeof(reply
));
1994 reply
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_EVENT
;
1995 reply
.r
.ret_code
= ret_code
;
1996 reply
.r
.event_id
= id
;
1997 len
= ustcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
1998 if (len
> 0 && len
!= sizeof(reply
))
2006 * Returns 0 on success, negative UST or system error value on error.
2008 int ustctl_recv_register_enum(int sock
,
2011 struct ustctl_enum_entry
**entries
,
2015 struct ustcomm_notify_enum_msg msg
;
2017 struct ustctl_enum_entry
*a_entries
= NULL
;
2019 len
= ustcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
2020 if (len
> 0 && len
!= sizeof(msg
))
2027 *session_objd
= msg
.session_objd
;
2028 strncpy(enum_name
, msg
.enum_name
, LTTNG_UST_SYM_NAME_LEN
);
2029 enum_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
2030 entries_len
= msg
.entries_len
;
2032 if (entries_len
% sizeof(*a_entries
) != 0) {
2038 a_entries
= zmalloc(entries_len
);
2041 len
= ustcomm_recv_unix_sock(sock
, a_entries
, entries_len
);
2042 if (len
> 0 && len
!= entries_len
) {
2054 *nr_entries
= entries_len
/ sizeof(*a_entries
);
2055 *entries
= a_entries
;
2065 * Returns 0 on success, negative error value on error.
2067 int ustctl_reply_register_enum(int sock
,
2073 struct ustcomm_notify_hdr header
;
2074 struct ustcomm_notify_enum_reply r
;
2077 memset(&reply
, 0, sizeof(reply
));
2078 reply
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_ENUM
;
2079 reply
.r
.ret_code
= ret_code
;
2080 reply
.r
.enum_id
= id
;
2081 len
= ustcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2082 if (len
> 0 && len
!= sizeof(reply
))
2090 * Returns 0 on success, negative UST or system error value on error.
2092 int ustctl_recv_register_channel(int sock
,
2093 int *session_objd
, /* session descriptor (output) */
2094 int *channel_objd
, /* channel descriptor (output) */
2096 struct ustctl_field
**fields
)
2099 struct ustcomm_notify_channel_msg msg
;
2101 struct ustctl_field
*a_fields
;
2103 len
= ustcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
2104 if (len
> 0 && len
!= sizeof(msg
))
2111 *session_objd
= msg
.session_objd
;
2112 *channel_objd
= msg
.channel_objd
;
2113 fields_len
= msg
.ctx_fields_len
;
2115 if (fields_len
% sizeof(*a_fields
) != 0) {
2121 a_fields
= zmalloc(fields_len
);
2126 len
= ustcomm_recv_unix_sock(sock
, a_fields
, fields_len
);
2127 if (len
> 0 && len
!= fields_len
) {
2142 *nr_fields
= fields_len
/ sizeof(*a_fields
);
2152 * Returns 0 on success, negative error value on error.
2154 int ustctl_reply_register_channel(int sock
,
2156 enum ustctl_channel_header header_type
,
2161 struct ustcomm_notify_hdr header
;
2162 struct ustcomm_notify_channel_reply r
;
2165 memset(&reply
, 0, sizeof(reply
));
2166 reply
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_CHANNEL
;
2167 reply
.r
.ret_code
= ret_code
;
2168 reply
.r
.chan_id
= chan_id
;
2169 switch (header_type
) {
2170 case USTCTL_CHANNEL_HEADER_COMPACT
:
2171 reply
.r
.header_type
= 1;
2173 case USTCTL_CHANNEL_HEADER_LARGE
:
2174 reply
.r
.header_type
= 2;
2177 reply
.r
.header_type
= 0;
2180 len
= ustcomm_send_unix_sock(sock
, &reply
, sizeof(reply
));
2181 if (len
> 0 && len
!= sizeof(reply
))
2188 /* Regenerate the statedump. */
2189 int ustctl_regenerate_statedump(int sock
, int handle
)
2191 struct ustcomm_ust_msg lum
;
2192 struct ustcomm_ust_reply lur
;
2195 memset(&lum
, 0, sizeof(lum
));
2196 lum
.handle
= handle
;
2197 lum
.cmd
= LTTNG_UST_SESSION_STATEDUMP
;
2198 ret
= ustcomm_send_app_cmd(sock
, &lum
, &lur
);
2201 DBG("Regenerated statedump for handle %u", handle
);
2205 static __attribute__((constructor
))
2206 void ustctl_init(void)
2209 lttng_ust_getenv_init(); /* Needs init_usterr() to be completed. */
2210 lttng_ust_clock_init();
2211 lttng_ring_buffer_metadata_client_init();
2212 lttng_ring_buffer_client_overwrite_init();
2213 lttng_ring_buffer_client_overwrite_rt_init();
2214 lttng_ring_buffer_client_discard_init();
2215 lttng_ring_buffer_client_discard_rt_init();
2216 lib_ringbuffer_signal_init();
2219 static __attribute__((destructor
))
2220 void ustctl_exit(void)
2222 lttng_ring_buffer_client_discard_rt_exit();
2223 lttng_ring_buffer_client_discard_exit();
2224 lttng_ring_buffer_client_overwrite_rt_exit();
2225 lttng_ring_buffer_client_overwrite_exit();
2226 lttng_ring_buffer_metadata_client_exit();