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.
25 #include <sys/types.h>
29 #include <common/common.h>
30 #include <common/defaults.h>
31 #include <common/uri.h>
32 #include <common/relayd/relayd.h>
35 #include "health-sessiond.h"
40 * Send a data payload using a given consumer socket of size len.
42 * The consumer socket lock MUST be acquired before calling this since this
43 * function can change the fd value.
45 * Return 0 on success else a negative value on error.
47 int consumer_socket_send(struct consumer_socket
*socket
, void *msg
, size_t len
)
53 assert(socket
->fd_ptr
);
56 /* Consumer socket is invalid. Stopping. */
62 size
= lttcomm_send_unix_sock(fd
, msg
, len
);
64 /* The above call will print a PERROR on error. */
65 DBG("Error when sending data to consumer on sock %d", fd
);
67 * At this point, the socket is not usable anymore thus closing it and
68 * setting the file descriptor to -1 so it is not reused.
71 /* This call will PERROR on error. */
72 (void) lttcomm_close_unix_sock(fd
);
84 * Receive a data payload using a given consumer socket of size len.
86 * The consumer socket lock MUST be acquired before calling this since this
87 * function can change the fd value.
89 * Return 0 on success else a negative value on error.
91 int consumer_socket_recv(struct consumer_socket
*socket
, void *msg
, size_t len
)
97 assert(socket
->fd_ptr
);
100 /* Consumer socket is invalid. Stopping. */
101 fd
= *socket
->fd_ptr
;
106 size
= lttcomm_recv_unix_sock(fd
, msg
, len
);
108 /* The above call will print a PERROR on error. */
109 DBG("Error when receiving data from the consumer socket %d", fd
);
111 * At this point, the socket is not usable anymore thus closing it and
112 * setting the file descriptor to -1 so it is not reused.
115 /* This call will PERROR on error. */
116 (void) lttcomm_close_unix_sock(fd
);
117 *socket
->fd_ptr
= -1;
128 * Receive a reply command status message from the consumer. Consumer socket
129 * lock MUST be acquired before calling this function.
131 * Return 0 on success, -1 on recv error or a negative lttng error code which
132 * was possibly returned by the consumer.
134 int consumer_recv_status_reply(struct consumer_socket
*sock
)
137 struct lttcomm_consumer_status_msg reply
;
141 ret
= consumer_socket_recv(sock
, &reply
, sizeof(reply
));
146 if (reply
.ret_code
== LTTCOMM_CONSUMERD_SUCCESS
) {
150 ret
= -reply
.ret_code
;
151 DBG("Consumer ret code %d", ret
);
159 * Once the ASK_CHANNEL command is sent to the consumer, the channel
160 * information are sent back. This call receives that data and populates key
163 * On success return 0 and both key and stream_count are set. On error, a
164 * negative value is sent back and both parameters are untouched.
166 int consumer_recv_status_channel(struct consumer_socket
*sock
,
167 uint64_t *key
, unsigned int *stream_count
)
170 struct lttcomm_consumer_status_channel reply
;
173 assert(stream_count
);
176 ret
= consumer_socket_recv(sock
, &reply
, sizeof(reply
));
181 /* An error is possible so don't touch the key and stream_count. */
182 if (reply
.ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
188 *stream_count
= reply
.stream_count
;
196 * Send destroy relayd command to consumer.
198 * On success return positive value. On error, negative value.
200 int consumer_send_destroy_relayd(struct consumer_socket
*sock
,
201 struct consumer_output
*consumer
)
204 struct lttcomm_consumer_msg msg
;
209 DBG2("Sending destroy relayd command to consumer sock %d", *sock
->fd_ptr
);
211 memset(&msg
, 0, sizeof(msg
));
212 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_RELAYD
;
213 msg
.u
.destroy_relayd
.net_seq_idx
= consumer
->net_seq_index
;
215 pthread_mutex_lock(sock
->lock
);
216 ret
= consumer_socket_send(sock
, &msg
, sizeof(msg
));
221 /* Don't check the return value. The caller will do it. */
222 ret
= consumer_recv_status_reply(sock
);
224 DBG2("Consumer send destroy relayd command done");
227 pthread_mutex_unlock(sock
->lock
);
232 * For each consumer socket in the consumer output object, send a destroy
235 void consumer_output_send_destroy_relayd(struct consumer_output
*consumer
)
237 struct lttng_ht_iter iter
;
238 struct consumer_socket
*socket
;
242 /* Destroy any relayd connection */
243 if (consumer
->type
== CONSUMER_DST_NET
) {
245 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
249 /* Send destroy relayd command */
250 ret
= consumer_send_destroy_relayd(socket
, consumer
);
252 DBG("Unable to send destroy relayd command to consumer");
253 /* Continue since we MUST delete everything at this point. */
261 * From a consumer_data structure, allocate and add a consumer socket to the
264 * Return 0 on success, else negative value on error
266 int consumer_create_socket(struct consumer_data
*data
,
267 struct consumer_output
*output
)
270 struct consumer_socket
*socket
;
274 if (output
== NULL
|| data
->cmd_sock
< 0) {
276 * Not an error. Possible there is simply not spawned consumer or it's
277 * disabled for the tracing session asking the socket.
283 socket
= consumer_find_socket(data
->cmd_sock
, output
);
285 if (socket
== NULL
) {
286 socket
= consumer_allocate_socket(&data
->cmd_sock
);
287 if (socket
== NULL
) {
292 socket
->registered
= 0;
293 socket
->lock
= &data
->lock
;
295 consumer_add_socket(socket
, output
);
299 socket
->type
= data
->type
;
301 DBG3("Consumer socket created (fd: %d) and added to output",
309 * Return the consumer socket from the given consumer output with the right
310 * bitness. On error, returns NULL.
312 * The caller MUST acquire a rcu read side lock and keep it until the socket
313 * object reference is not needed anymore.
315 struct consumer_socket
*consumer_find_socket_by_bitness(int bits
,
316 struct consumer_output
*consumer
)
319 struct consumer_socket
*socket
= NULL
;
323 consumer_fd
= uatomic_read(&ust_consumerd64_fd
);
326 consumer_fd
= uatomic_read(&ust_consumerd32_fd
);
333 socket
= consumer_find_socket(consumer_fd
, consumer
);
335 ERR("Consumer socket fd %d not found in consumer obj %p",
336 consumer_fd
, consumer
);
344 * Find a consumer_socket in a consumer_output hashtable. Read side lock must
345 * be acquired before calling this function and across use of the
346 * returned consumer_socket.
348 struct consumer_socket
*consumer_find_socket(int key
,
349 struct consumer_output
*consumer
)
351 struct lttng_ht_iter iter
;
352 struct lttng_ht_node_ulong
*node
;
353 struct consumer_socket
*socket
= NULL
;
355 /* Negative keys are lookup failures */
356 if (key
< 0 || consumer
== NULL
) {
360 lttng_ht_lookup(consumer
->socks
, (void *)((unsigned long) key
),
362 node
= lttng_ht_iter_get_node_ulong(&iter
);
364 socket
= caa_container_of(node
, struct consumer_socket
, node
);
371 * Allocate a new consumer_socket and return the pointer.
373 struct consumer_socket
*consumer_allocate_socket(int *fd
)
375 struct consumer_socket
*socket
= NULL
;
379 socket
= zmalloc(sizeof(struct consumer_socket
));
380 if (socket
== NULL
) {
381 PERROR("zmalloc consumer socket");
386 lttng_ht_node_init_ulong(&socket
->node
, *fd
);
393 * Add consumer socket to consumer output object. Read side lock must be
394 * acquired before calling this function.
396 void consumer_add_socket(struct consumer_socket
*sock
,
397 struct consumer_output
*consumer
)
402 lttng_ht_add_unique_ulong(consumer
->socks
, &sock
->node
);
406 * Delte consumer socket to consumer output object. Read side lock must be
407 * acquired before calling this function.
409 void consumer_del_socket(struct consumer_socket
*sock
,
410 struct consumer_output
*consumer
)
413 struct lttng_ht_iter iter
;
418 iter
.iter
.node
= &sock
->node
.node
;
419 ret
= lttng_ht_del(consumer
->socks
, &iter
);
424 * RCU destroy call function.
426 static void destroy_socket_rcu(struct rcu_head
*head
)
428 struct lttng_ht_node_ulong
*node
=
429 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
430 struct consumer_socket
*socket
=
431 caa_container_of(node
, struct consumer_socket
, node
);
437 * Destroy and free socket pointer in a call RCU. Read side lock must be
438 * acquired before calling this function.
440 void consumer_destroy_socket(struct consumer_socket
*sock
)
445 * We DO NOT close the file descriptor here since it is global to the
446 * session daemon and is closed only if the consumer dies or a custom
447 * consumer was registered,
449 if (sock
->registered
) {
450 DBG3("Consumer socket was registered. Closing fd %d", *sock
->fd_ptr
);
451 lttcomm_close_unix_sock(*sock
->fd_ptr
);
454 call_rcu(&sock
->node
.head
, destroy_socket_rcu
);
458 * Allocate and assign data to a consumer_output object.
460 * Return pointer to structure.
462 struct consumer_output
*consumer_create_output(enum consumer_dst_type type
)
464 struct consumer_output
*output
= NULL
;
466 output
= zmalloc(sizeof(struct consumer_output
));
467 if (output
== NULL
) {
468 PERROR("zmalloc consumer_output");
472 /* By default, consumer output is enabled */
475 output
->net_seq_index
= (uint64_t) -1ULL;
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 void consumer_destroy_output(struct consumer_output
*obj
)
516 consumer_destroy_output_sockets(obj
);
519 /* Finally destroy HT */
520 ht_cleanup_push(obj
->socks
);
527 * Copy consumer output and returned the newly allocated copy.
529 * Should *NOT* be called with RCU read-side lock held.
531 struct consumer_output
*consumer_copy_output(struct consumer_output
*obj
)
534 struct lttng_ht
*tmp_ht_ptr
;
535 struct consumer_output
*output
;
539 output
= consumer_create_output(obj
->type
);
540 if (output
== NULL
) {
543 /* Avoid losing the HT reference after the memcpy() */
544 tmp_ht_ptr
= output
->socks
;
546 memcpy(output
, obj
, sizeof(struct consumer_output
));
548 /* Putting back the HT pointer and start copying socket(s). */
549 output
->socks
= tmp_ht_ptr
;
551 ret
= consumer_copy_sockets(output
, obj
);
560 consumer_destroy_output(output
);
565 * Copy consumer sockets from src to dst.
567 * Return 0 on success or else a negative value.
569 int consumer_copy_sockets(struct consumer_output
*dst
,
570 struct consumer_output
*src
)
573 struct lttng_ht_iter iter
;
574 struct consumer_socket
*socket
, *copy_sock
;
580 cds_lfht_for_each_entry(src
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
581 /* Ignore socket that are already there. */
582 copy_sock
= consumer_find_socket(*socket
->fd_ptr
, dst
);
587 /* Create new socket object. */
588 copy_sock
= consumer_allocate_socket(socket
->fd_ptr
);
589 if (copy_sock
== NULL
) {
595 copy_sock
->registered
= socket
->registered
;
597 * This is valid because this lock is shared accross all consumer
598 * object being the global lock of the consumer data structure of the
601 copy_sock
->lock
= socket
->lock
;
602 consumer_add_socket(copy_sock
, dst
);
611 * Set network URI to the consumer output object.
613 * Return 0 on success. Return 1 if the URI were equal. Else, negative value on
616 int consumer_set_network_uri(struct consumer_output
*obj
,
617 struct lttng_uri
*uri
)
620 char tmp_path
[PATH_MAX
];
621 char hostname
[HOST_NAME_MAX
];
622 struct lttng_uri
*dst_uri
= NULL
;
624 /* Code flow error safety net. */
628 switch (uri
->stype
) {
629 case LTTNG_STREAM_CONTROL
:
630 dst_uri
= &obj
->dst
.net
.control
;
631 obj
->dst
.net
.control_isset
= 1;
632 if (uri
->port
== 0) {
633 /* Assign default port. */
634 uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
636 if (obj
->dst
.net
.data_isset
&& uri
->port
==
637 obj
->dst
.net
.data
.port
) {
638 ret
= -LTTNG_ERR_INVALID
;
642 DBG3("Consumer control URI set with port %d", uri
->port
);
644 case LTTNG_STREAM_DATA
:
645 dst_uri
= &obj
->dst
.net
.data
;
646 obj
->dst
.net
.data_isset
= 1;
647 if (uri
->port
== 0) {
648 /* Assign default port. */
649 uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
651 if (obj
->dst
.net
.control_isset
&& uri
->port
==
652 obj
->dst
.net
.control
.port
) {
653 ret
= -LTTNG_ERR_INVALID
;
657 DBG3("Consumer data URI set with port %d", uri
->port
);
660 ERR("Set network uri type unknown %d", uri
->stype
);
661 ret
= -LTTNG_ERR_INVALID
;
665 ret
= uri_compare(dst_uri
, uri
);
667 /* Same URI, don't touch it and return success. */
668 DBG3("URI network compare are the same");
672 /* URIs were not equal, replacing it. */
673 memset(dst_uri
, 0, sizeof(struct lttng_uri
));
674 memcpy(dst_uri
, uri
, sizeof(struct lttng_uri
));
675 obj
->type
= CONSUMER_DST_NET
;
677 /* Handle subdir and add hostname in front. */
678 if (dst_uri
->stype
== LTTNG_STREAM_CONTROL
) {
679 /* Get hostname to append it in the pathname */
680 ret
= gethostname(hostname
, sizeof(hostname
));
682 PERROR("gethostname. Fallback on default localhost");
683 strncpy(hostname
, "localhost", sizeof(hostname
));
685 hostname
[sizeof(hostname
) - 1] = '\0';
687 /* Setup consumer subdir if none present in the control URI */
688 if (strlen(dst_uri
->subdir
) == 0) {
689 ret
= snprintf(tmp_path
, sizeof(tmp_path
), "%s/%s",
690 hostname
, obj
->subdir
);
692 ret
= snprintf(tmp_path
, sizeof(tmp_path
), "%s/%s",
693 hostname
, dst_uri
->subdir
);
696 PERROR("snprintf set consumer uri subdir");
697 ret
= -LTTNG_ERR_NOMEM
;
701 strncpy(obj
->subdir
, tmp_path
, sizeof(obj
->subdir
));
702 DBG3("Consumer set network uri subdir path %s", tmp_path
);
713 * Send file descriptor to consumer via sock.
715 int consumer_send_fds(struct consumer_socket
*sock
, int *fds
, size_t nb_fd
)
723 ret
= lttcomm_send_fds_unix_sock(*sock
->fd_ptr
, fds
, nb_fd
);
725 /* The above call will print a PERROR on error. */
726 DBG("Error when sending consumer fds on sock %d", *sock
->fd_ptr
);
730 ret
= consumer_recv_status_reply(sock
);
737 * Consumer send communication message structure to consumer.
739 int consumer_send_msg(struct consumer_socket
*sock
,
740 struct lttcomm_consumer_msg
*msg
)
747 ret
= consumer_socket_send(sock
, msg
, sizeof(struct lttcomm_consumer_msg
));
752 ret
= consumer_recv_status_reply(sock
);
759 * Consumer send channel communication message structure to consumer.
761 int consumer_send_channel(struct consumer_socket
*sock
,
762 struct lttcomm_consumer_msg
*msg
)
769 ret
= consumer_send_msg(sock
, msg
);
779 * Populate the given consumer msg structure with the ask_channel command
782 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
783 uint64_t subbuf_size
,
786 unsigned int switch_timer_interval
,
787 unsigned int read_timer_interval
,
788 unsigned int live_timer_interval
,
792 const char *pathname
,
800 uint64_t tracefile_size
,
801 uint64_t tracefile_count
,
802 uint64_t session_id_per_pid
,
803 unsigned int monitor
,
804 uint32_t ust_app_uid
,
805 const char *root_shm_path
,
806 const char *shm_path
)
810 /* Zeroed structure */
811 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
813 msg
->cmd_type
= LTTNG_CONSUMER_ASK_CHANNEL_CREATION
;
814 msg
->u
.ask_channel
.subbuf_size
= subbuf_size
;
815 msg
->u
.ask_channel
.num_subbuf
= num_subbuf
;
816 msg
->u
.ask_channel
.overwrite
= overwrite
;
817 msg
->u
.ask_channel
.switch_timer_interval
= switch_timer_interval
;
818 msg
->u
.ask_channel
.read_timer_interval
= read_timer_interval
;
819 msg
->u
.ask_channel
.live_timer_interval
= live_timer_interval
;
820 msg
->u
.ask_channel
.output
= output
;
821 msg
->u
.ask_channel
.type
= type
;
822 msg
->u
.ask_channel
.session_id
= session_id
;
823 msg
->u
.ask_channel
.session_id_per_pid
= session_id_per_pid
;
824 msg
->u
.ask_channel
.uid
= uid
;
825 msg
->u
.ask_channel
.gid
= gid
;
826 msg
->u
.ask_channel
.relayd_id
= relayd_id
;
827 msg
->u
.ask_channel
.key
= key
;
828 msg
->u
.ask_channel
.chan_id
= chan_id
;
829 msg
->u
.ask_channel
.tracefile_size
= tracefile_size
;
830 msg
->u
.ask_channel
.tracefile_count
= tracefile_count
;
831 msg
->u
.ask_channel
.monitor
= monitor
;
832 msg
->u
.ask_channel
.ust_app_uid
= ust_app_uid
;
834 memcpy(msg
->u
.ask_channel
.uuid
, uuid
, sizeof(msg
->u
.ask_channel
.uuid
));
837 strncpy(msg
->u
.ask_channel
.pathname
, pathname
,
838 sizeof(msg
->u
.ask_channel
.pathname
));
839 msg
->u
.ask_channel
.pathname
[sizeof(msg
->u
.ask_channel
.pathname
)-1] = '\0';
842 strncpy(msg
->u
.ask_channel
.name
, name
, sizeof(msg
->u
.ask_channel
.name
));
843 msg
->u
.ask_channel
.name
[sizeof(msg
->u
.ask_channel
.name
) - 1] = '\0';
846 strncpy(msg
->u
.ask_channel
.root_shm_path
, root_shm_path
,
847 sizeof(msg
->u
.ask_channel
.root_shm_path
));
848 msg
->u
.ask_channel
.root_shm_path
[sizeof(msg
->u
.ask_channel
.root_shm_path
) - 1] = '\0';
851 strncpy(msg
->u
.ask_channel
.shm_path
, shm_path
,
852 sizeof(msg
->u
.ask_channel
.shm_path
));
853 msg
->u
.ask_channel
.shm_path
[sizeof(msg
->u
.ask_channel
.shm_path
) - 1] = '\0';
858 * Init channel communication message structure.
860 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
861 enum lttng_consumer_command cmd
,
862 uint64_t channel_key
,
864 const char *pathname
,
869 unsigned int nb_init_streams
,
870 enum lttng_event_output output
,
872 uint64_t tracefile_size
,
873 uint64_t tracefile_count
,
874 unsigned int monitor
,
875 unsigned int live_timer_interval
)
879 /* Zeroed structure */
880 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
884 msg
->u
.channel
.channel_key
= channel_key
;
885 msg
->u
.channel
.session_id
= session_id
;
886 msg
->u
.channel
.uid
= uid
;
887 msg
->u
.channel
.gid
= gid
;
888 msg
->u
.channel
.relayd_id
= relayd_id
;
889 msg
->u
.channel
.nb_init_streams
= nb_init_streams
;
890 msg
->u
.channel
.output
= output
;
891 msg
->u
.channel
.type
= type
;
892 msg
->u
.channel
.tracefile_size
= tracefile_size
;
893 msg
->u
.channel
.tracefile_count
= tracefile_count
;
894 msg
->u
.channel
.monitor
= monitor
;
895 msg
->u
.channel
.live_timer_interval
= live_timer_interval
;
897 strncpy(msg
->u
.channel
.pathname
, pathname
,
898 sizeof(msg
->u
.channel
.pathname
));
899 msg
->u
.channel
.pathname
[sizeof(msg
->u
.channel
.pathname
) - 1] = '\0';
901 strncpy(msg
->u
.channel
.name
, name
, sizeof(msg
->u
.channel
.name
));
902 msg
->u
.channel
.name
[sizeof(msg
->u
.channel
.name
) - 1] = '\0';
906 * Init stream communication message structure.
908 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
909 enum lttng_consumer_command cmd
,
910 uint64_t channel_key
,
916 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
919 msg
->u
.stream
.channel_key
= channel_key
;
920 msg
->u
.stream
.stream_key
= stream_key
;
921 msg
->u
.stream
.cpu
= cpu
;
924 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg
*msg
,
925 enum lttng_consumer_command cmd
,
926 uint64_t channel_key
, uint64_t net_seq_idx
)
930 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
933 msg
->u
.sent_streams
.channel_key
= channel_key
;
934 msg
->u
.sent_streams
.net_seq_idx
= net_seq_idx
;
938 * Send stream communication structure to the consumer.
940 int consumer_send_stream(struct consumer_socket
*sock
,
941 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
942 int *fds
, size_t nb_fd
)
951 ret
= consumer_send_msg(sock
, msg
);
956 ret
= consumer_send_fds(sock
, fds
, nb_fd
);
966 * Send relayd socket to consumer associated with a session name.
968 * On success return positive value. On error, negative value.
970 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
971 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
972 enum lttng_stream_type type
, uint64_t session_id
,
973 char *session_name
, char *hostname
, int session_live_timer
)
976 struct lttcomm_consumer_msg msg
;
978 /* Code flow error. Safety net. */
981 assert(consumer_sock
);
983 memset(&msg
, 0, sizeof(msg
));
984 /* Bail out if consumer is disabled */
985 if (!consumer
->enabled
) {
990 if (type
== LTTNG_STREAM_CONTROL
) {
991 ret
= relayd_create_session(rsock
,
992 &msg
.u
.relayd_sock
.relayd_session_id
,
993 session_name
, hostname
, session_live_timer
,
996 /* Close the control socket. */
997 (void) relayd_close(rsock
);
1002 msg
.cmd_type
= LTTNG_CONSUMER_ADD_RELAYD_SOCKET
;
1004 * Assign network consumer output index using the temporary consumer since
1005 * this call should only be made from within a set_consumer_uri() function
1006 * call in the session daemon.
1008 msg
.u
.relayd_sock
.net_index
= consumer
->net_seq_index
;
1009 msg
.u
.relayd_sock
.type
= type
;
1010 msg
.u
.relayd_sock
.session_id
= session_id
;
1011 memcpy(&msg
.u
.relayd_sock
.sock
, rsock
, sizeof(msg
.u
.relayd_sock
.sock
));
1013 DBG3("Sending relayd sock info to consumer on %d", *consumer_sock
->fd_ptr
);
1014 ret
= consumer_send_msg(consumer_sock
, &msg
);
1019 DBG3("Sending relayd socket file descriptor to consumer");
1020 ret
= consumer_send_fds(consumer_sock
, &rsock
->sock
.fd
, 1);
1025 DBG2("Consumer relayd socket sent");
1032 * Set consumer subdirectory using the session name and a generated datetime if
1033 * needed. This is appended to the current subdirectory.
1035 int consumer_set_subdir(struct consumer_output
*consumer
,
1036 const char *session_name
)
1039 unsigned int have_default_name
= 0;
1040 char datetime
[16], tmp_path
[PATH_MAX
];
1042 struct tm
*timeinfo
;
1045 assert(session_name
);
1047 memset(tmp_path
, 0, sizeof(tmp_path
));
1049 /* Flag if we have a default session. */
1050 if (strncmp(session_name
, DEFAULT_SESSION_NAME
"-",
1051 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) {
1052 have_default_name
= 1;
1054 /* Get date and time for session path */
1056 timeinfo
= localtime(&rawtime
);
1057 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1060 if (have_default_name
) {
1061 ret
= snprintf(tmp_path
, sizeof(tmp_path
),
1062 "%s/%s", consumer
->subdir
, session_name
);
1064 ret
= snprintf(tmp_path
, sizeof(tmp_path
),
1065 "%s/%s-%s/", consumer
->subdir
, session_name
, datetime
);
1068 PERROR("snprintf session name date");
1072 strncpy(consumer
->subdir
, tmp_path
, sizeof(consumer
->subdir
));
1073 DBG2("Consumer subdir set to %s", consumer
->subdir
);
1080 * Ask the consumer if the data is ready to read (NOT pending) for the specific
1083 * This function has a different behavior with the consumer i.e. that it waits
1084 * for a reply from the consumer if yes or no the data is pending.
1086 int consumer_is_data_pending(uint64_t session_id
,
1087 struct consumer_output
*consumer
)
1090 int32_t ret_code
= 0; /* Default is that the data is NOT pending */
1091 struct consumer_socket
*socket
;
1092 struct lttng_ht_iter iter
;
1093 struct lttcomm_consumer_msg msg
;
1097 DBG3("Consumer data pending for id %" PRIu64
, session_id
);
1099 memset(&msg
, 0, sizeof(msg
));
1100 msg
.cmd_type
= LTTNG_CONSUMER_DATA_PENDING
;
1101 msg
.u
.data_pending
.session_id
= session_id
;
1103 /* Send command for each consumer */
1105 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1107 pthread_mutex_lock(socket
->lock
);
1108 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1110 pthread_mutex_unlock(socket
->lock
);
1115 * No need for a recv reply status because the answer to the command is
1116 * the reply status message.
1119 ret
= consumer_socket_recv(socket
, &ret_code
, sizeof(ret_code
));
1121 pthread_mutex_unlock(socket
->lock
);
1124 pthread_mutex_unlock(socket
->lock
);
1126 if (ret_code
== 1) {
1132 DBG("Consumer data is %s pending for session id %" PRIu64
,
1133 ret_code
== 1 ? "" : "NOT", session_id
);
1142 * Send a flush command to consumer using the given channel key.
1144 * Return 0 on success else a negative value.
1146 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
)
1149 struct lttcomm_consumer_msg msg
;
1153 DBG2("Consumer flush channel key %" PRIu64
, key
);
1155 memset(&msg
, 0, sizeof(msg
));
1156 msg
.cmd_type
= LTTNG_CONSUMER_FLUSH_CHANNEL
;
1157 msg
.u
.flush_channel
.key
= key
;
1159 pthread_mutex_lock(socket
->lock
);
1160 health_code_update();
1162 ret
= consumer_send_msg(socket
, &msg
);
1168 health_code_update();
1169 pthread_mutex_unlock(socket
->lock
);
1174 * Send a close metadata command to consumer using the given channel key.
1175 * Called with registry lock held.
1177 * Return 0 on success else a negative value.
1179 int consumer_close_metadata(struct consumer_socket
*socket
,
1180 uint64_t metadata_key
)
1183 struct lttcomm_consumer_msg msg
;
1187 DBG2("Consumer close metadata channel key %" PRIu64
, metadata_key
);
1189 memset(&msg
, 0, sizeof(msg
));
1190 msg
.cmd_type
= LTTNG_CONSUMER_CLOSE_METADATA
;
1191 msg
.u
.close_metadata
.key
= metadata_key
;
1193 pthread_mutex_lock(socket
->lock
);
1194 health_code_update();
1196 ret
= consumer_send_msg(socket
, &msg
);
1202 health_code_update();
1203 pthread_mutex_unlock(socket
->lock
);
1208 * Send a setup metdata command to consumer using the given channel key.
1210 * Return 0 on success else a negative value.
1212 int consumer_setup_metadata(struct consumer_socket
*socket
,
1213 uint64_t metadata_key
)
1216 struct lttcomm_consumer_msg msg
;
1220 DBG2("Consumer setup metadata channel key %" PRIu64
, metadata_key
);
1222 memset(&msg
, 0, sizeof(msg
));
1223 msg
.cmd_type
= LTTNG_CONSUMER_SETUP_METADATA
;
1224 msg
.u
.setup_metadata
.key
= metadata_key
;
1226 pthread_mutex_lock(socket
->lock
);
1227 health_code_update();
1229 ret
= consumer_send_msg(socket
, &msg
);
1235 health_code_update();
1236 pthread_mutex_unlock(socket
->lock
);
1241 * Send metadata string to consumer.
1242 * RCU read-side lock must be held to guarantee existence of socket.
1244 * Return 0 on success else a negative value.
1246 int consumer_push_metadata(struct consumer_socket
*socket
,
1247 uint64_t metadata_key
, char *metadata_str
, size_t len
,
1248 size_t target_offset
)
1251 struct lttcomm_consumer_msg msg
;
1255 DBG2("Consumer push metadata to consumer socket %d", *socket
->fd_ptr
);
1257 pthread_mutex_lock(socket
->lock
);
1259 memset(&msg
, 0, sizeof(msg
));
1260 msg
.cmd_type
= LTTNG_CONSUMER_PUSH_METADATA
;
1261 msg
.u
.push_metadata
.key
= metadata_key
;
1262 msg
.u
.push_metadata
.target_offset
= target_offset
;
1263 msg
.u
.push_metadata
.len
= len
;
1265 health_code_update();
1266 ret
= consumer_send_msg(socket
, &msg
);
1267 if (ret
< 0 || len
== 0) {
1271 DBG3("Consumer pushing metadata on sock %d of len %zu", *socket
->fd_ptr
,
1274 ret
= consumer_socket_send(socket
, metadata_str
, len
);
1279 health_code_update();
1280 ret
= consumer_recv_status_reply(socket
);
1286 pthread_mutex_unlock(socket
->lock
);
1287 health_code_update();
1292 * Ask the consumer to snapshot a specific channel using the key.
1294 * Return 0 on success or else a negative error.
1296 int consumer_snapshot_channel(struct consumer_socket
*socket
, uint64_t key
,
1297 struct snapshot_output
*output
, int metadata
, uid_t uid
, gid_t gid
,
1298 const char *session_path
, int wait
, uint64_t nb_packets_per_stream
)
1301 struct lttcomm_consumer_msg msg
;
1305 assert(output
->consumer
);
1307 DBG("Consumer snapshot channel key %" PRIu64
, key
);
1309 memset(&msg
, 0, sizeof(msg
));
1310 msg
.cmd_type
= LTTNG_CONSUMER_SNAPSHOT_CHANNEL
;
1311 msg
.u
.snapshot_channel
.key
= key
;
1312 msg
.u
.snapshot_channel
.nb_packets_per_stream
= nb_packets_per_stream
;
1313 msg
.u
.snapshot_channel
.metadata
= metadata
;
1315 if (output
->consumer
->type
== CONSUMER_DST_NET
) {
1316 msg
.u
.snapshot_channel
.relayd_id
= output
->consumer
->net_seq_index
;
1317 msg
.u
.snapshot_channel
.use_relayd
= 1;
1318 ret
= snprintf(msg
.u
.snapshot_channel
.pathname
,
1319 sizeof(msg
.u
.snapshot_channel
.pathname
),
1320 "%s/%s-%s-%" PRIu64
"%s", output
->consumer
->subdir
,
1321 output
->name
, output
->datetime
, output
->nb_snapshot
,
1324 ret
= -LTTNG_ERR_NOMEM
;
1328 ret
= snprintf(msg
.u
.snapshot_channel
.pathname
,
1329 sizeof(msg
.u
.snapshot_channel
.pathname
),
1330 "%s/%s-%s-%" PRIu64
"%s", output
->consumer
->dst
.trace_path
,
1331 output
->name
, output
->datetime
, output
->nb_snapshot
,
1334 ret
= -LTTNG_ERR_NOMEM
;
1337 msg
.u
.snapshot_channel
.relayd_id
= (uint64_t) -1ULL;
1339 /* Create directory. Ignore if exist. */
1340 ret
= run_as_mkdir_recursive(msg
.u
.snapshot_channel
.pathname
,
1341 S_IRWXU
| S_IRWXG
, uid
, gid
);
1343 if (ret
!= -EEXIST
) {
1344 ERR("Trace directory creation error");
1350 health_code_update();
1351 ret
= consumer_send_msg(socket
, &msg
);
1357 health_code_update();