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
);
59 * Human readable error message.
61 static const char *ustcomm_readable_code
[] = {
62 [ USTCOMM_CODE_OFFSET(LTTNG_UST_OK
) ] = "Success",
63 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR
) ] = "Unknown error",
64 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_NOENT
) ] = "No entry",
65 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_EXIST
) ] = "Object already exists",
66 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_INVAL
) ] = "Invalid argument",
67 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_PERM
) ] = "Permission denied",
68 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_NOSYS
) ] = "Not implemented",
69 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_EXITING
) ] = "Process is exiting",
71 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_INVAL_MAGIC
) ] = "Invalid magic number",
72 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_INVAL_SOCKET_TYPE
) ] = "Invalid socket type",
73 [ USTCOMM_CODE_OFFSET(LTTNG_UST_ERR_UNSUP_MAJOR
) ] = "Unsupported major version",
79 * Receives positive error value.
80 * Return ptr to string representing a human readable
81 * error code from the ustcomm_return_code enum.
83 const char *lttng_ust_strerror(int code
)
85 if (code
== LTTNG_UST_OK
)
86 return ustcomm_readable_code
[USTCOMM_CODE_OFFSET(code
)];
87 if (code
< LTTNG_UST_ERR
)
88 return strerror(code
);
89 if (code
>= LTTNG_UST_ERR_NR
)
91 return ustcomm_readable_code
[USTCOMM_CODE_OFFSET(code
)];
95 * ustcomm_connect_unix_sock
97 * Connect to unix socket using the path name.
99 * Caller handles FD tracker.
101 int ustcomm_connect_unix_sock(const char *pathname
, long timeout
)
103 struct sockaddr_un sun
;
107 * libust threads require the close-on-exec flag for all
108 * resources so it does not leak file descriptors upon exec.
109 * SOCK_CLOEXEC is not used since it is linux specific.
111 fd
= socket(PF_UNIX
, SOCK_STREAM
, 0);
118 /* Give at least 10ms. */
121 ret
= ustcomm_setsockopt_snd_timeout(fd
, timeout
);
123 WARN("Error setting connect socket send timeout");
126 ret
= fcntl(fd
, F_SETFD
, FD_CLOEXEC
);
133 memset(&sun
, 0, sizeof(sun
));
134 sun
.sun_family
= AF_UNIX
;
135 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
136 sun
.sun_path
[sizeof(sun
.sun_path
) - 1] = '\0';
138 ret
= connect(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
141 * Don't print message on connect ENOENT error, because
142 * connect is used in normal execution to detect if
143 * sessiond is alive. ENOENT is when the unix socket
144 * file does not exist, and ECONNREFUSED is when the
145 * file exists but no sessiond is listening.
147 if (errno
!= ECONNREFUSED
&& errno
!= ECONNRESET
148 && errno
!= ENOENT
&& errno
!= EACCES
)
151 if (ret
== -ECONNREFUSED
|| ret
== -ECONNRESET
)
163 closeret
= close(fd
);
172 * ustcomm_accept_unix_sock
174 * Do an accept(2) on the sock and return the
175 * new file descriptor. The socket MUST be bind(2) before.
177 int ustcomm_accept_unix_sock(int sock
)
180 struct sockaddr_un sun
;
184 new_fd
= accept(sock
, (struct sockaddr
*) &sun
, &len
);
186 if (errno
!= ECONNABORTED
)
189 if (new_fd
== -ECONNABORTED
)
196 * ustcomm_create_unix_sock
198 * Creates a AF_UNIX local socket using pathname
199 * bind the socket upon creation and return the fd.
201 int ustcomm_create_unix_sock(const char *pathname
)
203 struct sockaddr_un sun
;
206 /* Create server socket */
207 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0) {
213 memset(&sun
, 0, sizeof(sun
));
214 sun
.sun_family
= AF_UNIX
;
215 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
216 sun
.sun_path
[sizeof(sun
.sun_path
) - 1] = '\0';
218 /* Unlink the old file if present */
219 (void) unlink(pathname
);
220 ret
= bind(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
233 closeret
= close(fd
);
243 * ustcomm_listen_unix_sock
245 * Make the socket listen using LTTNG_UST_COMM_MAX_LISTEN.
247 int ustcomm_listen_unix_sock(int sock
)
251 ret
= listen(sock
, LTTNG_UST_COMM_MAX_LISTEN
);
261 * ustcomm_close_unix_sock
263 * Shutdown cleanly a unix socket.
265 * Handles fd tracker internally.
267 int ustcomm_close_unix_sock(int sock
)
271 lttng_ust_lock_fd_tracker();
274 lttng_ust_delete_fd_from_tracker(sock
);
279 lttng_ust_unlock_fd_tracker();
285 * ustcomm_recv_unix_sock
287 * Receive data of size len in put that data into
288 * the buf param. Using recvmsg API.
289 * Return the size of received data.
290 * Return 0 on orderly shutdown.
292 ssize_t
ustcomm_recv_unix_sock(int sock
, void *buf
, size_t len
)
299 memset(&msg
, 0, sizeof(msg
));
301 iov
[0].iov_base
= buf
;
302 iov
[0].iov_len
= len
;
307 len_last
= iov
[0].iov_len
;
308 ret
= recvmsg(sock
, &msg
, 0);
310 iov
[0].iov_base
+= ret
;
311 iov
[0].iov_len
-= ret
;
312 assert(ret
<= len_last
);
314 } while ((ret
> 0 && ret
< len_last
) || (ret
< 0 && errno
== EINTR
));
319 if (errno
!= EPIPE
&& errno
!= ECONNRESET
&& errno
!= ECONNREFUSED
)
322 if (ret
== -ECONNRESET
|| ret
== -ECONNREFUSED
)
325 shutret
= shutdown(sock
, SHUT_RDWR
);
327 ERR("Socket shutdown error");
328 } else if (ret
> 0) {
331 /* ret = 0 means an orderly shutdown. */
337 * ustcomm_send_unix_sock
339 * Send buf data of size len. Using sendmsg API.
340 * Return the size of sent data.
342 ssize_t
ustcomm_send_unix_sock(int sock
, const void *buf
, size_t len
)
348 memset(&msg
, 0, sizeof(msg
));
350 iov
[0].iov_base
= (void *) buf
;
351 iov
[0].iov_len
= len
;
356 * Using the MSG_NOSIGNAL when sending data from sessiond to
357 * libust, so libust does not receive an unhandled SIGPIPE or
358 * SIGURG. The sessiond receiver side can be made more resilient
359 * by ignoring SIGPIPE, but we don't have this luxury on the
363 ret
= sendmsg(sock
, &msg
, MSG_NOSIGNAL
);
364 } while (ret
< 0 && errno
== EINTR
);
369 if (errno
!= EPIPE
&& errno
!= ECONNRESET
)
372 if (ret
== -ECONNRESET
)
375 shutret
= shutdown(sock
, SHUT_RDWR
);
377 ERR("Socket shutdown error");
384 * Send a message accompanied by fd(s) over a unix socket.
386 * Returns the size of data sent, or negative error value.
388 ssize_t
ustcomm_send_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
)
391 struct cmsghdr
*cmptr
;
394 unsigned int sizeof_fds
= nb_fd
* sizeof(int);
395 char tmp
[CMSG_SPACE(sizeof_fds
)];
398 memset(&msg
, 0, sizeof(msg
));
399 memset(tmp
, 0, CMSG_SPACE(sizeof_fds
) * sizeof(char));
401 if (nb_fd
> USTCOMM_MAX_SEND_FDS
)
404 msg
.msg_control
= (caddr_t
)tmp
;
405 msg
.msg_controllen
= CMSG_LEN(sizeof_fds
);
407 cmptr
= CMSG_FIRSTHDR(&msg
);
410 cmptr
->cmsg_level
= SOL_SOCKET
;
411 cmptr
->cmsg_type
= SCM_RIGHTS
;
412 cmptr
->cmsg_len
= CMSG_LEN(sizeof_fds
);
413 memcpy(CMSG_DATA(cmptr
), fds
, sizeof_fds
);
414 /* Sum of the length of all control messages in the buffer: */
415 msg
.msg_controllen
= cmptr
->cmsg_len
;
417 iov
[0].iov_base
= &dummy
;
423 ret
= sendmsg(sock
, &msg
, MSG_NOSIGNAL
);
424 } while (ret
< 0 && errno
== EINTR
);
427 * We consider EPIPE and ECONNRESET as expected.
429 if (errno
!= EPIPE
&& errno
!= ECONNRESET
) {
433 if (ret
== -ECONNRESET
)
440 * Recv a message accompanied by fd(s) from a unix socket.
442 * Expect at most "nb_fd" file descriptors. Returns the number of fd
443 * actually received in nb_fd.
444 * Returns -EPIPE on orderly shutdown.
446 ssize_t
ustcomm_recv_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
)
450 struct cmsghdr
*cmsg
;
451 size_t sizeof_fds
= nb_fd
* sizeof(int);
452 char recv_fd
[CMSG_SPACE(sizeof_fds
)];
457 memset(&msg
, 0, sizeof(msg
));
459 /* Prepare to receive the structures */
460 iov
[0].iov_base
= &dummy
;
464 msg
.msg_control
= recv_fd
;
465 msg
.msg_controllen
= sizeof(recv_fd
);
468 ret
= recvmsg(sock
, &msg
, 0);
469 } while (ret
< 0 && errno
== EINTR
);
471 if (errno
!= EPIPE
&& errno
!= ECONNRESET
) {
472 PERROR("recvmsg fds");
475 if (ret
== -ECONNRESET
)
480 /* orderly shutdown */
485 ERR("Error: Received %zd bytes, expected %d\n",
489 if (msg
.msg_flags
& MSG_CTRUNC
) {
490 ERR("Error: Control message truncated.\n");
494 cmsg
= CMSG_FIRSTHDR(&msg
);
496 ERR("Error: Invalid control message header\n");
500 if (cmsg
->cmsg_level
!= SOL_SOCKET
|| cmsg
->cmsg_type
!= SCM_RIGHTS
) {
501 ERR("Didn't received any fd\n");
505 if (cmsg
->cmsg_len
!= CMSG_LEN(sizeof_fds
)) {
506 ERR("Error: Received %zu bytes of ancillary data, expected %zu\n",
507 (size_t) cmsg
->cmsg_len
, (size_t) CMSG_LEN(sizeof_fds
));
512 memcpy(fds
, CMSG_DATA(cmsg
), sizeof_fds
);
515 for (i
= 0; i
< nb_fd
; i
++) {
516 ret
= fcntl(fds
[i
], F_SETFD
, FD_CLOEXEC
);
518 PERROR("fcntl failed to set FD_CLOEXEC on fd %d",
528 int ustcomm_send_app_msg(int sock
, struct ustcomm_ust_msg
*lum
)
532 len
= ustcomm_send_unix_sock(sock
, lum
, sizeof(*lum
));
540 ERR("incorrect message size: %zd\n", len
);
547 int ustcomm_recv_app_reply(int sock
, struct ustcomm_ust_reply
*lur
,
548 uint32_t expected_handle
, uint32_t expected_cmd
)
552 memset(lur
, 0, sizeof(*lur
));
553 len
= ustcomm_recv_unix_sock(sock
, lur
, sizeof(*lur
));
555 case 0: /* orderly shutdown */
561 if (lur
->handle
!= expected_handle
) {
562 ERR("Unexpected result message handle: "
563 "expected: %u vs received: %u\n",
564 expected_handle
, lur
->handle
);
567 if (lur
->cmd
!= expected_cmd
) {
568 ERR("Unexpected result message command "
569 "expected: %u vs received: %u\n",
570 expected_cmd
, lur
->cmd
);
576 return lur
->ret_code
;
581 ERR("incorrect message size: %zd\n", len
);
587 int ustcomm_send_app_cmd(int sock
,
588 struct ustcomm_ust_msg
*lum
,
589 struct ustcomm_ust_reply
*lur
)
593 ret
= ustcomm_send_app_msg(sock
, lum
);
596 ret
= ustcomm_recv_app_reply(sock
, lur
, lum
->handle
, lum
->cmd
);
603 * chan_data is allocated internally if this function returns the
606 ssize_t
ustcomm_recv_channel_from_sessiond(int sock
,
607 void **_chan_data
, uint64_t var_len
,
614 if (var_len
> LTTNG_UST_CHANNEL_DATA_MAX_LEN
) {
618 /* Receive variable length data */
619 chan_data
= zmalloc(var_len
);
624 len
= ustcomm_recv_unix_sock(sock
, chan_data
, var_len
);
625 if (len
!= var_len
) {
629 lttng_ust_lock_fd_tracker();
630 nr_fd
= ustcomm_recv_fds_unix_sock(sock
, &wakeup_fd
, 1);
632 lttng_ust_unlock_fd_tracker();
642 ret
= lttng_ust_add_fd_to_tracker(wakeup_fd
);
644 lttng_ust_unlock_fd_tracker();
645 ret
= close(wakeup_fd
);
647 PERROR("close on wakeup_fd");
654 lttng_ust_unlock_fd_tracker();
656 *_chan_data
= chan_data
;
666 int ustcomm_recv_stream_from_sessiond(int sock
,
667 uint64_t *memory_map_size
,
668 int *shm_fd
, int *wakeup_fd
)
674 /* recv shm fd and wakeup fd */
675 lttng_ust_lock_fd_tracker();
676 len
= ustcomm_recv_fds_unix_sock(sock
, fds
, 2);
678 lttng_ust_unlock_fd_tracker();
688 ret
= lttng_ust_add_fd_to_tracker(fds
[0]);
690 lttng_ust_unlock_fd_tracker();
693 PERROR("close on received shm_fd");
700 ret
= lttng_ust_add_fd_to_tracker(fds
[1]);
702 lttng_ust_unlock_fd_tracker();
703 ret
= close(*shm_fd
);
705 PERROR("close on shm_fd");
710 PERROR("close on received wakeup_fd");
716 lttng_ust_unlock_fd_tracker();
724 * Returns 0 on success, negative error value on error.
726 int ustcomm_send_reg_msg(int sock
,
727 enum ustctl_socket_type type
,
728 uint32_t bits_per_long
,
729 uint32_t uint8_t_alignment
,
730 uint32_t uint16_t_alignment
,
731 uint32_t uint32_t_alignment
,
732 uint32_t uint64_t_alignment
,
733 uint32_t long_alignment
)
736 struct ustctl_reg_msg reg_msg
;
738 reg_msg
.magic
= LTTNG_UST_COMM_MAGIC
;
739 reg_msg
.major
= LTTNG_UST_ABI_MAJOR_VERSION
;
740 reg_msg
.minor
= LTTNG_UST_ABI_MINOR_VERSION
;
741 reg_msg
.pid
= getpid();
742 reg_msg
.ppid
= getppid();
743 reg_msg
.uid
= getuid();
744 reg_msg
.gid
= getgid();
745 reg_msg
.bits_per_long
= bits_per_long
;
746 reg_msg
.uint8_t_alignment
= uint8_t_alignment
;
747 reg_msg
.uint16_t_alignment
= uint16_t_alignment
;
748 reg_msg
.uint32_t_alignment
= uint32_t_alignment
;
749 reg_msg
.uint64_t_alignment
= uint64_t_alignment
;
750 reg_msg
.long_alignment
= long_alignment
;
751 reg_msg
.socket_type
= type
;
752 lttng_ust_getprocname(reg_msg
.name
);
753 memset(reg_msg
.padding
, 0, sizeof(reg_msg
.padding
));
755 len
= ustcomm_send_unix_sock(sock
, ®_msg
, sizeof(reg_msg
));
756 if (len
> 0 && len
!= sizeof(reg_msg
))
764 ssize_t
count_one_type(const struct lttng_type
*lt
)
775 //TODO: implement non-empty struct.
779 const struct lttng_event_field
*choices
;
783 ret
= lttng_ust_dynamic_type_choices(&nr_choices
,
788 * One field for enum, one field for variant, and
789 * one field per choice.
791 return count_fields_recursive(nr_choices
, choices
) + 2;
800 ssize_t
count_fields_recursive(size_t nr_fields
,
801 const struct lttng_event_field
*lttng_fields
)
804 ssize_t ret
, count
= 0;
806 for (i
= 0; i
< nr_fields
; i
++) {
807 const struct lttng_event_field
*lf
;
809 lf
= <tng_fields
[i
];
810 /* skip 'nowrite' fields */
813 ret
= count_one_type(&lf
->type
);
815 return ret
; /* error */
822 ssize_t
count_ctx_fields_recursive(size_t nr_fields
,
823 const struct lttng_ctx_field
*lttng_fields
)
826 ssize_t ret
, count
= 0;
828 for (i
= 0; i
< nr_fields
; i
++) {
829 const struct lttng_event_field
*lf
;
831 lf
= <tng_fields
[i
].event_field
;
832 /* skip 'nowrite' fields */
835 ret
= count_one_type(&lf
->type
);
837 return ret
; /* error */
844 int serialize_string_encoding(int32_t *ue
,
845 enum lttng_string_encodings le
)
848 case lttng_encode_none
:
849 *ue
= ustctl_encode_none
;
851 case lttng_encode_UTF8
:
852 *ue
= ustctl_encode_UTF8
;
854 case lttng_encode_ASCII
:
855 *ue
= ustctl_encode_ASCII
;
864 int serialize_integer_type(struct ustctl_integer_type
*uit
,
865 const struct lttng_integer_type
*lit
)
869 uit
->size
= lit
->size
;
870 uit
->signedness
= lit
->signedness
;
871 uit
->reverse_byte_order
= lit
->reverse_byte_order
;
872 uit
->base
= lit
->base
;
873 if (serialize_string_encoding(&encoding
, lit
->encoding
))
875 uit
->encoding
= encoding
;
876 uit
->alignment
= lit
->alignment
;
881 int serialize_basic_type(struct lttng_session
*session
,
882 enum ustctl_abstract_types
*uatype
,
883 enum lttng_abstract_types atype
,
884 union _ustctl_basic_type
*ubt
,
885 const union _lttng_basic_type
*lbt
)
890 if (serialize_integer_type(&ubt
->integer
, &lbt
->integer
))
892 *uatype
= ustctl_atype_integer
;
899 if (serialize_string_encoding(&encoding
, lbt
->string
.encoding
))
901 ubt
->string
.encoding
= encoding
;
902 *uatype
= ustctl_atype_string
;
907 struct ustctl_float_type
*uft
;
908 const struct lttng_float_type
*lft
;
912 uft
->exp_dig
= lft
->exp_dig
;
913 uft
->mant_dig
= lft
->mant_dig
;
914 uft
->alignment
= lft
->alignment
;
915 uft
->reverse_byte_order
= lft
->reverse_byte_order
;
916 *uatype
= ustctl_atype_float
;
921 strncpy(ubt
->enumeration
.name
, lbt
->enumeration
.desc
->name
,
922 LTTNG_UST_SYM_NAME_LEN
);
923 ubt
->enumeration
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
924 if (serialize_integer_type(&ubt
->enumeration
.container_type
,
925 &lbt
->enumeration
.container_type
))
928 const struct lttng_enum
*_enum
;
930 _enum
= lttng_ust_enum_get_from_desc(session
, lbt
->enumeration
.desc
);
933 ubt
->enumeration
.id
= _enum
->id
;
935 ubt
->enumeration
.id
= -1ULL;
937 *uatype
= ustctl_atype_enum
;
949 int serialize_dynamic_type(struct lttng_session
*session
,
950 struct ustctl_field
*fields
, size_t *iter_output
,
951 const struct lttng_event_field
*lf
)
953 const struct lttng_event_field
*choices
;
954 char tag_field_name
[LTTNG_UST_SYM_NAME_LEN
];
955 const struct lttng_type
*tag_type
;
956 const struct lttng_event_field
*tag_field_generic
;
957 struct lttng_event_field tag_field
= {
958 .name
= tag_field_name
,
961 struct ustctl_field
*uf
;
962 size_t nr_choices
, i
;
965 tag_field_generic
= lttng_ust_dynamic_type_tag_field();
966 tag_type
= &tag_field_generic
->type
;
968 /* Serialize enum field. */
969 strncpy(tag_field_name
, lf
->name
, LTTNG_UST_SYM_NAME_LEN
);
970 tag_field_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
971 strncat(tag_field_name
,
973 LTTNG_UST_SYM_NAME_LEN
- strlen(tag_field_name
) - 1);
974 tag_field
.type
= *tag_type
;
975 ret
= serialize_one_field(session
, fields
, iter_output
,
980 /* Serialize variant field. */
981 uf
= &fields
[*iter_output
];
982 ret
= lttng_ust_dynamic_type_choices(&nr_choices
, &choices
);
986 strncpy(uf
->name
, lf
->name
, LTTNG_UST_SYM_NAME_LEN
);
987 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
988 uf
->type
.atype
= ustctl_atype_variant
;
989 uf
->type
.u
.variant
.nr_choices
= nr_choices
;
990 strncpy(uf
->type
.u
.variant
.tag_name
,
992 LTTNG_UST_SYM_NAME_LEN
);
993 uf
->type
.u
.variant
.tag_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
996 /* Serialize choice fields after variant. */
997 for (i
= 0; i
< nr_choices
; i
++) {
998 ret
= serialize_one_field(session
, fields
,
999 iter_output
, &choices
[i
]);
1007 int serialize_one_field(struct lttng_session
*session
,
1008 struct ustctl_field
*fields
, size_t *iter_output
,
1009 const struct lttng_event_field
*lf
)
1011 const struct lttng_type
*lt
= &lf
->type
;
1014 /* skip 'nowrite' fields */
1018 switch (lt
->atype
) {
1024 struct ustctl_field
*uf
= &fields
[*iter_output
];
1025 struct ustctl_type
*ut
= &uf
->type
;
1026 enum ustctl_abstract_types atype
;
1028 strncpy(uf
->name
, lf
->name
, LTTNG_UST_SYM_NAME_LEN
);
1029 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1030 ret
= serialize_basic_type(session
, &atype
, lt
->atype
,
1031 &ut
->u
.basic
, <
->u
.basic
);
1040 struct ustctl_field
*uf
= &fields
[*iter_output
];
1041 struct ustctl_type
*ut
= &uf
->type
;
1042 struct ustctl_basic_type
*ubt
;
1043 const struct lttng_basic_type
*lbt
;
1044 enum ustctl_abstract_types atype
;
1046 strncpy(uf
->name
, lf
->name
, LTTNG_UST_SYM_NAME_LEN
);
1047 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1048 uf
->type
.atype
= ustctl_atype_array
;
1049 ubt
= &ut
->u
.array
.elem_type
;
1050 lbt
= <
->u
.array
.elem_type
;
1051 ut
->u
.array
.length
= lt
->u
.array
.length
;
1052 ret
= serialize_basic_type(session
, &atype
, lbt
->atype
,
1053 &ubt
->u
.basic
, &lbt
->u
.basic
);
1057 ut
->atype
= ustctl_atype_array
;
1061 case atype_sequence
:
1063 struct ustctl_field
*uf
= &fields
[*iter_output
];
1064 struct ustctl_type
*ut
= &uf
->type
;
1065 struct ustctl_basic_type
*ubt
;
1066 const struct lttng_basic_type
*lbt
;
1067 enum ustctl_abstract_types atype
;
1070 strncpy(uf
->name
, lf
->name
, LTTNG_UST_SYM_NAME_LEN
);
1071 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1072 uf
->type
.atype
= ustctl_atype_sequence
;
1073 ubt
= &ut
->u
.sequence
.length_type
;
1074 lbt
= <
->u
.sequence
.length_type
;
1075 ret
= serialize_basic_type(session
, &atype
, lbt
->atype
,
1076 &ubt
->u
.basic
, &lbt
->u
.basic
);
1080 ubt
= &ut
->u
.sequence
.elem_type
;
1081 lbt
= <
->u
.sequence
.elem_type
;
1082 ret
= serialize_basic_type(session
, &atype
, lbt
->atype
,
1083 &ubt
->u
.basic
, &lbt
->u
.basic
);
1087 ut
->atype
= ustctl_atype_sequence
;
1093 ret
= serialize_dynamic_type(session
, fields
, iter_output
, lf
);
1100 struct ustctl_field
*uf
= &fields
[*iter_output
];
1103 * TODO: add support for non-empty struct.
1105 if (lf
->type
.u
._struct
.nr_fields
!= 0) {
1108 strncpy(uf
->name
, lf
->name
, LTTNG_UST_SYM_NAME_LEN
);
1109 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1110 uf
->type
.atype
= ustctl_atype_struct
;
1111 uf
->type
.u
._struct
.nr_fields
= 0;
1122 int serialize_fields(struct lttng_session
*session
,
1123 size_t *_nr_write_fields
,
1124 struct ustctl_field
**ustctl_fields
,
1126 const struct lttng_event_field
*lttng_fields
)
1128 struct ustctl_field
*fields
;
1130 size_t i
, iter_output
= 0;
1131 ssize_t nr_write_fields
;
1133 nr_write_fields
= count_fields_recursive(nr_fields
, lttng_fields
);
1134 if (nr_write_fields
< 0) {
1135 return (int) nr_write_fields
;
1138 fields
= zmalloc(nr_write_fields
* sizeof(*fields
));
1142 for (i
= 0; i
< nr_fields
; i
++) {
1143 ret
= serialize_one_field(session
, fields
, &iter_output
,
1149 *_nr_write_fields
= nr_write_fields
;
1150 *ustctl_fields
= fields
;
1159 int serialize_entries(struct ustctl_enum_entry
**_entries
,
1161 const struct lttng_enum_entry
*lttng_entries
)
1163 struct ustctl_enum_entry
*entries
;
1166 /* Serialize the entries */
1167 entries
= zmalloc(nr_entries
* sizeof(*entries
));
1170 for (i
= 0; i
< nr_entries
; i
++) {
1171 struct ustctl_enum_entry
*uentry
;
1172 const struct lttng_enum_entry
*lentry
;
1174 uentry
= &entries
[i
];
1175 lentry
= <tng_entries
[i
];
1177 uentry
->start
.value
= lentry
->start
.value
;
1178 uentry
->start
.signedness
= lentry
->start
.signedness
;
1179 uentry
->end
.value
= lentry
->end
.value
;
1180 uentry
->end
.signedness
= lentry
->end
.signedness
;
1181 strncpy(uentry
->string
, lentry
->string
, LTTNG_UST_SYM_NAME_LEN
);
1182 uentry
->string
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1184 if (lentry
->u
.extra
.options
& LTTNG_ENUM_ENTRY_OPTION_IS_AUTO
) {
1185 uentry
->u
.extra
.options
|=
1186 USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO
;
1189 *_entries
= entries
;
1194 int serialize_ctx_fields(struct lttng_session
*session
,
1195 size_t *_nr_write_fields
,
1196 struct ustctl_field
**ustctl_fields
,
1198 const struct lttng_ctx_field
*lttng_fields
)
1200 struct ustctl_field
*fields
;
1202 size_t i
, iter_output
= 0;
1203 ssize_t nr_write_fields
;
1205 nr_write_fields
= count_ctx_fields_recursive(nr_fields
,
1207 if (nr_write_fields
< 0) {
1208 return (int) nr_write_fields
;
1211 fields
= zmalloc(nr_write_fields
* sizeof(*fields
));
1215 for (i
= 0; i
< nr_fields
; i
++) {
1216 ret
= serialize_one_field(session
, fields
, &iter_output
,
1217 <tng_fields
[i
].event_field
);
1222 *_nr_write_fields
= nr_write_fields
;
1223 *ustctl_fields
= fields
;
1232 * Returns 0 on success, negative error value on error.
1234 int ustcomm_register_event(int sock
,
1235 struct lttng_session
*session
,
1236 int session_objd
, /* session descriptor */
1237 int channel_objd
, /* channel descriptor */
1238 const char *event_name
, /* event name (input) */
1240 const char *signature
, /* event signature (input) */
1241 size_t nr_fields
, /* fields */
1242 const struct lttng_event_field
*lttng_fields
,
1243 const char *model_emf_uri
,
1244 uint32_t *id
) /* event id (output) */
1248 struct ustcomm_notify_hdr header
;
1249 struct ustcomm_notify_event_msg m
;
1252 struct ustcomm_notify_hdr header
;
1253 struct ustcomm_notify_event_reply r
;
1255 size_t signature_len
, fields_len
, model_emf_uri_len
;
1256 struct ustctl_field
*fields
= NULL
;
1257 size_t nr_write_fields
= 0;
1260 memset(&msg
, 0, sizeof(msg
));
1261 msg
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_EVENT
;
1262 msg
.m
.session_objd
= session_objd
;
1263 msg
.m
.channel_objd
= channel_objd
;
1264 strncpy(msg
.m
.event_name
, event_name
, LTTNG_UST_SYM_NAME_LEN
);
1265 msg
.m
.event_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1266 msg
.m
.loglevel
= loglevel
;
1267 signature_len
= strlen(signature
) + 1;
1268 msg
.m
.signature_len
= signature_len
;
1270 /* Calculate fields len, serialize fields. */
1271 if (nr_fields
> 0) {
1272 ret
= serialize_fields(session
, &nr_write_fields
, &fields
,
1273 nr_fields
, lttng_fields
);
1278 fields_len
= sizeof(*fields
) * nr_write_fields
;
1279 msg
.m
.fields_len
= fields_len
;
1280 if (model_emf_uri
) {
1281 model_emf_uri_len
= strlen(model_emf_uri
) + 1;
1283 model_emf_uri_len
= 0;
1285 msg
.m
.model_emf_uri_len
= model_emf_uri_len
;
1287 len
= ustcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
1288 if (len
> 0 && len
!= sizeof(msg
)) {
1297 /* send signature */
1298 len
= ustcomm_send_unix_sock(sock
, signature
, signature_len
);
1299 if (len
> 0 && len
!= signature_len
) {
1309 if (fields_len
> 0) {
1310 len
= ustcomm_send_unix_sock(sock
, fields
, fields_len
);
1311 if (len
> 0 && len
!= fields_len
) {
1322 if (model_emf_uri_len
) {
1323 /* send model_emf_uri */
1324 len
= ustcomm_send_unix_sock(sock
, model_emf_uri
,
1326 if (len
> 0 && len
!= model_emf_uri_len
) {
1335 len
= ustcomm_recv_unix_sock(sock
, &reply
, sizeof(reply
));
1337 case 0: /* orderly shutdown */
1340 if (reply
.header
.notify_cmd
!= msg
.header
.notify_cmd
) {
1341 ERR("Unexpected result message command "
1342 "expected: %u vs received: %u\n",
1343 msg
.header
.notify_cmd
, reply
.header
.notify_cmd
);
1346 if (reply
.r
.ret_code
> 0)
1348 if (reply
.r
.ret_code
< 0)
1349 return reply
.r
.ret_code
;
1350 *id
= reply
.r
.event_id
;
1351 DBG("Sent register event notification for name \"%s\": ret_code %d, event_id %u\n",
1352 event_name
, reply
.r
.ret_code
, reply
.r
.event_id
);
1356 /* Transport level error */
1357 if (errno
== EPIPE
|| errno
== ECONNRESET
)
1361 ERR("incorrect message size: %zd\n", len
);
1367 /* Error path only. */
1374 * Returns 0 on success, negative error value on error.
1375 * Returns -EPIPE or -ECONNRESET if other end has hung up.
1377 int ustcomm_register_enum(int sock
,
1378 int session_objd
, /* session descriptor */
1379 const char *enum_name
, /* enum name (input) */
1380 size_t nr_entries
, /* entries */
1381 const struct lttng_enum_entry
*lttng_entries
,
1386 struct ustcomm_notify_hdr header
;
1387 struct ustcomm_notify_enum_msg m
;
1390 struct ustcomm_notify_hdr header
;
1391 struct ustcomm_notify_enum_reply r
;
1394 struct ustctl_enum_entry
*entries
= NULL
;
1397 memset(&msg
, 0, sizeof(msg
));
1398 msg
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_ENUM
;
1399 msg
.m
.session_objd
= session_objd
;
1400 strncpy(msg
.m
.enum_name
, enum_name
, LTTNG_UST_SYM_NAME_LEN
);
1401 msg
.m
.enum_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1403 /* Calculate entries len, serialize entries. */
1404 if (nr_entries
> 0) {
1405 ret
= serialize_entries(&entries
,
1406 nr_entries
, lttng_entries
);
1411 entries_len
= sizeof(*entries
) * nr_entries
;
1412 msg
.m
.entries_len
= entries_len
;
1414 len
= ustcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
1415 if (len
> 0 && len
!= sizeof(msg
)) {
1425 if (entries_len
> 0) {
1426 len
= ustcomm_send_unix_sock(sock
, entries
, entries_len
);
1427 if (len
> 0 && len
!= entries_len
) {
1440 len
= ustcomm_recv_unix_sock(sock
, &reply
, sizeof(reply
));
1442 case 0: /* orderly shutdown */
1445 if (reply
.header
.notify_cmd
!= msg
.header
.notify_cmd
) {
1446 ERR("Unexpected result message command "
1447 "expected: %u vs received: %u\n",
1448 msg
.header
.notify_cmd
, reply
.header
.notify_cmd
);
1451 if (reply
.r
.ret_code
> 0)
1453 if (reply
.r
.ret_code
< 0)
1454 return reply
.r
.ret_code
;
1455 *id
= reply
.r
.enum_id
;
1456 DBG("Sent register enum notification for name \"%s\": ret_code %d\n",
1457 enum_name
, reply
.r
.ret_code
);
1461 /* Transport level error */
1462 if (errno
== EPIPE
|| errno
== ECONNRESET
)
1466 ERR("incorrect message size: %zd\n", len
);
1478 * Returns 0 on success, negative error value on error.
1479 * Returns -EPIPE or -ECONNRESET if other end has hung up.
1481 int ustcomm_register_channel(int sock
,
1482 struct lttng_session
*session
,
1483 int session_objd
, /* session descriptor */
1484 int channel_objd
, /* channel descriptor */
1485 size_t nr_ctx_fields
,
1486 const struct lttng_ctx_field
*ctx_fields
,
1487 uint32_t *chan_id
, /* channel id (output) */
1488 int *header_type
) /* header type (output) */
1492 struct ustcomm_notify_hdr header
;
1493 struct ustcomm_notify_channel_msg m
;
1496 struct ustcomm_notify_hdr header
;
1497 struct ustcomm_notify_channel_reply r
;
1500 struct ustctl_field
*fields
= NULL
;
1502 size_t nr_write_fields
= 0;
1504 memset(&msg
, 0, sizeof(msg
));
1505 msg
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_CHANNEL
;
1506 msg
.m
.session_objd
= session_objd
;
1507 msg
.m
.channel_objd
= channel_objd
;
1509 /* Calculate fields len, serialize fields. */
1510 if (nr_ctx_fields
> 0) {
1511 ret
= serialize_ctx_fields(session
, &nr_write_fields
, &fields
,
1512 nr_ctx_fields
, ctx_fields
);
1517 fields_len
= sizeof(*fields
) * nr_write_fields
;
1518 msg
.m
.ctx_fields_len
= fields_len
;
1519 len
= ustcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
1520 if (len
> 0 && len
!= sizeof(msg
)) {
1530 if (fields_len
> 0) {
1531 len
= ustcomm_send_unix_sock(sock
, fields
, fields_len
);
1533 if (len
> 0 && len
!= fields_len
) {
1543 len
= ustcomm_recv_unix_sock(sock
, &reply
, sizeof(reply
));
1545 case 0: /* orderly shutdown */
1548 if (reply
.header
.notify_cmd
!= msg
.header
.notify_cmd
) {
1549 ERR("Unexpected result message command "
1550 "expected: %u vs received: %u\n",
1551 msg
.header
.notify_cmd
, reply
.header
.notify_cmd
);
1554 if (reply
.r
.ret_code
> 0)
1556 if (reply
.r
.ret_code
< 0)
1557 return reply
.r
.ret_code
;
1558 *chan_id
= reply
.r
.chan_id
;
1559 switch (reply
.r
.header_type
) {
1562 *header_type
= reply
.r
.header_type
;
1565 ERR("Unexpected channel header type %u\n",
1566 reply
.r
.header_type
);
1569 DBG("Sent register channel notification: chan_id %d, header_type %d\n",
1570 reply
.r
.chan_id
, reply
.r
.header_type
);
1574 /* Transport level error */
1575 if (errno
== EPIPE
|| errno
== ECONNRESET
)
1579 ERR("incorrect message size: %zd\n", len
);
1586 * Set socket reciving timeout.
1588 int ustcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
)
1593 tv
.tv_sec
= msec
/ 1000;
1594 tv
.tv_usec
= (msec
* 1000 % 1000000);
1596 ret
= setsockopt(sock
, SOL_SOCKET
, SO_RCVTIMEO
, &tv
, sizeof(tv
));
1598 PERROR("setsockopt SO_RCVTIMEO");
1606 * Set socket sending timeout.
1608 int ustcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
)
1613 tv
.tv_sec
= msec
/ 1000;
1614 tv
.tv_usec
= (msec
* 1000) % 1000000;
1616 ret
= setsockopt(sock
, SOL_SOCKET
, SO_SNDTIMEO
, &tv
, sizeof(tv
));
1618 PERROR("setsockopt SO_SNDTIMEO");