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>
38 * Send a data payload using a given consumer socket of size len.
40 * The consumer socket lock MUST be acquired before calling this since this
41 * function can change the fd value.
43 * Return 0 on success else a negative value on error.
45 int consumer_socket_send(struct consumer_socket
*socket
, void *msg
, size_t len
)
51 assert(socket
->fd_ptr
);
54 /* Consumer socket is invalid. Stopping. */
60 size
= lttcomm_send_unix_sock(fd
, msg
, len
);
62 /* The above call will print a PERROR on error. */
63 DBG("Error when sending data to consumer on sock %d", fd
);
65 * At this point, the socket is not usable anymore thus closing it and
66 * setting the file descriptor to -1 so it is not reused.
69 /* This call will PERROR on error. */
70 (void) lttcomm_close_unix_sock(fd
);
82 * Receive a data payload using a given consumer socket of size len.
84 * The consumer socket lock MUST be acquired before calling this since this
85 * function can change the fd value.
87 * Return 0 on success else a negative value on error.
89 int consumer_socket_recv(struct consumer_socket
*socket
, void *msg
, size_t len
)
95 assert(socket
->fd_ptr
);
98 /* Consumer socket is invalid. Stopping. */
104 size
= lttcomm_recv_unix_sock(fd
, msg
, len
);
106 /* The above call will print a PERROR on error. */
107 DBG("Error when receiving data from the consumer socket %d", fd
);
109 * At this point, the socket is not usable anymore thus closing it and
110 * setting the file descriptor to -1 so it is not reused.
113 /* This call will PERROR on error. */
114 (void) lttcomm_close_unix_sock(fd
);
115 *socket
->fd_ptr
= -1;
126 * Receive a reply command status message from the consumer. Consumer socket
127 * lock MUST be acquired before calling this function.
129 * Return 0 on success, -1 on recv error or a negative lttng error code which
130 * was possibly returned by the consumer.
132 int consumer_recv_status_reply(struct consumer_socket
*sock
)
135 struct lttcomm_consumer_status_msg reply
;
139 ret
= consumer_socket_recv(sock
, &reply
, sizeof(reply
));
144 if (reply
.ret_code
== LTTNG_OK
) {
148 ret
= -reply
.ret_code
;
149 DBG("Consumer ret code %d", ret
);
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
!= LTTNG_OK
) {
186 *stream_count
= reply
.stream_count
;
193 * Send destroy relayd command to consumer.
195 * On success return positive value. On error, negative value.
197 int consumer_send_destroy_relayd(struct consumer_socket
*sock
,
198 struct consumer_output
*consumer
)
201 struct lttcomm_consumer_msg msg
;
206 DBG2("Sending destroy relayd command to consumer sock %d", *sock
->fd_ptr
);
208 msg
.cmd_type
= LTTNG_CONSUMER_DESTROY_RELAYD
;
209 msg
.u
.destroy_relayd
.net_seq_idx
= consumer
->net_seq_index
;
211 pthread_mutex_lock(sock
->lock
);
212 ret
= consumer_socket_send(sock
, &msg
, sizeof(msg
));
217 /* Don't check the return value. The caller will do it. */
218 ret
= consumer_recv_status_reply(sock
);
220 DBG2("Consumer send destroy relayd command done");
223 pthread_mutex_unlock(sock
->lock
);
228 * For each consumer socket in the consumer output object, send a destroy
231 void consumer_output_send_destroy_relayd(struct consumer_output
*consumer
)
233 struct lttng_ht_iter iter
;
234 struct consumer_socket
*socket
;
238 /* Destroy any relayd connection */
239 if (consumer
->type
== CONSUMER_DST_NET
) {
241 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
245 /* Send destroy relayd command */
246 ret
= consumer_send_destroy_relayd(socket
, consumer
);
248 DBG("Unable to send destroy relayd command to consumer");
249 /* Continue since we MUST delete everything at this point. */
257 * From a consumer_data structure, allocate and add a consumer socket to the
260 * Return 0 on success, else negative value on error
262 int consumer_create_socket(struct consumer_data
*data
,
263 struct consumer_output
*output
)
266 struct consumer_socket
*socket
;
270 if (output
== NULL
|| data
->cmd_sock
< 0) {
272 * Not an error. Possible there is simply not spawned consumer or it's
273 * disabled for the tracing session asking the socket.
279 socket
= consumer_find_socket(data
->cmd_sock
, output
);
281 if (socket
== NULL
) {
282 socket
= consumer_allocate_socket(&data
->cmd_sock
);
283 if (socket
== NULL
) {
288 socket
->registered
= 0;
289 socket
->lock
= &data
->lock
;
291 consumer_add_socket(socket
, output
);
295 socket
->type
= data
->type
;
297 DBG3("Consumer socket created (fd: %d) and added to output",
305 * Return the consumer socket from the given consumer output with the right
306 * bitness. On error, returns NULL.
308 * The caller MUST acquire a rcu read side lock and keep it until the socket
309 * object reference is not needed anymore.
311 struct consumer_socket
*consumer_find_socket_by_bitness(int bits
,
312 struct consumer_output
*consumer
)
315 struct consumer_socket
*socket
= NULL
;
319 consumer_fd
= uatomic_read(&ust_consumerd64_fd
);
322 consumer_fd
= uatomic_read(&ust_consumerd32_fd
);
329 socket
= consumer_find_socket(consumer_fd
, consumer
);
331 ERR("Consumer socket fd %d not found in consumer obj %p",
332 consumer_fd
, consumer
);
340 * Find a consumer_socket in a consumer_output hashtable. Read side lock must
341 * be acquired before calling this function and across use of the
342 * returned consumer_socket.
344 struct consumer_socket
*consumer_find_socket(int key
,
345 struct consumer_output
*consumer
)
347 struct lttng_ht_iter iter
;
348 struct lttng_ht_node_ulong
*node
;
349 struct consumer_socket
*socket
= NULL
;
351 /* Negative keys are lookup failures */
352 if (key
< 0 || consumer
== NULL
) {
356 lttng_ht_lookup(consumer
->socks
, (void *)((unsigned long) key
),
358 node
= lttng_ht_iter_get_node_ulong(&iter
);
360 socket
= caa_container_of(node
, struct consumer_socket
, node
);
367 * Allocate a new consumer_socket and return the pointer.
369 struct consumer_socket
*consumer_allocate_socket(int *fd
)
371 struct consumer_socket
*socket
= NULL
;
375 socket
= zmalloc(sizeof(struct consumer_socket
));
376 if (socket
== NULL
) {
377 PERROR("zmalloc consumer socket");
382 lttng_ht_node_init_ulong(&socket
->node
, *fd
);
389 * Add consumer socket to consumer output object. Read side lock must be
390 * acquired before calling this function.
392 void consumer_add_socket(struct consumer_socket
*sock
,
393 struct consumer_output
*consumer
)
398 lttng_ht_add_unique_ulong(consumer
->socks
, &sock
->node
);
402 * Delte consumer socket to consumer output object. Read side lock must be
403 * acquired before calling this function.
405 void consumer_del_socket(struct consumer_socket
*sock
,
406 struct consumer_output
*consumer
)
409 struct lttng_ht_iter iter
;
414 iter
.iter
.node
= &sock
->node
.node
;
415 ret
= lttng_ht_del(consumer
->socks
, &iter
);
420 * RCU destroy call function.
422 static void destroy_socket_rcu(struct rcu_head
*head
)
424 struct lttng_ht_node_ulong
*node
=
425 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
426 struct consumer_socket
*socket
=
427 caa_container_of(node
, struct consumer_socket
, node
);
433 * Destroy and free socket pointer in a call RCU. Read side lock must be
434 * acquired before calling this function.
436 void consumer_destroy_socket(struct consumer_socket
*sock
)
441 * We DO NOT close the file descriptor here since it is global to the
442 * session daemon and is closed only if the consumer dies or a custom
443 * consumer was registered,
445 if (sock
->registered
) {
446 DBG3("Consumer socket was registered. Closing fd %d", *sock
->fd_ptr
);
447 lttcomm_close_unix_sock(*sock
->fd_ptr
);
450 call_rcu(&sock
->node
.head
, destroy_socket_rcu
);
454 * Allocate and assign data to a consumer_output object.
456 * Return pointer to structure.
458 struct consumer_output
*consumer_create_output(enum consumer_dst_type type
)
460 struct consumer_output
*output
= NULL
;
462 output
= zmalloc(sizeof(struct consumer_output
));
463 if (output
== NULL
) {
464 PERROR("zmalloc consumer_output");
468 /* By default, consumer output is enabled */
471 output
->net_seq_index
= (uint64_t) -1ULL;
473 output
->socks
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
480 * Iterate over the consumer output socket hash table and destroy them. The
481 * socket file descriptor are only closed if the consumer output was
482 * registered meaning it's an external consumer.
484 void consumer_destroy_output_sockets(struct consumer_output
*obj
)
486 struct lttng_ht_iter iter
;
487 struct consumer_socket
*socket
;
494 cds_lfht_for_each_entry(obj
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
495 consumer_del_socket(socket
, obj
);
496 consumer_destroy_socket(socket
);
502 * Delete the consumer_output object from the list and free the ptr.
504 * Should *NOT* be called with RCU read-side lock held.
506 void consumer_destroy_output(struct consumer_output
*obj
)
512 consumer_destroy_output_sockets(obj
);
515 /* Finally destroy HT */
516 ht_cleanup_push(obj
->socks
);
523 * Copy consumer output and returned the newly allocated copy.
525 * Should *NOT* be called with RCU read-side lock held.
527 struct consumer_output
*consumer_copy_output(struct consumer_output
*obj
)
530 struct lttng_ht
*tmp_ht_ptr
;
531 struct consumer_output
*output
;
535 output
= consumer_create_output(obj
->type
);
536 if (output
== NULL
) {
539 /* Avoid losing the HT reference after the memcpy() */
540 tmp_ht_ptr
= output
->socks
;
542 memcpy(output
, obj
, sizeof(struct consumer_output
));
544 /* Putting back the HT pointer and start copying socket(s). */
545 output
->socks
= tmp_ht_ptr
;
547 ret
= consumer_copy_sockets(output
, obj
);
556 consumer_destroy_output(output
);
561 * Copy consumer sockets from src to dst.
563 * Return 0 on success or else a negative value.
565 int consumer_copy_sockets(struct consumer_output
*dst
,
566 struct consumer_output
*src
)
569 struct lttng_ht_iter iter
;
570 struct consumer_socket
*socket
, *copy_sock
;
576 cds_lfht_for_each_entry(src
->socks
->ht
, &iter
.iter
, socket
, node
.node
) {
577 /* Ignore socket that are already there. */
578 copy_sock
= consumer_find_socket(*socket
->fd_ptr
, dst
);
583 /* Create new socket object. */
584 copy_sock
= consumer_allocate_socket(socket
->fd_ptr
);
585 if (copy_sock
== NULL
) {
591 copy_sock
->registered
= socket
->registered
;
593 * This is valid because this lock is shared accross all consumer
594 * object being the global lock of the consumer data structure of the
597 copy_sock
->lock
= socket
->lock
;
598 consumer_add_socket(copy_sock
, dst
);
607 * Set network URI to the consumer output object.
609 * Return 0 on success. Return 1 if the URI were equal. Else, negative value on
612 int consumer_set_network_uri(struct consumer_output
*obj
,
613 struct lttng_uri
*uri
)
616 char tmp_path
[PATH_MAX
];
617 char hostname
[HOST_NAME_MAX
];
618 struct lttng_uri
*dst_uri
= NULL
;
620 /* Code flow error safety net. */
624 switch (uri
->stype
) {
625 case LTTNG_STREAM_CONTROL
:
626 dst_uri
= &obj
->dst
.net
.control
;
627 obj
->dst
.net
.control_isset
= 1;
628 if (uri
->port
== 0) {
629 /* Assign default port. */
630 uri
->port
= DEFAULT_NETWORK_CONTROL_PORT
;
632 if (obj
->dst
.net
.data_isset
&& uri
->port
==
633 obj
->dst
.net
.data
.port
) {
634 ret
= -LTTNG_ERR_INVALID
;
638 DBG3("Consumer control URI set with port %d", uri
->port
);
640 case LTTNG_STREAM_DATA
:
641 dst_uri
= &obj
->dst
.net
.data
;
642 obj
->dst
.net
.data_isset
= 1;
643 if (uri
->port
== 0) {
644 /* Assign default port. */
645 uri
->port
= DEFAULT_NETWORK_DATA_PORT
;
647 if (obj
->dst
.net
.control_isset
&& uri
->port
==
648 obj
->dst
.net
.control
.port
) {
649 ret
= -LTTNG_ERR_INVALID
;
653 DBG3("Consumer data URI set with port %d", uri
->port
);
656 ERR("Set network uri type unknown %d", uri
->stype
);
657 ret
= -LTTNG_ERR_INVALID
;
661 ret
= uri_compare(dst_uri
, uri
);
663 /* Same URI, don't touch it and return success. */
664 DBG3("URI network compare are the same");
668 /* URIs were not equal, replacing it. */
669 memset(dst_uri
, 0, sizeof(struct lttng_uri
));
670 memcpy(dst_uri
, uri
, sizeof(struct lttng_uri
));
671 obj
->type
= CONSUMER_DST_NET
;
673 /* Handle subdir and add hostname in front. */
674 if (dst_uri
->stype
== LTTNG_STREAM_CONTROL
) {
675 /* Get hostname to append it in the pathname */
676 ret
= gethostname(hostname
, sizeof(hostname
));
678 PERROR("gethostname. Fallback on default localhost");
679 strncpy(hostname
, "localhost", sizeof(hostname
));
681 hostname
[sizeof(hostname
) - 1] = '\0';
683 /* Setup consumer subdir if none present in the control URI */
684 if (strlen(dst_uri
->subdir
) == 0) {
685 ret
= snprintf(tmp_path
, sizeof(tmp_path
), "%s/%s",
686 hostname
, obj
->subdir
);
688 ret
= snprintf(tmp_path
, sizeof(tmp_path
), "%s/%s",
689 hostname
, dst_uri
->subdir
);
692 PERROR("snprintf set consumer uri subdir");
693 ret
= -LTTNG_ERR_NOMEM
;
697 strncpy(obj
->subdir
, tmp_path
, sizeof(obj
->subdir
));
698 DBG3("Consumer set network uri subdir path %s", tmp_path
);
709 * Send file descriptor to consumer via sock.
711 int consumer_send_fds(struct consumer_socket
*sock
, int *fds
, size_t nb_fd
)
719 ret
= lttcomm_send_fds_unix_sock(*sock
->fd_ptr
, fds
, nb_fd
);
721 /* The above call will print a PERROR on error. */
722 DBG("Error when sending consumer fds on sock %d", *sock
->fd_ptr
);
726 ret
= consumer_recv_status_reply(sock
);
733 * Consumer send communication message structure to consumer.
735 int consumer_send_msg(struct consumer_socket
*sock
,
736 struct lttcomm_consumer_msg
*msg
)
743 ret
= consumer_socket_send(sock
, msg
, sizeof(struct lttcomm_consumer_msg
));
748 ret
= consumer_recv_status_reply(sock
);
755 * Consumer send channel communication message structure to consumer.
757 int consumer_send_channel(struct consumer_socket
*sock
,
758 struct lttcomm_consumer_msg
*msg
)
765 ret
= consumer_send_msg(sock
, msg
);
775 * Populate the given consumer msg structure with the ask_channel command
778 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
779 uint64_t subbuf_size
,
782 unsigned int switch_timer_interval
,
783 unsigned int read_timer_interval
,
784 unsigned int live_timer_interval
,
788 const char *pathname
,
796 uint64_t tracefile_size
,
797 uint64_t tracefile_count
,
798 uint64_t session_id_per_pid
,
799 unsigned int monitor
,
800 uint32_t ust_app_uid
)
804 /* Zeroed structure */
805 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
807 msg
->cmd_type
= LTTNG_CONSUMER_ASK_CHANNEL_CREATION
;
808 msg
->u
.ask_channel
.subbuf_size
= subbuf_size
;
809 msg
->u
.ask_channel
.num_subbuf
= num_subbuf
;
810 msg
->u
.ask_channel
.overwrite
= overwrite
;
811 msg
->u
.ask_channel
.switch_timer_interval
= switch_timer_interval
;
812 msg
->u
.ask_channel
.read_timer_interval
= read_timer_interval
;
813 msg
->u
.ask_channel
.live_timer_interval
= live_timer_interval
;
814 msg
->u
.ask_channel
.output
= output
;
815 msg
->u
.ask_channel
.type
= type
;
816 msg
->u
.ask_channel
.session_id
= session_id
;
817 msg
->u
.ask_channel
.session_id_per_pid
= session_id_per_pid
;
818 msg
->u
.ask_channel
.uid
= uid
;
819 msg
->u
.ask_channel
.gid
= gid
;
820 msg
->u
.ask_channel
.relayd_id
= relayd_id
;
821 msg
->u
.ask_channel
.key
= key
;
822 msg
->u
.ask_channel
.chan_id
= chan_id
;
823 msg
->u
.ask_channel
.tracefile_size
= tracefile_size
;
824 msg
->u
.ask_channel
.tracefile_count
= tracefile_count
;
825 msg
->u
.ask_channel
.monitor
= monitor
;
826 msg
->u
.ask_channel
.ust_app_uid
= ust_app_uid
;
828 memcpy(msg
->u
.ask_channel
.uuid
, uuid
, sizeof(msg
->u
.ask_channel
.uuid
));
831 strncpy(msg
->u
.ask_channel
.pathname
, pathname
,
832 sizeof(msg
->u
.ask_channel
.pathname
));
833 msg
->u
.ask_channel
.pathname
[sizeof(msg
->u
.ask_channel
.pathname
)-1] = '\0';
836 strncpy(msg
->u
.ask_channel
.name
, name
, sizeof(msg
->u
.ask_channel
.name
));
837 msg
->u
.ask_channel
.name
[sizeof(msg
->u
.ask_channel
.name
) - 1] = '\0';
841 * Init channel communication message structure.
843 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
844 enum lttng_consumer_command cmd
,
845 uint64_t channel_key
,
847 const char *pathname
,
852 unsigned int nb_init_streams
,
853 enum lttng_event_output output
,
855 uint64_t tracefile_size
,
856 uint64_t tracefile_count
,
857 unsigned int monitor
,
858 unsigned int live_timer_interval
)
862 /* Zeroed structure */
863 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
867 msg
->u
.channel
.channel_key
= channel_key
;
868 msg
->u
.channel
.session_id
= session_id
;
869 msg
->u
.channel
.uid
= uid
;
870 msg
->u
.channel
.gid
= gid
;
871 msg
->u
.channel
.relayd_id
= relayd_id
;
872 msg
->u
.channel
.nb_init_streams
= nb_init_streams
;
873 msg
->u
.channel
.output
= output
;
874 msg
->u
.channel
.type
= type
;
875 msg
->u
.channel
.tracefile_size
= tracefile_size
;
876 msg
->u
.channel
.tracefile_count
= tracefile_count
;
877 msg
->u
.channel
.monitor
= monitor
;
878 msg
->u
.channel
.live_timer_interval
= live_timer_interval
;
880 strncpy(msg
->u
.channel
.pathname
, pathname
,
881 sizeof(msg
->u
.channel
.pathname
));
882 msg
->u
.channel
.pathname
[sizeof(msg
->u
.channel
.pathname
) - 1] = '\0';
884 strncpy(msg
->u
.channel
.name
, name
, sizeof(msg
->u
.channel
.name
));
885 msg
->u
.channel
.name
[sizeof(msg
->u
.channel
.name
) - 1] = '\0';
889 * Init stream communication message structure.
891 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
892 enum lttng_consumer_command cmd
,
893 uint64_t channel_key
,
899 memset(msg
, 0, sizeof(struct lttcomm_consumer_msg
));
902 msg
->u
.stream
.channel_key
= channel_key
;
903 msg
->u
.stream
.stream_key
= stream_key
;
904 msg
->u
.stream
.cpu
= cpu
;
908 * Send stream communication structure to the consumer.
910 int consumer_send_stream(struct consumer_socket
*sock
,
911 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
912 int *fds
, size_t nb_fd
)
921 ret
= consumer_send_msg(sock
, msg
);
926 ret
= consumer_send_fds(sock
, fds
, nb_fd
);
936 * Send relayd socket to consumer associated with a session name.
938 * On success return positive value. On error, negative value.
940 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
941 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
942 enum lttng_stream_type type
, uint64_t session_id
)
945 struct lttcomm_consumer_msg msg
;
947 /* Code flow error. Safety net. */
950 assert(consumer_sock
);
952 /* Bail out if consumer is disabled */
953 if (!consumer
->enabled
) {
958 msg
.cmd_type
= LTTNG_CONSUMER_ADD_RELAYD_SOCKET
;
960 * Assign network consumer output index using the temporary consumer since
961 * this call should only be made from within a set_consumer_uri() function
962 * call in the session daemon.
964 msg
.u
.relayd_sock
.net_index
= consumer
->net_seq_index
;
965 msg
.u
.relayd_sock
.type
= type
;
966 msg
.u
.relayd_sock
.session_id
= session_id
;
967 memcpy(&msg
.u
.relayd_sock
.sock
, rsock
, sizeof(msg
.u
.relayd_sock
.sock
));
969 DBG3("Sending relayd sock info to consumer on %d", *consumer_sock
->fd_ptr
);
970 ret
= consumer_send_msg(consumer_sock
, &msg
);
975 DBG3("Sending relayd socket file descriptor to consumer");
976 ret
= consumer_send_fds(consumer_sock
, &rsock
->sock
.fd
, 1);
981 DBG2("Consumer relayd socket sent");
988 * Set consumer subdirectory using the session name and a generated datetime if
989 * needed. This is appended to the current subdirectory.
991 int consumer_set_subdir(struct consumer_output
*consumer
,
992 const char *session_name
)
995 unsigned int have_default_name
= 0;
996 char datetime
[16], tmp_path
[PATH_MAX
];
1001 assert(session_name
);
1003 memset(tmp_path
, 0, sizeof(tmp_path
));
1005 /* Flag if we have a default session. */
1006 if (strncmp(session_name
, DEFAULT_SESSION_NAME
"-",
1007 strlen(DEFAULT_SESSION_NAME
) + 1) == 0) {
1008 have_default_name
= 1;
1010 /* Get date and time for session path */
1012 timeinfo
= localtime(&rawtime
);
1013 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1016 if (have_default_name
) {
1017 ret
= snprintf(tmp_path
, sizeof(tmp_path
),
1018 "%s/%s", consumer
->subdir
, session_name
);
1020 ret
= snprintf(tmp_path
, sizeof(tmp_path
),
1021 "%s/%s-%s/", consumer
->subdir
, session_name
, datetime
);
1024 PERROR("snprintf session name date");
1028 strncpy(consumer
->subdir
, tmp_path
, sizeof(consumer
->subdir
));
1029 DBG2("Consumer subdir set to %s", consumer
->subdir
);
1036 * Ask the consumer if the data is ready to read (NOT pending) for the specific
1039 * This function has a different behavior with the consumer i.e. that it waits
1040 * for a reply from the consumer if yes or no the data is pending.
1042 int consumer_is_data_pending(uint64_t session_id
,
1043 struct consumer_output
*consumer
)
1046 int32_t ret_code
= 0; /* Default is that the data is NOT pending */
1047 struct consumer_socket
*socket
;
1048 struct lttng_ht_iter iter
;
1049 struct lttcomm_consumer_msg msg
;
1053 msg
.cmd_type
= LTTNG_CONSUMER_DATA_PENDING
;
1055 msg
.u
.data_pending
.session_id
= session_id
;
1057 DBG3("Consumer data pending for id %" PRIu64
, session_id
);
1059 /* Send command for each consumer */
1061 cds_lfht_for_each_entry(consumer
->socks
->ht
, &iter
.iter
, socket
,
1063 pthread_mutex_lock(socket
->lock
);
1064 ret
= consumer_socket_send(socket
, &msg
, sizeof(msg
));
1066 pthread_mutex_unlock(socket
->lock
);
1071 * No need for a recv reply status because the answer to the command is
1072 * the reply status message.
1075 ret
= consumer_socket_recv(socket
, &ret_code
, sizeof(ret_code
));
1077 pthread_mutex_unlock(socket
->lock
);
1080 pthread_mutex_unlock(socket
->lock
);
1082 if (ret_code
== 1) {
1088 DBG("Consumer data is %s pending for session id %" PRIu64
,
1089 ret_code
== 1 ? "" : "NOT", session_id
);
1098 * Send a flush command to consumer using the given channel key.
1100 * Return 0 on success else a negative value.
1102 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
)
1105 struct lttcomm_consumer_msg msg
;
1109 DBG2("Consumer flush channel key %" PRIu64
, key
);
1111 msg
.cmd_type
= LTTNG_CONSUMER_FLUSH_CHANNEL
;
1112 msg
.u
.flush_channel
.key
= key
;
1114 pthread_mutex_lock(socket
->lock
);
1115 health_code_update();
1117 ret
= consumer_send_msg(socket
, &msg
);
1123 health_code_update();
1124 pthread_mutex_unlock(socket
->lock
);
1129 * Send a close metdata command to consumer using the given channel key.
1131 * Return 0 on success else a negative value.
1133 int consumer_close_metadata(struct consumer_socket
*socket
,
1134 uint64_t metadata_key
)
1137 struct lttcomm_consumer_msg msg
;
1141 DBG2("Consumer close metadata channel key %" PRIu64
, metadata_key
);
1143 msg
.cmd_type
= LTTNG_CONSUMER_CLOSE_METADATA
;
1144 msg
.u
.close_metadata
.key
= metadata_key
;
1146 pthread_mutex_lock(socket
->lock
);
1147 health_code_update();
1149 ret
= consumer_send_msg(socket
, &msg
);
1155 health_code_update();
1156 pthread_mutex_unlock(socket
->lock
);
1161 * Send a setup metdata command to consumer using the given channel key.
1163 * Return 0 on success else a negative value.
1165 int consumer_setup_metadata(struct consumer_socket
*socket
,
1166 uint64_t metadata_key
)
1169 struct lttcomm_consumer_msg msg
;
1173 DBG2("Consumer setup metadata channel key %" PRIu64
, metadata_key
);
1175 msg
.cmd_type
= LTTNG_CONSUMER_SETUP_METADATA
;
1176 msg
.u
.setup_metadata
.key
= metadata_key
;
1178 pthread_mutex_lock(socket
->lock
);
1179 health_code_update();
1181 ret
= consumer_send_msg(socket
, &msg
);
1187 health_code_update();
1188 pthread_mutex_unlock(socket
->lock
);
1193 * Send metadata string to consumer. Socket lock MUST be acquired.
1195 * Return 0 on success else a negative value.
1197 int consumer_push_metadata(struct consumer_socket
*socket
,
1198 uint64_t metadata_key
, char *metadata_str
, size_t len
,
1199 size_t target_offset
)
1202 struct lttcomm_consumer_msg msg
;
1206 DBG2("Consumer push metadata to consumer socket %d", *socket
->fd_ptr
);
1208 msg
.cmd_type
= LTTNG_CONSUMER_PUSH_METADATA
;
1209 msg
.u
.push_metadata
.key
= metadata_key
;
1210 msg
.u
.push_metadata
.target_offset
= target_offset
;
1211 msg
.u
.push_metadata
.len
= len
;
1213 health_code_update();
1214 ret
= consumer_send_msg(socket
, &msg
);
1215 if (ret
< 0 || len
== 0) {
1219 DBG3("Consumer pushing metadata on sock %d of len %zu", *socket
->fd_ptr
,
1222 ret
= consumer_socket_send(socket
, metadata_str
, len
);
1227 health_code_update();
1228 ret
= consumer_recv_status_reply(socket
);
1234 health_code_update();
1239 * Ask the consumer to snapshot a specific channel using the key.
1241 * Return 0 on success or else a negative error.
1243 int consumer_snapshot_channel(struct consumer_socket
*socket
, uint64_t key
,
1244 struct snapshot_output
*output
, int metadata
, uid_t uid
, gid_t gid
,
1245 const char *session_path
, int wait
, int max_stream_size
)
1248 struct lttcomm_consumer_msg msg
;
1252 assert(output
->consumer
);
1254 DBG("Consumer snapshot channel key %" PRIu64
, key
);
1256 memset(&msg
, 0, sizeof(msg
));
1257 msg
.cmd_type
= LTTNG_CONSUMER_SNAPSHOT_CHANNEL
;
1258 msg
.u
.snapshot_channel
.key
= key
;
1259 msg
.u
.snapshot_channel
.max_stream_size
= max_stream_size
;
1260 msg
.u
.snapshot_channel
.metadata
= metadata
;
1262 if (output
->consumer
->type
== CONSUMER_DST_NET
) {
1263 msg
.u
.snapshot_channel
.relayd_id
= output
->consumer
->net_seq_index
;
1264 msg
.u
.snapshot_channel
.use_relayd
= 1;
1265 ret
= snprintf(msg
.u
.snapshot_channel
.pathname
,
1266 sizeof(msg
.u
.snapshot_channel
.pathname
),
1267 "%s/%s-%s-%" PRIu64
"%s", output
->consumer
->subdir
,
1268 output
->name
, output
->datetime
, output
->nb_snapshot
,
1271 ret
= -LTTNG_ERR_NOMEM
;
1275 ret
= snprintf(msg
.u
.snapshot_channel
.pathname
,
1276 sizeof(msg
.u
.snapshot_channel
.pathname
),
1277 "%s/%s-%s-%" PRIu64
"%s", output
->consumer
->dst
.trace_path
,
1278 output
->name
, output
->datetime
, output
->nb_snapshot
,
1281 ret
= -LTTNG_ERR_NOMEM
;
1284 msg
.u
.snapshot_channel
.relayd_id
= (uint64_t) -1ULL;
1286 /* Create directory. Ignore if exist. */
1287 ret
= run_as_mkdir_recursive(msg
.u
.snapshot_channel
.pathname
,
1288 S_IRWXU
| S_IRWXG
, uid
, gid
);
1290 if (ret
!= -EEXIST
) {
1291 ERR("Trace directory creation error");
1297 health_code_update();
1298 ret
= consumer_send_msg(socket
, &msg
);
1304 health_code_update();