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
15 #include <sys/types.h>
19 #include <common/common.h>
20 #include <common/defaults.h>
21 #include <common/uri.h>
22 #include <common/relayd/relayd.h>
23 #include <common/string-utils/format.h>
26 #include "health-sessiond.h"
29 #include "lttng-sessiond.h"
32 * Return allocated full pathname of the session using the consumer trace path
33 * and subdir if available.
35 * The caller can safely free(3) the returned value. On error, NULL is
38 char *setup_channel_trace_path(struct consumer_output
*consumer
,
39 const char *session_path
, size_t *consumer_path_offset
)
50 * Allocate the string ourself to make sure we never exceed
53 pathname
= zmalloc(LTTNG_PATH_MAX
);
58 /* Get correct path name destination */
59 if (consumer
->type
== CONSUMER_DST_NET
&&
60 consumer
->relay_major_version
== 2 &&
61 consumer
->relay_minor_version
< 11) {
62 ret
= snprintf(pathname
, LTTNG_PATH_MAX
, "%s%s/%s/%s",
63 consumer
->dst
.net
.base_dir
,
64 consumer
->chunk_path
, consumer
->domain_subdir
,
66 *consumer_path_offset
= 0;
68 ret
= snprintf(pathname
, LTTNG_PATH_MAX
, "%s/%s",
69 consumer
->domain_subdir
, session_path
);
70 *consumer_path_offset
= strlen(consumer
->domain_subdir
) + 1;
72 DBG3("Consumer trace path relative to current trace chunk: \"%s\"",
75 PERROR("Failed to format channel path");
77 } else if (ret
>= LTTNG_PATH_MAX
) {
78 ERR("Truncation occurred while formatting channel path");
89 * Send a data payload using a given consumer socket of size len.
91 * The consumer socket lock MUST be acquired before calling this since this
92 * function can change the fd value.
94 * Return 0 on success else a negative value on error.
96 int consumer_socket_send(
97 struct consumer_socket
*socket
, const void *msg
, size_t len
)
103 assert(socket
->fd_ptr
);
106 /* Consumer socket is invalid. Stopping. */
107 fd
= *socket
->fd_ptr
;
112 size
= lttcomm_send_unix_sock(fd
, msg
, len
);
114 /* The above call will print a PERROR on error. */
115 DBG("Error when sending data to consumer on sock %d", fd
);
117 * At this point, the socket is not usable anymore thus closing it and
118 * setting the file descriptor to -1 so it is not reused.
121 /* This call will PERROR on error. */
122 (void) lttcomm_close_unix_sock(fd
);
123 *socket
->fd_ptr
= -1;
134 * Receive a data payload using a given consumer socket of size len.
136 * The consumer socket lock MUST be acquired before calling this since this
137 * function can change the fd value.
139 * Return 0 on success else a negative value on error.
141 int consumer_socket_recv(struct consumer_socket
*socket
, void *msg
, size_t len
)
147 assert(socket
->fd_ptr
);
150 /* Consumer socket is invalid. Stopping. */
151 fd
= *socket
->fd_ptr
;
156 size
= lttcomm_recv_unix_sock(fd
, msg
, len
);
158 /* The above call will print a PERROR on error. */
159 DBG("Error when receiving data from the consumer socket %d", fd
);
161 * At this point, the socket is not usable anymore thus closing it and
162 * setting the file descriptor to -1 so it is not reused.
165 /* This call will PERROR on error. */
166 (void) lttcomm_close_unix_sock(fd
);
167 *socket
->fd_ptr
= -1;
178 * Receive a reply command status message from the consumer. Consumer socket
179 * lock MUST be acquired before calling this function.
181 * Return 0 on success, -1 on recv error or a negative lttng error code which
182 * was possibly returned by the consumer.
184 int consumer_recv_status_reply(struct consumer_socket
*sock
)
187 struct lttcomm_consumer_status_msg reply
;
191 ret
= consumer_socket_recv(sock
, &reply
, sizeof(reply
));
196 if (reply
.ret_code
== LTTCOMM_CONSUMERD_SUCCESS
) {
200 ret
= -reply
.ret_code
;
201 DBG("Consumer ret code %d", ret
);
209 * Once the ASK_CHANNEL command is sent to the consumer, the channel
210 * information are sent back. This call receives that data and populates key
213 * On success return 0 and both key and stream_count are set. On error, a
214 * negative value is sent back and both parameters are untouched.
216 int consumer_recv_status_channel(struct consumer_socket
*sock
,
217 uint64_t *key
, unsigned int *stream_count
)
220 struct lttcomm_consumer_status_channel reply
;
223 assert(stream_count
);
226 ret
= consumer_socket_recv(sock
, &reply
, sizeof(reply
));
231 /* An error is possible so don't touch the key and stream_count. */
232 if (reply
.ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
238 *stream_count
= reply
.stream_count
;
246 * Send destroy relayd command to consumer.
248 * On success return positive value. On error, negative value.
250 int consumer_send_destroy_relayd(struct consumer_socket
*sock
,
251 struct consumer_output
*consumer
)
254 struct lttcomm_consumer_msg msg
;
259 DBG2("Sending destroy relayd command to consumer sock %d", *sock
->fd_ptr
);
261 memset(&msg
, 0, sizeof(msg
));
262 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_RELAYD
;
263 msg
.u
.destroy_relayd
.net_seq_idx
= consumer
->net_seq_index
;
265 pthread_mutex_lock(sock
->lock
);
266 ret
= consumer_socket_send(sock
, &msg
, sizeof(msg
));
271 /* Don't check the return value. The caller will do it. */
272 ret
= consumer_recv_status_reply(sock
);
274 DBG2("Consumer send destroy relayd command done");
277 pthread_mutex_unlock(sock
->lock
);
282 * For each consumer socket in the consumer output object, send a destroy
285 void consumer_output_send_destroy_relayd(struct consumer_output
*consumer
)
287 struct lttng_ht_iter iter
;
288 struct consumer_socket
*socket
;
292 /* Destroy any relayd connection */
293 if (consumer
->type
== CONSUMER_DST_NET
) {
295 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
299 /* Send destroy relayd command */
300 ret
= consumer_send_destroy_relayd(socket
, consumer
);
302 DBG("Unable to send destroy relayd command to consumer");
303 /* Continue since we MUST delete everything at this point. */
311 * From a consumer_data structure, allocate and add a consumer socket to the
314 * Return 0 on success, else negative value on error
316 int consumer_create_socket(struct consumer_data
*data
,
317 struct consumer_output
*output
)
320 struct consumer_socket
*socket
;
324 if (output
== NULL
|| data
->cmd_sock
< 0) {
326 * Not an error. Possible there is simply not spawned consumer or it's
327 * disabled for the tracing session asking the socket.
333 socket
= consumer_find_socket(data
->cmd_sock
, output
);
335 if (socket
== NULL
) {
336 socket
= consumer_allocate_socket(&data
->cmd_sock
);
337 if (socket
== NULL
) {
342 socket
->registered
= 0;
343 socket
->lock
= &data
->lock
;
345 consumer_add_socket(socket
, output
);
349 socket
->type
= data
->type
;
351 DBG3("Consumer socket created (fd: %d) and added to output",
359 * Return the consumer socket from the given consumer output with the right
360 * bitness. On error, returns NULL.
362 * The caller MUST acquire a rcu read side lock and keep it until the socket
363 * object reference is not needed anymore.
365 struct consumer_socket
*consumer_find_socket_by_bitness(int bits
,
366 const struct consumer_output
*consumer
)
369 struct consumer_socket
*socket
= NULL
;
373 consumer_fd
= uatomic_read(&ust_consumerd64_fd
);
376 consumer_fd
= uatomic_read(&ust_consumerd32_fd
);
383 socket
= consumer_find_socket(consumer_fd
, consumer
);
385 ERR("Consumer socket fd %d not found in consumer obj %p",
386 consumer_fd
, consumer
);
394 * Find a consumer_socket in a consumer_output hashtable. Read side lock must
395 * be acquired before calling this function and across use of the
396 * returned consumer_socket.
398 struct consumer_socket
*consumer_find_socket(int key
,
399 const struct consumer_output
*consumer
)
401 struct lttng_ht_iter iter
;
402 struct lttng_ht_node_ulong
*node
;
403 struct consumer_socket
*socket
= NULL
;
405 /* Negative keys are lookup failures */
406 if (key
< 0 || consumer
== NULL
) {
410 lttng_ht_lookup(consumer
->socks
, (void *)((unsigned long) key
),
412 node
= lttng_ht_iter_get_node_ulong(&iter
);
414 socket
= caa_container_of(node
, struct consumer_socket
, node
);
421 * Allocate a new consumer_socket and return the pointer.
423 struct consumer_socket
*consumer_allocate_socket(int *fd
)
425 struct consumer_socket
*socket
= NULL
;
429 socket
= zmalloc(sizeof(struct consumer_socket
));
430 if (socket
== NULL
) {
431 PERROR("zmalloc consumer socket");
436 lttng_ht_node_init_ulong(&socket
->node
, *fd
);
443 * Add consumer socket to consumer output object. Read side lock must be
444 * acquired before calling this function.
446 void consumer_add_socket(struct consumer_socket
*sock
,
447 struct consumer_output
*consumer
)
452 lttng_ht_add_unique_ulong(consumer
->socks
, &sock
->node
);
456 * Delete consumer socket to consumer output object. Read side lock must be
457 * acquired before calling this function.
459 void consumer_del_socket(struct consumer_socket
*sock
,
460 struct consumer_output
*consumer
)
463 struct lttng_ht_iter iter
;
468 iter
.iter
.node
= &sock
->node
.node
;
469 ret
= lttng_ht_del(consumer
->socks
, &iter
);
474 * RCU destroy call function.
476 static void destroy_socket_rcu(struct rcu_head
*head
)
478 struct lttng_ht_node_ulong
*node
=
479 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
480 struct consumer_socket
*socket
=
481 caa_container_of(node
, struct consumer_socket
, node
);
487 * Destroy and free socket pointer in a call RCU. Read side lock must be
488 * acquired before calling this function.
490 void consumer_destroy_socket(struct consumer_socket
*sock
)
495 * We DO NOT close the file descriptor here since it is global to the
496 * session daemon and is closed only if the consumer dies or a custom
497 * consumer was registered,
499 if (sock
->registered
) {
500 DBG3("Consumer socket was registered. Closing fd %d", *sock
->fd_ptr
);
501 lttcomm_close_unix_sock(*sock
->fd_ptr
);
504 call_rcu(&sock
->node
.head
, destroy_socket_rcu
);
508 * Allocate and assign data to a consumer_output object.
510 * Return pointer to structure.
512 struct consumer_output
*consumer_create_output(enum consumer_dst_type type
)
514 struct consumer_output
*output
= NULL
;
516 output
= zmalloc(sizeof(struct consumer_output
));
517 if (output
== NULL
) {
518 PERROR("zmalloc consumer_output");
522 /* By default, consumer output is enabled */
525 output
->net_seq_index
= (uint64_t) -1ULL;
526 urcu_ref_init(&output
->ref
);
528 output
->socks
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
535 * Iterate over the consumer output socket hash table and destroy them. The
536 * socket file descriptor are only closed if the consumer output was
537 * registered meaning it's an external consumer.
539 void consumer_destroy_output_sockets(struct consumer_output
*obj
)
541 struct lttng_ht_iter iter
;
542 struct consumer_socket
*socket
;
549 cds_lfht_for_each_entry(obj
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
550 consumer_del_socket(socket
, obj
);
551 consumer_destroy_socket(socket
);
557 * Delete the consumer_output object from the list and free the ptr.
559 * Should *NOT* be called with RCU read-side lock held.
561 static void consumer_release_output(struct urcu_ref
*ref
)
563 struct consumer_output
*obj
=
564 caa_container_of(ref
, struct consumer_output
, ref
);
566 consumer_destroy_output_sockets(obj
);
569 /* Finally destroy HT */
570 ht_cleanup_push(obj
->socks
);
577 * Get the consumer_output object.
579 void consumer_output_get(struct consumer_output
*obj
)
581 urcu_ref_get(&obj
->ref
);
585 * Put the consumer_output object.
587 * Should *NOT* be called with RCU read-side lock held.
589 void consumer_output_put(struct consumer_output
*obj
)
594 urcu_ref_put(&obj
->ref
, consumer_release_output
);
598 * Copy consumer output and returned the newly allocated copy.
600 * Should *NOT* be called with RCU read-side lock held.
602 struct consumer_output
*consumer_copy_output(struct consumer_output
*src
)
605 struct consumer_output
*output
;
609 output
= consumer_create_output(src
->type
);
610 if (output
== NULL
) {
613 output
->enabled
= src
->enabled
;
614 output
->net_seq_index
= src
->net_seq_index
;
615 memcpy(output
->domain_subdir
, src
->domain_subdir
,
616 sizeof(output
->domain_subdir
));
617 output
->snapshot
= src
->snapshot
;
618 output
->relay_major_version
= src
->relay_major_version
;
619 output
->relay_minor_version
= src
->relay_minor_version
;
620 output
->relay_allows_clear
= src
->relay_allows_clear
;
621 memcpy(&output
->dst
, &src
->dst
, sizeof(output
->dst
));
622 ret
= consumer_copy_sockets(output
, src
);
630 consumer_output_put(output
);
635 * Copy consumer sockets from src to dst.
637 * Return 0 on success or else a negative value.
639 int consumer_copy_sockets(struct consumer_output
*dst
,
640 struct consumer_output
*src
)
643 struct lttng_ht_iter iter
;
644 struct consumer_socket
*socket
, *copy_sock
;
650 cds_lfht_for_each_entry(src
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
651 /* Ignore socket that are already there. */
652 copy_sock
= consumer_find_socket(*socket
->fd_ptr
, dst
);
657 /* Create new socket object. */
658 copy_sock
= consumer_allocate_socket(socket
->fd_ptr
);
659 if (copy_sock
== NULL
) {
665 copy_sock
->registered
= socket
->registered
;
667 * This is valid because this lock is shared accross all consumer
668 * object being the global lock of the consumer data structure of the
671 copy_sock
->lock
= socket
->lock
;
672 consumer_add_socket(copy_sock
, dst
);
681 * Set network URI to the consumer output.
683 * Return 0 on success. Return 1 if the URI were equal. Else, negative value on
686 int consumer_set_network_uri(const struct ltt_session
*session
,
687 struct consumer_output
*output
,
688 struct lttng_uri
*uri
)
691 struct lttng_uri
*dst_uri
= NULL
;
693 /* Code flow error safety net. */
697 switch (uri
->stype
) {
698 case LTTNG_STREAM_CONTROL
:
699 dst_uri
= &output
->dst
.net
.control
;
700 output
->dst
.net
.control_isset
= 1;
701 if (uri
->port
== 0) {
702 /* Assign default port. */
703 uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
705 if (output
->dst
.net
.data_isset
&& uri
->port
==
706 output
->dst
.net
.data
.port
) {
707 ret
= -LTTNG_ERR_INVALID
;
711 DBG3("Consumer control URI set with port %d", uri
->port
);
713 case LTTNG_STREAM_DATA
:
714 dst_uri
= &output
->dst
.net
.data
;
715 output
->dst
.net
.data_isset
= 1;
716 if (uri
->port
== 0) {
717 /* Assign default port. */
718 uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
720 if (output
->dst
.net
.control_isset
&& uri
->port
==
721 output
->dst
.net
.control
.port
) {
722 ret
= -LTTNG_ERR_INVALID
;
726 DBG3("Consumer data URI set with port %d", uri
->port
);
729 ERR("Set network uri type unknown %d", uri
->stype
);
730 ret
= -LTTNG_ERR_INVALID
;
734 ret
= uri_compare(dst_uri
, uri
);
736 /* Same URI, don't touch it and return success. */
737 DBG3("URI network compare are the same");
741 /* URIs were not equal, replacing it. */
742 memcpy(dst_uri
, uri
, sizeof(struct lttng_uri
));
743 output
->type
= CONSUMER_DST_NET
;
744 if (dst_uri
->stype
!= LTTNG_STREAM_CONTROL
) {
745 /* Only the control uri needs to contain the path. */
750 * If the user has specified a subdir as part of the control
751 * URL, the session's base output directory is:
752 * /RELAYD_OUTPUT_PATH/HOSTNAME/USER_SPECIFIED_DIR
754 * Hence, the "base_dir" from which all stream files and
755 * session rotation chunks are created takes the form
756 * /HOSTNAME/USER_SPECIFIED_DIR
758 * If the user has not specified an output directory as part of
759 * the control URL, the base output directory has the form:
760 * /RELAYD_OUTPUT_PATH/HOSTNAME/SESSION_NAME-CREATION_TIME
762 * Hence, the "base_dir" from which all stream files and
763 * session rotation chunks are created takes the form
764 * /HOSTNAME/SESSION_NAME-CREATION_TIME
766 * Note that automatically generated session names already
767 * contain the session's creation time. In that case, the
768 * creation time is omitted to prevent it from being duplicated
769 * in the final directory hierarchy.
772 if (strstr(uri
->subdir
, "../")) {
773 ERR("Network URI subdirs are not allowed to walk up the path hierarchy");
774 ret
= -LTTNG_ERR_INVALID
;
777 ret
= snprintf(output
->dst
.net
.base_dir
,
778 sizeof(output
->dst
.net
.base_dir
),
779 "/%s/%s/", session
->hostname
, uri
->subdir
);
781 if (session
->has_auto_generated_name
) {
782 ret
= snprintf(output
->dst
.net
.base_dir
,
783 sizeof(output
->dst
.net
.base_dir
),
784 "/%s/%s/", session
->hostname
,
787 char session_creation_datetime
[16];
791 timeinfo
= localtime(&session
->creation_time
);
793 ret
= -LTTNG_ERR_FATAL
;
796 strftime_ret
= strftime(session_creation_datetime
,
797 sizeof(session_creation_datetime
),
798 "%Y%m%d-%H%M%S", timeinfo
);
799 if (strftime_ret
== 0) {
800 ERR("Failed to format session creation timestamp while setting network URI");
801 ret
= -LTTNG_ERR_FATAL
;
804 ret
= snprintf(output
->dst
.net
.base_dir
,
805 sizeof(output
->dst
.net
.base_dir
),
806 "/%s/%s-%s/", session
->hostname
,
808 session_creation_datetime
);
811 if (ret
>= sizeof(output
->dst
.net
.base_dir
)) {
812 ret
= -LTTNG_ERR_INVALID
;
813 ERR("Truncation occurred while setting network output base directory");
815 } else if (ret
== -1) {
816 ret
= -LTTNG_ERR_INVALID
;
817 PERROR("Error occurred while setting network output base directory");
821 DBG3("Consumer set network uri base_dir path %s",
822 output
->dst
.net
.base_dir
);
833 * Send file descriptor to consumer via sock.
835 * The consumer socket lock must be held by the caller.
837 int consumer_send_fds(struct consumer_socket
*sock
, const int *fds
,
845 assert(pthread_mutex_trylock(sock
->lock
) == EBUSY
);
847 ret
= lttcomm_send_fds_unix_sock(*sock
->fd_ptr
, fds
, nb_fd
);
849 /* The above call will print a PERROR on error. */
850 DBG("Error when sending consumer fds on sock %d", *sock
->fd_ptr
);
854 ret
= consumer_recv_status_reply(sock
);
860 * Consumer send communication message structure to consumer.
862 * The consumer socket lock must be held by the caller.
864 int consumer_send_msg(struct consumer_socket
*sock
,
865 const struct lttcomm_consumer_msg
*msg
)
871 assert(pthread_mutex_trylock(sock
->lock
) == EBUSY
);
873 ret
= consumer_socket_send(sock
, msg
, sizeof(struct lttcomm_consumer_msg
));
878 ret
= consumer_recv_status_reply(sock
);
885 * Consumer send channel communication message structure to consumer.
887 * The consumer socket lock must be held by the caller.
889 int consumer_send_channel(struct consumer_socket
*sock
,
890 struct lttcomm_consumer_msg
*msg
)
897 ret
= consumer_send_msg(sock
, msg
);
907 * Populate the given consumer msg structure with the ask_channel command
910 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
911 uint64_t subbuf_size
,
914 unsigned int switch_timer_interval
,
915 unsigned int read_timer_interval
,
916 unsigned int live_timer_interval
,
917 bool is_in_live_session
,
918 unsigned int monitor_timer_interval
,
922 const char *pathname
,
928 uint64_t tracefile_size
,
929 uint64_t tracefile_count
,
930 uint64_t session_id_per_pid
,
931 unsigned int monitor
,
932 uint32_t ust_app_uid
,
933 int64_t blocking_timeout
,
934 const char *root_shm_path
,
935 const char *shm_path
,
936 struct lttng_trace_chunk
*trace_chunk
,
937 const struct lttng_credentials
*buffer_credentials
)
941 /* Zeroed structure */
942 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
943 msg
->u
.ask_channel
.buffer_credentials
.uid
= UINT32_MAX
;
944 msg
->u
.ask_channel
.buffer_credentials
.gid
= UINT32_MAX
;
948 enum lttng_trace_chunk_status chunk_status
;
950 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
, &chunk_id
);
951 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
952 LTTNG_OPTIONAL_SET(&msg
->u
.ask_channel
.chunk_id
, chunk_id
);
954 msg
->u
.ask_channel
.buffer_credentials
.uid
=
955 lttng_credentials_get_uid(buffer_credentials
);
956 msg
->u
.ask_channel
.buffer_credentials
.gid
=
957 lttng_credentials_get_gid(buffer_credentials
);
959 msg
->cmd_type
= LTTNG_CONSUMER_ASK_CHANNEL_CREATION
;
960 msg
->u
.ask_channel
.subbuf_size
= subbuf_size
;
961 msg
->u
.ask_channel
.num_subbuf
= num_subbuf
;
962 msg
->u
.ask_channel
.overwrite
= overwrite
;
963 msg
->u
.ask_channel
.switch_timer_interval
= switch_timer_interval
;
964 msg
->u
.ask_channel
.read_timer_interval
= read_timer_interval
;
965 msg
->u
.ask_channel
.live_timer_interval
= live_timer_interval
;
966 msg
->u
.ask_channel
.is_live
= is_in_live_session
;
967 msg
->u
.ask_channel
.monitor_timer_interval
= monitor_timer_interval
;
968 msg
->u
.ask_channel
.output
= output
;
969 msg
->u
.ask_channel
.type
= type
;
970 msg
->u
.ask_channel
.session_id
= session_id
;
971 msg
->u
.ask_channel
.session_id_per_pid
= session_id_per_pid
;
972 msg
->u
.ask_channel
.relayd_id
= relayd_id
;
973 msg
->u
.ask_channel
.key
= key
;
974 msg
->u
.ask_channel
.chan_id
= chan_id
;
975 msg
->u
.ask_channel
.tracefile_size
= tracefile_size
;
976 msg
->u
.ask_channel
.tracefile_count
= tracefile_count
;
977 msg
->u
.ask_channel
.monitor
= monitor
;
978 msg
->u
.ask_channel
.ust_app_uid
= ust_app_uid
;
979 msg
->u
.ask_channel
.blocking_timeout
= blocking_timeout
;
981 memcpy(msg
->u
.ask_channel
.uuid
, uuid
, sizeof(msg
->u
.ask_channel
.uuid
));
984 strncpy(msg
->u
.ask_channel
.pathname
, pathname
,
985 sizeof(msg
->u
.ask_channel
.pathname
));
986 msg
->u
.ask_channel
.pathname
[sizeof(msg
->u
.ask_channel
.pathname
)-1] = '\0';
989 strncpy(msg
->u
.ask_channel
.name
, name
, sizeof(msg
->u
.ask_channel
.name
));
990 msg
->u
.ask_channel
.name
[sizeof(msg
->u
.ask_channel
.name
) - 1] = '\0';
993 strncpy(msg
->u
.ask_channel
.root_shm_path
, root_shm_path
,
994 sizeof(msg
->u
.ask_channel
.root_shm_path
));
995 msg
->u
.ask_channel
.root_shm_path
[sizeof(msg
->u
.ask_channel
.root_shm_path
) - 1] = '\0';
998 strncpy(msg
->u
.ask_channel
.shm_path
, shm_path
,
999 sizeof(msg
->u
.ask_channel
.shm_path
));
1000 msg
->u
.ask_channel
.shm_path
[sizeof(msg
->u
.ask_channel
.shm_path
) - 1] = '\0';
1005 * Init channel communication message structure.
1007 void consumer_init_add_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
1008 uint64_t channel_key
,
1009 uint64_t session_id
,
1010 const char *pathname
,
1015 unsigned int nb_init_streams
,
1016 enum lttng_event_output output
,
1018 uint64_t tracefile_size
,
1019 uint64_t tracefile_count
,
1020 unsigned int monitor
,
1021 unsigned int live_timer_interval
,
1022 bool is_in_live_session
,
1023 unsigned int monitor_timer_interval
,
1024 struct lttng_trace_chunk
*trace_chunk
)
1028 /* Zeroed structure */
1029 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1033 enum lttng_trace_chunk_status chunk_status
;
1035 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
, &chunk_id
);
1036 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
1037 LTTNG_OPTIONAL_SET(&msg
->u
.channel
.chunk_id
, chunk_id
);
1041 msg
->cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
1042 msg
->u
.channel
.channel_key
= channel_key
;
1043 msg
->u
.channel
.session_id
= session_id
;
1044 msg
->u
.channel
.relayd_id
= relayd_id
;
1045 msg
->u
.channel
.nb_init_streams
= nb_init_streams
;
1046 msg
->u
.channel
.output
= output
;
1047 msg
->u
.channel
.type
= type
;
1048 msg
->u
.channel
.tracefile_size
= tracefile_size
;
1049 msg
->u
.channel
.tracefile_count
= tracefile_count
;
1050 msg
->u
.channel
.monitor
= monitor
;
1051 msg
->u
.channel
.live_timer_interval
= live_timer_interval
;
1052 msg
->u
.channel
.is_live
= is_in_live_session
;
1053 msg
->u
.channel
.monitor_timer_interval
= monitor_timer_interval
;
1055 strncpy(msg
->u
.channel
.pathname
, pathname
,
1056 sizeof(msg
->u
.channel
.pathname
));
1057 msg
->u
.channel
.pathname
[sizeof(msg
->u
.channel
.pathname
) - 1] = '\0';
1059 strncpy(msg
->u
.channel
.name
, name
, sizeof(msg
->u
.channel
.name
));
1060 msg
->u
.channel
.name
[sizeof(msg
->u
.channel
.name
) - 1] = '\0';
1064 * Init stream communication message structure.
1066 void consumer_init_add_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
1067 uint64_t channel_key
,
1068 uint64_t stream_key
,
1073 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1075 msg
->cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
1076 msg
->u
.stream
.channel_key
= channel_key
;
1077 msg
->u
.stream
.stream_key
= stream_key
;
1078 msg
->u
.stream
.cpu
= cpu
;
1081 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg
*msg
,
1082 enum lttng_consumer_command cmd
,
1083 uint64_t channel_key
, uint64_t net_seq_idx
)
1087 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1089 msg
->cmd_type
= cmd
;
1090 msg
->u
.sent_streams
.channel_key
= channel_key
;
1091 msg
->u
.sent_streams
.net_seq_idx
= net_seq_idx
;
1095 * Send stream communication structure to the consumer.
1097 int consumer_send_stream(struct consumer_socket
*sock
,
1098 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
1099 const int *fds
, size_t nb_fd
)
1108 ret
= consumer_send_msg(sock
, msg
);
1113 ret
= consumer_send_fds(sock
, fds
, nb_fd
);
1123 * Send relayd socket to consumer associated with a session name.
1125 * The consumer socket lock must be held by the caller.
1127 * On success return positive value. On error, negative value.
1129 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
1130 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
1131 enum lttng_stream_type type
, uint64_t session_id
,
1132 const char *session_name
, const char *hostname
,
1133 const char *base_path
, int session_live_timer
,
1134 const uint64_t *current_chunk_id
, time_t session_creation_time
,
1135 bool session_name_contains_creation_time
)
1138 struct lttcomm_consumer_msg msg
;
1140 /* Code flow error. Safety net. */
1143 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
,
1158 session_name
, hostname
, base_path
,
1160 consumer
->snapshot
, session_id
,
1161 sessiond_uuid
, current_chunk_id
,
1162 session_creation_time
,
1163 session_name_contains_creation_time
,
1166 /* Close the control socket. */
1167 (void) relayd_close(rsock
);
1170 msg
.u
.relayd_sock
.relayd_session_id
= relayd_session_id
;
1171 DBG("Created session on relay, output path reply: %s",
1175 msg
.cmd_type
= LTTNG_CONSUMER_ADD_RELAYD_SOCKET
;
1177 * Assign network consumer output index using the temporary consumer since
1178 * this call should only be made from within a set_consumer_uri() function
1179 * call in the session daemon.
1181 msg
.u
.relayd_sock
.net_index
= consumer
->net_seq_index
;
1182 msg
.u
.relayd_sock
.type
= type
;
1183 msg
.u
.relayd_sock
.session_id
= session_id
;
1184 memcpy(&msg
.u
.relayd_sock
.sock
, rsock
, sizeof(msg
.u
.relayd_sock
.sock
));
1186 DBG3("Sending relayd sock info to consumer on %d", *consumer_sock
->fd_ptr
);
1187 ret
= consumer_send_msg(consumer_sock
, &msg
);
1192 DBG3("Sending relayd socket file descriptor to consumer");
1193 ret
= consumer_send_fds(consumer_sock
, ALIGNED_CONST_PTR(rsock
->sock
.fd
), 1);
1198 DBG2("Consumer relayd socket sent");
1205 int consumer_send_pipe(struct consumer_socket
*consumer_sock
,
1206 enum lttng_consumer_command cmd
, int pipe
)
1209 struct lttcomm_consumer_msg msg
;
1210 const char *pipe_name
;
1211 const char *command_name
;
1214 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1215 pipe_name
= "channel monitor";
1216 command_name
= "SET_CHANNEL_MONITOR_PIPE";
1219 ERR("Unexpected command received in %s (cmd = %d)", __func__
,
1224 /* Code flow error. Safety net. */
1226 memset(&msg
, 0, sizeof(msg
));
1229 pthread_mutex_lock(consumer_sock
->lock
);
1230 DBG3("Sending %s command to consumer", command_name
);
1231 ret
= consumer_send_msg(consumer_sock
, &msg
);
1236 DBG3("Sending %s pipe %d to consumer on socket %d",
1238 pipe
, *consumer_sock
->fd_ptr
);
1239 ret
= consumer_send_fds(consumer_sock
, &pipe
, 1);
1244 DBG2("%s pipe successfully sent", pipe_name
);
1246 pthread_mutex_unlock(consumer_sock
->lock
);
1250 int consumer_send_channel_monitor_pipe(struct consumer_socket
*consumer_sock
,
1253 return consumer_send_pipe(consumer_sock
,
1254 LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
, pipe
);
1258 * Ask the consumer if the data is pending for the specific session id.
1259 * Returns 1 if data is pending, 0 otherwise, or < 0 on error.
1261 int consumer_is_data_pending(uint64_t session_id
,
1262 struct consumer_output
*consumer
)
1265 int32_t ret_code
= 0; /* Default is that the data is NOT pending */
1266 struct consumer_socket
*socket
;
1267 struct lttng_ht_iter iter
;
1268 struct lttcomm_consumer_msg msg
;
1272 DBG3("Consumer data pending for id %" PRIu64
, session_id
);
1274 memset(&msg
, 0, sizeof(msg
));
1275 msg
.cmd_type
= LTTNG_CONSUMER_DATA_PENDING
;
1276 msg
.u
.data_pending
.session_id
= session_id
;
1278 /* Send command for each consumer */
1280 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1282 pthread_mutex_lock(socket
->lock
);
1283 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1285 pthread_mutex_unlock(socket
->lock
);
1290 * No need for a recv reply status because the answer to the command is
1291 * the reply status message.
1294 ret
= consumer_socket_recv(socket
, &ret_code
, sizeof(ret_code
));
1296 pthread_mutex_unlock(socket
->lock
);
1299 pthread_mutex_unlock(socket
->lock
);
1301 if (ret_code
== 1) {
1307 DBG("Consumer data is %s pending for session id %" PRIu64
,
1308 ret_code
== 1 ? "" : "NOT", session_id
);
1317 * Send a flush command to consumer using the given channel key.
1319 * Return 0 on success else a negative value.
1321 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
)
1324 struct lttcomm_consumer_msg msg
;
1328 DBG2("Consumer flush channel key %" PRIu64
, key
);
1330 memset(&msg
, 0, sizeof(msg
));
1331 msg
.cmd_type
= LTTNG_CONSUMER_FLUSH_CHANNEL
;
1332 msg
.u
.flush_channel
.key
= key
;
1334 pthread_mutex_lock(socket
->lock
);
1335 health_code_update();
1337 ret
= consumer_send_msg(socket
, &msg
);
1343 health_code_update();
1344 pthread_mutex_unlock(socket
->lock
);
1349 * Send a clear quiescent command to consumer using the given channel key.
1351 * Return 0 on success else a negative value.
1353 int consumer_clear_quiescent_channel(struct consumer_socket
*socket
, uint64_t key
)
1356 struct lttcomm_consumer_msg msg
;
1360 DBG2("Consumer clear quiescent channel key %" PRIu64
, key
);
1362 memset(&msg
, 0, sizeof(msg
));
1363 msg
.cmd_type
= LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
;
1364 msg
.u
.clear_quiescent_channel
.key
= key
;
1366 pthread_mutex_lock(socket
->lock
);
1367 health_code_update();
1369 ret
= consumer_send_msg(socket
, &msg
);
1375 health_code_update();
1376 pthread_mutex_unlock(socket
->lock
);
1381 * Send a close metadata command to consumer using the given channel key.
1382 * Called with registry lock held.
1384 * Return 0 on success else a negative value.
1386 int consumer_close_metadata(struct consumer_socket
*socket
,
1387 uint64_t metadata_key
)
1390 struct lttcomm_consumer_msg msg
;
1394 DBG2("Consumer close metadata channel key %" PRIu64
, metadata_key
);
1396 memset(&msg
, 0, sizeof(msg
));
1397 msg
.cmd_type
= LTTNG_CONSUMER_CLOSE_METADATA
;
1398 msg
.u
.close_metadata
.key
= metadata_key
;
1400 pthread_mutex_lock(socket
->lock
);
1401 health_code_update();
1403 ret
= consumer_send_msg(socket
, &msg
);
1409 health_code_update();
1410 pthread_mutex_unlock(socket
->lock
);
1415 * Send a setup metdata command to consumer using the given channel key.
1417 * Return 0 on success else a negative value.
1419 int consumer_setup_metadata(struct consumer_socket
*socket
,
1420 uint64_t metadata_key
)
1423 struct lttcomm_consumer_msg msg
;
1427 DBG2("Consumer setup metadata channel key %" PRIu64
, metadata_key
);
1429 memset(&msg
, 0, sizeof(msg
));
1430 msg
.cmd_type
= LTTNG_CONSUMER_SETUP_METADATA
;
1431 msg
.u
.setup_metadata
.key
= metadata_key
;
1433 pthread_mutex_lock(socket
->lock
);
1434 health_code_update();
1436 ret
= consumer_send_msg(socket
, &msg
);
1442 health_code_update();
1443 pthread_mutex_unlock(socket
->lock
);
1448 * Send metadata string to consumer.
1449 * RCU read-side lock must be held to guarantee existence of socket.
1451 * Return 0 on success else a negative value.
1453 int consumer_push_metadata(struct consumer_socket
*socket
,
1454 uint64_t metadata_key
, char *metadata_str
, size_t len
,
1455 size_t target_offset
, uint64_t version
)
1458 struct lttcomm_consumer_msg msg
;
1462 DBG2("Consumer push metadata to consumer socket %d", *socket
->fd_ptr
);
1464 pthread_mutex_lock(socket
->lock
);
1466 memset(&msg
, 0, sizeof(msg
));
1467 msg
.cmd_type
= LTTNG_CONSUMER_PUSH_METADATA
;
1468 msg
.u
.push_metadata
.key
= metadata_key
;
1469 msg
.u
.push_metadata
.target_offset
= target_offset
;
1470 msg
.u
.push_metadata
.len
= len
;
1471 msg
.u
.push_metadata
.version
= version
;
1473 health_code_update();
1474 ret
= consumer_send_msg(socket
, &msg
);
1475 if (ret
< 0 || len
== 0) {
1479 DBG3("Consumer pushing metadata on sock %d of len %zu", *socket
->fd_ptr
,
1482 ret
= consumer_socket_send(socket
, metadata_str
, len
);
1487 health_code_update();
1488 ret
= consumer_recv_status_reply(socket
);
1494 pthread_mutex_unlock(socket
->lock
);
1495 health_code_update();
1500 * Ask the consumer to snapshot a specific channel using the key.
1502 * Returns LTTNG_OK on success or else an LTTng error code.
1504 enum lttng_error_code
consumer_snapshot_channel(struct consumer_socket
*socket
,
1505 uint64_t key
, const struct consumer_output
*output
, int metadata
,
1506 uid_t uid
, gid_t gid
, const char *channel_path
, int wait
,
1507 uint64_t nb_packets_per_stream
)
1510 enum lttng_error_code status
= LTTNG_OK
;
1511 struct lttcomm_consumer_msg msg
;
1516 DBG("Consumer snapshot channel key %" PRIu64
, key
);
1518 memset(&msg
, 0, sizeof(msg
));
1519 msg
.cmd_type
= LTTNG_CONSUMER_SNAPSHOT_CHANNEL
;
1520 msg
.u
.snapshot_channel
.key
= key
;
1521 msg
.u
.snapshot_channel
.nb_packets_per_stream
= nb_packets_per_stream
;
1522 msg
.u
.snapshot_channel
.metadata
= metadata
;
1524 if (output
->type
== CONSUMER_DST_NET
) {
1525 msg
.u
.snapshot_channel
.relayd_id
=
1526 output
->net_seq_index
;
1527 msg
.u
.snapshot_channel
.use_relayd
= 1;
1529 msg
.u
.snapshot_channel
.relayd_id
= (uint64_t) -1ULL;
1531 ret
= lttng_strncpy(msg
.u
.snapshot_channel
.pathname
,
1533 sizeof(msg
.u
.snapshot_channel
.pathname
));
1535 ERR("Snapshot path exceeds the maximal allowed length of %zu bytes (%zu bytes required) with path \"%s\"",
1536 sizeof(msg
.u
.snapshot_channel
.pathname
),
1537 strlen(channel_path
),
1539 status
= LTTNG_ERR_SNAPSHOT_FAIL
;
1543 health_code_update();
1544 pthread_mutex_lock(socket
->lock
);
1545 ret
= consumer_send_msg(socket
, &msg
);
1546 pthread_mutex_unlock(socket
->lock
);
1549 case LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
:
1550 status
= LTTNG_ERR_CHAN_NOT_FOUND
;
1553 status
= LTTNG_ERR_SNAPSHOT_FAIL
;
1560 health_code_update();
1565 * Ask the consumer the number of discarded events for a channel.
1567 int consumer_get_discarded_events(uint64_t session_id
, uint64_t channel_key
,
1568 struct consumer_output
*consumer
, uint64_t *discarded
)
1571 struct consumer_socket
*socket
;
1572 struct lttng_ht_iter iter
;
1573 struct lttcomm_consumer_msg msg
;
1577 DBG3("Consumer discarded events id %" PRIu64
, session_id
);
1579 memset(&msg
, 0, sizeof(msg
));
1580 msg
.cmd_type
= LTTNG_CONSUMER_DISCARDED_EVENTS
;
1581 msg
.u
.discarded_events
.session_id
= session_id
;
1582 msg
.u
.discarded_events
.channel_key
= channel_key
;
1586 /* Send command for each consumer */
1588 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1590 uint64_t consumer_discarded
= 0;
1591 pthread_mutex_lock(socket
->lock
);
1592 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1594 pthread_mutex_unlock(socket
->lock
);
1599 * No need for a recv reply status because the answer to the
1600 * command is the reply status message.
1602 ret
= consumer_socket_recv(socket
, &consumer_discarded
,
1603 sizeof(consumer_discarded
));
1605 ERR("get discarded events");
1606 pthread_mutex_unlock(socket
->lock
);
1609 pthread_mutex_unlock(socket
->lock
);
1610 *discarded
+= consumer_discarded
;
1613 DBG("Consumer discarded %" PRIu64
" events in session id %" PRIu64
,
1614 *discarded
, session_id
);
1622 * Ask the consumer the number of lost packets for a channel.
1624 int consumer_get_lost_packets(uint64_t session_id
, uint64_t channel_key
,
1625 struct consumer_output
*consumer
, uint64_t *lost
)
1628 struct consumer_socket
*socket
;
1629 struct lttng_ht_iter iter
;
1630 struct lttcomm_consumer_msg msg
;
1634 DBG3("Consumer lost packets id %" PRIu64
, session_id
);
1636 memset(&msg
, 0, sizeof(msg
));
1637 msg
.cmd_type
= LTTNG_CONSUMER_LOST_PACKETS
;
1638 msg
.u
.lost_packets
.session_id
= session_id
;
1639 msg
.u
.lost_packets
.channel_key
= channel_key
;
1643 /* Send command for each consumer */
1645 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1647 uint64_t consumer_lost
= 0;
1648 pthread_mutex_lock(socket
->lock
);
1649 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1651 pthread_mutex_unlock(socket
->lock
);
1656 * No need for a recv reply status because the answer to the
1657 * command is the reply status message.
1659 ret
= consumer_socket_recv(socket
, &consumer_lost
,
1660 sizeof(consumer_lost
));
1662 ERR("get lost packets");
1663 pthread_mutex_unlock(socket
->lock
);
1666 pthread_mutex_unlock(socket
->lock
);
1667 *lost
+= consumer_lost
;
1670 DBG("Consumer lost %" PRIu64
" packets in session id %" PRIu64
,
1679 * Ask the consumer to rotate a channel.
1681 * The new_chunk_id is the session->rotate_count that has been incremented
1682 * when the rotation started. On the relay, this allows to keep track in which
1683 * chunk each stream is currently writing to (for the rotate_pending operation).
1685 int consumer_rotate_channel(struct consumer_socket
*socket
, uint64_t key
,
1686 uid_t uid
, gid_t gid
, struct consumer_output
*output
,
1687 bool is_metadata_channel
)
1690 struct lttcomm_consumer_msg msg
;
1694 DBG("Consumer rotate channel key %" PRIu64
, key
);
1696 pthread_mutex_lock(socket
->lock
);
1697 memset(&msg
, 0, sizeof(msg
));
1698 msg
.cmd_type
= LTTNG_CONSUMER_ROTATE_CHANNEL
;
1699 msg
.u
.rotate_channel
.key
= key
;
1700 msg
.u
.rotate_channel
.metadata
= !!is_metadata_channel
;
1702 if (output
->type
== CONSUMER_DST_NET
) {
1703 msg
.u
.rotate_channel
.relayd_id
= output
->net_seq_index
;
1705 msg
.u
.rotate_channel
.relayd_id
= (uint64_t) -1ULL;
1708 health_code_update();
1709 ret
= consumer_send_msg(socket
, &msg
);
1712 case LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
:
1713 ret
= -LTTNG_ERR_CHAN_NOT_FOUND
;
1716 ret
= -LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
1722 pthread_mutex_unlock(socket
->lock
);
1723 health_code_update();
1727 int consumer_open_channel_packets(struct consumer_socket
*socket
, uint64_t key
)
1730 const struct lttcomm_consumer_msg msg
= {
1731 .cmd_type
= LTTNG_CONSUMER_OPEN_CHANNEL_PACKETS
,
1732 .u
.open_channel_packets
.key
= key
,
1737 DBG("Consumer open channel packets: channel key = %" PRIu64
, key
);
1739 health_code_update();
1741 pthread_mutex_lock(socket
->lock
);
1742 ret
= consumer_send_msg(socket
, &msg
);
1743 pthread_mutex_unlock(socket
->lock
);
1749 health_code_update();
1753 int consumer_clear_channel(struct consumer_socket
*socket
, uint64_t key
)
1756 struct lttcomm_consumer_msg msg
;
1760 DBG("Consumer clear channel %" PRIu64
, key
);
1762 memset(&msg
, 0, sizeof(msg
));
1763 msg
.cmd_type
= LTTNG_CONSUMER_CLEAR_CHANNEL
;
1764 msg
.u
.clear_channel
.key
= key
;
1766 health_code_update();
1768 pthread_mutex_lock(socket
->lock
);
1769 ret
= consumer_send_msg(socket
, &msg
);
1775 pthread_mutex_unlock(socket
->lock
);
1777 health_code_update();
1781 int consumer_init(struct consumer_socket
*socket
,
1782 const lttng_uuid sessiond_uuid
)
1785 struct lttcomm_consumer_msg msg
= {
1786 .cmd_type
= LTTNG_CONSUMER_INIT
,
1791 DBG("Sending consumer initialization command");
1792 lttng_uuid_copy(msg
.u
.init
.sessiond_uuid
, sessiond_uuid
);
1794 health_code_update();
1795 ret
= consumer_send_msg(socket
, &msg
);
1801 health_code_update();
1806 * Ask the consumer to create a new chunk for a given session.
1808 * Called with the consumer socket lock held.
1810 int consumer_create_trace_chunk(struct consumer_socket
*socket
,
1811 uint64_t relayd_id
, uint64_t session_id
,
1812 struct lttng_trace_chunk
*chunk
,
1813 const char *domain_subdir
)
1816 enum lttng_trace_chunk_status chunk_status
;
1817 struct lttng_credentials chunk_credentials
;
1818 const struct lttng_directory_handle
*chunk_directory_handle
= NULL
;
1819 struct lttng_directory_handle
*domain_handle
= NULL
;
1821 const char *chunk_name
;
1822 bool chunk_name_overridden
;
1824 time_t creation_timestamp
;
1825 char creation_timestamp_buffer
[ISO8601_STR_LEN
];
1826 const char *creation_timestamp_str
= "(none)";
1827 const bool chunk_has_local_output
= relayd_id
== -1ULL;
1828 enum lttng_trace_chunk_status tc_status
;
1829 struct lttcomm_consumer_msg msg
= {
1830 .cmd_type
= LTTNG_CONSUMER_CREATE_TRACE_CHUNK
,
1831 .u
.create_trace_chunk
.session_id
= session_id
,
1837 if (relayd_id
!= -1ULL) {
1838 LTTNG_OPTIONAL_SET(&msg
.u
.create_trace_chunk
.relayd_id
,
1842 chunk_status
= lttng_trace_chunk_get_name(chunk
, &chunk_name
,
1843 &chunk_name_overridden
);
1844 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
&&
1845 chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_NONE
) {
1846 ERR("Failed to get name of trace chunk");
1847 ret
= -LTTNG_ERR_FATAL
;
1850 if (chunk_name_overridden
) {
1851 ret
= lttng_strncpy(msg
.u
.create_trace_chunk
.override_name
,
1853 sizeof(msg
.u
.create_trace_chunk
.override_name
));
1855 ERR("Trace chunk name \"%s\" exceeds the maximal length allowed by the consumer protocol",
1857 ret
= -LTTNG_ERR_FATAL
;
1862 chunk_status
= lttng_trace_chunk_get_creation_timestamp(chunk
,
1863 &creation_timestamp
);
1864 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1865 ret
= -LTTNG_ERR_FATAL
;
1868 msg
.u
.create_trace_chunk
.creation_timestamp
=
1869 (uint64_t) creation_timestamp
;
1870 /* Only used for logging purposes. */
1871 ret
= time_to_iso8601_str(creation_timestamp
,
1872 creation_timestamp_buffer
,
1873 sizeof(creation_timestamp_buffer
));
1874 creation_timestamp_str
= !ret
? creation_timestamp_buffer
:
1875 "(formatting error)";
1877 chunk_status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1878 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1880 * Anonymous trace chunks should never be transmitted
1881 * to remote peers (consumerd and relayd). They are used
1882 * internally for backward-compatibility purposes.
1884 ret
= -LTTNG_ERR_FATAL
;
1887 msg
.u
.create_trace_chunk
.chunk_id
= chunk_id
;
1889 if (chunk_has_local_output
) {
1890 chunk_status
= lttng_trace_chunk_borrow_chunk_directory_handle(
1891 chunk
, &chunk_directory_handle
);
1892 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1893 ret
= -LTTNG_ERR_FATAL
;
1896 chunk_status
= lttng_trace_chunk_get_credentials(
1897 chunk
, &chunk_credentials
);
1898 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1900 * Not associating credentials to a sessiond chunk is a
1901 * fatal internal error.
1903 ret
= -LTTNG_ERR_FATAL
;
1906 tc_status
= lttng_trace_chunk_create_subdirectory(
1907 chunk
, domain_subdir
);
1908 if (tc_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1909 PERROR("Failed to create chunk domain output directory \"%s\"",
1911 ret
= -LTTNG_ERR_FATAL
;
1914 domain_handle
= lttng_directory_handle_create_from_handle(
1916 chunk_directory_handle
);
1917 if (!domain_handle
) {
1918 ret
= -LTTNG_ERR_FATAL
;
1923 * This will only compile on platforms that support
1924 * dirfd (POSIX.2008). This is fine as the session daemon
1925 * is only built for such platforms.
1927 * The ownership of the chunk directory handle's is maintained
1928 * by the trace chunk.
1930 domain_dirfd
= lttng_directory_handle_get_dirfd(
1932 assert(domain_dirfd
>= 0);
1934 msg
.u
.create_trace_chunk
.credentials
.value
.uid
=
1935 lttng_credentials_get_uid(&chunk_credentials
);
1936 msg
.u
.create_trace_chunk
.credentials
.value
.gid
=
1937 lttng_credentials_get_gid(&chunk_credentials
);
1938 msg
.u
.create_trace_chunk
.credentials
.is_set
= 1;
1941 DBG("Sending consumer create trace chunk command: relayd_id = %" PRId64
1942 ", session_id = %" PRIu64
", chunk_id = %" PRIu64
1943 ", creation_timestamp = %s",
1944 relayd_id
, session_id
, chunk_id
,
1945 creation_timestamp_str
);
1946 health_code_update();
1947 ret
= consumer_send_msg(socket
, &msg
);
1948 health_code_update();
1950 ERR("Trace chunk creation error on consumer");
1951 ret
= -LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
1955 if (chunk_has_local_output
) {
1956 DBG("Sending trace chunk domain directory fd to consumer");
1957 health_code_update();
1958 ret
= consumer_send_fds(socket
, &domain_dirfd
, 1);
1959 health_code_update();
1961 ERR("Trace chunk creation error on consumer");
1962 ret
= -LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
1967 lttng_directory_handle_put(domain_handle
);
1972 * Ask the consumer to close a trace chunk for a given session.
1974 * Called with the consumer socket lock held.
1976 int consumer_close_trace_chunk(struct consumer_socket
*socket
,
1977 uint64_t relayd_id
, uint64_t session_id
,
1978 struct lttng_trace_chunk
*chunk
,
1979 char *closed_trace_chunk_path
)
1982 enum lttng_trace_chunk_status chunk_status
;
1983 struct lttcomm_consumer_msg msg
= {
1984 .cmd_type
= LTTNG_CONSUMER_CLOSE_TRACE_CHUNK
,
1985 .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
;
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 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 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 struct lttcomm_consumer_msg msg
= {
2109 .cmd_type
= LTTNG_CONSUMER_TRACE_CHUNK_EXISTS
,
2110 .u
.trace_chunk_exists
.session_id
= session_id
,
2113 const char *consumer_reply_str
;
2117 if (relayd_id
!= -1ULL) {
2118 LTTNG_OPTIONAL_SET(&msg
.u
.trace_chunk_exists
.relayd_id
,
2122 chunk_status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
2123 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2125 * Anonymous trace chunks should never be transmitted
2126 * to remote peers (consumerd and relayd). They are used
2127 * internally for backward-compatibility purposes.
2129 ret
= -LTTNG_ERR_FATAL
;
2132 msg
.u
.trace_chunk_exists
.chunk_id
= chunk_id
;
2134 DBG("Sending consumer trace chunk exists command: relayd_id = %" PRId64
2135 ", session_id = %" PRIu64
2136 ", chunk_id = %" PRIu64
, relayd_id
, session_id
, chunk_id
);
2138 health_code_update();
2139 ret
= consumer_send_msg(socket
, &msg
);
2141 case LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
:
2142 consumer_reply_str
= "unknown trace chunk";
2143 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_UNKNOWN_CHUNK
;
2145 case LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL
:
2146 consumer_reply_str
= "trace chunk exists locally";
2147 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_EXISTS_LOCAL
;
2149 case LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE
:
2150 consumer_reply_str
= "trace chunk exists on remote peer";
2151 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_EXISTS_REMOTE
;
2154 ERR("Consumer returned an error from TRACE_CHUNK_EXISTS command");
2158 DBG("Consumer reply to TRACE_CHUNK_EXISTS command: %s",
2159 consumer_reply_str
);
2162 health_code_update();