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/utils.h>
39 * Receive a reply command status message from the consumer. Consumer socket
40 * lock MUST be acquired before calling this function.
42 * Return 0 on success, -1 on recv error or a negative lttng error code which
43 * was possibly returned by the consumer.
45 int consumer_recv_status_reply(struct consumer_socket
*sock
)
48 struct lttcomm_consumer_status_msg reply
;
52 ret
= lttcomm_recv_unix_sock(sock
->fd
, &reply
, sizeof(reply
));
55 /* Orderly shutdown. Don't return 0 which means success. */
58 /* The above call will print a PERROR on error. */
59 DBG("Fail to receive status reply on sock %d", sock
->fd
);
63 if (reply
.ret_code
== LTTNG_OK
) {
67 ret
= -reply
.ret_code
;
68 DBG("Consumer ret code %d", ret
);
76 * Once the ASK_CHANNEL command is sent to the consumer, the channel
77 * information are sent back. This call receives that data and populates key
80 * On success return 0 and both key and stream_count are set. On error, a
81 * negative value is sent back and both parameters are untouched.
83 int consumer_recv_status_channel(struct consumer_socket
*sock
,
84 uint64_t *key
, unsigned int *stream_count
)
87 struct lttcomm_consumer_status_channel reply
;
93 ret
= lttcomm_recv_unix_sock(sock
->fd
, &reply
, sizeof(reply
));
96 /* Orderly shutdown. Don't return 0 which means success. */
99 /* The above call will print a PERROR on error. */
100 DBG("Fail to receive status reply on sock %d", sock
->fd
);
104 /* An error is possible so don't touch the key and stream_count. */
105 if (reply
.ret_code
!= LTTNG_OK
) {
111 *stream_count
= reply
.stream_count
;
118 * Send destroy relayd command to consumer.
120 * On success return positive value. On error, negative value.
122 int consumer_send_destroy_relayd(struct consumer_socket
*sock
,
123 struct consumer_output
*consumer
)
126 struct lttcomm_consumer_msg msg
;
131 DBG2("Sending destroy relayd command to consumer sock %d", sock
->fd
);
133 /* Bail out if consumer is disabled */
134 if (!consumer
->enabled
) {
136 DBG3("Consumer is disabled");
140 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_RELAYD
;
141 msg
.u
.destroy_relayd
.net_seq_idx
= consumer
->net_seq_index
;
143 pthread_mutex_lock(sock
->lock
);
144 ret
= lttcomm_send_unix_sock(sock
->fd
, &msg
, sizeof(msg
));
146 /* Indicate that the consumer is probably closing at this point. */
147 DBG("send consumer destroy relayd command");
151 /* Don't check the return value. The caller will do it. */
152 ret
= consumer_recv_status_reply(sock
);
154 DBG2("Consumer send destroy relayd command done");
157 pthread_mutex_unlock(sock
->lock
);
163 * For each consumer socket in the consumer output object, send a destroy
166 void consumer_output_send_destroy_relayd(struct consumer_output
*consumer
)
168 struct lttng_ht_iter iter
;
169 struct consumer_socket
*socket
;
173 /* Destroy any relayd connection */
174 if (consumer
->type
== CONSUMER_DST_NET
) {
176 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
180 /* Send destroy relayd command */
181 ret
= consumer_send_destroy_relayd(socket
, consumer
);
183 DBG("Unable to send destroy relayd command to consumer");
184 /* Continue since we MUST delete everything at this point. */
192 * From a consumer_data structure, allocate and add a consumer socket to the
195 * Return 0 on success, else negative value on error
197 int consumer_create_socket(struct consumer_data
*data
,
198 struct consumer_output
*output
)
201 struct consumer_socket
*socket
;
205 if (output
== NULL
|| data
->cmd_sock
< 0) {
207 * Not an error. Possible there is simply not spawned consumer or it's
208 * disabled for the tracing session asking the socket.
214 socket
= consumer_find_socket(data
->cmd_sock
, output
);
216 if (socket
== NULL
) {
217 socket
= consumer_allocate_socket(data
->cmd_sock
);
218 if (socket
== NULL
) {
223 socket
->registered
= 0;
224 socket
->lock
= &data
->lock
;
226 consumer_add_socket(socket
, output
);
230 socket
->type
= data
->type
;
232 DBG3("Consumer socket created (fd: %d) and added to output",
240 * Return the consumer socket from the given consumer output with the right
241 * bitness. On error, returns NULL.
243 * The caller MUST acquire a rcu read side lock and keep it until the socket
244 * object reference is not needed anymore.
246 struct consumer_socket
*consumer_find_socket_by_bitness(int bits
,
247 struct consumer_output
*consumer
)
250 struct consumer_socket
*socket
= NULL
;
254 consumer_fd
= uatomic_read(&ust_consumerd64_fd
);
257 consumer_fd
= uatomic_read(&ust_consumerd32_fd
);
264 socket
= consumer_find_socket(consumer_fd
, consumer
);
266 ERR("Consumer socket fd %d not found in consumer obj %p",
267 consumer_fd
, consumer
);
275 * Find a consumer_socket in a consumer_output hashtable. Read side lock must
276 * be acquired before calling this function and across use of the
277 * returned consumer_socket.
279 struct consumer_socket
*consumer_find_socket(int key
,
280 struct consumer_output
*consumer
)
282 struct lttng_ht_iter iter
;
283 struct lttng_ht_node_ulong
*node
;
284 struct consumer_socket
*socket
= NULL
;
286 /* Negative keys are lookup failures */
287 if (key
< 0 || consumer
== NULL
) {
291 lttng_ht_lookup(consumer
->socks
, (void *)((unsigned long) key
),
293 node
= lttng_ht_iter_get_node_ulong(&iter
);
295 socket
= caa_container_of(node
, struct consumer_socket
, node
);
302 * Allocate a new consumer_socket and return the pointer.
304 struct consumer_socket
*consumer_allocate_socket(int fd
)
306 struct consumer_socket
*socket
= NULL
;
308 socket
= zmalloc(sizeof(struct consumer_socket
));
309 if (socket
== NULL
) {
310 PERROR("zmalloc consumer socket");
315 lttng_ht_node_init_ulong(&socket
->node
, fd
);
322 * Add consumer socket to consumer output object. Read side lock must be
323 * acquired before calling this function.
325 void consumer_add_socket(struct consumer_socket
*sock
,
326 struct consumer_output
*consumer
)
331 lttng_ht_add_unique_ulong(consumer
->socks
, &sock
->node
);
335 * Delte consumer socket to consumer output object. Read side lock must be
336 * acquired before calling this function.
338 void consumer_del_socket(struct consumer_socket
*sock
,
339 struct consumer_output
*consumer
)
342 struct lttng_ht_iter iter
;
347 iter
.iter
.node
= &sock
->node
.node
;
348 ret
= lttng_ht_del(consumer
->socks
, &iter
);
353 * RCU destroy call function.
355 static void destroy_socket_rcu(struct rcu_head
*head
)
357 struct lttng_ht_node_ulong
*node
=
358 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
359 struct consumer_socket
*socket
=
360 caa_container_of(node
, struct consumer_socket
, node
);
366 * Destroy and free socket pointer in a call RCU. Read side lock must be
367 * acquired before calling this function.
369 void consumer_destroy_socket(struct consumer_socket
*sock
)
374 * We DO NOT close the file descriptor here since it is global to the
375 * session daemon and is closed only if the consumer dies or a custom
376 * consumer was registered,
378 if (sock
->registered
) {
379 DBG3("Consumer socket was registered. Closing fd %d", sock
->fd
);
380 lttcomm_close_unix_sock(sock
->fd
);
383 call_rcu(&sock
->node
.head
, destroy_socket_rcu
);
387 * Allocate and assign data to a consumer_output object.
389 * Return pointer to structure.
391 struct consumer_output
*consumer_create_output(enum consumer_dst_type type
)
393 struct consumer_output
*output
= NULL
;
395 output
= zmalloc(sizeof(struct consumer_output
));
396 if (output
== NULL
) {
397 PERROR("zmalloc consumer_output");
401 /* By default, consumer output is enabled */
404 output
->net_seq_index
= (uint64_t) -1ULL;
406 output
->socks
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
413 * Delete the consumer_output object from the list and free the ptr.
415 * Should *NOT* be called with RCU read-side lock held.
417 void consumer_destroy_output(struct consumer_output
*obj
)
424 struct lttng_ht_iter iter
;
425 struct consumer_socket
*socket
;
428 cds_lfht_for_each_entry(obj
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
429 consumer_del_socket(socket
, obj
);
430 consumer_destroy_socket(socket
);
434 /* Finally destroy HT */
435 ht_cleanup_push(obj
->socks
);
442 * Copy consumer output and returned the newly allocated copy.
444 * Should *NOT* be called with RCU read-side lock held.
446 struct consumer_output
*consumer_copy_output(struct consumer_output
*obj
)
449 struct lttng_ht
*tmp_ht_ptr
;
450 struct consumer_output
*output
;
454 output
= consumer_create_output(obj
->type
);
455 if (output
== NULL
) {
458 /* Avoid losing the HT reference after the memcpy() */
459 tmp_ht_ptr
= output
->socks
;
461 memcpy(output
, obj
, sizeof(struct consumer_output
));
463 /* Putting back the HT pointer and start copying socket(s). */
464 output
->socks
= tmp_ht_ptr
;
466 ret
= consumer_copy_sockets(output
, obj
);
475 consumer_destroy_output(output
);
480 * Copy consumer sockets from src to dst.
482 * Return 0 on success or else a negative value.
484 int consumer_copy_sockets(struct consumer_output
*dst
,
485 struct consumer_output
*src
)
488 struct lttng_ht_iter iter
;
489 struct consumer_socket
*socket
, *copy_sock
;
495 cds_lfht_for_each_entry(src
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
496 /* Ignore socket that are already there. */
497 copy_sock
= consumer_find_socket(socket
->fd
, dst
);
502 /* Create new socket object. */
503 copy_sock
= consumer_allocate_socket(socket
->fd
);
504 if (copy_sock
== NULL
) {
510 copy_sock
->registered
= socket
->registered
;
512 * This is valid because this lock is shared accross all consumer
513 * object being the global lock of the consumer data structure of the
516 copy_sock
->lock
= socket
->lock
;
517 consumer_add_socket(copy_sock
, dst
);
526 * Set network URI to the consumer output object.
528 * Return 0 on success. Return 1 if the URI were equal. Else, negative value on
531 int consumer_set_network_uri(struct consumer_output
*obj
,
532 struct lttng_uri
*uri
)
535 char tmp_path
[PATH_MAX
];
536 char hostname
[HOST_NAME_MAX
];
537 struct lttng_uri
*dst_uri
= NULL
;
539 /* Code flow error safety net. */
543 switch (uri
->stype
) {
544 case LTTNG_STREAM_CONTROL
:
545 dst_uri
= &obj
->dst
.net
.control
;
546 obj
->dst
.net
.control_isset
= 1;
547 if (uri
->port
== 0) {
548 /* Assign default port. */
549 uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
551 if (obj
->dst
.net
.data_isset
&& uri
->port
==
552 obj
->dst
.net
.data
.port
) {
553 ret
= -LTTNG_ERR_INVALID
;
557 DBG3("Consumer control URI set with port %d", uri
->port
);
559 case LTTNG_STREAM_DATA
:
560 dst_uri
= &obj
->dst
.net
.data
;
561 obj
->dst
.net
.data_isset
= 1;
562 if (uri
->port
== 0) {
563 /* Assign default port. */
564 uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
566 if (obj
->dst
.net
.control_isset
&& uri
->port
==
567 obj
->dst
.net
.control
.port
) {
568 ret
= -LTTNG_ERR_INVALID
;
572 DBG3("Consumer data URI set with port %d", uri
->port
);
575 ERR("Set network uri type unknown %d", uri
->stype
);
576 ret
= -LTTNG_ERR_INVALID
;
580 ret
= uri_compare(dst_uri
, uri
);
582 /* Same URI, don't touch it and return success. */
583 DBG3("URI network compare are the same");
587 /* URIs were not equal, replacing it. */
588 memset(dst_uri
, 0, sizeof(struct lttng_uri
));
589 memcpy(dst_uri
, uri
, sizeof(struct lttng_uri
));
590 obj
->type
= CONSUMER_DST_NET
;
592 /* Handle subdir and add hostname in front. */
593 if (dst_uri
->stype
== LTTNG_STREAM_CONTROL
) {
594 /* Get hostname to append it in the pathname */
595 ret
= gethostname(hostname
, sizeof(hostname
));
597 PERROR("gethostname. Fallback on default localhost");
598 strncpy(hostname
, "localhost", sizeof(hostname
));
600 hostname
[sizeof(hostname
) - 1] = '\0';
602 /* Setup consumer subdir if none present in the control URI */
603 if (strlen(dst_uri
->subdir
) == 0) {
604 ret
= snprintf(tmp_path
, sizeof(tmp_path
), "%s/%s",
605 hostname
, obj
->subdir
);
607 ret
= snprintf(tmp_path
, sizeof(tmp_path
), "%s/%s",
608 hostname
, dst_uri
->subdir
);
611 PERROR("snprintf set consumer uri subdir");
612 ret
= -LTTNG_ERR_NOMEM
;
616 strncpy(obj
->subdir
, tmp_path
, sizeof(obj
->subdir
));
617 DBG3("Consumer set network uri subdir path %s", tmp_path
);
628 * Send file descriptor to consumer via sock.
630 int consumer_send_fds(struct consumer_socket
*sock
, int *fds
, size_t nb_fd
)
638 ret
= lttcomm_send_fds_unix_sock(sock
->fd
, fds
, nb_fd
);
640 /* The above call will print a PERROR on error. */
641 DBG("Error when sending consumer fds on sock %d", sock
->fd
);
645 ret
= consumer_recv_status_reply(sock
);
652 * Consumer send communication message structure to consumer.
654 int consumer_send_msg(struct consumer_socket
*sock
,
655 struct lttcomm_consumer_msg
*msg
)
661 assert(sock
->fd
>= 0);
663 ret
= lttcomm_send_unix_sock(sock
->fd
, msg
,
664 sizeof(struct lttcomm_consumer_msg
));
666 /* The above call will print a PERROR on error. */
667 DBG("Error when sending consumer channel on sock %d", sock
->fd
);
671 ret
= consumer_recv_status_reply(sock
);
678 * Consumer send channel communication message structure to consumer.
680 int consumer_send_channel(struct consumer_socket
*sock
,
681 struct lttcomm_consumer_msg
*msg
)
687 assert(sock
->fd
>= 0);
689 ret
= lttcomm_send_unix_sock(sock
->fd
, msg
,
690 sizeof(struct lttcomm_consumer_msg
));
692 /* The above call will print a PERROR on error. */
693 DBG("Error when sending consumer channel on sock %d", sock
->fd
);
697 ret
= consumer_recv_status_reply(sock
);
704 * Populate the given consumer msg structure with the ask_channel command
707 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
708 uint64_t subbuf_size
,
711 unsigned int switch_timer_interval
,
712 unsigned int read_timer_interval
,
716 const char *pathname
,
724 uint64_t tracefile_size
,
725 uint64_t tracefile_count
,
726 unsigned int monitor
)
730 /* Zeroed structure */
731 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
733 msg
->cmd_type
= LTTNG_CONSUMER_ASK_CHANNEL_CREATION
;
734 msg
->u
.ask_channel
.subbuf_size
= subbuf_size
;
735 msg
->u
.ask_channel
.num_subbuf
= num_subbuf
;
736 msg
->u
.ask_channel
.overwrite
= overwrite
;
737 msg
->u
.ask_channel
.switch_timer_interval
= switch_timer_interval
;
738 msg
->u
.ask_channel
.read_timer_interval
= read_timer_interval
;
739 msg
->u
.ask_channel
.output
= output
;
740 msg
->u
.ask_channel
.type
= type
;
741 msg
->u
.ask_channel
.session_id
= session_id
;
742 msg
->u
.ask_channel
.uid
= uid
;
743 msg
->u
.ask_channel
.gid
= gid
;
744 msg
->u
.ask_channel
.relayd_id
= relayd_id
;
745 msg
->u
.ask_channel
.key
= key
;
746 msg
->u
.ask_channel
.chan_id
= chan_id
;
747 msg
->u
.ask_channel
.tracefile_size
= tracefile_size
;
748 msg
->u
.ask_channel
.tracefile_count
= tracefile_count
;
749 msg
->u
.ask_channel
.monitor
= monitor
;
751 memcpy(msg
->u
.ask_channel
.uuid
, uuid
, sizeof(msg
->u
.ask_channel
.uuid
));
753 strncpy(msg
->u
.ask_channel
.pathname
, pathname
,
754 sizeof(msg
->u
.ask_channel
.pathname
));
755 msg
->u
.ask_channel
.pathname
[sizeof(msg
->u
.ask_channel
.pathname
)-1] = '\0';
757 strncpy(msg
->u
.ask_channel
.name
, name
, sizeof(msg
->u
.ask_channel
.name
));
758 msg
->u
.ask_channel
.name
[sizeof(msg
->u
.ask_channel
.name
) - 1] = '\0';
762 * Init channel communication message structure.
764 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
765 enum lttng_consumer_command cmd
,
766 uint64_t channel_key
,
768 const char *pathname
,
773 unsigned int nb_init_streams
,
774 enum lttng_event_output output
,
776 uint64_t tracefile_size
,
777 uint64_t tracefile_count
,
778 unsigned int monitor
)
782 /* Zeroed structure */
783 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
787 msg
->u
.channel
.channel_key
= channel_key
;
788 msg
->u
.channel
.session_id
= session_id
;
789 msg
->u
.channel
.uid
= uid
;
790 msg
->u
.channel
.gid
= gid
;
791 msg
->u
.channel
.relayd_id
= relayd_id
;
792 msg
->u
.channel
.nb_init_streams
= nb_init_streams
;
793 msg
->u
.channel
.output
= output
;
794 msg
->u
.channel
.type
= type
;
795 msg
->u
.channel
.tracefile_size
= tracefile_size
;
796 msg
->u
.channel
.tracefile_count
= tracefile_count
;
797 msg
->u
.channel
.monitor
= monitor
;
799 strncpy(msg
->u
.channel
.pathname
, pathname
,
800 sizeof(msg
->u
.channel
.pathname
));
801 msg
->u
.channel
.pathname
[sizeof(msg
->u
.channel
.pathname
) - 1] = '\0';
803 strncpy(msg
->u
.channel
.name
, name
, sizeof(msg
->u
.channel
.name
));
804 msg
->u
.channel
.name
[sizeof(msg
->u
.channel
.name
) - 1] = '\0';
808 * Init stream communication message structure.
810 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
811 enum lttng_consumer_command cmd
,
812 uint64_t channel_key
,
818 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
821 msg
->u
.stream
.channel_key
= channel_key
;
822 msg
->u
.stream
.stream_key
= stream_key
;
823 msg
->u
.stream
.cpu
= cpu
;
827 * Send stream communication structure to the consumer.
829 int consumer_send_stream(struct consumer_socket
*sock
,
830 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
831 int *fds
, size_t nb_fd
)
841 ret
= lttcomm_send_unix_sock(sock
->fd
, msg
,
842 sizeof(struct lttcomm_consumer_msg
));
844 /* The above call will print a PERROR on error. */
845 DBG("Error when sending consumer stream on sock %d", sock
->fd
);
849 ret
= consumer_recv_status_reply(sock
);
854 ret
= consumer_send_fds(sock
, fds
, nb_fd
);
864 * Send relayd socket to consumer associated with a session name.
866 * On success return positive value. On error, negative value.
868 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
869 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
870 enum lttng_stream_type type
, uint64_t session_id
)
873 struct lttcomm_consumer_msg msg
;
875 /* Code flow error. Safety net. */
878 assert(consumer_sock
);
880 /* Bail out if consumer is disabled */
881 if (!consumer
->enabled
) {
886 msg
.cmd_type
= LTTNG_CONSUMER_ADD_RELAYD_SOCKET
;
888 * Assign network consumer output index using the temporary consumer since
889 * this call should only be made from within a set_consumer_uri() function
890 * call in the session daemon.
892 msg
.u
.relayd_sock
.net_index
= consumer
->net_seq_index
;
893 msg
.u
.relayd_sock
.type
= type
;
894 msg
.u
.relayd_sock
.session_id
= session_id
;
895 memcpy(&msg
.u
.relayd_sock
.sock
, rsock
, sizeof(msg
.u
.relayd_sock
.sock
));
897 DBG3("Sending relayd sock info to consumer on %d", consumer_sock
->fd
);
898 ret
= lttcomm_send_unix_sock(consumer_sock
->fd
, &msg
, sizeof(msg
));
900 /* The above call will print a PERROR on error. */
901 DBG("Error when sending relayd sockets on sock %d", rsock
->sock
.fd
);
905 ret
= consumer_recv_status_reply(consumer_sock
);
910 DBG3("Sending relayd socket file descriptor to consumer");
911 ret
= consumer_send_fds(consumer_sock
, &rsock
->sock
.fd
, 1);
916 DBG2("Consumer relayd socket sent");
923 * Set consumer subdirectory using the session name and a generated datetime if
924 * needed. This is appended to the current subdirectory.
926 int consumer_set_subdir(struct consumer_output
*consumer
,
927 const char *session_name
)
930 unsigned int have_default_name
= 0;
931 char datetime
[16], tmp_path
[PATH_MAX
];
936 assert(session_name
);
938 memset(tmp_path
, 0, sizeof(tmp_path
));
940 /* Flag if we have a default session. */
941 if (strncmp(session_name
, DEFAULT_SESSION_NAME
"-",
942 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) {
943 have_default_name
= 1;
945 /* Get date and time for session path */
947 timeinfo
= localtime(&rawtime
);
948 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
951 if (have_default_name
) {
952 ret
= snprintf(tmp_path
, sizeof(tmp_path
),
953 "%s/%s", consumer
->subdir
, session_name
);
955 ret
= snprintf(tmp_path
, sizeof(tmp_path
),
956 "%s/%s-%s/", consumer
->subdir
, session_name
, datetime
);
959 PERROR("snprintf session name date");
963 strncpy(consumer
->subdir
, tmp_path
, sizeof(consumer
->subdir
));
964 DBG2("Consumer subdir set to %s", consumer
->subdir
);
971 * Ask the consumer if the data is ready to read (NOT pending) for the specific
974 * This function has a different behavior with the consumer i.e. that it waits
975 * for a reply from the consumer if yes or no the data is pending.
977 int consumer_is_data_pending(uint64_t session_id
,
978 struct consumer_output
*consumer
)
981 int32_t ret_code
= 0; /* Default is that the data is NOT pending */
982 struct consumer_socket
*socket
;
983 struct lttng_ht_iter iter
;
984 struct lttcomm_consumer_msg msg
;
988 msg
.cmd_type
= LTTNG_CONSUMER_DATA_PENDING
;
990 msg
.u
.data_pending
.session_id
= session_id
;
992 DBG3("Consumer data pending for id %" PRIu64
, session_id
);
994 /* Send command for each consumer */
996 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
998 /* Code flow error */
999 assert(socket
->fd
>= 0);
1001 pthread_mutex_lock(socket
->lock
);
1003 ret
= lttcomm_send_unix_sock(socket
->fd
, &msg
, sizeof(msg
));
1005 /* The above call will print a PERROR on error. */
1006 DBG("Error on consumer is data pending on sock %d", socket
->fd
);
1007 pthread_mutex_unlock(socket
->lock
);
1012 * No need for a recv reply status because the answer to the command is
1013 * the reply status message.
1016 ret
= lttcomm_recv_unix_sock(socket
->fd
, &ret_code
, sizeof(ret_code
));
1019 /* Orderly shutdown. Don't return 0 which means success. */
1022 /* The above call will print a PERROR on error. */
1023 DBG("Error on recv consumer is data pending on sock %d", socket
->fd
);
1024 pthread_mutex_unlock(socket
->lock
);
1028 pthread_mutex_unlock(socket
->lock
);
1030 if (ret_code
== 1) {
1036 DBG("Consumer data is %s pending for session id %" PRIu64
,
1037 ret_code
== 1 ? "" : "NOT", session_id
);
1046 * Send a flush command to consumer using the given channel key.
1048 * Return 0 on success else a negative value.
1050 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
)
1053 struct lttcomm_consumer_msg msg
;
1056 assert(socket
->fd
>= 0);
1058 DBG2("Consumer flush channel key %" PRIu64
, key
);
1060 msg
.cmd_type
= LTTNG_CONSUMER_FLUSH_CHANNEL
;
1061 msg
.u
.flush_channel
.key
= key
;
1063 pthread_mutex_lock(socket
->lock
);
1064 health_code_update();
1066 ret
= consumer_send_msg(socket
, &msg
);
1072 health_code_update();
1073 pthread_mutex_unlock(socket
->lock
);
1078 * Send a close metdata command to consumer using the given channel key.
1080 * Return 0 on success else a negative value.
1082 int consumer_close_metadata(struct consumer_socket
*socket
,
1083 uint64_t metadata_key
)
1086 struct lttcomm_consumer_msg msg
;
1089 assert(socket
->fd
>= 0);
1091 DBG2("Consumer close metadata channel key %" PRIu64
, metadata_key
);
1093 msg
.cmd_type
= LTTNG_CONSUMER_CLOSE_METADATA
;
1094 msg
.u
.close_metadata
.key
= metadata_key
;
1096 pthread_mutex_lock(socket
->lock
);
1097 health_code_update();
1099 ret
= consumer_send_msg(socket
, &msg
);
1105 health_code_update();
1106 pthread_mutex_unlock(socket
->lock
);
1111 * Send a setup metdata command to consumer using the given channel key.
1113 * Return 0 on success else a negative value.
1115 int consumer_setup_metadata(struct consumer_socket
*socket
,
1116 uint64_t metadata_key
)
1119 struct lttcomm_consumer_msg msg
;
1122 assert(socket
->fd
>= 0);
1124 DBG2("Consumer setup metadata channel key %" PRIu64
, metadata_key
);
1126 msg
.cmd_type
= LTTNG_CONSUMER_SETUP_METADATA
;
1127 msg
.u
.setup_metadata
.key
= metadata_key
;
1129 pthread_mutex_lock(socket
->lock
);
1130 health_code_update();
1132 ret
= consumer_send_msg(socket
, &msg
);
1138 health_code_update();
1139 pthread_mutex_unlock(socket
->lock
);
1144 * Send metadata string to consumer. Socket lock MUST be acquired.
1146 * Return 0 on success else a negative value.
1148 int consumer_push_metadata(struct consumer_socket
*socket
,
1149 uint64_t metadata_key
, char *metadata_str
, size_t len
,
1150 size_t target_offset
)
1153 struct lttcomm_consumer_msg msg
;
1156 assert(socket
->fd
>= 0);
1158 DBG2("Consumer push metadata to consumer socket %d", socket
->fd
);
1160 msg
.cmd_type
= LTTNG_CONSUMER_PUSH_METADATA
;
1161 msg
.u
.push_metadata
.key
= metadata_key
;
1162 msg
.u
.push_metadata
.target_offset
= target_offset
;
1163 msg
.u
.push_metadata
.len
= len
;
1165 health_code_update();
1166 ret
= consumer_send_msg(socket
, &msg
);
1167 if (ret
< 0 || len
== 0) {
1171 DBG3("Consumer pushing metadata on sock %d of len %zu", socket
->fd
, len
);
1173 ret
= lttcomm_send_unix_sock(socket
->fd
, metadata_str
, len
);
1178 health_code_update();
1179 ret
= consumer_recv_status_reply(socket
);
1185 health_code_update();
1190 * Ask the consumer to snapshot a specific channel using the key.
1192 * Return 0 on success or else a negative error.
1194 int consumer_snapshot_channel(struct consumer_socket
*socket
, uint64_t key
,
1195 struct snapshot_output
*output
, int metadata
, uid_t uid
, gid_t gid
,
1196 const char *session_path
, int wait
)
1200 struct lttcomm_consumer_msg msg
;
1203 assert(socket
->fd
>= 0);
1205 assert(output
->consumer
);
1207 DBG("Consumer snapshot channel key %" PRIu64
, key
);
1209 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
1216 memset(&msg
, 0, sizeof(msg
));
1217 msg
.cmd_type
= LTTNG_CONSUMER_SNAPSHOT_CHANNEL
;
1218 msg
.u
.snapshot_channel
.key
= key
;
1219 msg
.u
.snapshot_channel
.max_size
= output
->max_size
;
1220 msg
.u
.snapshot_channel
.metadata
= metadata
;
1222 if (output
->consumer
->type
== CONSUMER_DST_NET
) {
1223 msg
.u
.snapshot_channel
.relayd_id
= output
->consumer
->net_seq_index
;
1224 msg
.u
.snapshot_channel
.use_relayd
= 1;
1225 ret
= snprintf(msg
.u
.snapshot_channel
.pathname
,
1226 sizeof(msg
.u
.snapshot_channel
.pathname
), "%s/%s-%s%s",
1227 output
->consumer
->subdir
, output
->name
, datetime
,
1230 ret
= -LTTNG_ERR_NOMEM
;
1234 ret
= snprintf(msg
.u
.snapshot_channel
.pathname
,
1235 sizeof(msg
.u
.snapshot_channel
.pathname
), "%s/%s-%s%s",
1236 output
->consumer
->dst
.trace_path
, output
->name
, datetime
,
1239 ret
= -LTTNG_ERR_NOMEM
;
1242 msg
.u
.snapshot_channel
.relayd_id
= (uint64_t) -1ULL;
1244 /* Create directory. Ignore if exist. */
1245 ret
= run_as_mkdir_recursive(msg
.u
.snapshot_channel
.pathname
,
1246 S_IRWXU
| S_IRWXG
, uid
, gid
);
1248 if (ret
!= -EEXIST
) {
1249 ERR("Trace directory creation error");
1255 health_code_update();
1256 ret
= consumer_send_msg(socket
, &msg
);
1262 health_code_update();