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.
110 fd
= socket(PF_UNIX
, SOCK_STREAM
, 0);
117 /* Give at least 10ms. */
120 ret
= ustcomm_setsockopt_snd_timeout(fd
, timeout
);
122 WARN("Error setting connect socket send timeout");
125 ret
= fcntl(fd
, F_SETFD
, FD_CLOEXEC
);
132 memset(&sun
, 0, sizeof(sun
));
133 sun
.sun_family
= AF_UNIX
;
134 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
135 sun
.sun_path
[sizeof(sun
.sun_path
) - 1] = '\0';
137 ret
= connect(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
140 * Don't print message on connect ENOENT error, because
141 * connect is used in normal execution to detect if
142 * sessiond is alive. ENOENT is when the unix socket
143 * file does not exist, and ECONNREFUSED is when the
144 * file exists but no sessiond is listening.
146 if (errno
!= ECONNREFUSED
&& errno
!= ECONNRESET
147 && errno
!= ENOENT
&& errno
!= EACCES
)
150 if (ret
== -ECONNREFUSED
|| ret
== -ECONNRESET
)
162 closeret
= close(fd
);
171 * ustcomm_accept_unix_sock
173 * Do an accept(2) on the sock and return the
174 * new file descriptor. The socket MUST be bind(2) before.
176 int ustcomm_accept_unix_sock(int sock
)
179 struct sockaddr_un sun
;
183 new_fd
= accept(sock
, (struct sockaddr
*) &sun
, &len
);
185 if (errno
!= ECONNABORTED
)
188 if (new_fd
== -ECONNABORTED
)
195 * ustcomm_create_unix_sock
197 * Creates a AF_UNIX local socket using pathname
198 * bind the socket upon creation and return the fd.
200 int ustcomm_create_unix_sock(const char *pathname
)
202 struct sockaddr_un sun
;
205 /* Create server socket */
206 if ((fd
= socket(PF_UNIX
, SOCK_STREAM
, 0)) < 0) {
212 memset(&sun
, 0, sizeof(sun
));
213 sun
.sun_family
= AF_UNIX
;
214 strncpy(sun
.sun_path
, pathname
, sizeof(sun
.sun_path
));
215 sun
.sun_path
[sizeof(sun
.sun_path
) - 1] = '\0';
217 /* Unlink the old file if present */
218 (void) unlink(pathname
);
219 ret
= bind(fd
, (struct sockaddr
*) &sun
, sizeof(sun
));
232 closeret
= close(fd
);
242 * ustcomm_listen_unix_sock
244 * Make the socket listen using LTTNG_UST_COMM_MAX_LISTEN.
246 int ustcomm_listen_unix_sock(int sock
)
250 ret
= listen(sock
, LTTNG_UST_COMM_MAX_LISTEN
);
260 * ustcomm_close_unix_sock
262 * Shutdown cleanly a unix socket.
264 * Handles fd tracker internally.
266 int ustcomm_close_unix_sock(int sock
)
270 lttng_ust_lock_fd_tracker();
273 lttng_ust_delete_fd_from_tracker(sock
);
278 lttng_ust_unlock_fd_tracker();
284 * ustcomm_recv_unix_sock
286 * Receive data of size len in put that data into
287 * the buf param. Using recvmsg API.
288 * Return the size of received data.
289 * Return 0 on orderly shutdown.
291 ssize_t
ustcomm_recv_unix_sock(int sock
, void *buf
, size_t len
)
298 memset(&msg
, 0, sizeof(msg
));
300 iov
[0].iov_base
= buf
;
301 iov
[0].iov_len
= len
;
306 len_last
= iov
[0].iov_len
;
307 ret
= recvmsg(sock
, &msg
, 0);
309 iov
[0].iov_base
+= ret
;
310 iov
[0].iov_len
-= ret
;
311 assert(ret
<= len_last
);
313 } while ((ret
> 0 && ret
< len_last
) || (ret
< 0 && errno
== EINTR
));
318 if (errno
!= EPIPE
&& errno
!= ECONNRESET
&& errno
!= ECONNREFUSED
)
321 if (ret
== -ECONNRESET
|| ret
== -ECONNREFUSED
)
324 shutret
= shutdown(sock
, SHUT_RDWR
);
326 ERR("Socket shutdown error");
327 } else if (ret
> 0) {
330 /* ret = 0 means an orderly shutdown. */
336 * ustcomm_send_unix_sock
338 * Send buf data of size len. Using sendmsg API.
339 * Return the size of sent data.
341 ssize_t
ustcomm_send_unix_sock(int sock
, const void *buf
, size_t len
)
347 memset(&msg
, 0, sizeof(msg
));
349 iov
[0].iov_base
= (void *) buf
;
350 iov
[0].iov_len
= len
;
355 * Using the MSG_NOSIGNAL when sending data from sessiond to
356 * libust, so libust does not receive an unhandled SIGPIPE or
357 * SIGURG. The sessiond receiver side can be made more resilient
358 * by ignoring SIGPIPE, but we don't have this luxury on the
362 ret
= sendmsg(sock
, &msg
, MSG_NOSIGNAL
);
363 } while (ret
< 0 && errno
== EINTR
);
368 if (errno
!= EPIPE
&& errno
!= ECONNRESET
)
371 if (ret
== -ECONNRESET
)
374 shutret
= shutdown(sock
, SHUT_RDWR
);
376 ERR("Socket shutdown error");
383 * Send a message accompanied by fd(s) over a unix socket.
385 * Returns the size of data sent, or negative error value.
387 ssize_t
ustcomm_send_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
)
390 struct cmsghdr
*cmptr
;
393 unsigned int sizeof_fds
= nb_fd
* sizeof(int);
394 char tmp
[CMSG_SPACE(sizeof_fds
)];
397 memset(&msg
, 0, sizeof(msg
));
398 memset(tmp
, 0, CMSG_SPACE(sizeof_fds
) * sizeof(char));
400 if (nb_fd
> USTCOMM_MAX_SEND_FDS
)
403 msg
.msg_control
= (caddr_t
)tmp
;
404 msg
.msg_controllen
= CMSG_LEN(sizeof_fds
);
406 cmptr
= CMSG_FIRSTHDR(&msg
);
409 cmptr
->cmsg_level
= SOL_SOCKET
;
410 cmptr
->cmsg_type
= SCM_RIGHTS
;
411 cmptr
->cmsg_len
= CMSG_LEN(sizeof_fds
);
412 memcpy(CMSG_DATA(cmptr
), fds
, sizeof_fds
);
413 /* Sum of the length of all control messages in the buffer: */
414 msg
.msg_controllen
= cmptr
->cmsg_len
;
416 iov
[0].iov_base
= &dummy
;
422 ret
= sendmsg(sock
, &msg
, MSG_NOSIGNAL
);
423 } while (ret
< 0 && errno
== EINTR
);
426 * We consider EPIPE and ECONNRESET as expected.
428 if (errno
!= EPIPE
&& errno
!= ECONNRESET
) {
432 if (ret
== -ECONNRESET
)
439 * Recv a message accompanied by fd(s) from a unix socket.
441 * Returns the size of received data, or negative error value.
443 * Expect at most "nb_fd" file descriptors. Returns the number of fd
444 * actually received in nb_fd.
445 * Returns -EPIPE on orderly shutdown.
447 ssize_t
ustcomm_recv_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
)
451 struct cmsghdr
*cmsg
;
452 size_t sizeof_fds
= nb_fd
* sizeof(int);
453 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
));
511 memcpy(fds
, CMSG_DATA(cmsg
), sizeof_fds
);
517 int ustcomm_send_app_msg(int sock
, struct ustcomm_ust_msg
*lum
)
521 len
= ustcomm_send_unix_sock(sock
, lum
, sizeof(*lum
));
529 ERR("incorrect message size: %zd\n", len
);
536 int ustcomm_recv_app_reply(int sock
, struct ustcomm_ust_reply
*lur
,
537 uint32_t expected_handle
, uint32_t expected_cmd
)
541 memset(lur
, 0, sizeof(*lur
));
542 len
= ustcomm_recv_unix_sock(sock
, lur
, sizeof(*lur
));
544 case 0: /* orderly shutdown */
550 if (lur
->handle
!= expected_handle
) {
551 ERR("Unexpected result message handle: "
552 "expected: %u vs received: %u\n",
553 expected_handle
, lur
->handle
);
556 if (lur
->cmd
!= expected_cmd
) {
557 ERR("Unexpected result message command "
558 "expected: %u vs received: %u\n",
559 expected_cmd
, lur
->cmd
);
565 return lur
->ret_code
;
570 ERR("incorrect message size: %zd\n", len
);
576 int ustcomm_send_app_cmd(int sock
,
577 struct ustcomm_ust_msg
*lum
,
578 struct ustcomm_ust_reply
*lur
)
582 ret
= ustcomm_send_app_msg(sock
, lum
);
585 ret
= ustcomm_recv_app_reply(sock
, lur
, lum
->handle
, lum
->cmd
);
592 * chan_data is allocated internally if this function returns the
595 ssize_t
ustcomm_recv_channel_from_sessiond(int sock
,
596 void **_chan_data
, uint64_t var_len
,
603 if (var_len
> LTTNG_UST_CHANNEL_DATA_MAX_LEN
) {
607 /* Receive variable length data */
608 chan_data
= zmalloc(var_len
);
613 len
= ustcomm_recv_unix_sock(sock
, chan_data
, var_len
);
614 if (len
!= var_len
) {
618 lttng_ust_lock_fd_tracker();
619 nr_fd
= ustcomm_recv_fds_unix_sock(sock
, &wakeup_fd
, 1);
621 lttng_ust_unlock_fd_tracker();
631 ret
= lttng_ust_add_fd_to_tracker(wakeup_fd
);
633 lttng_ust_unlock_fd_tracker();
634 ret
= close(wakeup_fd
);
636 PERROR("close on wakeup_fd");
643 lttng_ust_unlock_fd_tracker();
645 *_chan_data
= chan_data
;
655 int ustcomm_recv_stream_from_sessiond(int sock
,
656 uint64_t *memory_map_size
,
657 int *shm_fd
, int *wakeup_fd
)
663 /* recv shm fd and wakeup fd */
664 lttng_ust_lock_fd_tracker();
665 len
= ustcomm_recv_fds_unix_sock(sock
, fds
, 2);
667 lttng_ust_unlock_fd_tracker();
677 ret
= lttng_ust_add_fd_to_tracker(fds
[0]);
679 lttng_ust_unlock_fd_tracker();
682 PERROR("close on received shm_fd");
689 ret
= lttng_ust_add_fd_to_tracker(fds
[1]);
691 lttng_ust_unlock_fd_tracker();
692 ret
= close(*shm_fd
);
694 PERROR("close on shm_fd");
699 PERROR("close on received wakeup_fd");
705 lttng_ust_unlock_fd_tracker();
713 * Returns 0 on success, negative error value on error.
715 int ustcomm_send_reg_msg(int sock
,
716 enum ustctl_socket_type type
,
717 uint32_t bits_per_long
,
718 uint32_t uint8_t_alignment
,
719 uint32_t uint16_t_alignment
,
720 uint32_t uint32_t_alignment
,
721 uint32_t uint64_t_alignment
,
722 uint32_t long_alignment
)
725 struct ustctl_reg_msg reg_msg
;
727 reg_msg
.magic
= LTTNG_UST_COMM_MAGIC
;
728 reg_msg
.major
= LTTNG_UST_ABI_MAJOR_VERSION
;
729 reg_msg
.minor
= LTTNG_UST_ABI_MINOR_VERSION
;
730 reg_msg
.pid
= getpid();
731 reg_msg
.ppid
= getppid();
732 reg_msg
.uid
= getuid();
733 reg_msg
.gid
= getgid();
734 reg_msg
.bits_per_long
= bits_per_long
;
735 reg_msg
.uint8_t_alignment
= uint8_t_alignment
;
736 reg_msg
.uint16_t_alignment
= uint16_t_alignment
;
737 reg_msg
.uint32_t_alignment
= uint32_t_alignment
;
738 reg_msg
.uint64_t_alignment
= uint64_t_alignment
;
739 reg_msg
.long_alignment
= long_alignment
;
740 reg_msg
.socket_type
= type
;
741 lttng_ust_getprocname(reg_msg
.name
);
742 memset(reg_msg
.padding
, 0, sizeof(reg_msg
.padding
));
744 len
= ustcomm_send_unix_sock(sock
, ®_msg
, sizeof(reg_msg
));
745 if (len
> 0 && len
!= sizeof(reg_msg
))
753 ssize_t
count_one_type(const struct lttng_type
*lt
)
764 //TODO: implement non-empty struct.
768 const struct lttng_event_field
*choices
;
772 ret
= lttng_ust_dynamic_type_choices(&nr_choices
,
777 * One field for enum, one field for variant, and
778 * one field per choice.
780 return count_fields_recursive(nr_choices
, choices
) + 2;
789 ssize_t
count_fields_recursive(size_t nr_fields
,
790 const struct lttng_event_field
*lttng_fields
)
793 ssize_t ret
, count
= 0;
795 for (i
= 0; i
< nr_fields
; i
++) {
796 const struct lttng_event_field
*lf
;
798 lf
= <tng_fields
[i
];
799 /* skip 'nowrite' fields */
802 ret
= count_one_type(&lf
->type
);
804 return ret
; /* error */
811 ssize_t
count_ctx_fields_recursive(size_t nr_fields
,
812 const struct lttng_ctx_field
*lttng_fields
)
815 ssize_t ret
, count
= 0;
817 for (i
= 0; i
< nr_fields
; i
++) {
818 const struct lttng_event_field
*lf
;
820 lf
= <tng_fields
[i
].event_field
;
821 /* skip 'nowrite' fields */
824 ret
= count_one_type(&lf
->type
);
826 return ret
; /* error */
833 int serialize_string_encoding(int32_t *ue
,
834 enum lttng_string_encodings le
)
837 case lttng_encode_none
:
838 *ue
= ustctl_encode_none
;
840 case lttng_encode_UTF8
:
841 *ue
= ustctl_encode_UTF8
;
843 case lttng_encode_ASCII
:
844 *ue
= ustctl_encode_ASCII
;
853 int serialize_integer_type(struct ustctl_integer_type
*uit
,
854 const struct lttng_integer_type
*lit
)
856 uit
->size
= lit
->size
;
857 uit
->signedness
= lit
->signedness
;
858 uit
->reverse_byte_order
= lit
->reverse_byte_order
;
859 uit
->base
= lit
->base
;
860 if (serialize_string_encoding(&uit
->encoding
, lit
->encoding
))
862 uit
->alignment
= lit
->alignment
;
867 int serialize_basic_type(struct lttng_session
*session
,
868 enum ustctl_abstract_types
*uatype
,
869 enum lttng_abstract_types atype
,
870 union _ustctl_basic_type
*ubt
,
871 const union _lttng_basic_type
*lbt
)
876 if (serialize_integer_type(&ubt
->integer
, &lbt
->integer
))
878 *uatype
= ustctl_atype_integer
;
883 if (serialize_string_encoding(&ubt
->string
.encoding
,
884 lbt
->string
.encoding
))
886 *uatype
= ustctl_atype_string
;
891 struct ustctl_float_type
*uft
;
892 const struct lttng_float_type
*lft
;
896 uft
->exp_dig
= lft
->exp_dig
;
897 uft
->mant_dig
= lft
->mant_dig
;
898 uft
->alignment
= lft
->alignment
;
899 uft
->reverse_byte_order
= lft
->reverse_byte_order
;
900 *uatype
= ustctl_atype_float
;
905 strncpy(ubt
->enumeration
.name
, lbt
->enumeration
.desc
->name
,
906 LTTNG_UST_SYM_NAME_LEN
);
907 ubt
->enumeration
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
908 if (serialize_integer_type(&ubt
->enumeration
.container_type
,
909 &lbt
->enumeration
.container_type
))
912 const struct lttng_enum
*_enum
;
914 _enum
= lttng_ust_enum_get(session
,
915 lbt
->enumeration
.desc
->name
);
918 ubt
->enumeration
.id
= _enum
->id
;
920 ubt
->enumeration
.id
= -1ULL;
922 *uatype
= ustctl_atype_enum
;
934 int serialize_dynamic_type(struct lttng_session
*session
,
935 struct ustctl_field
*fields
, size_t *iter_output
,
936 const struct lttng_event_field
*lf
)
938 const struct lttng_event_field
*choices
;
939 char tag_field_name
[LTTNG_UST_SYM_NAME_LEN
];
940 const struct lttng_type
*tag_type
;
941 const struct lttng_event_field
*tag_field_generic
;
942 struct lttng_event_field tag_field
= {
943 .name
= tag_field_name
,
946 struct ustctl_field
*uf
;
947 size_t nr_choices
, i
;
950 tag_field_generic
= lttng_ust_dynamic_type_tag_field();
951 tag_type
= &tag_field_generic
->type
;
953 /* Serialize enum field. */
954 strncpy(tag_field_name
, lf
->name
, LTTNG_UST_SYM_NAME_LEN
);
955 tag_field_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
956 strncat(tag_field_name
,
958 LTTNG_UST_SYM_NAME_LEN
- strlen(tag_field_name
) - 1);
959 tag_field
.type
= *tag_type
;
960 ret
= serialize_one_field(session
, fields
, iter_output
,
965 /* Serialize variant field. */
966 uf
= &fields
[*iter_output
];
967 ret
= lttng_ust_dynamic_type_choices(&nr_choices
, &choices
);
971 strncpy(uf
->name
, lf
->name
, LTTNG_UST_SYM_NAME_LEN
);
972 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
973 uf
->type
.atype
= ustctl_atype_variant
;
974 uf
->type
.u
.variant
.nr_choices
= nr_choices
;
975 strncpy(uf
->type
.u
.variant
.tag_name
,
977 LTTNG_UST_SYM_NAME_LEN
);
978 uf
->type
.u
.variant
.tag_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
981 /* Serialize choice fields after variant. */
982 for (i
= 0; i
< nr_choices
; i
++) {
983 ret
= serialize_one_field(session
, fields
,
984 iter_output
, &choices
[i
]);
992 int serialize_one_field(struct lttng_session
*session
,
993 struct ustctl_field
*fields
, size_t *iter_output
,
994 const struct lttng_event_field
*lf
)
996 const struct lttng_type
*lt
= &lf
->type
;
999 /* skip 'nowrite' fields */
1003 switch (lt
->atype
) {
1009 struct ustctl_field
*uf
= &fields
[*iter_output
];
1010 struct ustctl_type
*ut
= &uf
->type
;
1012 strncpy(uf
->name
, lf
->name
, LTTNG_UST_SYM_NAME_LEN
);
1013 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1014 ret
= serialize_basic_type(session
, &ut
->atype
, lt
->atype
,
1015 &ut
->u
.basic
, <
->u
.basic
);
1023 struct ustctl_field
*uf
= &fields
[*iter_output
];
1024 struct ustctl_type
*ut
= &uf
->type
;
1025 struct ustctl_basic_type
*ubt
;
1026 const struct lttng_basic_type
*lbt
;
1028 strncpy(uf
->name
, lf
->name
, LTTNG_UST_SYM_NAME_LEN
);
1029 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1030 uf
->type
.atype
= ustctl_atype_array
;
1031 ubt
= &ut
->u
.array
.elem_type
;
1032 lbt
= <
->u
.array
.elem_type
;
1033 ut
->u
.array
.length
= lt
->u
.array
.length
;
1034 ret
= serialize_basic_type(session
, &ubt
->atype
, lbt
->atype
,
1035 &ubt
->u
.basic
, &lbt
->u
.basic
);
1038 ut
->atype
= ustctl_atype_array
;
1042 case atype_sequence
:
1044 struct ustctl_field
*uf
= &fields
[*iter_output
];
1045 struct ustctl_type
*ut
= &uf
->type
;
1046 struct ustctl_basic_type
*ubt
;
1047 const struct lttng_basic_type
*lbt
;
1050 strncpy(uf
->name
, lf
->name
, LTTNG_UST_SYM_NAME_LEN
);
1051 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1052 uf
->type
.atype
= ustctl_atype_sequence
;
1053 ubt
= &ut
->u
.sequence
.length_type
;
1054 lbt
= <
->u
.sequence
.length_type
;
1055 ret
= serialize_basic_type(session
, &ubt
->atype
, lbt
->atype
,
1056 &ubt
->u
.basic
, &lbt
->u
.basic
);
1059 ubt
= &ut
->u
.sequence
.elem_type
;
1060 lbt
= <
->u
.sequence
.elem_type
;
1061 ret
= serialize_basic_type(session
, &ubt
->atype
, lbt
->atype
,
1062 &ubt
->u
.basic
, &lbt
->u
.basic
);
1065 ut
->atype
= ustctl_atype_sequence
;
1071 ret
= serialize_dynamic_type(session
, fields
, iter_output
, lf
);
1078 struct ustctl_field
*uf
= &fields
[*iter_output
];
1081 * TODO: add support for non-empty struct.
1083 if (lf
->type
.u
._struct
.nr_fields
!= 0) {
1086 strncpy(uf
->name
, lf
->name
, LTTNG_UST_SYM_NAME_LEN
);
1087 uf
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1088 uf
->type
.atype
= ustctl_atype_struct
;
1089 uf
->type
.u
._struct
.nr_fields
= 0;
1100 int serialize_fields(struct lttng_session
*session
,
1101 size_t *_nr_write_fields
,
1102 struct ustctl_field
**ustctl_fields
,
1104 const struct lttng_event_field
*lttng_fields
)
1106 struct ustctl_field
*fields
;
1108 size_t i
, iter_output
= 0;
1109 ssize_t nr_write_fields
;
1111 nr_write_fields
= count_fields_recursive(nr_fields
, lttng_fields
);
1112 if (nr_write_fields
< 0) {
1113 return (int) nr_write_fields
;
1116 fields
= zmalloc(nr_write_fields
* sizeof(*fields
));
1120 for (i
= 0; i
< nr_fields
; i
++) {
1121 ret
= serialize_one_field(session
, fields
, &iter_output
,
1127 *_nr_write_fields
= nr_write_fields
;
1128 *ustctl_fields
= fields
;
1137 int serialize_entries(struct ustctl_enum_entry
**_entries
,
1139 const struct lttng_enum_entry
*lttng_entries
)
1141 struct ustctl_enum_entry
*entries
;
1144 /* Serialize the entries */
1145 entries
= zmalloc(nr_entries
* sizeof(*entries
));
1148 for (i
= 0; i
< nr_entries
; i
++) {
1149 struct ustctl_enum_entry
*uentry
;
1150 const struct lttng_enum_entry
*lentry
;
1152 uentry
= &entries
[i
];
1153 lentry
= <tng_entries
[i
];
1155 uentry
->start
.value
= lentry
->start
.value
;
1156 uentry
->start
.signedness
= lentry
->start
.signedness
;
1157 uentry
->end
.value
= lentry
->end
.value
;
1158 uentry
->end
.signedness
= lentry
->end
.signedness
;
1159 strncpy(uentry
->string
, lentry
->string
, LTTNG_UST_SYM_NAME_LEN
);
1160 uentry
->string
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1162 if (lentry
->u
.extra
.options
& LTTNG_ENUM_ENTRY_OPTION_IS_AUTO
) {
1163 uentry
->u
.extra
.options
|=
1164 USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO
;
1167 *_entries
= entries
;
1172 int serialize_ctx_fields(struct lttng_session
*session
,
1173 size_t *_nr_write_fields
,
1174 struct ustctl_field
**ustctl_fields
,
1176 const struct lttng_ctx_field
*lttng_fields
)
1178 struct ustctl_field
*fields
;
1180 size_t i
, iter_output
= 0;
1181 ssize_t nr_write_fields
;
1183 nr_write_fields
= count_ctx_fields_recursive(nr_fields
,
1185 if (nr_write_fields
< 0) {
1186 return (int) nr_write_fields
;
1189 fields
= zmalloc(nr_write_fields
* sizeof(*fields
));
1193 for (i
= 0; i
< nr_fields
; i
++) {
1194 ret
= serialize_one_field(session
, fields
, &iter_output
,
1195 <tng_fields
[i
].event_field
);
1200 *_nr_write_fields
= nr_write_fields
;
1201 *ustctl_fields
= fields
;
1210 * Returns 0 on success, negative error value on error.
1212 int ustcomm_register_event(int sock
,
1213 struct lttng_session
*session
,
1214 int session_objd
, /* session descriptor */
1215 int channel_objd
, /* channel descriptor */
1216 const char *event_name
, /* event name (input) */
1218 const char *signature
, /* event signature (input) */
1219 size_t nr_fields
, /* fields */
1220 const struct lttng_event_field
*lttng_fields
,
1221 const char *model_emf_uri
,
1222 uint32_t *id
) /* event id (output) */
1226 struct ustcomm_notify_hdr header
;
1227 struct ustcomm_notify_event_msg m
;
1230 struct ustcomm_notify_hdr header
;
1231 struct ustcomm_notify_event_reply r
;
1233 size_t signature_len
, fields_len
, model_emf_uri_len
;
1234 struct ustctl_field
*fields
= NULL
;
1235 size_t nr_write_fields
= 0;
1238 memset(&msg
, 0, sizeof(msg
));
1239 msg
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_EVENT
;
1240 msg
.m
.session_objd
= session_objd
;
1241 msg
.m
.channel_objd
= channel_objd
;
1242 strncpy(msg
.m
.event_name
, event_name
, LTTNG_UST_SYM_NAME_LEN
);
1243 msg
.m
.event_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1244 msg
.m
.loglevel
= loglevel
;
1245 signature_len
= strlen(signature
) + 1;
1246 msg
.m
.signature_len
= signature_len
;
1248 /* Calculate fields len, serialize fields. */
1249 if (nr_fields
> 0) {
1250 ret
= serialize_fields(session
, &nr_write_fields
, &fields
,
1251 nr_fields
, lttng_fields
);
1256 fields_len
= sizeof(*fields
) * nr_write_fields
;
1257 msg
.m
.fields_len
= fields_len
;
1258 if (model_emf_uri
) {
1259 model_emf_uri_len
= strlen(model_emf_uri
) + 1;
1261 model_emf_uri_len
= 0;
1263 msg
.m
.model_emf_uri_len
= model_emf_uri_len
;
1265 len
= ustcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
1266 if (len
> 0 && len
!= sizeof(msg
)) {
1275 /* send signature */
1276 len
= ustcomm_send_unix_sock(sock
, signature
, signature_len
);
1277 if (len
> 0 && len
!= signature_len
) {
1287 if (fields_len
> 0) {
1288 len
= ustcomm_send_unix_sock(sock
, fields
, fields_len
);
1289 if (len
> 0 && len
!= fields_len
) {
1300 if (model_emf_uri_len
) {
1301 /* send model_emf_uri */
1302 len
= ustcomm_send_unix_sock(sock
, model_emf_uri
,
1304 if (len
> 0 && len
!= model_emf_uri_len
) {
1313 len
= ustcomm_recv_unix_sock(sock
, &reply
, sizeof(reply
));
1315 case 0: /* orderly shutdown */
1318 if (reply
.header
.notify_cmd
!= msg
.header
.notify_cmd
) {
1319 ERR("Unexpected result message command "
1320 "expected: %u vs received: %u\n",
1321 msg
.header
.notify_cmd
, reply
.header
.notify_cmd
);
1324 if (reply
.r
.ret_code
> 0)
1326 if (reply
.r
.ret_code
< 0)
1327 return reply
.r
.ret_code
;
1328 *id
= reply
.r
.event_id
;
1329 DBG("Sent register event notification for name \"%s\": ret_code %d, event_id %u\n",
1330 event_name
, reply
.r
.ret_code
, reply
.r
.event_id
);
1334 /* Transport level error */
1335 if (errno
== EPIPE
|| errno
== ECONNRESET
)
1339 ERR("incorrect message size: %zd\n", len
);
1345 /* Error path only. */
1352 * Returns 0 on success, negative error value on error.
1353 * Returns -EPIPE or -ECONNRESET if other end has hung up.
1355 int ustcomm_register_enum(int sock
,
1356 int session_objd
, /* session descriptor */
1357 const char *enum_name
, /* enum name (input) */
1358 size_t nr_entries
, /* entries */
1359 const struct lttng_enum_entry
*lttng_entries
,
1364 struct ustcomm_notify_hdr header
;
1365 struct ustcomm_notify_enum_msg m
;
1368 struct ustcomm_notify_hdr header
;
1369 struct ustcomm_notify_enum_reply r
;
1372 struct ustctl_enum_entry
*entries
= NULL
;
1375 memset(&msg
, 0, sizeof(msg
));
1376 msg
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_ENUM
;
1377 msg
.m
.session_objd
= session_objd
;
1378 strncpy(msg
.m
.enum_name
, enum_name
, LTTNG_UST_SYM_NAME_LEN
);
1379 msg
.m
.enum_name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
1381 /* Calculate entries len, serialize entries. */
1382 if (nr_entries
> 0) {
1383 ret
= serialize_entries(&entries
,
1384 nr_entries
, lttng_entries
);
1389 entries_len
= sizeof(*entries
) * nr_entries
;
1390 msg
.m
.entries_len
= entries_len
;
1392 len
= ustcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
1393 if (len
> 0 && len
!= sizeof(msg
)) {
1403 if (entries_len
> 0) {
1404 len
= ustcomm_send_unix_sock(sock
, entries
, entries_len
);
1405 if (len
> 0 && len
!= entries_len
) {
1418 len
= ustcomm_recv_unix_sock(sock
, &reply
, sizeof(reply
));
1420 case 0: /* orderly shutdown */
1423 if (reply
.header
.notify_cmd
!= msg
.header
.notify_cmd
) {
1424 ERR("Unexpected result message command "
1425 "expected: %u vs received: %u\n",
1426 msg
.header
.notify_cmd
, reply
.header
.notify_cmd
);
1429 if (reply
.r
.ret_code
> 0)
1431 if (reply
.r
.ret_code
< 0)
1432 return reply
.r
.ret_code
;
1433 *id
= reply
.r
.enum_id
;
1434 DBG("Sent register enum notification for name \"%s\": ret_code %d\n",
1435 enum_name
, reply
.r
.ret_code
);
1439 /* Transport level error */
1440 if (errno
== EPIPE
|| errno
== ECONNRESET
)
1444 ERR("incorrect message size: %zd\n", len
);
1456 * Returns 0 on success, negative error value on error.
1457 * Returns -EPIPE or -ECONNRESET if other end has hung up.
1459 int ustcomm_register_channel(int sock
,
1460 struct lttng_session
*session
,
1461 int session_objd
, /* session descriptor */
1462 int channel_objd
, /* channel descriptor */
1463 size_t nr_ctx_fields
,
1464 const struct lttng_ctx_field
*ctx_fields
,
1465 uint32_t *chan_id
, /* channel id (output) */
1466 int *header_type
) /* header type (output) */
1470 struct ustcomm_notify_hdr header
;
1471 struct ustcomm_notify_channel_msg m
;
1474 struct ustcomm_notify_hdr header
;
1475 struct ustcomm_notify_channel_reply r
;
1478 struct ustctl_field
*fields
= NULL
;
1480 size_t nr_write_fields
= 0;
1482 memset(&msg
, 0, sizeof(msg
));
1483 msg
.header
.notify_cmd
= USTCTL_NOTIFY_CMD_CHANNEL
;
1484 msg
.m
.session_objd
= session_objd
;
1485 msg
.m
.channel_objd
= channel_objd
;
1487 /* Calculate fields len, serialize fields. */
1488 if (nr_ctx_fields
> 0) {
1489 ret
= serialize_ctx_fields(session
, &nr_write_fields
, &fields
,
1490 nr_ctx_fields
, ctx_fields
);
1495 fields_len
= sizeof(*fields
) * nr_write_fields
;
1496 msg
.m
.ctx_fields_len
= fields_len
;
1497 len
= ustcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
1498 if (len
> 0 && len
!= sizeof(msg
)) {
1508 if (fields_len
> 0) {
1509 len
= ustcomm_send_unix_sock(sock
, fields
, fields_len
);
1511 if (len
> 0 && len
!= fields_len
) {
1521 len
= ustcomm_recv_unix_sock(sock
, &reply
, sizeof(reply
));
1523 case 0: /* orderly shutdown */
1526 if (reply
.header
.notify_cmd
!= msg
.header
.notify_cmd
) {
1527 ERR("Unexpected result message command "
1528 "expected: %u vs received: %u\n",
1529 msg
.header
.notify_cmd
, reply
.header
.notify_cmd
);
1532 if (reply
.r
.ret_code
> 0)
1534 if (reply
.r
.ret_code
< 0)
1535 return reply
.r
.ret_code
;
1536 *chan_id
= reply
.r
.chan_id
;
1537 switch (reply
.r
.header_type
) {
1540 *header_type
= reply
.r
.header_type
;
1543 ERR("Unexpected channel header type %u\n",
1544 reply
.r
.header_type
);
1547 DBG("Sent register channel notification: chan_id %d, header_type %d\n",
1548 reply
.r
.chan_id
, reply
.r
.header_type
);
1552 /* Transport level error */
1553 if (errno
== EPIPE
|| errno
== ECONNRESET
)
1557 ERR("incorrect message size: %zd\n", len
);
1564 * Set socket reciving timeout.
1566 int ustcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
)
1571 tv
.tv_sec
= msec
/ 1000;
1572 tv
.tv_usec
= (msec
* 1000 % 1000000);
1574 ret
= setsockopt(sock
, SOL_SOCKET
, SO_RCVTIMEO
, &tv
, sizeof(tv
));
1576 PERROR("setsockopt SO_RCVTIMEO");
1584 * Set socket sending timeout.
1586 int ustcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
)
1591 tv
.tv_sec
= msec
/ 1000;
1592 tv
.tv_usec
= (msec
* 1000) % 1000000;
1594 ret
= setsockopt(sock
, SOL_SOCKET
, SO_SNDTIMEO
, &tv
, sizeof(tv
));
1596 PERROR("setsockopt SO_SNDTIMEO");