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
];
503 /* Code flow error. Safety net. */
505 assert(channel_name
);
510 DBG("Relayd adding stream for channel name %s", channel_name
);
512 /* Compat with relayd 2.1 */
513 if (rsock
->minor
== 1) {
515 ret
= relayd_add_stream_2_1(rsock
, channel_name
, _pathname
);
517 } else if (rsock
->minor
> 1 && rsock
->minor
< 11) {
518 /* From 2.2 to 2.10 */
519 ret
= relayd_add_stream_2_2(rsock
, channel_name
, _pathname
,
520 tracefile_size
, tracefile_count
);
522 const char *separator
;
523 enum lttng_trace_chunk_status chunk_status
;
526 if (_pathname
[0] == '\0') {
532 ret
= snprintf(pathname
, RELAYD_COMM_LTTNG_PATH_MAX
, "%s%s%s",
533 domain_name
, separator
, _pathname
);
534 if (ret
<= 0 || ret
>= RELAYD_COMM_LTTNG_PATH_MAX
) {
535 ERR("Failed to format stream path: %s",
536 ret
<= 0 ? "formatting error" :
537 "path exceeds maximal allowed length");
542 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
,
544 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
546 /* From 2.11 to ...*/
547 ret
= relayd_add_stream_2_11(rsock
, channel_name
, pathname
,
548 tracefile_size
, tracefile_count
,
557 /* Waiting for reply */
558 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
563 /* Back to host bytes order. */
564 reply
.handle
= be64toh(reply
.handle
);
565 reply
.ret_code
= be32toh(reply
.ret_code
);
567 /* Return session id or negative ret code. */
568 if (reply
.ret_code
!= LTTNG_OK
) {
570 ERR("Relayd add stream replied error %d", reply
.ret_code
);
574 *stream_id
= reply
.handle
;
577 DBG("Relayd stream added successfully with handle %" PRIu64
,
585 * Inform the relay that all the streams for the current channel has been sent.
587 * On success return 0 else return ret_code negative value.
589 int relayd_streams_sent(struct lttcomm_relayd_sock
*rsock
)
592 struct lttcomm_relayd_generic_reply reply
;
594 /* Code flow error. Safety net. */
597 DBG("Relayd sending streams sent.");
599 /* This feature was introduced in 2.4, ignore it for earlier versions. */
600 if (rsock
->minor
< 4) {
606 ret
= send_command(rsock
, RELAYD_STREAMS_SENT
, NULL
, 0, 0);
611 /* Waiting for reply */
612 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
617 /* Back to host bytes order. */
618 reply
.ret_code
= be32toh(reply
.ret_code
);
620 /* Return session id or negative ret code. */
621 if (reply
.ret_code
!= LTTNG_OK
) {
623 ERR("Relayd streams sent replied error %d", reply
.ret_code
);
630 DBG("Relayd streams sent success");
638 * Check version numbers on the relayd.
639 * If major versions are compatible, we assign minor_to_use to the
640 * minor version of the procotol we are going to use for this session.
642 * Return 0 if the two daemons are compatible, LTTNG_ERR_RELAYD_VERSION_FAIL
643 * otherwise, or a negative value on network errors.
645 int relayd_version_check(struct lttcomm_relayd_sock
*rsock
)
648 struct lttcomm_relayd_version msg
;
650 /* Code flow error. Safety net. */
653 DBG("Relayd version check for major.minor %u.%u", rsock
->major
,
656 memset(&msg
, 0, sizeof(msg
));
657 /* Prepare network byte order before transmission. */
658 msg
.major
= htobe32(rsock
->major
);
659 msg
.minor
= htobe32(rsock
->minor
);
662 ret
= send_command(rsock
, RELAYD_VERSION
, (void *) &msg
, sizeof(msg
), 0);
667 /* Receive response */
668 ret
= recv_reply(rsock
, (void *) &msg
, sizeof(msg
));
673 /* Set back to host bytes order */
674 msg
.major
= be32toh(msg
.major
);
675 msg
.minor
= be32toh(msg
.minor
);
678 * Only validate the major version. If the other side is higher,
679 * communication is not possible. Only major version equal can talk to each
680 * other. If the minor version differs, the lowest version is used by both
683 if (msg
.major
!= rsock
->major
) {
685 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
686 DBG2("Relayd version is NOT compatible. Relayd version %u != %u (us)",
687 msg
.major
, rsock
->major
);
692 * If the relayd's minor version is higher, it will adapt to our version so
693 * we can continue to use the latest relayd communication data structure.
694 * If the received minor version is higher, the relayd should adapt to us.
696 if (rsock
->minor
> msg
.minor
) {
697 rsock
->minor
= msg
.minor
;
700 /* Version number compatible */
701 DBG2("Relayd version is compatible, using protocol version %u.%u",
702 rsock
->major
, rsock
->minor
);
710 * Add stream on the relayd and assign stream handle to the stream_id argument.
712 * On success return 0 else return ret_code negative value.
714 int relayd_send_metadata(struct lttcomm_relayd_sock
*rsock
, size_t len
)
718 /* Code flow error. Safety net. */
721 DBG("Relayd sending metadata of size %zu", len
);
724 ret
= send_command(rsock
, RELAYD_SEND_METADATA
, NULL
, len
, 0);
729 DBG2("Relayd metadata added successfully");
732 * After that call, the metadata data MUST be sent to the relayd so the
733 * receive size on the other end matches the len of the metadata packet
734 * header. This is why we don't wait for a reply here.
742 * Connect to relay daemon with an allocated lttcomm_relayd_sock.
744 int relayd_connect(struct lttcomm_relayd_sock
*rsock
)
746 /* Code flow error. Safety net. */
749 if (!rsock
->sock
.ops
) {
751 * Attempting a connect on a non-initialized socket.
756 DBG3("Relayd connect ...");
758 return rsock
->sock
.ops
->connect(&rsock
->sock
);
762 * Close relayd socket with an allocated lttcomm_relayd_sock.
764 * If no socket operations are found, simply return 0 meaning that everything
765 * is fine. Without operations, the socket can not possibly be opened or used.
766 * This is possible if the socket was allocated but not created. However, the
767 * caller could simply use it to store a valid file descriptor for instance
768 * passed over a Unix socket and call this to cleanup but still without a valid
771 * Return the close returned value. On error, a negative value is usually
772 * returned back from close(2).
774 int relayd_close(struct lttcomm_relayd_sock
*rsock
)
778 /* Code flow error. Safety net. */
781 /* An invalid fd is fine, return success. */
782 if (rsock
->sock
.fd
< 0) {
787 DBG3("Relayd closing socket %d", rsock
->sock
.fd
);
789 if (rsock
->sock
.ops
) {
790 ret
= rsock
->sock
.ops
->close(&rsock
->sock
);
792 /* Default call if no specific ops found. */
793 ret
= close(rsock
->sock
.fd
);
795 PERROR("relayd_close default close");
805 * Send data header structure to the relayd.
807 int relayd_send_data_hdr(struct lttcomm_relayd_sock
*rsock
,
808 struct lttcomm_relayd_data_hdr
*hdr
, size_t size
)
812 /* Code flow error. Safety net. */
816 if (rsock
->sock
.fd
< 0) {
820 DBG3("Relayd sending data header of size %zu", size
);
822 /* Again, safety net */
824 size
= sizeof(struct lttcomm_relayd_data_hdr
);
827 /* Only send data header. */
828 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, hdr
, size
, 0);
835 * The data MUST be sent right after that command for the receive on the
836 * other end to match the size in the header.
844 * Send close stream command to the relayd.
846 int relayd_send_close_stream(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
847 uint64_t last_net_seq_num
)
850 struct lttcomm_relayd_close_stream msg
;
851 struct lttcomm_relayd_generic_reply reply
;
853 /* Code flow error. Safety net. */
856 DBG("Relayd closing stream id %" PRIu64
, stream_id
);
858 memset(&msg
, 0, sizeof(msg
));
859 msg
.stream_id
= htobe64(stream_id
);
860 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
863 ret
= send_command(rsock
, RELAYD_CLOSE_STREAM
, (void *) &msg
, sizeof(msg
), 0);
868 /* Receive response */
869 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
874 reply
.ret_code
= be32toh(reply
.ret_code
);
876 /* Return session id or negative ret code. */
877 if (reply
.ret_code
!= LTTNG_OK
) {
879 ERR("Relayd close stream replied error %d", reply
.ret_code
);
885 DBG("Relayd close stream id %" PRIu64
" successfully", stream_id
);
892 * Check for data availability for a given stream id.
894 * Return 0 if NOT pending, 1 if so and a negative value on error.
896 int relayd_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
897 uint64_t last_net_seq_num
)
900 struct lttcomm_relayd_data_pending msg
;
901 struct lttcomm_relayd_generic_reply reply
;
903 /* Code flow error. Safety net. */
906 DBG("Relayd data pending for stream id %" PRIu64
, stream_id
);
908 memset(&msg
, 0, sizeof(msg
));
909 msg
.stream_id
= htobe64(stream_id
);
910 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
913 ret
= send_command(rsock
, RELAYD_DATA_PENDING
, (void *) &msg
,
919 /* Receive response */
920 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
925 reply
.ret_code
= be32toh(reply
.ret_code
);
927 /* Return session id or negative ret code. */
928 if (reply
.ret_code
>= LTTNG_OK
) {
929 ERR("Relayd data pending replied error %d", reply
.ret_code
);
932 /* At this point, the ret code is either 1 or 0 */
933 ret
= reply
.ret_code
;
935 DBG("Relayd data is %s pending for stream id %" PRIu64
,
936 ret
== 1 ? "" : "NOT", stream_id
);
943 * Check on the relayd side for a quiescent state on the control socket.
945 int relayd_quiescent_control(struct lttcomm_relayd_sock
*rsock
,
946 uint64_t metadata_stream_id
)
949 struct lttcomm_relayd_quiescent_control msg
;
950 struct lttcomm_relayd_generic_reply reply
;
952 /* Code flow error. Safety net. */
955 DBG("Relayd checking quiescent control state");
957 memset(&msg
, 0, sizeof(msg
));
958 msg
.stream_id
= htobe64(metadata_stream_id
);
961 ret
= send_command(rsock
, RELAYD_QUIESCENT_CONTROL
, &msg
, sizeof(msg
), 0);
966 /* Receive response */
967 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
972 reply
.ret_code
= be32toh(reply
.ret_code
);
974 /* Return session id or negative ret code. */
975 if (reply
.ret_code
!= LTTNG_OK
) {
977 ERR("Relayd quiescent control replied error %d", reply
.ret_code
);
981 /* Control socket is quiescent */
989 * Begin a data pending command for a specific session id.
991 int relayd_begin_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
)
994 struct lttcomm_relayd_begin_data_pending msg
;
995 struct lttcomm_relayd_generic_reply reply
;
997 /* Code flow error. Safety net. */
1000 DBG("Relayd begin data pending");
1002 memset(&msg
, 0, sizeof(msg
));
1003 msg
.session_id
= htobe64(id
);
1006 ret
= send_command(rsock
, RELAYD_BEGIN_DATA_PENDING
, &msg
, sizeof(msg
), 0);
1011 /* Receive response */
1012 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1017 reply
.ret_code
= be32toh(reply
.ret_code
);
1019 /* Return session id or negative ret code. */
1020 if (reply
.ret_code
!= LTTNG_OK
) {
1022 ERR("Relayd begin data pending replied error %d", reply
.ret_code
);
1033 * End a data pending command for a specific session id.
1035 * Return 0 on success and set is_data_inflight to 0 if no data is being
1036 * streamed or 1 if it is the case.
1038 int relayd_end_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
,
1039 unsigned int *is_data_inflight
)
1042 struct lttcomm_relayd_end_data_pending msg
;
1043 struct lttcomm_relayd_generic_reply reply
;
1045 /* Code flow error. Safety net. */
1048 DBG("Relayd end data pending");
1050 memset(&msg
, 0, sizeof(msg
));
1051 msg
.session_id
= htobe64(id
);
1054 ret
= send_command(rsock
, RELAYD_END_DATA_PENDING
, &msg
, sizeof(msg
), 0);
1059 /* Receive response */
1060 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1065 recv_ret
= be32toh(reply
.ret_code
);
1071 *is_data_inflight
= recv_ret
;
1073 DBG("Relayd end data pending is data inflight: %d", recv_ret
);
1082 * Send index to the relayd.
1084 int relayd_send_index(struct lttcomm_relayd_sock
*rsock
,
1085 struct ctf_packet_index
*index
, uint64_t relay_stream_id
,
1086 uint64_t net_seq_num
)
1089 struct lttcomm_relayd_index msg
;
1090 struct lttcomm_relayd_generic_reply reply
;
1092 /* Code flow error. Safety net. */
1095 if (rsock
->minor
< 4) {
1096 DBG("Not sending indexes before protocol 2.4");
1101 DBG("Relayd sending index for stream ID %" PRIu64
, relay_stream_id
);
1103 memset(&msg
, 0, sizeof(msg
));
1104 msg
.relay_stream_id
= htobe64(relay_stream_id
);
1105 msg
.net_seq_num
= htobe64(net_seq_num
);
1107 /* The index is already in big endian. */
1108 msg
.packet_size
= index
->packet_size
;
1109 msg
.content_size
= index
->content_size
;
1110 msg
.timestamp_begin
= index
->timestamp_begin
;
1111 msg
.timestamp_end
= index
->timestamp_end
;
1112 msg
.events_discarded
= index
->events_discarded
;
1113 msg
.stream_id
= index
->stream_id
;
1115 if (rsock
->minor
>= 8) {
1116 msg
.stream_instance_id
= index
->stream_instance_id
;
1117 msg
.packet_seq_num
= index
->packet_seq_num
;
1121 ret
= send_command(rsock
, RELAYD_SEND_INDEX
, &msg
,
1122 lttcomm_relayd_index_len(lttng_to_index_major(rsock
->major
,
1124 lttng_to_index_minor(rsock
->major
, rsock
->minor
)),
1130 /* Receive response */
1131 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1136 reply
.ret_code
= be32toh(reply
.ret_code
);
1138 /* Return session id or negative ret code. */
1139 if (reply
.ret_code
!= LTTNG_OK
) {
1141 ERR("Relayd send index replied error %d", reply
.ret_code
);
1152 * Ask the relay to reset the metadata trace file (regeneration).
1154 int relayd_reset_metadata(struct lttcomm_relayd_sock
*rsock
,
1155 uint64_t stream_id
, uint64_t version
)
1158 struct lttcomm_relayd_reset_metadata msg
;
1159 struct lttcomm_relayd_generic_reply reply
;
1161 /* Code flow error. Safety net. */
1164 /* Should have been prevented by the sessiond. */
1165 if (rsock
->minor
< 8) {
1166 ERR("Metadata regeneration unsupported before 2.8");
1171 DBG("Relayd reset metadata stream id %" PRIu64
, stream_id
);
1173 memset(&msg
, 0, sizeof(msg
));
1174 msg
.stream_id
= htobe64(stream_id
);
1175 msg
.version
= htobe64(version
);
1178 ret
= send_command(rsock
, RELAYD_RESET_METADATA
, (void *) &msg
, sizeof(msg
), 0);
1183 /* Receive response */
1184 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1189 reply
.ret_code
= be32toh(reply
.ret_code
);
1191 /* Return session id or negative ret code. */
1192 if (reply
.ret_code
!= LTTNG_OK
) {
1194 ERR("Relayd reset metadata replied error %d", reply
.ret_code
);
1200 DBG("Relayd reset metadata stream id %" PRIu64
" successfully", stream_id
);
1206 int relayd_rotate_streams(struct lttcomm_relayd_sock
*sock
,
1207 unsigned int stream_count
, const uint64_t *new_chunk_id
,
1208 const struct relayd_stream_rotation_position
*positions
)
1212 struct lttng_dynamic_buffer payload
;
1213 struct lttcomm_relayd_generic_reply reply
= {};
1214 const struct lttcomm_relayd_rotate_streams msg
= {
1215 .stream_count
= htobe32((uint32_t) stream_count
),
1216 .new_chunk_id
= (typeof(msg
.new_chunk_id
)) {
1217 .is_set
= !!new_chunk_id
,
1218 .value
= htobe64(new_chunk_id
? *new_chunk_id
: 0),
1221 char new_chunk_id_buf
[MAX_INT_DEC_LEN(*new_chunk_id
)] = {};
1222 const char *new_chunk_id_str
;
1224 if (!relayd_supports_chunks(sock
)) {
1225 DBG("Refusing to rotate remote streams: relayd does not support chunks");
1229 lttng_dynamic_buffer_init(&payload
);
1231 /* Code flow error. Safety net. */
1235 ret
= snprintf(new_chunk_id_buf
, sizeof(new_chunk_id_buf
),
1236 "%" PRIu64
, *new_chunk_id
);
1237 if (ret
== -1 || ret
>= sizeof(new_chunk_id_buf
)) {
1238 new_chunk_id_str
= "formatting error";
1240 new_chunk_id_str
= new_chunk_id_buf
;
1243 new_chunk_id_str
= "none";
1246 DBG("Preparing \"rotate streams\" command payload: new_chunk_id = %s, stream_count = %u",
1247 new_chunk_id_str
, stream_count
);
1249 ret
= lttng_dynamic_buffer_append(&payload
, &msg
, sizeof(msg
));
1251 ERR("Failed to allocate \"rotate streams\" command payload");
1255 for (i
= 0; i
< stream_count
; i
++) {
1256 const struct relayd_stream_rotation_position
*position
=
1258 const struct lttcomm_relayd_stream_rotation_position comm_position
= {
1259 .stream_id
= htobe64(position
->stream_id
),
1260 .rotate_at_seq_num
= htobe64(
1261 position
->rotate_at_seq_num
),
1264 DBG("Rotate stream %" PRIu64
" at sequence number %" PRIu64
,
1265 position
->stream_id
,
1266 position
->rotate_at_seq_num
);
1267 ret
= lttng_dynamic_buffer_append(&payload
, &comm_position
,
1268 sizeof(comm_position
));
1270 ERR("Failed to allocate \"rotate streams\" command payload");
1276 ret
= send_command(sock
, RELAYD_ROTATE_STREAMS
, payload
.data
,
1279 ERR("Failed to send \"rotate stream\" command");
1283 /* Receive response. */
1284 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1286 ERR("Failed to receive \"rotate streams\" command reply");
1290 reply
.ret_code
= be32toh(reply
.ret_code
);
1291 if (reply
.ret_code
!= LTTNG_OK
) {
1293 ERR("Relayd rotate streams replied error %d", reply
.ret_code
);
1297 DBG("Relayd rotated streams successfully");
1301 lttng_dynamic_buffer_reset(&payload
);
1305 int relayd_create_trace_chunk(struct lttcomm_relayd_sock
*sock
,
1306 struct lttng_trace_chunk
*chunk
)
1309 enum lttng_trace_chunk_status status
;
1310 struct lttcomm_relayd_create_trace_chunk msg
= {};
1311 struct lttcomm_relayd_generic_reply reply
= {};
1312 struct lttng_dynamic_buffer payload
;
1314 time_t creation_timestamp
;
1315 const char *chunk_name
;
1316 size_t chunk_name_length
;
1317 bool overridden_name
;
1319 lttng_dynamic_buffer_init(&payload
);
1321 if (!relayd_supports_chunks(sock
)) {
1322 DBG("Refusing to create remote trace chunk: relayd does not support chunks");
1326 status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1327 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1332 status
= lttng_trace_chunk_get_creation_timestamp(
1333 chunk
, &creation_timestamp
);
1334 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1339 status
= lttng_trace_chunk_get_name(
1340 chunk
, &chunk_name
, &overridden_name
);
1341 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
&&
1342 status
!= LTTNG_TRACE_CHUNK_STATUS_NONE
) {
1347 chunk_name_length
= overridden_name
? (strlen(chunk_name
) + 1) : 0;
1348 msg
= (typeof(msg
)){
1349 .chunk_id
= htobe64(chunk_id
),
1350 .creation_timestamp
= htobe64((uint64_t) creation_timestamp
),
1351 .override_name_length
= htobe32((uint32_t) chunk_name_length
),
1354 ret
= lttng_dynamic_buffer_append(&payload
, &msg
, sizeof(msg
));
1358 if (chunk_name_length
) {
1359 ret
= lttng_dynamic_buffer_append(
1360 &payload
, chunk_name
, chunk_name_length
);
1366 ret
= send_command(sock
, RELAYD_CREATE_TRACE_CHUNK
, payload
.data
,
1369 ERR("Failed to send trace chunk creation command to relay daemon");
1373 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1375 ERR("Failed to receive relay daemon trace chunk creation command reply");
1379 reply
.ret_code
= be32toh(reply
.ret_code
);
1380 if (reply
.ret_code
!= LTTNG_OK
) {
1382 ERR("Relayd trace chunk create replied error %d",
1386 DBG("Relayd successfully created trace chunk: chunk_id = %" PRIu64
,
1391 lttng_dynamic_buffer_reset(&payload
);
1395 int relayd_close_trace_chunk(struct lttcomm_relayd_sock
*sock
,
1396 struct lttng_trace_chunk
*chunk
,
1400 enum lttng_trace_chunk_status status
;
1401 struct lttcomm_relayd_close_trace_chunk msg
= {};
1402 struct lttcomm_relayd_close_trace_chunk_reply reply
= {};
1404 time_t close_timestamp
;
1405 LTTNG_OPTIONAL(enum lttng_trace_chunk_command_type
) close_command
= {};
1407 if (!relayd_supports_chunks(sock
)) {
1408 DBG("Refusing to close remote trace chunk: relayd does not support chunks");
1412 status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1413 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1414 ERR("Failed to get trace chunk id");
1419 status
= lttng_trace_chunk_get_close_timestamp(chunk
, &close_timestamp
);
1420 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1421 ERR("Failed to get trace chunk close timestamp");
1426 status
= lttng_trace_chunk_get_close_command(chunk
,
1427 &close_command
.value
);
1429 case LTTNG_TRACE_CHUNK_STATUS_OK
:
1430 close_command
.is_set
= 1;
1432 case LTTNG_TRACE_CHUNK_STATUS_NONE
:
1435 ERR("Failed to get trace chunk close command");
1440 msg
= (typeof(msg
)){
1441 .chunk_id
= htobe64(chunk_id
),
1442 .close_timestamp
= htobe64((uint64_t) close_timestamp
),
1444 .value
= htobe32((uint32_t) close_command
.value
),
1445 .is_set
= close_command
.is_set
,
1449 ret
= send_command(sock
, RELAYD_CLOSE_TRACE_CHUNK
, &msg
, sizeof(msg
),
1452 ERR("Failed to send trace chunk close command to relay daemon");
1456 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1458 ERR("Failed to receive relay daemon trace chunk close command reply");
1462 reply
.path_length
= be32toh(reply
.path_length
);
1463 if (reply
.path_length
>= LTTNG_PATH_MAX
) {
1464 ERR("Chunk path too long");
1469 ret
= recv_reply(sock
, path
, reply
.path_length
);
1471 ERR("Failed to receive relay daemon trace chunk close command reply");
1474 if (path
[reply
.path_length
- 1] != '\0') {
1475 ERR("Invalid trace chunk path returned by relay daemon (not null-terminated)");
1480 reply
.generic
.ret_code
= be32toh(reply
.generic
.ret_code
);
1481 if (reply
.generic
.ret_code
!= LTTNG_OK
) {
1483 ERR("Relayd trace chunk close replied error %d",
1484 reply
.generic
.ret_code
);
1487 DBG("Relayd successfully closed trace chunk: chunk_id = %" PRIu64
,
1494 int relayd_trace_chunk_exists(struct lttcomm_relayd_sock
*sock
,
1495 uint64_t chunk_id
, bool *chunk_exists
)
1498 struct lttcomm_relayd_trace_chunk_exists msg
= {};
1499 struct lttcomm_relayd_trace_chunk_exists_reply reply
= {};
1501 if (!relayd_supports_chunks(sock
)) {
1502 DBG("Refusing to check for trace chunk existence: relayd does not support chunks");
1503 /* The chunk will never exist */
1504 *chunk_exists
= false;
1508 msg
= (typeof(msg
)){
1509 .chunk_id
= htobe64(chunk_id
),
1512 ret
= send_command(sock
, RELAYD_TRACE_CHUNK_EXISTS
, &msg
, sizeof(msg
),
1515 ERR("Failed to send trace chunk exists command to relay daemon");
1519 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1521 ERR("Failed to receive relay daemon trace chunk close command reply");
1525 reply
.generic
.ret_code
= be32toh(reply
.generic
.ret_code
);
1526 if (reply
.generic
.ret_code
!= LTTNG_OK
) {
1528 ERR("Relayd trace chunk close replied error %d",
1529 reply
.generic
.ret_code
);
1532 DBG("Relayd successfully checked trace chunk existence: chunk_id = %" PRIu64
1533 ", exists = %s", chunk_id
,
1534 reply
.trace_chunk_exists
? "true" : "false");
1535 *chunk_exists
= !!reply
.trace_chunk_exists
;
1541 int relayd_get_configuration(struct lttcomm_relayd_sock
*sock
,
1542 uint64_t query_flags
,
1543 uint64_t *result_flags
)
1546 struct lttcomm_relayd_get_configuration msg
= (typeof(msg
)) {
1547 .query_flags
= htobe64(query_flags
),
1549 struct lttcomm_relayd_get_configuration_reply reply
= {};
1551 if (!relayd_supports_get_configuration(sock
)) {
1552 DBG("Refusing to get relayd configuration (unsupported by relayd)");
1561 ret
= send_command(sock
, RELAYD_GET_CONFIGURATION
, &msg
, sizeof(msg
),
1564 ERR("Failed to send get configuration command to relay daemon");
1568 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1570 ERR("Failed to receive relay daemon get configuration command reply");
1574 reply
.generic
.ret_code
= be32toh(reply
.generic
.ret_code
);
1575 if (reply
.generic
.ret_code
!= LTTNG_OK
) {
1577 ERR("Relayd get configuration replied error %d",
1578 reply
.generic
.ret_code
);
1580 reply
.relayd_configuration_flags
=
1581 be64toh(reply
.relayd_configuration_flags
);
1583 DBG("Relayd successfully got configuration: query_flags = %" PRIu64
1584 ", results_flags = %" PRIu64
, query_flags
,
1585 reply
.relayd_configuration_flags
);
1586 *result_flags
= reply
.relayd_configuration_flags
;