2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
3 * 2018 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License, version 2 only, as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 51
16 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include <sys/types.h>
29 #include <common/common.h>
30 #include <common/defaults.h>
31 #include <common/uri.h>
32 #include <common/relayd/relayd.h>
33 #include <common/string-utils/format.h>
36 #include "health-sessiond.h"
39 #include "lttng-sessiond.h"
42 * Return allocated full pathname of the session using the consumer trace path
43 * and subdir if available.
45 * The caller can safely free(3) the returned value. On error, NULL is
48 char *setup_channel_trace_path(struct consumer_output
*consumer
,
49 const char *session_path
)
60 * Allocate the string ourself to make sure we never exceed
63 pathname
= zmalloc(LTTNG_PATH_MAX
);
68 /* Get correct path name destination */
69 if (consumer
->type
== CONSUMER_DST_NET
&&
70 consumer
->relay_major_version
== 2 &&
71 consumer
->relay_minor_version
< 11) {
72 ret
= snprintf(pathname
, LTTNG_PATH_MAX
, "%s%s/%s%s",
73 consumer
->dst
.net
.base_dir
,
74 consumer
->chunk_path
, consumer
->domain_subdir
,
77 ret
= snprintf(pathname
, LTTNG_PATH_MAX
, "%s%s",
78 consumer
->domain_subdir
, session_path
);
80 DBG3("Consumer trace path relative to current trace chunk: \"%s\"",
83 PERROR("Failed to format channel path");
85 } else if (ret
>= LTTNG_PATH_MAX
) {
86 ERR("Truncation occurred while formatting channel path");
97 * Send a data payload using a given consumer socket of size len.
99 * The consumer socket lock MUST be acquired before calling this since this
100 * function can change the fd value.
102 * Return 0 on success else a negative value on error.
104 int consumer_socket_send(struct consumer_socket
*socket
, void *msg
, size_t len
)
110 assert(socket
->fd_ptr
);
113 /* Consumer socket is invalid. Stopping. */
114 fd
= *socket
->fd_ptr
;
119 size
= lttcomm_send_unix_sock(fd
, msg
, len
);
121 /* The above call will print a PERROR on error. */
122 DBG("Error when sending data to consumer on sock %d", fd
);
124 * At this point, the socket is not usable anymore thus closing it and
125 * setting the file descriptor to -1 so it is not reused.
128 /* This call will PERROR on error. */
129 (void) lttcomm_close_unix_sock(fd
);
130 *socket
->fd_ptr
= -1;
141 * Receive a data payload using a given consumer socket of size len.
143 * The consumer socket lock MUST be acquired before calling this since this
144 * function can change the fd value.
146 * Return 0 on success else a negative value on error.
148 int consumer_socket_recv(struct consumer_socket
*socket
, void *msg
, size_t len
)
154 assert(socket
->fd_ptr
);
157 /* Consumer socket is invalid. Stopping. */
158 fd
= *socket
->fd_ptr
;
163 size
= lttcomm_recv_unix_sock(fd
, msg
, len
);
165 /* The above call will print a PERROR on error. */
166 DBG("Error when receiving data from the consumer socket %d", fd
);
168 * At this point, the socket is not usable anymore thus closing it and
169 * setting the file descriptor to -1 so it is not reused.
172 /* This call will PERROR on error. */
173 (void) lttcomm_close_unix_sock(fd
);
174 *socket
->fd_ptr
= -1;
185 * Receive a reply command status message from the consumer. Consumer socket
186 * lock MUST be acquired before calling this function.
188 * Return 0 on success, -1 on recv error or a negative lttng error code which
189 * was possibly returned by the consumer.
191 int consumer_recv_status_reply(struct consumer_socket
*sock
)
194 struct lttcomm_consumer_status_msg reply
;
198 ret
= consumer_socket_recv(sock
, &reply
, sizeof(reply
));
203 if (reply
.ret_code
== LTTCOMM_CONSUMERD_SUCCESS
) {
207 ret
= -reply
.ret_code
;
208 DBG("Consumer ret code %d", ret
);
216 * Once the ASK_CHANNEL command is sent to the consumer, the channel
217 * information are sent back. This call receives that data and populates key
220 * On success return 0 and both key and stream_count are set. On error, a
221 * negative value is sent back and both parameters are untouched.
223 int consumer_recv_status_channel(struct consumer_socket
*sock
,
224 uint64_t *key
, unsigned int *stream_count
)
227 struct lttcomm_consumer_status_channel reply
;
230 assert(stream_count
);
233 ret
= consumer_socket_recv(sock
, &reply
, sizeof(reply
));
238 /* An error is possible so don't touch the key and stream_count. */
239 if (reply
.ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
245 *stream_count
= reply
.stream_count
;
253 * Send destroy relayd command to consumer.
255 * On success return positive value. On error, negative value.
257 int consumer_send_destroy_relayd(struct consumer_socket
*sock
,
258 struct consumer_output
*consumer
)
261 struct lttcomm_consumer_msg msg
;
266 DBG2("Sending destroy relayd command to consumer sock %d", *sock
->fd_ptr
);
268 memset(&msg
, 0, sizeof(msg
));
269 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_RELAYD
;
270 msg
.u
.destroy_relayd
.net_seq_idx
= consumer
->net_seq_index
;
272 pthread_mutex_lock(sock
->lock
);
273 ret
= consumer_socket_send(sock
, &msg
, sizeof(msg
));
278 /* Don't check the return value. The caller will do it. */
279 ret
= consumer_recv_status_reply(sock
);
281 DBG2("Consumer send destroy relayd command done");
284 pthread_mutex_unlock(sock
->lock
);
289 * For each consumer socket in the consumer output object, send a destroy
292 void consumer_output_send_destroy_relayd(struct consumer_output
*consumer
)
294 struct lttng_ht_iter iter
;
295 struct consumer_socket
*socket
;
299 /* Destroy any relayd connection */
300 if (consumer
->type
== CONSUMER_DST_NET
) {
302 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
306 /* Send destroy relayd command */
307 ret
= consumer_send_destroy_relayd(socket
, consumer
);
309 DBG("Unable to send destroy relayd command to consumer");
310 /* Continue since we MUST delete everything at this point. */
318 * From a consumer_data structure, allocate and add a consumer socket to the
321 * Return 0 on success, else negative value on error
323 int consumer_create_socket(struct consumer_data
*data
,
324 struct consumer_output
*output
)
327 struct consumer_socket
*socket
;
331 if (output
== NULL
|| data
->cmd_sock
< 0) {
333 * Not an error. Possible there is simply not spawned consumer or it's
334 * disabled for the tracing session asking the socket.
340 socket
= consumer_find_socket(data
->cmd_sock
, output
);
342 if (socket
== NULL
) {
343 socket
= consumer_allocate_socket(&data
->cmd_sock
);
344 if (socket
== NULL
) {
349 socket
->registered
= 0;
350 socket
->lock
= &data
->lock
;
352 consumer_add_socket(socket
, output
);
356 socket
->type
= data
->type
;
358 DBG3("Consumer socket created (fd: %d) and added to output",
366 * Return the consumer socket from the given consumer output with the right
367 * bitness. On error, returns NULL.
369 * The caller MUST acquire a rcu read side lock and keep it until the socket
370 * object reference is not needed anymore.
372 struct consumer_socket
*consumer_find_socket_by_bitness(int bits
,
373 const struct consumer_output
*consumer
)
376 struct consumer_socket
*socket
= NULL
;
380 consumer_fd
= uatomic_read(&ust_consumerd64_fd
);
383 consumer_fd
= uatomic_read(&ust_consumerd32_fd
);
390 socket
= consumer_find_socket(consumer_fd
, consumer
);
392 ERR("Consumer socket fd %d not found in consumer obj %p",
393 consumer_fd
, consumer
);
401 * Find a consumer_socket in a consumer_output hashtable. Read side lock must
402 * be acquired before calling this function and across use of the
403 * returned consumer_socket.
405 struct consumer_socket
*consumer_find_socket(int key
,
406 const struct consumer_output
*consumer
)
408 struct lttng_ht_iter iter
;
409 struct lttng_ht_node_ulong
*node
;
410 struct consumer_socket
*socket
= NULL
;
412 /* Negative keys are lookup failures */
413 if (key
< 0 || consumer
== NULL
) {
417 lttng_ht_lookup(consumer
->socks
, (void *)((unsigned long) key
),
419 node
= lttng_ht_iter_get_node_ulong(&iter
);
421 socket
= caa_container_of(node
, struct consumer_socket
, node
);
428 * Allocate a new consumer_socket and return the pointer.
430 struct consumer_socket
*consumer_allocate_socket(int *fd
)
432 struct consumer_socket
*socket
= NULL
;
436 socket
= zmalloc(sizeof(struct consumer_socket
));
437 if (socket
== NULL
) {
438 PERROR("zmalloc consumer socket");
443 lttng_ht_node_init_ulong(&socket
->node
, *fd
);
450 * Add consumer socket to consumer output object. Read side lock must be
451 * acquired before calling this function.
453 void consumer_add_socket(struct consumer_socket
*sock
,
454 struct consumer_output
*consumer
)
459 lttng_ht_add_unique_ulong(consumer
->socks
, &sock
->node
);
463 * Delete consumer socket to consumer output object. Read side lock must be
464 * acquired before calling this function.
466 void consumer_del_socket(struct consumer_socket
*sock
,
467 struct consumer_output
*consumer
)
470 struct lttng_ht_iter iter
;
475 iter
.iter
.node
= &sock
->node
.node
;
476 ret
= lttng_ht_del(consumer
->socks
, &iter
);
481 * RCU destroy call function.
483 static void destroy_socket_rcu(struct rcu_head
*head
)
485 struct lttng_ht_node_ulong
*node
=
486 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
487 struct consumer_socket
*socket
=
488 caa_container_of(node
, struct consumer_socket
, node
);
494 * Destroy and free socket pointer in a call RCU. Read side lock must be
495 * acquired before calling this function.
497 void consumer_destroy_socket(struct consumer_socket
*sock
)
502 * We DO NOT close the file descriptor here since it is global to the
503 * session daemon and is closed only if the consumer dies or a custom
504 * consumer was registered,
506 if (sock
->registered
) {
507 DBG3("Consumer socket was registered. Closing fd %d", *sock
->fd_ptr
);
508 lttcomm_close_unix_sock(*sock
->fd_ptr
);
511 call_rcu(&sock
->node
.head
, destroy_socket_rcu
);
515 * Allocate and assign data to a consumer_output object.
517 * Return pointer to structure.
519 struct consumer_output
*consumer_create_output(enum consumer_dst_type type
)
521 struct consumer_output
*output
= NULL
;
523 output
= zmalloc(sizeof(struct consumer_output
));
524 if (output
== NULL
) {
525 PERROR("zmalloc consumer_output");
529 /* By default, consumer output is enabled */
532 output
->net_seq_index
= (uint64_t) -1ULL;
533 urcu_ref_init(&output
->ref
);
535 output
->socks
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
542 * Iterate over the consumer output socket hash table and destroy them. The
543 * socket file descriptor are only closed if the consumer output was
544 * registered meaning it's an external consumer.
546 void consumer_destroy_output_sockets(struct consumer_output
*obj
)
548 struct lttng_ht_iter iter
;
549 struct consumer_socket
*socket
;
556 cds_lfht_for_each_entry(obj
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
557 consumer_del_socket(socket
, obj
);
558 consumer_destroy_socket(socket
);
564 * Delete the consumer_output object from the list and free the ptr.
566 * Should *NOT* be called with RCU read-side lock held.
568 static void consumer_release_output(struct urcu_ref
*ref
)
570 struct consumer_output
*obj
=
571 caa_container_of(ref
, struct consumer_output
, ref
);
573 consumer_destroy_output_sockets(obj
);
576 /* Finally destroy HT */
577 ht_cleanup_push(obj
->socks
);
584 * Get the consumer_output object.
586 void consumer_output_get(struct consumer_output
*obj
)
588 urcu_ref_get(&obj
->ref
);
592 * Put the consumer_output object.
594 * Should *NOT* be called with RCU read-side lock held.
596 void consumer_output_put(struct consumer_output
*obj
)
601 urcu_ref_put(&obj
->ref
, consumer_release_output
);
605 * Copy consumer output and returned the newly allocated copy.
607 * Should *NOT* be called with RCU read-side lock held.
609 struct consumer_output
*consumer_copy_output(struct consumer_output
*src
)
612 struct consumer_output
*output
;
616 output
= consumer_create_output(src
->type
);
617 if (output
== NULL
) {
620 output
->enabled
= src
->enabled
;
621 output
->net_seq_index
= src
->net_seq_index
;
622 memcpy(output
->domain_subdir
, src
->domain_subdir
,
623 sizeof(output
->domain_subdir
));
624 output
->snapshot
= src
->snapshot
;
625 output
->relay_major_version
= src
->relay_major_version
;
626 output
->relay_minor_version
= src
->relay_minor_version
;
627 memcpy(&output
->dst
, &src
->dst
, sizeof(output
->dst
));
628 ret
= consumer_copy_sockets(output
, src
);
636 consumer_output_put(output
);
641 * Copy consumer sockets from src to dst.
643 * Return 0 on success or else a negative value.
645 int consumer_copy_sockets(struct consumer_output
*dst
,
646 struct consumer_output
*src
)
649 struct lttng_ht_iter iter
;
650 struct consumer_socket
*socket
, *copy_sock
;
656 cds_lfht_for_each_entry(src
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
657 /* Ignore socket that are already there. */
658 copy_sock
= consumer_find_socket(*socket
->fd_ptr
, dst
);
663 /* Create new socket object. */
664 copy_sock
= consumer_allocate_socket(socket
->fd_ptr
);
665 if (copy_sock
== NULL
) {
671 copy_sock
->registered
= socket
->registered
;
673 * This is valid because this lock is shared accross all consumer
674 * object being the global lock of the consumer data structure of the
677 copy_sock
->lock
= socket
->lock
;
678 consumer_add_socket(copy_sock
, dst
);
687 * Set network URI to the consumer output.
689 * Return 0 on success. Return 1 if the URI were equal. Else, negative value on
692 int consumer_set_network_uri(const struct ltt_session
*session
,
693 struct consumer_output
*output
,
694 struct lttng_uri
*uri
)
697 struct lttng_uri
*dst_uri
= NULL
;
699 /* Code flow error safety net. */
703 switch (uri
->stype
) {
704 case LTTNG_STREAM_CONTROL
:
705 dst_uri
= &output
->dst
.net
.control
;
706 output
->dst
.net
.control_isset
= 1;
707 if (uri
->port
== 0) {
708 /* Assign default port. */
709 uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
711 if (output
->dst
.net
.data_isset
&& uri
->port
==
712 output
->dst
.net
.data
.port
) {
713 ret
= -LTTNG_ERR_INVALID
;
717 DBG3("Consumer control URI set with port %d", uri
->port
);
719 case LTTNG_STREAM_DATA
:
720 dst_uri
= &output
->dst
.net
.data
;
721 output
->dst
.net
.data_isset
= 1;
722 if (uri
->port
== 0) {
723 /* Assign default port. */
724 uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
726 if (output
->dst
.net
.control_isset
&& uri
->port
==
727 output
->dst
.net
.control
.port
) {
728 ret
= -LTTNG_ERR_INVALID
;
732 DBG3("Consumer data URI set with port %d", uri
->port
);
735 ERR("Set network uri type unknown %d", uri
->stype
);
736 ret
= -LTTNG_ERR_INVALID
;
740 ret
= uri_compare(dst_uri
, uri
);
742 /* Same URI, don't touch it and return success. */
743 DBG3("URI network compare are the same");
747 /* URIs were not equal, replacing it. */
748 memcpy(dst_uri
, uri
, sizeof(struct lttng_uri
));
749 output
->type
= CONSUMER_DST_NET
;
750 if (dst_uri
->stype
!= LTTNG_STREAM_CONTROL
) {
751 /* Only the control uri needs to contain the path. */
756 * If the user has specified a subdir as part of the control
757 * URL, the session's base output directory is:
758 * /RELAYD_OUTPUT_PATH/HOSTNAME/USER_SPECIFIED_DIR
760 * Hence, the "base_dir" from which all stream files and
761 * session rotation chunks are created takes the form
762 * /HOSTNAME/USER_SPECIFIED_DIR
764 * If the user has not specified an output directory as part of
765 * the control URL, the base output directory has the form:
766 * /RELAYD_OUTPUT_PATH/HOSTNAME/SESSION_NAME-CREATION_TIME
768 * Hence, the "base_dir" from which all stream files and
769 * session rotation chunks are created takes the form
770 * /HOSTNAME/SESSION_NAME-CREATION_TIME
772 * Note that automatically generated session names already
773 * contain the session's creation time. In that case, the
774 * creation time is omitted to prevent it from being duplicated
775 * in the final directory hierarchy.
778 if (strstr(uri
->subdir
, "../")) {
779 ERR("Network URI subdirs are not allowed to walk up the path hierarchy");
780 ret
= -LTTNG_ERR_INVALID
;
783 ret
= snprintf(output
->dst
.net
.base_dir
,
784 sizeof(output
->dst
.net
.base_dir
),
785 "/%s/%s/", session
->hostname
, uri
->subdir
);
787 if (session
->has_auto_generated_name
) {
788 ret
= snprintf(output
->dst
.net
.base_dir
,
789 sizeof(output
->dst
.net
.base_dir
),
790 "/%s/%s/", session
->hostname
,
793 char session_creation_datetime
[16];
797 timeinfo
= localtime(&session
->creation_time
);
799 ret
= -LTTNG_ERR_FATAL
;
802 strftime_ret
= strftime(session_creation_datetime
,
803 sizeof(session_creation_datetime
),
804 "%Y%m%d-%H%M%S", timeinfo
);
805 if (strftime_ret
== 0) {
806 ERR("Failed to format session creation timestamp while setting network URI");
807 ret
= -LTTNG_ERR_FATAL
;
810 ret
= snprintf(output
->dst
.net
.base_dir
,
811 sizeof(output
->dst
.net
.base_dir
),
812 "/%s/%s-%s/", session
->hostname
,
814 session_creation_datetime
);
817 if (ret
>= sizeof(output
->dst
.net
.base_dir
)) {
818 ret
= -LTTNG_ERR_INVALID
;
819 ERR("Truncation occurred while setting network output base directory");
821 } else if (ret
== -1) {
822 ret
= -LTTNG_ERR_INVALID
;
823 PERROR("Error occurred while setting network output base directory");
827 DBG3("Consumer set network uri base_dir path %s",
828 output
->dst
.net
.base_dir
);
839 * Send file descriptor to consumer via sock.
841 * The consumer socket lock must be held by the caller.
843 int consumer_send_fds(struct consumer_socket
*sock
, const int *fds
,
851 assert(pthread_mutex_trylock(sock
->lock
) == EBUSY
);
853 ret
= lttcomm_send_fds_unix_sock(*sock
->fd_ptr
, fds
, nb_fd
);
855 /* The above call will print a PERROR on error. */
856 DBG("Error when sending consumer fds on sock %d", *sock
->fd_ptr
);
860 ret
= consumer_recv_status_reply(sock
);
866 * Consumer send communication message structure to consumer.
868 * The consumer socket lock must be held by the caller.
870 int consumer_send_msg(struct consumer_socket
*sock
,
871 struct lttcomm_consumer_msg
*msg
)
877 assert(pthread_mutex_trylock(sock
->lock
) == EBUSY
);
879 ret
= consumer_socket_send(sock
, msg
, sizeof(struct lttcomm_consumer_msg
));
884 ret
= consumer_recv_status_reply(sock
);
891 * Consumer send channel communication message structure to consumer.
893 * The consumer socket lock must be held by the caller.
895 int consumer_send_channel(struct consumer_socket
*sock
,
896 struct lttcomm_consumer_msg
*msg
)
903 ret
= consumer_send_msg(sock
, msg
);
913 * Populate the given consumer msg structure with the ask_channel command
916 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
917 uint64_t subbuf_size
,
920 unsigned int switch_timer_interval
,
921 unsigned int read_timer_interval
,
922 unsigned int live_timer_interval
,
923 bool is_in_live_session
,
924 unsigned int monitor_timer_interval
,
928 const char *pathname
,
934 uint64_t tracefile_size
,
935 uint64_t tracefile_count
,
936 uint64_t session_id_per_pid
,
937 unsigned int monitor
,
938 uint32_t ust_app_uid
,
939 int64_t blocking_timeout
,
940 const char *root_shm_path
,
941 const char *shm_path
,
942 struct lttng_trace_chunk
*trace_chunk
,
943 const struct lttng_credentials
*buffer_credentials
)
947 /* Zeroed structure */
948 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
949 msg
->u
.ask_channel
.buffer_credentials
.uid
= UINT32_MAX
;
950 msg
->u
.ask_channel
.buffer_credentials
.gid
= UINT32_MAX
;
954 enum lttng_trace_chunk_status chunk_status
;
956 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
, &chunk_id
);
957 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
958 LTTNG_OPTIONAL_SET(&msg
->u
.ask_channel
.chunk_id
, chunk_id
);
960 msg
->u
.ask_channel
.buffer_credentials
.uid
= buffer_credentials
->uid
;
961 msg
->u
.ask_channel
.buffer_credentials
.gid
= buffer_credentials
->gid
;
963 msg
->cmd_type
= LTTNG_CONSUMER_ASK_CHANNEL_CREATION
;
964 msg
->u
.ask_channel
.subbuf_size
= subbuf_size
;
965 msg
->u
.ask_channel
.num_subbuf
= num_subbuf
;
966 msg
->u
.ask_channel
.overwrite
= overwrite
;
967 msg
->u
.ask_channel
.switch_timer_interval
= switch_timer_interval
;
968 msg
->u
.ask_channel
.read_timer_interval
= read_timer_interval
;
969 msg
->u
.ask_channel
.live_timer_interval
= live_timer_interval
;
970 msg
->u
.ask_channel
.is_live
= is_in_live_session
;
971 msg
->u
.ask_channel
.monitor_timer_interval
= monitor_timer_interval
;
972 msg
->u
.ask_channel
.output
= output
;
973 msg
->u
.ask_channel
.type
= type
;
974 msg
->u
.ask_channel
.session_id
= session_id
;
975 msg
->u
.ask_channel
.session_id_per_pid
= session_id_per_pid
;
976 msg
->u
.ask_channel
.relayd_id
= relayd_id
;
977 msg
->u
.ask_channel
.key
= key
;
978 msg
->u
.ask_channel
.chan_id
= chan_id
;
979 msg
->u
.ask_channel
.tracefile_size
= tracefile_size
;
980 msg
->u
.ask_channel
.tracefile_count
= tracefile_count
;
981 msg
->u
.ask_channel
.monitor
= monitor
;
982 msg
->u
.ask_channel
.ust_app_uid
= ust_app_uid
;
983 msg
->u
.ask_channel
.blocking_timeout
= blocking_timeout
;
985 memcpy(msg
->u
.ask_channel
.uuid
, uuid
, sizeof(msg
->u
.ask_channel
.uuid
));
988 strncpy(msg
->u
.ask_channel
.pathname
, pathname
,
989 sizeof(msg
->u
.ask_channel
.pathname
));
990 msg
->u
.ask_channel
.pathname
[sizeof(msg
->u
.ask_channel
.pathname
)-1] = '\0';
993 strncpy(msg
->u
.ask_channel
.name
, name
, sizeof(msg
->u
.ask_channel
.name
));
994 msg
->u
.ask_channel
.name
[sizeof(msg
->u
.ask_channel
.name
) - 1] = '\0';
997 strncpy(msg
->u
.ask_channel
.root_shm_path
, root_shm_path
,
998 sizeof(msg
->u
.ask_channel
.root_shm_path
));
999 msg
->u
.ask_channel
.root_shm_path
[sizeof(msg
->u
.ask_channel
.root_shm_path
) - 1] = '\0';
1002 strncpy(msg
->u
.ask_channel
.shm_path
, shm_path
,
1003 sizeof(msg
->u
.ask_channel
.shm_path
));
1004 msg
->u
.ask_channel
.shm_path
[sizeof(msg
->u
.ask_channel
.shm_path
) - 1] = '\0';
1009 * Init channel communication message structure.
1011 void consumer_init_add_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
1012 uint64_t channel_key
,
1013 uint64_t session_id
,
1014 const char *pathname
,
1019 unsigned int nb_init_streams
,
1020 enum lttng_event_output output
,
1022 uint64_t tracefile_size
,
1023 uint64_t tracefile_count
,
1024 unsigned int monitor
,
1025 unsigned int live_timer_interval
,
1026 bool is_in_live_session
,
1027 unsigned int monitor_timer_interval
,
1028 struct lttng_trace_chunk
*trace_chunk
)
1032 /* Zeroed structure */
1033 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1037 enum lttng_trace_chunk_status chunk_status
;
1039 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
, &chunk_id
);
1040 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
1041 LTTNG_OPTIONAL_SET(&msg
->u
.channel
.chunk_id
, chunk_id
);
1045 msg
->cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
1046 msg
->u
.channel
.channel_key
= channel_key
;
1047 msg
->u
.channel
.session_id
= session_id
;
1048 msg
->u
.channel
.relayd_id
= relayd_id
;
1049 msg
->u
.channel
.nb_init_streams
= nb_init_streams
;
1050 msg
->u
.channel
.output
= output
;
1051 msg
->u
.channel
.type
= type
;
1052 msg
->u
.channel
.tracefile_size
= tracefile_size
;
1053 msg
->u
.channel
.tracefile_count
= tracefile_count
;
1054 msg
->u
.channel
.monitor
= monitor
;
1055 msg
->u
.channel
.live_timer_interval
= live_timer_interval
;
1056 msg
->u
.channel
.is_live
= is_in_live_session
;
1057 msg
->u
.channel
.monitor_timer_interval
= monitor_timer_interval
;
1059 strncpy(msg
->u
.channel
.pathname
, pathname
,
1060 sizeof(msg
->u
.channel
.pathname
));
1061 msg
->u
.channel
.pathname
[sizeof(msg
->u
.channel
.pathname
) - 1] = '\0';
1063 strncpy(msg
->u
.channel
.name
, name
, sizeof(msg
->u
.channel
.name
));
1064 msg
->u
.channel
.name
[sizeof(msg
->u
.channel
.name
) - 1] = '\0';
1068 * Init stream communication message structure.
1070 void consumer_init_add_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
1071 uint64_t channel_key
,
1072 uint64_t stream_key
,
1077 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1079 msg
->cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
1080 msg
->u
.stream
.channel_key
= channel_key
;
1081 msg
->u
.stream
.stream_key
= stream_key
;
1082 msg
->u
.stream
.cpu
= cpu
;
1085 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg
*msg
,
1086 enum lttng_consumer_command cmd
,
1087 uint64_t channel_key
, uint64_t net_seq_idx
)
1091 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1093 msg
->cmd_type
= cmd
;
1094 msg
->u
.sent_streams
.channel_key
= channel_key
;
1095 msg
->u
.sent_streams
.net_seq_idx
= net_seq_idx
;
1099 * Send stream communication structure to the consumer.
1101 int consumer_send_stream(struct consumer_socket
*sock
,
1102 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
1103 const int *fds
, size_t nb_fd
)
1112 ret
= consumer_send_msg(sock
, msg
);
1117 ret
= consumer_send_fds(sock
, fds
, nb_fd
);
1127 * Send relayd socket to consumer associated with a session name.
1129 * The consumer socket lock must be held by the caller.
1131 * On success return positive value. On error, negative value.
1133 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
1134 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
1135 enum lttng_stream_type type
, uint64_t session_id
,
1136 const char *session_name
, const char *hostname
,
1137 const char *base_path
, int session_live_timer
,
1138 const uint64_t *current_chunk_id
, time_t session_creation_time
,
1139 bool session_name_contains_creation_time
)
1142 struct lttcomm_consumer_msg msg
;
1144 /* Code flow error. Safety net. */
1147 assert(consumer_sock
);
1149 memset(&msg
, 0, sizeof(msg
));
1150 /* Bail out if consumer is disabled */
1151 if (!consumer
->enabled
) {
1156 if (type
== LTTNG_STREAM_CONTROL
) {
1157 char output_path
[LTTNG_PATH_MAX
] = {};
1158 uint64_t relayd_session_id
;
1160 ret
= relayd_create_session(rsock
,
1162 session_name
, hostname
, base_path
,
1164 consumer
->snapshot
, session_id
,
1165 sessiond_uuid
, current_chunk_id
,
1166 session_creation_time
,
1167 session_name_contains_creation_time
,
1170 /* Close the control socket. */
1171 (void) relayd_close(rsock
);
1174 msg
.u
.relayd_sock
.relayd_session_id
= relayd_session_id
;
1175 DBG("Created session on relay, output path reply: %s",
1179 msg
.cmd_type
= LTTNG_CONSUMER_ADD_RELAYD_SOCKET
;
1181 * Assign network consumer output index using the temporary consumer since
1182 * this call should only be made from within a set_consumer_uri() function
1183 * call in the session daemon.
1185 msg
.u
.relayd_sock
.net_index
= consumer
->net_seq_index
;
1186 msg
.u
.relayd_sock
.type
= type
;
1187 msg
.u
.relayd_sock
.session_id
= session_id
;
1188 memcpy(&msg
.u
.relayd_sock
.sock
, rsock
, sizeof(msg
.u
.relayd_sock
.sock
));
1190 DBG3("Sending relayd sock info to consumer on %d", *consumer_sock
->fd_ptr
);
1191 ret
= consumer_send_msg(consumer_sock
, &msg
);
1196 DBG3("Sending relayd socket file descriptor to consumer");
1197 ret
= consumer_send_fds(consumer_sock
, ALIGNED_CONST_PTR(rsock
->sock
.fd
), 1);
1202 DBG2("Consumer relayd socket sent");
1209 int consumer_send_pipe(struct consumer_socket
*consumer_sock
,
1210 enum lttng_consumer_command cmd
, int pipe
)
1213 struct lttcomm_consumer_msg msg
;
1214 const char *pipe_name
;
1215 const char *command_name
;
1218 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1219 pipe_name
= "channel monitor";
1220 command_name
= "SET_CHANNEL_MONITOR_PIPE";
1223 ERR("Unexpected command received in %s (cmd = %d)", __func__
,
1228 /* Code flow error. Safety net. */
1230 memset(&msg
, 0, sizeof(msg
));
1233 pthread_mutex_lock(consumer_sock
->lock
);
1234 DBG3("Sending %s command to consumer", command_name
);
1235 ret
= consumer_send_msg(consumer_sock
, &msg
);
1240 DBG3("Sending %s pipe %d to consumer on socket %d",
1242 pipe
, *consumer_sock
->fd_ptr
);
1243 ret
= consumer_send_fds(consumer_sock
, &pipe
, 1);
1248 DBG2("%s pipe successfully sent", pipe_name
);
1250 pthread_mutex_unlock(consumer_sock
->lock
);
1254 int consumer_send_channel_monitor_pipe(struct consumer_socket
*consumer_sock
,
1257 return consumer_send_pipe(consumer_sock
,
1258 LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
, pipe
);
1262 * Ask the consumer if the data is pending for the specific session id.
1263 * Returns 1 if data is pending, 0 otherwise, or < 0 on error.
1265 int consumer_is_data_pending(uint64_t session_id
,
1266 struct consumer_output
*consumer
)
1269 int32_t ret_code
= 0; /* Default is that the data is NOT pending */
1270 struct consumer_socket
*socket
;
1271 struct lttng_ht_iter iter
;
1272 struct lttcomm_consumer_msg msg
;
1276 DBG3("Consumer data pending for id %" PRIu64
, session_id
);
1278 memset(&msg
, 0, sizeof(msg
));
1279 msg
.cmd_type
= LTTNG_CONSUMER_DATA_PENDING
;
1280 msg
.u
.data_pending
.session_id
= session_id
;
1282 /* Send command for each consumer */
1284 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1286 pthread_mutex_lock(socket
->lock
);
1287 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1289 pthread_mutex_unlock(socket
->lock
);
1294 * No need for a recv reply status because the answer to the command is
1295 * the reply status message.
1298 ret
= consumer_socket_recv(socket
, &ret_code
, sizeof(ret_code
));
1300 pthread_mutex_unlock(socket
->lock
);
1303 pthread_mutex_unlock(socket
->lock
);
1305 if (ret_code
== 1) {
1311 DBG("Consumer data is %s pending for session id %" PRIu64
,
1312 ret_code
== 1 ? "" : "NOT", session_id
);
1321 * Send a flush command to consumer using the given channel key.
1323 * Return 0 on success else a negative value.
1325 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
)
1328 struct lttcomm_consumer_msg msg
;
1332 DBG2("Consumer flush channel key %" PRIu64
, key
);
1334 memset(&msg
, 0, sizeof(msg
));
1335 msg
.cmd_type
= LTTNG_CONSUMER_FLUSH_CHANNEL
;
1336 msg
.u
.flush_channel
.key
= key
;
1338 pthread_mutex_lock(socket
->lock
);
1339 health_code_update();
1341 ret
= consumer_send_msg(socket
, &msg
);
1347 health_code_update();
1348 pthread_mutex_unlock(socket
->lock
);
1353 * Send a clear quiescent command to consumer using the given channel key.
1355 * Return 0 on success else a negative value.
1357 int consumer_clear_quiescent_channel(struct consumer_socket
*socket
, uint64_t key
)
1360 struct lttcomm_consumer_msg msg
;
1364 DBG2("Consumer clear quiescent channel key %" PRIu64
, key
);
1366 memset(&msg
, 0, sizeof(msg
));
1367 msg
.cmd_type
= LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
;
1368 msg
.u
.clear_quiescent_channel
.key
= key
;
1370 pthread_mutex_lock(socket
->lock
);
1371 health_code_update();
1373 ret
= consumer_send_msg(socket
, &msg
);
1379 health_code_update();
1380 pthread_mutex_unlock(socket
->lock
);
1385 * Send a close metadata command to consumer using the given channel key.
1386 * Called with registry lock held.
1388 * Return 0 on success else a negative value.
1390 int consumer_close_metadata(struct consumer_socket
*socket
,
1391 uint64_t metadata_key
)
1394 struct lttcomm_consumer_msg msg
;
1398 DBG2("Consumer close metadata channel key %" PRIu64
, metadata_key
);
1400 memset(&msg
, 0, sizeof(msg
));
1401 msg
.cmd_type
= LTTNG_CONSUMER_CLOSE_METADATA
;
1402 msg
.u
.close_metadata
.key
= metadata_key
;
1404 pthread_mutex_lock(socket
->lock
);
1405 health_code_update();
1407 ret
= consumer_send_msg(socket
, &msg
);
1413 health_code_update();
1414 pthread_mutex_unlock(socket
->lock
);
1419 * Send a setup metdata command to consumer using the given channel key.
1421 * Return 0 on success else a negative value.
1423 int consumer_setup_metadata(struct consumer_socket
*socket
,
1424 uint64_t metadata_key
)
1427 struct lttcomm_consumer_msg msg
;
1431 DBG2("Consumer setup metadata channel key %" PRIu64
, metadata_key
);
1433 memset(&msg
, 0, sizeof(msg
));
1434 msg
.cmd_type
= LTTNG_CONSUMER_SETUP_METADATA
;
1435 msg
.u
.setup_metadata
.key
= metadata_key
;
1437 pthread_mutex_lock(socket
->lock
);
1438 health_code_update();
1440 ret
= consumer_send_msg(socket
, &msg
);
1446 health_code_update();
1447 pthread_mutex_unlock(socket
->lock
);
1452 * Send metadata string to consumer.
1453 * RCU read-side lock must be held to guarantee existence of socket.
1455 * Return 0 on success else a negative value.
1457 int consumer_push_metadata(struct consumer_socket
*socket
,
1458 uint64_t metadata_key
, char *metadata_str
, size_t len
,
1459 size_t target_offset
, uint64_t version
)
1462 struct lttcomm_consumer_msg msg
;
1466 DBG2("Consumer push metadata to consumer socket %d", *socket
->fd_ptr
);
1468 pthread_mutex_lock(socket
->lock
);
1470 memset(&msg
, 0, sizeof(msg
));
1471 msg
.cmd_type
= LTTNG_CONSUMER_PUSH_METADATA
;
1472 msg
.u
.push_metadata
.key
= metadata_key
;
1473 msg
.u
.push_metadata
.target_offset
= target_offset
;
1474 msg
.u
.push_metadata
.len
= len
;
1475 msg
.u
.push_metadata
.version
= version
;
1477 health_code_update();
1478 ret
= consumer_send_msg(socket
, &msg
);
1479 if (ret
< 0 || len
== 0) {
1483 DBG3("Consumer pushing metadata on sock %d of len %zu", *socket
->fd_ptr
,
1486 ret
= consumer_socket_send(socket
, metadata_str
, len
);
1491 health_code_update();
1492 ret
= consumer_recv_status_reply(socket
);
1498 pthread_mutex_unlock(socket
->lock
);
1499 health_code_update();
1504 * Ask the consumer to snapshot a specific channel using the key.
1506 * Returns LTTNG_OK on success or else an LTTng error code.
1508 enum lttng_error_code
consumer_snapshot_channel(struct consumer_socket
*socket
,
1509 uint64_t key
, const struct consumer_output
*output
, int metadata
,
1510 uid_t uid
, gid_t gid
, const char *channel_path
, int wait
,
1511 uint64_t nb_packets_per_stream
)
1514 enum lttng_error_code status
= LTTNG_OK
;
1515 struct lttcomm_consumer_msg msg
;
1520 DBG("Consumer snapshot channel key %" PRIu64
, key
);
1522 memset(&msg
, 0, sizeof(msg
));
1523 msg
.cmd_type
= LTTNG_CONSUMER_SNAPSHOT_CHANNEL
;
1524 msg
.u
.snapshot_channel
.key
= key
;
1525 msg
.u
.snapshot_channel
.nb_packets_per_stream
= nb_packets_per_stream
;
1526 msg
.u
.snapshot_channel
.metadata
= metadata
;
1528 if (output
->type
== CONSUMER_DST_NET
) {
1529 msg
.u
.snapshot_channel
.relayd_id
=
1530 output
->net_seq_index
;
1531 msg
.u
.snapshot_channel
.use_relayd
= 1;
1533 msg
.u
.snapshot_channel
.relayd_id
= (uint64_t) -1ULL;
1535 ret
= lttng_strncpy(msg
.u
.snapshot_channel
.pathname
,
1537 sizeof(msg
.u
.snapshot_channel
.pathname
));
1539 ERR("Snapshot path exceeds the maximal allowed length of %zu bytes (%zu bytes required) with path \"%s\"",
1540 sizeof(msg
.u
.snapshot_channel
.pathname
),
1541 strlen(channel_path
),
1543 status
= LTTNG_ERR_SNAPSHOT_FAIL
;
1547 health_code_update();
1548 pthread_mutex_lock(socket
->lock
);
1549 ret
= consumer_send_msg(socket
, &msg
);
1550 pthread_mutex_unlock(socket
->lock
);
1553 case LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
:
1554 status
= LTTNG_ERR_CHAN_NOT_FOUND
;
1557 status
= LTTNG_ERR_SNAPSHOT_FAIL
;
1564 health_code_update();
1569 * Ask the consumer the number of discarded events for a channel.
1571 int consumer_get_discarded_events(uint64_t session_id
, uint64_t channel_key
,
1572 struct consumer_output
*consumer
, uint64_t *discarded
)
1575 struct consumer_socket
*socket
;
1576 struct lttng_ht_iter iter
;
1577 struct lttcomm_consumer_msg msg
;
1581 DBG3("Consumer discarded events id %" PRIu64
, session_id
);
1583 memset(&msg
, 0, sizeof(msg
));
1584 msg
.cmd_type
= LTTNG_CONSUMER_DISCARDED_EVENTS
;
1585 msg
.u
.discarded_events
.session_id
= session_id
;
1586 msg
.u
.discarded_events
.channel_key
= channel_key
;
1590 /* Send command for each consumer */
1592 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1594 uint64_t consumer_discarded
= 0;
1595 pthread_mutex_lock(socket
->lock
);
1596 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1598 pthread_mutex_unlock(socket
->lock
);
1603 * No need for a recv reply status because the answer to the
1604 * command is the reply status message.
1606 ret
= consumer_socket_recv(socket
, &consumer_discarded
,
1607 sizeof(consumer_discarded
));
1609 ERR("get discarded events");
1610 pthread_mutex_unlock(socket
->lock
);
1613 pthread_mutex_unlock(socket
->lock
);
1614 *discarded
+= consumer_discarded
;
1617 DBG("Consumer discarded %" PRIu64
" events in session id %" PRIu64
,
1618 *discarded
, session_id
);
1626 * Ask the consumer the number of lost packets for a channel.
1628 int consumer_get_lost_packets(uint64_t session_id
, uint64_t channel_key
,
1629 struct consumer_output
*consumer
, uint64_t *lost
)
1632 struct consumer_socket
*socket
;
1633 struct lttng_ht_iter iter
;
1634 struct lttcomm_consumer_msg msg
;
1638 DBG3("Consumer lost packets id %" PRIu64
, session_id
);
1640 memset(&msg
, 0, sizeof(msg
));
1641 msg
.cmd_type
= LTTNG_CONSUMER_LOST_PACKETS
;
1642 msg
.u
.lost_packets
.session_id
= session_id
;
1643 msg
.u
.lost_packets
.channel_key
= channel_key
;
1647 /* Send command for each consumer */
1649 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1651 uint64_t consumer_lost
= 0;
1652 pthread_mutex_lock(socket
->lock
);
1653 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1655 pthread_mutex_unlock(socket
->lock
);
1660 * No need for a recv reply status because the answer to the
1661 * command is the reply status message.
1663 ret
= consumer_socket_recv(socket
, &consumer_lost
,
1664 sizeof(consumer_lost
));
1666 ERR("get lost packets");
1667 pthread_mutex_unlock(socket
->lock
);
1670 pthread_mutex_unlock(socket
->lock
);
1671 *lost
+= consumer_lost
;
1674 DBG("Consumer lost %" PRIu64
" packets in session id %" PRIu64
,
1683 * Ask the consumer to rotate a channel.
1685 * The new_chunk_id is the session->rotate_count that has been incremented
1686 * when the rotation started. On the relay, this allows to keep track in which
1687 * chunk each stream is currently writing to (for the rotate_pending operation).
1689 int consumer_rotate_channel(struct consumer_socket
*socket
, uint64_t key
,
1690 uid_t uid
, gid_t gid
, struct consumer_output
*output
,
1691 bool is_metadata_channel
)
1694 struct lttcomm_consumer_msg msg
;
1698 DBG("Consumer rotate channel key %" PRIu64
, key
);
1700 pthread_mutex_lock(socket
->lock
);
1701 memset(&msg
, 0, sizeof(msg
));
1702 msg
.cmd_type
= LTTNG_CONSUMER_ROTATE_CHANNEL
;
1703 msg
.u
.rotate_channel
.key
= key
;
1704 msg
.u
.rotate_channel
.metadata
= !!is_metadata_channel
;
1706 if (output
->type
== CONSUMER_DST_NET
) {
1707 msg
.u
.rotate_channel
.relayd_id
= output
->net_seq_index
;
1709 msg
.u
.rotate_channel
.relayd_id
= (uint64_t) -1ULL;
1712 health_code_update();
1713 ret
= consumer_send_msg(socket
, &msg
);
1716 case LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
:
1717 ret
= -LTTNG_ERR_CHAN_NOT_FOUND
;
1720 ret
= -LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
1726 pthread_mutex_unlock(socket
->lock
);
1727 health_code_update();
1731 int consumer_init(struct consumer_socket
*socket
,
1732 const lttng_uuid sessiond_uuid
)
1735 struct lttcomm_consumer_msg msg
= {
1736 .cmd_type
= LTTNG_CONSUMER_INIT
,
1741 DBG("Sending consumer initialization command");
1742 lttng_uuid_copy(msg
.u
.init
.sessiond_uuid
, sessiond_uuid
);
1744 health_code_update();
1745 ret
= consumer_send_msg(socket
, &msg
);
1751 health_code_update();
1756 * Ask the consumer to create a new chunk for a given session.
1758 * Called with the consumer socket lock held.
1760 int consumer_create_trace_chunk(struct consumer_socket
*socket
,
1761 uint64_t relayd_id
, uint64_t session_id
,
1762 struct lttng_trace_chunk
*chunk
)
1765 enum lttng_trace_chunk_status chunk_status
;
1766 struct lttng_credentials chunk_credentials
;
1767 const struct lttng_directory_handle
*chunk_directory_handle
;
1769 const char *chunk_name
;
1770 bool chunk_name_overridden
;
1772 time_t creation_timestamp
;
1773 char creation_timestamp_buffer
[ISO8601_STR_LEN
];
1774 const char *creation_timestamp_str
= "(none)";
1775 const bool chunk_has_local_output
= relayd_id
== -1ULL;
1776 struct lttcomm_consumer_msg msg
= {
1777 .cmd_type
= LTTNG_CONSUMER_CREATE_TRACE_CHUNK
,
1778 .u
.create_trace_chunk
.session_id
= session_id
,
1784 if (relayd_id
!= -1ULL) {
1785 LTTNG_OPTIONAL_SET(&msg
.u
.create_trace_chunk
.relayd_id
,
1789 chunk_status
= lttng_trace_chunk_get_name(chunk
, &chunk_name
,
1790 &chunk_name_overridden
);
1791 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
&&
1792 chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_NONE
) {
1793 ERR("Failed to get name of trace chunk");
1794 ret
= -LTTNG_ERR_FATAL
;
1797 if (chunk_name_overridden
) {
1798 ret
= lttng_strncpy(msg
.u
.create_trace_chunk
.override_name
,
1800 sizeof(msg
.u
.create_trace_chunk
.override_name
));
1802 ERR("Trace chunk name \"%s\" exceeds the maximal length allowed by the consumer protocol",
1804 ret
= -LTTNG_ERR_FATAL
;
1809 chunk_status
= lttng_trace_chunk_get_creation_timestamp(chunk
,
1810 &creation_timestamp
);
1811 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1812 ret
= -LTTNG_ERR_FATAL
;
1815 msg
.u
.create_trace_chunk
.creation_timestamp
=
1816 (uint64_t) creation_timestamp
;
1817 /* Only used for logging purposes. */
1818 ret
= time_to_iso8601_str(creation_timestamp
,
1819 creation_timestamp_buffer
,
1820 sizeof(creation_timestamp_buffer
));
1821 creation_timestamp_str
= !ret
? creation_timestamp_buffer
:
1822 "(formatting error)";
1824 chunk_status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1825 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1827 * Anonymous trace chunks should never be transmitted
1828 * to remote peers (consumerd and relayd). They are used
1829 * internally for backward-compatibility purposes.
1831 ret
= -LTTNG_ERR_FATAL
;
1834 msg
.u
.create_trace_chunk
.chunk_id
= chunk_id
;
1836 if (chunk_has_local_output
) {
1837 chunk_status
= lttng_trace_chunk_get_chunk_directory_handle(
1838 chunk
, &chunk_directory_handle
);
1839 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1840 ret
= -LTTNG_ERR_FATAL
;
1845 * This will only compile on platforms that support
1846 * dirfd (POSIX.2008). This is fine as the session daemon
1847 * is only built for such platforms.
1849 * The ownership of the chunk directory handle's is maintained
1850 * by the trace chunk.
1852 chunk_dirfd
= lttng_directory_handle_get_dirfd(
1853 chunk_directory_handle
);
1854 assert(chunk_dirfd
>= 0);
1856 chunk_status
= lttng_trace_chunk_get_credentials(
1857 chunk
, &chunk_credentials
);
1858 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1860 * Not associating credentials to a sessiond chunk is a
1861 * fatal internal error.
1863 ret
= -LTTNG_ERR_FATAL
;
1866 msg
.u
.create_trace_chunk
.credentials
.value
.uid
=
1867 chunk_credentials
.uid
;
1868 msg
.u
.create_trace_chunk
.credentials
.value
.gid
=
1869 chunk_credentials
.gid
;
1870 msg
.u
.create_trace_chunk
.credentials
.is_set
= 1;
1873 DBG("Sending consumer create trace chunk command: relayd_id = %" PRId64
1874 ", session_id = %" PRIu64
", chunk_id = %" PRIu64
1875 ", creation_timestamp = %s",
1876 relayd_id
, session_id
, chunk_id
,
1877 creation_timestamp_str
);
1878 health_code_update();
1879 ret
= consumer_send_msg(socket
, &msg
);
1880 health_code_update();
1882 ERR("Trace chunk creation error on consumer");
1883 ret
= -LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
1887 if (chunk_has_local_output
) {
1888 DBG("Sending trace chunk directory fd to consumer");
1889 health_code_update();
1890 ret
= consumer_send_fds(socket
, &chunk_dirfd
, 1);
1891 health_code_update();
1893 ERR("Trace chunk creation error on consumer");
1894 ret
= -LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
1903 * Ask the consumer to close a trace chunk for a given session.
1905 * Called with the consumer socket lock held.
1907 int consumer_close_trace_chunk(struct consumer_socket
*socket
,
1908 uint64_t relayd_id
, uint64_t session_id
,
1909 struct lttng_trace_chunk
*chunk
,
1910 char *closed_trace_chunk_path
)
1913 enum lttng_trace_chunk_status chunk_status
;
1914 struct lttcomm_consumer_msg msg
= {
1915 .cmd_type
= LTTNG_CONSUMER_CLOSE_TRACE_CHUNK
,
1916 .u
.close_trace_chunk
.session_id
= session_id
,
1918 struct lttcomm_consumer_close_trace_chunk_reply reply
;
1920 time_t close_timestamp
;
1921 enum lttng_trace_chunk_command_type close_command
;
1922 const char *close_command_name
= "none";
1923 struct lttng_dynamic_buffer path_reception_buffer
;
1926 lttng_dynamic_buffer_init(&path_reception_buffer
);
1928 if (relayd_id
!= -1ULL) {
1930 &msg
.u
.close_trace_chunk
.relayd_id
, relayd_id
);
1933 chunk_status
= lttng_trace_chunk_get_close_command(
1934 chunk
, &close_command
);
1935 switch (chunk_status
) {
1936 case LTTNG_TRACE_CHUNK_STATUS_OK
:
1937 LTTNG_OPTIONAL_SET(&msg
.u
.close_trace_chunk
.close_command
,
1938 (uint32_t) close_command
);
1940 case LTTNG_TRACE_CHUNK_STATUS_NONE
:
1943 ERR("Failed to get trace chunk close command");
1948 chunk_status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1950 * Anonymous trace chunks should never be transmitted to remote peers
1951 * (consumerd and relayd). They are used internally for
1952 * backward-compatibility purposes.
1954 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
1955 msg
.u
.close_trace_chunk
.chunk_id
= chunk_id
;
1957 chunk_status
= lttng_trace_chunk_get_close_timestamp(chunk
,
1960 * A trace chunk should be closed locally before being closed remotely.
1961 * Otherwise, the close timestamp would never be transmitted to the
1964 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
1965 msg
.u
.close_trace_chunk
.close_timestamp
= (uint64_t) close_timestamp
;
1967 if (msg
.u
.close_trace_chunk
.close_command
.is_set
) {
1968 close_command_name
= lttng_trace_chunk_command_type_get_name(
1971 DBG("Sending consumer close trace chunk command: relayd_id = %" PRId64
1972 ", session_id = %" PRIu64
", chunk_id = %" PRIu64
1973 ", close command = \"%s\"",
1974 relayd_id
, session_id
, chunk_id
, close_command_name
);
1976 health_code_update();
1977 ret
= consumer_socket_send(socket
, &msg
, sizeof(struct lttcomm_consumer_msg
));
1979 ret
= -LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
1982 ret
= consumer_socket_recv(socket
, &reply
, sizeof(reply
));
1984 ret
= -LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
1987 if (reply
.path_length
>= LTTNG_PATH_MAX
) {
1988 ERR("Invalid path returned by relay daemon: %" PRIu32
"bytes exceeds maximal allowed length of %d bytes",
1989 reply
.path_length
, LTTNG_PATH_MAX
);
1990 ret
= -LTTNG_ERR_INVALID_PROTOCOL
;
1993 ret
= lttng_dynamic_buffer_set_size(&path_reception_buffer
,
1996 ERR("Failed to allocate reception buffer of path returned by the \"close trace chunk\" command");
1997 ret
= -LTTNG_ERR_NOMEM
;
2000 ret
= consumer_socket_recv(socket
, path_reception_buffer
.data
,
2001 path_reception_buffer
.size
);
2003 ERR("Communication error while receiving path of closed trace chunk");
2004 ret
= -LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
2007 if (path_reception_buffer
.data
[path_reception_buffer
.size
- 1] != '\0') {
2008 ERR("Invalid path returned by relay daemon: not null-terminated");
2009 ret
= -LTTNG_ERR_INVALID_PROTOCOL
;
2012 if (closed_trace_chunk_path
) {
2014 * closed_trace_chunk_path is assumed to have a length >=
2017 memcpy(closed_trace_chunk_path
, path_reception_buffer
.data
,
2018 path_reception_buffer
.size
);
2021 lttng_dynamic_buffer_reset(&path_reception_buffer
);
2022 health_code_update();
2027 * Ask the consumer if a trace chunk exists.
2029 * Called with the consumer socket lock held.
2030 * Returns 0 on success, or a negative value on error.
2032 int consumer_trace_chunk_exists(struct consumer_socket
*socket
,
2033 uint64_t relayd_id
, uint64_t session_id
,
2034 struct lttng_trace_chunk
*chunk
,
2035 enum consumer_trace_chunk_exists_status
*result
)
2038 enum lttng_trace_chunk_status chunk_status
;
2039 struct lttcomm_consumer_msg msg
= {
2040 .cmd_type
= LTTNG_CONSUMER_TRACE_CHUNK_EXISTS
,
2041 .u
.trace_chunk_exists
.session_id
= session_id
,
2044 const char *consumer_reply_str
;
2048 if (relayd_id
!= -1ULL) {
2049 LTTNG_OPTIONAL_SET(&msg
.u
.trace_chunk_exists
.relayd_id
,
2053 chunk_status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
2054 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2056 * Anonymous trace chunks should never be transmitted
2057 * to remote peers (consumerd and relayd). They are used
2058 * internally for backward-compatibility purposes.
2060 ret
= -LTTNG_ERR_FATAL
;
2063 msg
.u
.trace_chunk_exists
.chunk_id
= chunk_id
;
2065 DBG("Sending consumer trace chunk exists command: relayd_id = %" PRId64
2066 ", session_id = %" PRIu64
2067 ", chunk_id = %" PRIu64
, relayd_id
, session_id
, chunk_id
);
2069 health_code_update();
2070 ret
= consumer_send_msg(socket
, &msg
);
2072 case LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
:
2073 consumer_reply_str
= "unknown trace chunk";
2074 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_UNKNOWN_CHUNK
;
2076 case LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL
:
2077 consumer_reply_str
= "trace chunk exists locally";
2078 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_EXISTS_LOCAL
;
2080 case LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE
:
2081 consumer_reply_str
= "trace chunk exists on remote peer";
2082 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_EXISTS_REMOTE
;
2085 ERR("Consumer returned an error from TRACE_CHUNK_EXISTS command");
2089 DBG("Consumer reply to TRACE_CHUNK_EXISTS command: %s",
2090 consumer_reply_str
);
2093 health_code_update();