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 * Should *NOT* be called with RCU read-side lock held.
560 static void consumer_release_output(struct urcu_ref
*ref
)
562 struct consumer_output
*obj
=
563 caa_container_of(ref
, struct consumer_output
, ref
);
565 consumer_destroy_output_sockets(obj
);
568 /* Finally destroy HT */
569 ht_cleanup_push(obj
->socks
);
576 * Get the consumer_output object.
578 void consumer_output_get(struct consumer_output
*obj
)
580 urcu_ref_get(&obj
->ref
);
584 * Put the consumer_output object.
586 * Should *NOT* be called with RCU read-side lock held.
588 void consumer_output_put(struct consumer_output
*obj
)
593 urcu_ref_put(&obj
->ref
, consumer_release_output
);
597 * Copy consumer output and returned the newly allocated copy.
599 * Should *NOT* be called with RCU read-side lock held.
601 struct consumer_output
*consumer_copy_output(struct consumer_output
*src
)
604 struct consumer_output
*output
;
608 output
= consumer_create_output(src
->type
);
609 if (output
== NULL
) {
612 output
->enabled
= src
->enabled
;
613 output
->net_seq_index
= src
->net_seq_index
;
614 memcpy(output
->domain_subdir
, src
->domain_subdir
,
615 sizeof(output
->domain_subdir
));
616 output
->snapshot
= src
->snapshot
;
617 output
->relay_major_version
= src
->relay_major_version
;
618 output
->relay_minor_version
= src
->relay_minor_version
;
619 output
->relay_allows_clear
= src
->relay_allows_clear
;
620 memcpy(&output
->dst
, &src
->dst
, sizeof(output
->dst
));
621 ret
= consumer_copy_sockets(output
, src
);
629 consumer_output_put(output
);
634 * Copy consumer sockets from src to dst.
636 * Return 0 on success or else a negative value.
638 int consumer_copy_sockets(struct consumer_output
*dst
,
639 struct consumer_output
*src
)
642 struct lttng_ht_iter iter
;
643 struct consumer_socket
*socket
, *copy_sock
;
649 cds_lfht_for_each_entry(src
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
650 /* Ignore socket that are already there. */
651 copy_sock
= consumer_find_socket(*socket
->fd_ptr
, dst
);
656 /* Create new socket object. */
657 copy_sock
= consumer_allocate_socket(socket
->fd_ptr
);
658 if (copy_sock
== NULL
) {
664 copy_sock
->registered
= socket
->registered
;
666 * This is valid because this lock is shared accross all consumer
667 * object being the global lock of the consumer data structure of the
670 copy_sock
->lock
= socket
->lock
;
671 consumer_add_socket(copy_sock
, dst
);
680 * Set network URI to the consumer output.
682 * Return 0 on success. Return 1 if the URI were equal. Else, negative value on
685 int consumer_set_network_uri(const struct ltt_session
*session
,
686 struct consumer_output
*output
,
687 struct lttng_uri
*uri
)
690 struct lttng_uri
*dst_uri
= NULL
;
692 /* Code flow error safety net. */
693 LTTNG_ASSERT(output
);
696 switch (uri
->stype
) {
697 case LTTNG_STREAM_CONTROL
:
698 dst_uri
= &output
->dst
.net
.control
;
699 output
->dst
.net
.control_isset
= 1;
700 if (uri
->port
== 0) {
701 /* Assign default port. */
702 uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
704 if (output
->dst
.net
.data_isset
&& uri
->port
==
705 output
->dst
.net
.data
.port
) {
706 ret
= -LTTNG_ERR_INVALID
;
710 DBG3("Consumer control URI set with port %d", uri
->port
);
712 case LTTNG_STREAM_DATA
:
713 dst_uri
= &output
->dst
.net
.data
;
714 output
->dst
.net
.data_isset
= 1;
715 if (uri
->port
== 0) {
716 /* Assign default port. */
717 uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
719 if (output
->dst
.net
.control_isset
&& uri
->port
==
720 output
->dst
.net
.control
.port
) {
721 ret
= -LTTNG_ERR_INVALID
;
725 DBG3("Consumer data URI set with port %d", uri
->port
);
728 ERR("Set network uri type unknown %d", uri
->stype
);
729 ret
= -LTTNG_ERR_INVALID
;
733 ret
= uri_compare(dst_uri
, uri
);
735 /* Same URI, don't touch it and return success. */
736 DBG3("URI network compare are the same");
740 /* URIs were not equal, replacing it. */
741 memcpy(dst_uri
, uri
, sizeof(struct lttng_uri
));
742 output
->type
= CONSUMER_DST_NET
;
743 if (dst_uri
->stype
!= LTTNG_STREAM_CONTROL
) {
744 /* Only the control uri needs to contain the path. */
749 * If the user has specified a subdir as part of the control
750 * URL, the session's base output directory is:
751 * /RELAYD_OUTPUT_PATH/HOSTNAME/USER_SPECIFIED_DIR
753 * Hence, the "base_dir" from which all stream files and
754 * session rotation chunks are created takes the form
755 * /HOSTNAME/USER_SPECIFIED_DIR
757 * If the user has not specified an output directory as part of
758 * the control URL, the base output directory has the form:
759 * /RELAYD_OUTPUT_PATH/HOSTNAME/SESSION_NAME-CREATION_TIME
761 * Hence, the "base_dir" from which all stream files and
762 * session rotation chunks are created takes the form
763 * /HOSTNAME/SESSION_NAME-CREATION_TIME
765 * Note that automatically generated session names already
766 * contain the session's creation time. In that case, the
767 * creation time is omitted to prevent it from being duplicated
768 * in the final directory hierarchy.
771 if (strstr(uri
->subdir
, "../")) {
772 ERR("Network URI subdirs are not allowed to walk up the path hierarchy");
773 ret
= -LTTNG_ERR_INVALID
;
776 ret
= snprintf(output
->dst
.net
.base_dir
,
777 sizeof(output
->dst
.net
.base_dir
),
778 "/%s/%s/", session
->hostname
, uri
->subdir
);
780 if (session
->has_auto_generated_name
) {
781 ret
= snprintf(output
->dst
.net
.base_dir
,
782 sizeof(output
->dst
.net
.base_dir
),
783 "/%s/%s/", session
->hostname
,
786 char session_creation_datetime
[16];
790 timeinfo
= localtime(&session
->creation_time
);
792 ret
= -LTTNG_ERR_FATAL
;
795 strftime_ret
= strftime(session_creation_datetime
,
796 sizeof(session_creation_datetime
),
797 "%Y%m%d-%H%M%S", timeinfo
);
798 if (strftime_ret
== 0) {
799 ERR("Failed to format session creation timestamp while setting network URI");
800 ret
= -LTTNG_ERR_FATAL
;
803 ret
= snprintf(output
->dst
.net
.base_dir
,
804 sizeof(output
->dst
.net
.base_dir
),
805 "/%s/%s-%s/", session
->hostname
,
807 session_creation_datetime
);
810 if (ret
>= sizeof(output
->dst
.net
.base_dir
)) {
811 ret
= -LTTNG_ERR_INVALID
;
812 ERR("Truncation occurred while setting network output base directory");
814 } else if (ret
== -1) {
815 ret
= -LTTNG_ERR_INVALID
;
816 PERROR("Error occurred while setting network output base directory");
820 DBG3("Consumer set network uri base_dir path %s",
821 output
->dst
.net
.base_dir
);
832 * Send file descriptor to consumer via sock.
834 * The consumer socket lock must be held by the caller.
836 int consumer_send_fds(struct consumer_socket
*sock
, const int *fds
,
843 LTTNG_ASSERT(nb_fd
> 0);
844 LTTNG_ASSERT(pthread_mutex_trylock(sock
->lock
) == EBUSY
);
846 ret
= lttcomm_send_fds_unix_sock(*sock
->fd_ptr
, fds
, nb_fd
);
848 /* The above call will print a PERROR on error. */
849 DBG("Error when sending consumer fds on sock %d", *sock
->fd_ptr
);
853 ret
= consumer_recv_status_reply(sock
);
859 * Consumer send communication message structure to consumer.
861 * The consumer socket lock must be held by the caller.
863 int consumer_send_msg(struct consumer_socket
*sock
,
864 const struct lttcomm_consumer_msg
*msg
)
870 LTTNG_ASSERT(pthread_mutex_trylock(sock
->lock
) == EBUSY
);
872 ret
= consumer_socket_send(sock
, msg
, sizeof(struct lttcomm_consumer_msg
));
877 ret
= consumer_recv_status_reply(sock
);
884 * Consumer send channel communication message structure to consumer.
886 * The consumer socket lock must be held by the caller.
888 int consumer_send_channel(struct consumer_socket
*sock
,
889 struct lttcomm_consumer_msg
*msg
)
896 ret
= consumer_send_msg(sock
, msg
);
906 * Populate the given consumer msg structure with the ask_channel command
909 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
910 uint64_t subbuf_size
,
913 unsigned int switch_timer_interval
,
914 unsigned int read_timer_interval
,
915 unsigned int live_timer_interval
,
916 bool is_in_live_session
,
917 unsigned int monitor_timer_interval
,
921 const char *pathname
,
927 uint64_t tracefile_size
,
928 uint64_t tracefile_count
,
929 uint64_t session_id_per_pid
,
930 unsigned int monitor
,
931 uint32_t ust_app_uid
,
932 int64_t blocking_timeout
,
933 const char *root_shm_path
,
934 const char *shm_path
,
935 struct lttng_trace_chunk
*trace_chunk
,
936 const struct lttng_credentials
*buffer_credentials
)
940 /* Zeroed structure */
941 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
942 msg
->u
.ask_channel
.buffer_credentials
.uid
= UINT32_MAX
;
943 msg
->u
.ask_channel
.buffer_credentials
.gid
= UINT32_MAX
;
947 enum lttng_trace_chunk_status chunk_status
;
949 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
, &chunk_id
);
950 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
951 LTTNG_OPTIONAL_SET(&msg
->u
.ask_channel
.chunk_id
, chunk_id
);
953 msg
->u
.ask_channel
.buffer_credentials
.uid
=
954 lttng_credentials_get_uid(buffer_credentials
);
955 msg
->u
.ask_channel
.buffer_credentials
.gid
=
956 lttng_credentials_get_gid(buffer_credentials
);
958 msg
->cmd_type
= LTTNG_CONSUMER_ASK_CHANNEL_CREATION
;
959 msg
->u
.ask_channel
.subbuf_size
= subbuf_size
;
960 msg
->u
.ask_channel
.num_subbuf
= num_subbuf
;
961 msg
->u
.ask_channel
.overwrite
= overwrite
;
962 msg
->u
.ask_channel
.switch_timer_interval
= switch_timer_interval
;
963 msg
->u
.ask_channel
.read_timer_interval
= read_timer_interval
;
964 msg
->u
.ask_channel
.live_timer_interval
= live_timer_interval
;
965 msg
->u
.ask_channel
.is_live
= is_in_live_session
;
966 msg
->u
.ask_channel
.monitor_timer_interval
= monitor_timer_interval
;
967 msg
->u
.ask_channel
.output
= output
;
968 msg
->u
.ask_channel
.type
= type
;
969 msg
->u
.ask_channel
.session_id
= session_id
;
970 msg
->u
.ask_channel
.session_id_per_pid
= session_id_per_pid
;
971 msg
->u
.ask_channel
.relayd_id
= relayd_id
;
972 msg
->u
.ask_channel
.key
= key
;
973 msg
->u
.ask_channel
.chan_id
= chan_id
;
974 msg
->u
.ask_channel
.tracefile_size
= tracefile_size
;
975 msg
->u
.ask_channel
.tracefile_count
= tracefile_count
;
976 msg
->u
.ask_channel
.monitor
= monitor
;
977 msg
->u
.ask_channel
.ust_app_uid
= ust_app_uid
;
978 msg
->u
.ask_channel
.blocking_timeout
= blocking_timeout
;
980 memcpy(msg
->u
.ask_channel
.uuid
, uuid
, sizeof(msg
->u
.ask_channel
.uuid
));
983 strncpy(msg
->u
.ask_channel
.pathname
, pathname
,
984 sizeof(msg
->u
.ask_channel
.pathname
));
985 msg
->u
.ask_channel
.pathname
[sizeof(msg
->u
.ask_channel
.pathname
)-1] = '\0';
988 strncpy(msg
->u
.ask_channel
.name
, name
, sizeof(msg
->u
.ask_channel
.name
));
989 msg
->u
.ask_channel
.name
[sizeof(msg
->u
.ask_channel
.name
) - 1] = '\0';
992 strncpy(msg
->u
.ask_channel
.root_shm_path
, root_shm_path
,
993 sizeof(msg
->u
.ask_channel
.root_shm_path
));
994 msg
->u
.ask_channel
.root_shm_path
[sizeof(msg
->u
.ask_channel
.root_shm_path
) - 1] = '\0';
997 strncpy(msg
->u
.ask_channel
.shm_path
, shm_path
,
998 sizeof(msg
->u
.ask_channel
.shm_path
));
999 msg
->u
.ask_channel
.shm_path
[sizeof(msg
->u
.ask_channel
.shm_path
) - 1] = '\0';
1004 * Init channel communication message structure.
1006 void consumer_init_add_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
1007 uint64_t channel_key
,
1008 uint64_t session_id
,
1009 const char *pathname
,
1014 unsigned int nb_init_streams
,
1015 enum lttng_event_output output
,
1017 uint64_t tracefile_size
,
1018 uint64_t tracefile_count
,
1019 unsigned int monitor
,
1020 unsigned int live_timer_interval
,
1021 bool is_in_live_session
,
1022 unsigned int monitor_timer_interval
,
1023 struct lttng_trace_chunk
*trace_chunk
)
1027 /* Zeroed structure */
1028 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1032 enum lttng_trace_chunk_status chunk_status
;
1034 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
, &chunk_id
);
1035 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
1036 LTTNG_OPTIONAL_SET(&msg
->u
.channel
.chunk_id
, chunk_id
);
1040 msg
->cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
1041 msg
->u
.channel
.channel_key
= channel_key
;
1042 msg
->u
.channel
.session_id
= session_id
;
1043 msg
->u
.channel
.relayd_id
= relayd_id
;
1044 msg
->u
.channel
.nb_init_streams
= nb_init_streams
;
1045 msg
->u
.channel
.output
= output
;
1046 msg
->u
.channel
.type
= type
;
1047 msg
->u
.channel
.tracefile_size
= tracefile_size
;
1048 msg
->u
.channel
.tracefile_count
= tracefile_count
;
1049 msg
->u
.channel
.monitor
= monitor
;
1050 msg
->u
.channel
.live_timer_interval
= live_timer_interval
;
1051 msg
->u
.channel
.is_live
= is_in_live_session
;
1052 msg
->u
.channel
.monitor_timer_interval
= monitor_timer_interval
;
1054 strncpy(msg
->u
.channel
.pathname
, pathname
,
1055 sizeof(msg
->u
.channel
.pathname
));
1056 msg
->u
.channel
.pathname
[sizeof(msg
->u
.channel
.pathname
) - 1] = '\0';
1058 strncpy(msg
->u
.channel
.name
, name
, sizeof(msg
->u
.channel
.name
));
1059 msg
->u
.channel
.name
[sizeof(msg
->u
.channel
.name
) - 1] = '\0';
1063 * Init stream communication message structure.
1065 void consumer_init_add_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
1066 uint64_t channel_key
,
1067 uint64_t stream_key
,
1072 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1074 msg
->cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
1075 msg
->u
.stream
.channel_key
= channel_key
;
1076 msg
->u
.stream
.stream_key
= stream_key
;
1077 msg
->u
.stream
.cpu
= cpu
;
1080 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg
*msg
,
1081 enum lttng_consumer_command cmd
,
1082 uint64_t channel_key
, uint64_t net_seq_idx
)
1086 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1088 msg
->cmd_type
= cmd
;
1089 msg
->u
.sent_streams
.channel_key
= channel_key
;
1090 msg
->u
.sent_streams
.net_seq_idx
= net_seq_idx
;
1094 * Send stream communication structure to the consumer.
1096 int consumer_send_stream(struct consumer_socket
*sock
,
1097 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
1098 const int *fds
, size_t nb_fd
)
1107 ret
= consumer_send_msg(sock
, msg
);
1112 ret
= consumer_send_fds(sock
, fds
, nb_fd
);
1122 * Send relayd socket to consumer associated with a session name.
1124 * The consumer socket lock must be held by the caller.
1126 * On success return positive value. On error, negative value.
1128 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
1129 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
1130 enum lttng_stream_type type
, uint64_t session_id
,
1131 const char *session_name
, const char *hostname
,
1132 const char *base_path
, int session_live_timer
,
1133 const uint64_t *current_chunk_id
, time_t session_creation_time
,
1134 bool session_name_contains_creation_time
)
1138 struct lttcomm_consumer_msg msg
;
1140 /* Code flow error. Safety net. */
1141 LTTNG_ASSERT(rsock
);
1142 LTTNG_ASSERT(consumer
);
1143 LTTNG_ASSERT(consumer_sock
);
1145 memset(&msg
, 0, sizeof(msg
));
1146 /* Bail out if consumer is disabled */
1147 if (!consumer
->enabled
) {
1152 if (type
== LTTNG_STREAM_CONTROL
) {
1153 char output_path
[LTTNG_PATH_MAX
] = {};
1154 uint64_t relayd_session_id
;
1156 ret
= relayd_create_session(rsock
, &relayd_session_id
,
1157 session_name
, hostname
, base_path
,
1158 session_live_timer
, consumer
->snapshot
,
1159 session_id
, the_sessiond_uuid
, current_chunk_id
,
1160 session_creation_time
,
1161 session_name_contains_creation_time
,
1164 /* Close the control socket. */
1165 (void) relayd_close(rsock
);
1168 msg
.u
.relayd_sock
.relayd_session_id
= relayd_session_id
;
1169 DBG("Created session on relay, output path reply: %s",
1173 msg
.cmd_type
= LTTNG_CONSUMER_ADD_RELAYD_SOCKET
;
1175 * Assign network consumer output index using the temporary consumer since
1176 * this call should only be made from within a set_consumer_uri() function
1177 * call in the session daemon.
1179 msg
.u
.relayd_sock
.net_index
= consumer
->net_seq_index
;
1180 msg
.u
.relayd_sock
.type
= type
;
1181 msg
.u
.relayd_sock
.session_id
= session_id
;
1182 memcpy(&msg
.u
.relayd_sock
.sock
, rsock
, sizeof(msg
.u
.relayd_sock
.sock
));
1184 DBG3("Sending relayd sock info to consumer on %d", *consumer_sock
->fd_ptr
);
1185 ret
= consumer_send_msg(consumer_sock
, &msg
);
1190 DBG3("Sending relayd socket file descriptor to consumer");
1191 fd
= rsock
->sock
.fd
;
1192 ret
= consumer_send_fds(consumer_sock
, &fd
, 1);
1197 DBG2("Consumer relayd socket sent");
1204 int consumer_send_pipe(struct consumer_socket
*consumer_sock
,
1205 enum lttng_consumer_command cmd
, int pipe
)
1208 struct lttcomm_consumer_msg msg
;
1209 const char *pipe_name
;
1210 const char *command_name
;
1213 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1214 pipe_name
= "channel monitor";
1215 command_name
= "SET_CHANNEL_MONITOR_PIPE";
1218 ERR("Unexpected command received in %s (cmd = %d)", __func__
,
1223 /* Code flow error. Safety net. */
1225 memset(&msg
, 0, sizeof(msg
));
1228 pthread_mutex_lock(consumer_sock
->lock
);
1229 DBG3("Sending %s command to consumer", command_name
);
1230 ret
= consumer_send_msg(consumer_sock
, &msg
);
1235 DBG3("Sending %s pipe %d to consumer on socket %d",
1237 pipe
, *consumer_sock
->fd_ptr
);
1238 ret
= consumer_send_fds(consumer_sock
, &pipe
, 1);
1243 DBG2("%s pipe successfully sent", pipe_name
);
1245 pthread_mutex_unlock(consumer_sock
->lock
);
1249 int consumer_send_channel_monitor_pipe(struct consumer_socket
*consumer_sock
,
1252 return consumer_send_pipe(consumer_sock
,
1253 LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
, pipe
);
1257 * Ask the consumer if the data is pending for the specific session id.
1258 * Returns 1 if data is pending, 0 otherwise, or < 0 on error.
1260 int consumer_is_data_pending(uint64_t session_id
,
1261 struct consumer_output
*consumer
)
1264 int32_t ret_code
= 0; /* Default is that the data is NOT pending */
1265 struct consumer_socket
*socket
;
1266 struct lttng_ht_iter iter
;
1267 struct lttcomm_consumer_msg msg
;
1269 LTTNG_ASSERT(consumer
);
1271 DBG3("Consumer data pending for id %" PRIu64
, session_id
);
1273 memset(&msg
, 0, sizeof(msg
));
1274 msg
.cmd_type
= LTTNG_CONSUMER_DATA_PENDING
;
1275 msg
.u
.data_pending
.session_id
= session_id
;
1277 /* Send command for each consumer */
1279 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1281 pthread_mutex_lock(socket
->lock
);
1282 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1284 pthread_mutex_unlock(socket
->lock
);
1289 * No need for a recv reply status because the answer to the command is
1290 * the reply status message.
1293 ret
= consumer_socket_recv(socket
, &ret_code
, sizeof(ret_code
));
1295 pthread_mutex_unlock(socket
->lock
);
1298 pthread_mutex_unlock(socket
->lock
);
1300 if (ret_code
== 1) {
1306 DBG("Consumer data is %s pending for session id %" PRIu64
,
1307 ret_code
== 1 ? "" : "NOT", session_id
);
1316 * Send a flush command to consumer using the given channel key.
1318 * Return 0 on success else a negative value.
1320 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
)
1323 struct lttcomm_consumer_msg msg
;
1325 LTTNG_ASSERT(socket
);
1327 DBG2("Consumer flush channel key %" PRIu64
, key
);
1329 memset(&msg
, 0, sizeof(msg
));
1330 msg
.cmd_type
= LTTNG_CONSUMER_FLUSH_CHANNEL
;
1331 msg
.u
.flush_channel
.key
= key
;
1333 pthread_mutex_lock(socket
->lock
);
1334 health_code_update();
1336 ret
= consumer_send_msg(socket
, &msg
);
1342 health_code_update();
1343 pthread_mutex_unlock(socket
->lock
);
1348 * Send a clear quiescent command to consumer using the given channel key.
1350 * Return 0 on success else a negative value.
1352 int consumer_clear_quiescent_channel(struct consumer_socket
*socket
, uint64_t key
)
1355 struct lttcomm_consumer_msg msg
;
1357 LTTNG_ASSERT(socket
);
1359 DBG2("Consumer clear quiescent channel key %" PRIu64
, key
);
1361 memset(&msg
, 0, sizeof(msg
));
1362 msg
.cmd_type
= LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
;
1363 msg
.u
.clear_quiescent_channel
.key
= key
;
1365 pthread_mutex_lock(socket
->lock
);
1366 health_code_update();
1368 ret
= consumer_send_msg(socket
, &msg
);
1374 health_code_update();
1375 pthread_mutex_unlock(socket
->lock
);
1380 * Send a close metadata command to consumer using the given channel key.
1381 * Called with registry lock held.
1383 * Return 0 on success else a negative value.
1385 int consumer_close_metadata(struct consumer_socket
*socket
,
1386 uint64_t metadata_key
)
1389 struct lttcomm_consumer_msg msg
;
1391 LTTNG_ASSERT(socket
);
1393 DBG2("Consumer close metadata channel key %" PRIu64
, metadata_key
);
1395 memset(&msg
, 0, sizeof(msg
));
1396 msg
.cmd_type
= LTTNG_CONSUMER_CLOSE_METADATA
;
1397 msg
.u
.close_metadata
.key
= metadata_key
;
1399 pthread_mutex_lock(socket
->lock
);
1400 health_code_update();
1402 ret
= consumer_send_msg(socket
, &msg
);
1408 health_code_update();
1409 pthread_mutex_unlock(socket
->lock
);
1414 * Send a setup metdata command to consumer using the given channel key.
1416 * Return 0 on success else a negative value.
1418 int consumer_setup_metadata(struct consumer_socket
*socket
,
1419 uint64_t metadata_key
)
1422 struct lttcomm_consumer_msg msg
;
1424 LTTNG_ASSERT(socket
);
1426 DBG2("Consumer setup metadata channel key %" PRIu64
, metadata_key
);
1428 memset(&msg
, 0, sizeof(msg
));
1429 msg
.cmd_type
= LTTNG_CONSUMER_SETUP_METADATA
;
1430 msg
.u
.setup_metadata
.key
= metadata_key
;
1432 pthread_mutex_lock(socket
->lock
);
1433 health_code_update();
1435 ret
= consumer_send_msg(socket
, &msg
);
1441 health_code_update();
1442 pthread_mutex_unlock(socket
->lock
);
1447 * Send metadata string to consumer.
1448 * RCU read-side lock must be held to guarantee existence of socket.
1450 * Return 0 on success else a negative value.
1452 int consumer_push_metadata(struct consumer_socket
*socket
,
1453 uint64_t metadata_key
, char *metadata_str
, size_t len
,
1454 size_t target_offset
, uint64_t version
)
1457 struct lttcomm_consumer_msg msg
;
1459 LTTNG_ASSERT(socket
);
1461 DBG2("Consumer push metadata to consumer socket %d", *socket
->fd_ptr
);
1463 pthread_mutex_lock(socket
->lock
);
1465 memset(&msg
, 0, sizeof(msg
));
1466 msg
.cmd_type
= LTTNG_CONSUMER_PUSH_METADATA
;
1467 msg
.u
.push_metadata
.key
= metadata_key
;
1468 msg
.u
.push_metadata
.target_offset
= target_offset
;
1469 msg
.u
.push_metadata
.len
= len
;
1470 msg
.u
.push_metadata
.version
= version
;
1472 health_code_update();
1473 ret
= consumer_send_msg(socket
, &msg
);
1474 if (ret
< 0 || len
== 0) {
1478 DBG3("Consumer pushing metadata on sock %d of len %zu", *socket
->fd_ptr
,
1481 ret
= consumer_socket_send(socket
, metadata_str
, len
);
1486 health_code_update();
1487 ret
= consumer_recv_status_reply(socket
);
1493 pthread_mutex_unlock(socket
->lock
);
1494 health_code_update();
1499 * Ask the consumer to snapshot a specific channel using the key.
1501 * Returns LTTNG_OK on success or else an LTTng error code.
1503 enum lttng_error_code
consumer_snapshot_channel(struct consumer_socket
*socket
,
1504 uint64_t key
, const struct consumer_output
*output
, int metadata
,
1505 uid_t uid
, gid_t gid
, const char *channel_path
, int wait
,
1506 uint64_t nb_packets_per_stream
)
1509 enum lttng_error_code status
= LTTNG_OK
;
1510 struct lttcomm_consumer_msg msg
;
1512 LTTNG_ASSERT(socket
);
1513 LTTNG_ASSERT(output
);
1515 DBG("Consumer snapshot channel key %" PRIu64
, key
);
1517 memset(&msg
, 0, sizeof(msg
));
1518 msg
.cmd_type
= LTTNG_CONSUMER_SNAPSHOT_CHANNEL
;
1519 msg
.u
.snapshot_channel
.key
= key
;
1520 msg
.u
.snapshot_channel
.nb_packets_per_stream
= nb_packets_per_stream
;
1521 msg
.u
.snapshot_channel
.metadata
= metadata
;
1523 if (output
->type
== CONSUMER_DST_NET
) {
1524 msg
.u
.snapshot_channel
.relayd_id
=
1525 output
->net_seq_index
;
1526 msg
.u
.snapshot_channel
.use_relayd
= 1;
1528 msg
.u
.snapshot_channel
.relayd_id
= (uint64_t) -1ULL;
1530 ret
= lttng_strncpy(msg
.u
.snapshot_channel
.pathname
,
1532 sizeof(msg
.u
.snapshot_channel
.pathname
));
1534 ERR("Snapshot path exceeds the maximal allowed length of %zu bytes (%zu bytes required) with path \"%s\"",
1535 sizeof(msg
.u
.snapshot_channel
.pathname
),
1536 strlen(channel_path
),
1538 status
= LTTNG_ERR_SNAPSHOT_FAIL
;
1542 health_code_update();
1543 pthread_mutex_lock(socket
->lock
);
1544 ret
= consumer_send_msg(socket
, &msg
);
1545 pthread_mutex_unlock(socket
->lock
);
1548 case LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
:
1549 status
= LTTNG_ERR_CHAN_NOT_FOUND
;
1552 status
= LTTNG_ERR_SNAPSHOT_FAIL
;
1559 health_code_update();
1564 * Ask the consumer the number of discarded events for a channel.
1566 int consumer_get_discarded_events(uint64_t session_id
, uint64_t channel_key
,
1567 struct consumer_output
*consumer
, uint64_t *discarded
)
1570 struct consumer_socket
*socket
;
1571 struct lttng_ht_iter iter
;
1572 struct lttcomm_consumer_msg msg
;
1574 LTTNG_ASSERT(consumer
);
1576 DBG3("Consumer discarded events id %" PRIu64
, session_id
);
1578 memset(&msg
, 0, sizeof(msg
));
1579 msg
.cmd_type
= LTTNG_CONSUMER_DISCARDED_EVENTS
;
1580 msg
.u
.discarded_events
.session_id
= session_id
;
1581 msg
.u
.discarded_events
.channel_key
= channel_key
;
1585 /* Send command for each consumer */
1587 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1589 uint64_t consumer_discarded
= 0;
1590 pthread_mutex_lock(socket
->lock
);
1591 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1593 pthread_mutex_unlock(socket
->lock
);
1598 * No need for a recv reply status because the answer to the
1599 * command is the reply status message.
1601 ret
= consumer_socket_recv(socket
, &consumer_discarded
,
1602 sizeof(consumer_discarded
));
1604 ERR("get discarded events");
1605 pthread_mutex_unlock(socket
->lock
);
1608 pthread_mutex_unlock(socket
->lock
);
1609 *discarded
+= consumer_discarded
;
1612 DBG("Consumer discarded %" PRIu64
" events in session id %" PRIu64
,
1613 *discarded
, session_id
);
1621 * Ask the consumer the number of lost packets for a channel.
1623 int consumer_get_lost_packets(uint64_t session_id
, uint64_t channel_key
,
1624 struct consumer_output
*consumer
, uint64_t *lost
)
1627 struct consumer_socket
*socket
;
1628 struct lttng_ht_iter iter
;
1629 struct lttcomm_consumer_msg msg
;
1631 LTTNG_ASSERT(consumer
);
1633 DBG3("Consumer lost packets id %" PRIu64
, session_id
);
1635 memset(&msg
, 0, sizeof(msg
));
1636 msg
.cmd_type
= LTTNG_CONSUMER_LOST_PACKETS
;
1637 msg
.u
.lost_packets
.session_id
= session_id
;
1638 msg
.u
.lost_packets
.channel_key
= channel_key
;
1642 /* Send command for each consumer */
1644 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1646 uint64_t consumer_lost
= 0;
1647 pthread_mutex_lock(socket
->lock
);
1648 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1650 pthread_mutex_unlock(socket
->lock
);
1655 * No need for a recv reply status because the answer to the
1656 * command is the reply status message.
1658 ret
= consumer_socket_recv(socket
, &consumer_lost
,
1659 sizeof(consumer_lost
));
1661 ERR("get lost packets");
1662 pthread_mutex_unlock(socket
->lock
);
1665 pthread_mutex_unlock(socket
->lock
);
1666 *lost
+= consumer_lost
;
1669 DBG("Consumer lost %" PRIu64
" packets in session id %" PRIu64
,
1678 * Ask the consumer to rotate a channel.
1680 * The new_chunk_id is the session->rotate_count that has been incremented
1681 * when the rotation started. On the relay, this allows to keep track in which
1682 * chunk each stream is currently writing to (for the rotate_pending operation).
1684 int consumer_rotate_channel(struct consumer_socket
*socket
, uint64_t key
,
1685 uid_t uid
, gid_t gid
, struct consumer_output
*output
,
1686 bool is_metadata_channel
)
1689 struct lttcomm_consumer_msg msg
;
1691 LTTNG_ASSERT(socket
);
1693 DBG("Consumer rotate channel key %" PRIu64
, key
);
1695 pthread_mutex_lock(socket
->lock
);
1696 memset(&msg
, 0, sizeof(msg
));
1697 msg
.cmd_type
= LTTNG_CONSUMER_ROTATE_CHANNEL
;
1698 msg
.u
.rotate_channel
.key
= key
;
1699 msg
.u
.rotate_channel
.metadata
= !!is_metadata_channel
;
1701 if (output
->type
== CONSUMER_DST_NET
) {
1702 msg
.u
.rotate_channel
.relayd_id
= output
->net_seq_index
;
1704 msg
.u
.rotate_channel
.relayd_id
= (uint64_t) -1ULL;
1707 health_code_update();
1708 ret
= consumer_send_msg(socket
, &msg
);
1711 case LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
:
1712 ret
= -LTTNG_ERR_CHAN_NOT_FOUND
;
1715 ret
= -LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
1721 pthread_mutex_unlock(socket
->lock
);
1722 health_code_update();
1726 int consumer_open_channel_packets(struct consumer_socket
*socket
, uint64_t key
)
1729 lttcomm_consumer_msg msg
= {
1730 .cmd_type
= LTTNG_CONSUMER_OPEN_CHANNEL_PACKETS
,
1732 msg
.u
.open_channel_packets
.key
= key
;
1734 LTTNG_ASSERT(socket
);
1736 DBG("Consumer open channel packets: channel key = %" PRIu64
, key
);
1738 health_code_update();
1740 pthread_mutex_lock(socket
->lock
);
1741 ret
= consumer_send_msg(socket
, &msg
);
1742 pthread_mutex_unlock(socket
->lock
);
1748 health_code_update();
1752 int consumer_clear_channel(struct consumer_socket
*socket
, uint64_t key
)
1755 struct lttcomm_consumer_msg msg
;
1757 LTTNG_ASSERT(socket
);
1759 DBG("Consumer clear channel %" PRIu64
, key
);
1761 memset(&msg
, 0, sizeof(msg
));
1762 msg
.cmd_type
= LTTNG_CONSUMER_CLEAR_CHANNEL
;
1763 msg
.u
.clear_channel
.key
= key
;
1765 health_code_update();
1767 pthread_mutex_lock(socket
->lock
);
1768 ret
= consumer_send_msg(socket
, &msg
);
1774 pthread_mutex_unlock(socket
->lock
);
1776 health_code_update();
1780 int consumer_init(struct consumer_socket
*socket
,
1781 const lttng_uuid sessiond_uuid
)
1784 struct lttcomm_consumer_msg msg
= {
1785 .cmd_type
= LTTNG_CONSUMER_INIT
,
1788 LTTNG_ASSERT(socket
);
1790 DBG("Sending consumer initialization command");
1791 lttng_uuid_copy(msg
.u
.init
.sessiond_uuid
, sessiond_uuid
);
1793 health_code_update();
1794 ret
= consumer_send_msg(socket
, &msg
);
1800 health_code_update();
1805 * Ask the consumer to create a new chunk for a given session.
1807 * Called with the consumer socket lock held.
1809 int consumer_create_trace_chunk(struct consumer_socket
*socket
,
1810 uint64_t relayd_id
, uint64_t session_id
,
1811 struct lttng_trace_chunk
*chunk
,
1812 const char *domain_subdir
)
1815 enum lttng_trace_chunk_status chunk_status
;
1816 struct lttng_credentials chunk_credentials
;
1817 const struct lttng_directory_handle
*chunk_directory_handle
= NULL
;
1818 struct lttng_directory_handle
*domain_handle
= NULL
;
1820 const char *chunk_name
;
1821 bool chunk_name_overridden
;
1823 time_t creation_timestamp
;
1824 char creation_timestamp_buffer
[ISO8601_STR_LEN
];
1825 const char *creation_timestamp_str
= "(none)";
1826 const bool chunk_has_local_output
= relayd_id
== -1ULL;
1827 enum lttng_trace_chunk_status tc_status
;
1828 struct lttcomm_consumer_msg msg
= {
1829 .cmd_type
= LTTNG_CONSUMER_CREATE_TRACE_CHUNK
,
1831 msg
.u
.create_trace_chunk
.session_id
= session_id
;
1833 LTTNG_ASSERT(socket
);
1834 LTTNG_ASSERT(chunk
);
1836 if (relayd_id
!= -1ULL) {
1837 LTTNG_OPTIONAL_SET(&msg
.u
.create_trace_chunk
.relayd_id
,
1841 chunk_status
= lttng_trace_chunk_get_name(chunk
, &chunk_name
,
1842 &chunk_name_overridden
);
1843 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
&&
1844 chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_NONE
) {
1845 ERR("Failed to get name of trace chunk");
1846 ret
= -LTTNG_ERR_FATAL
;
1849 if (chunk_name_overridden
) {
1850 ret
= lttng_strncpy(msg
.u
.create_trace_chunk
.override_name
,
1852 sizeof(msg
.u
.create_trace_chunk
.override_name
));
1854 ERR("Trace chunk name \"%s\" exceeds the maximal length allowed by the consumer protocol",
1856 ret
= -LTTNG_ERR_FATAL
;
1861 chunk_status
= lttng_trace_chunk_get_creation_timestamp(chunk
,
1862 &creation_timestamp
);
1863 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1864 ret
= -LTTNG_ERR_FATAL
;
1867 msg
.u
.create_trace_chunk
.creation_timestamp
=
1868 (uint64_t) creation_timestamp
;
1869 /* Only used for logging purposes. */
1870 ret
= time_to_iso8601_str(creation_timestamp
,
1871 creation_timestamp_buffer
,
1872 sizeof(creation_timestamp_buffer
));
1873 creation_timestamp_str
= !ret
? creation_timestamp_buffer
:
1874 "(formatting error)";
1876 chunk_status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1877 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1879 * Anonymous trace chunks should never be transmitted
1880 * to remote peers (consumerd and relayd). They are used
1881 * internally for backward-compatibility purposes.
1883 ret
= -LTTNG_ERR_FATAL
;
1886 msg
.u
.create_trace_chunk
.chunk_id
= chunk_id
;
1888 if (chunk_has_local_output
) {
1889 chunk_status
= lttng_trace_chunk_borrow_chunk_directory_handle(
1890 chunk
, &chunk_directory_handle
);
1891 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1892 ret
= -LTTNG_ERR_FATAL
;
1895 chunk_status
= lttng_trace_chunk_get_credentials(
1896 chunk
, &chunk_credentials
);
1897 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1899 * Not associating credentials to a sessiond chunk is a
1900 * fatal internal error.
1902 ret
= -LTTNG_ERR_FATAL
;
1905 tc_status
= lttng_trace_chunk_create_subdirectory(
1906 chunk
, domain_subdir
);
1907 if (tc_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1908 PERROR("Failed to create chunk domain output directory \"%s\"",
1910 ret
= -LTTNG_ERR_FATAL
;
1913 domain_handle
= lttng_directory_handle_create_from_handle(
1915 chunk_directory_handle
);
1916 if (!domain_handle
) {
1917 ret
= -LTTNG_ERR_FATAL
;
1922 * This will only compile on platforms that support
1923 * dirfd (POSIX.2008). This is fine as the session daemon
1924 * is only built for such platforms.
1926 * The ownership of the chunk directory handle's is maintained
1927 * by the trace chunk.
1929 domain_dirfd
= lttng_directory_handle_get_dirfd(
1931 LTTNG_ASSERT(domain_dirfd
>= 0);
1933 msg
.u
.create_trace_chunk
.credentials
.value
.uid
=
1934 lttng_credentials_get_uid(&chunk_credentials
);
1935 msg
.u
.create_trace_chunk
.credentials
.value
.gid
=
1936 lttng_credentials_get_gid(&chunk_credentials
);
1937 msg
.u
.create_trace_chunk
.credentials
.is_set
= 1;
1940 DBG("Sending consumer create trace chunk command: relayd_id = %" PRId64
1941 ", session_id = %" PRIu64
", chunk_id = %" PRIu64
1942 ", creation_timestamp = %s",
1943 relayd_id
, session_id
, chunk_id
,
1944 creation_timestamp_str
);
1945 health_code_update();
1946 ret
= consumer_send_msg(socket
, &msg
);
1947 health_code_update();
1949 ERR("Trace chunk creation error on consumer");
1950 ret
= -LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
1954 if (chunk_has_local_output
) {
1955 DBG("Sending trace chunk domain directory fd to consumer");
1956 health_code_update();
1957 ret
= consumer_send_fds(socket
, &domain_dirfd
, 1);
1958 health_code_update();
1960 ERR("Trace chunk creation error on consumer");
1961 ret
= -LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
1966 lttng_directory_handle_put(domain_handle
);
1971 * Ask the consumer to close a trace chunk for a given session.
1973 * Called with the consumer socket lock held.
1975 int consumer_close_trace_chunk(struct consumer_socket
*socket
,
1976 uint64_t relayd_id
, uint64_t session_id
,
1977 struct lttng_trace_chunk
*chunk
,
1978 char *closed_trace_chunk_path
)
1981 enum lttng_trace_chunk_status chunk_status
;
1982 lttcomm_consumer_msg msg
= {
1983 .cmd_type
= LTTNG_CONSUMER_CLOSE_TRACE_CHUNK
,
1985 msg
.u
.close_trace_chunk
.session_id
= session_id
;
1987 struct lttcomm_consumer_close_trace_chunk_reply reply
;
1989 time_t close_timestamp
;
1990 enum lttng_trace_chunk_command_type close_command
;
1991 const char *close_command_name
= "none";
1992 struct lttng_dynamic_buffer path_reception_buffer
;
1994 LTTNG_ASSERT(socket
);
1995 lttng_dynamic_buffer_init(&path_reception_buffer
);
1997 if (relayd_id
!= -1ULL) {
1999 &msg
.u
.close_trace_chunk
.relayd_id
, relayd_id
);
2002 chunk_status
= lttng_trace_chunk_get_close_command(
2003 chunk
, &close_command
);
2004 switch (chunk_status
) {
2005 case LTTNG_TRACE_CHUNK_STATUS_OK
:
2006 LTTNG_OPTIONAL_SET(&msg
.u
.close_trace_chunk
.close_command
,
2007 (uint32_t) close_command
);
2009 case LTTNG_TRACE_CHUNK_STATUS_NONE
:
2012 ERR("Failed to get trace chunk close command");
2017 chunk_status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
2019 * Anonymous trace chunks should never be transmitted to remote peers
2020 * (consumerd and relayd). They are used internally for
2021 * backward-compatibility purposes.
2023 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
2024 msg
.u
.close_trace_chunk
.chunk_id
= chunk_id
;
2026 chunk_status
= lttng_trace_chunk_get_close_timestamp(chunk
,
2029 * A trace chunk should be closed locally before being closed remotely.
2030 * Otherwise, the close timestamp would never be transmitted to the
2033 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
2034 msg
.u
.close_trace_chunk
.close_timestamp
= (uint64_t) close_timestamp
;
2036 if (msg
.u
.close_trace_chunk
.close_command
.is_set
) {
2037 close_command_name
= lttng_trace_chunk_command_type_get_name(
2040 DBG("Sending consumer close trace chunk command: relayd_id = %" PRId64
2041 ", session_id = %" PRIu64
", chunk_id = %" PRIu64
2042 ", close command = \"%s\"",
2043 relayd_id
, session_id
, chunk_id
, close_command_name
);
2045 health_code_update();
2046 ret
= consumer_socket_send(socket
, &msg
, sizeof(struct lttcomm_consumer_msg
));
2048 ret
= -LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
2051 ret
= consumer_socket_recv(socket
, &reply
, sizeof(reply
));
2053 ret
= -LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
2056 if (reply
.path_length
>= LTTNG_PATH_MAX
) {
2057 ERR("Invalid path returned by relay daemon: %" PRIu32
"bytes exceeds maximal allowed length of %d bytes",
2058 reply
.path_length
, LTTNG_PATH_MAX
);
2059 ret
= -LTTNG_ERR_INVALID_PROTOCOL
;
2062 ret
= lttng_dynamic_buffer_set_size(&path_reception_buffer
,
2065 ERR("Failed to allocate reception buffer of path returned by the \"close trace chunk\" command");
2066 ret
= -LTTNG_ERR_NOMEM
;
2069 ret
= consumer_socket_recv(socket
, path_reception_buffer
.data
,
2070 path_reception_buffer
.size
);
2072 ERR("Communication error while receiving path of closed trace chunk");
2073 ret
= -LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
2076 if (path_reception_buffer
.data
[path_reception_buffer
.size
- 1] != '\0') {
2077 ERR("Invalid path returned by relay daemon: not null-terminated");
2078 ret
= -LTTNG_ERR_INVALID_PROTOCOL
;
2081 if (closed_trace_chunk_path
) {
2083 * closed_trace_chunk_path is assumed to have a length >=
2086 memcpy(closed_trace_chunk_path
, path_reception_buffer
.data
,
2087 path_reception_buffer
.size
);
2090 lttng_dynamic_buffer_reset(&path_reception_buffer
);
2091 health_code_update();
2096 * Ask the consumer if a trace chunk exists.
2098 * Called with the consumer socket lock held.
2099 * Returns 0 on success, or a negative value on error.
2101 int consumer_trace_chunk_exists(struct consumer_socket
*socket
,
2102 uint64_t relayd_id
, uint64_t session_id
,
2103 struct lttng_trace_chunk
*chunk
,
2104 enum consumer_trace_chunk_exists_status
*result
)
2107 enum lttng_trace_chunk_status chunk_status
;
2108 lttcomm_consumer_msg msg
= {
2109 .cmd_type
= LTTNG_CONSUMER_TRACE_CHUNK_EXISTS
,
2111 msg
.u
.trace_chunk_exists
.session_id
= session_id
;
2114 const char *consumer_reply_str
;
2116 LTTNG_ASSERT(socket
);
2118 if (relayd_id
!= -1ULL) {
2119 LTTNG_OPTIONAL_SET(&msg
.u
.trace_chunk_exists
.relayd_id
,
2123 chunk_status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
2124 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2126 * Anonymous trace chunks should never be transmitted
2127 * to remote peers (consumerd and relayd). They are used
2128 * internally for backward-compatibility purposes.
2130 ret
= -LTTNG_ERR_FATAL
;
2133 msg
.u
.trace_chunk_exists
.chunk_id
= chunk_id
;
2135 DBG("Sending consumer trace chunk exists command: relayd_id = %" PRId64
2136 ", session_id = %" PRIu64
2137 ", chunk_id = %" PRIu64
, relayd_id
, session_id
, chunk_id
);
2139 health_code_update();
2140 ret
= consumer_send_msg(socket
, &msg
);
2142 case LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
:
2143 consumer_reply_str
= "unknown trace chunk";
2144 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_UNKNOWN_CHUNK
;
2146 case LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL
:
2147 consumer_reply_str
= "trace chunk exists locally";
2148 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_EXISTS_LOCAL
;
2150 case LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE
:
2151 consumer_reply_str
= "trace chunk exists on remote peer";
2152 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_EXISTS_REMOTE
;
2155 ERR("Consumer returned an error from TRACE_CHUNK_EXISTS command");
2159 DBG("Consumer reply to TRACE_CHUNK_EXISTS command: %s",
2160 consumer_reply_str
);
2163 health_code_update();