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(struct consumer_socket
*socket
, void *msg
, size_t len
)
102 assert(socket
->fd_ptr
);
105 /* Consumer socket is invalid. Stopping. */
106 fd
= *socket
->fd_ptr
;
111 size
= lttcomm_send_unix_sock(fd
, msg
, len
);
113 /* The above call will print a PERROR on error. */
114 DBG("Error when sending data to consumer on sock %d", fd
);
116 * At this point, the socket is not usable anymore thus closing it and
117 * setting the file descriptor to -1 so it is not reused.
120 /* This call will PERROR on error. */
121 (void) lttcomm_close_unix_sock(fd
);
122 *socket
->fd_ptr
= -1;
133 * Receive a data payload using a given consumer socket of size len.
135 * The consumer socket lock MUST be acquired before calling this since this
136 * function can change the fd value.
138 * Return 0 on success else a negative value on error.
140 int consumer_socket_recv(struct consumer_socket
*socket
, void *msg
, size_t len
)
146 assert(socket
->fd_ptr
);
149 /* Consumer socket is invalid. Stopping. */
150 fd
= *socket
->fd_ptr
;
155 size
= lttcomm_recv_unix_sock(fd
, msg
, len
);
157 /* The above call will print a PERROR on error. */
158 DBG("Error when receiving data from the consumer socket %d", fd
);
160 * At this point, the socket is not usable anymore thus closing it and
161 * setting the file descriptor to -1 so it is not reused.
164 /* This call will PERROR on error. */
165 (void) lttcomm_close_unix_sock(fd
);
166 *socket
->fd_ptr
= -1;
177 * Receive a reply command status message from the consumer. Consumer socket
178 * lock MUST be acquired before calling this function.
180 * Return 0 on success, -1 on recv error or a negative lttng error code which
181 * was possibly returned by the consumer.
183 int consumer_recv_status_reply(struct consumer_socket
*sock
)
186 struct lttcomm_consumer_status_msg reply
;
190 ret
= consumer_socket_recv(sock
, &reply
, sizeof(reply
));
195 if (reply
.ret_code
== LTTCOMM_CONSUMERD_SUCCESS
) {
199 ret
= -reply
.ret_code
;
200 DBG("Consumer ret code %d", ret
);
208 * Once the ASK_CHANNEL command is sent to the consumer, the channel
209 * information are sent back. This call receives that data and populates key
212 * On success return 0 and both key and stream_count are set. On error, a
213 * negative value is sent back and both parameters are untouched.
215 int consumer_recv_status_channel(struct consumer_socket
*sock
,
216 uint64_t *key
, unsigned int *stream_count
)
219 struct lttcomm_consumer_status_channel reply
;
222 assert(stream_count
);
225 ret
= consumer_socket_recv(sock
, &reply
, sizeof(reply
));
230 /* An error is possible so don't touch the key and stream_count. */
231 if (reply
.ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
237 *stream_count
= reply
.stream_count
;
245 * Send destroy relayd command to consumer.
247 * On success return positive value. On error, negative value.
249 int consumer_send_destroy_relayd(struct consumer_socket
*sock
,
250 struct consumer_output
*consumer
)
253 struct lttcomm_consumer_msg msg
;
258 DBG2("Sending destroy relayd command to consumer sock %d", *sock
->fd_ptr
);
260 memset(&msg
, 0, sizeof(msg
));
261 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_RELAYD
;
262 msg
.u
.destroy_relayd
.net_seq_idx
= consumer
->net_seq_index
;
264 pthread_mutex_lock(sock
->lock
);
265 ret
= consumer_socket_send(sock
, &msg
, sizeof(msg
));
270 /* Don't check the return value. The caller will do it. */
271 ret
= consumer_recv_status_reply(sock
);
273 DBG2("Consumer send destroy relayd command done");
276 pthread_mutex_unlock(sock
->lock
);
281 * For each consumer socket in the consumer output object, send a destroy
284 void consumer_output_send_destroy_relayd(struct consumer_output
*consumer
)
286 struct lttng_ht_iter iter
;
287 struct consumer_socket
*socket
;
291 /* Destroy any relayd connection */
292 if (consumer
->type
== CONSUMER_DST_NET
) {
294 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
298 /* Send destroy relayd command */
299 ret
= consumer_send_destroy_relayd(socket
, consumer
);
301 DBG("Unable to send destroy relayd command to consumer");
302 /* Continue since we MUST delete everything at this point. */
310 * From a consumer_data structure, allocate and add a consumer socket to the
313 * Return 0 on success, else negative value on error
315 int consumer_create_socket(struct consumer_data
*data
,
316 struct consumer_output
*output
)
319 struct consumer_socket
*socket
;
323 if (output
== NULL
|| data
->cmd_sock
< 0) {
325 * Not an error. Possible there is simply not spawned consumer or it's
326 * disabled for the tracing session asking the socket.
332 socket
= consumer_find_socket(data
->cmd_sock
, output
);
334 if (socket
== NULL
) {
335 socket
= consumer_allocate_socket(&data
->cmd_sock
);
336 if (socket
== NULL
) {
341 socket
->registered
= 0;
342 socket
->lock
= &data
->lock
;
344 consumer_add_socket(socket
, output
);
348 socket
->type
= data
->type
;
350 DBG3("Consumer socket created (fd: %d) and added to output",
358 * Return the consumer socket from the given consumer output with the right
359 * bitness. On error, returns NULL.
361 * The caller MUST acquire a rcu read side lock and keep it until the socket
362 * object reference is not needed anymore.
364 struct consumer_socket
*consumer_find_socket_by_bitness(int bits
,
365 const struct consumer_output
*consumer
)
368 struct consumer_socket
*socket
= NULL
;
372 consumer_fd
= uatomic_read(&ust_consumerd64_fd
);
375 consumer_fd
= uatomic_read(&ust_consumerd32_fd
);
382 socket
= consumer_find_socket(consumer_fd
, consumer
);
384 ERR("Consumer socket fd %d not found in consumer obj %p",
385 consumer_fd
, consumer
);
393 * Find a consumer_socket in a consumer_output hashtable. Read side lock must
394 * be acquired before calling this function and across use of the
395 * returned consumer_socket.
397 struct consumer_socket
*consumer_find_socket(int key
,
398 const struct consumer_output
*consumer
)
400 struct lttng_ht_iter iter
;
401 struct lttng_ht_node_ulong
*node
;
402 struct consumer_socket
*socket
= NULL
;
404 /* Negative keys are lookup failures */
405 if (key
< 0 || consumer
== NULL
) {
409 lttng_ht_lookup(consumer
->socks
, (void *)((unsigned long) key
),
411 node
= lttng_ht_iter_get_node_ulong(&iter
);
413 socket
= caa_container_of(node
, struct consumer_socket
, node
);
420 * Allocate a new consumer_socket and return the pointer.
422 struct consumer_socket
*consumer_allocate_socket(int *fd
)
424 struct consumer_socket
*socket
= NULL
;
428 socket
= zmalloc(sizeof(struct consumer_socket
));
429 if (socket
== NULL
) {
430 PERROR("zmalloc consumer socket");
435 lttng_ht_node_init_ulong(&socket
->node
, *fd
);
442 * Add consumer socket to consumer output object. Read side lock must be
443 * acquired before calling this function.
445 void consumer_add_socket(struct consumer_socket
*sock
,
446 struct consumer_output
*consumer
)
451 lttng_ht_add_unique_ulong(consumer
->socks
, &sock
->node
);
455 * Delete consumer socket to consumer output object. Read side lock must be
456 * acquired before calling this function.
458 void consumer_del_socket(struct consumer_socket
*sock
,
459 struct consumer_output
*consumer
)
462 struct lttng_ht_iter iter
;
467 iter
.iter
.node
= &sock
->node
.node
;
468 ret
= lttng_ht_del(consumer
->socks
, &iter
);
473 * RCU destroy call function.
475 static void destroy_socket_rcu(struct rcu_head
*head
)
477 struct lttng_ht_node_ulong
*node
=
478 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
479 struct consumer_socket
*socket
=
480 caa_container_of(node
, struct consumer_socket
, node
);
486 * Destroy and free socket pointer in a call RCU. Read side lock must be
487 * acquired before calling this function.
489 void consumer_destroy_socket(struct consumer_socket
*sock
)
494 * We DO NOT close the file descriptor here since it is global to the
495 * session daemon and is closed only if the consumer dies or a custom
496 * consumer was registered,
498 if (sock
->registered
) {
499 DBG3("Consumer socket was registered. Closing fd %d", *sock
->fd_ptr
);
500 lttcomm_close_unix_sock(*sock
->fd_ptr
);
503 call_rcu(&sock
->node
.head
, destroy_socket_rcu
);
507 * Allocate and assign data to a consumer_output object.
509 * Return pointer to structure.
511 struct consumer_output
*consumer_create_output(enum consumer_dst_type type
)
513 struct consumer_output
*output
= NULL
;
515 output
= zmalloc(sizeof(struct consumer_output
));
516 if (output
== NULL
) {
517 PERROR("zmalloc consumer_output");
521 /* By default, consumer output is enabled */
524 output
->net_seq_index
= (uint64_t) -1ULL;
525 urcu_ref_init(&output
->ref
);
527 output
->socks
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
534 * Iterate over the consumer output socket hash table and destroy them. The
535 * socket file descriptor are only closed if the consumer output was
536 * registered meaning it's an external consumer.
538 void consumer_destroy_output_sockets(struct consumer_output
*obj
)
540 struct lttng_ht_iter iter
;
541 struct consumer_socket
*socket
;
548 cds_lfht_for_each_entry(obj
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
549 consumer_del_socket(socket
, obj
);
550 consumer_destroy_socket(socket
);
556 * Delete the consumer_output object from the list and free the ptr.
558 * Should *NOT* be called with RCU read-side lock held.
560 static void consumer_release_output(struct urcu_ref
*ref
)
562 struct consumer_output
*obj
=
563 caa_container_of(ref
, struct consumer_output
, ref
);
565 consumer_destroy_output_sockets(obj
);
568 /* Finally destroy HT */
569 ht_cleanup_push(obj
->socks
);
576 * Get the consumer_output object.
578 void consumer_output_get(struct consumer_output
*obj
)
580 urcu_ref_get(&obj
->ref
);
584 * Put the consumer_output object.
586 * Should *NOT* be called with RCU read-side lock held.
588 void consumer_output_put(struct consumer_output
*obj
)
593 urcu_ref_put(&obj
->ref
, consumer_release_output
);
597 * Copy consumer output and returned the newly allocated copy.
599 * Should *NOT* be called with RCU read-side lock held.
601 struct consumer_output
*consumer_copy_output(struct consumer_output
*src
)
604 struct consumer_output
*output
;
608 output
= consumer_create_output(src
->type
);
609 if (output
== NULL
) {
612 output
->enabled
= src
->enabled
;
613 output
->net_seq_index
= src
->net_seq_index
;
614 memcpy(output
->domain_subdir
, src
->domain_subdir
,
615 sizeof(output
->domain_subdir
));
616 output
->snapshot
= src
->snapshot
;
617 output
->relay_major_version
= src
->relay_major_version
;
618 output
->relay_minor_version
= src
->relay_minor_version
;
619 output
->relay_allows_clear
= src
->relay_allows_clear
;
620 memcpy(&output
->dst
, &src
->dst
, sizeof(output
->dst
));
621 ret
= consumer_copy_sockets(output
, src
);
629 consumer_output_put(output
);
634 * Copy consumer sockets from src to dst.
636 * Return 0 on success or else a negative value.
638 int consumer_copy_sockets(struct consumer_output
*dst
,
639 struct consumer_output
*src
)
642 struct lttng_ht_iter iter
;
643 struct consumer_socket
*socket
, *copy_sock
;
649 cds_lfht_for_each_entry(src
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
650 /* Ignore socket that are already there. */
651 copy_sock
= consumer_find_socket(*socket
->fd_ptr
, dst
);
656 /* Create new socket object. */
657 copy_sock
= consumer_allocate_socket(socket
->fd_ptr
);
658 if (copy_sock
== NULL
) {
664 copy_sock
->registered
= socket
->registered
;
666 * This is valid because this lock is shared accross all consumer
667 * object being the global lock of the consumer data structure of the
670 copy_sock
->lock
= socket
->lock
;
671 consumer_add_socket(copy_sock
, dst
);
680 * Set network URI to the consumer output.
682 * Return 0 on success. Return 1 if the URI were equal. Else, negative value on
685 int consumer_set_network_uri(const struct ltt_session
*session
,
686 struct consumer_output
*output
,
687 struct lttng_uri
*uri
)
690 struct lttng_uri
*dst_uri
= NULL
;
692 /* Code flow error safety net. */
696 switch (uri
->stype
) {
697 case LTTNG_STREAM_CONTROL
:
698 dst_uri
= &output
->dst
.net
.control
;
699 output
->dst
.net
.control_isset
= 1;
700 if (uri
->port
== 0) {
701 /* Assign default port. */
702 uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
704 if (output
->dst
.net
.data_isset
&& uri
->port
==
705 output
->dst
.net
.data
.port
) {
706 ret
= -LTTNG_ERR_INVALID
;
710 DBG3("Consumer control URI set with port %d", uri
->port
);
712 case LTTNG_STREAM_DATA
:
713 dst_uri
= &output
->dst
.net
.data
;
714 output
->dst
.net
.data_isset
= 1;
715 if (uri
->port
== 0) {
716 /* Assign default port. */
717 uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
719 if (output
->dst
.net
.control_isset
&& uri
->port
==
720 output
->dst
.net
.control
.port
) {
721 ret
= -LTTNG_ERR_INVALID
;
725 DBG3("Consumer data URI set with port %d", uri
->port
);
728 ERR("Set network uri type unknown %d", uri
->stype
);
729 ret
= -LTTNG_ERR_INVALID
;
733 ret
= uri_compare(dst_uri
, uri
);
735 /* Same URI, don't touch it and return success. */
736 DBG3("URI network compare are the same");
740 /* URIs were not equal, replacing it. */
741 memcpy(dst_uri
, uri
, sizeof(struct lttng_uri
));
742 output
->type
= CONSUMER_DST_NET
;
743 if (dst_uri
->stype
!= LTTNG_STREAM_CONTROL
) {
744 /* Only the control uri needs to contain the path. */
749 * If the user has specified a subdir as part of the control
750 * URL, the session's base output directory is:
751 * /RELAYD_OUTPUT_PATH/HOSTNAME/USER_SPECIFIED_DIR
753 * Hence, the "base_dir" from which all stream files and
754 * session rotation chunks are created takes the form
755 * /HOSTNAME/USER_SPECIFIED_DIR
757 * If the user has not specified an output directory as part of
758 * the control URL, the base output directory has the form:
759 * /RELAYD_OUTPUT_PATH/HOSTNAME/SESSION_NAME-CREATION_TIME
761 * Hence, the "base_dir" from which all stream files and
762 * session rotation chunks are created takes the form
763 * /HOSTNAME/SESSION_NAME-CREATION_TIME
765 * Note that automatically generated session names already
766 * contain the session's creation time. In that case, the
767 * creation time is omitted to prevent it from being duplicated
768 * in the final directory hierarchy.
771 if (strstr(uri
->subdir
, "../")) {
772 ERR("Network URI subdirs are not allowed to walk up the path hierarchy");
773 ret
= -LTTNG_ERR_INVALID
;
776 ret
= snprintf(output
->dst
.net
.base_dir
,
777 sizeof(output
->dst
.net
.base_dir
),
778 "/%s/%s/", session
->hostname
, uri
->subdir
);
780 if (session
->has_auto_generated_name
) {
781 ret
= snprintf(output
->dst
.net
.base_dir
,
782 sizeof(output
->dst
.net
.base_dir
),
783 "/%s/%s/", session
->hostname
,
786 char session_creation_datetime
[16];
790 timeinfo
= localtime(&session
->creation_time
);
792 ret
= -LTTNG_ERR_FATAL
;
795 strftime_ret
= strftime(session_creation_datetime
,
796 sizeof(session_creation_datetime
),
797 "%Y%m%d-%H%M%S", timeinfo
);
798 if (strftime_ret
== 0) {
799 ERR("Failed to format session creation timestamp while setting network URI");
800 ret
= -LTTNG_ERR_FATAL
;
803 ret
= snprintf(output
->dst
.net
.base_dir
,
804 sizeof(output
->dst
.net
.base_dir
),
805 "/%s/%s-%s/", session
->hostname
,
807 session_creation_datetime
);
810 if (ret
>= sizeof(output
->dst
.net
.base_dir
)) {
811 ret
= -LTTNG_ERR_INVALID
;
812 ERR("Truncation occurred while setting network output base directory");
814 } else if (ret
== -1) {
815 ret
= -LTTNG_ERR_INVALID
;
816 PERROR("Error occurred while setting network output base directory");
820 DBG3("Consumer set network uri base_dir path %s",
821 output
->dst
.net
.base_dir
);
832 * Send file descriptor to consumer via sock.
834 * The consumer socket lock must be held by the caller.
836 int consumer_send_fds(struct consumer_socket
*sock
, const int *fds
,
844 assert(pthread_mutex_trylock(sock
->lock
) == EBUSY
);
846 ret
= lttcomm_send_fds_unix_sock(*sock
->fd_ptr
, fds
, nb_fd
);
848 /* The above call will print a PERROR on error. */
849 DBG("Error when sending consumer fds on sock %d", *sock
->fd_ptr
);
853 ret
= consumer_recv_status_reply(sock
);
859 * Consumer send communication message structure to consumer.
861 * The consumer socket lock must be held by the caller.
863 int consumer_send_msg(struct consumer_socket
*sock
,
864 struct lttcomm_consumer_msg
*msg
)
870 assert(pthread_mutex_trylock(sock
->lock
) == EBUSY
);
872 ret
= consumer_socket_send(sock
, msg
, sizeof(struct lttcomm_consumer_msg
));
877 ret
= consumer_recv_status_reply(sock
);
884 * Consumer send channel communication message structure to consumer.
886 * The consumer socket lock must be held by the caller.
888 int consumer_send_channel(struct consumer_socket
*sock
,
889 struct lttcomm_consumer_msg
*msg
)
896 ret
= consumer_send_msg(sock
, msg
);
906 * Populate the given consumer msg structure with the ask_channel command
909 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
910 uint64_t subbuf_size
,
913 unsigned int switch_timer_interval
,
914 unsigned int read_timer_interval
,
915 unsigned int live_timer_interval
,
916 unsigned int monitor_timer_interval
,
920 const char *pathname
,
926 uint64_t tracefile_size
,
927 uint64_t tracefile_count
,
928 uint64_t session_id_per_pid
,
929 unsigned int monitor
,
930 uint32_t ust_app_uid
,
931 int64_t blocking_timeout
,
932 const char *root_shm_path
,
933 const char *shm_path
,
934 struct lttng_trace_chunk
*trace_chunk
,
935 const struct lttng_credentials
*buffer_credentials
)
939 /* Zeroed structure */
940 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
941 msg
->u
.ask_channel
.buffer_credentials
.uid
= UINT32_MAX
;
942 msg
->u
.ask_channel
.buffer_credentials
.gid
= UINT32_MAX
;
946 enum lttng_trace_chunk_status chunk_status
;
948 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
, &chunk_id
);
949 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
950 LTTNG_OPTIONAL_SET(&msg
->u
.ask_channel
.chunk_id
, chunk_id
);
952 msg
->u
.ask_channel
.buffer_credentials
.uid
= buffer_credentials
->uid
;
953 msg
->u
.ask_channel
.buffer_credentials
.gid
= buffer_credentials
->gid
;
955 msg
->cmd_type
= LTTNG_CONSUMER_ASK_CHANNEL_CREATION
;
956 msg
->u
.ask_channel
.subbuf_size
= subbuf_size
;
957 msg
->u
.ask_channel
.num_subbuf
= num_subbuf
;
958 msg
->u
.ask_channel
.overwrite
= overwrite
;
959 msg
->u
.ask_channel
.switch_timer_interval
= switch_timer_interval
;
960 msg
->u
.ask_channel
.read_timer_interval
= read_timer_interval
;
961 msg
->u
.ask_channel
.live_timer_interval
= live_timer_interval
;
962 msg
->u
.ask_channel
.monitor_timer_interval
= monitor_timer_interval
;
963 msg
->u
.ask_channel
.output
= output
;
964 msg
->u
.ask_channel
.type
= type
;
965 msg
->u
.ask_channel
.session_id
= session_id
;
966 msg
->u
.ask_channel
.session_id_per_pid
= session_id_per_pid
;
967 msg
->u
.ask_channel
.relayd_id
= relayd_id
;
968 msg
->u
.ask_channel
.key
= key
;
969 msg
->u
.ask_channel
.chan_id
= chan_id
;
970 msg
->u
.ask_channel
.tracefile_size
= tracefile_size
;
971 msg
->u
.ask_channel
.tracefile_count
= tracefile_count
;
972 msg
->u
.ask_channel
.monitor
= monitor
;
973 msg
->u
.ask_channel
.ust_app_uid
= ust_app_uid
;
974 msg
->u
.ask_channel
.blocking_timeout
= blocking_timeout
;
976 memcpy(msg
->u
.ask_channel
.uuid
, uuid
, sizeof(msg
->u
.ask_channel
.uuid
));
979 strncpy(msg
->u
.ask_channel
.pathname
, pathname
,
980 sizeof(msg
->u
.ask_channel
.pathname
));
981 msg
->u
.ask_channel
.pathname
[sizeof(msg
->u
.ask_channel
.pathname
)-1] = '\0';
984 strncpy(msg
->u
.ask_channel
.name
, name
, sizeof(msg
->u
.ask_channel
.name
));
985 msg
->u
.ask_channel
.name
[sizeof(msg
->u
.ask_channel
.name
) - 1] = '\0';
988 strncpy(msg
->u
.ask_channel
.root_shm_path
, root_shm_path
,
989 sizeof(msg
->u
.ask_channel
.root_shm_path
));
990 msg
->u
.ask_channel
.root_shm_path
[sizeof(msg
->u
.ask_channel
.root_shm_path
) - 1] = '\0';
993 strncpy(msg
->u
.ask_channel
.shm_path
, shm_path
,
994 sizeof(msg
->u
.ask_channel
.shm_path
));
995 msg
->u
.ask_channel
.shm_path
[sizeof(msg
->u
.ask_channel
.shm_path
) - 1] = '\0';
1000 * Init channel communication message structure.
1002 void consumer_init_add_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
1003 uint64_t channel_key
,
1004 uint64_t session_id
,
1005 const char *pathname
,
1010 unsigned int nb_init_streams
,
1011 enum lttng_event_output output
,
1013 uint64_t tracefile_size
,
1014 uint64_t tracefile_count
,
1015 unsigned int monitor
,
1016 unsigned int live_timer_interval
,
1017 unsigned int monitor_timer_interval
,
1018 struct lttng_trace_chunk
*trace_chunk
)
1022 /* Zeroed structure */
1023 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1027 enum lttng_trace_chunk_status chunk_status
;
1029 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
, &chunk_id
);
1030 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
1031 LTTNG_OPTIONAL_SET(&msg
->u
.channel
.chunk_id
, chunk_id
);
1035 msg
->cmd_type
= LTTNG_CONSUMER_ADD_CHANNEL
;
1036 msg
->u
.channel
.channel_key
= channel_key
;
1037 msg
->u
.channel
.session_id
= session_id
;
1038 msg
->u
.channel
.relayd_id
= relayd_id
;
1039 msg
->u
.channel
.nb_init_streams
= nb_init_streams
;
1040 msg
->u
.channel
.output
= output
;
1041 msg
->u
.channel
.type
= type
;
1042 msg
->u
.channel
.tracefile_size
= tracefile_size
;
1043 msg
->u
.channel
.tracefile_count
= tracefile_count
;
1044 msg
->u
.channel
.monitor
= monitor
;
1045 msg
->u
.channel
.live_timer_interval
= live_timer_interval
;
1046 msg
->u
.channel
.monitor_timer_interval
= monitor_timer_interval
;
1048 strncpy(msg
->u
.channel
.pathname
, pathname
,
1049 sizeof(msg
->u
.channel
.pathname
));
1050 msg
->u
.channel
.pathname
[sizeof(msg
->u
.channel
.pathname
) - 1] = '\0';
1052 strncpy(msg
->u
.channel
.name
, name
, sizeof(msg
->u
.channel
.name
));
1053 msg
->u
.channel
.name
[sizeof(msg
->u
.channel
.name
) - 1] = '\0';
1057 * Init stream communication message structure.
1059 void consumer_init_add_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
1060 uint64_t channel_key
,
1061 uint64_t stream_key
,
1066 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1068 msg
->cmd_type
= LTTNG_CONSUMER_ADD_STREAM
;
1069 msg
->u
.stream
.channel_key
= channel_key
;
1070 msg
->u
.stream
.stream_key
= stream_key
;
1071 msg
->u
.stream
.cpu
= cpu
;
1074 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg
*msg
,
1075 enum lttng_consumer_command cmd
,
1076 uint64_t channel_key
, uint64_t net_seq_idx
)
1080 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
1082 msg
->cmd_type
= cmd
;
1083 msg
->u
.sent_streams
.channel_key
= channel_key
;
1084 msg
->u
.sent_streams
.net_seq_idx
= net_seq_idx
;
1088 * Send stream communication structure to the consumer.
1090 int consumer_send_stream(struct consumer_socket
*sock
,
1091 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
1092 const int *fds
, size_t nb_fd
)
1101 ret
= consumer_send_msg(sock
, msg
);
1106 ret
= consumer_send_fds(sock
, fds
, nb_fd
);
1116 * Send relayd socket to consumer associated with a session name.
1118 * The consumer socket lock must be held by the caller.
1120 * On success return positive value. On error, negative value.
1122 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
1123 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
1124 enum lttng_stream_type type
, uint64_t session_id
,
1125 const char *session_name
, const char *hostname
,
1126 const char *base_path
, int session_live_timer
,
1127 const uint64_t *current_chunk_id
, time_t session_creation_time
,
1128 bool session_name_contains_creation_time
)
1131 struct lttcomm_consumer_msg msg
;
1133 /* Code flow error. Safety net. */
1136 assert(consumer_sock
);
1138 memset(&msg
, 0, sizeof(msg
));
1139 /* Bail out if consumer is disabled */
1140 if (!consumer
->enabled
) {
1145 if (type
== LTTNG_STREAM_CONTROL
) {
1146 char output_path
[LTTNG_PATH_MAX
] = {};
1147 uint64_t relayd_session_id
;
1149 ret
= relayd_create_session(rsock
,
1151 session_name
, hostname
, base_path
,
1153 consumer
->snapshot
, session_id
,
1154 sessiond_uuid
, current_chunk_id
,
1155 session_creation_time
,
1156 session_name_contains_creation_time
,
1159 /* Close the control socket. */
1160 (void) relayd_close(rsock
);
1163 msg
.u
.relayd_sock
.relayd_session_id
= relayd_session_id
;
1164 DBG("Created session on relay, output path reply: %s",
1168 msg
.cmd_type
= LTTNG_CONSUMER_ADD_RELAYD_SOCKET
;
1170 * Assign network consumer output index using the temporary consumer since
1171 * this call should only be made from within a set_consumer_uri() function
1172 * call in the session daemon.
1174 msg
.u
.relayd_sock
.net_index
= consumer
->net_seq_index
;
1175 msg
.u
.relayd_sock
.type
= type
;
1176 msg
.u
.relayd_sock
.session_id
= session_id
;
1177 memcpy(&msg
.u
.relayd_sock
.sock
, rsock
, sizeof(msg
.u
.relayd_sock
.sock
));
1179 DBG3("Sending relayd sock info to consumer on %d", *consumer_sock
->fd_ptr
);
1180 ret
= consumer_send_msg(consumer_sock
, &msg
);
1185 DBG3("Sending relayd socket file descriptor to consumer");
1186 ret
= consumer_send_fds(consumer_sock
, ALIGNED_CONST_PTR(rsock
->sock
.fd
), 1);
1191 DBG2("Consumer relayd socket sent");
1198 int consumer_send_pipe(struct consumer_socket
*consumer_sock
,
1199 enum lttng_consumer_command cmd
, int pipe
)
1202 struct lttcomm_consumer_msg msg
;
1203 const char *pipe_name
;
1204 const char *command_name
;
1207 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1208 pipe_name
= "channel monitor";
1209 command_name
= "SET_CHANNEL_MONITOR_PIPE";
1212 ERR("Unexpected command received in %s (cmd = %d)", __func__
,
1217 /* Code flow error. Safety net. */
1219 memset(&msg
, 0, sizeof(msg
));
1222 pthread_mutex_lock(consumer_sock
->lock
);
1223 DBG3("Sending %s command to consumer", command_name
);
1224 ret
= consumer_send_msg(consumer_sock
, &msg
);
1229 DBG3("Sending %s pipe %d to consumer on socket %d",
1231 pipe
, *consumer_sock
->fd_ptr
);
1232 ret
= consumer_send_fds(consumer_sock
, &pipe
, 1);
1237 DBG2("%s pipe successfully sent", pipe_name
);
1239 pthread_mutex_unlock(consumer_sock
->lock
);
1243 int consumer_send_channel_monitor_pipe(struct consumer_socket
*consumer_sock
,
1246 return consumer_send_pipe(consumer_sock
,
1247 LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
, pipe
);
1251 * Ask the consumer if the data is pending for the specific session id.
1252 * Returns 1 if data is pending, 0 otherwise, or < 0 on error.
1254 int consumer_is_data_pending(uint64_t session_id
,
1255 struct consumer_output
*consumer
)
1258 int32_t ret_code
= 0; /* Default is that the data is NOT pending */
1259 struct consumer_socket
*socket
;
1260 struct lttng_ht_iter iter
;
1261 struct lttcomm_consumer_msg msg
;
1265 DBG3("Consumer data pending for id %" PRIu64
, session_id
);
1267 memset(&msg
, 0, sizeof(msg
));
1268 msg
.cmd_type
= LTTNG_CONSUMER_DATA_PENDING
;
1269 msg
.u
.data_pending
.session_id
= session_id
;
1271 /* Send command for each consumer */
1273 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1275 pthread_mutex_lock(socket
->lock
);
1276 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1278 pthread_mutex_unlock(socket
->lock
);
1283 * No need for a recv reply status because the answer to the command is
1284 * the reply status message.
1287 ret
= consumer_socket_recv(socket
, &ret_code
, sizeof(ret_code
));
1289 pthread_mutex_unlock(socket
->lock
);
1292 pthread_mutex_unlock(socket
->lock
);
1294 if (ret_code
== 1) {
1300 DBG("Consumer data is %s pending for session id %" PRIu64
,
1301 ret_code
== 1 ? "" : "NOT", session_id
);
1310 * Send a flush command to consumer using the given channel key.
1312 * Return 0 on success else a negative value.
1314 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
)
1317 struct lttcomm_consumer_msg msg
;
1321 DBG2("Consumer flush channel key %" PRIu64
, key
);
1323 memset(&msg
, 0, sizeof(msg
));
1324 msg
.cmd_type
= LTTNG_CONSUMER_FLUSH_CHANNEL
;
1325 msg
.u
.flush_channel
.key
= key
;
1327 pthread_mutex_lock(socket
->lock
);
1328 health_code_update();
1330 ret
= consumer_send_msg(socket
, &msg
);
1336 health_code_update();
1337 pthread_mutex_unlock(socket
->lock
);
1342 * Send a clear quiescent command to consumer using the given channel key.
1344 * Return 0 on success else a negative value.
1346 int consumer_clear_quiescent_channel(struct consumer_socket
*socket
, uint64_t key
)
1349 struct lttcomm_consumer_msg msg
;
1353 DBG2("Consumer clear quiescent channel key %" PRIu64
, key
);
1355 memset(&msg
, 0, sizeof(msg
));
1356 msg
.cmd_type
= LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
;
1357 msg
.u
.clear_quiescent_channel
.key
= key
;
1359 pthread_mutex_lock(socket
->lock
);
1360 health_code_update();
1362 ret
= consumer_send_msg(socket
, &msg
);
1368 health_code_update();
1369 pthread_mutex_unlock(socket
->lock
);
1374 * Send a close metadata command to consumer using the given channel key.
1375 * Called with registry lock held.
1377 * Return 0 on success else a negative value.
1379 int consumer_close_metadata(struct consumer_socket
*socket
,
1380 uint64_t metadata_key
)
1383 struct lttcomm_consumer_msg msg
;
1387 DBG2("Consumer close metadata channel key %" PRIu64
, metadata_key
);
1389 memset(&msg
, 0, sizeof(msg
));
1390 msg
.cmd_type
= LTTNG_CONSUMER_CLOSE_METADATA
;
1391 msg
.u
.close_metadata
.key
= metadata_key
;
1393 pthread_mutex_lock(socket
->lock
);
1394 health_code_update();
1396 ret
= consumer_send_msg(socket
, &msg
);
1402 health_code_update();
1403 pthread_mutex_unlock(socket
->lock
);
1408 * Send a setup metdata command to consumer using the given channel key.
1410 * Return 0 on success else a negative value.
1412 int consumer_setup_metadata(struct consumer_socket
*socket
,
1413 uint64_t metadata_key
)
1416 struct lttcomm_consumer_msg msg
;
1420 DBG2("Consumer setup metadata channel key %" PRIu64
, metadata_key
);
1422 memset(&msg
, 0, sizeof(msg
));
1423 msg
.cmd_type
= LTTNG_CONSUMER_SETUP_METADATA
;
1424 msg
.u
.setup_metadata
.key
= metadata_key
;
1426 pthread_mutex_lock(socket
->lock
);
1427 health_code_update();
1429 ret
= consumer_send_msg(socket
, &msg
);
1435 health_code_update();
1436 pthread_mutex_unlock(socket
->lock
);
1441 * Send metadata string to consumer.
1442 * RCU read-side lock must be held to guarantee existence of socket.
1444 * Return 0 on success else a negative value.
1446 int consumer_push_metadata(struct consumer_socket
*socket
,
1447 uint64_t metadata_key
, char *metadata_str
, size_t len
,
1448 size_t target_offset
, uint64_t version
)
1451 struct lttcomm_consumer_msg msg
;
1455 DBG2("Consumer push metadata to consumer socket %d", *socket
->fd_ptr
);
1457 pthread_mutex_lock(socket
->lock
);
1459 memset(&msg
, 0, sizeof(msg
));
1460 msg
.cmd_type
= LTTNG_CONSUMER_PUSH_METADATA
;
1461 msg
.u
.push_metadata
.key
= metadata_key
;
1462 msg
.u
.push_metadata
.target_offset
= target_offset
;
1463 msg
.u
.push_metadata
.len
= len
;
1464 msg
.u
.push_metadata
.version
= version
;
1466 health_code_update();
1467 ret
= consumer_send_msg(socket
, &msg
);
1468 if (ret
< 0 || len
== 0) {
1472 DBG3("Consumer pushing metadata on sock %d of len %zu", *socket
->fd_ptr
,
1475 ret
= consumer_socket_send(socket
, metadata_str
, len
);
1480 health_code_update();
1481 ret
= consumer_recv_status_reply(socket
);
1487 pthread_mutex_unlock(socket
->lock
);
1488 health_code_update();
1493 * Ask the consumer to snapshot a specific channel using the key.
1495 * Returns LTTNG_OK on success or else an LTTng error code.
1497 enum lttng_error_code
consumer_snapshot_channel(struct consumer_socket
*socket
,
1498 uint64_t key
, const struct consumer_output
*output
, int metadata
,
1499 uid_t uid
, gid_t gid
, const char *channel_path
, int wait
,
1500 uint64_t nb_packets_per_stream
)
1503 enum lttng_error_code status
= LTTNG_OK
;
1504 struct lttcomm_consumer_msg msg
;
1509 DBG("Consumer snapshot channel key %" PRIu64
, key
);
1511 memset(&msg
, 0, sizeof(msg
));
1512 msg
.cmd_type
= LTTNG_CONSUMER_SNAPSHOT_CHANNEL
;
1513 msg
.u
.snapshot_channel
.key
= key
;
1514 msg
.u
.snapshot_channel
.nb_packets_per_stream
= nb_packets_per_stream
;
1515 msg
.u
.snapshot_channel
.metadata
= metadata
;
1517 if (output
->type
== CONSUMER_DST_NET
) {
1518 msg
.u
.snapshot_channel
.relayd_id
=
1519 output
->net_seq_index
;
1520 msg
.u
.snapshot_channel
.use_relayd
= 1;
1522 msg
.u
.snapshot_channel
.relayd_id
= (uint64_t) -1ULL;
1524 ret
= lttng_strncpy(msg
.u
.snapshot_channel
.pathname
,
1526 sizeof(msg
.u
.snapshot_channel
.pathname
));
1528 ERR("Snapshot path exceeds the maximal allowed length of %zu bytes (%zu bytes required) with path \"%s\"",
1529 sizeof(msg
.u
.snapshot_channel
.pathname
),
1530 strlen(channel_path
),
1532 status
= LTTNG_ERR_SNAPSHOT_FAIL
;
1536 health_code_update();
1537 pthread_mutex_lock(socket
->lock
);
1538 ret
= consumer_send_msg(socket
, &msg
);
1539 pthread_mutex_unlock(socket
->lock
);
1542 case LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
:
1543 status
= LTTNG_ERR_CHAN_NOT_FOUND
;
1546 status
= LTTNG_ERR_SNAPSHOT_FAIL
;
1553 health_code_update();
1558 * Ask the consumer the number of discarded events for a channel.
1560 int consumer_get_discarded_events(uint64_t session_id
, uint64_t channel_key
,
1561 struct consumer_output
*consumer
, uint64_t *discarded
)
1564 struct consumer_socket
*socket
;
1565 struct lttng_ht_iter iter
;
1566 struct lttcomm_consumer_msg msg
;
1570 DBG3("Consumer discarded events id %" PRIu64
, session_id
);
1572 memset(&msg
, 0, sizeof(msg
));
1573 msg
.cmd_type
= LTTNG_CONSUMER_DISCARDED_EVENTS
;
1574 msg
.u
.discarded_events
.session_id
= session_id
;
1575 msg
.u
.discarded_events
.channel_key
= channel_key
;
1579 /* Send command for each consumer */
1581 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1583 uint64_t consumer_discarded
= 0;
1584 pthread_mutex_lock(socket
->lock
);
1585 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1587 pthread_mutex_unlock(socket
->lock
);
1592 * No need for a recv reply status because the answer to the
1593 * command is the reply status message.
1595 ret
= consumer_socket_recv(socket
, &consumer_discarded
,
1596 sizeof(consumer_discarded
));
1598 ERR("get discarded events");
1599 pthread_mutex_unlock(socket
->lock
);
1602 pthread_mutex_unlock(socket
->lock
);
1603 *discarded
+= consumer_discarded
;
1606 DBG("Consumer discarded %" PRIu64
" events in session id %" PRIu64
,
1607 *discarded
, session_id
);
1615 * Ask the consumer the number of lost packets for a channel.
1617 int consumer_get_lost_packets(uint64_t session_id
, uint64_t channel_key
,
1618 struct consumer_output
*consumer
, uint64_t *lost
)
1621 struct consumer_socket
*socket
;
1622 struct lttng_ht_iter iter
;
1623 struct lttcomm_consumer_msg msg
;
1627 DBG3("Consumer lost packets id %" PRIu64
, session_id
);
1629 memset(&msg
, 0, sizeof(msg
));
1630 msg
.cmd_type
= LTTNG_CONSUMER_LOST_PACKETS
;
1631 msg
.u
.lost_packets
.session_id
= session_id
;
1632 msg
.u
.lost_packets
.channel_key
= channel_key
;
1636 /* Send command for each consumer */
1638 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1640 uint64_t consumer_lost
= 0;
1641 pthread_mutex_lock(socket
->lock
);
1642 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1644 pthread_mutex_unlock(socket
->lock
);
1649 * No need for a recv reply status because the answer to the
1650 * command is the reply status message.
1652 ret
= consumer_socket_recv(socket
, &consumer_lost
,
1653 sizeof(consumer_lost
));
1655 ERR("get lost packets");
1656 pthread_mutex_unlock(socket
->lock
);
1659 pthread_mutex_unlock(socket
->lock
);
1660 *lost
+= consumer_lost
;
1663 DBG("Consumer lost %" PRIu64
" packets in session id %" PRIu64
,
1672 * Ask the consumer to rotate a channel.
1674 * The new_chunk_id is the session->rotate_count that has been incremented
1675 * when the rotation started. On the relay, this allows to keep track in which
1676 * chunk each stream is currently writing to (for the rotate_pending operation).
1678 int consumer_rotate_channel(struct consumer_socket
*socket
, uint64_t key
,
1679 uid_t uid
, gid_t gid
, struct consumer_output
*output
,
1680 bool is_metadata_channel
)
1683 struct lttcomm_consumer_msg msg
;
1687 DBG("Consumer rotate channel key %" PRIu64
, key
);
1689 pthread_mutex_lock(socket
->lock
);
1690 memset(&msg
, 0, sizeof(msg
));
1691 msg
.cmd_type
= LTTNG_CONSUMER_ROTATE_CHANNEL
;
1692 msg
.u
.rotate_channel
.key
= key
;
1693 msg
.u
.rotate_channel
.metadata
= !!is_metadata_channel
;
1695 if (output
->type
== CONSUMER_DST_NET
) {
1696 msg
.u
.rotate_channel
.relayd_id
= output
->net_seq_index
;
1698 msg
.u
.rotate_channel
.relayd_id
= (uint64_t) -1ULL;
1701 health_code_update();
1702 ret
= consumer_send_msg(socket
, &msg
);
1705 case LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
:
1706 ret
= -LTTNG_ERR_CHAN_NOT_FOUND
;
1709 ret
= -LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
1715 pthread_mutex_unlock(socket
->lock
);
1716 health_code_update();
1720 int consumer_clear_channel(struct consumer_socket
*socket
, uint64_t key
)
1723 struct lttcomm_consumer_msg msg
;
1727 DBG("Consumer clear channel %" PRIu64
, key
);
1729 memset(&msg
, 0, sizeof(msg
));
1730 msg
.cmd_type
= LTTNG_CONSUMER_CLEAR_CHANNEL
;
1731 msg
.u
.clear_channel
.key
= key
;
1733 health_code_update();
1735 pthread_mutex_lock(socket
->lock
);
1736 ret
= consumer_send_msg(socket
, &msg
);
1742 pthread_mutex_unlock(socket
->lock
);
1744 health_code_update();
1748 int consumer_init(struct consumer_socket
*socket
,
1749 const lttng_uuid sessiond_uuid
)
1752 struct lttcomm_consumer_msg msg
= {
1753 .cmd_type
= LTTNG_CONSUMER_INIT
,
1758 DBG("Sending consumer initialization command");
1759 lttng_uuid_copy(msg
.u
.init
.sessiond_uuid
, sessiond_uuid
);
1761 health_code_update();
1762 ret
= consumer_send_msg(socket
, &msg
);
1768 health_code_update();
1773 * Ask the consumer to create a new chunk for a given session.
1775 * Called with the consumer socket lock held.
1777 int consumer_create_trace_chunk(struct consumer_socket
*socket
,
1778 uint64_t relayd_id
, uint64_t session_id
,
1779 struct lttng_trace_chunk
*chunk
,
1780 const char *domain_subdir
)
1783 enum lttng_trace_chunk_status chunk_status
;
1784 struct lttng_credentials chunk_credentials
;
1785 const struct lttng_directory_handle
*chunk_directory_handle
= NULL
;
1786 struct lttng_directory_handle
*domain_handle
= NULL
;
1788 const char *chunk_name
;
1789 bool chunk_name_overridden
;
1791 time_t creation_timestamp
;
1792 char creation_timestamp_buffer
[ISO8601_STR_LEN
];
1793 const char *creation_timestamp_str
= "(none)";
1794 const bool chunk_has_local_output
= relayd_id
== -1ULL;
1795 struct lttcomm_consumer_msg msg
= {
1796 .cmd_type
= LTTNG_CONSUMER_CREATE_TRACE_CHUNK
,
1797 .u
.create_trace_chunk
.session_id
= session_id
,
1803 if (relayd_id
!= -1ULL) {
1804 LTTNG_OPTIONAL_SET(&msg
.u
.create_trace_chunk
.relayd_id
,
1808 chunk_status
= lttng_trace_chunk_get_name(chunk
, &chunk_name
,
1809 &chunk_name_overridden
);
1810 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
&&
1811 chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_NONE
) {
1812 ERR("Failed to get name of trace chunk");
1813 ret
= -LTTNG_ERR_FATAL
;
1816 if (chunk_name_overridden
) {
1817 ret
= lttng_strncpy(msg
.u
.create_trace_chunk
.override_name
,
1819 sizeof(msg
.u
.create_trace_chunk
.override_name
));
1821 ERR("Trace chunk name \"%s\" exceeds the maximal length allowed by the consumer protocol",
1823 ret
= -LTTNG_ERR_FATAL
;
1828 chunk_status
= lttng_trace_chunk_get_creation_timestamp(chunk
,
1829 &creation_timestamp
);
1830 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1831 ret
= -LTTNG_ERR_FATAL
;
1834 msg
.u
.create_trace_chunk
.creation_timestamp
=
1835 (uint64_t) creation_timestamp
;
1836 /* Only used for logging purposes. */
1837 ret
= time_to_iso8601_str(creation_timestamp
,
1838 creation_timestamp_buffer
,
1839 sizeof(creation_timestamp_buffer
));
1840 creation_timestamp_str
= !ret
? creation_timestamp_buffer
:
1841 "(formatting error)";
1843 chunk_status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1844 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1846 * Anonymous trace chunks should never be transmitted
1847 * to remote peers (consumerd and relayd). They are used
1848 * internally for backward-compatibility purposes.
1850 ret
= -LTTNG_ERR_FATAL
;
1853 msg
.u
.create_trace_chunk
.chunk_id
= chunk_id
;
1855 if (chunk_has_local_output
) {
1856 chunk_status
= lttng_trace_chunk_borrow_chunk_directory_handle(
1857 chunk
, &chunk_directory_handle
);
1858 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1859 ret
= -LTTNG_ERR_FATAL
;
1862 chunk_status
= lttng_trace_chunk_get_credentials(
1863 chunk
, &chunk_credentials
);
1864 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1866 * Not associating credentials to a sessiond chunk is a
1867 * fatal internal error.
1869 ret
= -LTTNG_ERR_FATAL
;
1872 ret
= lttng_directory_handle_create_subdirectory_as_user(
1873 chunk_directory_handle
,
1876 &chunk_credentials
);
1878 PERROR("Failed to create chunk domain output directory \"%s\"",
1880 ret
= -LTTNG_ERR_FATAL
;
1883 domain_handle
= lttng_directory_handle_create_from_handle(
1885 chunk_directory_handle
);
1886 if (!domain_handle
) {
1887 ret
= -LTTNG_ERR_FATAL
;
1892 * This will only compile on platforms that support
1893 * dirfd (POSIX.2008). This is fine as the session daemon
1894 * is only built for such platforms.
1896 * The ownership of the chunk directory handle's is maintained
1897 * by the trace chunk.
1899 domain_dirfd
= lttng_directory_handle_get_dirfd(
1901 assert(domain_dirfd
>= 0);
1903 msg
.u
.create_trace_chunk
.credentials
.value
.uid
=
1904 chunk_credentials
.uid
;
1905 msg
.u
.create_trace_chunk
.credentials
.value
.gid
=
1906 chunk_credentials
.gid
;
1907 msg
.u
.create_trace_chunk
.credentials
.is_set
= 1;
1910 DBG("Sending consumer create trace chunk command: relayd_id = %" PRId64
1911 ", session_id = %" PRIu64
", chunk_id = %" PRIu64
1912 ", creation_timestamp = %s",
1913 relayd_id
, session_id
, chunk_id
,
1914 creation_timestamp_str
);
1915 health_code_update();
1916 ret
= consumer_send_msg(socket
, &msg
);
1917 health_code_update();
1919 ERR("Trace chunk creation error on consumer");
1920 ret
= -LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
1924 if (chunk_has_local_output
) {
1925 DBG("Sending trace chunk domain directory fd to consumer");
1926 health_code_update();
1927 ret
= consumer_send_fds(socket
, &domain_dirfd
, 1);
1928 health_code_update();
1930 ERR("Trace chunk creation error on consumer");
1931 ret
= -LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
1936 lttng_directory_handle_put(domain_handle
);
1941 * Ask the consumer to close a trace chunk for a given session.
1943 * Called with the consumer socket lock held.
1945 int consumer_close_trace_chunk(struct consumer_socket
*socket
,
1946 uint64_t relayd_id
, uint64_t session_id
,
1947 struct lttng_trace_chunk
*chunk
,
1948 char *closed_trace_chunk_path
)
1951 enum lttng_trace_chunk_status chunk_status
;
1952 struct lttcomm_consumer_msg msg
= {
1953 .cmd_type
= LTTNG_CONSUMER_CLOSE_TRACE_CHUNK
,
1954 .u
.close_trace_chunk
.session_id
= session_id
,
1956 struct lttcomm_consumer_close_trace_chunk_reply reply
;
1958 time_t close_timestamp
;
1959 enum lttng_trace_chunk_command_type close_command
;
1960 const char *close_command_name
= "none";
1961 struct lttng_dynamic_buffer path_reception_buffer
;
1964 lttng_dynamic_buffer_init(&path_reception_buffer
);
1966 if (relayd_id
!= -1ULL) {
1968 &msg
.u
.close_trace_chunk
.relayd_id
, relayd_id
);
1971 chunk_status
= lttng_trace_chunk_get_close_command(
1972 chunk
, &close_command
);
1973 switch (chunk_status
) {
1974 case LTTNG_TRACE_CHUNK_STATUS_OK
:
1975 LTTNG_OPTIONAL_SET(&msg
.u
.close_trace_chunk
.close_command
,
1976 (uint32_t) close_command
);
1978 case LTTNG_TRACE_CHUNK_STATUS_NONE
:
1981 ERR("Failed to get trace chunk close command");
1986 chunk_status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1988 * Anonymous trace chunks should never be transmitted to remote peers
1989 * (consumerd and relayd). They are used internally for
1990 * backward-compatibility purposes.
1992 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
1993 msg
.u
.close_trace_chunk
.chunk_id
= chunk_id
;
1995 chunk_status
= lttng_trace_chunk_get_close_timestamp(chunk
,
1998 * A trace chunk should be closed locally before being closed remotely.
1999 * Otherwise, the close timestamp would never be transmitted to the
2002 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
2003 msg
.u
.close_trace_chunk
.close_timestamp
= (uint64_t) close_timestamp
;
2005 if (msg
.u
.close_trace_chunk
.close_command
.is_set
) {
2006 close_command_name
= lttng_trace_chunk_command_type_get_name(
2009 DBG("Sending consumer close trace chunk command: relayd_id = %" PRId64
2010 ", session_id = %" PRIu64
", chunk_id = %" PRIu64
2011 ", close command = \"%s\"",
2012 relayd_id
, session_id
, chunk_id
, close_command_name
);
2014 health_code_update();
2015 ret
= consumer_socket_send(socket
, &msg
, sizeof(struct lttcomm_consumer_msg
));
2017 ret
= -LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
2020 ret
= consumer_socket_recv(socket
, &reply
, sizeof(reply
));
2022 ret
= -LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
2025 if (reply
.path_length
>= LTTNG_PATH_MAX
) {
2026 ERR("Invalid path returned by relay daemon: %" PRIu32
"bytes exceeds maximal allowed length of %d bytes",
2027 reply
.path_length
, LTTNG_PATH_MAX
);
2028 ret
= -LTTNG_ERR_INVALID_PROTOCOL
;
2031 ret
= lttng_dynamic_buffer_set_size(&path_reception_buffer
,
2034 ERR("Failed to allocate reception buffer of path returned by the \"close trace chunk\" command");
2035 ret
= -LTTNG_ERR_NOMEM
;
2038 ret
= consumer_socket_recv(socket
, path_reception_buffer
.data
,
2039 path_reception_buffer
.size
);
2041 ERR("Communication error while receiving path of closed trace chunk");
2042 ret
= -LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
2045 if (path_reception_buffer
.data
[path_reception_buffer
.size
- 1] != '\0') {
2046 ERR("Invalid path returned by relay daemon: not null-terminated");
2047 ret
= -LTTNG_ERR_INVALID_PROTOCOL
;
2050 if (closed_trace_chunk_path
) {
2052 * closed_trace_chunk_path is assumed to have a length >=
2055 memcpy(closed_trace_chunk_path
, path_reception_buffer
.data
,
2056 path_reception_buffer
.size
);
2059 lttng_dynamic_buffer_reset(&path_reception_buffer
);
2060 health_code_update();
2065 * Ask the consumer if a trace chunk exists.
2067 * Called with the consumer socket lock held.
2068 * Returns 0 on success, or a negative value on error.
2070 int consumer_trace_chunk_exists(struct consumer_socket
*socket
,
2071 uint64_t relayd_id
, uint64_t session_id
,
2072 struct lttng_trace_chunk
*chunk
,
2073 enum consumer_trace_chunk_exists_status
*result
)
2076 enum lttng_trace_chunk_status chunk_status
;
2077 struct lttcomm_consumer_msg msg
= {
2078 .cmd_type
= LTTNG_CONSUMER_TRACE_CHUNK_EXISTS
,
2079 .u
.trace_chunk_exists
.session_id
= session_id
,
2082 const char *consumer_reply_str
;
2086 if (relayd_id
!= -1ULL) {
2087 LTTNG_OPTIONAL_SET(&msg
.u
.trace_chunk_exists
.relayd_id
,
2091 chunk_status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
2092 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
2094 * Anonymous trace chunks should never be transmitted
2095 * to remote peers (consumerd and relayd). They are used
2096 * internally for backward-compatibility purposes.
2098 ret
= -LTTNG_ERR_FATAL
;
2101 msg
.u
.trace_chunk_exists
.chunk_id
= chunk_id
;
2103 DBG("Sending consumer trace chunk exists command: relayd_id = %" PRId64
2104 ", session_id = %" PRIu64
2105 ", chunk_id = %" PRIu64
, relayd_id
, session_id
, chunk_id
);
2107 health_code_update();
2108 ret
= consumer_send_msg(socket
, &msg
);
2110 case LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
:
2111 consumer_reply_str
= "unknown trace chunk";
2112 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_UNKNOWN_CHUNK
;
2114 case LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL
:
2115 consumer_reply_str
= "trace chunk exists locally";
2116 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_EXISTS_LOCAL
;
2118 case LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE
:
2119 consumer_reply_str
= "trace chunk exists on remote peer";
2120 *result
= CONSUMER_TRACE_CHUNK_EXISTS_STATUS_EXISTS_REMOTE
;
2123 ERR("Consumer returned an error from TRACE_CHUNK_EXISTS command");
2127 DBG("Consumer reply to TRACE_CHUNK_EXISTS command: %s",
2128 consumer_reply_str
);
2131 health_code_update();