2 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
15 #include <common/common.h>
16 #include <common/defaults.h>
17 #include <common/compat/endian.h>
18 #include <common/compat/string.h>
19 #include <common/sessiond-comm/relayd.h>
20 #include <common/index/ctf-index.h>
21 #include <common/trace-chunk.h>
22 #include <common/string-utils/format.h>
27 bool relayd_supports_chunks(const struct lttcomm_relayd_sock
*sock
)
29 if (sock
->major
> 2) {
31 } else if (sock
->major
== 2 && sock
->minor
>= 11) {
38 bool relayd_supports_get_configuration(const struct lttcomm_relayd_sock
*sock
)
40 if (sock
->major
> 2) {
42 } else if (sock
->major
== 2 && sock
->minor
>= 12) {
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
= (char *) 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
= strlen(base_path
) + 1;
166 msg_length
= sizeof(*msg
) + session_name_len
+ hostname_len
+ base_path_len
;
167 msg
= (lttcomm_relayd_create_session_2_11
*) zmalloc(msg_length
);
169 PERROR("zmalloc create_session_2_11 command message");
174 LTTNG_ASSERT(session_name_len
<= UINT32_MAX
);
175 msg
->session_name_len
= htobe32(session_name_len
);
177 LTTNG_ASSERT(hostname_len
<= UINT32_MAX
);
178 msg
->hostname_len
= htobe32(hostname_len
);
180 LTTNG_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 (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 LTTNG_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
= (lttcomm_relayd_add_stream_2_11
*) zmalloc(msg_length
);
449 PERROR("zmalloc add_stream_2_11 command message");
454 LTTNG_ASSERT(channel_name_len
<= UINT32_MAX
);
455 msg
->channel_name_len
= htobe32(channel_name_len
);
457 LTTNG_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 *domain_name
, 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
;
500 char pathname
[RELAYD_COMM_LTTNG_PATH_MAX
];
502 /* Code flow error. Safety net. */
504 LTTNG_ASSERT(channel_name
);
505 LTTNG_ASSERT(domain_name
);
506 LTTNG_ASSERT(_pathname
);
507 LTTNG_ASSERT(trace_chunk
);
509 DBG("Relayd adding stream for channel name %s", channel_name
);
511 /* Compat with relayd 2.1 */
512 if (rsock
->minor
== 1) {
514 ret
= relayd_add_stream_2_1(rsock
, channel_name
, _pathname
);
516 } else if (rsock
->minor
> 1 && rsock
->minor
< 11) {
517 /* From 2.2 to 2.10 */
518 ret
= relayd_add_stream_2_2(rsock
, channel_name
, _pathname
,
519 tracefile_size
, tracefile_count
);
521 const char *separator
;
522 enum lttng_trace_chunk_status chunk_status
;
525 if (_pathname
[0] == '\0') {
531 ret
= snprintf(pathname
, RELAYD_COMM_LTTNG_PATH_MAX
, "%s%s%s",
532 domain_name
, separator
, _pathname
);
533 if (ret
<= 0 || ret
>= RELAYD_COMM_LTTNG_PATH_MAX
) {
534 ERR("Failed to format stream path: %s",
535 ret
<= 0 ? "formatting error" :
536 "path exceeds maximal allowed length");
541 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
,
543 LTTNG_ASSERT(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
545 /* From 2.11 to ...*/
546 ret
= relayd_add_stream_2_11(rsock
, channel_name
, pathname
,
547 tracefile_size
, tracefile_count
,
556 /* Waiting for reply */
557 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
562 /* Back to host bytes order. */
563 reply
.handle
= be64toh(reply
.handle
);
564 reply
.ret_code
= be32toh(reply
.ret_code
);
566 /* Return session id or negative ret code. */
567 if (reply
.ret_code
!= LTTNG_OK
) {
569 ERR("Relayd add stream replied error %d", reply
.ret_code
);
573 *stream_id
= reply
.handle
;
576 DBG("Relayd stream added successfully with handle %" PRIu64
,
584 * Inform the relay that all the streams for the current channel has been sent.
586 * On success return 0 else return ret_code negative value.
588 int relayd_streams_sent(struct lttcomm_relayd_sock
*rsock
)
591 struct lttcomm_relayd_generic_reply reply
;
593 /* Code flow error. Safety net. */
596 DBG("Relayd sending streams sent.");
598 /* This feature was introduced in 2.4, ignore it for earlier versions. */
599 if (rsock
->minor
< 4) {
605 ret
= send_command(rsock
, RELAYD_STREAMS_SENT
, NULL
, 0, 0);
610 /* Waiting for reply */
611 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
616 /* Back to host bytes order. */
617 reply
.ret_code
= be32toh(reply
.ret_code
);
619 /* Return session id or negative ret code. */
620 if (reply
.ret_code
!= LTTNG_OK
) {
622 ERR("Relayd streams sent replied error %d", reply
.ret_code
);
629 DBG("Relayd streams sent success");
637 * Check version numbers on the relayd.
638 * If major versions are compatible, we assign minor_to_use to the
639 * minor version of the procotol we are going to use for this session.
641 * Return 0 if the two daemons are compatible, LTTNG_ERR_RELAYD_VERSION_FAIL
642 * otherwise, or a negative value on network errors.
644 int relayd_version_check(struct lttcomm_relayd_sock
*rsock
)
647 struct lttcomm_relayd_version msg
;
649 /* Code flow error. Safety net. */
652 DBG("Relayd version check for major.minor %u.%u", rsock
->major
,
655 memset(&msg
, 0, sizeof(msg
));
656 /* Prepare network byte order before transmission. */
657 msg
.major
= htobe32(rsock
->major
);
658 msg
.minor
= htobe32(rsock
->minor
);
661 ret
= send_command(rsock
, RELAYD_VERSION
, (void *) &msg
, sizeof(msg
), 0);
666 /* Receive response */
667 ret
= recv_reply(rsock
, (void *) &msg
, sizeof(msg
));
672 /* Set back to host bytes order */
673 msg
.major
= be32toh(msg
.major
);
674 msg
.minor
= be32toh(msg
.minor
);
677 * Only validate the major version. If the other side is higher,
678 * communication is not possible. Only major version equal can talk to each
679 * other. If the minor version differs, the lowest version is used by both
682 if (msg
.major
!= rsock
->major
) {
684 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
685 DBG2("Relayd version is NOT compatible. Relayd version %u != %u (us)",
686 msg
.major
, rsock
->major
);
691 * If the relayd's minor version is higher, it will adapt to our version so
692 * we can continue to use the latest relayd communication data structure.
693 * If the received minor version is higher, the relayd should adapt to us.
695 if (rsock
->minor
> msg
.minor
) {
696 rsock
->minor
= msg
.minor
;
699 /* Version number compatible */
700 DBG2("Relayd version is compatible, using protocol version %u.%u",
701 rsock
->major
, rsock
->minor
);
709 * Add stream on the relayd and assign stream handle to the stream_id argument.
711 * On success return 0 else return ret_code negative value.
713 int relayd_send_metadata(struct lttcomm_relayd_sock
*rsock
, size_t len
)
717 /* Code flow error. Safety net. */
720 DBG("Relayd sending metadata of size %zu", len
);
723 ret
= send_command(rsock
, RELAYD_SEND_METADATA
, NULL
, len
, 0);
728 DBG2("Relayd metadata added successfully");
731 * After that call, the metadata data MUST be sent to the relayd so the
732 * receive size on the other end matches the len of the metadata packet
733 * header. This is why we don't wait for a reply here.
741 * Connect to relay daemon with an allocated lttcomm_relayd_sock.
743 int relayd_connect(struct lttcomm_relayd_sock
*rsock
)
745 /* Code flow error. Safety net. */
748 if (!rsock
->sock
.ops
) {
750 * Attempting a connect on a non-initialized socket.
755 DBG3("Relayd connect ...");
757 return rsock
->sock
.ops
->connect(&rsock
->sock
);
761 * Close relayd socket with an allocated lttcomm_relayd_sock.
763 * If no socket operations are found, simply return 0 meaning that everything
764 * is fine. Without operations, the socket can not possibly be opened or used.
765 * This is possible if the socket was allocated but not created. However, the
766 * caller could simply use it to store a valid file descriptor for instance
767 * passed over a Unix socket and call this to cleanup but still without a valid
770 * Return the close returned value. On error, a negative value is usually
771 * returned back from close(2).
773 int relayd_close(struct lttcomm_relayd_sock
*rsock
)
777 /* Code flow error. Safety net. */
780 /* An invalid fd is fine, return success. */
781 if (rsock
->sock
.fd
< 0) {
786 DBG3("Relayd closing socket %d", rsock
->sock
.fd
);
788 if (rsock
->sock
.ops
) {
789 ret
= rsock
->sock
.ops
->close(&rsock
->sock
);
791 /* Default call if no specific ops found. */
792 ret
= close(rsock
->sock
.fd
);
794 PERROR("relayd_close default close");
804 * Send data header structure to the relayd.
806 int relayd_send_data_hdr(struct lttcomm_relayd_sock
*rsock
,
807 struct lttcomm_relayd_data_hdr
*hdr
, size_t size
)
811 /* Code flow error. Safety net. */
815 if (rsock
->sock
.fd
< 0) {
819 DBG3("Relayd sending data header of size %zu", size
);
821 /* Again, safety net */
823 size
= sizeof(struct lttcomm_relayd_data_hdr
);
826 /* Only send data header. */
827 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, hdr
, size
, 0);
834 * The data MUST be sent right after that command for the receive on the
835 * other end to match the size in the header.
843 * Send close stream command to the relayd.
845 int relayd_send_close_stream(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
846 uint64_t last_net_seq_num
)
849 struct lttcomm_relayd_close_stream msg
;
850 struct lttcomm_relayd_generic_reply reply
;
852 /* Code flow error. Safety net. */
855 DBG("Relayd closing stream id %" PRIu64
, stream_id
);
857 memset(&msg
, 0, sizeof(msg
));
858 msg
.stream_id
= htobe64(stream_id
);
859 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
862 ret
= send_command(rsock
, RELAYD_CLOSE_STREAM
, (void *) &msg
, sizeof(msg
), 0);
867 /* Receive response */
868 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
873 reply
.ret_code
= be32toh(reply
.ret_code
);
875 /* Return session id or negative ret code. */
876 if (reply
.ret_code
!= LTTNG_OK
) {
878 ERR("Relayd close stream replied error %d", reply
.ret_code
);
884 DBG("Relayd close stream id %" PRIu64
" successfully", stream_id
);
891 * Check for data availability for a given stream id.
893 * Return 0 if NOT pending, 1 if so and a negative value on error.
895 int relayd_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
896 uint64_t last_net_seq_num
)
899 struct lttcomm_relayd_data_pending msg
;
900 struct lttcomm_relayd_generic_reply reply
;
902 /* Code flow error. Safety net. */
905 DBG("Relayd data pending for stream id %" PRIu64
, stream_id
);
907 memset(&msg
, 0, sizeof(msg
));
908 msg
.stream_id
= htobe64(stream_id
);
909 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
912 ret
= send_command(rsock
, RELAYD_DATA_PENDING
, (void *) &msg
,
918 /* Receive response */
919 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
924 reply
.ret_code
= be32toh(reply
.ret_code
);
926 /* Return session id or negative ret code. */
927 if (reply
.ret_code
>= LTTNG_OK
) {
928 ERR("Relayd data pending replied error %d", reply
.ret_code
);
931 /* At this point, the ret code is either 1 or 0 */
932 ret
= reply
.ret_code
;
934 DBG("Relayd data is %s pending for stream id %" PRIu64
,
935 ret
== 1 ? "" : "NOT", stream_id
);
942 * Check on the relayd side for a quiescent state on the control socket.
944 int relayd_quiescent_control(struct lttcomm_relayd_sock
*rsock
,
945 uint64_t metadata_stream_id
)
948 struct lttcomm_relayd_quiescent_control msg
;
949 struct lttcomm_relayd_generic_reply reply
;
951 /* Code flow error. Safety net. */
954 DBG("Relayd checking quiescent control state");
956 memset(&msg
, 0, sizeof(msg
));
957 msg
.stream_id
= htobe64(metadata_stream_id
);
960 ret
= send_command(rsock
, RELAYD_QUIESCENT_CONTROL
, &msg
, sizeof(msg
), 0);
965 /* Receive response */
966 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
971 reply
.ret_code
= be32toh(reply
.ret_code
);
973 /* Return session id or negative ret code. */
974 if (reply
.ret_code
!= LTTNG_OK
) {
976 ERR("Relayd quiescent control replied error %d", reply
.ret_code
);
980 /* Control socket is quiescent */
988 * Begin a data pending command for a specific session id.
990 int relayd_begin_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
)
993 struct lttcomm_relayd_begin_data_pending msg
;
994 struct lttcomm_relayd_generic_reply reply
;
996 /* Code flow error. Safety net. */
999 DBG("Relayd begin data pending");
1001 memset(&msg
, 0, sizeof(msg
));
1002 msg
.session_id
= htobe64(id
);
1005 ret
= send_command(rsock
, RELAYD_BEGIN_DATA_PENDING
, &msg
, sizeof(msg
), 0);
1010 /* Receive response */
1011 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1016 reply
.ret_code
= be32toh(reply
.ret_code
);
1018 /* Return session id or negative ret code. */
1019 if (reply
.ret_code
!= LTTNG_OK
) {
1021 ERR("Relayd begin data pending replied error %d", reply
.ret_code
);
1032 * End a data pending command for a specific session id.
1034 * Return 0 on success and set is_data_inflight to 0 if no data is being
1035 * streamed or 1 if it is the case.
1037 int relayd_end_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
,
1038 unsigned int *is_data_inflight
)
1041 struct lttcomm_relayd_end_data_pending msg
;
1042 struct lttcomm_relayd_generic_reply reply
;
1044 /* Code flow error. Safety net. */
1045 LTTNG_ASSERT(rsock
);
1047 DBG("Relayd end data pending");
1049 memset(&msg
, 0, sizeof(msg
));
1050 msg
.session_id
= htobe64(id
);
1053 ret
= send_command(rsock
, RELAYD_END_DATA_PENDING
, &msg
, sizeof(msg
), 0);
1058 /* Receive response */
1059 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1064 recv_ret
= be32toh(reply
.ret_code
);
1070 *is_data_inflight
= recv_ret
;
1072 DBG("Relayd end data pending is data inflight: %d", recv_ret
);
1081 * Send index to the relayd.
1083 int relayd_send_index(struct lttcomm_relayd_sock
*rsock
,
1084 struct ctf_packet_index
*index
, uint64_t relay_stream_id
,
1085 uint64_t net_seq_num
)
1088 struct lttcomm_relayd_index msg
;
1089 struct lttcomm_relayd_generic_reply reply
;
1091 /* Code flow error. Safety net. */
1092 LTTNG_ASSERT(rsock
);
1094 if (rsock
->minor
< 4) {
1095 DBG("Not sending indexes before protocol 2.4");
1100 DBG("Relayd sending index for stream ID %" PRIu64
, relay_stream_id
);
1102 memset(&msg
, 0, sizeof(msg
));
1103 msg
.relay_stream_id
= htobe64(relay_stream_id
);
1104 msg
.net_seq_num
= htobe64(net_seq_num
);
1106 /* The index is already in big endian. */
1107 msg
.packet_size
= index
->packet_size
;
1108 msg
.content_size
= index
->content_size
;
1109 msg
.timestamp_begin
= index
->timestamp_begin
;
1110 msg
.timestamp_end
= index
->timestamp_end
;
1111 msg
.events_discarded
= index
->events_discarded
;
1112 msg
.stream_id
= index
->stream_id
;
1114 if (rsock
->minor
>= 8) {
1115 msg
.stream_instance_id
= index
->stream_instance_id
;
1116 msg
.packet_seq_num
= index
->packet_seq_num
;
1120 ret
= send_command(rsock
, RELAYD_SEND_INDEX
, &msg
,
1121 lttcomm_relayd_index_len(lttng_to_index_major(rsock
->major
,
1123 lttng_to_index_minor(rsock
->major
, rsock
->minor
)),
1129 /* Receive response */
1130 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1135 reply
.ret_code
= be32toh(reply
.ret_code
);
1137 /* Return session id or negative ret code. */
1138 if (reply
.ret_code
!= LTTNG_OK
) {
1140 ERR("Relayd send index replied error %d", reply
.ret_code
);
1151 * Ask the relay to reset the metadata trace file (regeneration).
1153 int relayd_reset_metadata(struct lttcomm_relayd_sock
*rsock
,
1154 uint64_t stream_id
, uint64_t version
)
1157 struct lttcomm_relayd_reset_metadata msg
;
1158 struct lttcomm_relayd_generic_reply reply
;
1160 /* Code flow error. Safety net. */
1161 LTTNG_ASSERT(rsock
);
1163 /* Should have been prevented by the sessiond. */
1164 if (rsock
->minor
< 8) {
1165 ERR("Metadata regeneration unsupported before 2.8");
1170 DBG("Relayd reset metadata stream id %" PRIu64
, stream_id
);
1172 memset(&msg
, 0, sizeof(msg
));
1173 msg
.stream_id
= htobe64(stream_id
);
1174 msg
.version
= htobe64(version
);
1177 ret
= send_command(rsock
, RELAYD_RESET_METADATA
, (void *) &msg
, sizeof(msg
), 0);
1182 /* Receive response */
1183 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1188 reply
.ret_code
= be32toh(reply
.ret_code
);
1190 /* Return session id or negative ret code. */
1191 if (reply
.ret_code
!= LTTNG_OK
) {
1193 ERR("Relayd reset metadata replied error %d", reply
.ret_code
);
1199 DBG("Relayd reset metadata stream id %" PRIu64
" successfully", stream_id
);
1205 int relayd_rotate_streams(struct lttcomm_relayd_sock
*sock
,
1206 unsigned int stream_count
, const uint64_t *new_chunk_id
,
1207 const struct relayd_stream_rotation_position
*positions
)
1211 struct lttng_dynamic_buffer payload
;
1212 struct lttcomm_relayd_generic_reply reply
= {};
1213 const struct lttcomm_relayd_rotate_streams msg
= {
1214 .stream_count
= htobe32((uint32_t) stream_count
),
1215 .new_chunk_id
= (typeof(msg
.new_chunk_id
)) {
1216 .is_set
= !!new_chunk_id
,
1217 .value
= htobe64(new_chunk_id
? *new_chunk_id
: 0),
1220 char new_chunk_id_buf
[MAX_INT_DEC_LEN(*new_chunk_id
)] = {};
1221 const char *new_chunk_id_str
;
1223 if (!relayd_supports_chunks(sock
)) {
1224 DBG("Refusing to rotate remote streams: relayd does not support chunks");
1228 lttng_dynamic_buffer_init(&payload
);
1230 /* Code flow error. Safety net. */
1234 ret
= snprintf(new_chunk_id_buf
, sizeof(new_chunk_id_buf
),
1235 "%" PRIu64
, *new_chunk_id
);
1236 if (ret
== -1 || ret
>= sizeof(new_chunk_id_buf
)) {
1237 new_chunk_id_str
= "formatting error";
1239 new_chunk_id_str
= new_chunk_id_buf
;
1242 new_chunk_id_str
= "none";
1245 DBG("Preparing \"rotate streams\" command payload: new_chunk_id = %s, stream_count = %u",
1246 new_chunk_id_str
, stream_count
);
1248 ret
= lttng_dynamic_buffer_append(&payload
, &msg
, sizeof(msg
));
1250 ERR("Failed to allocate \"rotate streams\" command payload");
1254 for (i
= 0; i
< stream_count
; i
++) {
1255 const struct relayd_stream_rotation_position
*position
=
1257 const struct lttcomm_relayd_stream_rotation_position comm_position
= {
1258 .stream_id
= htobe64(position
->stream_id
),
1259 .rotate_at_seq_num
= htobe64(
1260 position
->rotate_at_seq_num
),
1263 DBG("Rotate stream %" PRIu64
" at sequence number %" PRIu64
,
1264 position
->stream_id
,
1265 position
->rotate_at_seq_num
);
1266 ret
= lttng_dynamic_buffer_append(&payload
, &comm_position
,
1267 sizeof(comm_position
));
1269 ERR("Failed to allocate \"rotate streams\" command payload");
1275 ret
= send_command(sock
, RELAYD_ROTATE_STREAMS
, payload
.data
,
1278 ERR("Failed to send \"rotate stream\" command");
1282 /* Receive response. */
1283 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1285 ERR("Failed to receive \"rotate streams\" command reply");
1289 reply
.ret_code
= be32toh(reply
.ret_code
);
1290 if (reply
.ret_code
!= LTTNG_OK
) {
1292 ERR("Relayd rotate streams replied error %d", reply
.ret_code
);
1296 DBG("Relayd rotated streams successfully");
1300 lttng_dynamic_buffer_reset(&payload
);
1304 int relayd_create_trace_chunk(struct lttcomm_relayd_sock
*sock
,
1305 struct lttng_trace_chunk
*chunk
)
1308 enum lttng_trace_chunk_status status
;
1309 struct lttcomm_relayd_create_trace_chunk msg
= {};
1310 struct lttcomm_relayd_generic_reply reply
= {};
1311 struct lttng_dynamic_buffer payload
;
1313 time_t creation_timestamp
;
1314 const char *chunk_name
;
1315 size_t chunk_name_length
;
1316 bool overridden_name
;
1318 lttng_dynamic_buffer_init(&payload
);
1320 if (!relayd_supports_chunks(sock
)) {
1321 DBG("Refusing to create remote trace chunk: relayd does not support chunks");
1325 status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1326 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1331 status
= lttng_trace_chunk_get_creation_timestamp(
1332 chunk
, &creation_timestamp
);
1333 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1338 status
= lttng_trace_chunk_get_name(
1339 chunk
, &chunk_name
, &overridden_name
);
1340 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
&&
1341 status
!= LTTNG_TRACE_CHUNK_STATUS_NONE
) {
1346 chunk_name_length
= overridden_name
? (strlen(chunk_name
) + 1) : 0;
1347 msg
= (typeof(msg
)){
1348 .chunk_id
= htobe64(chunk_id
),
1349 .creation_timestamp
= htobe64((uint64_t) creation_timestamp
),
1350 .override_name_length
= htobe32((uint32_t) chunk_name_length
),
1353 ret
= lttng_dynamic_buffer_append(&payload
, &msg
, sizeof(msg
));
1357 if (chunk_name_length
) {
1358 ret
= lttng_dynamic_buffer_append(
1359 &payload
, chunk_name
, chunk_name_length
);
1365 ret
= send_command(sock
, RELAYD_CREATE_TRACE_CHUNK
, payload
.data
,
1368 ERR("Failed to send trace chunk creation command to relay daemon");
1372 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1374 ERR("Failed to receive relay daemon trace chunk creation command reply");
1378 reply
.ret_code
= be32toh(reply
.ret_code
);
1379 if (reply
.ret_code
!= LTTNG_OK
) {
1381 ERR("Relayd trace chunk create replied error %d",
1385 DBG("Relayd successfully created trace chunk: chunk_id = %" PRIu64
,
1390 lttng_dynamic_buffer_reset(&payload
);
1394 int relayd_close_trace_chunk(struct lttcomm_relayd_sock
*sock
,
1395 struct lttng_trace_chunk
*chunk
,
1399 enum lttng_trace_chunk_status status
;
1400 struct lttcomm_relayd_close_trace_chunk msg
= {};
1401 struct lttcomm_relayd_close_trace_chunk_reply reply
= {};
1403 time_t close_timestamp
;
1404 LTTNG_OPTIONAL(enum lttng_trace_chunk_command_type
) close_command
= {};
1406 if (!relayd_supports_chunks(sock
)) {
1407 DBG("Refusing to close remote trace chunk: relayd does not support chunks");
1411 status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1412 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1413 ERR("Failed to get trace chunk id");
1418 status
= lttng_trace_chunk_get_close_timestamp(chunk
, &close_timestamp
);
1419 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1420 ERR("Failed to get trace chunk close timestamp");
1425 status
= lttng_trace_chunk_get_close_command(chunk
,
1426 &close_command
.value
);
1428 case LTTNG_TRACE_CHUNK_STATUS_OK
:
1429 close_command
.is_set
= 1;
1431 case LTTNG_TRACE_CHUNK_STATUS_NONE
:
1434 ERR("Failed to get trace chunk close command");
1439 msg
= (typeof(msg
)){
1440 .chunk_id
= htobe64(chunk_id
),
1441 .close_timestamp
= htobe64((uint64_t) close_timestamp
),
1443 .is_set
= close_command
.is_set
,
1444 .value
= htobe32((uint32_t) close_command
.value
),
1448 ret
= send_command(sock
, RELAYD_CLOSE_TRACE_CHUNK
, &msg
, sizeof(msg
),
1451 ERR("Failed to send trace chunk close command to relay daemon");
1455 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1457 ERR("Failed to receive relay daemon trace chunk close command reply");
1461 reply
.path_length
= be32toh(reply
.path_length
);
1462 if (reply
.path_length
>= LTTNG_PATH_MAX
) {
1463 ERR("Chunk path too long");
1468 ret
= recv_reply(sock
, path
, reply
.path_length
);
1470 ERR("Failed to receive relay daemon trace chunk close command reply");
1473 if (path
[reply
.path_length
- 1] != '\0') {
1474 ERR("Invalid trace chunk path returned by relay daemon (not null-terminated)");
1479 reply
.generic
.ret_code
= be32toh(reply
.generic
.ret_code
);
1480 if (reply
.generic
.ret_code
!= LTTNG_OK
) {
1482 ERR("Relayd trace chunk close replied error %d",
1483 reply
.generic
.ret_code
);
1486 DBG("Relayd successfully closed trace chunk: chunk_id = %" PRIu64
,
1493 int relayd_trace_chunk_exists(struct lttcomm_relayd_sock
*sock
,
1494 uint64_t chunk_id
, bool *chunk_exists
)
1497 struct lttcomm_relayd_trace_chunk_exists msg
= {};
1498 struct lttcomm_relayd_trace_chunk_exists_reply reply
= {};
1500 if (!relayd_supports_chunks(sock
)) {
1501 DBG("Refusing to check for trace chunk existence: relayd does not support chunks");
1502 /* The chunk will never exist */
1503 *chunk_exists
= false;
1507 msg
= (typeof(msg
)){
1508 .chunk_id
= htobe64(chunk_id
),
1511 ret
= send_command(sock
, RELAYD_TRACE_CHUNK_EXISTS
, &msg
, sizeof(msg
),
1514 ERR("Failed to send trace chunk exists command to relay daemon");
1518 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1520 ERR("Failed to receive relay daemon trace chunk close command reply");
1524 reply
.generic
.ret_code
= be32toh(reply
.generic
.ret_code
);
1525 if (reply
.generic
.ret_code
!= LTTNG_OK
) {
1527 ERR("Relayd trace chunk close replied error %d",
1528 reply
.generic
.ret_code
);
1531 DBG("Relayd successfully checked trace chunk existence: chunk_id = %" PRIu64
1532 ", exists = %s", chunk_id
,
1533 reply
.trace_chunk_exists
? "true" : "false");
1534 *chunk_exists
= !!reply
.trace_chunk_exists
;
1540 int relayd_get_configuration(struct lttcomm_relayd_sock
*sock
,
1541 uint64_t query_flags
,
1542 uint64_t *result_flags
)
1545 struct lttcomm_relayd_get_configuration msg
= (typeof(msg
)) {
1546 .query_flags
= htobe64(query_flags
),
1548 struct lttcomm_relayd_get_configuration_reply reply
= {};
1550 if (!relayd_supports_get_configuration(sock
)) {
1551 DBG("Refusing to get relayd configuration (unsupported by relayd)");
1560 ret
= send_command(sock
, RELAYD_GET_CONFIGURATION
, &msg
, sizeof(msg
),
1563 ERR("Failed to send get configuration command to relay daemon");
1567 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1569 ERR("Failed to receive relay daemon get configuration command reply");
1573 reply
.generic
.ret_code
= be32toh(reply
.generic
.ret_code
);
1574 if (reply
.generic
.ret_code
!= LTTNG_OK
) {
1576 ERR("Relayd get configuration replied error %d",
1577 reply
.generic
.ret_code
);
1579 reply
.relayd_configuration_flags
=
1580 be64toh(reply
.relayd_configuration_flags
);
1582 DBG("Relayd successfully got configuration: query_flags = %" PRIu64
1583 ", results_flags = %" PRIu64
, query_flags
,
1584 reply
.relayd_configuration_flags
);
1585 *result_flags
= reply
.relayd_configuration_flags
;