2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2011-2013 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; only
8 * version 2.1 of the License.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include <sys/socket.h>
27 #include <sys/types.h>
34 #include <lttng/ust-ctl.h>
38 #include <lttng/ust-error.h>
39 #include <lttng/ust-events.h>
40 #include <lttng/ust-dynamic-type.h>
41 #include <usterr-signal-safe.h>
43 #include "../liblttng-ust/compat.h"
45 #define USTCOMM_CODE_OFFSET(code) \
46 (code == LTTNG_UST_OK ? 0 : (code - LTTNG_UST_ERR + 1))
48 #define USTCOMM_MAX_SEND_FDS 4
51 ssize_t
count_fields_recursive(size_t nr_fields
,
52 const struct lttng_event_field
*lttng_fields
);
54 int serialize_one_field(struct lttng_session
*session
,
55 struct ustctl_field
*fields
, size_t *iter_output
,
56 const struct lttng_event_field
*lf
);
58 int serialize_fields(struct lttng_session
*session
,
59 struct ustctl_field
*ustctl_fields
,
60 size_t *iter_output
, size_t nr_lttng_fields
,
61 const struct lttng_event_field
*lttng_fields
);
64 * Human readable error message.
66 static const char *ustcomm_readable_code
[] = {
67 [ USTCOMM_CODE_OFFSET(LTTNG_UST_OK
) ] = "Success",
68 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR
) ] = "Unknown error",
69 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_NOENT
) ] = "No entry",
70 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_EXIST
) ] = "Object already exists",
71 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_INVAL
) ] = "Invalid argument",
72 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_PERM
) ] = "Permission denied",
73 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_NOSYS
) ] = "Not implemented",
74 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_EXITING
) ] = "Process is exiting",
76 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_INVAL_MAGIC
) ] = "Invalid magic number",
77 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_INVAL_SOCKET_TYPE
) ] = "Invalid socket type",
78 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_UNSUP_MAJOR
) ] = "Unsupported major version",
84 * Receives positive error value.
85 * Return ptr to string representing a human readable
86 * error code from the ustcomm_return_code enum.
88 const char *lttng_ust_strerror(int code
)
90 if (code
== LTTNG_UST_OK
)
91 return ustcomm_readable_code
[USTCOMM_CODE_OFFSET(code
)];
92 if (code
< LTTNG_UST_ERR
)
93 return strerror(code
);
94 if (code
>= LTTNG_UST_ERR_NR
)
96 return ustcomm_readable_code
[USTCOMM_CODE_OFFSET(code
)];
100 * ustcomm_connect_unix_sock
102 * Connect to unix socket using the path name.
104 * Caller handles FD tracker.
106 int ustcomm_connect_unix_sock(const char *pathname
, long timeout
)
108 struct sockaddr_un sun
;
112 * libust threads require the close-on-exec flag for all
113 * resources so it does not leak file descriptors upon exec.
114 * SOCK_CLOEXEC is not used since it is linux specific.
116 fd
= socket(PF_UNIX
, SOCK_STREAM
, 0);
123 /* Give at least 10ms. */
126 ret
= ustcomm_setsockopt_snd_timeout(fd
, timeout
);
128 WARN("Error setting connect socket send timeout");
131 ret
= fcntl(fd
, F_SETFD
, FD_CLOEXEC
);
138 memset(&sun
, 0, sizeof(sun
));
139 sun
.sun_family
= AF_UNIX
;
140 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
141 sun
.sun_path
[sizeof(sun
.sun_path
) - 1] = '\0';
143 ret
= connect(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
146 * Don't print message on connect ENOENT error, because
147 * connect is used in normal execution to detect if
148 * sessiond is alive. ENOENT is when the unix socket
149 * file does not exist, and ECONNREFUSED is when the
150 * file exists but no sessiond is listening.
152 if (errno
!= ECONNREFUSED
&& errno
!= ECONNRESET
153 && errno
!= ENOENT
&& errno
!= EACCES
)
156 if (ret
== -ECONNREFUSED
|| ret
== -ECONNRESET
)
168 closeret
= close(fd
);
177 * ustcomm_accept_unix_sock
179 * Do an accept(2) on the sock and return the
180 * new file descriptor. The socket MUST be bind(2) before.
182 int ustcomm_accept_unix_sock(int sock
)
185 struct sockaddr_un sun
;
189 new_fd
= accept(sock
, (struct sockaddr
*) &sun
, &len
);
191 if (errno
!= ECONNABORTED
)
194 if (new_fd
== -ECONNABORTED
)
201 * ustcomm_create_unix_sock
203 * Creates a AF_UNIX local socket using pathname
204 * bind the socket upon creation and return the fd.
206 int ustcomm_create_unix_sock(const char *pathname
)
208 struct sockaddr_un sun
;
211 /* Create server socket */
212 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0) {
218 memset(&sun
, 0, sizeof(sun
));
219 sun
.sun_family
= AF_UNIX
;
220 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
221 sun
.sun_path
[sizeof(sun
.sun_path
) - 1] = '\0';
223 /* Unlink the old file if present */
224 (void) unlink(pathname
);
225 ret
= bind(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
238 closeret
= close(fd
);
248 * ustcomm_listen_unix_sock
250 * Make the socket listen using LTTNG_UST_COMM_MAX_LISTEN.
252 int ustcomm_listen_unix_sock(int sock
)
256 ret
= listen(sock
, LTTNG_UST_COMM_MAX_LISTEN
);
266 * ustcomm_close_unix_sock
268 * Shutdown cleanly a unix socket.
270 * Handles fd tracker internally.
272 int ustcomm_close_unix_sock(int sock
)
276 lttng_ust_lock_fd_tracker();
279 lttng_ust_delete_fd_from_tracker(sock
);
284 lttng_ust_unlock_fd_tracker();
290 * ustcomm_recv_unix_sock
292 * Receive data of size len in put that data into
293 * the buf param. Using recvmsg API.
294 * Return the size of received data.
295 * Return 0 on orderly shutdown.
297 ssize_t
ustcomm_recv_unix_sock(int sock
, void *buf
, size_t len
)
304 memset(&msg
, 0, sizeof(msg
));
306 iov
[0].iov_base
= buf
;
307 iov
[0].iov_len
= len
;
312 len_last
= iov
[0].iov_len
;
313 ret
= recvmsg(sock
, &msg
, 0);
315 iov
[0].iov_base
+= ret
;
316 iov
[0].iov_len
-= ret
;
317 assert(ret
<= len_last
);
319 } while ((ret
> 0 && ret
< len_last
) || (ret
< 0 && errno
== EINTR
));
324 if (errno
!= EPIPE
&& errno
!= ECONNRESET
&& errno
!= ECONNREFUSED
)
327 if (ret
== -ECONNRESET
|| ret
== -ECONNREFUSED
)
330 shutret
= shutdown(sock
, SHUT_RDWR
);
332 ERR("Socket shutdown error");
333 } else if (ret
> 0) {
336 /* ret = 0 means an orderly shutdown. */
342 * ustcomm_send_unix_sock
344 * Send buf data of size len. Using sendmsg API.
345 * Return the size of sent data.
347 ssize_t
ustcomm_send_unix_sock(int sock
, const void *buf
, size_t len
)
353 memset(&msg
, 0, sizeof(msg
));
355 iov
[0].iov_base
= (void *) buf
;
356 iov
[0].iov_len
= len
;
361 * Using the MSG_NOSIGNAL when sending data from sessiond to
362 * libust, so libust does not receive an unhandled SIGPIPE or
363 * SIGURG. The sessiond receiver side can be made more resilient
364 * by ignoring SIGPIPE, but we don't have this luxury on the
368 ret
= sendmsg(sock
, &msg
, MSG_NOSIGNAL
);
369 } while (ret
< 0 && errno
== EINTR
);
374 if (errno
!= EPIPE
&& errno
!= ECONNRESET
)
377 if (ret
== -ECONNRESET
)
380 shutret
= shutdown(sock
, SHUT_RDWR
);
382 ERR("Socket shutdown error");
389 * Send a message accompanied by fd(s) over a unix socket.
391 * Returns the size of data sent, or negative error value.
393 ssize_t
ustcomm_send_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
)
396 struct cmsghdr
*cmptr
;
399 unsigned int sizeof_fds
= nb_fd
* sizeof(int);
400 char tmp
[CMSG_SPACE(sizeof_fds
)];
403 memset(&msg
, 0, sizeof(msg
));
404 memset(tmp
, 0, CMSG_SPACE(sizeof_fds
) * sizeof(char));
406 if (nb_fd
> USTCOMM_MAX_SEND_FDS
)
409 msg
.msg_control
= (caddr_t
)tmp
;
410 msg
.msg_controllen
= CMSG_LEN(sizeof_fds
);
412 cmptr
= CMSG_FIRSTHDR(&msg
);
415 cmptr
->cmsg_level
= SOL_SOCKET
;
416 cmptr
->cmsg_type
= SCM_RIGHTS
;
417 cmptr
->cmsg_len
= CMSG_LEN(sizeof_fds
);
418 memcpy(CMSG_DATA(cmptr
), fds
, sizeof_fds
);
419 /* Sum of the length of all control messages in the buffer: */
420 msg
.msg_controllen
= cmptr
->cmsg_len
;
422 iov
[0].iov_base
= &dummy
;
428 ret
= sendmsg(sock
, &msg
, MSG_NOSIGNAL
);
429 } while (ret
< 0 && errno
== EINTR
);
432 * We consider EPIPE and ECONNRESET as expected.
434 if (errno
!= EPIPE
&& errno
!= ECONNRESET
) {
438 if (ret
== -ECONNRESET
)
445 * Recv a message accompanied by fd(s) from a unix socket.
447 * Expect at most "nb_fd" file descriptors. Returns the number of fd
448 * actually received in nb_fd.
449 * Returns -EPIPE on orderly shutdown.
451 ssize_t
ustcomm_recv_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
)
455 struct cmsghdr
*cmsg
;
456 size_t sizeof_fds
= nb_fd
* sizeof(int);
457 char recv_fd
[CMSG_SPACE(sizeof_fds
)];
462 memset(&msg
, 0, sizeof(msg
));
464 /* Prepare to receive the structures */
465 iov
[0].iov_base
= &dummy
;
469 msg
.msg_control
= recv_fd
;
470 msg
.msg_controllen
= sizeof(recv_fd
);
473 ret
= recvmsg(sock
, &msg
, 0);
474 } while (ret
< 0 && errno
== EINTR
);
476 if (errno
!= EPIPE
&& errno
!= ECONNRESET
) {
477 PERROR("recvmsg fds");
480 if (ret
== -ECONNRESET
)
485 /* orderly shutdown */
490 ERR("Error: Received %zd bytes, expected %d\n",
494 if (msg
.msg_flags
& MSG_CTRUNC
) {
495 ERR("Error: Control message truncated.\n");
499 cmsg
= CMSG_FIRSTHDR(&msg
);
501 ERR("Error: Invalid control message header\n");
505 if (cmsg
->cmsg_level
!= SOL_SOCKET
|| cmsg
->cmsg_type
!= SCM_RIGHTS
) {
506 ERR("Didn't received any fd\n");
510 if (cmsg
->cmsg_len
!= CMSG_LEN(sizeof_fds
)) {
511 ERR("Error: Received %zu bytes of ancillary data, expected %zu\n",
512 (size_t) cmsg
->cmsg_len
, (size_t) CMSG_LEN(sizeof_fds
));
517 memcpy(fds
, CMSG_DATA(cmsg
), sizeof_fds
);
520 for (i
= 0; i
< nb_fd
; i
++) {
521 ret
= fcntl(fds
[i
], F_SETFD
, FD_CLOEXEC
);
523 PERROR("fcntl failed to set FD_CLOEXEC on fd %d",
533 int ustcomm_send_app_msg(int sock
, struct ustcomm_ust_msg
*lum
)
537 len
= ustcomm_send_unix_sock(sock
, lum
, sizeof(*lum
));
545 ERR("incorrect message size: %zd\n", len
);
552 int ustcomm_recv_app_reply(int sock
, struct ustcomm_ust_reply
*lur
,
553 uint32_t expected_handle
, uint32_t expected_cmd
)
557 memset(lur
, 0, sizeof(*lur
));
558 len
= ustcomm_recv_unix_sock(sock
, lur
, sizeof(*lur
));
560 case 0: /* orderly shutdown */
566 if (lur
->handle
!= expected_handle
) {
567 ERR("Unexpected result message handle: "
568 "expected: %u vs received: %u\n",
569 expected_handle
, lur
->handle
);
572 if (lur
->cmd
!= expected_cmd
) {
573 ERR("Unexpected result message command "
574 "expected: %u vs received: %u\n",
575 expected_cmd
, lur
->cmd
);
581 return lur
->ret_code
;
586 ERR("incorrect message size: %zd\n", len
);
592 int ustcomm_send_app_cmd(int sock
,
593 struct ustcomm_ust_msg
*lum
,
594 struct ustcomm_ust_reply
*lur
)
598 ret
= ustcomm_send_app_msg(sock
, lum
);
601 ret
= ustcomm_recv_app_reply(sock
, lur
, lum
->handle
, lum
->cmd
);
608 * chan_data is allocated internally if this function returns the
611 ssize_t
ustcomm_recv_channel_from_sessiond(int sock
,
612 void **_chan_data
, uint64_t var_len
,
619 if (var_len
> LTTNG_UST_CHANNEL_DATA_MAX_LEN
) {
623 /* Receive variable length data */
624 chan_data
= zmalloc(var_len
);
629 len
= ustcomm_recv_unix_sock(sock
, chan_data
, var_len
);
630 if (len
!= var_len
) {
634 lttng_ust_lock_fd_tracker();
635 nr_fd
= ustcomm_recv_fds_unix_sock(sock
, &wakeup_fd
, 1);
637 lttng_ust_unlock_fd_tracker();
647 ret
= lttng_ust_add_fd_to_tracker(wakeup_fd
);
649 ret
= close(wakeup_fd
);
651 PERROR("close on wakeup_fd");
654 lttng_ust_unlock_fd_tracker();
659 lttng_ust_unlock_fd_tracker();
661 *_chan_data
= chan_data
;
671 int ustcomm_recv_stream_from_sessiond(int sock
,
672 uint64_t *memory_map_size
,
673 int *shm_fd
, int *wakeup_fd
)
679 /* recv shm fd and wakeup fd */
680 lttng_ust_lock_fd_tracker();
681 len
= ustcomm_recv_fds_unix_sock(sock
, fds
, 2);
683 lttng_ust_unlock_fd_tracker();
693 ret
= lttng_ust_add_fd_to_tracker(fds
[0]);
697 PERROR("close on received shm_fd");
700 lttng_ust_unlock_fd_tracker();
705 ret
= lttng_ust_add_fd_to_tracker(fds
[1]);
707 ret
= close(*shm_fd
);
709 PERROR("close on shm_fd");
714 PERROR("close on received wakeup_fd");
717 lttng_ust_unlock_fd_tracker();
721 lttng_ust_unlock_fd_tracker();
729 * Returns 0 on success, negative error value on error.
731 int ustcomm_send_reg_msg(int sock
,
732 enum ustctl_socket_type type
,
733 uint32_t bits_per_long
,
734 uint32_t uint8_t_alignment
,
735 uint32_t uint16_t_alignment
,
736 uint32_t uint32_t_alignment
,
737 uint32_t uint64_t_alignment
,
738 uint32_t long_alignment
)
741 struct ustctl_reg_msg reg_msg
;
743 reg_msg
.magic
= LTTNG_UST_COMM_MAGIC
;
744 reg_msg
.major
= LTTNG_UST_ABI_MAJOR_VERSION
;
745 reg_msg
.minor
= LTTNG_UST_ABI_MINOR_VERSION
;
746 reg_msg
.pid
= getpid();
747 reg_msg
.ppid
= getppid();
748 reg_msg
.uid
= getuid();
749 reg_msg
.gid
= getgid();
750 reg_msg
.bits_per_long
= bits_per_long
;
751 reg_msg
.uint8_t_alignment
= uint8_t_alignment
;
752 reg_msg
.uint16_t_alignment
= uint16_t_alignment
;
753 reg_msg
.uint32_t_alignment
= uint32_t_alignment
;
754 reg_msg
.uint64_t_alignment
= uint64_t_alignment
;
755 reg_msg
.long_alignment
= long_alignment
;
756 reg_msg
.socket_type
= type
;
757 lttng_pthread_getname_np(reg_msg
.name
, LTTNG_UST_ABI_PROCNAME_LEN
);
758 memset(reg_msg
.padding
, 0, sizeof(reg_msg
.padding
));
760 len
= ustcomm_send_unix_sock(sock
, ®_msg
, sizeof(reg_msg
));
761 if (len
> 0 && len
!= sizeof(reg_msg
))
769 ssize_t
count_one_type(const struct lttng_type
*lt
)
780 return count_fields_recursive(lt
->u
.legacy
._struct
.nr_fields
,
781 lt
->u
.legacy
._struct
.fields
) + 1;
782 case atype_enum_nestable
:
783 return count_one_type(lt
->u
.enum_nestable
.container_type
) + 1;
784 case atype_array_nestable
:
785 return count_one_type(lt
->u
.array_nestable
.elem_type
) + 1;
786 case atype_sequence_nestable
:
787 return count_one_type(lt
->u
.sequence_nestable
.elem_type
) + 1;
788 case atype_struct_nestable
:
789 return count_fields_recursive(lt
->u
.struct_nestable
.nr_fields
,
790 lt
->u
.struct_nestable
.fields
) + 1;
794 const struct lttng_event_field
*choices
;
798 ret
= lttng_ust_dynamic_type_choices(&nr_choices
,
803 * Two fields for enum, one field for variant, and
804 * one field per choice.
806 return count_fields_recursive(nr_choices
, choices
) + 3;
816 ssize_t
count_fields_recursive(size_t nr_fields
,
817 const struct lttng_event_field
*lttng_fields
)
820 ssize_t ret
, count
= 0;
822 for (i
= 0; i
< nr_fields
; i
++) {
823 const struct lttng_event_field
*lf
;
825 lf
= <tng_fields
[i
];
826 /* skip 'nowrite' fields */
829 ret
= count_one_type(&lf
->type
);
831 return ret
; /* error */
838 ssize_t
count_ctx_fields_recursive(size_t nr_fields
,
839 const struct lttng_ctx_field
*lttng_fields
)
842 ssize_t ret
, count
= 0;
844 for (i
= 0; i
< nr_fields
; i
++) {
845 const struct lttng_event_field
*lf
;
847 lf
= <tng_fields
[i
].event_field
;
848 /* skip 'nowrite' fields */
851 ret
= count_one_type(&lf
->type
);
853 return ret
; /* error */
860 int serialize_string_encoding(int32_t *ue
,
861 enum lttng_string_encodings le
)
864 case lttng_encode_none
:
865 *ue
= ustctl_encode_none
;
867 case lttng_encode_UTF8
:
868 *ue
= ustctl_encode_UTF8
;
870 case lttng_encode_ASCII
:
871 *ue
= ustctl_encode_ASCII
;
880 int serialize_integer_type(struct ustctl_integer_type
*uit
,
881 const struct lttng_integer_type
*lit
)
885 uit
->size
= lit
->size
;
886 uit
->signedness
= lit
->signedness
;
887 uit
->reverse_byte_order
= lit
->reverse_byte_order
;
888 uit
->base
= lit
->base
;
889 if (serialize_string_encoding(&encoding
, lit
->encoding
))
891 uit
->encoding
= encoding
;
892 uit
->alignment
= lit
->alignment
;
897 int serialize_basic_type(struct lttng_session
*session
,
898 enum ustctl_abstract_types
*uatype
,
899 enum lttng_abstract_types atype
,
900 union _ustctl_basic_type
*ubt
,
901 const union _lttng_basic_type
*lbt
)
906 if (serialize_integer_type(&ubt
->integer
, &lbt
->integer
))
908 *uatype
= ustctl_atype_integer
;
915 if (serialize_string_encoding(&encoding
, lbt
->string
.encoding
))
917 ubt
->string
.encoding
= encoding
;
918 *uatype
= ustctl_atype_string
;
923 struct ustctl_float_type
*uft
;
924 const struct lttng_float_type
*lft
;
928 uft
->exp_dig
= lft
->exp_dig
;
929 uft
->mant_dig
= lft
->mant_dig
;
930 uft
->alignment
= lft
->alignment
;
931 uft
->reverse_byte_order
= lft
->reverse_byte_order
;
932 *uatype
= ustctl_atype_float
;
937 strncpy(ubt
->enumeration
.name
, lbt
->enumeration
.desc
->name
,
938 LTTNG_UST_SYM_NAME_LEN
);
939 ubt
->enumeration
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
940 if (serialize_integer_type(&ubt
->enumeration
.container_type
,
941 &lbt
->enumeration
.container_type
))
944 const struct lttng_enum
*_enum
;
946 _enum
= lttng_ust_enum_get_from_desc(session
, lbt
->enumeration
.desc
);
949 ubt
->enumeration
.id
= _enum
->id
;
951 ubt
->enumeration
.id
= -1ULL;
953 *uatype
= ustctl_atype_enum
;
957 case atype_array_nestable
:
959 case atype_sequence_nestable
:
960 case atype_enum_nestable
:
968 int serialize_dynamic_type(struct lttng_session
*session
,
969 struct ustctl_field
*fields
, size_t *iter_output
,
970 const char *field_name
)
972 const struct lttng_event_field
*choices
;
973 char tag_field_name
[LTTNG_UST_SYM_NAME_LEN
];
974 const struct lttng_type
*tag_type
;
975 const struct lttng_event_field
*tag_field_generic
;
976 struct lttng_event_field tag_field
= {
977 .name
= tag_field_name
,
980 struct ustctl_field
*uf
;
981 size_t nr_choices
, i
;
984 tag_field_generic
= lttng_ust_dynamic_type_tag_field();
985 tag_type
= &tag_field_generic
->type
;
987 /* Serialize enum field. */
988 strncpy(tag_field_name
, field_name
, LTTNG_UST_SYM_NAME_LEN
);
989 tag_field_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
990 strncat(tag_field_name
,
992 LTTNG_UST_SYM_NAME_LEN
- strlen(tag_field_name
) - 1);
993 tag_field
.type
= *tag_type
;
994 ret
= serialize_one_field(session
, fields
, iter_output
,
999 /* Serialize variant field. */
1000 uf
= &fields
[*iter_output
];
1001 ret
= lttng_ust_dynamic_type_choices(&nr_choices
, &choices
);
1005 strncpy(uf
->name
, field_name
, LTTNG_UST_SYM_NAME_LEN
);
1006 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1007 uf
->type
.atype
= ustctl_atype_variant
;
1008 uf
->type
.u
.variant_nestable
.nr_choices
= nr_choices
;
1009 strncpy(uf
->type
.u
.variant_nestable
.tag_name
,
1011 LTTNG_UST_SYM_NAME_LEN
);
1012 uf
->type
.u
.variant_nestable
.tag_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1013 uf
->type
.u
.variant_nestable
.alignment
= 0;
1016 /* Serialize choice fields after variant. */
1017 for (i
= 0; i
< nr_choices
; i
++) {
1018 ret
= serialize_one_field(session
, fields
,
1019 iter_output
, &choices
[i
]);
1027 int serialize_one_type(struct lttng_session
*session
,
1028 struct ustctl_field
*fields
, size_t *iter_output
,
1029 const char *field_name
, const struct lttng_type
*lt
)
1034 * Serializing a type (rather than a field) generates a ustctl_field
1035 * entry with 0-length name.
1038 switch (lt
->atype
) {
1044 struct ustctl_field
*uf
= &fields
[*iter_output
];
1045 struct ustctl_type
*ut
= &uf
->type
;
1046 enum ustctl_abstract_types atype
;
1049 strncpy(uf
->name
, field_name
, LTTNG_UST_SYM_NAME_LEN
);
1050 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1054 ret
= serialize_basic_type(session
, &atype
, lt
->atype
,
1055 &ut
->u
.legacy
.basic
, <
->u
.legacy
.basic
);
1064 struct ustctl_field
*uf
= &fields
[*iter_output
];
1065 struct ustctl_type
*ut
= &uf
->type
;
1066 struct ustctl_basic_type
*ubt
;
1067 const struct lttng_basic_type
*lbt
;
1068 enum ustctl_abstract_types atype
;
1071 strncpy(uf
->name
, field_name
, LTTNG_UST_SYM_NAME_LEN
);
1072 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1076 ut
->atype
= ustctl_atype_array
;
1077 ubt
= &ut
->u
.legacy
.array
.elem_type
;
1078 lbt
= <
->u
.legacy
.array
.elem_type
;
1079 ut
->u
.legacy
.array
.length
= lt
->u
.legacy
.array
.length
;
1080 ret
= serialize_basic_type(session
, &atype
, lbt
->atype
,
1081 &ubt
->u
.basic
, &lbt
->u
.basic
);
1088 case atype_array_nestable
:
1090 struct ustctl_field
*uf
= &fields
[*iter_output
];
1091 struct ustctl_type
*ut
= &uf
->type
;
1094 strncpy(uf
->name
, field_name
, LTTNG_UST_SYM_NAME_LEN
);
1095 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1099 ut
->atype
= ustctl_atype_array_nestable
;
1100 ut
->u
.array_nestable
.length
= lt
->u
.array_nestable
.length
;
1101 ut
->u
.array_nestable
.alignment
= lt
->u
.array_nestable
.alignment
;
1104 ret
= serialize_one_type(session
, fields
, iter_output
, NULL
,
1105 lt
->u
.array_nestable
.elem_type
);
1110 case atype_sequence
:
1112 struct ustctl_field
*uf
= &fields
[*iter_output
];
1113 struct ustctl_type
*ut
= &uf
->type
;
1114 struct ustctl_basic_type
*ubt
;
1115 const struct lttng_basic_type
*lbt
;
1116 enum ustctl_abstract_types atype
;
1119 strncpy(uf
->name
, field_name
, LTTNG_UST_SYM_NAME_LEN
);
1120 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1124 uf
->type
.atype
= ustctl_atype_sequence
;
1125 ubt
= &ut
->u
.legacy
.sequence
.length_type
;
1126 lbt
= <
->u
.legacy
.sequence
.length_type
;
1127 ret
= serialize_basic_type(session
, &atype
, lbt
->atype
,
1128 &ubt
->u
.basic
, &lbt
->u
.basic
);
1132 ubt
= &ut
->u
.legacy
.sequence
.elem_type
;
1133 lbt
= <
->u
.legacy
.sequence
.elem_type
;
1134 ret
= serialize_basic_type(session
, &atype
, lbt
->atype
,
1135 &ubt
->u
.basic
, &lbt
->u
.basic
);
1142 case atype_sequence_nestable
:
1144 struct ustctl_field
*uf
= &fields
[*iter_output
];
1145 struct ustctl_type
*ut
= &uf
->type
;
1148 strncpy(uf
->name
, field_name
, LTTNG_UST_SYM_NAME_LEN
);
1149 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1153 ut
->atype
= ustctl_atype_sequence_nestable
;
1154 strncpy(ut
->u
.sequence_nestable
.length_name
,
1155 lt
->u
.sequence_nestable
.length_name
,
1156 LTTNG_UST_SYM_NAME_LEN
);
1157 ut
->u
.sequence_nestable
.length_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1158 ut
->u
.sequence_nestable
.alignment
= lt
->u
.sequence_nestable
.alignment
;
1161 ret
= serialize_one_type(session
, fields
, iter_output
, NULL
,
1162 lt
->u
.sequence_nestable
.elem_type
);
1169 ret
= serialize_dynamic_type(session
, fields
, iter_output
,
1177 struct ustctl_field
*uf
= &fields
[*iter_output
];
1180 strncpy(uf
->name
, field_name
, LTTNG_UST_SYM_NAME_LEN
);
1181 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1185 uf
->type
.atype
= ustctl_atype_struct
;
1186 uf
->type
.u
.legacy
._struct
.nr_fields
= lt
->u
.legacy
._struct
.nr_fields
;
1189 ret
= serialize_fields(session
, fields
, iter_output
,
1190 lt
->u
.legacy
._struct
.nr_fields
,
1191 lt
->u
.legacy
._struct
.fields
);
1196 case atype_struct_nestable
:
1198 struct ustctl_field
*uf
= &fields
[*iter_output
];
1201 strncpy(uf
->name
, field_name
, LTTNG_UST_SYM_NAME_LEN
);
1202 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1206 uf
->type
.atype
= ustctl_atype_struct_nestable
;
1207 uf
->type
.u
.struct_nestable
.nr_fields
= lt
->u
.struct_nestable
.nr_fields
;
1208 uf
->type
.u
.struct_nestable
.alignment
= lt
->u
.struct_nestable
.alignment
;
1211 ret
= serialize_fields(session
, fields
, iter_output
,
1212 lt
->u
.struct_nestable
.nr_fields
,
1213 lt
->u
.struct_nestable
.fields
);
1218 case atype_enum_nestable
:
1220 struct ustctl_field
*uf
= &fields
[*iter_output
];
1221 struct ustctl_type
*ut
= &uf
->type
;
1224 strncpy(uf
->name
, field_name
, LTTNG_UST_SYM_NAME_LEN
);
1225 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1229 strncpy(ut
->u
.enum_nestable
.name
, lt
->u
.enum_nestable
.desc
->name
,
1230 LTTNG_UST_SYM_NAME_LEN
);
1231 ut
->u
.enum_nestable
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1232 ut
->atype
= ustctl_atype_enum_nestable
;
1235 ret
= serialize_one_type(session
, fields
, iter_output
, NULL
,
1236 lt
->u
.enum_nestable
.container_type
);
1240 const struct lttng_enum
*_enum
;
1242 _enum
= lttng_ust_enum_get_from_desc(session
, lt
->u
.enum_nestable
.desc
);
1245 ut
->u
.enum_nestable
.id
= _enum
->id
;
1247 ut
->u
.enum_nestable
.id
= -1ULL;
1258 int serialize_one_field(struct lttng_session
*session
,
1259 struct ustctl_field
*fields
, size_t *iter_output
,
1260 const struct lttng_event_field
*lf
)
1262 /* skip 'nowrite' fields */
1266 return serialize_one_type(session
, fields
, iter_output
, lf
->name
, &lf
->type
);
1270 int serialize_fields(struct lttng_session
*session
,
1271 struct ustctl_field
*ustctl_fields
,
1272 size_t *iter_output
, size_t nr_lttng_fields
,
1273 const struct lttng_event_field
*lttng_fields
)
1278 for (i
= 0; i
< nr_lttng_fields
; i
++) {
1279 ret
= serialize_one_field(session
, ustctl_fields
,
1280 iter_output
, <tng_fields
[i
]);
1288 int alloc_serialize_fields(struct lttng_session
*session
,
1289 size_t *_nr_write_fields
,
1290 struct ustctl_field
**ustctl_fields
,
1292 const struct lttng_event_field
*lttng_fields
)
1294 struct ustctl_field
*fields
;
1296 size_t iter_output
= 0;
1297 ssize_t nr_write_fields
;
1299 nr_write_fields
= count_fields_recursive(nr_fields
, lttng_fields
);
1300 if (nr_write_fields
< 0) {
1301 return (int) nr_write_fields
;
1304 fields
= zmalloc(nr_write_fields
* sizeof(*fields
));
1308 ret
= serialize_fields(session
, fields
, &iter_output
, nr_fields
,
1313 *_nr_write_fields
= nr_write_fields
;
1314 *ustctl_fields
= fields
;
1323 int serialize_entries(struct ustctl_enum_entry
**_entries
,
1325 const struct lttng_enum_entry
*lttng_entries
)
1327 struct ustctl_enum_entry
*entries
;
1330 /* Serialize the entries */
1331 entries
= zmalloc(nr_entries
* sizeof(*entries
));
1334 for (i
= 0; i
< nr_entries
; i
++) {
1335 struct ustctl_enum_entry
*uentry
;
1336 const struct lttng_enum_entry
*lentry
;
1338 uentry
= &entries
[i
];
1339 lentry
= <tng_entries
[i
];
1341 uentry
->start
.value
= lentry
->start
.value
;
1342 uentry
->start
.signedness
= lentry
->start
.signedness
;
1343 uentry
->end
.value
= lentry
->end
.value
;
1344 uentry
->end
.signedness
= lentry
->end
.signedness
;
1345 strncpy(uentry
->string
, lentry
->string
, LTTNG_UST_SYM_NAME_LEN
);
1346 uentry
->string
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1348 if (lentry
->u
.extra
.options
& LTTNG_ENUM_ENTRY_OPTION_IS_AUTO
) {
1349 uentry
->u
.extra
.options
|=
1350 USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO
;
1353 *_entries
= entries
;
1358 int serialize_ctx_fields(struct lttng_session
*session
,
1359 size_t *_nr_write_fields
,
1360 struct ustctl_field
**ustctl_fields
,
1362 const struct lttng_ctx_field
*lttng_fields
)
1364 struct ustctl_field
*fields
;
1366 size_t i
, iter_output
= 0;
1367 ssize_t nr_write_fields
;
1369 nr_write_fields
= count_ctx_fields_recursive(nr_fields
,
1371 if (nr_write_fields
< 0) {
1372 return (int) nr_write_fields
;
1375 fields
= zmalloc(nr_write_fields
* sizeof(*fields
));
1379 for (i
= 0; i
< nr_fields
; i
++) {
1380 ret
= serialize_one_field(session
, fields
, &iter_output
,
1381 <tng_fields
[i
].event_field
);
1386 *_nr_write_fields
= nr_write_fields
;
1387 *ustctl_fields
= fields
;
1396 * Returns 0 on success, negative error value on error.
1398 int ustcomm_register_event(int sock
,
1399 struct lttng_session
*session
,
1400 int session_objd
, /* session descriptor */
1401 int channel_objd
, /* channel descriptor */
1402 const char *event_name
, /* event name (input) */
1404 const char *signature
, /* event signature (input) */
1405 size_t nr_fields
, /* fields */
1406 const struct lttng_event_field
*lttng_fields
,
1407 const char *model_emf_uri
,
1408 uint32_t *id
) /* event id (output) */
1412 struct ustcomm_notify_hdr header
;
1413 struct ustcomm_notify_event_msg m
;
1416 struct ustcomm_notify_hdr header
;
1417 struct ustcomm_notify_event_reply r
;
1419 size_t signature_len
, fields_len
, model_emf_uri_len
;
1420 struct ustctl_field
*fields
= NULL
;
1421 size_t nr_write_fields
= 0;
1424 memset(&msg
, 0, sizeof(msg
));
1425 msg
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_EVENT
;
1426 msg
.m
.session_objd
= session_objd
;
1427 msg
.m
.channel_objd
= channel_objd
;
1428 strncpy(msg
.m
.event_name
, event_name
, LTTNG_UST_SYM_NAME_LEN
);
1429 msg
.m
.event_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1430 msg
.m
.loglevel
= loglevel
;
1431 signature_len
= strlen(signature
) + 1;
1432 msg
.m
.signature_len
= signature_len
;
1434 /* Calculate fields len, serialize fields. */
1435 if (nr_fields
> 0) {
1436 ret
= alloc_serialize_fields(session
, &nr_write_fields
, &fields
,
1437 nr_fields
, lttng_fields
);
1442 fields_len
= sizeof(*fields
) * nr_write_fields
;
1443 msg
.m
.fields_len
= fields_len
;
1444 if (model_emf_uri
) {
1445 model_emf_uri_len
= strlen(model_emf_uri
) + 1;
1447 model_emf_uri_len
= 0;
1449 msg
.m
.model_emf_uri_len
= model_emf_uri_len
;
1451 len
= ustcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
1452 if (len
> 0 && len
!= sizeof(msg
)) {
1461 /* send signature */
1462 len
= ustcomm_send_unix_sock(sock
, signature
, signature_len
);
1463 if (len
> 0 && len
!= signature_len
) {
1473 if (fields_len
> 0) {
1474 len
= ustcomm_send_unix_sock(sock
, fields
, fields_len
);
1475 if (len
> 0 && len
!= fields_len
) {
1486 if (model_emf_uri_len
) {
1487 /* send model_emf_uri */
1488 len
= ustcomm_send_unix_sock(sock
, model_emf_uri
,
1490 if (len
> 0 && len
!= model_emf_uri_len
) {
1499 len
= ustcomm_recv_unix_sock(sock
, &reply
, sizeof(reply
));
1501 case 0: /* orderly shutdown */
1504 if (reply
.header
.notify_cmd
!= msg
.header
.notify_cmd
) {
1505 ERR("Unexpected result message command "
1506 "expected: %u vs received: %u\n",
1507 msg
.header
.notify_cmd
, reply
.header
.notify_cmd
);
1510 if (reply
.r
.ret_code
> 0)
1512 if (reply
.r
.ret_code
< 0)
1513 return reply
.r
.ret_code
;
1514 *id
= reply
.r
.event_id
;
1515 DBG("Sent register event notification for name \"%s\": ret_code %d, event_id %u\n",
1516 event_name
, reply
.r
.ret_code
, reply
.r
.event_id
);
1520 /* Transport level error */
1521 if (errno
== EPIPE
|| errno
== ECONNRESET
)
1525 ERR("incorrect message size: %zd\n", len
);
1531 /* Error path only. */
1538 * Returns 0 on success, negative error value on error.
1539 * Returns -EPIPE or -ECONNRESET if other end has hung up.
1541 int ustcomm_register_enum(int sock
,
1542 int session_objd
, /* session descriptor */
1543 const char *enum_name
, /* enum name (input) */
1544 size_t nr_entries
, /* entries */
1545 const struct lttng_enum_entry
*lttng_entries
,
1550 struct ustcomm_notify_hdr header
;
1551 struct ustcomm_notify_enum_msg m
;
1554 struct ustcomm_notify_hdr header
;
1555 struct ustcomm_notify_enum_reply r
;
1558 struct ustctl_enum_entry
*entries
= NULL
;
1561 memset(&msg
, 0, sizeof(msg
));
1562 msg
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_ENUM
;
1563 msg
.m
.session_objd
= session_objd
;
1564 strncpy(msg
.m
.enum_name
, enum_name
, LTTNG_UST_SYM_NAME_LEN
);
1565 msg
.m
.enum_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1567 /* Calculate entries len, serialize entries. */
1568 if (nr_entries
> 0) {
1569 ret
= serialize_entries(&entries
,
1570 nr_entries
, lttng_entries
);
1575 entries_len
= sizeof(*entries
) * nr_entries
;
1576 msg
.m
.entries_len
= entries_len
;
1578 len
= ustcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
1579 if (len
> 0 && len
!= sizeof(msg
)) {
1589 if (entries_len
> 0) {
1590 len
= ustcomm_send_unix_sock(sock
, entries
, entries_len
);
1591 if (len
> 0 && len
!= entries_len
) {
1604 len
= ustcomm_recv_unix_sock(sock
, &reply
, sizeof(reply
));
1606 case 0: /* orderly shutdown */
1609 if (reply
.header
.notify_cmd
!= msg
.header
.notify_cmd
) {
1610 ERR("Unexpected result message command "
1611 "expected: %u vs received: %u\n",
1612 msg
.header
.notify_cmd
, reply
.header
.notify_cmd
);
1615 if (reply
.r
.ret_code
> 0)
1617 if (reply
.r
.ret_code
< 0)
1618 return reply
.r
.ret_code
;
1619 *id
= reply
.r
.enum_id
;
1620 DBG("Sent register enum notification for name \"%s\": ret_code %d\n",
1621 enum_name
, reply
.r
.ret_code
);
1625 /* Transport level error */
1626 if (errno
== EPIPE
|| errno
== ECONNRESET
)
1630 ERR("incorrect message size: %zd\n", len
);
1642 * Returns 0 on success, negative error value on error.
1643 * Returns -EPIPE or -ECONNRESET if other end has hung up.
1645 int ustcomm_register_channel(int sock
,
1646 struct lttng_session
*session
,
1647 int session_objd
, /* session descriptor */
1648 int channel_objd
, /* channel descriptor */
1649 size_t nr_ctx_fields
,
1650 const struct lttng_ctx_field
*ctx_fields
,
1651 uint32_t *chan_id
, /* channel id (output) */
1652 int *header_type
) /* header type (output) */
1656 struct ustcomm_notify_hdr header
;
1657 struct ustcomm_notify_channel_msg m
;
1660 struct ustcomm_notify_hdr header
;
1661 struct ustcomm_notify_channel_reply r
;
1664 struct ustctl_field
*fields
= NULL
;
1666 size_t nr_write_fields
= 0;
1668 memset(&msg
, 0, sizeof(msg
));
1669 msg
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_CHANNEL
;
1670 msg
.m
.session_objd
= session_objd
;
1671 msg
.m
.channel_objd
= channel_objd
;
1673 /* Calculate fields len, serialize fields. */
1674 if (nr_ctx_fields
> 0) {
1675 ret
= serialize_ctx_fields(session
, &nr_write_fields
, &fields
,
1676 nr_ctx_fields
, ctx_fields
);
1681 fields_len
= sizeof(*fields
) * nr_write_fields
;
1682 msg
.m
.ctx_fields_len
= fields_len
;
1683 len
= ustcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
1684 if (len
> 0 && len
!= sizeof(msg
)) {
1694 if (fields_len
> 0) {
1695 len
= ustcomm_send_unix_sock(sock
, fields
, fields_len
);
1697 if (len
> 0 && len
!= fields_len
) {
1707 len
= ustcomm_recv_unix_sock(sock
, &reply
, sizeof(reply
));
1709 case 0: /* orderly shutdown */
1712 if (reply
.header
.notify_cmd
!= msg
.header
.notify_cmd
) {
1713 ERR("Unexpected result message command "
1714 "expected: %u vs received: %u\n",
1715 msg
.header
.notify_cmd
, reply
.header
.notify_cmd
);
1718 if (reply
.r
.ret_code
> 0)
1720 if (reply
.r
.ret_code
< 0)
1721 return reply
.r
.ret_code
;
1722 *chan_id
= reply
.r
.chan_id
;
1723 switch (reply
.r
.header_type
) {
1726 *header_type
= reply
.r
.header_type
;
1729 ERR("Unexpected channel header type %u\n",
1730 reply
.r
.header_type
);
1733 DBG("Sent register channel notification: chan_id %d, header_type %d\n",
1734 reply
.r
.chan_id
, reply
.r
.header_type
);
1738 /* Transport level error */
1739 if (errno
== EPIPE
|| errno
== ECONNRESET
)
1743 ERR("incorrect message size: %zd\n", len
);
1750 * Set socket reciving timeout.
1752 int ustcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
)
1757 tv
.tv_sec
= msec
/ 1000;
1758 tv
.tv_usec
= (msec
* 1000 % 1000000);
1760 ret
= setsockopt(sock
, SOL_SOCKET
, SO_RCVTIMEO
, &tv
, sizeof(tv
));
1762 PERROR("setsockopt SO_RCVTIMEO");
1770 * Set socket sending timeout.
1772 int ustcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
)
1777 tv
.tv_sec
= msec
/ 1000;
1778 tv
.tv_usec
= (msec
* 1000) % 1000000;
1780 ret
= setsockopt(sock
, SOL_SOCKET
, SO_SNDTIMEO
, &tv
, sizeof(tv
));
1782 PERROR("setsockopt SO_SNDTIMEO");