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.
27 #include <common/common.h>
28 #include <common/defaults.h>
29 #include <common/compat/endian.h>
30 #include <common/sessiond-comm/relayd.h>
31 #include <common/index/ctf-index.h>
36 * Send command. Fill up the header and append the data.
38 static int send_command(struct lttcomm_relayd_sock
*rsock
,
39 enum lttcomm_relayd_command cmd
, void *data
, size_t size
,
43 struct lttcomm_relayd_hdr header
;
45 uint64_t buf_size
= sizeof(header
);
47 if (rsock
->sock
.fd
< 0) {
55 buf
= zmalloc(buf_size
);
57 PERROR("zmalloc relayd send command buf");
62 memset(&header
, 0, sizeof(header
));
63 header
.cmd
= htobe32(cmd
);
64 header
.data_size
= htobe64(size
);
66 /* Zeroed for now since not used. */
67 header
.cmd_version
= 0;
68 header
.circuit_id
= 0;
70 /* Prepare buffer to send. */
71 memcpy(buf
, &header
, sizeof(header
));
73 memcpy(buf
+ sizeof(header
), data
, size
);
76 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, buf
, buf_size
, flags
);
82 DBG3("Relayd sending command %d of size %" PRIu64
, cmd
, buf_size
);
91 * Receive reply data on socket. This MUST be call after send_command or else
92 * could result in unexpected behavior(s).
94 static int recv_reply(struct lttcomm_relayd_sock
*rsock
, void *data
, size_t size
)
98 if (rsock
->sock
.fd
< 0) {
102 DBG3("Relayd waiting for reply of size %zu", size
);
104 ret
= rsock
->sock
.ops
->recvmsg(&rsock
->sock
, data
, size
, 0);
105 if (ret
<= 0 || ret
!= size
) {
107 /* Orderly shutdown. */
108 DBG("Socket %d has performed an orderly shutdown", rsock
->sock
.fd
);
110 DBG("Receiving reply failed on sock %d for size %zu with ret %d",
111 rsock
->sock
.fd
, size
, ret
);
113 /* Always return -1 here and the caller can use errno. */
123 * Starting at 2.4, RELAYD_CREATE_SESSION takes additional parameters to
124 * support the live reading capability.
126 static int relayd_create_session_2_4(struct lttcomm_relayd_sock
*rsock
,
127 uint64_t *session_id
, char *session_name
, char *hostname
,
128 int session_live_timer
, unsigned int snapshot
)
131 struct lttcomm_relayd_create_session_2_4 msg
;
133 strncpy(msg
.session_name
, session_name
, sizeof(msg
.session_name
));
134 strncpy(msg
.hostname
, hostname
, sizeof(msg
.hostname
));
135 msg
.live_timer
= htobe32(session_live_timer
);
136 msg
.snapshot
= htobe32(snapshot
);
139 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, &msg
, sizeof(msg
), 0);
149 * RELAYD_CREATE_SESSION from 2.1 to 2.3.
151 static int relayd_create_session_2_1(struct lttcomm_relayd_sock
*rsock
,
152 uint64_t *session_id
)
157 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, NULL
, 0, 0);
167 * Send a RELAYD_CREATE_SESSION command to the relayd with the given socket and
168 * set session_id of the relayd if we have a successful reply from the relayd.
170 * On success, return 0 else a negative value which is either an errno error or
171 * a lttng error code from the relayd.
173 int relayd_create_session(struct lttcomm_relayd_sock
*rsock
, uint64_t *session_id
,
174 char *session_name
, char *hostname
, int session_live_timer
,
175 unsigned int snapshot
)
178 struct lttcomm_relayd_status_session reply
;
183 DBG("Relayd create session");
185 switch(rsock
->minor
) {
189 ret
= relayd_create_session_2_1(rsock
, session_id
);
193 ret
= relayd_create_session_2_4(rsock
, session_id
, session_name
,
194 hostname
, session_live_timer
, snapshot
);
202 /* Receive response */
203 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
208 reply
.session_id
= be64toh(reply
.session_id
);
209 reply
.ret_code
= be32toh(reply
.ret_code
);
211 /* Return session id or negative ret code. */
212 if (reply
.ret_code
!= LTTNG_OK
) {
214 ERR("Relayd create session replied error %d", reply
.ret_code
);
218 *session_id
= reply
.session_id
;
221 DBG("Relayd session created with id %" PRIu64
, reply
.session_id
);
228 * Add stream on the relayd and assign stream handle to the stream_id argument.
230 * On success return 0 else return ret_code negative value.
232 int relayd_add_stream(struct lttcomm_relayd_sock
*rsock
, const char *channel_name
,
233 const char *pathname
, uint64_t *stream_id
,
234 uint64_t tracefile_size
, uint64_t tracefile_count
)
237 struct lttcomm_relayd_add_stream msg
;
238 struct lttcomm_relayd_add_stream_2_2 msg_2_2
;
239 struct lttcomm_relayd_status_stream reply
;
241 /* Code flow error. Safety net. */
243 assert(channel_name
);
246 DBG("Relayd adding stream for channel name %s", channel_name
);
248 /* Compat with relayd 2.1 */
249 if (rsock
->minor
== 1) {
250 memset(&msg
, 0, sizeof(msg
));
251 strncpy(msg
.channel_name
, channel_name
, sizeof(msg
.channel_name
));
252 strncpy(msg
.pathname
, pathname
, sizeof(msg
.pathname
));
255 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg
, sizeof(msg
), 0);
260 memset(&msg_2_2
, 0, sizeof(msg_2_2
));
261 /* Compat with relayd 2.2+ */
262 strncpy(msg_2_2
.channel_name
, channel_name
, sizeof(msg_2_2
.channel_name
));
263 strncpy(msg_2_2
.pathname
, pathname
, sizeof(msg_2_2
.pathname
));
264 msg_2_2
.tracefile_size
= htobe64(tracefile_size
);
265 msg_2_2
.tracefile_count
= htobe64(tracefile_count
);
268 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg_2_2
, sizeof(msg_2_2
), 0);
274 /* Waiting for reply */
275 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
280 /* Back to host bytes order. */
281 reply
.handle
= be64toh(reply
.handle
);
282 reply
.ret_code
= be32toh(reply
.ret_code
);
284 /* Return session id or negative ret code. */
285 if (reply
.ret_code
!= LTTNG_OK
) {
287 ERR("Relayd add stream replied error %d", reply
.ret_code
);
291 *stream_id
= reply
.handle
;
294 DBG("Relayd stream added successfully with handle %" PRIu64
,
302 * Inform the relay that all the streams for the current channel has been sent.
304 * On success return 0 else return ret_code negative value.
306 int relayd_streams_sent(struct lttcomm_relayd_sock
*rsock
)
309 struct lttcomm_relayd_generic_reply reply
;
311 /* Code flow error. Safety net. */
314 DBG("Relayd sending streams sent.");
316 /* This feature was introduced in 2.4, ignore it for earlier versions. */
317 if (rsock
->minor
< 4) {
323 ret
= send_command(rsock
, RELAYD_STREAMS_SENT
, NULL
, 0, 0);
328 /* Waiting for reply */
329 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
334 /* Back to host bytes order. */
335 reply
.ret_code
= be32toh(reply
.ret_code
);
337 /* Return session id or negative ret code. */
338 if (reply
.ret_code
!= LTTNG_OK
) {
340 ERR("Relayd streams sent replied error %d", reply
.ret_code
);
347 DBG("Relayd streams sent success");
355 * Check version numbers on the relayd.
356 * If major versions are compatible, we assign minor_to_use to the
357 * minor version of the procotol we are going to use for this session.
359 * Return 0 if compatible else negative value.
361 int relayd_version_check(struct lttcomm_relayd_sock
*rsock
)
364 struct lttcomm_relayd_version msg
;
366 /* Code flow error. Safety net. */
369 DBG("Relayd version check for major.minor %u.%u", rsock
->major
,
372 memset(&msg
, 0, sizeof(msg
));
373 /* Prepare network byte order before transmission. */
374 msg
.major
= htobe32(rsock
->major
);
375 msg
.minor
= htobe32(rsock
->minor
);
378 ret
= send_command(rsock
, RELAYD_VERSION
, (void *) &msg
, sizeof(msg
), 0);
383 /* Receive response */
384 ret
= recv_reply(rsock
, (void *) &msg
, sizeof(msg
));
389 /* Set back to host bytes order */
390 msg
.major
= be32toh(msg
.major
);
391 msg
.minor
= be32toh(msg
.minor
);
394 * Only validate the major version. If the other side is higher,
395 * communication is not possible. Only major version equal can talk to each
396 * other. If the minor version differs, the lowest version is used by both
399 if (msg
.major
!= rsock
->major
) {
402 DBG2("Relayd version is NOT compatible. Relayd version %u != %u (us)",
403 msg
.major
, rsock
->major
);
408 * If the relayd's minor version is higher, it will adapt to our version so
409 * we can continue to use the latest relayd communication data structure.
410 * If the received minor version is higher, the relayd should adapt to us.
412 if (rsock
->minor
> msg
.minor
) {
413 rsock
->minor
= msg
.minor
;
416 /* Version number compatible */
417 DBG2("Relayd version is compatible, using protocol version %u.%u",
418 rsock
->major
, rsock
->minor
);
426 * Add stream on the relayd and assign stream handle to the stream_id argument.
428 * On success return 0 else return ret_code negative value.
430 int relayd_send_metadata(struct lttcomm_relayd_sock
*rsock
, size_t len
)
434 /* Code flow error. Safety net. */
437 DBG("Relayd sending metadata of size %zu", len
);
440 ret
= send_command(rsock
, RELAYD_SEND_METADATA
, NULL
, len
, 0);
445 DBG2("Relayd metadata added successfully");
448 * After that call, the metadata data MUST be sent to the relayd so the
449 * receive size on the other end matches the len of the metadata packet
450 * header. This is why we don't wait for a reply here.
458 * Connect to relay daemon with an allocated lttcomm_relayd_sock.
460 int relayd_connect(struct lttcomm_relayd_sock
*rsock
)
462 /* Code flow error. Safety net. */
465 if (!rsock
->sock
.ops
) {
467 * Attempting a connect on a non-initialized socket.
472 DBG3("Relayd connect ...");
474 return rsock
->sock
.ops
->connect(&rsock
->sock
);
478 * Close relayd socket with an allocated lttcomm_relayd_sock.
480 * If no socket operations are found, simply return 0 meaning that everything
481 * is fine. Without operations, the socket can not possibly be opened or used.
482 * This is possible if the socket was allocated but not created. However, the
483 * caller could simply use it to store a valid file descriptor for instance
484 * passed over a Unix socket and call this to cleanup but still without a valid
487 * Return the close returned value. On error, a negative value is usually
488 * returned back from close(2).
490 int relayd_close(struct lttcomm_relayd_sock
*rsock
)
494 /* Code flow error. Safety net. */
497 /* An invalid fd is fine, return success. */
498 if (rsock
->sock
.fd
< 0) {
503 DBG3("Relayd closing socket %d", rsock
->sock
.fd
);
505 if (rsock
->sock
.ops
) {
506 ret
= rsock
->sock
.ops
->close(&rsock
->sock
);
508 /* Default call if no specific ops found. */
509 ret
= close(rsock
->sock
.fd
);
511 PERROR("relayd_close default close");
521 * Send data header structure to the relayd.
523 int relayd_send_data_hdr(struct lttcomm_relayd_sock
*rsock
,
524 struct lttcomm_relayd_data_hdr
*hdr
, size_t size
)
528 /* Code flow error. Safety net. */
532 if (rsock
->sock
.fd
< 0) {
536 DBG3("Relayd sending data header of size %zu", size
);
538 /* Again, safety net */
540 size
= sizeof(struct lttcomm_relayd_data_hdr
);
543 /* Only send data header. */
544 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, hdr
, size
, 0);
551 * The data MUST be sent right after that command for the receive on the
552 * other end to match the size in the header.
560 * Send close stream command to the relayd.
562 int relayd_send_close_stream(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
563 uint64_t last_net_seq_num
)
566 struct lttcomm_relayd_close_stream msg
;
567 struct lttcomm_relayd_generic_reply reply
;
569 /* Code flow error. Safety net. */
572 DBG("Relayd closing stream id %" PRIu64
, stream_id
);
574 memset(&msg
, 0, sizeof(msg
));
575 msg
.stream_id
= htobe64(stream_id
);
576 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
579 ret
= send_command(rsock
, RELAYD_CLOSE_STREAM
, (void *) &msg
, sizeof(msg
), 0);
584 /* Receive response */
585 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
590 reply
.ret_code
= be32toh(reply
.ret_code
);
592 /* Return session id or negative ret code. */
593 if (reply
.ret_code
!= LTTNG_OK
) {
595 ERR("Relayd close stream replied error %d", reply
.ret_code
);
601 DBG("Relayd close stream id %" PRIu64
" successfully", stream_id
);
608 * Check for data availability for a given stream id.
610 * Return 0 if NOT pending, 1 if so and a negative value on error.
612 int relayd_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
613 uint64_t last_net_seq_num
)
616 struct lttcomm_relayd_data_pending msg
;
617 struct lttcomm_relayd_generic_reply reply
;
619 /* Code flow error. Safety net. */
622 DBG("Relayd data pending for stream id %" PRIu64
, stream_id
);
624 memset(&msg
, 0, sizeof(msg
));
625 msg
.stream_id
= htobe64(stream_id
);
626 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
629 ret
= send_command(rsock
, RELAYD_DATA_PENDING
, (void *) &msg
,
635 /* Receive response */
636 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
641 reply
.ret_code
= be32toh(reply
.ret_code
);
643 /* Return session id or negative ret code. */
644 if (reply
.ret_code
>= LTTNG_OK
) {
645 ERR("Relayd data pending replied error %d", reply
.ret_code
);
648 /* At this point, the ret code is either 1 or 0 */
649 ret
= reply
.ret_code
;
651 DBG("Relayd data is %s pending for stream id %" PRIu64
,
652 ret
== 1 ? "" : "NOT", stream_id
);
659 * Check on the relayd side for a quiescent state on the control socket.
661 int relayd_quiescent_control(struct lttcomm_relayd_sock
*rsock
,
662 uint64_t metadata_stream_id
)
665 struct lttcomm_relayd_quiescent_control msg
;
666 struct lttcomm_relayd_generic_reply reply
;
668 /* Code flow error. Safety net. */
671 DBG("Relayd checking quiescent control state");
673 memset(&msg
, 0, sizeof(msg
));
674 msg
.stream_id
= htobe64(metadata_stream_id
);
677 ret
= send_command(rsock
, RELAYD_QUIESCENT_CONTROL
, &msg
, sizeof(msg
), 0);
682 /* Receive response */
683 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
688 reply
.ret_code
= be32toh(reply
.ret_code
);
690 /* Return session id or negative ret code. */
691 if (reply
.ret_code
!= LTTNG_OK
) {
693 ERR("Relayd quiescent control replied error %d", reply
.ret_code
);
697 /* Control socket is quiescent */
705 * Begin a data pending command for a specific session id.
707 int relayd_begin_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
)
710 struct lttcomm_relayd_begin_data_pending msg
;
711 struct lttcomm_relayd_generic_reply reply
;
713 /* Code flow error. Safety net. */
716 DBG("Relayd begin data pending");
718 memset(&msg
, 0, sizeof(msg
));
719 msg
.session_id
= htobe64(id
);
722 ret
= send_command(rsock
, RELAYD_BEGIN_DATA_PENDING
, &msg
, sizeof(msg
), 0);
727 /* Receive response */
728 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
733 reply
.ret_code
= be32toh(reply
.ret_code
);
735 /* Return session id or negative ret code. */
736 if (reply
.ret_code
!= LTTNG_OK
) {
738 ERR("Relayd begin data pending replied error %d", reply
.ret_code
);
749 * End a data pending command for a specific session id.
751 * Return 0 on success and set is_data_inflight to 0 if no data is being
752 * streamed or 1 if it is the case.
754 int relayd_end_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
,
755 unsigned int *is_data_inflight
)
758 struct lttcomm_relayd_end_data_pending msg
;
759 struct lttcomm_relayd_generic_reply reply
;
761 /* Code flow error. Safety net. */
764 DBG("Relayd end data pending");
766 memset(&msg
, 0, sizeof(msg
));
767 msg
.session_id
= htobe64(id
);
770 ret
= send_command(rsock
, RELAYD_END_DATA_PENDING
, &msg
, sizeof(msg
), 0);
775 /* Receive response */
776 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
781 recv_ret
= be32toh(reply
.ret_code
);
787 *is_data_inflight
= recv_ret
;
789 DBG("Relayd end data pending is data inflight: %d", recv_ret
);
798 * Send index to the relayd.
800 int relayd_send_index(struct lttcomm_relayd_sock
*rsock
,
801 struct ctf_packet_index
*index
, uint64_t relay_stream_id
,
802 uint64_t net_seq_num
)
805 struct lttcomm_relayd_index msg
;
806 struct lttcomm_relayd_generic_reply reply
;
808 /* Code flow error. Safety net. */
811 if (rsock
->minor
< 4) {
812 DBG("Not sending indexes before protocol 2.4");
817 DBG("Relayd sending index for stream ID %" PRIu64
, relay_stream_id
);
819 memset(&msg
, 0, sizeof(msg
));
820 msg
.relay_stream_id
= htobe64(relay_stream_id
);
821 msg
.net_seq_num
= htobe64(net_seq_num
);
823 /* The index is already in big endian. */
824 msg
.packet_size
= index
->packet_size
;
825 msg
.content_size
= index
->content_size
;
826 msg
.timestamp_begin
= index
->timestamp_begin
;
827 msg
.timestamp_end
= index
->timestamp_end
;
828 msg
.events_discarded
= index
->events_discarded
;
829 msg
.stream_id
= index
->stream_id
;
832 ret
= send_command(rsock
, RELAYD_SEND_INDEX
, &msg
, sizeof(msg
), 0);
837 /* Receive response */
838 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
843 reply
.ret_code
= be32toh(reply
.ret_code
);
845 /* Return session id or negative ret code. */
846 if (reply
.ret_code
!= LTTNG_OK
) {
848 ERR("Relayd send index replied error %d", reply
.ret_code
);