2 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
3 * Copyright (C) 2018 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
14 #include <sys/types.h>
18 #include <common/common.h>
19 #include <common/defaults.h>
20 #include <common/uri.h>
21 #include <common/relayd/relayd.h>
22 #include <common/string-utils/format.h>
25 #include "health-sessiond.h"
28 #include "lttng-sessiond.h"
31 * Return allocated full pathname of the session using the consumer trace path
32 * and subdir if available.
34 * The caller can safely free(3) the returned value. On error, NULL is
37 char *setup_channel_trace_path(struct consumer_output
*consumer
,
38 const char *session_path
, size_t *consumer_path_offset
)
43 LTTNG_ASSERT(consumer
);
44 LTTNG_ASSERT(session_path
);
49 * Allocate the string ourself to make sure we never exceed
52 pathname
= (char *) zmalloc(LTTNG_PATH_MAX
);
57 /* Get correct path name destination */
58 if (consumer
->type
== CONSUMER_DST_NET
&&
59 consumer
->relay_major_version
== 2 &&
60 consumer
->relay_minor_version
< 11) {
61 ret
= snprintf(pathname
, LTTNG_PATH_MAX
, "%s%s/%s/%s",
62 consumer
->dst
.net
.base_dir
,
63 consumer
->chunk_path
, consumer
->domain_subdir
,
65 *consumer_path_offset
= 0;
67 ret
= snprintf(pathname
, LTTNG_PATH_MAX
, "%s/%s",
68 consumer
->domain_subdir
, session_path
);
69 *consumer_path_offset
= strlen(consumer
->domain_subdir
) + 1;
71 DBG3("Consumer trace path relative to current trace chunk: \"%s\"",
74 PERROR("Failed to format channel path");
76 } else if (ret
>= LTTNG_PATH_MAX
) {
77 ERR("Truncation occurred while formatting channel path");
88 * Send a data payload using a given consumer socket of size len.
90 * The consumer socket lock MUST be acquired before calling this since this
91 * function can change the fd value.
93 * Return 0 on success else a negative value on error.
95 int consumer_socket_send(
96 struct consumer_socket
*socket
, const void *msg
, size_t len
)
101 LTTNG_ASSERT(socket
);
102 LTTNG_ASSERT(socket
->fd_ptr
);
105 /* Consumer socket is invalid. Stopping. */
106 fd
= *socket
->fd_ptr
;
111 size
= lttcomm_send_unix_sock(fd
, msg
, len
);
113 /* The above call will print a PERROR on error. */
114 DBG("Error when sending data to consumer on sock %d", fd
);
116 * At this point, the socket is not usable anymore thus closing it and
117 * setting the file descriptor to -1 so it is not reused.
120 /* This call will PERROR on error. */
121 (void) lttcomm_close_unix_sock(fd
);
122 *socket
->fd_ptr
= -1;
133 * Receive a data payload using a given consumer socket of size len.
135 * The consumer socket lock MUST be acquired before calling this since this
136 * function can change the fd value.
138 * Return 0 on success else a negative value on error.
140 int consumer_socket_recv(struct consumer_socket
*socket
, void *msg
, size_t len
)
145 LTTNG_ASSERT(socket
);
146 LTTNG_ASSERT(socket
->fd_ptr
);
149 /* Consumer socket is invalid. Stopping. */
150 fd
= *socket
->fd_ptr
;
155 size
= lttcomm_recv_unix_sock(fd
, msg
, len
);
157 /* The above call will print a PERROR on error. */
158 DBG("Error when receiving data from the consumer socket %d", fd
);
160 * At this point, the socket is not usable anymore thus closing it and
161 * setting the file descriptor to -1 so it is not reused.
164 /* This call will PERROR on error. */
165 (void) lttcomm_close_unix_sock(fd
);
166 *socket
->fd_ptr
= -1;
177 * Receive a reply command status message from the consumer. Consumer socket
178 * lock MUST be acquired before calling this function.
180 * Return 0 on success, -1 on recv error or a negative lttng error code which
181 * was possibly returned by the consumer.
183 int consumer_recv_status_reply(struct consumer_socket
*sock
)
186 struct lttcomm_consumer_status_msg reply
;
190 ret
= consumer_socket_recv(sock
, &reply
, sizeof(reply
));
195 if (reply
.ret_code
== LTTCOMM_CONSUMERD_SUCCESS
) {
199 ret
= -reply
.ret_code
;
200 DBG("Consumer ret code %d", ret
);
208 * Once the ASK_CHANNEL command is sent to the consumer, the channel
209 * information are sent back. This call receives that data and populates key
212 * On success return 0 and both key and stream_count are set. On error, a
213 * negative value is sent back and both parameters are untouched.
215 int consumer_recv_status_channel(struct consumer_socket
*sock
,
216 uint64_t *key
, unsigned int *stream_count
)
219 struct lttcomm_consumer_status_channel reply
;
222 LTTNG_ASSERT(stream_count
);
225 ret
= consumer_socket_recv(sock
, &reply
, sizeof(reply
));
230 /* An error is possible so don't touch the key and stream_count. */
231 if (reply
.ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
237 *stream_count
= reply
.stream_count
;
245 * Send destroy relayd command to consumer.
247 * On success return positive value. On error, negative value.
249 int consumer_send_destroy_relayd(struct consumer_socket
*sock
,
250 struct consumer_output
*consumer
)
253 struct lttcomm_consumer_msg msg
;
255 LTTNG_ASSERT(consumer
);
258 DBG2("Sending destroy relayd command to consumer sock %d", *sock
->fd_ptr
);
260 memset(&msg
, 0, sizeof(msg
));
261 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_RELAYD
;
262 msg
.u
.destroy_relayd
.net_seq_idx
= consumer
->net_seq_index
;
264 pthread_mutex_lock(sock
->lock
);
265 ret
= consumer_socket_send(sock
, &msg
, sizeof(msg
));
270 /* Don't check the return value. The caller will do it. */
271 ret
= consumer_recv_status_reply(sock
);
273 DBG2("Consumer send destroy relayd command done");
276 pthread_mutex_unlock(sock
->lock
);
281 * For each consumer socket in the consumer output object, send a destroy
284 void consumer_output_send_destroy_relayd(struct consumer_output
*consumer
)
286 struct lttng_ht_iter iter
;
287 struct consumer_socket
*socket
;
289 LTTNG_ASSERT(consumer
);
291 /* Destroy any relayd connection */
292 if (consumer
->type
== CONSUMER_DST_NET
) {
294 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
298 /* Send destroy relayd command */
299 ret
= consumer_send_destroy_relayd(socket
, consumer
);
301 DBG("Unable to send destroy relayd command to consumer");
302 /* Continue since we MUST delete everything at this point. */
310 * From a consumer_data structure, allocate and add a consumer socket to the
313 * Return 0 on success, else negative value on error
315 int consumer_create_socket(struct consumer_data
*data
,
316 struct consumer_output
*output
)
319 struct consumer_socket
*socket
;
323 if (output
== NULL
|| data
->cmd_sock
< 0) {
325 * Not an error. Possible there is simply not spawned consumer or it's
326 * disabled for the tracing session asking the socket.
332 socket
= consumer_find_socket(data
->cmd_sock
, output
);
334 if (socket
== NULL
) {
335 socket
= consumer_allocate_socket(&data
->cmd_sock
);
336 if (socket
== NULL
) {
341 socket
->registered
= 0;
342 socket
->lock
= &data
->lock
;
344 consumer_add_socket(socket
, output
);
348 socket
->type
= data
->type
;
350 DBG3("Consumer socket created (fd: %d) and added to output",
358 * Return the consumer socket from the given consumer output with the right
359 * bitness. On error, returns NULL.
361 * The caller MUST acquire a rcu read side lock and keep it until the socket
362 * object reference is not needed anymore.
364 struct consumer_socket
*consumer_find_socket_by_bitness(int bits
,
365 const struct consumer_output
*consumer
)
368 struct consumer_socket
*socket
= NULL
;
372 consumer_fd
= uatomic_read(&the_ust_consumerd64_fd
);
375 consumer_fd
= uatomic_read(&the_ust_consumerd32_fd
);
382 socket
= consumer_find_socket(consumer_fd
, consumer
);
384 ERR("Consumer socket fd %d not found in consumer obj %p",
385 consumer_fd
, consumer
);
393 * Find a consumer_socket in a consumer_output hashtable. Read side lock must
394 * be acquired before calling this function and across use of the
395 * returned consumer_socket.
397 struct consumer_socket
*consumer_find_socket(int key
,
398 const struct consumer_output
*consumer
)
400 struct lttng_ht_iter iter
;
401 struct lttng_ht_node_ulong
*node
;
402 struct consumer_socket
*socket
= NULL
;
404 /* Negative keys are lookup failures */
405 if (key
< 0 || consumer
== NULL
) {
409 lttng_ht_lookup(consumer
->socks
, (void *)((unsigned long) key
),
411 node
= lttng_ht_iter_get_node_ulong(&iter
);
413 socket
= caa_container_of(node
, struct consumer_socket
, node
);
420 * Allocate a new consumer_socket and return the pointer.
422 struct consumer_socket
*consumer_allocate_socket(int *fd
)
424 struct consumer_socket
*socket
= NULL
;
428 socket
= (consumer_socket
*) zmalloc(sizeof(struct consumer_socket
));
429 if (socket
== NULL
) {
430 PERROR("zmalloc consumer socket");
435 lttng_ht_node_init_ulong(&socket
->node
, *fd
);
442 * Add consumer socket to consumer output object. Read side lock must be
443 * acquired before calling this function.
445 void consumer_add_socket(struct consumer_socket
*sock
,
446 struct consumer_output
*consumer
)
449 LTTNG_ASSERT(consumer
);
451 lttng_ht_add_unique_ulong(consumer
->socks
, &sock
->node
);
455 * Delete consumer socket to consumer output object. Read side lock must be
456 * acquired before calling this function.
458 void consumer_del_socket(struct consumer_socket
*sock
,
459 struct consumer_output
*consumer
)
462 struct lttng_ht_iter iter
;
465 LTTNG_ASSERT(consumer
);
467 iter
.iter
.node
= &sock
->node
.node
;
468 ret
= lttng_ht_del(consumer
->socks
, &iter
);
473 * RCU destroy call function.
475 static void destroy_socket_rcu(struct rcu_head
*head
)
477 struct lttng_ht_node_ulong
*node
=
478 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
479 struct consumer_socket
*socket
=
480 caa_container_of(node
, struct consumer_socket
, node
);
486 * Destroy and free socket pointer in a call RCU. Read side lock must be
487 * acquired before calling this function.
489 void consumer_destroy_socket(struct consumer_socket
*sock
)
494 * We DO NOT close the file descriptor here since it is global to the
495 * session daemon and is closed only if the consumer dies or a custom
496 * consumer was registered,
498 if (sock
->registered
) {
499 DBG3("Consumer socket was registered. Closing fd %d", *sock
->fd_ptr
);
500 lttcomm_close_unix_sock(*sock
->fd_ptr
);
503 call_rcu(&sock
->node
.head
, destroy_socket_rcu
);
507 * Allocate and assign data to a consumer_output object.
509 * Return pointer to structure.
511 struct consumer_output
*consumer_create_output(enum consumer_dst_type type
)
513 struct consumer_output
*output
= NULL
;
515 output
= (consumer_output
*) zmalloc(sizeof(struct consumer_output
));
516 if (output
== NULL
) {
517 PERROR("zmalloc consumer_output");
521 /* By default, consumer output is enabled */
524 output
->net_seq_index
= (uint64_t) -1ULL;
525 urcu_ref_init(&output
->ref
);
527 output
->socks
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
534 * Iterate over the consumer output socket hash table and destroy them. The
535 * socket file descriptor are only closed if the consumer output was
536 * registered meaning it's an external consumer.
538 void consumer_destroy_output_sockets(struct consumer_output
*obj
)
540 struct lttng_ht_iter iter
;
541 struct consumer_socket
*socket
;
548 cds_lfht_for_each_entry(obj
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
549 consumer_del_socket(socket
, obj
);
550 consumer_destroy_socket(socket
);
556 * Delete the consumer_output object from the list and free the ptr.
558 static void consumer_release_output(struct urcu_ref
*ref
)
560 struct consumer_output
*obj
=
561 caa_container_of(ref
, struct consumer_output
, ref
);
563 consumer_destroy_output_sockets(obj
);
566 /* Finally destroy HT */
567 lttng_ht_destroy(obj
->socks
);
574 * Get the consumer_output object.
576 void consumer_output_get(struct consumer_output
*obj
)
578 urcu_ref_get(&obj
->ref
);
582 * Put the consumer_output object.
584 void consumer_output_put(struct consumer_output
*obj
)
589 urcu_ref_put(&obj
->ref
, consumer_release_output
);
593 * Copy consumer output and returned the newly allocated copy.
595 struct consumer_output
*consumer_copy_output(struct consumer_output
*src
)
598 struct consumer_output
*output
;
602 output
= consumer_create_output(src
->type
);
603 if (output
== NULL
) {
606 output
->enabled
= src
->enabled
;
607 output
->net_seq_index
= src
->net_seq_index
;
608 memcpy(output
->domain_subdir
, src
->domain_subdir
,
609 sizeof(output
->domain_subdir
));
610 output
->snapshot
= src
->snapshot
;
611 output
->relay_major_version
= src
->relay_major_version
;
612 output
->relay_minor_version
= src
->relay_minor_version
;
613 output
->relay_allows_clear
= src
->relay_allows_clear
;
614 memcpy(&output
->dst
, &src
->dst
, sizeof(output
->dst
));
615 ret
= consumer_copy_sockets(output
, src
);
623 consumer_output_put(output
);
628 * Copy consumer sockets from src to dst.
630 * Return 0 on success or else a negative value.
632 int consumer_copy_sockets(struct consumer_output
*dst
,
633 struct consumer_output
*src
)
636 struct lttng_ht_iter iter
;
637 struct consumer_socket
*socket
, *copy_sock
;
643 cds_lfht_for_each_entry(src
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
644 /* Ignore socket that are already there. */
645 copy_sock
= consumer_find_socket(*socket
->fd_ptr
, dst
);
650 /* Create new socket object. */
651 copy_sock
= consumer_allocate_socket(socket
->fd_ptr
);
652 if (copy_sock
== NULL
) {
658 copy_sock
->registered
= socket
->registered
;
660 * This is valid because this lock is shared accross all consumer
661 * object being the global lock of the consumer data structure of the
664 copy_sock
->lock
= socket
->lock
;
665 consumer_add_socket(copy_sock
, dst
);
674 * Set network URI to the consumer output.
676 * Return 0 on success. Return 1 if the URI were equal. Else, negative value on
679 int consumer_set_network_uri(const struct ltt_session
*session
,
680 struct consumer_output
*output
,
681 struct lttng_uri
*uri
)
684 struct lttng_uri
*dst_uri
= NULL
;
686 /* Code flow error safety net. */
687 LTTNG_ASSERT(output
);
690 switch (uri
->stype
) {
691 case LTTNG_STREAM_CONTROL
:
692 dst_uri
= &output
->dst
.net
.control
;
693 output
->dst
.net
.control_isset
= 1;
694 if (uri
->port
== 0) {
695 /* Assign default port. */
696 uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
698 if (output
->dst
.net
.data_isset
&& uri
->port
==
699 output
->dst
.net
.data
.port
) {
700 ret
= -LTTNG_ERR_INVALID
;
704 DBG3("Consumer control URI set with port %d", uri
->port
);
706 case LTTNG_STREAM_DATA
:
707 dst_uri
= &output
->dst
.net
.data
;
708 output
->dst
.net
.data_isset
= 1;
709 if (uri
->port
== 0) {
710 /* Assign default port. */
711 uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
713 if (output
->dst
.net
.control_isset
&& uri
->port
==
714 output
->dst
.net
.control
.port
) {
715 ret
= -LTTNG_ERR_INVALID
;
719 DBG3("Consumer data URI set with port %d", uri
->port
);
722 ERR("Set network uri type unknown %d", uri
->stype
);
723 ret
= -LTTNG_ERR_INVALID
;
727 ret
= uri_compare(dst_uri
, uri
);
729 /* Same URI, don't touch it and return success. */
730 DBG3("URI network compare are the same");
734 /* URIs were not equal, replacing it. */
735 memcpy(dst_uri
, uri
, sizeof(struct lttng_uri
));
736 output
->type
= CONSUMER_DST_NET
;
737 if (dst_uri
->stype
!= LTTNG_STREAM_CONTROL
) {
738 /* Only the control uri needs to contain the path. */
743 * If the user has specified a subdir as part of the control
744 * URL, the session's base output directory is:
745 * /RELAYD_OUTPUT_PATH/HOSTNAME/USER_SPECIFIED_DIR
747 * Hence, the "base_dir" from which all stream files and
748 * session rotation chunks are created takes the form
749 * /HOSTNAME/USER_SPECIFIED_DIR
751 * If the user has not specified an output directory as part of
752 * the control URL, the base output directory has the form:
753 * /RELAYD_OUTPUT_PATH/HOSTNAME/SESSION_NAME-CREATION_TIME
755 * Hence, the "base_dir" from which all stream files and
756 * session rotation chunks are created takes the form
757 * /HOSTNAME/SESSION_NAME-CREATION_TIME
759 * Note that automatically generated session names already
760 * contain the session's creation time. In that case, the
761 * creation time is omitted to prevent it from being duplicated
762 * in the final directory hierarchy.
765 if (strstr(uri
->subdir
, "../")) {
766 ERR("Network URI subdirs are not allowed to walk up the path hierarchy");
767 ret
= -LTTNG_ERR_INVALID
;
770 ret
= snprintf(output
->dst
.net
.base_dir
,
771 sizeof(output
->dst
.net
.base_dir
),
772 "/%s/%s/", session
->hostname
, uri
->subdir
);
774 if (session
->has_auto_generated_name
) {
775 ret
= snprintf(output
->dst
.net
.base_dir
,
776 sizeof(output
->dst
.net
.base_dir
),
777 "/%s/%s/", session
->hostname
,
780 char session_creation_datetime
[16];
784 timeinfo
= localtime(&session
->creation_time
);
786 ret
= -LTTNG_ERR_FATAL
;
789 strftime_ret
= strftime(session_creation_datetime
,
790 sizeof(session_creation_datetime
),
791 "%Y%m%d-%H%M%S", timeinfo
);
792 if (strftime_ret
== 0) {
793 ERR("Failed to format session creation timestamp while setting network URI");
794 ret
= -LTTNG_ERR_FATAL
;
797 ret
= snprintf(output
->dst
.net
.base_dir
,
798 sizeof(output
->dst
.net
.base_dir
),
799 "/%s/%s-%s/", session
->hostname
,
801 session_creation_datetime
);
804 if (ret
>= sizeof(output
->dst
.net
.base_dir
)) {
805 ret
= -LTTNG_ERR_INVALID
;
806 ERR("Truncation occurred while setting network output base directory");
808 } else if (ret
== -1) {
809 ret
= -LTTNG_ERR_INVALID
;
810 PERROR("Error occurred while setting network output base directory");
814 DBG3("Consumer set network uri base_dir path %s",
815 output
->dst
.net
.base_dir
);
826 * Send file descriptor to consumer via sock.
828 * The consumer socket lock must be held by the caller.
830 int consumer_send_fds(struct consumer_socket
*sock
, const int *fds
,
837 LTTNG_ASSERT(nb_fd
> 0);
838 LTTNG_ASSERT(pthread_mutex_trylock(sock
->lock
) == EBUSY
);
840 ret
= lttcomm_send_fds_unix_sock(*sock
->fd_ptr
, fds
, nb_fd
);
842 /* The above call will print a PERROR on error. */
843 DBG("Error when sending consumer fds on sock %d", *sock
->fd_ptr
);
847 ret
= consumer_recv_status_reply(sock
);
853 * Consumer send communication message structure to consumer.
855 * The consumer socket lock must be held by the caller.
857 int consumer_send_msg(struct consumer_socket
*sock
,
858 const struct lttcomm_consumer_msg
*msg
)
864 LTTNG_ASSERT(pthread_mutex_trylock(sock
->lock
) == EBUSY
);
866 ret
= consumer_socket_send(sock
, msg
, sizeof(struct lttcomm_consumer_msg
));
871 ret
= consumer_recv_status_reply(sock
);
878 * Consumer send channel communication message structure to consumer.
880 * The consumer socket lock must be held by the caller.
882 int consumer_send_channel(struct consumer_socket
*sock
,
883 struct lttcomm_consumer_msg
*msg
)
890 ret
= consumer_send_msg(sock
, msg
);
900 * Populate the given consumer msg structure with the ask_channel command
903 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
904 uint64_t subbuf_size
,
907 unsigned int switch_timer_interval
,
908 unsigned int read_timer_interval
,
909 unsigned int live_timer_interval
,
910 bool is_in_live_session
,
911 unsigned int monitor_timer_interval
,
915 const char *pathname
,
921 uint64_t tracefile_size
,
922 uint64_t tracefile_count
,
923 uint64_t session_id_per_pid
,
924 unsigned int monitor
,
925 uint32_t ust_app_uid
,
926 int64_t blocking_timeout
,
927 const char *root_shm_path
,
928 const char *shm_path
,
929 struct lttng_trace_chunk
*trace_chunk
,
930 const struct lttng_credentials
*buffer_credentials
)
934 /* Zeroed structure */
935 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
936 msg
->u
.ask_channel
.buffer_credentials
.uid
= UINT32_MAX
;
937 msg
->u
.ask_channel
.buffer_credentials
.gid
= UINT32_MAX
;
941 enum lttng_trace_chunk_status chunk_status
;
943 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
, &chunk_id
);
944 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
945 LTTNG_OPTIONAL_SET(&msg
->u
.ask_channel
.chunk_id
, chunk_id
);
947 msg
->u
.ask_channel
.buffer_credentials
.uid
=
948 lttng_credentials_get_uid(buffer_credentials
);
949 msg
->u
.ask_channel
.buffer_credentials
.gid
=
950 lttng_credentials_get_gid(buffer_credentials
);
952 msg
->cmd_type
= LTTNG_CONSUMER_ASK_CHANNEL_CREATION
;
953 msg
->u
.ask_channel
.subbuf_size
= subbuf_size
;
954 msg
->u
.ask_channel
.num_subbuf
= num_subbuf
;
955 msg
->u
.ask_channel
.overwrite
= overwrite
;
956 msg
->u
.ask_channel
.switch_timer_interval
= switch_timer_interval
;
957 msg
->u
.ask_channel
.read_timer_interval
= read_timer_interval
;
958 msg
->u
.ask_channel
.live_timer_interval
= live_timer_interval
;
959 msg
->u
.ask_channel
.is_live
= is_in_live_session
;
960 msg
->u
.ask_channel
.monitor_timer_interval
= monitor_timer_interval
;
961 msg
->u
.ask_channel
.output
= output
;
962 msg
->u
.ask_channel
.type
= type
;
963 msg
->u
.ask_channel
.session_id
= session_id
;
964 msg
->u
.ask_channel
.session_id_per_pid
= session_id_per_pid
;
965 msg
->u
.ask_channel
.relayd_id
= relayd_id
;
966 msg
->u
.ask_channel
.key
= key
;
967 msg
->u
.ask_channel
.chan_id
= chan_id
;
968 msg
->u
.ask_channel
.tracefile_size
= tracefile_size
;
969 msg
->u
.ask_channel
.tracefile_count
= tracefile_count
;
970 msg
->u
.ask_channel
.monitor
= monitor
;
971 msg
->u
.ask_channel
.ust_app_uid
= ust_app_uid
;
972 msg
->u
.ask_channel
.blocking_timeout
= blocking_timeout
;
974 memcpy(msg
->u
.ask_channel
.uuid
, uuid
, sizeof(msg
->u
.ask_channel
.uuid
));
977 strncpy(msg
->u
.ask_channel
.pathname
, pathname
,
978 sizeof(msg
->u
.ask_channel
.pathname
));
979 msg
->u
.ask_channel
.pathname
[sizeof(msg
->u
.ask_channel
.pathname
)-1] = '\0';
982 strncpy(msg
->u
.ask_channel
.name
, name
, sizeof(msg
->u
.ask_channel
.name
));
983 msg
->u
.ask_channel
.name
[sizeof(msg
->u
.ask_channel
.name
) - 1] = '\0';
986 strncpy(msg
->u
.ask_channel
.root_shm_path
, root_shm_path
,
987 sizeof(msg
->u
.ask_channel
.root_shm_path
));
988 msg
->u
.ask_channel
.root_shm_path
[sizeof(msg
->u
.ask_channel
.root_shm_path
) - 1] = '\0';
991 strncpy(msg
->u
.ask_channel
.shm_path
, shm_path
,
992 sizeof(msg
->u
.ask_channel
.shm_path
));
993 msg
->u
.ask_channel
.shm_path
[sizeof(msg
->u
.ask_channel
.shm_path
) - 1] = '\0';
998 * Init channel communication message structure.
1000 void consumer_init_add_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
1001 uint64_t channel_key
,
1002 uint64_t session_id
,
1003 const char *pathname
,
1008 unsigned int nb_init_streams
,
1009 enum lttng_event_output output
,
1011 uint64_t tracefile_size
,
1012 uint64_t tracefile_count
,
1013 unsigned int monitor
,
1014 unsigned int live_timer_interval
,
1015 bool is_in_live_session
,
1016 unsigned int monitor_timer_interval
,
1017 struct lttng_trace_chunk
*trace_chunk
)
1021 /* Zeroed structure */
1022 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1026 enum lttng_trace_chunk_status chunk_status
;
1028 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
, &chunk_id
);
1029 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
1030 LTTNG_OPTIONAL_SET(&msg
->u
.channel
.chunk_id
, chunk_id
);
1034 msg
->cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
1035 msg
->u
.channel
.channel_key
= channel_key
;
1036 msg
->u
.channel
.session_id
= session_id
;
1037 msg
->u
.channel
.relayd_id
= relayd_id
;
1038 msg
->u
.channel
.nb_init_streams
= nb_init_streams
;
1039 msg
->u
.channel
.output
= output
;
1040 msg
->u
.channel
.type
= type
;
1041 msg
->u
.channel
.tracefile_size
= tracefile_size
;
1042 msg
->u
.channel
.tracefile_count
= tracefile_count
;
1043 msg
->u
.channel
.monitor
= monitor
;
1044 msg
->u
.channel
.live_timer_interval
= live_timer_interval
;
1045 msg
->u
.channel
.is_live
= is_in_live_session
;
1046 msg
->u
.channel
.monitor_timer_interval
= monitor_timer_interval
;
1048 strncpy(msg
->u
.channel
.pathname
, pathname
,
1049 sizeof(msg
->u
.channel
.pathname
));
1050 msg
->u
.channel
.pathname
[sizeof(msg
->u
.channel
.pathname
) - 1] = '\0';
1052 strncpy(msg
->u
.channel
.name
, name
, sizeof(msg
->u
.channel
.name
));
1053 msg
->u
.channel
.name
[sizeof(msg
->u
.channel
.name
) - 1] = '\0';
1057 * Init stream communication message structure.
1059 void consumer_init_add_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
1060 uint64_t channel_key
,
1061 uint64_t stream_key
,
1066 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1068 msg
->cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
1069 msg
->u
.stream
.channel_key
= channel_key
;
1070 msg
->u
.stream
.stream_key
= stream_key
;
1071 msg
->u
.stream
.cpu
= cpu
;
1074 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg
*msg
,
1075 enum lttng_consumer_command cmd
,
1076 uint64_t channel_key
, uint64_t net_seq_idx
)
1080 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1082 msg
->cmd_type
= cmd
;
1083 msg
->u
.sent_streams
.channel_key
= channel_key
;
1084 msg
->u
.sent_streams
.net_seq_idx
= net_seq_idx
;
1088 * Send stream communication structure to the consumer.
1090 int consumer_send_stream(struct consumer_socket
*sock
,
1091 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
1092 const int *fds
, size_t nb_fd
)
1101 ret
= consumer_send_msg(sock
, msg
);
1106 ret
= consumer_send_fds(sock
, fds
, nb_fd
);
1116 * Send relayd socket to consumer associated with a session name.
1118 * The consumer socket lock must be held by the caller.
1120 * On success return positive value. On error, negative value.
1122 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
1123 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
1124 enum lttng_stream_type type
, uint64_t session_id
,
1125 const char *session_name
, const char *hostname
,
1126 const char *base_path
, int session_live_timer
,
1127 const uint64_t *current_chunk_id
, time_t session_creation_time
,
1128 bool session_name_contains_creation_time
)
1132 struct lttcomm_consumer_msg msg
;
1134 /* Code flow error. Safety net. */
1135 LTTNG_ASSERT(rsock
);
1136 LTTNG_ASSERT(consumer
);
1137 LTTNG_ASSERT(consumer_sock
);
1139 memset(&msg
, 0, sizeof(msg
));
1140 /* Bail out if consumer is disabled */
1141 if (!consumer
->enabled
) {
1146 if (type
== LTTNG_STREAM_CONTROL
) {
1147 char output_path
[LTTNG_PATH_MAX
] = {};
1148 uint64_t relayd_session_id
;
1150 ret
= relayd_create_session(rsock
, &relayd_session_id
,
1151 session_name
, hostname
, base_path
,
1152 session_live_timer
, consumer
->snapshot
,
1153 session_id
, the_sessiond_uuid
, current_chunk_id
,
1154 session_creation_time
,
1155 session_name_contains_creation_time
,
1158 /* Close the control socket. */
1159 (void) relayd_close(rsock
);
1162 msg
.u
.relayd_sock
.relayd_session_id
= relayd_session_id
;
1163 DBG("Created session on relay, output path reply: %s",
1167 msg
.cmd_type
= LTTNG_CONSUMER_ADD_RELAYD_SOCKET
;
1169 * Assign network consumer output index using the temporary consumer since
1170 * this call should only be made from within a set_consumer_uri() function
1171 * call in the session daemon.
1173 msg
.u
.relayd_sock
.net_index
= consumer
->net_seq_index
;
1174 msg
.u
.relayd_sock
.type
= type
;
1175 msg
.u
.relayd_sock
.session_id
= session_id
;
1176 memcpy(&msg
.u
.relayd_sock
.sock
, rsock
, sizeof(msg
.u
.relayd_sock
.sock
));
1178 DBG3("Sending relayd sock info to consumer on %d", *consumer_sock
->fd_ptr
);
1179 ret
= consumer_send_msg(consumer_sock
, &msg
);
1184 DBG3("Sending relayd socket file descriptor to consumer");
1185 fd
= rsock
->sock
.fd
;
1186 ret
= consumer_send_fds(consumer_sock
, &fd
, 1);
1191 DBG2("Consumer relayd socket sent");
1198 int consumer_send_pipe(struct consumer_socket
*consumer_sock
,
1199 enum lttng_consumer_command cmd
, int pipe
)
1202 struct lttcomm_consumer_msg msg
;
1203 const char *pipe_name
;
1204 const char *command_name
;
1207 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1208 pipe_name
= "channel monitor";
1209 command_name
= "SET_CHANNEL_MONITOR_PIPE";
1212 ERR("Unexpected command received in %s (cmd = %d)", __func__
,
1217 /* Code flow error. Safety net. */
1219 memset(&msg
, 0, sizeof(msg
));
1222 pthread_mutex_lock(consumer_sock
->lock
);
1223 DBG3("Sending %s command to consumer", command_name
);
1224 ret
= consumer_send_msg(consumer_sock
, &msg
);
1229 DBG3("Sending %s pipe %d to consumer on socket %d",
1231 pipe
, *consumer_sock
->fd_ptr
);
1232 ret
= consumer_send_fds(consumer_sock
, &pipe
, 1);
1237 DBG2("%s pipe successfully sent", pipe_name
);
1239 pthread_mutex_unlock(consumer_sock
->lock
);
1243 int consumer_send_channel_monitor_pipe(struct consumer_socket
*consumer_sock
,
1246 return consumer_send_pipe(consumer_sock
,
1247 LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
, pipe
);
1251 * Ask the consumer if the data is pending for the specific session id.
1252 * Returns 1 if data is pending, 0 otherwise, or < 0 on error.
1254 int consumer_is_data_pending(uint64_t session_id
,
1255 struct consumer_output
*consumer
)
1258 int32_t ret_code
= 0; /* Default is that the data is NOT pending */
1259 struct consumer_socket
*socket
;
1260 struct lttng_ht_iter iter
;
1261 struct lttcomm_consumer_msg msg
;
1263 LTTNG_ASSERT(consumer
);
1265 DBG3("Consumer data pending for id %" PRIu64
, session_id
);
1267 memset(&msg
, 0, sizeof(msg
));
1268 msg
.cmd_type
= LTTNG_CONSUMER_DATA_PENDING
;
1269 msg
.u
.data_pending
.session_id
= session_id
;
1271 /* Send command for each consumer */
1273 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1275 pthread_mutex_lock(socket
->lock
);
1276 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1278 pthread_mutex_unlock(socket
->lock
);
1283 * No need for a recv reply status because the answer to the command is
1284 * the reply status message.
1287 ret
= consumer_socket_recv(socket
, &ret_code
, sizeof(ret_code
));
1289 pthread_mutex_unlock(socket
->lock
);
1292 pthread_mutex_unlock(socket
->lock
);
1294 if (ret_code
== 1) {
1300 DBG("Consumer data is %s pending for session id %" PRIu64
,
1301 ret_code
== 1 ? "" : "NOT", session_id
);
1310 * Send a flush command to consumer using the given channel key.
1312 * Return 0 on success else a negative value.
1314 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
)
1317 struct lttcomm_consumer_msg msg
;
1319 LTTNG_ASSERT(socket
);
1321 DBG2("Consumer flush channel key %" PRIu64
, key
);
1323 memset(&msg
, 0, sizeof(msg
));
1324 msg
.cmd_type
= LTTNG_CONSUMER_FLUSH_CHANNEL
;
1325 msg
.u
.flush_channel
.key
= key
;
1327 pthread_mutex_lock(socket
->lock
);
1328 health_code_update();
1330 ret
= consumer_send_msg(socket
, &msg
);
1336 health_code_update();
1337 pthread_mutex_unlock(socket
->lock
);
1342 * Send a clear quiescent command to consumer using the given channel key.
1344 * Return 0 on success else a negative value.
1346 int consumer_clear_quiescent_channel(struct consumer_socket
*socket
, uint64_t key
)
1349 struct lttcomm_consumer_msg msg
;
1351 LTTNG_ASSERT(socket
);
1353 DBG2("Consumer clear quiescent channel key %" PRIu64
, key
);
1355 memset(&msg
, 0, sizeof(msg
));
1356 msg
.cmd_type
= LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
;
1357 msg
.u
.clear_quiescent_channel
.key
= key
;
1359 pthread_mutex_lock(socket
->lock
);
1360 health_code_update();
1362 ret
= consumer_send_msg(socket
, &msg
);
1368 health_code_update();
1369 pthread_mutex_unlock(socket
->lock
);
1374 * Send a close metadata command to consumer using the given channel key.
1375 * Called with registry lock held.
1377 * Return 0 on success else a negative value.
1379 int consumer_close_metadata(struct consumer_socket
*socket
,
1380 uint64_t metadata_key
)
1383 struct lttcomm_consumer_msg msg
;
1385 LTTNG_ASSERT(socket
);
1387 DBG2("Consumer close metadata channel key %" PRIu64
, metadata_key
);
1389 memset(&msg
, 0, sizeof(msg
));
1390 msg
.cmd_type
= LTTNG_CONSUMER_CLOSE_METADATA
;
1391 msg
.u
.close_metadata
.key
= metadata_key
;
1393 pthread_mutex_lock(socket
->lock
);
1394 health_code_update();
1396 ret
= consumer_send_msg(socket
, &msg
);
1402 health_code_update();
1403 pthread_mutex_unlock(socket
->lock
);
1408 * Send a setup metdata command to consumer using the given channel key.
1410 * Return 0 on success else a negative value.
1412 int consumer_setup_metadata(struct consumer_socket
*socket
,
1413 uint64_t metadata_key
)
1416 struct lttcomm_consumer_msg msg
;
1418 LTTNG_ASSERT(socket
);
1420 DBG2("Consumer setup metadata channel key %" PRIu64
, metadata_key
);
1422 memset(&msg
, 0, sizeof(msg
));
1423 msg
.cmd_type
= LTTNG_CONSUMER_SETUP_METADATA
;
1424 msg
.u
.setup_metadata
.key
= metadata_key
;
1426 pthread_mutex_lock(socket
->lock
);
1427 health_code_update();
1429 ret
= consumer_send_msg(socket
, &msg
);
1435 health_code_update();
1436 pthread_mutex_unlock(socket
->lock
);
1441 * Send metadata string to consumer.
1442 * RCU read-side lock must be held to guarantee existence of socket.
1444 * Return 0 on success else a negative value.
1446 int consumer_push_metadata(struct consumer_socket
*socket
,
1447 uint64_t metadata_key
, char *metadata_str
, size_t len
,
1448 size_t target_offset
, uint64_t version
)
1451 struct lttcomm_consumer_msg msg
;
1453 LTTNG_ASSERT(socket
);
1455 DBG2("Consumer push metadata to consumer socket %d", *socket
->fd_ptr
);
1457 pthread_mutex_lock(socket
->lock
);
1459 memset(&msg
, 0, sizeof(msg
));
1460 msg
.cmd_type
= LTTNG_CONSUMER_PUSH_METADATA
;
1461 msg
.u
.push_metadata
.key
= metadata_key
;
1462 msg
.u
.push_metadata
.target_offset
= target_offset
;
1463 msg
.u
.push_metadata
.len
= len
;
1464 msg
.u
.push_metadata
.version
= version
;
1466 health_code_update();
1467 ret
= consumer_send_msg(socket
, &msg
);
1468 if (ret
< 0 || len
== 0) {
1472 DBG3("Consumer pushing metadata on sock %d of len %zu", *socket
->fd_ptr
,
1475 ret
= consumer_socket_send(socket
, metadata_str
, len
);
1480 health_code_update();
1481 ret
= consumer_recv_status_reply(socket
);
1487 pthread_mutex_unlock(socket
->lock
);
1488 health_code_update();
1493 * Ask the consumer to snapshot a specific channel using the key.
1495 * Returns LTTNG_OK on success or else an LTTng error code.
1497 enum lttng_error_code
consumer_snapshot_channel(struct consumer_socket
*socket
,
1498 uint64_t key
, const struct consumer_output
*output
, int metadata
,
1499 uid_t uid
, gid_t gid
, const char *channel_path
, int wait
,
1500 uint64_t nb_packets_per_stream
)
1503 enum lttng_error_code status
= LTTNG_OK
;
1504 struct lttcomm_consumer_msg msg
;
1506 LTTNG_ASSERT(socket
);
1507 LTTNG_ASSERT(output
);
1509 DBG("Consumer snapshot channel key %" PRIu64
, key
);
1511 memset(&msg
, 0, sizeof(msg
));
1512 msg
.cmd_type
= LTTNG_CONSUMER_SNAPSHOT_CHANNEL
;
1513 msg
.u
.snapshot_channel
.key
= key
;
1514 msg
.u
.snapshot_channel
.nb_packets_per_stream
= nb_packets_per_stream
;
1515 msg
.u
.snapshot_channel
.metadata
= metadata
;
1517 if (output
->type
== CONSUMER_DST_NET
) {
1518 msg
.u
.snapshot_channel
.relayd_id
=
1519 output
->net_seq_index
;
1520 msg
.u
.snapshot_channel
.use_relayd
= 1;
1522 msg
.u
.snapshot_channel
.relayd_id
= (uint64_t) -1ULL;
1524 ret
= lttng_strncpy(msg
.u
.snapshot_channel
.pathname
,
1526 sizeof(msg
.u
.snapshot_channel
.pathname
));
1528 ERR("Snapshot path exceeds the maximal allowed length of %zu bytes (%zu bytes required) with path \"%s\"",
1529 sizeof(msg
.u
.snapshot_channel
.pathname
),
1530 strlen(channel_path
),
1532 status
= LTTNG_ERR_SNAPSHOT_FAIL
;
1536 health_code_update();
1537 pthread_mutex_lock(socket
->lock
);
1538 ret
= consumer_send_msg(socket
, &msg
);
1539 pthread_mutex_unlock(socket
->lock
);
1542 case LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
:
1543 status
= LTTNG_ERR_CHAN_NOT_FOUND
;
1546 status
= LTTNG_ERR_SNAPSHOT_FAIL
;
1553 health_code_update();
1558 * Ask the consumer the number of discarded events for a channel.
1560 int consumer_get_discarded_events(uint64_t session_id
, uint64_t channel_key
,
1561 struct consumer_output
*consumer
, uint64_t *discarded
)
1564 struct consumer_socket
*socket
;
1565 struct lttng_ht_iter iter
;
1566 struct lttcomm_consumer_msg msg
;
1568 LTTNG_ASSERT(consumer
);
1570 DBG3("Consumer discarded events id %" PRIu64
, session_id
);
1572 memset(&msg
, 0, sizeof(msg
));
1573 msg
.cmd_type
= LTTNG_CONSUMER_DISCARDED_EVENTS
;
1574 msg
.u
.discarded_events
.session_id
= session_id
;
1575 msg
.u
.discarded_events
.channel_key
= channel_key
;
1579 /* Send command for each consumer */
1581 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1583 uint64_t consumer_discarded
= 0;
1584 pthread_mutex_lock(socket
->lock
);
1585 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1587 pthread_mutex_unlock(socket
->lock
);
1592 * No need for a recv reply status because the answer to the
1593 * command is the reply status message.
1595 ret
= consumer_socket_recv(socket
, &consumer_discarded
,
1596 sizeof(consumer_discarded
));
1598 ERR("get discarded events");
1599 pthread_mutex_unlock(socket
->lock
);
1602 pthread_mutex_unlock(socket
->lock
);
1603 *discarded
+= consumer_discarded
;
1606 DBG("Consumer discarded %" PRIu64
" events in session id %" PRIu64
,
1607 *discarded
, session_id
);
1615 * Ask the consumer the number of lost packets for a channel.
1617 int consumer_get_lost_packets(uint64_t session_id
, uint64_t channel_key
,
1618 struct consumer_output
*consumer
, uint64_t *lost
)
1621 struct consumer_socket
*socket
;
1622 struct lttng_ht_iter iter
;
1623 struct lttcomm_consumer_msg msg
;
1625 LTTNG_ASSERT(consumer
);
1627 DBG3("Consumer lost packets id %" PRIu64
, session_id
);
1629 memset(&msg
, 0, sizeof(msg
));
1630 msg
.cmd_type
= LTTNG_CONSUMER_LOST_PACKETS
;
1631 msg
.u
.lost_packets
.session_id
= session_id
;
1632 msg
.u
.lost_packets
.channel_key
= channel_key
;
1636 /* Send command for each consumer */
1638 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1640 uint64_t consumer_lost
= 0;
1641 pthread_mutex_lock(socket
->lock
);
1642 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1644 pthread_mutex_unlock(socket
->lock
);
1649 * No need for a recv reply status because the answer to the
1650 * command is the reply status message.
1652 ret
= consumer_socket_recv(socket
, &consumer_lost
,
1653 sizeof(consumer_lost
));
1655 ERR("get lost packets");
1656 pthread_mutex_unlock(socket
->lock
);
1659 pthread_mutex_unlock(socket
->lock
);
1660 *lost
+= consumer_lost
;
1663 DBG("Consumer lost %" PRIu64
" packets in session id %" PRIu64
,
1672 * Ask the consumer to rotate a channel.
1674 * The new_chunk_id is the session->rotate_count that has been incremented
1675 * when the rotation started. On the relay, this allows to keep track in which
1676 * chunk each stream is currently writing to (for the rotate_pending operation).
1678 int consumer_rotate_channel(struct consumer_socket
*socket
, uint64_t key
,
1679 uid_t uid
, gid_t gid
, struct consumer_output
*output
,
1680 bool is_metadata_channel
)
1683 struct lttcomm_consumer_msg msg
;
1685 LTTNG_ASSERT(socket
);
1687 DBG("Consumer rotate channel key %" PRIu64
, key
);
1689 pthread_mutex_lock(socket
->lock
);
1690 memset(&msg
, 0, sizeof(msg
));
1691 msg
.cmd_type
= LTTNG_CONSUMER_ROTATE_CHANNEL
;
1692 msg
.u
.rotate_channel
.key
= key
;
1693 msg
.u
.rotate_channel
.metadata
= !!is_metadata_channel
;
1695 if (output
->type
== CONSUMER_DST_NET
) {
1696 msg
.u
.rotate_channel
.relayd_id
= output
->net_seq_index
;
1698 msg
.u
.rotate_channel
.relayd_id
= (uint64_t) -1ULL;
1701 health_code_update();
1702 ret
= consumer_send_msg(socket
, &msg
);
1705 case LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
:
1706 ret
= -LTTNG_ERR_CHAN_NOT_FOUND
;
1709 ret
= -LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
1715 pthread_mutex_unlock(socket
->lock
);
1716 health_code_update();
1720 int consumer_open_channel_packets(struct consumer_socket
*socket
, uint64_t key
)
1723 lttcomm_consumer_msg msg
= {
1724 .cmd_type
= LTTNG_CONSUMER_OPEN_CHANNEL_PACKETS
,
1726 msg
.u
.open_channel_packets
.key
= key
;
1728 LTTNG_ASSERT(socket
);
1730 DBG("Consumer open channel packets: channel key = %" PRIu64
, key
);
1732 health_code_update();
1734 pthread_mutex_lock(socket
->lock
);
1735 ret
= consumer_send_msg(socket
, &msg
);
1736 pthread_mutex_unlock(socket
->lock
);
1742 health_code_update();
1746 int consumer_clear_channel(struct consumer_socket
*socket
, uint64_t key
)
1749 struct lttcomm_consumer_msg msg
;
1751 LTTNG_ASSERT(socket
);
1753 DBG("Consumer clear channel %" PRIu64
, key
);
1755 memset(&msg
, 0, sizeof(msg
));
1756 msg
.cmd_type
= LTTNG_CONSUMER_CLEAR_CHANNEL
;
1757 msg
.u
.clear_channel
.key
= key
;
1759 health_code_update();
1761 pthread_mutex_lock(socket
->lock
);
1762 ret
= consumer_send_msg(socket
, &msg
);
1768 pthread_mutex_unlock(socket
->lock
);
1770 health_code_update();
1774 int consumer_init(struct consumer_socket
*socket
,
1775 const lttng_uuid sessiond_uuid
)
1778 struct lttcomm_consumer_msg msg
= {
1779 .cmd_type
= LTTNG_CONSUMER_INIT
,
1782 LTTNG_ASSERT(socket
);
1784 DBG("Sending consumer initialization command");
1785 lttng_uuid_copy(msg
.u
.init
.sessiond_uuid
, sessiond_uuid
);
1787 health_code_update();
1788 ret
= consumer_send_msg(socket
, &msg
);
1794 health_code_update();
1799 * Ask the consumer to create a new chunk for a given session.
1801 * Called with the consumer socket lock held.
1803 int consumer_create_trace_chunk(struct consumer_socket
*socket
,
1804 uint64_t relayd_id
, uint64_t session_id
,
1805 struct lttng_trace_chunk
*chunk
,
1806 const char *domain_subdir
)
1809 enum lttng_trace_chunk_status chunk_status
;
1810 struct lttng_credentials chunk_credentials
;
1811 const struct lttng_directory_handle
*chunk_directory_handle
= NULL
;
1812 struct lttng_directory_handle
*domain_handle
= NULL
;
1814 const char *chunk_name
;
1815 bool chunk_name_overridden
;
1817 time_t creation_timestamp
;
1818 char creation_timestamp_buffer
[ISO8601_STR_LEN
];
1819 const char *creation_timestamp_str
= "(none)";
1820 const bool chunk_has_local_output
= relayd_id
== -1ULL;
1821 enum lttng_trace_chunk_status tc_status
;
1822 struct lttcomm_consumer_msg msg
= {
1823 .cmd_type
= LTTNG_CONSUMER_CREATE_TRACE_CHUNK
,
1825 msg
.u
.create_trace_chunk
.session_id
= session_id
;
1827 LTTNG_ASSERT(socket
);
1828 LTTNG_ASSERT(chunk
);
1830 if (relayd_id
!= -1ULL) {
1831 LTTNG_OPTIONAL_SET(&msg
.u
.create_trace_chunk
.relayd_id
,
1835 chunk_status
= lttng_trace_chunk_get_name(chunk
, &chunk_name
,
1836 &chunk_name_overridden
);
1837 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
&&
1838 chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_NONE
) {
1839 ERR("Failed to get name of trace chunk");
1840 ret
= -LTTNG_ERR_FATAL
;
1843 if (chunk_name_overridden
) {
1844 ret
= lttng_strncpy(msg
.u
.create_trace_chunk
.override_name
,
1846 sizeof(msg
.u
.create_trace_chunk
.override_name
));
1848 ERR("Trace chunk name \"%s\" exceeds the maximal length allowed by the consumer protocol",
1850 ret
= -LTTNG_ERR_FATAL
;
1855 chunk_status
= lttng_trace_chunk_get_creation_timestamp(chunk
,
1856 &creation_timestamp
);
1857 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1858 ret
= -LTTNG_ERR_FATAL
;
1861 msg
.u
.create_trace_chunk
.creation_timestamp
=
1862 (uint64_t) creation_timestamp
;
1863 /* Only used for logging purposes. */
1864 ret
= time_to_iso8601_str(creation_timestamp
,
1865 creation_timestamp_buffer
,
1866 sizeof(creation_timestamp_buffer
));
1867 creation_timestamp_str
= !ret
? creation_timestamp_buffer
:
1868 "(formatting error)";
1870 chunk_status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1871 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1873 * Anonymous trace chunks should never be transmitted
1874 * to remote peers (consumerd and relayd). They are used
1875 * internally for backward-compatibility purposes.
1877 ret
= -LTTNG_ERR_FATAL
;
1880 msg
.u
.create_trace_chunk
.chunk_id
= chunk_id
;
1882 if (chunk_has_local_output
) {
1883 chunk_status
= lttng_trace_chunk_borrow_chunk_directory_handle(
1884 chunk
, &chunk_directory_handle
);
1885 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1886 ret
= -LTTNG_ERR_FATAL
;
1889 chunk_status
= lttng_trace_chunk_get_credentials(
1890 chunk
, &chunk_credentials
);
1891 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1893 * Not associating credentials to a sessiond chunk is a
1894 * fatal internal error.
1896 ret
= -LTTNG_ERR_FATAL
;
1899 tc_status
= lttng_trace_chunk_create_subdirectory(
1900 chunk
, domain_subdir
);
1901 if (tc_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1902 PERROR("Failed to create chunk domain output directory \"%s\"",
1904 ret
= -LTTNG_ERR_FATAL
;
1907 domain_handle
= lttng_directory_handle_create_from_handle(
1909 chunk_directory_handle
);
1910 if (!domain_handle
) {
1911 ret
= -LTTNG_ERR_FATAL
;
1916 * This will only compile on platforms that support
1917 * dirfd (POSIX.2008). This is fine as the session daemon
1918 * is only built for such platforms.
1920 * The ownership of the chunk directory handle's is maintained
1921 * by the trace chunk.
1923 domain_dirfd
= lttng_directory_handle_get_dirfd(
1925 LTTNG_ASSERT(domain_dirfd
>= 0);
1927 msg
.u
.create_trace_chunk
.credentials
.value
.uid
=
1928 lttng_credentials_get_uid(&chunk_credentials
);
1929 msg
.u
.create_trace_chunk
.credentials
.value
.gid
=
1930 lttng_credentials_get_gid(&chunk_credentials
);
1931 msg
.u
.create_trace_chunk
.credentials
.is_set
= 1;
1934 DBG("Sending consumer create trace chunk command: relayd_id = %" PRId64
1935 ", session_id = %" PRIu64
", chunk_id = %" PRIu64
1936 ", creation_timestamp = %s",
1937 relayd_id
, session_id
, chunk_id
,
1938 creation_timestamp_str
);
1939 health_code_update();
1940 ret
= consumer_send_msg(socket
, &msg
);
1941 health_code_update();
1943 ERR("Trace chunk creation error on consumer");
1944 ret
= -LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
1948 if (chunk_has_local_output
) {
1949 DBG("Sending trace chunk domain directory fd to consumer");
1950 health_code_update();
1951 ret
= consumer_send_fds(socket
, &domain_dirfd
, 1);
1952 health_code_update();
1954 ERR("Trace chunk creation error on consumer");
1955 ret
= -LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
1960 lttng_directory_handle_put(domain_handle
);
1965 * Ask the consumer to close a trace chunk for a given session.
1967 * Called with the consumer socket lock held.
1969 int consumer_close_trace_chunk(struct consumer_socket
*socket
,
1970 uint64_t relayd_id
, uint64_t session_id
,
1971 struct lttng_trace_chunk
*chunk
,
1972 char *closed_trace_chunk_path
)
1975 enum lttng_trace_chunk_status chunk_status
;
1976 lttcomm_consumer_msg msg
= {
1977 .cmd_type
= LTTNG_CONSUMER_CLOSE_TRACE_CHUNK
,
1979 msg
.u
.close_trace_chunk
.session_id
= session_id
;
1981 struct lttcomm_consumer_close_trace_chunk_reply reply
;
1983 time_t close_timestamp
;
1984 enum lttng_trace_chunk_command_type close_command
;
1985 const char *close_command_name
= "none";
1986 struct lttng_dynamic_buffer path_reception_buffer
;
1988 LTTNG_ASSERT(socket
);
1989 lttng_dynamic_buffer_init(&path_reception_buffer
);
1991 if (relayd_id
!= -1ULL) {
1993 &msg
.u
.close_trace_chunk
.relayd_id
, relayd_id
);
1996 chunk_status
= lttng_trace_chunk_get_close_command(
1997 chunk
, &close_command
);
1998 switch (chunk_status
) {
1999 case LTTNG_TRACE_CHUNK_STATUS_OK
:
2000 LTTNG_OPTIONAL_SET(&msg
.u
.close_trace_chunk
.close_command
,
2001 (uint32_t) close_command
);
2003 case LTTNG_TRACE_CHUNK_STATUS_NONE
:
2006 ERR("Failed to get trace chunk close command");
2011 chunk_status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
2013 * Anonymous trace chunks should never be transmitted to remote peers
2014 * (consumerd and relayd). They are used internally for
2015 * backward-compatibility purposes.
2017 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
2018 msg
.u
.close_trace_chunk
.chunk_id
= chunk_id
;
2020 chunk_status
= lttng_trace_chunk_get_close_timestamp(chunk
,
2023 * A trace chunk should be closed locally before being closed remotely.
2024 * Otherwise, the close timestamp would never be transmitted to the
2027 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
2028 msg
.u
.close_trace_chunk
.close_timestamp
= (uint64_t) close_timestamp
;
2030 if (msg
.u
.close_trace_chunk
.close_command
.is_set
) {
2031 close_command_name
= lttng_trace_chunk_command_type_get_name(
2034 DBG("Sending consumer close trace chunk command: relayd_id = %" PRId64
2035 ", session_id = %" PRIu64
", chunk_id = %" PRIu64
2036 ", close command = \"%s\"",
2037 relayd_id
, session_id
, chunk_id
, close_command_name
);
2039 health_code_update();
2040 ret
= consumer_socket_send(socket
, &msg
, sizeof(struct lttcomm_consumer_msg
));
2042 ret
= -LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
2045 ret
= consumer_socket_recv(socket
, &reply
, sizeof(reply
));
2047 ret
= -LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
2050 if (reply
.path_length
>= LTTNG_PATH_MAX
) {
2051 ERR("Invalid path returned by relay daemon: %" PRIu32
"bytes exceeds maximal allowed length of %d bytes",
2052 reply
.path_length
, LTTNG_PATH_MAX
);
2053 ret
= -LTTNG_ERR_INVALID_PROTOCOL
;
2056 ret
= lttng_dynamic_buffer_set_size(&path_reception_buffer
,
2059 ERR("Failed to allocate reception buffer of path returned by the \"close trace chunk\" command");
2060 ret
= -LTTNG_ERR_NOMEM
;
2063 ret
= consumer_socket_recv(socket
, path_reception_buffer
.data
,
2064 path_reception_buffer
.size
);
2066 ERR("Communication error while receiving path of closed trace chunk");
2067 ret
= -LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
2070 if (path_reception_buffer
.data
[path_reception_buffer
.size
- 1] != '\0') {
2071 ERR("Invalid path returned by relay daemon: not null-terminated");
2072 ret
= -LTTNG_ERR_INVALID_PROTOCOL
;
2075 if (closed_trace_chunk_path
) {
2077 * closed_trace_chunk_path is assumed to have a length >=
2080 memcpy(closed_trace_chunk_path
, path_reception_buffer
.data
,
2081 path_reception_buffer
.size
);
2084 lttng_dynamic_buffer_reset(&path_reception_buffer
);
2085 health_code_update();
2090 * Ask the consumer if a trace chunk exists.
2092 * Called with the consumer socket lock held.
2093 * Returns 0 on success, or a negative value on error.
2095 int consumer_trace_chunk_exists(struct consumer_socket
*socket
,
2096 uint64_t relayd_id
, uint64_t session_id
,
2097 struct lttng_trace_chunk
*chunk
,
2098 enum consumer_trace_chunk_exists_status
*result
)
2101 enum lttng_trace_chunk_status chunk_status
;
2102 lttcomm_consumer_msg msg
= {
2103 .cmd_type
= LTTNG_CONSUMER_TRACE_CHUNK_EXISTS
,
2105 msg
.u
.trace_chunk_exists
.session_id
= session_id
;
2108 const char *consumer_reply_str
;
2110 LTTNG_ASSERT(socket
);
2112 if (relayd_id
!= -1ULL) {
2113 LTTNG_OPTIONAL_SET(&msg
.u
.trace_chunk_exists
.relayd_id
,
2117 chunk_status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
2118 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2120 * Anonymous trace chunks should never be transmitted
2121 * to remote peers (consumerd and relayd). They are used
2122 * internally for backward-compatibility purposes.
2124 ret
= -LTTNG_ERR_FATAL
;
2127 msg
.u
.trace_chunk_exists
.chunk_id
= chunk_id
;
2129 DBG("Sending consumer trace chunk exists command: relayd_id = %" PRId64
2130 ", session_id = %" PRIu64
2131 ", chunk_id = %" PRIu64
, relayd_id
, session_id
, chunk_id
);
2133 health_code_update();
2134 ret
= consumer_send_msg(socket
, &msg
);
2136 case LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
:
2137 consumer_reply_str
= "unknown trace chunk";
2138 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_UNKNOWN_CHUNK
;
2140 case LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL
:
2141 consumer_reply_str
= "trace chunk exists locally";
2142 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_EXISTS_LOCAL
;
2144 case LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE
:
2145 consumer_reply_str
= "trace chunk exists on remote peer";
2146 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_EXISTS_REMOTE
;
2149 ERR("Consumer returned an error from TRACE_CHUNK_EXISTS command");
2153 DBG("Consumer reply to TRACE_CHUNK_EXISTS command: %s",
2154 consumer_reply_str
);
2157 health_code_update();