2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 #include <sys/types.h>
28 #include <common/common.h>
29 #include <common/defaults.h>
30 #include <common/uri.h>
31 #include <common/relayd/relayd.h>
34 #include "health-sessiond.h"
39 * Send a data payload using a given consumer socket of size len.
41 * The consumer socket lock MUST be acquired before calling this since this
42 * function can change the fd value.
44 * Return 0 on success else a negative value on error.
46 int consumer_socket_send(struct consumer_socket
*socket
, void *msg
, size_t len
)
52 assert(socket
->fd_ptr
);
55 /* Consumer socket is invalid. Stopping. */
61 size
= lttcomm_send_unix_sock(fd
, msg
, len
);
63 /* The above call will print a PERROR on error. */
64 DBG("Error when sending data to consumer on sock %d", fd
);
66 * At this point, the socket is not usable anymore thus closing it and
67 * setting the file descriptor to -1 so it is not reused.
70 /* This call will PERROR on error. */
71 (void) lttcomm_close_unix_sock(fd
);
83 * Receive a data payload using a given consumer socket of size len.
85 * The consumer socket lock MUST be acquired before calling this since this
86 * function can change the fd value.
88 * Return 0 on success else a negative value on error.
90 int consumer_socket_recv(struct consumer_socket
*socket
, void *msg
, size_t len
)
96 assert(socket
->fd_ptr
);
99 /* Consumer socket is invalid. Stopping. */
100 fd
= *socket
->fd_ptr
;
105 size
= lttcomm_recv_unix_sock(fd
, msg
, len
);
107 /* The above call will print a PERROR on error. */
108 DBG("Error when receiving data from the consumer socket %d", fd
);
110 * At this point, the socket is not usable anymore thus closing it and
111 * setting the file descriptor to -1 so it is not reused.
114 /* This call will PERROR on error. */
115 (void) lttcomm_close_unix_sock(fd
);
116 *socket
->fd_ptr
= -1;
127 * Receive a reply command status message from the consumer. Consumer socket
128 * lock MUST be acquired before calling this function.
130 * Return 0 on success, -1 on recv error or a negative lttng error code which
131 * was possibly returned by the consumer.
133 int consumer_recv_status_reply(struct consumer_socket
*sock
)
136 struct lttcomm_consumer_status_msg reply
;
140 ret
= consumer_socket_recv(sock
, &reply
, sizeof(reply
));
145 if (reply
.ret_code
== LTTCOMM_CONSUMERD_SUCCESS
) {
149 ret
= -reply
.ret_code
;
150 DBG("Consumer ret code %d", ret
);
158 * Once the ASK_CHANNEL command is sent to the consumer, the channel
159 * information are sent back. This call receives that data and populates key
162 * On success return 0 and both key and stream_count are set. On error, a
163 * negative value is sent back and both parameters are untouched.
165 int consumer_recv_status_channel(struct consumer_socket
*sock
,
166 uint64_t *key
, unsigned int *stream_count
)
169 struct lttcomm_consumer_status_channel reply
;
172 assert(stream_count
);
175 ret
= consumer_socket_recv(sock
, &reply
, sizeof(reply
));
180 /* An error is possible so don't touch the key and stream_count. */
181 if (reply
.ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
187 *stream_count
= reply
.stream_count
;
195 * Send destroy relayd command to consumer.
197 * On success return positive value. On error, negative value.
199 int consumer_send_destroy_relayd(struct consumer_socket
*sock
,
200 struct consumer_output
*consumer
)
203 struct lttcomm_consumer_msg msg
;
208 DBG2("Sending destroy relayd command to consumer sock %d", *sock
->fd_ptr
);
210 memset(&msg
, 0, sizeof(msg
));
211 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_RELAYD
;
212 msg
.u
.destroy_relayd
.net_seq_idx
= consumer
->net_seq_index
;
214 pthread_mutex_lock(sock
->lock
);
215 ret
= consumer_socket_send(sock
, &msg
, sizeof(msg
));
220 /* Don't check the return value. The caller will do it. */
221 ret
= consumer_recv_status_reply(sock
);
223 DBG2("Consumer send destroy relayd command done");
226 pthread_mutex_unlock(sock
->lock
);
231 * For each consumer socket in the consumer output object, send a destroy
234 void consumer_output_send_destroy_relayd(struct consumer_output
*consumer
)
236 struct lttng_ht_iter iter
;
237 struct consumer_socket
*socket
;
241 /* Destroy any relayd connection */
242 if (consumer
->type
== CONSUMER_DST_NET
) {
244 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
248 /* Send destroy relayd command */
249 ret
= consumer_send_destroy_relayd(socket
, consumer
);
251 DBG("Unable to send destroy relayd command to consumer");
252 /* Continue since we MUST delete everything at this point. */
260 * From a consumer_data structure, allocate and add a consumer socket to the
263 * Return 0 on success, else negative value on error
265 int consumer_create_socket(struct consumer_data
*data
,
266 struct consumer_output
*output
)
269 struct consumer_socket
*socket
;
273 if (output
== NULL
|| data
->cmd_sock
< 0) {
275 * Not an error. Possible there is simply not spawned consumer or it's
276 * disabled for the tracing session asking the socket.
282 socket
= consumer_find_socket(data
->cmd_sock
, output
);
284 if (socket
== NULL
) {
285 socket
= consumer_allocate_socket(&data
->cmd_sock
);
286 if (socket
== NULL
) {
291 socket
->registered
= 0;
292 socket
->lock
= &data
->lock
;
294 consumer_add_socket(socket
, output
);
298 socket
->type
= data
->type
;
300 DBG3("Consumer socket created (fd: %d) and added to output",
308 * Return the consumer socket from the given consumer output with the right
309 * bitness. On error, returns NULL.
311 * The caller MUST acquire a rcu read side lock and keep it until the socket
312 * object reference is not needed anymore.
314 struct consumer_socket
*consumer_find_socket_by_bitness(int bits
,
315 struct consumer_output
*consumer
)
318 struct consumer_socket
*socket
= NULL
;
322 consumer_fd
= uatomic_read(&ust_consumerd64_fd
);
325 consumer_fd
= uatomic_read(&ust_consumerd32_fd
);
332 socket
= consumer_find_socket(consumer_fd
, consumer
);
334 ERR("Consumer socket fd %d not found in consumer obj %p",
335 consumer_fd
, consumer
);
343 * Find a consumer_socket in a consumer_output hashtable. Read side lock must
344 * be acquired before calling this function and across use of the
345 * returned consumer_socket.
347 struct consumer_socket
*consumer_find_socket(int key
,
348 struct consumer_output
*consumer
)
350 struct lttng_ht_iter iter
;
351 struct lttng_ht_node_ulong
*node
;
352 struct consumer_socket
*socket
= NULL
;
354 /* Negative keys are lookup failures */
355 if (key
< 0 || consumer
== NULL
) {
359 lttng_ht_lookup(consumer
->socks
, (void *)((unsigned long) key
),
361 node
= lttng_ht_iter_get_node_ulong(&iter
);
363 socket
= caa_container_of(node
, struct consumer_socket
, node
);
370 * Allocate a new consumer_socket and return the pointer.
372 struct consumer_socket
*consumer_allocate_socket(int *fd
)
374 struct consumer_socket
*socket
= NULL
;
378 socket
= zmalloc(sizeof(struct consumer_socket
));
379 if (socket
== NULL
) {
380 PERROR("zmalloc consumer socket");
385 lttng_ht_node_init_ulong(&socket
->node
, *fd
);
392 * Add consumer socket to consumer output object. Read side lock must be
393 * acquired before calling this function.
395 void consumer_add_socket(struct consumer_socket
*sock
,
396 struct consumer_output
*consumer
)
401 lttng_ht_add_unique_ulong(consumer
->socks
, &sock
->node
);
405 * Delte consumer socket to consumer output object. Read side lock must be
406 * acquired before calling this function.
408 void consumer_del_socket(struct consumer_socket
*sock
,
409 struct consumer_output
*consumer
)
412 struct lttng_ht_iter iter
;
417 iter
.iter
.node
= &sock
->node
.node
;
418 ret
= lttng_ht_del(consumer
->socks
, &iter
);
423 * RCU destroy call function.
425 static void destroy_socket_rcu(struct rcu_head
*head
)
427 struct lttng_ht_node_ulong
*node
=
428 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
429 struct consumer_socket
*socket
=
430 caa_container_of(node
, struct consumer_socket
, node
);
436 * Destroy and free socket pointer in a call RCU. Read side lock must be
437 * acquired before calling this function.
439 void consumer_destroy_socket(struct consumer_socket
*sock
)
444 * We DO NOT close the file descriptor here since it is global to the
445 * session daemon and is closed only if the consumer dies or a custom
446 * consumer was registered,
448 if (sock
->registered
) {
449 DBG3("Consumer socket was registered. Closing fd %d", *sock
->fd_ptr
);
450 lttcomm_close_unix_sock(*sock
->fd_ptr
);
453 call_rcu(&sock
->node
.head
, destroy_socket_rcu
);
457 * Allocate and assign data to a consumer_output object.
459 * Return pointer to structure.
461 struct consumer_output
*consumer_create_output(enum consumer_dst_type type
)
463 struct consumer_output
*output
= NULL
;
465 output
= zmalloc(sizeof(struct consumer_output
));
466 if (output
== NULL
) {
467 PERROR("zmalloc consumer_output");
471 /* By default, consumer output is enabled */
474 output
->net_seq_index
= (uint64_t) -1ULL;
475 urcu_ref_init(&output
->ref
);
477 output
->socks
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
484 * Iterate over the consumer output socket hash table and destroy them. The
485 * socket file descriptor are only closed if the consumer output was
486 * registered meaning it's an external consumer.
488 void consumer_destroy_output_sockets(struct consumer_output
*obj
)
490 struct lttng_ht_iter iter
;
491 struct consumer_socket
*socket
;
498 cds_lfht_for_each_entry(obj
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
499 consumer_del_socket(socket
, obj
);
500 consumer_destroy_socket(socket
);
506 * Delete the consumer_output object from the list and free the ptr.
508 * Should *NOT* be called with RCU read-side lock held.
510 static void consumer_release_output(struct urcu_ref
*ref
)
512 struct consumer_output
*obj
=
513 caa_container_of(ref
, struct consumer_output
, ref
);
515 consumer_destroy_output_sockets(obj
);
518 /* Finally destroy HT */
519 ht_cleanup_push(obj
->socks
);
526 * Get the consumer_output object.
528 void consumer_output_get(struct consumer_output
*obj
)
530 urcu_ref_get(&obj
->ref
);
534 * Put the consumer_output object.
536 * Should *NOT* be called with RCU read-side lock held.
538 void consumer_output_put(struct consumer_output
*obj
)
543 urcu_ref_put(&obj
->ref
, consumer_release_output
);
547 * Copy consumer output and returned the newly allocated copy.
549 * Should *NOT* be called with RCU read-side lock held.
551 struct consumer_output
*consumer_copy_output(struct consumer_output
*obj
)
554 struct consumer_output
*output
;
558 output
= consumer_create_output(obj
->type
);
559 if (output
== NULL
) {
562 output
->enabled
= obj
->enabled
;
563 output
->net_seq_index
= obj
->net_seq_index
;
564 memcpy(output
->subdir
, obj
->subdir
, PATH_MAX
);
565 output
->snapshot
= obj
->snapshot
;
566 output
->relay_major_version
= obj
->relay_major_version
;
567 output
->relay_minor_version
= obj
->relay_minor_version
;
568 memcpy(&output
->dst
, &obj
->dst
, sizeof(output
->dst
));
569 ret
= consumer_copy_sockets(output
, obj
);
577 consumer_output_put(output
);
582 * Copy consumer sockets from src to dst.
584 * Return 0 on success or else a negative value.
586 int consumer_copy_sockets(struct consumer_output
*dst
,
587 struct consumer_output
*src
)
590 struct lttng_ht_iter iter
;
591 struct consumer_socket
*socket
, *copy_sock
;
597 cds_lfht_for_each_entry(src
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
598 /* Ignore socket that are already there. */
599 copy_sock
= consumer_find_socket(*socket
->fd_ptr
, dst
);
604 /* Create new socket object. */
605 copy_sock
= consumer_allocate_socket(socket
->fd_ptr
);
606 if (copy_sock
== NULL
) {
612 copy_sock
->registered
= socket
->registered
;
614 * This is valid because this lock is shared accross all consumer
615 * object being the global lock of the consumer data structure of the
618 copy_sock
->lock
= socket
->lock
;
619 consumer_add_socket(copy_sock
, dst
);
628 * Set network URI to the consumer output object.
630 * Return 0 on success. Return 1 if the URI were equal. Else, negative value on
633 int consumer_set_network_uri(struct consumer_output
*obj
,
634 struct lttng_uri
*uri
)
637 char tmp_path
[PATH_MAX
];
638 char hostname
[HOST_NAME_MAX
];
639 struct lttng_uri
*dst_uri
= NULL
;
641 /* Code flow error safety net. */
645 switch (uri
->stype
) {
646 case LTTNG_STREAM_CONTROL
:
647 dst_uri
= &obj
->dst
.net
.control
;
648 obj
->dst
.net
.control_isset
= 1;
649 if (uri
->port
== 0) {
650 /* Assign default port. */
651 uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
653 if (obj
->dst
.net
.data_isset
&& uri
->port
==
654 obj
->dst
.net
.data
.port
) {
655 ret
= -LTTNG_ERR_INVALID
;
659 DBG3("Consumer control URI set with port %d", uri
->port
);
661 case LTTNG_STREAM_DATA
:
662 dst_uri
= &obj
->dst
.net
.data
;
663 obj
->dst
.net
.data_isset
= 1;
664 if (uri
->port
== 0) {
665 /* Assign default port. */
666 uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
668 if (obj
->dst
.net
.control_isset
&& uri
->port
==
669 obj
->dst
.net
.control
.port
) {
670 ret
= -LTTNG_ERR_INVALID
;
674 DBG3("Consumer data URI set with port %d", uri
->port
);
677 ERR("Set network uri type unknown %d", uri
->stype
);
678 ret
= -LTTNG_ERR_INVALID
;
682 ret
= uri_compare(dst_uri
, uri
);
684 /* Same URI, don't touch it and return success. */
685 DBG3("URI network compare are the same");
689 /* URIs were not equal, replacing it. */
690 memset(dst_uri
, 0, sizeof(struct lttng_uri
));
691 memcpy(dst_uri
, uri
, sizeof(struct lttng_uri
));
692 obj
->type
= CONSUMER_DST_NET
;
694 /* Handle subdir and add hostname in front. */
695 if (dst_uri
->stype
== LTTNG_STREAM_CONTROL
) {
696 /* Get hostname to append it in the pathname */
697 ret
= gethostname(hostname
, sizeof(hostname
));
699 PERROR("gethostname. Fallback on default localhost");
700 strncpy(hostname
, "localhost", sizeof(hostname
));
702 hostname
[sizeof(hostname
) - 1] = '\0';
704 /* Setup consumer subdir if none present in the control URI */
705 if (strlen(dst_uri
->subdir
) == 0) {
706 ret
= snprintf(tmp_path
, sizeof(tmp_path
), "%s/%s",
707 hostname
, obj
->subdir
);
709 ret
= snprintf(tmp_path
, sizeof(tmp_path
), "%s/%s",
710 hostname
, dst_uri
->subdir
);
713 PERROR("snprintf set consumer uri subdir");
714 ret
= -LTTNG_ERR_NOMEM
;
718 if (lttng_strncpy(obj
->subdir
, tmp_path
, sizeof(obj
->subdir
))) {
719 ret
= -LTTNG_ERR_INVALID
;
722 DBG3("Consumer set network uri subdir path %s", tmp_path
);
733 * Send file descriptor to consumer via sock.
735 int consumer_send_fds(struct consumer_socket
*sock
, int *fds
, size_t nb_fd
)
743 ret
= lttcomm_send_fds_unix_sock(*sock
->fd_ptr
, fds
, nb_fd
);
745 /* The above call will print a PERROR on error. */
746 DBG("Error when sending consumer fds on sock %d", *sock
->fd_ptr
);
750 ret
= consumer_recv_status_reply(sock
);
756 * Consumer send communication message structure to consumer.
758 int consumer_send_msg(struct consumer_socket
*sock
,
759 struct lttcomm_consumer_msg
*msg
)
766 ret
= consumer_socket_send(sock
, msg
, sizeof(struct lttcomm_consumer_msg
));
771 ret
= consumer_recv_status_reply(sock
);
778 * Consumer send channel communication message structure to consumer.
780 int consumer_send_channel(struct consumer_socket
*sock
,
781 struct lttcomm_consumer_msg
*msg
)
788 ret
= consumer_send_msg(sock
, msg
);
798 * Populate the given consumer msg structure with the ask_channel command
801 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
802 uint64_t subbuf_size
,
805 unsigned int switch_timer_interval
,
806 unsigned int read_timer_interval
,
807 unsigned int live_timer_interval
,
808 unsigned int monitor_timer_interval
,
812 const char *pathname
,
820 uint64_t tracefile_size
,
821 uint64_t tracefile_count
,
822 uint64_t session_id_per_pid
,
823 unsigned int monitor
,
824 uint32_t ust_app_uid
,
825 const char *root_shm_path
,
826 const char *shm_path
)
830 /* Zeroed structure */
831 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
833 msg
->cmd_type
= LTTNG_CONSUMER_ASK_CHANNEL_CREATION
;
834 msg
->u
.ask_channel
.subbuf_size
= subbuf_size
;
835 msg
->u
.ask_channel
.num_subbuf
= num_subbuf
;
836 msg
->u
.ask_channel
.overwrite
= overwrite
;
837 msg
->u
.ask_channel
.switch_timer_interval
= switch_timer_interval
;
838 msg
->u
.ask_channel
.read_timer_interval
= read_timer_interval
;
839 msg
->u
.ask_channel
.live_timer_interval
= live_timer_interval
;
840 msg
->u
.ask_channel
.monitor_timer_interval
= monitor_timer_interval
;
841 msg
->u
.ask_channel
.output
= output
;
842 msg
->u
.ask_channel
.type
= type
;
843 msg
->u
.ask_channel
.session_id
= session_id
;
844 msg
->u
.ask_channel
.session_id_per_pid
= session_id_per_pid
;
845 msg
->u
.ask_channel
.uid
= uid
;
846 msg
->u
.ask_channel
.gid
= gid
;
847 msg
->u
.ask_channel
.relayd_id
= relayd_id
;
848 msg
->u
.ask_channel
.key
= key
;
849 msg
->u
.ask_channel
.chan_id
= chan_id
;
850 msg
->u
.ask_channel
.tracefile_size
= tracefile_size
;
851 msg
->u
.ask_channel
.tracefile_count
= tracefile_count
;
852 msg
->u
.ask_channel
.monitor
= monitor
;
853 msg
->u
.ask_channel
.ust_app_uid
= ust_app_uid
;
855 memcpy(msg
->u
.ask_channel
.uuid
, uuid
, sizeof(msg
->u
.ask_channel
.uuid
));
858 strncpy(msg
->u
.ask_channel
.pathname
, pathname
,
859 sizeof(msg
->u
.ask_channel
.pathname
));
860 msg
->u
.ask_channel
.pathname
[sizeof(msg
->u
.ask_channel
.pathname
)-1] = '\0';
863 strncpy(msg
->u
.ask_channel
.name
, name
, sizeof(msg
->u
.ask_channel
.name
));
864 msg
->u
.ask_channel
.name
[sizeof(msg
->u
.ask_channel
.name
) - 1] = '\0';
867 strncpy(msg
->u
.ask_channel
.root_shm_path
, root_shm_path
,
868 sizeof(msg
->u
.ask_channel
.root_shm_path
));
869 msg
->u
.ask_channel
.root_shm_path
[sizeof(msg
->u
.ask_channel
.root_shm_path
) - 1] = '\0';
872 strncpy(msg
->u
.ask_channel
.shm_path
, shm_path
,
873 sizeof(msg
->u
.ask_channel
.shm_path
));
874 msg
->u
.ask_channel
.shm_path
[sizeof(msg
->u
.ask_channel
.shm_path
) - 1] = '\0';
879 * Init channel communication message structure.
881 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
882 enum lttng_consumer_command cmd
,
883 uint64_t channel_key
,
885 const char *pathname
,
890 unsigned int nb_init_streams
,
891 enum lttng_event_output output
,
893 uint64_t tracefile_size
,
894 uint64_t tracefile_count
,
895 unsigned int monitor
,
896 unsigned int live_timer_interval
,
897 unsigned int monitor_timer_interval
)
901 /* Zeroed structure */
902 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
906 msg
->u
.channel
.channel_key
= channel_key
;
907 msg
->u
.channel
.session_id
= session_id
;
908 msg
->u
.channel
.uid
= uid
;
909 msg
->u
.channel
.gid
= gid
;
910 msg
->u
.channel
.relayd_id
= relayd_id
;
911 msg
->u
.channel
.nb_init_streams
= nb_init_streams
;
912 msg
->u
.channel
.output
= output
;
913 msg
->u
.channel
.type
= type
;
914 msg
->u
.channel
.tracefile_size
= tracefile_size
;
915 msg
->u
.channel
.tracefile_count
= tracefile_count
;
916 msg
->u
.channel
.monitor
= monitor
;
917 msg
->u
.channel
.live_timer_interval
= live_timer_interval
;
918 msg
->u
.channel
.monitor_timer_interval
= monitor_timer_interval
;
920 strncpy(msg
->u
.channel
.pathname
, pathname
,
921 sizeof(msg
->u
.channel
.pathname
));
922 msg
->u
.channel
.pathname
[sizeof(msg
->u
.channel
.pathname
) - 1] = '\0';
924 strncpy(msg
->u
.channel
.name
, name
, sizeof(msg
->u
.channel
.name
));
925 msg
->u
.channel
.name
[sizeof(msg
->u
.channel
.name
) - 1] = '\0';
929 * Init stream communication message structure.
931 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
932 enum lttng_consumer_command cmd
,
933 uint64_t channel_key
,
939 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
942 msg
->u
.stream
.channel_key
= channel_key
;
943 msg
->u
.stream
.stream_key
= stream_key
;
944 msg
->u
.stream
.cpu
= cpu
;
947 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg
*msg
,
948 enum lttng_consumer_command cmd
,
949 uint64_t channel_key
, uint64_t net_seq_idx
)
953 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
956 msg
->u
.sent_streams
.channel_key
= channel_key
;
957 msg
->u
.sent_streams
.net_seq_idx
= net_seq_idx
;
961 * Send stream communication structure to the consumer.
963 int consumer_send_stream(struct consumer_socket
*sock
,
964 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
965 int *fds
, size_t nb_fd
)
974 ret
= consumer_send_msg(sock
, msg
);
979 ret
= consumer_send_fds(sock
, fds
, nb_fd
);
989 * Send relayd socket to consumer associated with a session name.
991 * On success return positive value. On error, negative value.
993 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
994 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
995 enum lttng_stream_type type
, uint64_t session_id
,
996 char *session_name
, char *hostname
, int session_live_timer
)
999 struct lttcomm_consumer_msg msg
;
1001 /* Code flow error. Safety net. */
1004 assert(consumer_sock
);
1006 memset(&msg
, 0, sizeof(msg
));
1007 /* Bail out if consumer is disabled */
1008 if (!consumer
->enabled
) {
1013 if (type
== LTTNG_STREAM_CONTROL
) {
1014 ret
= relayd_create_session(rsock
,
1015 &msg
.u
.relayd_sock
.relayd_session_id
,
1016 session_name
, hostname
, session_live_timer
,
1017 consumer
->snapshot
);
1019 /* Close the control socket. */
1020 (void) relayd_close(rsock
);
1025 msg
.cmd_type
= LTTNG_CONSUMER_ADD_RELAYD_SOCKET
;
1027 * Assign network consumer output index using the temporary consumer since
1028 * this call should only be made from within a set_consumer_uri() function
1029 * call in the session daemon.
1031 msg
.u
.relayd_sock
.net_index
= consumer
->net_seq_index
;
1032 msg
.u
.relayd_sock
.type
= type
;
1033 msg
.u
.relayd_sock
.session_id
= session_id
;
1034 memcpy(&msg
.u
.relayd_sock
.sock
, rsock
, sizeof(msg
.u
.relayd_sock
.sock
));
1036 DBG3("Sending relayd sock info to consumer on %d", *consumer_sock
->fd_ptr
);
1037 ret
= consumer_send_msg(consumer_sock
, &msg
);
1042 DBG3("Sending relayd socket file descriptor to consumer");
1043 ret
= consumer_send_fds(consumer_sock
, &rsock
->sock
.fd
, 1);
1048 DBG2("Consumer relayd socket sent");
1054 int consumer_send_channel_monitor_pipe(struct consumer_socket
*consumer_sock
,
1058 struct lttcomm_consumer_msg msg
;
1060 /* Code flow error. Safety net. */
1062 memset(&msg
, 0, sizeof(msg
));
1063 msg
.cmd_type
= LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
;
1065 DBG3("Sending set_channel_monitor_pipe command to consumer");
1066 ret
= consumer_send_msg(consumer_sock
, &msg
);
1071 DBG3("Sending channel monitoring pipe %d to consumer on socket %d",
1072 pipe
, *consumer_sock
->fd_ptr
);
1073 ret
= consumer_send_fds(consumer_sock
, &pipe
, 1);
1078 DBG2("Channel monitoring pipe successfully sent");
1084 * Set consumer subdirectory using the session name and a generated datetime if
1085 * needed. This is appended to the current subdirectory.
1087 int consumer_set_subdir(struct consumer_output
*consumer
,
1088 const char *session_name
)
1091 unsigned int have_default_name
= 0;
1092 char datetime
[16], tmp_path
[PATH_MAX
];
1094 struct tm
*timeinfo
;
1097 assert(session_name
);
1099 memset(tmp_path
, 0, sizeof(tmp_path
));
1101 /* Flag if we have a default session. */
1102 if (strncmp(session_name
, DEFAULT_SESSION_NAME
"-",
1103 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) {
1104 have_default_name
= 1;
1106 /* Get date and time for session path */
1108 timeinfo
= localtime(&rawtime
);
1109 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1112 if (have_default_name
) {
1113 ret
= snprintf(tmp_path
, sizeof(tmp_path
),
1114 "%s/%s", consumer
->subdir
, session_name
);
1116 ret
= snprintf(tmp_path
, sizeof(tmp_path
),
1117 "%s/%s-%s/", consumer
->subdir
, session_name
, datetime
);
1120 PERROR("snprintf session name date");
1124 if (lttng_strncpy(consumer
->subdir
, tmp_path
,
1125 sizeof(consumer
->subdir
))) {
1129 DBG2("Consumer subdir set to %s", consumer
->subdir
);
1136 * Ask the consumer if the data is pending for the specific session id.
1137 * Returns 1 if data is pending, 0 otherwise, or < 0 on error.
1139 int consumer_is_data_pending(uint64_t session_id
,
1140 struct consumer_output
*consumer
)
1143 int32_t ret_code
= 0; /* Default is that the data is NOT pending */
1144 struct consumer_socket
*socket
;
1145 struct lttng_ht_iter iter
;
1146 struct lttcomm_consumer_msg msg
;
1150 DBG3("Consumer data pending for id %" PRIu64
, session_id
);
1152 memset(&msg
, 0, sizeof(msg
));
1153 msg
.cmd_type
= LTTNG_CONSUMER_DATA_PENDING
;
1154 msg
.u
.data_pending
.session_id
= session_id
;
1156 /* Send command for each consumer */
1158 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1160 pthread_mutex_lock(socket
->lock
);
1161 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1163 pthread_mutex_unlock(socket
->lock
);
1168 * No need for a recv reply status because the answer to the command is
1169 * the reply status message.
1172 ret
= consumer_socket_recv(socket
, &ret_code
, sizeof(ret_code
));
1174 pthread_mutex_unlock(socket
->lock
);
1177 pthread_mutex_unlock(socket
->lock
);
1179 if (ret_code
== 1) {
1185 DBG("Consumer data is %s pending for session id %" PRIu64
,
1186 ret_code
== 1 ? "" : "NOT", session_id
);
1195 * Send a flush command to consumer using the given channel key.
1197 * Return 0 on success else a negative value.
1199 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
)
1202 struct lttcomm_consumer_msg msg
;
1206 DBG2("Consumer flush channel key %" PRIu64
, key
);
1208 memset(&msg
, 0, sizeof(msg
));
1209 msg
.cmd_type
= LTTNG_CONSUMER_FLUSH_CHANNEL
;
1210 msg
.u
.flush_channel
.key
= key
;
1212 pthread_mutex_lock(socket
->lock
);
1213 health_code_update();
1215 ret
= consumer_send_msg(socket
, &msg
);
1221 health_code_update();
1222 pthread_mutex_unlock(socket
->lock
);
1227 * Send a clear quiescent command to consumer using the given channel key.
1229 * Return 0 on success else a negative value.
1231 int consumer_clear_quiescent_channel(struct consumer_socket
*socket
, uint64_t key
)
1234 struct lttcomm_consumer_msg msg
;
1238 DBG2("Consumer clear quiescent channel key %" PRIu64
, key
);
1240 memset(&msg
, 0, sizeof(msg
));
1241 msg
.cmd_type
= LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
;
1242 msg
.u
.clear_quiescent_channel
.key
= key
;
1244 pthread_mutex_lock(socket
->lock
);
1245 health_code_update();
1247 ret
= consumer_send_msg(socket
, &msg
);
1253 health_code_update();
1254 pthread_mutex_unlock(socket
->lock
);
1259 * Send a close metadata command to consumer using the given channel key.
1260 * Called with registry lock held.
1262 * Return 0 on success else a negative value.
1264 int consumer_close_metadata(struct consumer_socket
*socket
,
1265 uint64_t metadata_key
)
1268 struct lttcomm_consumer_msg msg
;
1272 DBG2("Consumer close metadata channel key %" PRIu64
, metadata_key
);
1274 memset(&msg
, 0, sizeof(msg
));
1275 msg
.cmd_type
= LTTNG_CONSUMER_CLOSE_METADATA
;
1276 msg
.u
.close_metadata
.key
= metadata_key
;
1278 pthread_mutex_lock(socket
->lock
);
1279 health_code_update();
1281 ret
= consumer_send_msg(socket
, &msg
);
1287 health_code_update();
1288 pthread_mutex_unlock(socket
->lock
);
1293 * Send a setup metdata command to consumer using the given channel key.
1295 * Return 0 on success else a negative value.
1297 int consumer_setup_metadata(struct consumer_socket
*socket
,
1298 uint64_t metadata_key
)
1301 struct lttcomm_consumer_msg msg
;
1305 DBG2("Consumer setup metadata channel key %" PRIu64
, metadata_key
);
1307 memset(&msg
, 0, sizeof(msg
));
1308 msg
.cmd_type
= LTTNG_CONSUMER_SETUP_METADATA
;
1309 msg
.u
.setup_metadata
.key
= metadata_key
;
1311 pthread_mutex_lock(socket
->lock
);
1312 health_code_update();
1314 ret
= consumer_send_msg(socket
, &msg
);
1320 health_code_update();
1321 pthread_mutex_unlock(socket
->lock
);
1326 * Send metadata string to consumer.
1327 * RCU read-side lock must be held to guarantee existence of socket.
1329 * Return 0 on success else a negative value.
1331 int consumer_push_metadata(struct consumer_socket
*socket
,
1332 uint64_t metadata_key
, char *metadata_str
, size_t len
,
1333 size_t target_offset
, uint64_t version
)
1336 struct lttcomm_consumer_msg msg
;
1340 DBG2("Consumer push metadata to consumer socket %d", *socket
->fd_ptr
);
1342 pthread_mutex_lock(socket
->lock
);
1344 memset(&msg
, 0, sizeof(msg
));
1345 msg
.cmd_type
= LTTNG_CONSUMER_PUSH_METADATA
;
1346 msg
.u
.push_metadata
.key
= metadata_key
;
1347 msg
.u
.push_metadata
.target_offset
= target_offset
;
1348 msg
.u
.push_metadata
.len
= len
;
1349 msg
.u
.push_metadata
.version
= version
;
1351 health_code_update();
1352 ret
= consumer_send_msg(socket
, &msg
);
1353 if (ret
< 0 || len
== 0) {
1357 DBG3("Consumer pushing metadata on sock %d of len %zu", *socket
->fd_ptr
,
1360 ret
= consumer_socket_send(socket
, metadata_str
, len
);
1365 health_code_update();
1366 ret
= consumer_recv_status_reply(socket
);
1372 pthread_mutex_unlock(socket
->lock
);
1373 health_code_update();
1378 * Ask the consumer to snapshot a specific channel using the key.
1380 * Return 0 on success or else a negative error.
1382 int consumer_snapshot_channel(struct consumer_socket
*socket
, uint64_t key
,
1383 struct snapshot_output
*output
, int metadata
, uid_t uid
, gid_t gid
,
1384 const char *session_path
, int wait
, uint64_t nb_packets_per_stream
)
1387 struct lttcomm_consumer_msg msg
;
1391 assert(output
->consumer
);
1393 DBG("Consumer snapshot channel key %" PRIu64
, key
);
1395 memset(&msg
, 0, sizeof(msg
));
1396 msg
.cmd_type
= LTTNG_CONSUMER_SNAPSHOT_CHANNEL
;
1397 msg
.u
.snapshot_channel
.key
= key
;
1398 msg
.u
.snapshot_channel
.nb_packets_per_stream
= nb_packets_per_stream
;
1399 msg
.u
.snapshot_channel
.metadata
= metadata
;
1401 if (output
->consumer
->type
== CONSUMER_DST_NET
) {
1402 msg
.u
.snapshot_channel
.relayd_id
= output
->consumer
->net_seq_index
;
1403 msg
.u
.snapshot_channel
.use_relayd
= 1;
1404 ret
= snprintf(msg
.u
.snapshot_channel
.pathname
,
1405 sizeof(msg
.u
.snapshot_channel
.pathname
),
1406 "%s/%s-%s-%" PRIu64
"%s", output
->consumer
->subdir
,
1407 output
->name
, output
->datetime
, output
->nb_snapshot
,
1410 ret
= -LTTNG_ERR_NOMEM
;
1414 ret
= snprintf(msg
.u
.snapshot_channel
.pathname
,
1415 sizeof(msg
.u
.snapshot_channel
.pathname
),
1416 "%s/%s-%s-%" PRIu64
"%s", output
->consumer
->dst
.trace_path
,
1417 output
->name
, output
->datetime
, output
->nb_snapshot
,
1420 ret
= -LTTNG_ERR_NOMEM
;
1423 msg
.u
.snapshot_channel
.relayd_id
= (uint64_t) -1ULL;
1425 /* Create directory. Ignore if exist. */
1426 ret
= run_as_mkdir_recursive(msg
.u
.snapshot_channel
.pathname
,
1427 S_IRWXU
| S_IRWXG
, uid
, gid
);
1429 if (errno
!= EEXIST
) {
1430 ERR("Trace directory creation error");
1436 health_code_update();
1437 ret
= consumer_send_msg(socket
, &msg
);
1443 health_code_update();
1448 * Ask the consumer the number of discarded events for a channel.
1450 int consumer_get_discarded_events(uint64_t session_id
, uint64_t channel_key
,
1451 struct consumer_output
*consumer
, uint64_t *discarded
)
1454 struct consumer_socket
*socket
;
1455 struct lttng_ht_iter iter
;
1456 struct lttcomm_consumer_msg msg
;
1460 DBG3("Consumer discarded events id %" PRIu64
, session_id
);
1462 memset(&msg
, 0, sizeof(msg
));
1463 msg
.cmd_type
= LTTNG_CONSUMER_DISCARDED_EVENTS
;
1464 msg
.u
.discarded_events
.session_id
= session_id
;
1465 msg
.u
.discarded_events
.channel_key
= channel_key
;
1469 /* Send command for each consumer */
1471 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1473 uint64_t consumer_discarded
= 0;
1474 pthread_mutex_lock(socket
->lock
);
1475 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1477 pthread_mutex_unlock(socket
->lock
);
1482 * No need for a recv reply status because the answer to the
1483 * command is the reply status message.
1485 ret
= consumer_socket_recv(socket
, &consumer_discarded
,
1486 sizeof(consumer_discarded
));
1488 ERR("get discarded events");
1489 pthread_mutex_unlock(socket
->lock
);
1492 pthread_mutex_unlock(socket
->lock
);
1493 *discarded
+= consumer_discarded
;
1496 DBG("Consumer discarded %" PRIu64
" events in session id %" PRIu64
,
1497 *discarded
, session_id
);
1505 * Ask the consumer the number of lost packets for a channel.
1507 int consumer_get_lost_packets(uint64_t session_id
, uint64_t channel_key
,
1508 struct consumer_output
*consumer
, uint64_t *lost
)
1511 struct consumer_socket
*socket
;
1512 struct lttng_ht_iter iter
;
1513 struct lttcomm_consumer_msg msg
;
1517 DBG3("Consumer lost packets id %" PRIu64
, session_id
);
1519 memset(&msg
, 0, sizeof(msg
));
1520 msg
.cmd_type
= LTTNG_CONSUMER_LOST_PACKETS
;
1521 msg
.u
.lost_packets
.session_id
= session_id
;
1522 msg
.u
.lost_packets
.channel_key
= channel_key
;
1526 /* Send command for each consumer */
1528 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1530 uint64_t consumer_lost
= 0;
1531 pthread_mutex_lock(socket
->lock
);
1532 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1534 pthread_mutex_unlock(socket
->lock
);
1539 * No need for a recv reply status because the answer to the
1540 * command is the reply status message.
1542 ret
= consumer_socket_recv(socket
, &consumer_lost
,
1543 sizeof(consumer_lost
));
1545 ERR("get lost packets");
1546 pthread_mutex_unlock(socket
->lock
);
1549 pthread_mutex_unlock(socket
->lock
);
1550 *lost
+= consumer_lost
;
1553 DBG("Consumer lost %" PRIu64
" packets in session id %" PRIu64
,