2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <common/common.h>
27 #include <common/defaults.h>
28 #include <common/compat/endian.h>
29 #include <common/compat/string.h>
30 #include <common/sessiond-comm/relayd.h>
31 #include <common/index/ctf-index.h>
32 #include <common/trace-chunk.h>
33 #include <common/string-utils/format.h>
38 * Send command. Fill up the header and append the data.
40 static int send_command(struct lttcomm_relayd_sock
*rsock
,
41 enum lttcomm_relayd_command cmd
, const void *data
, size_t size
,
45 struct lttcomm_relayd_hdr header
;
47 uint64_t buf_size
= sizeof(header
);
49 if (rsock
->sock
.fd
< 0) {
57 buf
= zmalloc(buf_size
);
59 PERROR("zmalloc relayd send command buf");
64 memset(&header
, 0, sizeof(header
));
65 header
.cmd
= htobe32(cmd
);
66 header
.data_size
= htobe64(size
);
68 /* Zeroed for now since not used. */
69 header
.cmd_version
= 0;
70 header
.circuit_id
= 0;
72 /* Prepare buffer to send. */
73 memcpy(buf
, &header
, sizeof(header
));
75 memcpy(buf
+ sizeof(header
), data
, size
);
78 DBG3("Relayd sending command %d of size %" PRIu64
, (int) cmd
, buf_size
);
79 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, buf
, buf_size
, flags
);
81 PERROR("Failed to send command %d of size %" PRIu64
,
93 * Receive reply data on socket. This MUST be call after send_command or else
94 * could result in unexpected behavior(s).
96 static int recv_reply(struct lttcomm_relayd_sock
*rsock
, void *data
, size_t size
)
100 if (rsock
->sock
.fd
< 0) {
104 DBG3("Relayd waiting for reply of size %zu", size
);
106 ret
= rsock
->sock
.ops
->recvmsg(&rsock
->sock
, data
, size
, 0);
107 if (ret
<= 0 || ret
!= size
) {
109 /* Orderly shutdown. */
110 DBG("Socket %d has performed an orderly shutdown", rsock
->sock
.fd
);
112 DBG("Receiving reply failed on sock %d for size %zu with ret %d",
113 rsock
->sock
.fd
, size
, ret
);
115 /* Always return -1 here and the caller can use errno. */
125 * Starting from 2.11, RELAYD_CREATE_SESSION payload (session_name,
126 * hostname, and base_path) have no length restriction on the sender side.
127 * Length for both payloads is stored in the msg struct. A new dynamic size
128 * payload size is introduced.
130 static int relayd_create_session_2_11(struct lttcomm_relayd_sock
*rsock
,
131 const char *session_name
, const char *hostname
,
132 const char *base_path
, int session_live_timer
,
133 unsigned int snapshot
, uint64_t sessiond_session_id
,
134 const lttng_uuid sessiond_uuid
, const uint64_t *current_chunk_id
,
135 time_t creation_time
, bool session_name_contains_creation_time
)
138 struct lttcomm_relayd_create_session_2_11
*msg
= NULL
;
139 size_t session_name_len
;
141 size_t base_path_len
;
148 /* The three names are sent with a '\0' delimiter between them. */
149 session_name_len
= strlen(session_name
) + 1;
150 hostname_len
= strlen(hostname
) + 1;
151 base_path_len
= base_path
? strlen(base_path
) + 1 : 0;
153 msg_length
= sizeof(*msg
) + session_name_len
+ hostname_len
+ base_path_len
;
154 msg
= zmalloc(msg_length
);
156 PERROR("zmalloc create_session_2_11 command message");
161 assert(session_name_len
<= UINT32_MAX
);
162 msg
->session_name_len
= htobe32(session_name_len
);
164 assert(hostname_len
<= UINT32_MAX
);
165 msg
->hostname_len
= htobe32(hostname_len
);
167 assert(base_path_len
<= UINT32_MAX
);
168 msg
->base_path_len
= htobe32(base_path_len
);
171 if (lttng_strncpy(dst
, session_name
, session_name_len
)) {
175 dst
+= session_name_len
;
176 if (lttng_strncpy(dst
, hostname
, hostname_len
)) {
181 if (base_path
&& lttng_strncpy(dst
, base_path
, base_path_len
)) {
186 msg
->live_timer
= htobe32(session_live_timer
);
187 msg
->snapshot
= !!snapshot
;
189 lttng_uuid_copy(msg
->sessiond_uuid
, sessiond_uuid
);
190 msg
->session_id
= htobe64(sessiond_session_id
);
191 msg
->session_name_contains_creation_time
= session_name_contains_creation_time
;
192 if (current_chunk_id
) {
193 LTTNG_OPTIONAL_SET(&msg
->current_chunk_id
,
194 htobe64(*current_chunk_id
));
197 msg
->creation_time
= htobe64((uint64_t) creation_time
);
200 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, msg
, msg_length
, 0);
209 * From 2.4 to 2.10, RELAYD_CREATE_SESSION takes additional parameters to
210 * support the live reading capability.
212 static int relayd_create_session_2_4(struct lttcomm_relayd_sock
*rsock
,
213 const char *session_name
, const char *hostname
,
214 int session_live_timer
, unsigned int snapshot
)
217 struct lttcomm_relayd_create_session_2_4 msg
;
219 if (lttng_strncpy(msg
.session_name
, session_name
,
220 sizeof(msg
.session_name
))) {
224 if (lttng_strncpy(msg
.hostname
, hostname
, sizeof(msg
.hostname
))) {
228 msg
.live_timer
= htobe32(session_live_timer
);
229 msg
.snapshot
= htobe32(snapshot
);
232 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, &msg
, sizeof(msg
), 0);
242 * RELAYD_CREATE_SESSION from 2.1 to 2.3.
244 static int relayd_create_session_2_1(struct lttcomm_relayd_sock
*rsock
)
249 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, NULL
, 0, 0);
259 * Send a RELAYD_CREATE_SESSION command to the relayd with the given socket and
260 * set session_id of the relayd if we have a successful reply from the relayd.
262 * On success, return 0 else a negative value which is either an errno error or
263 * a lttng error code from the relayd.
265 int relayd_create_session(struct lttcomm_relayd_sock
*rsock
,
266 uint64_t *relayd_session_id
,
267 const char *session_name
, const char *hostname
,
268 const char *base_path
, int session_live_timer
,
269 unsigned int snapshot
, uint64_t sessiond_session_id
,
270 const lttng_uuid sessiond_uuid
,
271 const uint64_t *current_chunk_id
,
272 time_t creation_time
, bool session_name_contains_creation_time
)
275 struct lttcomm_relayd_status_session reply
;
278 assert(relayd_session_id
);
280 DBG("Relayd create session");
282 if (rsock
->minor
< 4) {
283 /* From 2.1 to 2.3 */
284 ret
= relayd_create_session_2_1(rsock
);
285 } else if (rsock
->minor
>= 4 && rsock
->minor
< 11) {
286 /* From 2.4 to 2.10 */
287 ret
= relayd_create_session_2_4(rsock
, session_name
,
288 hostname
, session_live_timer
, snapshot
);
290 /* From 2.11 to ... */
291 ret
= relayd_create_session_2_11(rsock
, session_name
,
292 hostname
, base_path
, session_live_timer
, snapshot
,
293 sessiond_session_id
, sessiond_uuid
,
294 current_chunk_id
, creation_time
,
295 session_name_contains_creation_time
);
302 /* Receive response */
303 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
308 reply
.session_id
= be64toh(reply
.session_id
);
309 reply
.ret_code
= be32toh(reply
.ret_code
);
311 /* Return session id or negative ret code. */
312 if (reply
.ret_code
!= LTTNG_OK
) {
314 ERR("Relayd create session replied error %d", reply
.ret_code
);
318 *relayd_session_id
= reply
.session_id
;
321 DBG("Relayd session created with id %" PRIu64
, reply
.session_id
);
327 static int relayd_add_stream_2_1(struct lttcomm_relayd_sock
*rsock
,
328 const char *channel_name
, const char *pathname
)
331 struct lttcomm_relayd_add_stream msg
;
333 memset(&msg
, 0, sizeof(msg
));
334 if (lttng_strncpy(msg
.channel_name
, channel_name
,
335 sizeof(msg
.channel_name
))) {
340 if (lttng_strncpy(msg
.pathname
, pathname
,
341 sizeof(msg
.pathname
))) {
347 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg
, sizeof(msg
), 0);
357 static int relayd_add_stream_2_2(struct lttcomm_relayd_sock
*rsock
,
358 const char *channel_name
, const char *pathname
,
359 uint64_t tracefile_size
, uint64_t tracefile_count
)
362 struct lttcomm_relayd_add_stream_2_2 msg
;
364 memset(&msg
, 0, sizeof(msg
));
365 /* Compat with relayd 2.2 to 2.10 */
366 if (lttng_strncpy(msg
.channel_name
, channel_name
,
367 sizeof(msg
.channel_name
))) {
371 if (lttng_strncpy(msg
.pathname
, pathname
,
372 sizeof(msg
.pathname
))) {
376 msg
.tracefile_size
= htobe64(tracefile_size
);
377 msg
.tracefile_count
= htobe64(tracefile_count
);
380 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg
, sizeof(msg
), 0);
389 static int relayd_add_stream_2_11(struct lttcomm_relayd_sock
*rsock
,
390 const char *channel_name
, const char *pathname
,
391 uint64_t tracefile_size
, uint64_t tracefile_count
,
392 uint64_t trace_archive_id
)
395 struct lttcomm_relayd_add_stream_2_11
*msg
= NULL
;
396 size_t channel_name_len
;
400 /* The two names are sent with a '\0' delimiter between them. */
401 channel_name_len
= strlen(channel_name
) + 1;
402 pathname_len
= strlen(pathname
) + 1;
404 msg_length
= sizeof(*msg
) + channel_name_len
+ pathname_len
;
405 msg
= zmalloc(msg_length
);
407 PERROR("zmalloc add_stream_2_11 command message");
412 assert(channel_name_len
<= UINT32_MAX
);
413 msg
->channel_name_len
= htobe32(channel_name_len
);
415 assert(pathname_len
<= UINT32_MAX
);
416 msg
->pathname_len
= htobe32(pathname_len
);
418 if (lttng_strncpy(msg
->names
, channel_name
, channel_name_len
)) {
422 if (lttng_strncpy(msg
->names
+ channel_name_len
, pathname
, pathname_len
)) {
427 msg
->tracefile_size
= htobe64(tracefile_size
);
428 msg
->tracefile_count
= htobe64(tracefile_count
);
429 msg
->trace_chunk_id
= htobe64(trace_archive_id
);
432 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) msg
, msg_length
, 0);
443 * Add stream on the relayd and assign stream handle to the stream_id argument.
445 * On success return 0 else return ret_code negative value.
447 int relayd_add_stream(struct lttcomm_relayd_sock
*rsock
, const char *channel_name
,
448 const char *pathname
, uint64_t *stream_id
,
449 uint64_t tracefile_size
, uint64_t tracefile_count
,
450 struct lttng_trace_chunk
*trace_chunk
)
453 struct lttcomm_relayd_status_stream reply
;
455 /* Code flow error. Safety net. */
457 assert(channel_name
);
460 DBG("Relayd adding stream for channel name %s", channel_name
);
462 /* Compat with relayd 2.1 */
463 if (rsock
->minor
== 1) {
465 assert(!trace_chunk
);
466 ret
= relayd_add_stream_2_1(rsock
, channel_name
, pathname
);
468 } else if (rsock
->minor
> 1 && rsock
->minor
< 11) {
469 /* From 2.2 to 2.10 */
470 assert(!trace_chunk
);
471 ret
= relayd_add_stream_2_2(rsock
, channel_name
, pathname
,
472 tracefile_size
, tracefile_count
);
474 enum lttng_trace_chunk_status chunk_status
;
478 chunk_status
= lttng_trace_chunk_get_id(trace_chunk
,
480 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
482 /* From 2.11 to ...*/
483 ret
= relayd_add_stream_2_11(rsock
, channel_name
, pathname
,
484 tracefile_size
, tracefile_count
,
493 /* Waiting for reply */
494 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
499 /* Back to host bytes order. */
500 reply
.handle
= be64toh(reply
.handle
);
501 reply
.ret_code
= be32toh(reply
.ret_code
);
503 /* Return session id or negative ret code. */
504 if (reply
.ret_code
!= LTTNG_OK
) {
506 ERR("Relayd add stream replied error %d", reply
.ret_code
);
510 *stream_id
= reply
.handle
;
513 DBG("Relayd stream added successfully with handle %" PRIu64
,
521 * Inform the relay that all the streams for the current channel has been sent.
523 * On success return 0 else return ret_code negative value.
525 int relayd_streams_sent(struct lttcomm_relayd_sock
*rsock
)
528 struct lttcomm_relayd_generic_reply reply
;
530 /* Code flow error. Safety net. */
533 DBG("Relayd sending streams sent.");
535 /* This feature was introduced in 2.4, ignore it for earlier versions. */
536 if (rsock
->minor
< 4) {
542 ret
= send_command(rsock
, RELAYD_STREAMS_SENT
, NULL
, 0, 0);
547 /* Waiting for reply */
548 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
553 /* Back to host bytes order. */
554 reply
.ret_code
= be32toh(reply
.ret_code
);
556 /* Return session id or negative ret code. */
557 if (reply
.ret_code
!= LTTNG_OK
) {
559 ERR("Relayd streams sent replied error %d", reply
.ret_code
);
566 DBG("Relayd streams sent success");
574 * Check version numbers on the relayd.
575 * If major versions are compatible, we assign minor_to_use to the
576 * minor version of the procotol we are going to use for this session.
578 * Return 0 if the two daemons are compatible, LTTNG_ERR_RELAYD_VERSION_FAIL
579 * otherwise, or a negative value on network errors.
581 int relayd_version_check(struct lttcomm_relayd_sock
*rsock
)
584 struct lttcomm_relayd_version msg
;
586 /* Code flow error. Safety net. */
589 DBG("Relayd version check for major.minor %u.%u", rsock
->major
,
592 memset(&msg
, 0, sizeof(msg
));
593 /* Prepare network byte order before transmission. */
594 msg
.major
= htobe32(rsock
->major
);
595 msg
.minor
= htobe32(rsock
->minor
);
598 ret
= send_command(rsock
, RELAYD_VERSION
, (void *) &msg
, sizeof(msg
), 0);
603 /* Receive response */
604 ret
= recv_reply(rsock
, (void *) &msg
, sizeof(msg
));
609 /* Set back to host bytes order */
610 msg
.major
= be32toh(msg
.major
);
611 msg
.minor
= be32toh(msg
.minor
);
614 * Only validate the major version. If the other side is higher,
615 * communication is not possible. Only major version equal can talk to each
616 * other. If the minor version differs, the lowest version is used by both
619 if (msg
.major
!= rsock
->major
) {
621 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
622 DBG2("Relayd version is NOT compatible. Relayd version %u != %u (us)",
623 msg
.major
, rsock
->major
);
628 * If the relayd's minor version is higher, it will adapt to our version so
629 * we can continue to use the latest relayd communication data structure.
630 * If the received minor version is higher, the relayd should adapt to us.
632 if (rsock
->minor
> msg
.minor
) {
633 rsock
->minor
= msg
.minor
;
636 /* Version number compatible */
637 DBG2("Relayd version is compatible, using protocol version %u.%u",
638 rsock
->major
, rsock
->minor
);
646 * Add stream on the relayd and assign stream handle to the stream_id argument.
648 * On success return 0 else return ret_code negative value.
650 int relayd_send_metadata(struct lttcomm_relayd_sock
*rsock
, size_t len
)
654 /* Code flow error. Safety net. */
657 DBG("Relayd sending metadata of size %zu", len
);
660 ret
= send_command(rsock
, RELAYD_SEND_METADATA
, NULL
, len
, 0);
665 DBG2("Relayd metadata added successfully");
668 * After that call, the metadata data MUST be sent to the relayd so the
669 * receive size on the other end matches the len of the metadata packet
670 * header. This is why we don't wait for a reply here.
678 * Connect to relay daemon with an allocated lttcomm_relayd_sock.
680 int relayd_connect(struct lttcomm_relayd_sock
*rsock
)
682 /* Code flow error. Safety net. */
685 if (!rsock
->sock
.ops
) {
687 * Attempting a connect on a non-initialized socket.
692 DBG3("Relayd connect ...");
694 return rsock
->sock
.ops
->connect(&rsock
->sock
);
698 * Close relayd socket with an allocated lttcomm_relayd_sock.
700 * If no socket operations are found, simply return 0 meaning that everything
701 * is fine. Without operations, the socket can not possibly be opened or used.
702 * This is possible if the socket was allocated but not created. However, the
703 * caller could simply use it to store a valid file descriptor for instance
704 * passed over a Unix socket and call this to cleanup but still without a valid
707 * Return the close returned value. On error, a negative value is usually
708 * returned back from close(2).
710 int relayd_close(struct lttcomm_relayd_sock
*rsock
)
714 /* Code flow error. Safety net. */
717 /* An invalid fd is fine, return success. */
718 if (rsock
->sock
.fd
< 0) {
723 DBG3("Relayd closing socket %d", rsock
->sock
.fd
);
725 if (rsock
->sock
.ops
) {
726 ret
= rsock
->sock
.ops
->close(&rsock
->sock
);
728 /* Default call if no specific ops found. */
729 ret
= close(rsock
->sock
.fd
);
731 PERROR("relayd_close default close");
741 * Send data header structure to the relayd.
743 int relayd_send_data_hdr(struct lttcomm_relayd_sock
*rsock
,
744 struct lttcomm_relayd_data_hdr
*hdr
, size_t size
)
748 /* Code flow error. Safety net. */
752 if (rsock
->sock
.fd
< 0) {
756 DBG3("Relayd sending data header of size %zu", size
);
758 /* Again, safety net */
760 size
= sizeof(struct lttcomm_relayd_data_hdr
);
763 /* Only send data header. */
764 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, hdr
, size
, 0);
771 * The data MUST be sent right after that command for the receive on the
772 * other end to match the size in the header.
780 * Send close stream command to the relayd.
782 int relayd_send_close_stream(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
783 uint64_t last_net_seq_num
)
786 struct lttcomm_relayd_close_stream msg
;
787 struct lttcomm_relayd_generic_reply reply
;
789 /* Code flow error. Safety net. */
792 DBG("Relayd closing stream id %" PRIu64
, stream_id
);
794 memset(&msg
, 0, sizeof(msg
));
795 msg
.stream_id
= htobe64(stream_id
);
796 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
799 ret
= send_command(rsock
, RELAYD_CLOSE_STREAM
, (void *) &msg
, sizeof(msg
), 0);
804 /* Receive response */
805 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
810 reply
.ret_code
= be32toh(reply
.ret_code
);
812 /* Return session id or negative ret code. */
813 if (reply
.ret_code
!= LTTNG_OK
) {
815 ERR("Relayd close stream replied error %d", reply
.ret_code
);
821 DBG("Relayd close stream id %" PRIu64
" successfully", stream_id
);
828 * Check for data availability for a given stream id.
830 * Return 0 if NOT pending, 1 if so and a negative value on error.
832 int relayd_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
833 uint64_t last_net_seq_num
)
836 struct lttcomm_relayd_data_pending msg
;
837 struct lttcomm_relayd_generic_reply reply
;
839 /* Code flow error. Safety net. */
842 DBG("Relayd data pending for stream id %" PRIu64
, stream_id
);
844 memset(&msg
, 0, sizeof(msg
));
845 msg
.stream_id
= htobe64(stream_id
);
846 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
849 ret
= send_command(rsock
, RELAYD_DATA_PENDING
, (void *) &msg
,
855 /* Receive response */
856 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
861 reply
.ret_code
= be32toh(reply
.ret_code
);
863 /* Return session id or negative ret code. */
864 if (reply
.ret_code
>= LTTNG_OK
) {
865 ERR("Relayd data pending replied error %d", reply
.ret_code
);
868 /* At this point, the ret code is either 1 or 0 */
869 ret
= reply
.ret_code
;
871 DBG("Relayd data is %s pending for stream id %" PRIu64
,
872 ret
== 1 ? "" : "NOT", stream_id
);
879 * Check on the relayd side for a quiescent state on the control socket.
881 int relayd_quiescent_control(struct lttcomm_relayd_sock
*rsock
,
882 uint64_t metadata_stream_id
)
885 struct lttcomm_relayd_quiescent_control msg
;
886 struct lttcomm_relayd_generic_reply reply
;
888 /* Code flow error. Safety net. */
891 DBG("Relayd checking quiescent control state");
893 memset(&msg
, 0, sizeof(msg
));
894 msg
.stream_id
= htobe64(metadata_stream_id
);
897 ret
= send_command(rsock
, RELAYD_QUIESCENT_CONTROL
, &msg
, sizeof(msg
), 0);
902 /* Receive response */
903 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
908 reply
.ret_code
= be32toh(reply
.ret_code
);
910 /* Return session id or negative ret code. */
911 if (reply
.ret_code
!= LTTNG_OK
) {
913 ERR("Relayd quiescent control replied error %d", reply
.ret_code
);
917 /* Control socket is quiescent */
925 * Begin a data pending command for a specific session id.
927 int relayd_begin_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
)
930 struct lttcomm_relayd_begin_data_pending msg
;
931 struct lttcomm_relayd_generic_reply reply
;
933 /* Code flow error. Safety net. */
936 DBG("Relayd begin data pending");
938 memset(&msg
, 0, sizeof(msg
));
939 msg
.session_id
= htobe64(id
);
942 ret
= send_command(rsock
, RELAYD_BEGIN_DATA_PENDING
, &msg
, sizeof(msg
), 0);
947 /* Receive response */
948 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
953 reply
.ret_code
= be32toh(reply
.ret_code
);
955 /* Return session id or negative ret code. */
956 if (reply
.ret_code
!= LTTNG_OK
) {
958 ERR("Relayd begin data pending replied error %d", reply
.ret_code
);
969 * End a data pending command for a specific session id.
971 * Return 0 on success and set is_data_inflight to 0 if no data is being
972 * streamed or 1 if it is the case.
974 int relayd_end_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
,
975 unsigned int *is_data_inflight
)
978 struct lttcomm_relayd_end_data_pending msg
;
979 struct lttcomm_relayd_generic_reply reply
;
981 /* Code flow error. Safety net. */
984 DBG("Relayd end data pending");
986 memset(&msg
, 0, sizeof(msg
));
987 msg
.session_id
= htobe64(id
);
990 ret
= send_command(rsock
, RELAYD_END_DATA_PENDING
, &msg
, sizeof(msg
), 0);
995 /* Receive response */
996 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1001 recv_ret
= be32toh(reply
.ret_code
);
1007 *is_data_inflight
= recv_ret
;
1009 DBG("Relayd end data pending is data inflight: %d", recv_ret
);
1018 * Send index to the relayd.
1020 int relayd_send_index(struct lttcomm_relayd_sock
*rsock
,
1021 struct ctf_packet_index
*index
, uint64_t relay_stream_id
,
1022 uint64_t net_seq_num
)
1025 struct lttcomm_relayd_index msg
;
1026 struct lttcomm_relayd_generic_reply reply
;
1028 /* Code flow error. Safety net. */
1031 if (rsock
->minor
< 4) {
1032 DBG("Not sending indexes before protocol 2.4");
1037 DBG("Relayd sending index for stream ID %" PRIu64
, relay_stream_id
);
1039 memset(&msg
, 0, sizeof(msg
));
1040 msg
.relay_stream_id
= htobe64(relay_stream_id
);
1041 msg
.net_seq_num
= htobe64(net_seq_num
);
1043 /* The index is already in big endian. */
1044 msg
.packet_size
= index
->packet_size
;
1045 msg
.content_size
= index
->content_size
;
1046 msg
.timestamp_begin
= index
->timestamp_begin
;
1047 msg
.timestamp_end
= index
->timestamp_end
;
1048 msg
.events_discarded
= index
->events_discarded
;
1049 msg
.stream_id
= index
->stream_id
;
1051 if (rsock
->minor
>= 8) {
1052 msg
.stream_instance_id
= index
->stream_instance_id
;
1053 msg
.packet_seq_num
= index
->packet_seq_num
;
1057 ret
= send_command(rsock
, RELAYD_SEND_INDEX
, &msg
,
1058 lttcomm_relayd_index_len(lttng_to_index_major(rsock
->major
,
1060 lttng_to_index_minor(rsock
->major
, rsock
->minor
)),
1066 /* Receive response */
1067 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1072 reply
.ret_code
= be32toh(reply
.ret_code
);
1074 /* Return session id or negative ret code. */
1075 if (reply
.ret_code
!= LTTNG_OK
) {
1077 ERR("Relayd send index replied error %d", reply
.ret_code
);
1088 * Ask the relay to reset the metadata trace file (regeneration).
1090 int relayd_reset_metadata(struct lttcomm_relayd_sock
*rsock
,
1091 uint64_t stream_id
, uint64_t version
)
1094 struct lttcomm_relayd_reset_metadata msg
;
1095 struct lttcomm_relayd_generic_reply reply
;
1097 /* Code flow error. Safety net. */
1100 /* Should have been prevented by the sessiond. */
1101 if (rsock
->minor
< 8) {
1102 ERR("Metadata regeneration unsupported before 2.8");
1107 DBG("Relayd reset metadata stream id %" PRIu64
, stream_id
);
1109 memset(&msg
, 0, sizeof(msg
));
1110 msg
.stream_id
= htobe64(stream_id
);
1111 msg
.version
= htobe64(version
);
1114 ret
= send_command(rsock
, RELAYD_RESET_METADATA
, (void *) &msg
, sizeof(msg
), 0);
1119 /* Receive response */
1120 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
1125 reply
.ret_code
= be32toh(reply
.ret_code
);
1127 /* Return session id or negative ret code. */
1128 if (reply
.ret_code
!= LTTNG_OK
) {
1130 ERR("Relayd reset metadata replied error %d", reply
.ret_code
);
1136 DBG("Relayd reset metadata stream id %" PRIu64
" successfully", stream_id
);
1142 int relayd_rotate_streams(struct lttcomm_relayd_sock
*sock
,
1143 unsigned int stream_count
, const uint64_t *new_chunk_id
,
1144 const struct relayd_stream_rotation_position
*positions
)
1148 struct lttng_dynamic_buffer payload
;
1149 struct lttcomm_relayd_generic_reply reply
= {};
1150 const struct lttcomm_relayd_rotate_streams msg
= {
1151 .stream_count
= htobe32((uint32_t) stream_count
),
1152 .new_chunk_id
= (typeof(msg
.new_chunk_id
)) {
1153 .is_set
= !!new_chunk_id
,
1154 .value
= htobe64(new_chunk_id
? *new_chunk_id
: 0),
1157 char new_chunk_id_buf
[MAX_INT_DEC_LEN(*new_chunk_id
)] = {};
1158 const char *new_chunk_id_str
;
1160 lttng_dynamic_buffer_init(&payload
);
1162 /* Code flow error. Safety net. */
1166 ret
= snprintf(new_chunk_id_buf
, sizeof(new_chunk_id_buf
),
1167 "%" PRIu64
, *new_chunk_id
);
1168 if (ret
== -1 || ret
>= sizeof(new_chunk_id_buf
)) {
1169 new_chunk_id_str
= "formatting error";
1171 new_chunk_id_str
= new_chunk_id_buf
;
1174 new_chunk_id_str
= "none";
1177 DBG("Preparing \"rotate streams\" command payload: new_chunk_id = %s, stream_count = %u",
1178 new_chunk_id_str
, stream_count
);
1180 ret
= lttng_dynamic_buffer_append(&payload
, &msg
, sizeof(msg
));
1182 ERR("Failed to allocate \"rotate streams\" command payload");
1186 for (i
= 0; i
< stream_count
; i
++) {
1187 const struct relayd_stream_rotation_position
*position
=
1189 const struct lttcomm_relayd_stream_rotation_position comm_position
= {
1190 .stream_id
= htobe64(position
->stream_id
),
1191 .rotate_at_seq_num
= htobe64(
1192 position
->rotate_at_seq_num
),
1195 DBG("Rotate stream %" PRIu64
"at sequence number %" PRIu64
,
1196 position
->stream_id
,
1197 position
->rotate_at_seq_num
);
1198 ret
= lttng_dynamic_buffer_append(&payload
, &comm_position
,
1199 sizeof(comm_position
));
1201 ERR("Failed to allocate \"rotate streams\" command payload");
1207 ret
= send_command(sock
, RELAYD_ROTATE_STREAMS
, payload
.data
,
1210 ERR("Failed to send \"rotate stream\" command");
1214 /* Receive response. */
1215 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1217 ERR("Failed to receive \"rotate streams\" command reply");
1221 reply
.ret_code
= be32toh(reply
.ret_code
);
1222 if (reply
.ret_code
!= LTTNG_OK
) {
1224 ERR("Relayd rotate streams replied error %d", reply
.ret_code
);
1228 DBG("Relayd rotated streams successfully");
1232 lttng_dynamic_buffer_reset(&payload
);
1236 int relayd_create_trace_chunk(struct lttcomm_relayd_sock
*sock
,
1237 struct lttng_trace_chunk
*chunk
)
1240 enum lttng_trace_chunk_status status
;
1241 struct lttcomm_relayd_create_trace_chunk msg
= {};
1242 struct lttcomm_relayd_generic_reply reply
= {};
1243 struct lttng_dynamic_buffer payload
;
1245 time_t creation_timestamp
;
1246 const char *chunk_name
;
1247 size_t chunk_name_length
;
1248 bool overridden_name
;
1250 lttng_dynamic_buffer_init(&payload
);
1252 status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1253 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1258 status
= lttng_trace_chunk_get_creation_timestamp(
1259 chunk
, &creation_timestamp
);
1260 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1265 status
= lttng_trace_chunk_get_name(
1266 chunk
, &chunk_name
, &overridden_name
);
1267 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
&&
1268 status
!= LTTNG_TRACE_CHUNK_STATUS_NONE
) {
1273 chunk_name_length
= overridden_name
? (strlen(chunk_name
) + 1) : 0;
1274 msg
= (typeof(msg
)){
1275 .chunk_id
= htobe64(chunk_id
),
1276 .creation_timestamp
= htobe64((uint64_t) creation_timestamp
),
1277 .override_name_length
= htobe32((uint32_t) chunk_name_length
),
1280 ret
= lttng_dynamic_buffer_append(&payload
, &msg
, sizeof(msg
));
1284 if (chunk_name_length
) {
1285 ret
= lttng_dynamic_buffer_append(
1286 &payload
, chunk_name
, chunk_name_length
);
1292 ret
= send_command(sock
, RELAYD_CREATE_TRACE_CHUNK
, payload
.data
,
1295 ERR("Failed to send trace chunk creation command to relay daemon");
1299 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1301 ERR("Failed to receive relay daemon trace chunk creation command reply");
1305 reply
.ret_code
= be32toh(reply
.ret_code
);
1306 if (reply
.ret_code
!= LTTNG_OK
) {
1308 ERR("Relayd trace chunk create replied error %d",
1312 DBG("Relayd successfully created trace chunk: chunk_id = %" PRIu64
,
1317 lttng_dynamic_buffer_reset(&payload
);
1321 int relayd_close_trace_chunk(struct lttcomm_relayd_sock
*sock
,
1322 struct lttng_trace_chunk
*chunk
)
1325 enum lttng_trace_chunk_status status
;
1326 struct lttcomm_relayd_close_trace_chunk msg
= {};
1327 struct lttcomm_relayd_generic_reply reply
= {};
1329 time_t close_timestamp
;
1330 LTTNG_OPTIONAL(enum lttng_trace_chunk_command_type
) close_command
= {};
1332 status
= lttng_trace_chunk_get_id(chunk
, &chunk_id
);
1333 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1334 ERR("Failed to get trace chunk id");
1339 status
= lttng_trace_chunk_get_close_timestamp(chunk
, &close_timestamp
);
1340 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1341 ERR("Failed to get trace chunk close timestamp");
1346 status
= lttng_trace_chunk_get_close_command(chunk
,
1347 &close_command
.value
);
1349 case LTTNG_TRACE_CHUNK_STATUS_OK
:
1350 close_command
.is_set
= 1;
1352 case LTTNG_TRACE_CHUNK_STATUS_NONE
:
1355 ERR("Failed to get trace chunk close command");
1360 msg
= (typeof(msg
)){
1361 .chunk_id
= htobe64(chunk_id
),
1362 .close_timestamp
= htobe64((uint64_t) close_timestamp
),
1364 .value
= htobe32((uint32_t) close_command
.value
),
1365 .is_set
= close_command
.is_set
,
1369 ret
= send_command(sock
, RELAYD_CLOSE_TRACE_CHUNK
, &msg
, sizeof(msg
),
1372 ERR("Failed to send trace chunk close command to relay daemon");
1376 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1378 ERR("Failed to receive relay daemon trace chunk close command reply");
1382 reply
.ret_code
= be32toh(reply
.ret_code
);
1383 if (reply
.ret_code
!= LTTNG_OK
) {
1385 ERR("Relayd trace chunk close replied error %d",
1389 DBG("Relayd successfully closed trace chunk: chunk_id = %" PRIu64
,
1396 int relayd_trace_chunk_exists(struct lttcomm_relayd_sock
*sock
,
1397 uint64_t chunk_id
, bool *chunk_exists
)
1400 struct lttcomm_relayd_trace_chunk_exists msg
= {};
1401 struct lttcomm_relayd_trace_chunk_exists_reply reply
= {};
1403 msg
= (typeof(msg
)){
1404 .chunk_id
= htobe64(chunk_id
),
1407 ret
= send_command(sock
, RELAYD_TRACE_CHUNK_EXISTS
, &msg
, sizeof(msg
),
1410 ERR("Failed to send trace chunk exists command to relay daemon");
1414 ret
= recv_reply(sock
, &reply
, sizeof(reply
));
1416 ERR("Failed to receive relay daemon trace chunk close command reply");
1420 reply
.generic
.ret_code
= be32toh(reply
.generic
.ret_code
);
1421 if (reply
.generic
.ret_code
!= LTTNG_OK
) {
1423 ERR("Relayd trace chunk close replied error %d",
1424 reply
.generic
.ret_code
);
1427 DBG("Relayd successfully checked trace chunk existence: chunk_id = %" PRIu64
1428 ", exists = %s", chunk_id
,
1429 reply
.trace_chunk_exists
? "true" : "false");
1430 *chunk_exists
= !!reply
.trace_chunk_exists
;