2 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
16 #include <common/common.h>
17 #include <common/defaults.h>
18 #include <common/compat/endian.h>
19 #include <common/compat/string.h>
20 #include <common/sessiond-comm/relayd.h>
21 #include <common/index/ctf-index.h>
22 #include <common/trace-chunk.h>
23 #include <common/string-utils/format.h>
28 bool relayd_supports_chunks(const struct lttcomm_relayd_sock
*sock
)
30 if (sock
->major
> 2) {
32 } else if (sock
->major
== 2 && sock
->minor
>= 11) {
39 bool relayd_supports_get_configuration(const struct lttcomm_relayd_sock
*sock
)
41 if (sock
->major
> 2) {
43 } else if (sock
->major
== 2 && sock
->minor
>= 12) {
50 * Send command. Fill up the header and append the data.
52 static int send_command(struct lttcomm_relayd_sock
*rsock
,
53 enum lttcomm_relayd_command cmd
, const void *data
, size_t size
,
57 struct lttcomm_relayd_hdr header
;
59 uint64_t buf_size
= sizeof(header
);
61 if (rsock
->sock
.fd
< 0) {
69 buf
= zmalloc(buf_size
);
71 PERROR("zmalloc relayd send command buf");
76 memset(&header
, 0, sizeof(header
));
77 header
.cmd
= htobe32(cmd
);
78 header
.data_size
= htobe64(size
);
80 /* Zeroed for now since not used. */
81 header
.cmd_version
= 0;
82 header
.circuit_id
= 0;
84 /* Prepare buffer to send. */
85 memcpy(buf
, &header
, sizeof(header
));
87 memcpy(buf
+ sizeof(header
), data
, size
);
90 DBG3("Relayd sending command %d of size %" PRIu64
, (int) cmd
, buf_size
);
91 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, buf
, buf_size
, flags
);
93 PERROR("Failed to send command %d of size %" PRIu64
,
105 * Receive reply data on socket. This MUST be call after send_command or else
106 * could result in unexpected behavior(s).
108 static int recv_reply(struct lttcomm_relayd_sock
*rsock
, void *data
, size_t size
)
112 if (rsock
->sock
.fd
< 0) {
116 DBG3("Relayd waiting for reply of size %zu", size
);
118 ret
= rsock
->sock
.ops
->recvmsg(&rsock
->sock
, data
, size
, 0);
119 if (ret
<= 0 || ret
!= size
) {
121 /* Orderly shutdown. */
122 DBG("Socket %d has performed an orderly shutdown", rsock
->sock
.fd
);
124 DBG("Receiving reply failed on sock %d for size %zu with ret %d",
125 rsock
->sock
.fd
, size
, ret
);
127 /* Always return -1 here and the caller can use errno. */
137 * Starting from 2.11, RELAYD_CREATE_SESSION payload (session_name,
138 * hostname, and base_path) have no length restriction on the sender side.
139 * Length for both payloads is stored in the msg struct. A new dynamic size
140 * payload size is introduced.
142 static int relayd_create_session_2_11(struct lttcomm_relayd_sock
*rsock
,
143 const char *session_name
, const char *hostname
,
144 const char *base_path
, int session_live_timer
,
145 unsigned int snapshot
, uint64_t sessiond_session_id
,
146 const lttng_uuid sessiond_uuid
, const uint64_t *current_chunk_id
,
147 time_t creation_time
, bool session_name_contains_creation_time
,
148 struct lttcomm_relayd_create_session_reply_2_11
*reply
,
152 struct lttcomm_relayd_create_session_2_11
*msg
= NULL
;
153 size_t session_name_len
;
155 size_t base_path_len
;
162 /* The three names are sent with a '\0' delimiter between them. */
163 session_name_len
= strlen(session_name
) + 1;
164 hostname_len
= strlen(hostname
) + 1;
165 base_path_len
= strlen(base_path
) + 1;
167 msg_length
= sizeof(*msg
) + session_name_len
+ hostname_len
+ base_path_len
;
168 msg
= zmalloc(msg_length
);
170 PERROR("zmalloc create_session_2_11 command message");
175 assert(session_name_len
<= UINT32_MAX
);
176 msg
->session_name_len
= htobe32(session_name_len
);
178 assert(hostname_len
<= UINT32_MAX
);
179 msg
->hostname_len
= htobe32(hostname_len
);
181 assert(base_path_len
<= UINT32_MAX
);
182 msg
->base_path_len
= htobe32(base_path_len
);
185 if (lttng_strncpy(dst
, session_name
, session_name_len
)) {
189 dst
+= session_name_len
;
190 if (lttng_strncpy(dst
, hostname
, hostname_len
)) {
195 if (lttng_strncpy(dst
, base_path
, base_path_len
)) {
200 msg
->live_timer
= htobe32(session_live_timer
);
201 msg
->snapshot
= !!snapshot
;
203 lttng_uuid_copy(msg
->sessiond_uuid
, sessiond_uuid
);
204 msg
->session_id
= htobe64(sessiond_session_id
);
205 msg
->session_name_contains_creation_time
= session_name_contains_creation_time
;
206 if (current_chunk_id
) {
207 LTTNG_OPTIONAL_SET(&msg
->current_chunk_id
,
208 htobe64(*current_chunk_id
));
211 msg
->creation_time
= htobe64((uint64_t) creation_time
);
214 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, msg
, msg_length
, 0);
218 /* Receive response */
219 ret
= recv_reply(rsock
, reply
, sizeof(*reply
));
223 reply
->generic
.session_id
= be64toh(reply
->generic
.session_id
);
224 reply
->generic
.ret_code
= be32toh(reply
->generic
.ret_code
);
225 reply
->output_path_length
= be32toh(reply
->output_path_length
);
226 if (reply
->output_path_length
>= LTTNG_PATH_MAX
) {
227 ERR("Invalid session output path length in reply (%" PRIu32
" bytes) exceeds maximal allowed length (%d bytes)",
228 reply
->output_path_length
, LTTNG_PATH_MAX
);
232 ret
= recv_reply(rsock
, output_path
, reply
->output_path_length
);
241 * From 2.4 to 2.10, RELAYD_CREATE_SESSION takes additional parameters to
242 * support the live reading capability.
244 static int relayd_create_session_2_4(struct lttcomm_relayd_sock
*rsock
,
245 const char *session_name
, const char *hostname
,
246 int session_live_timer
, unsigned int snapshot
,
247 struct lttcomm_relayd_status_session
*reply
)
250 struct lttcomm_relayd_create_session_2_4 msg
;
252 if (lttng_strncpy(msg
.session_name
, session_name
,
253 sizeof(msg
.session_name
))) {
257 if (lttng_strncpy(msg
.hostname
, hostname
, sizeof(msg
.hostname
))) {
261 msg
.live_timer
= htobe32(session_live_timer
);
262 msg
.snapshot
= htobe32(snapshot
);
265 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, &msg
, sizeof(msg
), 0);
270 /* Receive response */
271 ret
= recv_reply(rsock
, reply
, sizeof(*reply
));
275 reply
->session_id
= be64toh(reply
->session_id
);
276 reply
->ret_code
= be32toh(reply
->ret_code
);
282 * RELAYD_CREATE_SESSION from 2.1 to 2.3.
284 static int relayd_create_session_2_1(struct lttcomm_relayd_sock
*rsock
,
285 struct lttcomm_relayd_status_session
*reply
)
290 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, NULL
, 0, 0);
295 /* Receive response */
296 ret
= recv_reply(rsock
, reply
, sizeof(*reply
));
300 reply
->session_id
= be64toh(reply
->session_id
);
301 reply
->ret_code
= be32toh(reply
->ret_code
);
307 * Send a RELAYD_CREATE_SESSION command to the relayd with the given socket and
308 * set session_id of the relayd if we have a successful reply from the relayd.
310 * On success, return 0 else a negative value which is either an errno error or
311 * a lttng error code from the relayd.
313 int relayd_create_session(struct lttcomm_relayd_sock
*rsock
,
314 uint64_t *relayd_session_id
,
315 const char *session_name
, const char *hostname
,
316 const char *base_path
, int session_live_timer
,
317 unsigned int snapshot
, uint64_t sessiond_session_id
,
318 const lttng_uuid sessiond_uuid
,
319 const uint64_t *current_chunk_id
,
320 time_t creation_time
, bool session_name_contains_creation_time
,
324 struct lttcomm_relayd_create_session_reply_2_11 reply
= {};
327 assert(relayd_session_id
);
329 DBG("Relayd create session");
331 if (rsock
->minor
< 4) {
332 /* From 2.1 to 2.3 */
333 ret
= relayd_create_session_2_1(rsock
, &reply
.generic
);
334 } else if (rsock
->minor
>= 4 && rsock
->minor
< 11) {
335 /* From 2.4 to 2.10 */
336 ret
= relayd_create_session_2_4(rsock
, session_name
,
337 hostname
, session_live_timer
, snapshot
,
340 /* From 2.11 to ... */
341 ret
= relayd_create_session_2_11(rsock
, session_name
,
342 hostname
, base_path
, session_live_timer
, snapshot
,
343 sessiond_session_id
, sessiond_uuid
,
344 current_chunk_id
, creation_time
,
345 session_name_contains_creation_time
,
346 &reply
, output_path
);
353 /* Return session id or negative ret code. */
354 if (reply
.generic
.ret_code
!= LTTNG_OK
) {
356 ERR("Relayd create session replied error %d",
357 reply
.generic
.ret_code
);
361 *relayd_session_id
= reply
.generic
.session_id
;
364 DBG("Relayd session created with id %" PRIu64
, reply
.generic
.session_id
);
370 static int relayd_add_stream_2_1(struct lttcomm_relayd_sock
*rsock
,
371 const char *channel_name
, const char *pathname
)
374 struct lttcomm_relayd_add_stream msg
;
376 memset(&msg
, 0, sizeof(msg
));
377 if (lttng_strncpy(msg
.channel_name
, channel_name
,
378 sizeof(msg
.channel_name
))) {
383 if (lttng_strncpy(msg
.pathname
, pathname
,
384 sizeof(msg
.pathname
))) {
390 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg
, sizeof(msg
), 0);
400 static int relayd_add_stream_2_2(struct lttcomm_relayd_sock
*rsock
,
401 const char *channel_name
, const char *pathname
,
402 uint64_t tracefile_size
, uint64_t tracefile_count
)
405 struct lttcomm_relayd_add_stream_2_2 msg
;
407 memset(&msg
, 0, sizeof(msg
));
408 /* Compat with relayd 2.2 to 2.10 */
409 if (lttng_strncpy(msg
.channel_name
, channel_name
,
410 sizeof(msg
.channel_name
))) {
414 if (lttng_strncpy(msg
.pathname
, pathname
,
415 sizeof(msg
.pathname
))) {
419 msg
.tracefile_size
= htobe64(tracefile_size
);
420 msg
.tracefile_count
= htobe64(tracefile_count
);
423 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg
, sizeof(msg
), 0);
432 static int relayd_add_stream_2_11(struct lttcomm_relayd_sock
*rsock
,
433 const char *channel_name
, const char *pathname
,
434 uint64_t tracefile_size
, uint64_t tracefile_count
,
435 uint64_t trace_archive_id
)
438 struct lttcomm_relayd_add_stream_2_11
*msg
= NULL
;
439 size_t channel_name_len
;
443 /* The two names are sent with a '\0' delimiter between them. */
444 channel_name_len
= strlen(channel_name
) + 1;
445 pathname_len
= strlen(pathname
) + 1;
447 msg_length
= sizeof(*msg
) + channel_name_len
+ pathname_len
;
448 msg
= zmalloc(msg_length
);
450 PERROR("zmalloc add_stream_2_11 command message");
455 assert(channel_name_len
<= UINT32_MAX
);
456 msg
->channel_name_len
= htobe32(channel_name_len
);
458 assert(pathname_len
<= UINT32_MAX
);
459 msg
->pathname_len
= htobe32(pathname_len
);
461 if (lttng_strncpy(msg
->names
, channel_name
, channel_name_len
)) {
465 if (lttng_strncpy(msg
->names
+ channel_name_len
, pathname
, pathname_len
)) {
470 msg
->tracefile_size
= htobe64(tracefile_size
);
471 msg
->tracefile_count
= htobe64(tracefile_count
);
472 msg
->trace_chunk_id
= htobe64(trace_archive_id
);
475 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) msg
, msg_length
, 0);
486 * Add stream on the relayd and assign stream handle to the stream_id argument.
488 * Chunks are not supported by relayd prior to 2.11, but are used to
489 * internally between session daemon and consumer daemon to keep track
490 * of the channel and stream output path.
492 * On success return 0 else return ret_code negative value.
494 int relayd_add_stream(struct lttcomm_relayd_sock
*rsock
, const char *channel_name
,
495 const char *domain_name
, const char *_pathname
, uint64_t *stream_id
,
496 uint64_t tracefile_size
, uint64_t tracefile_count
,
497 struct lttng_trace_chunk
*trace_chunk
)
500 struct lttcomm_relayd_status_stream reply
;
501 char pathname
[RELAYD_COMM_LTTNG_PATH_MAX
];
502 const char *separator
;
504 /* Code flow error. Safety net. */
506 assert(channel_name
);
511 DBG("Relayd adding stream for channel name %s", channel_name
);
513 if (_pathname
[0] == '\0') {
518 ret
= snprintf(pathname
, RELAYD_COMM_LTTNG_PATH_MAX
, "%s%s%s",
519 domain_name
, separator
, _pathname
);
520 if (ret
<= 0 || ret
>= RELAYD_COMM_LTTNG_PATH_MAX
) {
521 ERR("stream path too long.");
526 /* Compat with relayd 2.1 */
527 if (rsock
->minor
== 1) {
529 ret
= relayd_add_stream_2_1(rsock
, channel_name
, pathname
);
531 } else if (rsock
->minor
> 1 && rsock
->minor
< 11) {
532 /* From 2.2 to 2.10 */
533 ret
= relayd_add_stream_2_2(rsock
, channel_name
, pathname
,
534 tracefile_size
, tracefile_count
);
536 enum lttng_trace_chunk_status chunk_status
;
539 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
,
541 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
543 /* From 2.11 to ...*/
544 ret
= relayd_add_stream_2_11(rsock
, channel_name
, pathname
,
545 tracefile_size
, tracefile_count
,
554 /* Waiting for reply */
555 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
560 /* Back to host bytes order. */
561 reply
.handle
= be64toh(reply
.handle
);
562 reply
.ret_code
= be32toh(reply
.ret_code
);
564 /* Return session id or negative ret code. */
565 if (reply
.ret_code
!= LTTNG_OK
) {
567 ERR("Relayd add stream replied error %d", reply
.ret_code
);
571 *stream_id
= reply
.handle
;
574 DBG("Relayd stream added successfully with handle %" PRIu64
,
582 * Inform the relay that all the streams for the current channel has been sent.
584 * On success return 0 else return ret_code negative value.
586 int relayd_streams_sent(struct lttcomm_relayd_sock
*rsock
)
589 struct lttcomm_relayd_generic_reply reply
;
591 /* Code flow error. Safety net. */
594 DBG("Relayd sending streams sent.");
596 /* This feature was introduced in 2.4, ignore it for earlier versions. */
597 if (rsock
->minor
< 4) {
603 ret
= send_command(rsock
, RELAYD_STREAMS_SENT
, NULL
, 0, 0);
608 /* Waiting for reply */
609 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
614 /* Back to host bytes order. */
615 reply
.ret_code
= be32toh(reply
.ret_code
);
617 /* Return session id or negative ret code. */
618 if (reply
.ret_code
!= LTTNG_OK
) {
620 ERR("Relayd streams sent replied error %d", reply
.ret_code
);
627 DBG("Relayd streams sent success");
635 * Check version numbers on the relayd.
636 * If major versions are compatible, we assign minor_to_use to the
637 * minor version of the procotol we are going to use for this session.
639 * Return 0 if the two daemons are compatible, LTTNG_ERR_RELAYD_VERSION_FAIL
640 * otherwise, or a negative value on network errors.
642 int relayd_version_check(struct lttcomm_relayd_sock
*rsock
)
645 struct lttcomm_relayd_version msg
;
647 /* Code flow error. Safety net. */
650 DBG("Relayd version check for major.minor %u.%u", rsock
->major
,
653 memset(&msg
, 0, sizeof(msg
));
654 /* Prepare network byte order before transmission. */
655 msg
.major
= htobe32(rsock
->major
);
656 msg
.minor
= htobe32(rsock
->minor
);
659 ret
= send_command(rsock
, RELAYD_VERSION
, (void *) &msg
, sizeof(msg
), 0);
664 /* Receive response */
665 ret
= recv_reply(rsock
, (void *) &msg
, sizeof(msg
));
670 /* Set back to host bytes order */
671 msg
.major
= be32toh(msg
.major
);
672 msg
.minor
= be32toh(msg
.minor
);
675 * Only validate the major version. If the other side is higher,
676 * communication is not possible. Only major version equal can talk to each
677 * other. If the minor version differs, the lowest version is used by both
680 if (msg
.major
!= rsock
->major
) {
682 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
683 DBG2("Relayd version is NOT compatible. Relayd version %u != %u (us)",
684 msg
.major
, rsock
->major
);
689 * If the relayd's minor version is higher, it will adapt to our version so
690 * we can continue to use the latest relayd communication data structure.
691 * If the received minor version is higher, the relayd should adapt to us.
693 if (rsock
->minor
> msg
.minor
) {
694 rsock
->minor
= msg
.minor
;
697 /* Version number compatible */
698 DBG2("Relayd version is compatible, using protocol version %u.%u",
699 rsock
->major
, rsock
->minor
);
707 * Add stream on the relayd and assign stream handle to the stream_id argument.
709 * On success return 0 else return ret_code negative value.
711 int relayd_send_metadata(struct lttcomm_relayd_sock
*rsock
, size_t len
)
715 /* Code flow error. Safety net. */
718 DBG("Relayd sending metadata of size %zu", len
);
721 ret
= send_command(rsock
, RELAYD_SEND_METADATA
, NULL
, len
, 0);
726 DBG2("Relayd metadata added successfully");
729 * After that call, the metadata data MUST be sent to the relayd so the
730 * receive size on the other end matches the len of the metadata packet
731 * header. This is why we don't wait for a reply here.
739 * Connect to relay daemon with an allocated lttcomm_relayd_sock.
741 int relayd_connect(struct lttcomm_relayd_sock
*rsock
)
743 /* Code flow error. Safety net. */
746 if (!rsock
->sock
.ops
) {
748 * Attempting a connect on a non-initialized socket.
753 DBG3("Relayd connect ...");
755 return rsock
->sock
.ops
->connect(&rsock
->sock
);
759 * Close relayd socket with an allocated lttcomm_relayd_sock.
761 * If no socket operations are found, simply return 0 meaning that everything
762 * is fine. Without operations, the socket can not possibly be opened or used.
763 * This is possible if the socket was allocated but not created. However, the
764 * caller could simply use it to store a valid file descriptor for instance
765 * passed over a Unix socket and call this to cleanup but still without a valid
768 * Return the close returned value. On error, a negative value is usually
769 * returned back from close(2).
771 int relayd_close(struct lttcomm_relayd_sock
*rsock
)
775 /* Code flow error. Safety net. */
778 /* An invalid fd is fine, return success. */
779 if (rsock
->sock
.fd
< 0) {
784 DBG3("Relayd closing socket %d", rsock
->sock
.fd
);
786 if (rsock
->sock
.ops
) {
787 ret
= rsock
->sock
.ops
->close(&rsock
->sock
);
789 /* Default call if no specific ops found. */
790 ret
= close(rsock
->sock
.fd
);
792 PERROR("relayd_close default close");
802 * Send data header structure to the relayd.
804 int relayd_send_data_hdr(struct lttcomm_relayd_sock
*rsock
,
805 struct lttcomm_relayd_data_hdr
*hdr
, size_t size
)
809 /* Code flow error. Safety net. */
813 if (rsock
->sock
.fd
< 0) {
817 DBG3("Relayd sending data header of size %zu", size
);
819 /* Again, safety net */
821 size
= sizeof(struct lttcomm_relayd_data_hdr
);
824 /* Only send data header. */
825 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, hdr
, size
, 0);
832 * The data MUST be sent right after that command for the receive on the
833 * other end to match the size in the header.
841 * Send close stream command to the relayd.
843 int relayd_send_close_stream(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
844 uint64_t last_net_seq_num
)
847 struct lttcomm_relayd_close_stream msg
;
848 struct lttcomm_relayd_generic_reply reply
;
850 /* Code flow error. Safety net. */
853 DBG("Relayd closing stream id %" PRIu64
, stream_id
);
855 memset(&msg
, 0, sizeof(msg
));
856 msg
.stream_id
= htobe64(stream_id
);
857 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
860 ret
= send_command(rsock
, RELAYD_CLOSE_STREAM
, (void *) &msg
, sizeof(msg
), 0);
865 /* Receive response */
866 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
871 reply
.ret_code
= be32toh(reply
.ret_code
);
873 /* Return session id or negative ret code. */
874 if (reply
.ret_code
!= LTTNG_OK
) {
876 ERR("Relayd close stream replied error %d", reply
.ret_code
);
882 DBG("Relayd close stream id %" PRIu64
" successfully", stream_id
);
889 * Check for data availability for a given stream id.
891 * Return 0 if NOT pending, 1 if so and a negative value on error.
893 int relayd_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
894 uint64_t last_net_seq_num
)
897 struct lttcomm_relayd_data_pending msg
;
898 struct lttcomm_relayd_generic_reply reply
;
900 /* Code flow error. Safety net. */
903 DBG("Relayd data pending for stream id %" PRIu64
, stream_id
);
905 memset(&msg
, 0, sizeof(msg
));
906 msg
.stream_id
= htobe64(stream_id
);
907 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
910 ret
= send_command(rsock
, RELAYD_DATA_PENDING
, (void *) &msg
,
916 /* Receive response */
917 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
922 reply
.ret_code
= be32toh(reply
.ret_code
);
924 /* Return session id or negative ret code. */
925 if (reply
.ret_code
>= LTTNG_OK
) {
926 ERR("Relayd data pending replied error %d", reply
.ret_code
);
929 /* At this point, the ret code is either 1 or 0 */
930 ret
= reply
.ret_code
;
932 DBG("Relayd data is %s pending for stream id %" PRIu64
,
933 ret
== 1 ? "" : "NOT", stream_id
);
940 * Check on the relayd side for a quiescent state on the control socket.
942 int relayd_quiescent_control(struct lttcomm_relayd_sock
*rsock
,
943 uint64_t metadata_stream_id
)
946 struct lttcomm_relayd_quiescent_control msg
;
947 struct lttcomm_relayd_generic_reply reply
;
949 /* Code flow error. Safety net. */
952 DBG("Relayd checking quiescent control state");
954 memset(&msg
, 0, sizeof(msg
));
955 msg
.stream_id
= htobe64(metadata_stream_id
);
958 ret
= send_command(rsock
, RELAYD_QUIESCENT_CONTROL
, &msg
, sizeof(msg
), 0);
963 /* Receive response */
964 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
969 reply
.ret_code
= be32toh(reply
.ret_code
);
971 /* Return session id or negative ret code. */
972 if (reply
.ret_code
!= LTTNG_OK
) {
974 ERR("Relayd quiescent control replied error %d", reply
.ret_code
);
978 /* Control socket is quiescent */
986 * Begin a data pending command for a specific session id.
988 int relayd_begin_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
)
991 struct lttcomm_relayd_begin_data_pending msg
;
992 struct lttcomm_relayd_generic_reply reply
;
994 /* Code flow error. Safety net. */
997 DBG("Relayd begin data pending");
999 memset(&msg
, 0, sizeof(msg
));
1000 msg
.session_id
= htobe64(id
);
1003 ret
= send_command(rsock
, RELAYD_BEGIN_DATA_PENDING
, &msg
, sizeof(msg
), 0);
1008 /* Receive response */
1009 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1014 reply
.ret_code
= be32toh(reply
.ret_code
);
1016 /* Return session id or negative ret code. */
1017 if (reply
.ret_code
!= LTTNG_OK
) {
1019 ERR("Relayd begin data pending replied error %d", reply
.ret_code
);
1030 * End a data pending command for a specific session id.
1032 * Return 0 on success and set is_data_inflight to 0 if no data is being
1033 * streamed or 1 if it is the case.
1035 int relayd_end_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
,
1036 unsigned int *is_data_inflight
)
1039 struct lttcomm_relayd_end_data_pending msg
;
1040 struct lttcomm_relayd_generic_reply reply
;
1042 /* Code flow error. Safety net. */
1045 DBG("Relayd end data pending");
1047 memset(&msg
, 0, sizeof(msg
));
1048 msg
.session_id
= htobe64(id
);
1051 ret
= send_command(rsock
, RELAYD_END_DATA_PENDING
, &msg
, sizeof(msg
), 0);
1056 /* Receive response */
1057 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1062 recv_ret
= be32toh(reply
.ret_code
);
1068 *is_data_inflight
= recv_ret
;
1070 DBG("Relayd end data pending is data inflight: %d", recv_ret
);
1079 * Send index to the relayd.
1081 int relayd_send_index(struct lttcomm_relayd_sock
*rsock
,
1082 struct ctf_packet_index
*index
, uint64_t relay_stream_id
,
1083 uint64_t net_seq_num
)
1086 struct lttcomm_relayd_index msg
;
1087 struct lttcomm_relayd_generic_reply reply
;
1089 /* Code flow error. Safety net. */
1092 if (rsock
->minor
< 4) {
1093 DBG("Not sending indexes before protocol 2.4");
1098 DBG("Relayd sending index for stream ID %" PRIu64
, relay_stream_id
);
1100 memset(&msg
, 0, sizeof(msg
));
1101 msg
.relay_stream_id
= htobe64(relay_stream_id
);
1102 msg
.net_seq_num
= htobe64(net_seq_num
);
1104 /* The index is already in big endian. */
1105 msg
.packet_size
= index
->packet_size
;
1106 msg
.content_size
= index
->content_size
;
1107 msg
.timestamp_begin
= index
->timestamp_begin
;
1108 msg
.timestamp_end
= index
->timestamp_end
;
1109 msg
.events_discarded
= index
->events_discarded
;
1110 msg
.stream_id
= index
->stream_id
;
1112 if (rsock
->minor
>= 8) {
1113 msg
.stream_instance_id
= index
->stream_instance_id
;
1114 msg
.packet_seq_num
= index
->packet_seq_num
;
1118 ret
= send_command(rsock
, RELAYD_SEND_INDEX
, &msg
,
1119 lttcomm_relayd_index_len(lttng_to_index_major(rsock
->major
,
1121 lttng_to_index_minor(rsock
->major
, rsock
->minor
)),
1127 /* Receive response */
1128 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1133 reply
.ret_code
= be32toh(reply
.ret_code
);
1135 /* Return session id or negative ret code. */
1136 if (reply
.ret_code
!= LTTNG_OK
) {
1138 ERR("Relayd send index replied error %d", reply
.ret_code
);
1149 * Ask the relay to reset the metadata trace file (regeneration).
1151 int relayd_reset_metadata(struct lttcomm_relayd_sock
*rsock
,
1152 uint64_t stream_id
, uint64_t version
)
1155 struct lttcomm_relayd_reset_metadata msg
;
1156 struct lttcomm_relayd_generic_reply reply
;
1158 /* Code flow error. Safety net. */
1161 /* Should have been prevented by the sessiond. */
1162 if (rsock
->minor
< 8) {
1163 ERR("Metadata regeneration unsupported before 2.8");
1168 DBG("Relayd reset metadata stream id %" PRIu64
, stream_id
);
1170 memset(&msg
, 0, sizeof(msg
));
1171 msg
.stream_id
= htobe64(stream_id
);
1172 msg
.version
= htobe64(version
);
1175 ret
= send_command(rsock
, RELAYD_RESET_METADATA
, (void *) &msg
, sizeof(msg
), 0);
1180 /* Receive response */
1181 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1186 reply
.ret_code
= be32toh(reply
.ret_code
);
1188 /* Return session id or negative ret code. */
1189 if (reply
.ret_code
!= LTTNG_OK
) {
1191 ERR("Relayd reset metadata replied error %d", reply
.ret_code
);
1197 DBG("Relayd reset metadata stream id %" PRIu64
" successfully", stream_id
);
1203 int relayd_rotate_streams(struct lttcomm_relayd_sock
*sock
,
1204 unsigned int stream_count
, const uint64_t *new_chunk_id
,
1205 const struct relayd_stream_rotation_position
*positions
)
1209 struct lttng_dynamic_buffer payload
;
1210 struct lttcomm_relayd_generic_reply reply
= {};
1211 const struct lttcomm_relayd_rotate_streams msg
= {
1212 .stream_count
= htobe32((uint32_t) stream_count
),
1213 .new_chunk_id
= (typeof(msg
.new_chunk_id
)) {
1214 .is_set
= !!new_chunk_id
,
1215 .value
= htobe64(new_chunk_id
? *new_chunk_id
: 0),
1218 char new_chunk_id_buf
[MAX_INT_DEC_LEN(*new_chunk_id
)] = {};
1219 const char *new_chunk_id_str
;
1221 if (!relayd_supports_chunks(sock
)) {
1222 DBG("Refusing to rotate remote streams: relayd does not support chunks");
1226 lttng_dynamic_buffer_init(&payload
);
1228 /* Code flow error. Safety net. */
1232 ret
= snprintf(new_chunk_id_buf
, sizeof(new_chunk_id_buf
),
1233 "%" PRIu64
, *new_chunk_id
);
1234 if (ret
== -1 || ret
>= sizeof(new_chunk_id_buf
)) {
1235 new_chunk_id_str
= "formatting error";
1237 new_chunk_id_str
= new_chunk_id_buf
;
1240 new_chunk_id_str
= "none";
1243 DBG("Preparing \"rotate streams\" command payload: new_chunk_id = %s, stream_count = %u",
1244 new_chunk_id_str
, stream_count
);
1246 ret
= lttng_dynamic_buffer_append(&payload
, &msg
, sizeof(msg
));
1248 ERR("Failed to allocate \"rotate streams\" command payload");
1252 for (i
= 0; i
< stream_count
; i
++) {
1253 const struct relayd_stream_rotation_position
*position
=
1255 const struct lttcomm_relayd_stream_rotation_position comm_position
= {
1256 .stream_id
= htobe64(position
->stream_id
),
1257 .rotate_at_seq_num
= htobe64(
1258 position
->rotate_at_seq_num
),
1261 DBG("Rotate stream %" PRIu64
" at sequence number %" PRIu64
,
1262 position
->stream_id
,
1263 position
->rotate_at_seq_num
);
1264 ret
= lttng_dynamic_buffer_append(&payload
, &comm_position
,
1265 sizeof(comm_position
));
1267 ERR("Failed to allocate \"rotate streams\" command payload");
1273 ret
= send_command(sock
, RELAYD_ROTATE_STREAMS
, payload
.data
,
1276 ERR("Failed to send \"rotate stream\" command");
1280 /* Receive response. */
1281 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1283 ERR("Failed to receive \"rotate streams\" command reply");
1287 reply
.ret_code
= be32toh(reply
.ret_code
);
1288 if (reply
.ret_code
!= LTTNG_OK
) {
1290 ERR("Relayd rotate streams replied error %d", reply
.ret_code
);
1294 DBG("Relayd rotated streams successfully");
1298 lttng_dynamic_buffer_reset(&payload
);
1302 int relayd_create_trace_chunk(struct lttcomm_relayd_sock
*sock
,
1303 struct lttng_trace_chunk
*chunk
)
1306 enum lttng_trace_chunk_status status
;
1307 struct lttcomm_relayd_create_trace_chunk msg
= {};
1308 struct lttcomm_relayd_generic_reply reply
= {};
1309 struct lttng_dynamic_buffer payload
;
1311 time_t creation_timestamp
;
1312 const char *chunk_name
;
1313 size_t chunk_name_length
;
1314 bool overridden_name
;
1316 lttng_dynamic_buffer_init(&payload
);
1318 if (!relayd_supports_chunks(sock
)) {
1319 DBG("Refusing to create remote trace chunk: relayd does not support chunks");
1323 status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1324 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1329 status
= lttng_trace_chunk_get_creation_timestamp(
1330 chunk
, &creation_timestamp
);
1331 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1336 status
= lttng_trace_chunk_get_name(
1337 chunk
, &chunk_name
, &overridden_name
);
1338 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
&&
1339 status
!= LTTNG_TRACE_CHUNK_STATUS_NONE
) {
1344 chunk_name_length
= overridden_name
? (strlen(chunk_name
) + 1) : 0;
1345 msg
= (typeof(msg
)){
1346 .chunk_id
= htobe64(chunk_id
),
1347 .creation_timestamp
= htobe64((uint64_t) creation_timestamp
),
1348 .override_name_length
= htobe32((uint32_t) chunk_name_length
),
1351 ret
= lttng_dynamic_buffer_append(&payload
, &msg
, sizeof(msg
));
1355 if (chunk_name_length
) {
1356 ret
= lttng_dynamic_buffer_append(
1357 &payload
, chunk_name
, chunk_name_length
);
1363 ret
= send_command(sock
, RELAYD_CREATE_TRACE_CHUNK
, payload
.data
,
1366 ERR("Failed to send trace chunk creation command to relay daemon");
1370 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1372 ERR("Failed to receive relay daemon trace chunk creation command reply");
1376 reply
.ret_code
= be32toh(reply
.ret_code
);
1377 if (reply
.ret_code
!= LTTNG_OK
) {
1379 ERR("Relayd trace chunk create replied error %d",
1383 DBG("Relayd successfully created trace chunk: chunk_id = %" PRIu64
,
1388 lttng_dynamic_buffer_reset(&payload
);
1392 int relayd_close_trace_chunk(struct lttcomm_relayd_sock
*sock
,
1393 struct lttng_trace_chunk
*chunk
,
1397 enum lttng_trace_chunk_status status
;
1398 struct lttcomm_relayd_close_trace_chunk msg
= {};
1399 struct lttcomm_relayd_close_trace_chunk_reply reply
= {};
1401 time_t close_timestamp
;
1402 LTTNG_OPTIONAL(enum lttng_trace_chunk_command_type
) close_command
= {};
1404 if (!relayd_supports_chunks(sock
)) {
1405 DBG("Refusing to close remote trace chunk: relayd does not support chunks");
1409 status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1410 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1411 ERR("Failed to get trace chunk id");
1416 status
= lttng_trace_chunk_get_close_timestamp(chunk
, &close_timestamp
);
1417 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1418 ERR("Failed to get trace chunk close timestamp");
1423 status
= lttng_trace_chunk_get_close_command(chunk
,
1424 &close_command
.value
);
1426 case LTTNG_TRACE_CHUNK_STATUS_OK
:
1427 close_command
.is_set
= 1;
1429 case LTTNG_TRACE_CHUNK_STATUS_NONE
:
1432 ERR("Failed to get trace chunk close command");
1437 msg
= (typeof(msg
)){
1438 .chunk_id
= htobe64(chunk_id
),
1439 .close_timestamp
= htobe64((uint64_t) close_timestamp
),
1441 .value
= htobe32((uint32_t) close_command
.value
),
1442 .is_set
= close_command
.is_set
,
1446 ret
= send_command(sock
, RELAYD_CLOSE_TRACE_CHUNK
, &msg
, sizeof(msg
),
1449 ERR("Failed to send trace chunk close command to relay daemon");
1453 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1455 ERR("Failed to receive relay daemon trace chunk close command reply");
1459 reply
.path_length
= be32toh(reply
.path_length
);
1460 if (reply
.path_length
>= LTTNG_PATH_MAX
) {
1461 ERR("Chunk path too long");
1466 ret
= recv_reply(sock
, path
, reply
.path_length
);
1468 ERR("Failed to receive relay daemon trace chunk close command reply");
1471 if (path
[reply
.path_length
- 1] != '\0') {
1472 ERR("Invalid trace chunk path returned by relay daemon (not null-terminated)");
1477 reply
.generic
.ret_code
= be32toh(reply
.generic
.ret_code
);
1478 if (reply
.generic
.ret_code
!= LTTNG_OK
) {
1480 ERR("Relayd trace chunk close replied error %d",
1481 reply
.generic
.ret_code
);
1484 DBG("Relayd successfully closed trace chunk: chunk_id = %" PRIu64
,
1491 int relayd_trace_chunk_exists(struct lttcomm_relayd_sock
*sock
,
1492 uint64_t chunk_id
, bool *chunk_exists
)
1495 struct lttcomm_relayd_trace_chunk_exists msg
= {};
1496 struct lttcomm_relayd_trace_chunk_exists_reply reply
= {};
1498 if (!relayd_supports_chunks(sock
)) {
1499 DBG("Refusing to check for trace chunk existence: relayd does not support chunks");
1500 /* The chunk will never exist */
1501 *chunk_exists
= false;
1505 msg
= (typeof(msg
)){
1506 .chunk_id
= htobe64(chunk_id
),
1509 ret
= send_command(sock
, RELAYD_TRACE_CHUNK_EXISTS
, &msg
, sizeof(msg
),
1512 ERR("Failed to send trace chunk exists command to relay daemon");
1516 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1518 ERR("Failed to receive relay daemon trace chunk close command reply");
1522 reply
.generic
.ret_code
= be32toh(reply
.generic
.ret_code
);
1523 if (reply
.generic
.ret_code
!= LTTNG_OK
) {
1525 ERR("Relayd trace chunk close replied error %d",
1526 reply
.generic
.ret_code
);
1529 DBG("Relayd successfully checked trace chunk existence: chunk_id = %" PRIu64
1530 ", exists = %s", chunk_id
,
1531 reply
.trace_chunk_exists
? "true" : "false");
1532 *chunk_exists
= !!reply
.trace_chunk_exists
;
1538 int relayd_get_configuration(struct lttcomm_relayd_sock
*sock
,
1539 uint64_t query_flags
,
1540 uint64_t *result_flags
)
1543 struct lttcomm_relayd_get_configuration msg
= (typeof(msg
)) {
1544 .query_flags
= htobe64(query_flags
),
1546 struct lttcomm_relayd_get_configuration_reply reply
= {};
1548 if (!relayd_supports_get_configuration(sock
)) {
1549 DBG("Refusing to get relayd configuration (unsupported by relayd)");
1558 ret
= send_command(sock
, RELAYD_GET_CONFIGURATION
, &msg
, sizeof(msg
),
1561 ERR("Failed to send get configuration command to relay daemon");
1565 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1567 ERR("Failed to receive relay daemon get configuration command reply");
1571 reply
.generic
.ret_code
= be32toh(reply
.generic
.ret_code
);
1572 if (reply
.generic
.ret_code
!= LTTNG_OK
) {
1574 ERR("Relayd get configuration replied error %d",
1575 reply
.generic
.ret_code
);
1577 reply
.relayd_configuration_flags
=
1578 be64toh(reply
.relayd_configuration_flags
);
1580 DBG("Relayd successfully got configuration: query_flags = %" PRIu64
1581 ", results_flags = %" PRIu64
, query_flags
,
1582 reply
.relayd_configuration_flags
);
1583 *result_flags
= reply
.relayd_configuration_flags
;