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
;
157 * Once the ASK_CHANNEL command is sent to the consumer, the channel
158 * information are sent back. This call receives that data and populates key
161 * On success return 0 and both key and stream_count are set. On error, a
162 * negative value is sent back and both parameters are untouched.
164 int consumer_recv_status_channel(struct consumer_socket
*sock
,
165 uint64_t *key
, unsigned int *stream_count
)
168 struct lttcomm_consumer_status_channel reply
;
171 assert(stream_count
);
174 ret
= consumer_socket_recv(sock
, &reply
, sizeof(reply
));
179 /* An error is possible so don't touch the key and stream_count. */
180 if (reply
.ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
186 *stream_count
= reply
.stream_count
;
194 * Send destroy relayd command to consumer.
196 * On success return positive value. On error, negative value.
198 int consumer_send_destroy_relayd(struct consumer_socket
*sock
,
199 struct consumer_output
*consumer
)
202 struct lttcomm_consumer_msg msg
;
207 DBG2("Sending destroy relayd command to consumer sock %d", *sock
->fd_ptr
);
209 memset(&msg
, 0, sizeof(msg
));
210 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_RELAYD
;
211 msg
.u
.destroy_relayd
.net_seq_idx
= consumer
->net_seq_index
;
213 pthread_mutex_lock(sock
->lock
);
214 ret
= consumer_socket_send(sock
, &msg
, sizeof(msg
));
219 /* Don't check the return value. The caller will do it. */
220 ret
= consumer_recv_status_reply(sock
);
222 DBG2("Consumer send destroy relayd command done");
225 pthread_mutex_unlock(sock
->lock
);
230 * For each consumer socket in the consumer output object, send a destroy
233 void consumer_output_send_destroy_relayd(struct consumer_output
*consumer
)
235 struct lttng_ht_iter iter
;
236 struct consumer_socket
*socket
;
240 /* Destroy any relayd connection */
241 if (consumer
->type
== CONSUMER_DST_NET
) {
243 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
247 /* Send destroy relayd command */
248 ret
= consumer_send_destroy_relayd(socket
, consumer
);
250 DBG("Unable to send destroy relayd command to consumer");
251 /* Continue since we MUST delete everything at this point. */
259 * From a consumer_data structure, allocate and add a consumer socket to the
262 * Return 0 on success, else negative value on error
264 int consumer_create_socket(struct consumer_data
*data
,
265 struct consumer_output
*output
)
268 struct consumer_socket
*socket
;
272 if (output
== NULL
|| data
->cmd_sock
< 0) {
274 * Not an error. Possible there is simply not spawned consumer or it's
275 * disabled for the tracing session asking the socket.
281 socket
= consumer_find_socket(data
->cmd_sock
, output
);
283 if (socket
== NULL
) {
284 socket
= consumer_allocate_socket(&data
->cmd_sock
);
285 if (socket
== NULL
) {
290 socket
->registered
= 0;
291 socket
->lock
= &data
->lock
;
293 consumer_add_socket(socket
, output
);
297 socket
->type
= data
->type
;
299 DBG3("Consumer socket created (fd: %d) and added to output",
307 * Return the consumer socket from the given consumer output with the right
308 * bitness. On error, returns NULL.
310 * The caller MUST acquire a rcu read side lock and keep it until the socket
311 * object reference is not needed anymore.
313 struct consumer_socket
*consumer_find_socket_by_bitness(int bits
,
314 struct consumer_output
*consumer
)
317 struct consumer_socket
*socket
= NULL
;
321 consumer_fd
= uatomic_read(&ust_consumerd64_fd
);
324 consumer_fd
= uatomic_read(&ust_consumerd32_fd
);
331 socket
= consumer_find_socket(consumer_fd
, consumer
);
333 ERR("Consumer socket fd %d not found in consumer obj %p",
334 consumer_fd
, consumer
);
342 * Find a consumer_socket in a consumer_output hashtable. Read side lock must
343 * be acquired before calling this function and across use of the
344 * returned consumer_socket.
346 struct consumer_socket
*consumer_find_socket(int key
,
347 struct consumer_output
*consumer
)
349 struct lttng_ht_iter iter
;
350 struct lttng_ht_node_ulong
*node
;
351 struct consumer_socket
*socket
= NULL
;
353 /* Negative keys are lookup failures */
354 if (key
< 0 || consumer
== NULL
) {
358 lttng_ht_lookup(consumer
->socks
, (void *)((unsigned long) key
),
360 node
= lttng_ht_iter_get_node_ulong(&iter
);
362 socket
= caa_container_of(node
, struct consumer_socket
, node
);
369 * Allocate a new consumer_socket and return the pointer.
371 struct consumer_socket
*consumer_allocate_socket(int *fd
)
373 struct consumer_socket
*socket
= NULL
;
377 socket
= zmalloc(sizeof(struct consumer_socket
));
378 if (socket
== NULL
) {
379 PERROR("zmalloc consumer socket");
384 lttng_ht_node_init_ulong(&socket
->node
, *fd
);
391 * Add consumer socket to consumer output object. Read side lock must be
392 * acquired before calling this function.
394 void consumer_add_socket(struct consumer_socket
*sock
,
395 struct consumer_output
*consumer
)
400 lttng_ht_add_unique_ulong(consumer
->socks
, &sock
->node
);
404 * Delte consumer socket to consumer output object. Read side lock must be
405 * acquired before calling this function.
407 void consumer_del_socket(struct consumer_socket
*sock
,
408 struct consumer_output
*consumer
)
411 struct lttng_ht_iter iter
;
416 iter
.iter
.node
= &sock
->node
.node
;
417 ret
= lttng_ht_del(consumer
->socks
, &iter
);
422 * RCU destroy call function.
424 static void destroy_socket_rcu(struct rcu_head
*head
)
426 struct lttng_ht_node_ulong
*node
=
427 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
428 struct consumer_socket
*socket
=
429 caa_container_of(node
, struct consumer_socket
, node
);
435 * Destroy and free socket pointer in a call RCU. Read side lock must be
436 * acquired before calling this function.
438 void consumer_destroy_socket(struct consumer_socket
*sock
)
443 * We DO NOT close the file descriptor here since it is global to the
444 * session daemon and is closed only if the consumer dies or a custom
445 * consumer was registered,
447 if (sock
->registered
) {
448 DBG3("Consumer socket was registered. Closing fd %d", *sock
->fd_ptr
);
449 lttcomm_close_unix_sock(*sock
->fd_ptr
);
452 call_rcu(&sock
->node
.head
, destroy_socket_rcu
);
456 * Allocate and assign data to a consumer_output object.
458 * Return pointer to structure.
460 struct consumer_output
*consumer_create_output(enum consumer_dst_type type
)
462 struct consumer_output
*output
= NULL
;
464 output
= zmalloc(sizeof(struct consumer_output
));
465 if (output
== NULL
) {
466 PERROR("zmalloc consumer_output");
470 /* By default, consumer output is enabled */
473 output
->net_seq_index
= (uint64_t) -1ULL;
474 urcu_ref_init(&output
->ref
);
476 output
->socks
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
483 * Iterate over the consumer output socket hash table and destroy them. The
484 * socket file descriptor are only closed if the consumer output was
485 * registered meaning it's an external consumer.
487 void consumer_destroy_output_sockets(struct consumer_output
*obj
)
489 struct lttng_ht_iter iter
;
490 struct consumer_socket
*socket
;
497 cds_lfht_for_each_entry(obj
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
498 consumer_del_socket(socket
, obj
);
499 consumer_destroy_socket(socket
);
505 * Delete the consumer_output object from the list and free the ptr.
507 * Should *NOT* be called with RCU read-side lock held.
509 static void consumer_release_output(struct urcu_ref
*ref
)
511 struct consumer_output
*obj
=
512 caa_container_of(ref
, struct consumer_output
, ref
);
514 consumer_destroy_output_sockets(obj
);
517 /* Finally destroy HT */
518 ht_cleanup_push(obj
->socks
);
525 * Get the consumer_output object.
527 void consumer_output_get(struct consumer_output
*obj
)
529 urcu_ref_get(&obj
->ref
);
533 * Put the consumer_output object.
535 * Should *NOT* be called with RCU read-side lock held.
537 void consumer_output_put(struct consumer_output
*obj
)
542 urcu_ref_put(&obj
->ref
, consumer_release_output
);
546 * Copy consumer output and returned the newly allocated copy.
548 * Should *NOT* be called with RCU read-side lock held.
550 struct consumer_output
*consumer_copy_output(struct consumer_output
*obj
)
553 struct consumer_output
*output
;
557 output
= consumer_create_output(obj
->type
);
558 if (output
== NULL
) {
561 output
->enabled
= obj
->enabled
;
562 output
->net_seq_index
= obj
->net_seq_index
;
563 memcpy(output
->subdir
, obj
->subdir
, PATH_MAX
);
564 output
->snapshot
= obj
->snapshot
;
565 output
->relay_major_version
= obj
->relay_major_version
;
566 output
->relay_minor_version
= obj
->relay_minor_version
;
567 memcpy(&output
->dst
, &obj
->dst
, sizeof(output
->dst
));
568 ret
= consumer_copy_sockets(output
, obj
);
576 consumer_output_put(output
);
581 * Copy consumer sockets from src to dst.
583 * Return 0 on success or else a negative value.
585 int consumer_copy_sockets(struct consumer_output
*dst
,
586 struct consumer_output
*src
)
589 struct lttng_ht_iter iter
;
590 struct consumer_socket
*socket
, *copy_sock
;
596 cds_lfht_for_each_entry(src
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
597 /* Ignore socket that are already there. */
598 copy_sock
= consumer_find_socket(*socket
->fd_ptr
, dst
);
603 /* Create new socket object. */
604 copy_sock
= consumer_allocate_socket(socket
->fd_ptr
);
605 if (copy_sock
== NULL
) {
611 copy_sock
->registered
= socket
->registered
;
613 * This is valid because this lock is shared accross all consumer
614 * object being the global lock of the consumer data structure of the
617 copy_sock
->lock
= socket
->lock
;
618 consumer_add_socket(copy_sock
, dst
);
627 * Set network URI to the consumer output object.
629 * Return 0 on success. Return 1 if the URI were equal. Else, negative value on
632 int consumer_set_network_uri(struct consumer_output
*obj
,
633 struct lttng_uri
*uri
)
636 char tmp_path
[PATH_MAX
];
637 char hostname
[HOST_NAME_MAX
];
638 struct lttng_uri
*dst_uri
= NULL
;
640 /* Code flow error safety net. */
644 switch (uri
->stype
) {
645 case LTTNG_STREAM_CONTROL
:
646 dst_uri
= &obj
->dst
.net
.control
;
647 obj
->dst
.net
.control_isset
= 1;
648 if (uri
->port
== 0) {
649 /* Assign default port. */
650 uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
652 if (obj
->dst
.net
.data_isset
&& uri
->port
==
653 obj
->dst
.net
.data
.port
) {
654 ret
= -LTTNG_ERR_INVALID
;
658 DBG3("Consumer control URI set with port %d", uri
->port
);
660 case LTTNG_STREAM_DATA
:
661 dst_uri
= &obj
->dst
.net
.data
;
662 obj
->dst
.net
.data_isset
= 1;
663 if (uri
->port
== 0) {
664 /* Assign default port. */
665 uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
667 if (obj
->dst
.net
.control_isset
&& uri
->port
==
668 obj
->dst
.net
.control
.port
) {
669 ret
= -LTTNG_ERR_INVALID
;
673 DBG3("Consumer data URI set with port %d", uri
->port
);
676 ERR("Set network uri type unknown %d", uri
->stype
);
677 ret
= -LTTNG_ERR_INVALID
;
681 ret
= uri_compare(dst_uri
, uri
);
683 /* Same URI, don't touch it and return success. */
684 DBG3("URI network compare are the same");
688 /* URIs were not equal, replacing it. */
689 memset(dst_uri
, 0, sizeof(struct lttng_uri
));
690 memcpy(dst_uri
, uri
, sizeof(struct lttng_uri
));
691 obj
->type
= CONSUMER_DST_NET
;
693 /* Handle subdir and add hostname in front. */
694 if (dst_uri
->stype
== LTTNG_STREAM_CONTROL
) {
695 /* Get hostname to append it in the pathname */
696 ret
= gethostname(hostname
, sizeof(hostname
));
698 PERROR("gethostname. Fallback on default localhost");
699 strncpy(hostname
, "localhost", sizeof(hostname
));
701 hostname
[sizeof(hostname
) - 1] = '\0';
703 /* Setup consumer subdir if none present in the control URI */
704 if (strlen(dst_uri
->subdir
) == 0) {
705 ret
= snprintf(tmp_path
, sizeof(tmp_path
), "%s/%s",
706 hostname
, obj
->subdir
);
708 ret
= snprintf(tmp_path
, sizeof(tmp_path
), "%s/%s",
709 hostname
, dst_uri
->subdir
);
712 PERROR("snprintf set consumer uri subdir");
713 ret
= -LTTNG_ERR_NOMEM
;
717 if (lttng_strncpy(obj
->subdir
, tmp_path
, sizeof(obj
->subdir
))) {
718 ret
= -LTTNG_ERR_INVALID
;
721 DBG3("Consumer set network uri subdir path %s", tmp_path
);
732 * Send file descriptor to consumer via sock.
734 * The consumer socket lock must be held by the caller.
736 int consumer_send_fds(struct consumer_socket
*sock
, int *fds
, size_t nb_fd
)
743 assert(pthread_mutex_trylock(sock
->lock
) == EBUSY
);
745 ret
= lttcomm_send_fds_unix_sock(*sock
->fd_ptr
, fds
, nb_fd
);
747 /* The above call will print a PERROR on error. */
748 DBG("Error when sending consumer fds on sock %d", *sock
->fd_ptr
);
752 ret
= consumer_recv_status_reply(sock
);
758 * Consumer send communication message structure to consumer.
760 * The consumer socket lock must be held by the caller.
762 int consumer_send_msg(struct consumer_socket
*sock
,
763 struct lttcomm_consumer_msg
*msg
)
769 assert(pthread_mutex_trylock(sock
->lock
) == EBUSY
);
771 ret
= consumer_socket_send(sock
, msg
, sizeof(struct lttcomm_consumer_msg
));
776 ret
= consumer_recv_status_reply(sock
);
783 * Consumer send channel communication message structure to consumer.
785 * The consumer socket lock must be held by the caller.
787 int consumer_send_channel(struct consumer_socket
*sock
,
788 struct lttcomm_consumer_msg
*msg
)
795 ret
= consumer_send_msg(sock
, msg
);
805 * Populate the given consumer msg structure with the ask_channel command
808 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
809 uint64_t subbuf_size
,
812 unsigned int switch_timer_interval
,
813 unsigned int read_timer_interval
,
814 unsigned int live_timer_interval
,
815 unsigned int monitor_timer_interval
,
819 const char *pathname
,
827 uint64_t tracefile_size
,
828 uint64_t tracefile_count
,
829 uint64_t session_id_per_pid
,
830 unsigned int monitor
,
831 uint32_t ust_app_uid
,
832 int64_t blocking_timeout
,
833 const char *root_shm_path
,
834 const char *shm_path
)
838 /* Zeroed structure */
839 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
841 msg
->cmd_type
= LTTNG_CONSUMER_ASK_CHANNEL_CREATION
;
842 msg
->u
.ask_channel
.subbuf_size
= subbuf_size
;
843 msg
->u
.ask_channel
.num_subbuf
= num_subbuf
;
844 msg
->u
.ask_channel
.overwrite
= overwrite
;
845 msg
->u
.ask_channel
.switch_timer_interval
= switch_timer_interval
;
846 msg
->u
.ask_channel
.read_timer_interval
= read_timer_interval
;
847 msg
->u
.ask_channel
.live_timer_interval
= live_timer_interval
;
848 msg
->u
.ask_channel
.monitor_timer_interval
= monitor_timer_interval
;
849 msg
->u
.ask_channel
.output
= output
;
850 msg
->u
.ask_channel
.type
= type
;
851 msg
->u
.ask_channel
.session_id
= session_id
;
852 msg
->u
.ask_channel
.session_id_per_pid
= session_id_per_pid
;
853 msg
->u
.ask_channel
.uid
= uid
;
854 msg
->u
.ask_channel
.gid
= gid
;
855 msg
->u
.ask_channel
.relayd_id
= relayd_id
;
856 msg
->u
.ask_channel
.key
= key
;
857 msg
->u
.ask_channel
.chan_id
= chan_id
;
858 msg
->u
.ask_channel
.tracefile_size
= tracefile_size
;
859 msg
->u
.ask_channel
.tracefile_count
= tracefile_count
;
860 msg
->u
.ask_channel
.monitor
= monitor
;
861 msg
->u
.ask_channel
.ust_app_uid
= ust_app_uid
;
862 msg
->u
.ask_channel
.blocking_timeout
= blocking_timeout
;
864 memcpy(msg
->u
.ask_channel
.uuid
, uuid
, sizeof(msg
->u
.ask_channel
.uuid
));
867 strncpy(msg
->u
.ask_channel
.pathname
, pathname
,
868 sizeof(msg
->u
.ask_channel
.pathname
));
869 msg
->u
.ask_channel
.pathname
[sizeof(msg
->u
.ask_channel
.pathname
)-1] = '\0';
872 strncpy(msg
->u
.ask_channel
.name
, name
, sizeof(msg
->u
.ask_channel
.name
));
873 msg
->u
.ask_channel
.name
[sizeof(msg
->u
.ask_channel
.name
) - 1] = '\0';
876 strncpy(msg
->u
.ask_channel
.root_shm_path
, root_shm_path
,
877 sizeof(msg
->u
.ask_channel
.root_shm_path
));
878 msg
->u
.ask_channel
.root_shm_path
[sizeof(msg
->u
.ask_channel
.root_shm_path
) - 1] = '\0';
881 strncpy(msg
->u
.ask_channel
.shm_path
, shm_path
,
882 sizeof(msg
->u
.ask_channel
.shm_path
));
883 msg
->u
.ask_channel
.shm_path
[sizeof(msg
->u
.ask_channel
.shm_path
) - 1] = '\0';
888 * Init channel communication message structure.
890 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
891 enum lttng_consumer_command cmd
,
892 uint64_t channel_key
,
894 const char *pathname
,
899 unsigned int nb_init_streams
,
900 enum lttng_event_output output
,
902 uint64_t tracefile_size
,
903 uint64_t tracefile_count
,
904 unsigned int monitor
,
905 unsigned int live_timer_interval
,
906 unsigned int monitor_timer_interval
)
910 /* Zeroed structure */
911 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
915 msg
->u
.channel
.channel_key
= channel_key
;
916 msg
->u
.channel
.session_id
= session_id
;
917 msg
->u
.channel
.uid
= uid
;
918 msg
->u
.channel
.gid
= gid
;
919 msg
->u
.channel
.relayd_id
= relayd_id
;
920 msg
->u
.channel
.nb_init_streams
= nb_init_streams
;
921 msg
->u
.channel
.output
= output
;
922 msg
->u
.channel
.type
= type
;
923 msg
->u
.channel
.tracefile_size
= tracefile_size
;
924 msg
->u
.channel
.tracefile_count
= tracefile_count
;
925 msg
->u
.channel
.monitor
= monitor
;
926 msg
->u
.channel
.live_timer_interval
= live_timer_interval
;
927 msg
->u
.channel
.monitor_timer_interval
= monitor_timer_interval
;
929 strncpy(msg
->u
.channel
.pathname
, pathname
,
930 sizeof(msg
->u
.channel
.pathname
));
931 msg
->u
.channel
.pathname
[sizeof(msg
->u
.channel
.pathname
) - 1] = '\0';
933 strncpy(msg
->u
.channel
.name
, name
, sizeof(msg
->u
.channel
.name
));
934 msg
->u
.channel
.name
[sizeof(msg
->u
.channel
.name
) - 1] = '\0';
938 * Init stream communication message structure.
940 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
941 enum lttng_consumer_command cmd
,
942 uint64_t channel_key
,
948 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
951 msg
->u
.stream
.channel_key
= channel_key
;
952 msg
->u
.stream
.stream_key
= stream_key
;
953 msg
->u
.stream
.cpu
= cpu
;
956 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg
*msg
,
957 enum lttng_consumer_command cmd
,
958 uint64_t channel_key
, uint64_t net_seq_idx
)
962 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
965 msg
->u
.sent_streams
.channel_key
= channel_key
;
966 msg
->u
.sent_streams
.net_seq_idx
= net_seq_idx
;
970 * Send stream communication structure to the consumer.
972 int consumer_send_stream(struct consumer_socket
*sock
,
973 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
974 int *fds
, size_t nb_fd
)
983 ret
= consumer_send_msg(sock
, msg
);
988 ret
= consumer_send_fds(sock
, fds
, nb_fd
);
998 * Send relayd socket to consumer associated with a session name.
1000 * The consumer socket lock must be held by the caller.
1002 * On success return positive value. On error, negative value.
1004 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
1005 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
1006 enum lttng_stream_type type
, uint64_t session_id
,
1007 char *session_name
, char *hostname
, int session_live_timer
)
1010 struct lttcomm_consumer_msg msg
;
1012 /* Code flow error. Safety net. */
1015 assert(consumer_sock
);
1017 memset(&msg
, 0, sizeof(msg
));
1018 /* Bail out if consumer is disabled */
1019 if (!consumer
->enabled
) {
1024 if (type
== LTTNG_STREAM_CONTROL
) {
1025 ret
= relayd_create_session(rsock
,
1026 &msg
.u
.relayd_sock
.relayd_session_id
,
1027 session_name
, hostname
, session_live_timer
,
1028 consumer
->snapshot
);
1030 /* Close the control socket. */
1031 (void) relayd_close(rsock
);
1036 msg
.cmd_type
= LTTNG_CONSUMER_ADD_RELAYD_SOCKET
;
1038 * Assign network consumer output index using the temporary consumer since
1039 * this call should only be made from within a set_consumer_uri() function
1040 * call in the session daemon.
1042 msg
.u
.relayd_sock
.net_index
= consumer
->net_seq_index
;
1043 msg
.u
.relayd_sock
.type
= type
;
1044 msg
.u
.relayd_sock
.session_id
= session_id
;
1045 memcpy(&msg
.u
.relayd_sock
.sock
, rsock
, sizeof(msg
.u
.relayd_sock
.sock
));
1047 DBG3("Sending relayd sock info to consumer on %d", *consumer_sock
->fd_ptr
);
1048 ret
= consumer_send_msg(consumer_sock
, &msg
);
1053 DBG3("Sending relayd socket file descriptor to consumer");
1054 ret
= consumer_send_fds(consumer_sock
, &rsock
->sock
.fd
, 1);
1059 DBG2("Consumer relayd socket sent");
1065 int consumer_send_channel_monitor_pipe(struct consumer_socket
*consumer_sock
,
1069 struct lttcomm_consumer_msg msg
;
1071 /* Code flow error. Safety net. */
1073 memset(&msg
, 0, sizeof(msg
));
1074 msg
.cmd_type
= LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
;
1076 pthread_mutex_lock(consumer_sock
->lock
);
1077 DBG3("Sending set_channel_monitor_pipe command to consumer");
1078 ret
= consumer_send_msg(consumer_sock
, &msg
);
1083 DBG3("Sending channel monitoring pipe %d to consumer on socket %d",
1084 pipe
, *consumer_sock
->fd_ptr
);
1085 ret
= consumer_send_fds(consumer_sock
, &pipe
, 1);
1090 DBG2("Channel monitoring pipe successfully sent");
1092 pthread_mutex_unlock(consumer_sock
->lock
);
1097 * Set consumer subdirectory using the session name and a generated datetime if
1098 * needed. This is appended to the current subdirectory.
1100 int consumer_set_subdir(struct consumer_output
*consumer
,
1101 const char *session_name
)
1104 unsigned int have_default_name
= 0;
1105 char datetime
[16], tmp_path
[PATH_MAX
];
1107 struct tm
*timeinfo
;
1110 assert(session_name
);
1112 memset(tmp_path
, 0, sizeof(tmp_path
));
1114 /* Flag if we have a default session. */
1115 if (strncmp(session_name
, DEFAULT_SESSION_NAME
"-",
1116 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) {
1117 have_default_name
= 1;
1119 /* Get date and time for session path */
1121 timeinfo
= localtime(&rawtime
);
1122 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1125 if (have_default_name
) {
1126 ret
= snprintf(tmp_path
, sizeof(tmp_path
),
1127 "%s/%s", consumer
->subdir
, session_name
);
1129 ret
= snprintf(tmp_path
, sizeof(tmp_path
),
1130 "%s/%s-%s/", consumer
->subdir
, session_name
, datetime
);
1133 PERROR("snprintf session name date");
1137 if (lttng_strncpy(consumer
->subdir
, tmp_path
,
1138 sizeof(consumer
->subdir
))) {
1142 DBG2("Consumer subdir set to %s", consumer
->subdir
);
1149 * Ask the consumer if the data is pending for the specific session id.
1150 * Returns 1 if data is pending, 0 otherwise, or < 0 on error.
1152 int consumer_is_data_pending(uint64_t session_id
,
1153 struct consumer_output
*consumer
)
1156 int32_t ret_code
= 0; /* Default is that the data is NOT pending */
1157 struct consumer_socket
*socket
;
1158 struct lttng_ht_iter iter
;
1159 struct lttcomm_consumer_msg msg
;
1163 DBG3("Consumer data pending for id %" PRIu64
, session_id
);
1165 memset(&msg
, 0, sizeof(msg
));
1166 msg
.cmd_type
= LTTNG_CONSUMER_DATA_PENDING
;
1167 msg
.u
.data_pending
.session_id
= session_id
;
1169 /* Send command for each consumer */
1171 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1173 pthread_mutex_lock(socket
->lock
);
1174 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1176 pthread_mutex_unlock(socket
->lock
);
1181 * No need for a recv reply status because the answer to the command is
1182 * the reply status message.
1185 ret
= consumer_socket_recv(socket
, &ret_code
, sizeof(ret_code
));
1187 pthread_mutex_unlock(socket
->lock
);
1190 pthread_mutex_unlock(socket
->lock
);
1192 if (ret_code
== 1) {
1198 DBG("Consumer data is %s pending for session id %" PRIu64
,
1199 ret_code
== 1 ? "" : "NOT", session_id
);
1208 * Send a flush command to consumer using the given channel key.
1210 * Return 0 on success else a negative value.
1212 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
)
1215 struct lttcomm_consumer_msg msg
;
1219 DBG2("Consumer flush channel key %" PRIu64
, key
);
1221 memset(&msg
, 0, sizeof(msg
));
1222 msg
.cmd_type
= LTTNG_CONSUMER_FLUSH_CHANNEL
;
1223 msg
.u
.flush_channel
.key
= key
;
1225 pthread_mutex_lock(socket
->lock
);
1226 health_code_update();
1228 ret
= consumer_send_msg(socket
, &msg
);
1234 health_code_update();
1235 pthread_mutex_unlock(socket
->lock
);
1240 * Send a clear quiescent command to consumer using the given channel key.
1242 * Return 0 on success else a negative value.
1244 int consumer_clear_quiescent_channel(struct consumer_socket
*socket
, uint64_t key
)
1247 struct lttcomm_consumer_msg msg
;
1251 DBG2("Consumer clear quiescent channel key %" PRIu64
, key
);
1253 memset(&msg
, 0, sizeof(msg
));
1254 msg
.cmd_type
= LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
;
1255 msg
.u
.clear_quiescent_channel
.key
= key
;
1257 pthread_mutex_lock(socket
->lock
);
1258 health_code_update();
1260 ret
= consumer_send_msg(socket
, &msg
);
1266 health_code_update();
1267 pthread_mutex_unlock(socket
->lock
);
1272 * Send a close metadata command to consumer using the given channel key.
1273 * Called with registry lock held.
1275 * Return 0 on success else a negative value.
1277 int consumer_close_metadata(struct consumer_socket
*socket
,
1278 uint64_t metadata_key
)
1281 struct lttcomm_consumer_msg msg
;
1285 DBG2("Consumer close metadata channel key %" PRIu64
, metadata_key
);
1287 memset(&msg
, 0, sizeof(msg
));
1288 msg
.cmd_type
= LTTNG_CONSUMER_CLOSE_METADATA
;
1289 msg
.u
.close_metadata
.key
= metadata_key
;
1291 pthread_mutex_lock(socket
->lock
);
1292 health_code_update();
1294 ret
= consumer_send_msg(socket
, &msg
);
1300 health_code_update();
1301 pthread_mutex_unlock(socket
->lock
);
1306 * Send a setup metdata command to consumer using the given channel key.
1308 * Return 0 on success else a negative value.
1310 int consumer_setup_metadata(struct consumer_socket
*socket
,
1311 uint64_t metadata_key
)
1314 struct lttcomm_consumer_msg msg
;
1318 DBG2("Consumer setup metadata channel key %" PRIu64
, metadata_key
);
1320 memset(&msg
, 0, sizeof(msg
));
1321 msg
.cmd_type
= LTTNG_CONSUMER_SETUP_METADATA
;
1322 msg
.u
.setup_metadata
.key
= metadata_key
;
1324 pthread_mutex_lock(socket
->lock
);
1325 health_code_update();
1327 ret
= consumer_send_msg(socket
, &msg
);
1333 health_code_update();
1334 pthread_mutex_unlock(socket
->lock
);
1339 * Send metadata string to consumer.
1340 * RCU read-side lock must be held to guarantee existence of socket.
1342 * Return 0 on success else a negative value.
1344 int consumer_push_metadata(struct consumer_socket
*socket
,
1345 uint64_t metadata_key
, char *metadata_str
, size_t len
,
1346 size_t target_offset
, uint64_t version
)
1349 struct lttcomm_consumer_msg msg
;
1353 DBG2("Consumer push metadata to consumer socket %d", *socket
->fd_ptr
);
1355 pthread_mutex_lock(socket
->lock
);
1357 memset(&msg
, 0, sizeof(msg
));
1358 msg
.cmd_type
= LTTNG_CONSUMER_PUSH_METADATA
;
1359 msg
.u
.push_metadata
.key
= metadata_key
;
1360 msg
.u
.push_metadata
.target_offset
= target_offset
;
1361 msg
.u
.push_metadata
.len
= len
;
1362 msg
.u
.push_metadata
.version
= version
;
1364 health_code_update();
1365 ret
= consumer_send_msg(socket
, &msg
);
1366 if (ret
< 0 || len
== 0) {
1370 DBG3("Consumer pushing metadata on sock %d of len %zu", *socket
->fd_ptr
,
1373 ret
= consumer_socket_send(socket
, metadata_str
, len
);
1378 health_code_update();
1379 ret
= consumer_recv_status_reply(socket
);
1385 pthread_mutex_unlock(socket
->lock
);
1386 health_code_update();
1391 * Ask the consumer to snapshot a specific channel using the key.
1393 * Return 0 on success or else a negative error.
1395 int consumer_snapshot_channel(struct consumer_socket
*socket
, uint64_t key
,
1396 struct snapshot_output
*output
, int metadata
, uid_t uid
, gid_t gid
,
1397 const char *session_path
, int wait
, uint64_t nb_packets_per_stream
)
1400 struct lttcomm_consumer_msg msg
;
1404 assert(output
->consumer
);
1406 DBG("Consumer snapshot channel key %" PRIu64
, key
);
1408 memset(&msg
, 0, sizeof(msg
));
1409 msg
.cmd_type
= LTTNG_CONSUMER_SNAPSHOT_CHANNEL
;
1410 msg
.u
.snapshot_channel
.key
= key
;
1411 msg
.u
.snapshot_channel
.nb_packets_per_stream
= nb_packets_per_stream
;
1412 msg
.u
.snapshot_channel
.metadata
= metadata
;
1414 if (output
->consumer
->type
== CONSUMER_DST_NET
) {
1415 msg
.u
.snapshot_channel
.relayd_id
= output
->consumer
->net_seq_index
;
1416 msg
.u
.snapshot_channel
.use_relayd
= 1;
1417 ret
= snprintf(msg
.u
.snapshot_channel
.pathname
,
1418 sizeof(msg
.u
.snapshot_channel
.pathname
),
1419 "%s/%s-%s-%" PRIu64
"%s", output
->consumer
->subdir
,
1420 output
->name
, output
->datetime
, output
->nb_snapshot
,
1423 ret
= -LTTNG_ERR_NOMEM
;
1427 ret
= snprintf(msg
.u
.snapshot_channel
.pathname
,
1428 sizeof(msg
.u
.snapshot_channel
.pathname
),
1429 "%s/%s-%s-%" PRIu64
"%s", output
->consumer
->dst
.trace_path
,
1430 output
->name
, output
->datetime
, output
->nb_snapshot
,
1433 ret
= -LTTNG_ERR_NOMEM
;
1436 msg
.u
.snapshot_channel
.relayd_id
= (uint64_t) -1ULL;
1438 /* Create directory. Ignore if exist. */
1439 ret
= run_as_mkdir_recursive(msg
.u
.snapshot_channel
.pathname
,
1440 S_IRWXU
| S_IRWXG
, uid
, gid
);
1442 if (errno
!= EEXIST
) {
1443 ERR("Trace directory creation error");
1449 health_code_update();
1450 pthread_mutex_lock(socket
->lock
);
1451 ret
= consumer_send_msg(socket
, &msg
);
1452 pthread_mutex_unlock(socket
->lock
);
1458 health_code_update();
1463 * Ask the consumer the number of discarded events for a channel.
1465 int consumer_get_discarded_events(uint64_t session_id
, uint64_t channel_key
,
1466 struct consumer_output
*consumer
, uint64_t *discarded
)
1469 struct consumer_socket
*socket
;
1470 struct lttng_ht_iter iter
;
1471 struct lttcomm_consumer_msg msg
;
1475 DBG3("Consumer discarded events id %" PRIu64
, session_id
);
1477 memset(&msg
, 0, sizeof(msg
));
1478 msg
.cmd_type
= LTTNG_CONSUMER_DISCARDED_EVENTS
;
1479 msg
.u
.discarded_events
.session_id
= session_id
;
1480 msg
.u
.discarded_events
.channel_key
= channel_key
;
1484 /* Send command for each consumer */
1486 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1488 uint64_t consumer_discarded
= 0;
1489 pthread_mutex_lock(socket
->lock
);
1490 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1492 pthread_mutex_unlock(socket
->lock
);
1497 * No need for a recv reply status because the answer to the
1498 * command is the reply status message.
1500 ret
= consumer_socket_recv(socket
, &consumer_discarded
,
1501 sizeof(consumer_discarded
));
1503 ERR("get discarded events");
1504 pthread_mutex_unlock(socket
->lock
);
1507 pthread_mutex_unlock(socket
->lock
);
1508 *discarded
+= consumer_discarded
;
1511 DBG("Consumer discarded %" PRIu64
" events in session id %" PRIu64
,
1512 *discarded
, session_id
);
1520 * Ask the consumer the number of lost packets for a channel.
1522 int consumer_get_lost_packets(uint64_t session_id
, uint64_t channel_key
,
1523 struct consumer_output
*consumer
, uint64_t *lost
)
1526 struct consumer_socket
*socket
;
1527 struct lttng_ht_iter iter
;
1528 struct lttcomm_consumer_msg msg
;
1532 DBG3("Consumer lost packets id %" PRIu64
, session_id
);
1534 memset(&msg
, 0, sizeof(msg
));
1535 msg
.cmd_type
= LTTNG_CONSUMER_LOST_PACKETS
;
1536 msg
.u
.lost_packets
.session_id
= session_id
;
1537 msg
.u
.lost_packets
.channel_key
= channel_key
;
1541 /* Send command for each consumer */
1543 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1545 uint64_t consumer_lost
= 0;
1546 pthread_mutex_lock(socket
->lock
);
1547 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1549 pthread_mutex_unlock(socket
->lock
);
1554 * No need for a recv reply status because the answer to the
1555 * command is the reply status message.
1557 ret
= consumer_socket_recv(socket
, &consumer_lost
,
1558 sizeof(consumer_lost
));
1560 ERR("get lost packets");
1561 pthread_mutex_unlock(socket
->lock
);
1564 pthread_mutex_unlock(socket
->lock
);
1565 *lost
+= consumer_lost
;
1568 DBG("Consumer lost %" PRIu64
" packets in session id %" PRIu64
,
1576 int consumer_clear_channel(struct consumer_socket
*socket
, uint64_t key
,
1577 struct consumer_output
*output
)
1580 struct lttcomm_consumer_msg msg
;
1584 DBG("Consumer clear channel %" PRIu64
, key
);
1586 memset(&msg
, 0, sizeof(msg
));
1587 msg
.cmd_type
= LTTNG_CONSUMER_CLEAR_CHANNEL
;
1588 msg
.u
.clear_channel
.key
= key
;
1590 health_code_update();
1592 pthread_mutex_lock(socket
->lock
);
1593 ret
= consumer_send_msg(socket
, &msg
);
1599 pthread_mutex_unlock(socket
->lock
);
1601 health_code_update();
1606 int consumer_msg_clear_session(struct consumer_socket
*socket
, uint64_t session_id
,
1607 struct consumer_output
*output
)
1610 struct lttcomm_consumer_msg msg
;
1614 DBG("Consumer clear session %" PRIu64
, session_id
);
1616 memset(&msg
, 0, sizeof(msg
));
1617 msg
.cmd_type
= LTTNG_CONSUMER_CLEAR_SESSION
;
1618 msg
.u
.clear_session
.session_id
= session_id
;
1620 health_code_update();
1622 pthread_mutex_lock(socket
->lock
);
1623 ret
= consumer_send_msg(socket
, &msg
);
1629 pthread_mutex_unlock(socket
->lock
);
1631 health_code_update();
1635 int consumer_clear_session(struct ltt_session
*session
)
1637 struct ltt_ust_session
*usess
= session
->ust_session
;
1638 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
1643 struct consumer_socket
*socket
;
1644 struct lttng_ht_iter iter
;
1646 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1647 socket
, node
.node
) {
1648 ret
= consumer_msg_clear_session(socket
, session
->id
,
1656 struct consumer_socket
*socket
;
1657 struct lttng_ht_iter iter
;
1659 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1660 socket
, node
.node
) {
1661 ret
= consumer_msg_clear_session(socket
, session
->id
,