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.
26 #include <common/common.h>
27 #include <common/defaults.h>
28 #include <common/compat/endian.h>
29 #include <common/compat/string.h>
30 #include <common/sessiond-comm/relayd.h>
31 #include <common/index/ctf-index.h>
32 #include <common/trace-chunk.h>
33 #include <common/string-utils/format.h>
38 bool relayd_supports_chunks(const struct lttcomm_relayd_sock
*sock
)
40 if (sock
->major
> 2) {
42 } else if (sock
->major
== 2 && sock
->minor
>= 11) {
49 * Send command. Fill up the header and append the data.
51 static int send_command(struct lttcomm_relayd_sock
*rsock
,
52 enum lttcomm_relayd_command cmd
, const void *data
, size_t size
,
56 struct lttcomm_relayd_hdr header
;
58 uint64_t buf_size
= sizeof(header
);
60 if (rsock
->sock
.fd
< 0) {
68 buf
= zmalloc(buf_size
);
70 PERROR("zmalloc relayd send command buf");
75 memset(&header
, 0, sizeof(header
));
76 header
.cmd
= htobe32(cmd
);
77 header
.data_size
= htobe64(size
);
79 /* Zeroed for now since not used. */
80 header
.cmd_version
= 0;
81 header
.circuit_id
= 0;
83 /* Prepare buffer to send. */
84 memcpy(buf
, &header
, sizeof(header
));
86 memcpy(buf
+ sizeof(header
), data
, size
);
89 DBG3("Relayd sending command %d of size %" PRIu64
, (int) cmd
, buf_size
);
90 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, buf
, buf_size
, flags
);
92 PERROR("Failed to send command %d of size %" PRIu64
,
104 * Receive reply data on socket. This MUST be call after send_command or else
105 * could result in unexpected behavior(s).
107 static int recv_reply(struct lttcomm_relayd_sock
*rsock
, void *data
, size_t size
)
111 if (rsock
->sock
.fd
< 0) {
115 DBG3("Relayd waiting for reply of size %zu", size
);
117 ret
= rsock
->sock
.ops
->recvmsg(&rsock
->sock
, data
, size
, 0);
118 if (ret
<= 0 || ret
!= size
) {
120 /* Orderly shutdown. */
121 DBG("Socket %d has performed an orderly shutdown", rsock
->sock
.fd
);
123 DBG("Receiving reply failed on sock %d for size %zu with ret %d",
124 rsock
->sock
.fd
, size
, ret
);
126 /* Always return -1 here and the caller can use errno. */
136 * Starting from 2.11, RELAYD_CREATE_SESSION payload (session_name,
137 * hostname, and base_path) have no length restriction on the sender side.
138 * Length for both payloads is stored in the msg struct. A new dynamic size
139 * payload size is introduced.
141 static int relayd_create_session_2_11(struct lttcomm_relayd_sock
*rsock
,
142 const char *session_name
, const char *hostname
,
143 const char *base_path
, int session_live_timer
,
144 unsigned int snapshot
, uint64_t sessiond_session_id
,
145 const lttng_uuid sessiond_uuid
, const uint64_t *current_chunk_id
,
146 time_t creation_time
, bool session_name_contains_creation_time
,
147 struct lttcomm_relayd_create_session_reply_2_11
*reply
,
151 struct lttcomm_relayd_create_session_2_11
*msg
= NULL
;
152 size_t session_name_len
;
154 size_t base_path_len
;
161 /* The three names are sent with a '\0' delimiter between them. */
162 session_name_len
= strlen(session_name
) + 1;
163 hostname_len
= strlen(hostname
) + 1;
164 base_path_len
= base_path
? strlen(base_path
) + 1 : 0;
166 msg_length
= sizeof(*msg
) + session_name_len
+ hostname_len
+ base_path_len
;
167 msg
= zmalloc(msg_length
);
169 PERROR("zmalloc create_session_2_11 command message");
174 assert(session_name_len
<= UINT32_MAX
);
175 msg
->session_name_len
= htobe32(session_name_len
);
177 assert(hostname_len
<= UINT32_MAX
);
178 msg
->hostname_len
= htobe32(hostname_len
);
180 assert(base_path_len
<= UINT32_MAX
);
181 msg
->base_path_len
= htobe32(base_path_len
);
184 if (lttng_strncpy(dst
, session_name
, session_name_len
)) {
188 dst
+= session_name_len
;
189 if (lttng_strncpy(dst
, hostname
, hostname_len
)) {
194 if (base_path
&& lttng_strncpy(dst
, base_path
, base_path_len
)) {
199 msg
->live_timer
= htobe32(session_live_timer
);
200 msg
->snapshot
= !!snapshot
;
202 lttng_uuid_copy(msg
->sessiond_uuid
, sessiond_uuid
);
203 msg
->session_id
= htobe64(sessiond_session_id
);
204 msg
->session_name_contains_creation_time
= session_name_contains_creation_time
;
205 if (current_chunk_id
) {
206 LTTNG_OPTIONAL_SET(&msg
->current_chunk_id
,
207 htobe64(*current_chunk_id
));
210 msg
->creation_time
= htobe64((uint64_t) creation_time
);
213 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, msg
, msg_length
, 0);
217 /* Receive response */
218 ret
= recv_reply(rsock
, reply
, sizeof(*reply
));
222 reply
->generic
.session_id
= be64toh(reply
->generic
.session_id
);
223 reply
->generic
.ret_code
= be32toh(reply
->generic
.ret_code
);
224 reply
->output_path_length
= be32toh(reply
->output_path_length
);
225 if (reply
->output_path_length
>= LTTNG_PATH_MAX
) {
226 ERR("Invalid session output path length in reply (%" PRIu32
" bytes) exceeds maximal allowed length (%d bytes)",
227 reply
->output_path_length
, LTTNG_PATH_MAX
);
231 ret
= recv_reply(rsock
, output_path
, reply
->output_path_length
);
240 * From 2.4 to 2.10, RELAYD_CREATE_SESSION takes additional parameters to
241 * support the live reading capability.
243 static int relayd_create_session_2_4(struct lttcomm_relayd_sock
*rsock
,
244 const char *session_name
, const char *hostname
,
245 int session_live_timer
, unsigned int snapshot
,
246 struct lttcomm_relayd_status_session
*reply
)
249 struct lttcomm_relayd_create_session_2_4 msg
;
251 if (lttng_strncpy(msg
.session_name
, session_name
,
252 sizeof(msg
.session_name
))) {
256 if (lttng_strncpy(msg
.hostname
, hostname
, sizeof(msg
.hostname
))) {
260 msg
.live_timer
= htobe32(session_live_timer
);
261 msg
.snapshot
= htobe32(snapshot
);
264 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, &msg
, sizeof(msg
), 0);
269 /* Receive response */
270 ret
= recv_reply(rsock
, reply
, sizeof(*reply
));
274 reply
->session_id
= be64toh(reply
->session_id
);
275 reply
->ret_code
= be32toh(reply
->ret_code
);
281 * RELAYD_CREATE_SESSION from 2.1 to 2.3.
283 static int relayd_create_session_2_1(struct lttcomm_relayd_sock
*rsock
,
284 struct lttcomm_relayd_status_session
*reply
)
289 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, NULL
, 0, 0);
294 /* Receive response */
295 ret
= recv_reply(rsock
, reply
, sizeof(*reply
));
299 reply
->session_id
= be64toh(reply
->session_id
);
300 reply
->ret_code
= be32toh(reply
->ret_code
);
306 * Send a RELAYD_CREATE_SESSION command to the relayd with the given socket and
307 * set session_id of the relayd if we have a successful reply from the relayd.
309 * On success, return 0 else a negative value which is either an errno error or
310 * a lttng error code from the relayd.
312 int relayd_create_session(struct lttcomm_relayd_sock
*rsock
,
313 uint64_t *relayd_session_id
,
314 const char *session_name
, const char *hostname
,
315 const char *base_path
, int session_live_timer
,
316 unsigned int snapshot
, uint64_t sessiond_session_id
,
317 const lttng_uuid sessiond_uuid
,
318 const uint64_t *current_chunk_id
,
319 time_t creation_time
, bool session_name_contains_creation_time
,
323 struct lttcomm_relayd_create_session_reply_2_11 reply
= {};
326 assert(relayd_session_id
);
328 DBG("Relayd create session");
330 if (rsock
->minor
< 4) {
331 /* From 2.1 to 2.3 */
332 ret
= relayd_create_session_2_1(rsock
, &reply
.generic
);
333 } else if (rsock
->minor
>= 4 && rsock
->minor
< 11) {
334 /* From 2.4 to 2.10 */
335 ret
= relayd_create_session_2_4(rsock
, session_name
,
336 hostname
, session_live_timer
, snapshot
,
339 /* From 2.11 to ... */
340 ret
= relayd_create_session_2_11(rsock
, session_name
,
341 hostname
, base_path
, session_live_timer
, snapshot
,
342 sessiond_session_id
, sessiond_uuid
,
343 current_chunk_id
, creation_time
,
344 session_name_contains_creation_time
,
345 &reply
, output_path
);
352 /* Return session id or negative ret code. */
353 if (reply
.generic
.ret_code
!= LTTNG_OK
) {
355 ERR("Relayd create session replied error %d",
356 reply
.generic
.ret_code
);
360 *relayd_session_id
= reply
.generic
.session_id
;
363 DBG("Relayd session created with id %" PRIu64
, reply
.generic
.session_id
);
369 static int relayd_add_stream_2_1(struct lttcomm_relayd_sock
*rsock
,
370 const char *channel_name
, const char *pathname
)
373 struct lttcomm_relayd_add_stream msg
;
375 memset(&msg
, 0, sizeof(msg
));
376 if (lttng_strncpy(msg
.channel_name
, channel_name
,
377 sizeof(msg
.channel_name
))) {
382 if (lttng_strncpy(msg
.pathname
, pathname
,
383 sizeof(msg
.pathname
))) {
389 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg
, sizeof(msg
), 0);
399 static int relayd_add_stream_2_2(struct lttcomm_relayd_sock
*rsock
,
400 const char *channel_name
, const char *pathname
,
401 uint64_t tracefile_size
, uint64_t tracefile_count
)
404 struct lttcomm_relayd_add_stream_2_2 msg
;
406 memset(&msg
, 0, sizeof(msg
));
407 /* Compat with relayd 2.2 to 2.10 */
408 if (lttng_strncpy(msg
.channel_name
, channel_name
,
409 sizeof(msg
.channel_name
))) {
413 if (lttng_strncpy(msg
.pathname
, pathname
,
414 sizeof(msg
.pathname
))) {
418 msg
.tracefile_size
= htobe64(tracefile_size
);
419 msg
.tracefile_count
= htobe64(tracefile_count
);
422 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg
, sizeof(msg
), 0);
431 static int relayd_add_stream_2_11(struct lttcomm_relayd_sock
*rsock
,
432 const char *channel_name
, const char *pathname
,
433 uint64_t tracefile_size
, uint64_t tracefile_count
,
434 uint64_t trace_archive_id
)
437 struct lttcomm_relayd_add_stream_2_11
*msg
= NULL
;
438 size_t channel_name_len
;
442 /* The two names are sent with a '\0' delimiter between them. */
443 channel_name_len
= strlen(channel_name
) + 1;
444 pathname_len
= strlen(pathname
) + 1;
446 msg_length
= sizeof(*msg
) + channel_name_len
+ pathname_len
;
447 msg
= zmalloc(msg_length
);
449 PERROR("zmalloc add_stream_2_11 command message");
454 assert(channel_name_len
<= UINT32_MAX
);
455 msg
->channel_name_len
= htobe32(channel_name_len
);
457 assert(pathname_len
<= UINT32_MAX
);
458 msg
->pathname_len
= htobe32(pathname_len
);
460 if (lttng_strncpy(msg
->names
, channel_name
, channel_name_len
)) {
464 if (lttng_strncpy(msg
->names
+ channel_name_len
, pathname
, pathname_len
)) {
469 msg
->tracefile_size
= htobe64(tracefile_size
);
470 msg
->tracefile_count
= htobe64(tracefile_count
);
471 msg
->trace_chunk_id
= htobe64(trace_archive_id
);
474 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) msg
, msg_length
, 0);
485 * Add stream on the relayd and assign stream handle to the stream_id argument.
487 * Chunks are not supported by relayd prior to 2.11, but are used to
488 * internally between session daemon and consumer daemon to keep track
489 * of the channel and stream output path.
491 * On success return 0 else return ret_code negative value.
493 int relayd_add_stream(struct lttcomm_relayd_sock
*rsock
, const char *channel_name
,
494 const char *pathname
, uint64_t *stream_id
,
495 uint64_t tracefile_size
, uint64_t tracefile_count
,
496 struct lttng_trace_chunk
*trace_chunk
)
499 struct lttcomm_relayd_status_stream reply
;
501 /* Code flow error. Safety net. */
503 assert(channel_name
);
507 DBG("Relayd adding stream for channel name %s", channel_name
);
509 /* Compat with relayd 2.1 */
510 if (rsock
->minor
== 1) {
512 ret
= relayd_add_stream_2_1(rsock
, channel_name
, pathname
);
514 } else if (rsock
->minor
> 1 && rsock
->minor
< 11) {
515 /* From 2.2 to 2.10 */
516 ret
= relayd_add_stream_2_2(rsock
, channel_name
, pathname
,
517 tracefile_size
, tracefile_count
);
519 enum lttng_trace_chunk_status chunk_status
;
522 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
,
524 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
526 /* From 2.11 to ...*/
527 ret
= relayd_add_stream_2_11(rsock
, channel_name
, pathname
,
528 tracefile_size
, tracefile_count
,
537 /* Waiting for reply */
538 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
543 /* Back to host bytes order. */
544 reply
.handle
= be64toh(reply
.handle
);
545 reply
.ret_code
= be32toh(reply
.ret_code
);
547 /* Return session id or negative ret code. */
548 if (reply
.ret_code
!= LTTNG_OK
) {
550 ERR("Relayd add stream replied error %d", reply
.ret_code
);
554 *stream_id
= reply
.handle
;
557 DBG("Relayd stream added successfully with handle %" PRIu64
,
565 * Inform the relay that all the streams for the current channel has been sent.
567 * On success return 0 else return ret_code negative value.
569 int relayd_streams_sent(struct lttcomm_relayd_sock
*rsock
)
572 struct lttcomm_relayd_generic_reply reply
;
574 /* Code flow error. Safety net. */
577 DBG("Relayd sending streams sent.");
579 /* This feature was introduced in 2.4, ignore it for earlier versions. */
580 if (rsock
->minor
< 4) {
586 ret
= send_command(rsock
, RELAYD_STREAMS_SENT
, NULL
, 0, 0);
591 /* Waiting for reply */
592 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
597 /* Back to host bytes order. */
598 reply
.ret_code
= be32toh(reply
.ret_code
);
600 /* Return session id or negative ret code. */
601 if (reply
.ret_code
!= LTTNG_OK
) {
603 ERR("Relayd streams sent replied error %d", reply
.ret_code
);
610 DBG("Relayd streams sent success");
618 * Check version numbers on the relayd.
619 * If major versions are compatible, we assign minor_to_use to the
620 * minor version of the procotol we are going to use for this session.
622 * Return 0 if the two daemons are compatible, LTTNG_ERR_RELAYD_VERSION_FAIL
623 * otherwise, or a negative value on network errors.
625 int relayd_version_check(struct lttcomm_relayd_sock
*rsock
)
628 struct lttcomm_relayd_version msg
;
630 /* Code flow error. Safety net. */
633 DBG("Relayd version check for major.minor %u.%u", rsock
->major
,
636 memset(&msg
, 0, sizeof(msg
));
637 /* Prepare network byte order before transmission. */
638 msg
.major
= htobe32(rsock
->major
);
639 msg
.minor
= htobe32(rsock
->minor
);
642 ret
= send_command(rsock
, RELAYD_VERSION
, (void *) &msg
, sizeof(msg
), 0);
647 /* Receive response */
648 ret
= recv_reply(rsock
, (void *) &msg
, sizeof(msg
));
653 /* Set back to host bytes order */
654 msg
.major
= be32toh(msg
.major
);
655 msg
.minor
= be32toh(msg
.minor
);
658 * Only validate the major version. If the other side is higher,
659 * communication is not possible. Only major version equal can talk to each
660 * other. If the minor version differs, the lowest version is used by both
663 if (msg
.major
!= rsock
->major
) {
665 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
666 DBG2("Relayd version is NOT compatible. Relayd version %u != %u (us)",
667 msg
.major
, rsock
->major
);
672 * If the relayd's minor version is higher, it will adapt to our version so
673 * we can continue to use the latest relayd communication data structure.
674 * If the received minor version is higher, the relayd should adapt to us.
676 if (rsock
->minor
> msg
.minor
) {
677 rsock
->minor
= msg
.minor
;
680 /* Version number compatible */
681 DBG2("Relayd version is compatible, using protocol version %u.%u",
682 rsock
->major
, rsock
->minor
);
690 * Add stream on the relayd and assign stream handle to the stream_id argument.
692 * On success return 0 else return ret_code negative value.
694 int relayd_send_metadata(struct lttcomm_relayd_sock
*rsock
, size_t len
)
698 /* Code flow error. Safety net. */
701 DBG("Relayd sending metadata of size %zu", len
);
704 ret
= send_command(rsock
, RELAYD_SEND_METADATA
, NULL
, len
, 0);
709 DBG2("Relayd metadata added successfully");
712 * After that call, the metadata data MUST be sent to the relayd so the
713 * receive size on the other end matches the len of the metadata packet
714 * header. This is why we don't wait for a reply here.
722 * Connect to relay daemon with an allocated lttcomm_relayd_sock.
724 int relayd_connect(struct lttcomm_relayd_sock
*rsock
)
726 /* Code flow error. Safety net. */
729 if (!rsock
->sock
.ops
) {
731 * Attempting a connect on a non-initialized socket.
736 DBG3("Relayd connect ...");
738 return rsock
->sock
.ops
->connect(&rsock
->sock
);
742 * Close relayd socket with an allocated lttcomm_relayd_sock.
744 * If no socket operations are found, simply return 0 meaning that everything
745 * is fine. Without operations, the socket can not possibly be opened or used.
746 * This is possible if the socket was allocated but not created. However, the
747 * caller could simply use it to store a valid file descriptor for instance
748 * passed over a Unix socket and call this to cleanup but still without a valid
751 * Return the close returned value. On error, a negative value is usually
752 * returned back from close(2).
754 int relayd_close(struct lttcomm_relayd_sock
*rsock
)
758 /* Code flow error. Safety net. */
761 /* An invalid fd is fine, return success. */
762 if (rsock
->sock
.fd
< 0) {
767 DBG3("Relayd closing socket %d", rsock
->sock
.fd
);
769 if (rsock
->sock
.ops
) {
770 ret
= rsock
->sock
.ops
->close(&rsock
->sock
);
772 /* Default call if no specific ops found. */
773 ret
= close(rsock
->sock
.fd
);
775 PERROR("relayd_close default close");
785 * Send data header structure to the relayd.
787 int relayd_send_data_hdr(struct lttcomm_relayd_sock
*rsock
,
788 struct lttcomm_relayd_data_hdr
*hdr
, size_t size
)
792 /* Code flow error. Safety net. */
796 if (rsock
->sock
.fd
< 0) {
800 DBG3("Relayd sending data header of size %zu", size
);
802 /* Again, safety net */
804 size
= sizeof(struct lttcomm_relayd_data_hdr
);
807 /* Only send data header. */
808 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, hdr
, size
, 0);
815 * The data MUST be sent right after that command for the receive on the
816 * other end to match the size in the header.
824 * Send close stream command to the relayd.
826 int relayd_send_close_stream(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
827 uint64_t last_net_seq_num
)
830 struct lttcomm_relayd_close_stream msg
;
831 struct lttcomm_relayd_generic_reply reply
;
833 /* Code flow error. Safety net. */
836 DBG("Relayd closing stream id %" PRIu64
, stream_id
);
838 memset(&msg
, 0, sizeof(msg
));
839 msg
.stream_id
= htobe64(stream_id
);
840 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
843 ret
= send_command(rsock
, RELAYD_CLOSE_STREAM
, (void *) &msg
, sizeof(msg
), 0);
848 /* Receive response */
849 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
854 reply
.ret_code
= be32toh(reply
.ret_code
);
856 /* Return session id or negative ret code. */
857 if (reply
.ret_code
!= LTTNG_OK
) {
859 ERR("Relayd close stream replied error %d", reply
.ret_code
);
865 DBG("Relayd close stream id %" PRIu64
" successfully", stream_id
);
872 * Check for data availability for a given stream id.
874 * Return 0 if NOT pending, 1 if so and a negative value on error.
876 int relayd_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
877 uint64_t last_net_seq_num
)
880 struct lttcomm_relayd_data_pending msg
;
881 struct lttcomm_relayd_generic_reply reply
;
883 /* Code flow error. Safety net. */
886 DBG("Relayd data pending for stream id %" PRIu64
, stream_id
);
888 memset(&msg
, 0, sizeof(msg
));
889 msg
.stream_id
= htobe64(stream_id
);
890 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
893 ret
= send_command(rsock
, RELAYD_DATA_PENDING
, (void *) &msg
,
899 /* Receive response */
900 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
905 reply
.ret_code
= be32toh(reply
.ret_code
);
907 /* Return session id or negative ret code. */
908 if (reply
.ret_code
>= LTTNG_OK
) {
909 ERR("Relayd data pending replied error %d", reply
.ret_code
);
912 /* At this point, the ret code is either 1 or 0 */
913 ret
= reply
.ret_code
;
915 DBG("Relayd data is %s pending for stream id %" PRIu64
,
916 ret
== 1 ? "" : "NOT", stream_id
);
923 * Check on the relayd side for a quiescent state on the control socket.
925 int relayd_quiescent_control(struct lttcomm_relayd_sock
*rsock
,
926 uint64_t metadata_stream_id
)
929 struct lttcomm_relayd_quiescent_control msg
;
930 struct lttcomm_relayd_generic_reply reply
;
932 /* Code flow error. Safety net. */
935 DBG("Relayd checking quiescent control state");
937 memset(&msg
, 0, sizeof(msg
));
938 msg
.stream_id
= htobe64(metadata_stream_id
);
941 ret
= send_command(rsock
, RELAYD_QUIESCENT_CONTROL
, &msg
, sizeof(msg
), 0);
946 /* Receive response */
947 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
952 reply
.ret_code
= be32toh(reply
.ret_code
);
954 /* Return session id or negative ret code. */
955 if (reply
.ret_code
!= LTTNG_OK
) {
957 ERR("Relayd quiescent control replied error %d", reply
.ret_code
);
961 /* Control socket is quiescent */
969 * Begin a data pending command for a specific session id.
971 int relayd_begin_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
)
974 struct lttcomm_relayd_begin_data_pending msg
;
975 struct lttcomm_relayd_generic_reply reply
;
977 /* Code flow error. Safety net. */
980 DBG("Relayd begin data pending");
982 memset(&msg
, 0, sizeof(msg
));
983 msg
.session_id
= htobe64(id
);
986 ret
= send_command(rsock
, RELAYD_BEGIN_DATA_PENDING
, &msg
, sizeof(msg
), 0);
991 /* Receive response */
992 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
997 reply
.ret_code
= be32toh(reply
.ret_code
);
999 /* Return session id or negative ret code. */
1000 if (reply
.ret_code
!= LTTNG_OK
) {
1002 ERR("Relayd begin data pending replied error %d", reply
.ret_code
);
1013 * End a data pending command for a specific session id.
1015 * Return 0 on success and set is_data_inflight to 0 if no data is being
1016 * streamed or 1 if it is the case.
1018 int relayd_end_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
,
1019 unsigned int *is_data_inflight
)
1022 struct lttcomm_relayd_end_data_pending msg
;
1023 struct lttcomm_relayd_generic_reply reply
;
1025 /* Code flow error. Safety net. */
1028 DBG("Relayd end data pending");
1030 memset(&msg
, 0, sizeof(msg
));
1031 msg
.session_id
= htobe64(id
);
1034 ret
= send_command(rsock
, RELAYD_END_DATA_PENDING
, &msg
, sizeof(msg
), 0);
1039 /* Receive response */
1040 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1045 recv_ret
= be32toh(reply
.ret_code
);
1051 *is_data_inflight
= recv_ret
;
1053 DBG("Relayd end data pending is data inflight: %d", recv_ret
);
1062 * Send index to the relayd.
1064 int relayd_send_index(struct lttcomm_relayd_sock
*rsock
,
1065 struct ctf_packet_index
*index
, uint64_t relay_stream_id
,
1066 uint64_t net_seq_num
)
1069 struct lttcomm_relayd_index msg
;
1070 struct lttcomm_relayd_generic_reply reply
;
1072 /* Code flow error. Safety net. */
1075 if (rsock
->minor
< 4) {
1076 DBG("Not sending indexes before protocol 2.4");
1081 DBG("Relayd sending index for stream ID %" PRIu64
, relay_stream_id
);
1083 memset(&msg
, 0, sizeof(msg
));
1084 msg
.relay_stream_id
= htobe64(relay_stream_id
);
1085 msg
.net_seq_num
= htobe64(net_seq_num
);
1087 /* The index is already in big endian. */
1088 msg
.packet_size
= index
->packet_size
;
1089 msg
.content_size
= index
->content_size
;
1090 msg
.timestamp_begin
= index
->timestamp_begin
;
1091 msg
.timestamp_end
= index
->timestamp_end
;
1092 msg
.events_discarded
= index
->events_discarded
;
1093 msg
.stream_id
= index
->stream_id
;
1095 if (rsock
->minor
>= 8) {
1096 msg
.stream_instance_id
= index
->stream_instance_id
;
1097 msg
.packet_seq_num
= index
->packet_seq_num
;
1101 ret
= send_command(rsock
, RELAYD_SEND_INDEX
, &msg
,
1102 lttcomm_relayd_index_len(lttng_to_index_major(rsock
->major
,
1104 lttng_to_index_minor(rsock
->major
, rsock
->minor
)),
1110 /* Receive response */
1111 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1116 reply
.ret_code
= be32toh(reply
.ret_code
);
1118 /* Return session id or negative ret code. */
1119 if (reply
.ret_code
!= LTTNG_OK
) {
1121 ERR("Relayd send index replied error %d", reply
.ret_code
);
1132 * Ask the relay to reset the metadata trace file (regeneration).
1134 int relayd_reset_metadata(struct lttcomm_relayd_sock
*rsock
,
1135 uint64_t stream_id
, uint64_t version
)
1138 struct lttcomm_relayd_reset_metadata msg
;
1139 struct lttcomm_relayd_generic_reply reply
;
1141 /* Code flow error. Safety net. */
1144 /* Should have been prevented by the sessiond. */
1145 if (rsock
->minor
< 8) {
1146 ERR("Metadata regeneration unsupported before 2.8");
1151 DBG("Relayd reset metadata stream id %" PRIu64
, stream_id
);
1153 memset(&msg
, 0, sizeof(msg
));
1154 msg
.stream_id
= htobe64(stream_id
);
1155 msg
.version
= htobe64(version
);
1158 ret
= send_command(rsock
, RELAYD_RESET_METADATA
, (void *) &msg
, sizeof(msg
), 0);
1163 /* Receive response */
1164 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1169 reply
.ret_code
= be32toh(reply
.ret_code
);
1171 /* Return session id or negative ret code. */
1172 if (reply
.ret_code
!= LTTNG_OK
) {
1174 ERR("Relayd reset metadata replied error %d", reply
.ret_code
);
1180 DBG("Relayd reset metadata stream id %" PRIu64
" successfully", stream_id
);
1186 int relayd_rotate_streams(struct lttcomm_relayd_sock
*sock
,
1187 unsigned int stream_count
, const uint64_t *new_chunk_id
,
1188 const struct relayd_stream_rotation_position
*positions
)
1192 struct lttng_dynamic_buffer payload
;
1193 struct lttcomm_relayd_generic_reply reply
= {};
1194 const struct lttcomm_relayd_rotate_streams msg
= {
1195 .stream_count
= htobe32((uint32_t) stream_count
),
1196 .new_chunk_id
= (typeof(msg
.new_chunk_id
)) {
1197 .is_set
= !!new_chunk_id
,
1198 .value
= htobe64(new_chunk_id
? *new_chunk_id
: 0),
1201 char new_chunk_id_buf
[MAX_INT_DEC_LEN(*new_chunk_id
)] = {};
1202 const char *new_chunk_id_str
;
1204 if (!relayd_supports_chunks(sock
)) {
1205 DBG("Refusing to rotate remote streams: relayd does not support chunks");
1209 lttng_dynamic_buffer_init(&payload
);
1211 /* Code flow error. Safety net. */
1215 ret
= snprintf(new_chunk_id_buf
, sizeof(new_chunk_id_buf
),
1216 "%" PRIu64
, *new_chunk_id
);
1217 if (ret
== -1 || ret
>= sizeof(new_chunk_id_buf
)) {
1218 new_chunk_id_str
= "formatting error";
1220 new_chunk_id_str
= new_chunk_id_buf
;
1223 new_chunk_id_str
= "none";
1226 DBG("Preparing \"rotate streams\" command payload: new_chunk_id = %s, stream_count = %u",
1227 new_chunk_id_str
, stream_count
);
1229 ret
= lttng_dynamic_buffer_append(&payload
, &msg
, sizeof(msg
));
1231 ERR("Failed to allocate \"rotate streams\" command payload");
1235 for (i
= 0; i
< stream_count
; i
++) {
1236 const struct relayd_stream_rotation_position
*position
=
1238 const struct lttcomm_relayd_stream_rotation_position comm_position
= {
1239 .stream_id
= htobe64(position
->stream_id
),
1240 .rotate_at_seq_num
= htobe64(
1241 position
->rotate_at_seq_num
),
1244 DBG("Rotate stream %" PRIu64
"at sequence number %" PRIu64
,
1245 position
->stream_id
,
1246 position
->rotate_at_seq_num
);
1247 ret
= lttng_dynamic_buffer_append(&payload
, &comm_position
,
1248 sizeof(comm_position
));
1250 ERR("Failed to allocate \"rotate streams\" command payload");
1256 ret
= send_command(sock
, RELAYD_ROTATE_STREAMS
, payload
.data
,
1259 ERR("Failed to send \"rotate stream\" command");
1263 /* Receive response. */
1264 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1266 ERR("Failed to receive \"rotate streams\" command reply");
1270 reply
.ret_code
= be32toh(reply
.ret_code
);
1271 if (reply
.ret_code
!= LTTNG_OK
) {
1273 ERR("Relayd rotate streams replied error %d", reply
.ret_code
);
1277 DBG("Relayd rotated streams successfully");
1281 lttng_dynamic_buffer_reset(&payload
);
1285 int relayd_create_trace_chunk(struct lttcomm_relayd_sock
*sock
,
1286 struct lttng_trace_chunk
*chunk
)
1289 enum lttng_trace_chunk_status status
;
1290 struct lttcomm_relayd_create_trace_chunk msg
= {};
1291 struct lttcomm_relayd_generic_reply reply
= {};
1292 struct lttng_dynamic_buffer payload
;
1294 time_t creation_timestamp
;
1295 const char *chunk_name
;
1296 size_t chunk_name_length
;
1297 bool overridden_name
;
1299 lttng_dynamic_buffer_init(&payload
);
1301 if (!relayd_supports_chunks(sock
)) {
1302 DBG("Refusing to create remote trace chunk: relayd does not support chunks");
1306 status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1307 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1312 status
= lttng_trace_chunk_get_creation_timestamp(
1313 chunk
, &creation_timestamp
);
1314 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1319 status
= lttng_trace_chunk_get_name(
1320 chunk
, &chunk_name
, &overridden_name
);
1321 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
&&
1322 status
!= LTTNG_TRACE_CHUNK_STATUS_NONE
) {
1327 chunk_name_length
= overridden_name
? (strlen(chunk_name
) + 1) : 0;
1328 msg
= (typeof(msg
)){
1329 .chunk_id
= htobe64(chunk_id
),
1330 .creation_timestamp
= htobe64((uint64_t) creation_timestamp
),
1331 .override_name_length
= htobe32((uint32_t) chunk_name_length
),
1334 ret
= lttng_dynamic_buffer_append(&payload
, &msg
, sizeof(msg
));
1338 if (chunk_name_length
) {
1339 ret
= lttng_dynamic_buffer_append(
1340 &payload
, chunk_name
, chunk_name_length
);
1346 ret
= send_command(sock
, RELAYD_CREATE_TRACE_CHUNK
, payload
.data
,
1349 ERR("Failed to send trace chunk creation command to relay daemon");
1353 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1355 ERR("Failed to receive relay daemon trace chunk creation command reply");
1359 reply
.ret_code
= be32toh(reply
.ret_code
);
1360 if (reply
.ret_code
!= LTTNG_OK
) {
1362 ERR("Relayd trace chunk create replied error %d",
1366 DBG("Relayd successfully created trace chunk: chunk_id = %" PRIu64
,
1371 lttng_dynamic_buffer_reset(&payload
);
1375 int relayd_close_trace_chunk(struct lttcomm_relayd_sock
*sock
,
1376 struct lttng_trace_chunk
*chunk
,
1380 enum lttng_trace_chunk_status status
;
1381 struct lttcomm_relayd_close_trace_chunk msg
= {};
1382 struct lttcomm_relayd_close_trace_chunk_reply reply
= {};
1384 time_t close_timestamp
;
1385 LTTNG_OPTIONAL(enum lttng_trace_chunk_command_type
) close_command
= {};
1387 if (!relayd_supports_chunks(sock
)) {
1388 DBG("Refusing to close remote trace chunk: relayd does not support chunks");
1392 status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1393 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1394 ERR("Failed to get trace chunk id");
1399 status
= lttng_trace_chunk_get_close_timestamp(chunk
, &close_timestamp
);
1400 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1401 ERR("Failed to get trace chunk close timestamp");
1406 status
= lttng_trace_chunk_get_close_command(chunk
,
1407 &close_command
.value
);
1409 case LTTNG_TRACE_CHUNK_STATUS_OK
:
1410 close_command
.is_set
= 1;
1412 case LTTNG_TRACE_CHUNK_STATUS_NONE
:
1415 ERR("Failed to get trace chunk close command");
1420 msg
= (typeof(msg
)){
1421 .chunk_id
= htobe64(chunk_id
),
1422 .close_timestamp
= htobe64((uint64_t) close_timestamp
),
1424 .value
= htobe32((uint32_t) close_command
.value
),
1425 .is_set
= close_command
.is_set
,
1429 ret
= send_command(sock
, RELAYD_CLOSE_TRACE_CHUNK
, &msg
, sizeof(msg
),
1432 ERR("Failed to send trace chunk close command to relay daemon");
1436 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1438 ERR("Failed to receive relay daemon trace chunk close command reply");
1442 reply
.path_length
= be32toh(reply
.path_length
);
1443 if (reply
.path_length
>= LTTNG_PATH_MAX
) {
1444 ERR("Chunk path too long");
1449 ret
= recv_reply(sock
, path
, reply
.path_length
);
1451 ERR("Failed to receive relay daemon trace chunk close command reply");
1454 if (path
[reply
.path_length
- 1] != '\0') {
1455 ERR("Invalid trace chunk path returned by relay daemon (not null-terminated)");
1460 reply
.generic
.ret_code
= be32toh(reply
.generic
.ret_code
);
1461 if (reply
.generic
.ret_code
!= LTTNG_OK
) {
1463 ERR("Relayd trace chunk close replied error %d",
1464 reply
.generic
.ret_code
);
1467 DBG("Relayd successfully closed trace chunk: chunk_id = %" PRIu64
,
1474 int relayd_trace_chunk_exists(struct lttcomm_relayd_sock
*sock
,
1475 uint64_t chunk_id
, bool *chunk_exists
)
1478 struct lttcomm_relayd_trace_chunk_exists msg
= {};
1479 struct lttcomm_relayd_trace_chunk_exists_reply reply
= {};
1481 if (!relayd_supports_chunks(sock
)) {
1482 DBG("Refusing to check for trace chunk existence: relayd does not support chunks");
1483 /* The chunk will never exist */
1484 *chunk_exists
= false;
1488 msg
= (typeof(msg
)){
1489 .chunk_id
= htobe64(chunk_id
),
1492 ret
= send_command(sock
, RELAYD_TRACE_CHUNK_EXISTS
, &msg
, sizeof(msg
),
1495 ERR("Failed to send trace chunk exists command to relay daemon");
1499 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1501 ERR("Failed to receive relay daemon trace chunk close command reply");
1505 reply
.generic
.ret_code
= be32toh(reply
.generic
.ret_code
);
1506 if (reply
.generic
.ret_code
!= LTTNG_OK
) {
1508 ERR("Relayd trace chunk close replied error %d",
1509 reply
.generic
.ret_code
);
1512 DBG("Relayd successfully checked trace chunk existence: chunk_id = %" PRIu64
1513 ", exists = %s", chunk_id
,
1514 reply
.trace_chunk_exists
? "true" : "false");
1515 *chunk_exists
= !!reply
.trace_chunk_exists
;