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/sessiond-comm/relayd.h>
29 #include <common/index/ctf-index.h>
34 * Send command. Fill up the header and append the data.
36 static int send_command(struct lttcomm_relayd_sock
*rsock
,
37 enum lttcomm_relayd_command cmd
, void *data
, size_t size
,
41 struct lttcomm_relayd_hdr header
;
43 uint64_t buf_size
= sizeof(header
);
45 if (rsock
->sock
.fd
< 0) {
53 buf
= zmalloc(buf_size
);
55 PERROR("zmalloc relayd send command buf");
60 header
.cmd
= htobe32(cmd
);
61 header
.data_size
= htobe64(size
);
63 /* Zeroed for now since not used. */
64 header
.cmd_version
= 0;
65 header
.circuit_id
= 0;
67 /* Prepare buffer to send. */
68 memcpy(buf
, &header
, sizeof(header
));
70 memcpy(buf
+ sizeof(header
), data
, size
);
73 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, buf
, buf_size
, flags
);
79 DBG3("Relayd sending command %d of size %" PRIu64
, cmd
, buf_size
);
88 * Receive reply data on socket. This MUST be call after send_command or else
89 * could result in unexpected behavior(s).
91 static int recv_reply(struct lttcomm_relayd_sock
*rsock
, void *data
, size_t size
)
95 if (rsock
->sock
.fd
< 0) {
99 DBG3("Relayd waiting for reply of size %zu", size
);
101 ret
= rsock
->sock
.ops
->recvmsg(&rsock
->sock
, data
, size
, 0);
102 if (ret
<= 0 || ret
!= size
) {
104 /* Orderly shutdown. */
105 DBG("Socket %d has performed an orderly shutdown", rsock
->sock
.fd
);
107 DBG("Receiving reply failed on sock %d for size %zu with ret %d",
108 rsock
->sock
.fd
, size
, ret
);
110 /* Always return -1 here and the caller can use errno. */
120 * Starting at 2.4, RELAYD_CREATE_SESSION takes additional parameters to
121 * support the live reading capability.
123 static int relayd_create_session_2_4(struct lttcomm_relayd_sock
*rsock
,
124 uint64_t *session_id
, char *session_name
, char *hostname
,
125 int session_live_timer
, unsigned int snapshot
)
128 struct lttcomm_relayd_create_session_2_4 msg
;
130 strncpy(msg
.session_name
, session_name
, sizeof(msg
.session_name
));
131 strncpy(msg
.hostname
, hostname
, sizeof(msg
.hostname
));
132 msg
.live_timer
= htobe32(session_live_timer
);
133 msg
.snapshot
= htobe32(snapshot
);
136 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, &msg
, sizeof(msg
), 0);
146 * RELAYD_CREATE_SESSION from 2.1 to 2.3.
148 static int relayd_create_session_2_1(struct lttcomm_relayd_sock
*rsock
,
149 uint64_t *session_id
)
154 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, NULL
, 0, 0);
164 * Send a RELAYD_CREATE_SESSION command to the relayd with the given socket and
165 * set session_id of the relayd if we have a successful reply from the relayd.
167 * On success, return 0 else a negative value which is either an errno error or
168 * a lttng error code from the relayd.
170 int relayd_create_session(struct lttcomm_relayd_sock
*rsock
, uint64_t *session_id
,
171 char *session_name
, char *hostname
, int session_live_timer
,
172 unsigned int snapshot
)
175 struct lttcomm_relayd_status_session reply
;
180 DBG("Relayd create session");
182 switch(rsock
->minor
) {
186 ret
= relayd_create_session_2_1(rsock
, session_id
);
190 ret
= relayd_create_session_2_4(rsock
, session_id
, session_name
,
191 hostname
, session_live_timer
, snapshot
);
199 /* Receive response */
200 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
205 reply
.session_id
= be64toh(reply
.session_id
);
206 reply
.ret_code
= be32toh(reply
.ret_code
);
208 /* Return session id or negative ret code. */
209 if (reply
.ret_code
!= LTTNG_OK
) {
211 ERR("Relayd create session replied error %d", reply
.ret_code
);
215 *session_id
= reply
.session_id
;
218 DBG("Relayd session created with id %" PRIu64
, reply
.session_id
);
225 * Add stream on the relayd and assign stream handle to the stream_id argument.
227 * On success return 0 else return ret_code negative value.
229 int relayd_add_stream(struct lttcomm_relayd_sock
*rsock
, const char *channel_name
,
230 const char *pathname
, uint64_t *stream_id
,
231 uint64_t tracefile_size
, uint64_t tracefile_count
)
234 struct lttcomm_relayd_add_stream msg
;
235 struct lttcomm_relayd_add_stream_2_2 msg_2_2
;
236 struct lttcomm_relayd_status_stream reply
;
238 /* Code flow error. Safety net. */
240 assert(channel_name
);
243 DBG("Relayd adding stream for channel name %s", channel_name
);
245 /* Compat with relayd 2.1 */
246 if (rsock
->minor
== 1) {
247 strncpy(msg
.channel_name
, channel_name
, sizeof(msg
.channel_name
));
248 strncpy(msg
.pathname
, pathname
, sizeof(msg
.pathname
));
251 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg
, sizeof(msg
), 0);
256 /* Compat with relayd 2.2+ */
257 strncpy(msg_2_2
.channel_name
, channel_name
, sizeof(msg_2_2
.channel_name
));
258 strncpy(msg_2_2
.pathname
, pathname
, sizeof(msg_2_2
.pathname
));
259 msg_2_2
.tracefile_size
= htobe64(tracefile_size
);
260 msg_2_2
.tracefile_count
= htobe64(tracefile_count
);
263 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg_2_2
, sizeof(msg_2_2
), 0);
269 /* Waiting for reply */
270 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
275 /* Back to host bytes order. */
276 reply
.handle
= be64toh(reply
.handle
);
277 reply
.ret_code
= be32toh(reply
.ret_code
);
279 /* Return session id or negative ret code. */
280 if (reply
.ret_code
!= LTTNG_OK
) {
282 ERR("Relayd add stream replied error %d", reply
.ret_code
);
286 *stream_id
= reply
.handle
;
289 DBG("Relayd stream added successfully with handle %" PRIu64
,
297 * Inform the relay that all the streams for the current channel has been sent.
299 * On success return 0 else return ret_code negative value.
301 int relayd_streams_sent(struct lttcomm_relayd_sock
*rsock
)
304 struct lttcomm_relayd_generic_reply reply
;
306 /* Code flow error. Safety net. */
309 DBG("Relayd sending streams sent.");
311 /* This feature was introduced in 2.4, ignore it for earlier versions. */
312 if (rsock
->minor
< 4) {
318 ret
= send_command(rsock
, RELAYD_STREAMS_SENT
, NULL
, 0, 0);
323 /* Waiting for reply */
324 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
329 /* Back to host bytes order. */
330 reply
.ret_code
= be32toh(reply
.ret_code
);
332 /* Return session id or negative ret code. */
333 if (reply
.ret_code
!= LTTNG_OK
) {
335 ERR("Relayd streams sent replied error %d", reply
.ret_code
);
342 DBG("Relayd streams sent success");
350 * Check version numbers on the relayd.
351 * If major versions are compatible, we assign minor_to_use to the
352 * minor version of the procotol we are going to use for this session.
354 * Return 0 if compatible else negative value.
356 int relayd_version_check(struct lttcomm_relayd_sock
*rsock
)
359 struct lttcomm_relayd_version msg
;
361 /* Code flow error. Safety net. */
364 DBG("Relayd version check for major.minor %u.%u", rsock
->major
,
367 /* Prepare network byte order before transmission. */
368 msg
.major
= htobe32(rsock
->major
);
369 msg
.minor
= htobe32(rsock
->minor
);
372 ret
= send_command(rsock
, RELAYD_VERSION
, (void *) &msg
, sizeof(msg
), 0);
377 /* Receive response */
378 ret
= recv_reply(rsock
, (void *) &msg
, sizeof(msg
));
383 /* Set back to host bytes order */
384 msg
.major
= be32toh(msg
.major
);
385 msg
.minor
= be32toh(msg
.minor
);
388 * Only validate the major version. If the other side is higher,
389 * communication is not possible. Only major version equal can talk to each
390 * other. If the minor version differs, the lowest version is used by both
393 if (msg
.major
!= rsock
->major
) {
396 DBG2("Relayd version is NOT compatible. Relayd version %u != %u (us)",
397 msg
.major
, rsock
->major
);
402 * If the relayd's minor version is higher, it will adapt to our version so
403 * we can continue to use the latest relayd communication data structure.
404 * If the received minor version is higher, the relayd should adapt to us.
406 if (rsock
->minor
> msg
.minor
) {
407 rsock
->minor
= msg
.minor
;
410 /* Version number compatible */
411 DBG2("Relayd version is compatible, using protocol version %u.%u",
412 rsock
->major
, rsock
->minor
);
420 * Add stream on the relayd and assign stream handle to the stream_id argument.
422 * On success return 0 else return ret_code negative value.
424 int relayd_send_metadata(struct lttcomm_relayd_sock
*rsock
, size_t len
)
428 /* Code flow error. Safety net. */
431 DBG("Relayd sending metadata of size %zu", len
);
434 ret
= send_command(rsock
, RELAYD_SEND_METADATA
, NULL
, len
, 0);
439 DBG2("Relayd metadata added successfully");
442 * After that call, the metadata data MUST be sent to the relayd so the
443 * receive size on the other end matches the len of the metadata packet
444 * header. This is why we don't wait for a reply here.
452 * Connect to relay daemon with an allocated lttcomm_relayd_sock.
454 int relayd_connect(struct lttcomm_relayd_sock
*rsock
)
456 /* Code flow error. Safety net. */
459 if (!rsock
->sock
.ops
) {
461 * Attempting a connect on a non-initialized socket.
466 DBG3("Relayd connect ...");
468 return rsock
->sock
.ops
->connect(&rsock
->sock
);
472 * Close relayd socket with an allocated lttcomm_relayd_sock.
474 * If no socket operations are found, simply return 0 meaning that everything
475 * is fine. Without operations, the socket can not possibly be opened or used.
476 * This is possible if the socket was allocated but not created. However, the
477 * caller could simply use it to store a valid file descriptor for instance
478 * passed over a Unix socket and call this to cleanup but still without a valid
481 * Return the close returned value. On error, a negative value is usually
482 * returned back from close(2).
484 int relayd_close(struct lttcomm_relayd_sock
*rsock
)
488 /* Code flow error. Safety net. */
491 /* An invalid fd is fine, return success. */
492 if (rsock
->sock
.fd
< 0) {
497 DBG3("Relayd closing socket %d", rsock
->sock
.fd
);
499 if (rsock
->sock
.ops
) {
500 ret
= rsock
->sock
.ops
->close(&rsock
->sock
);
502 /* Default call if no specific ops found. */
503 ret
= close(rsock
->sock
.fd
);
505 PERROR("relayd_close default close");
515 * Send data header structure to the relayd.
517 int relayd_send_data_hdr(struct lttcomm_relayd_sock
*rsock
,
518 struct lttcomm_relayd_data_hdr
*hdr
, size_t size
)
522 /* Code flow error. Safety net. */
526 if (rsock
->sock
.fd
< 0) {
530 DBG3("Relayd sending data header of size %zu", size
);
532 /* Again, safety net */
534 size
= sizeof(struct lttcomm_relayd_data_hdr
);
537 /* Only send data header. */
538 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, hdr
, size
, 0);
545 * The data MUST be sent right after that command for the receive on the
546 * other end to match the size in the header.
554 * Send close stream command to the relayd.
556 int relayd_send_close_stream(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
557 uint64_t last_net_seq_num
)
560 struct lttcomm_relayd_close_stream msg
;
561 struct lttcomm_relayd_generic_reply reply
;
563 /* Code flow error. Safety net. */
566 DBG("Relayd closing stream id %" PRIu64
, stream_id
);
568 msg
.stream_id
= htobe64(stream_id
);
569 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
572 ret
= send_command(rsock
, RELAYD_CLOSE_STREAM
, (void *) &msg
, sizeof(msg
), 0);
577 /* Receive response */
578 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
583 reply
.ret_code
= be32toh(reply
.ret_code
);
585 /* Return session id or negative ret code. */
586 if (reply
.ret_code
!= LTTNG_OK
) {
588 ERR("Relayd close stream replied error %d", reply
.ret_code
);
594 DBG("Relayd close stream id %" PRIu64
" successfully", stream_id
);
601 * Check for data availability for a given stream id.
603 * Return 0 if NOT pending, 1 if so and a negative value on error.
605 int relayd_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
606 uint64_t last_net_seq_num
)
609 struct lttcomm_relayd_data_pending msg
;
610 struct lttcomm_relayd_generic_reply reply
;
612 /* Code flow error. Safety net. */
615 DBG("Relayd data pending for stream id %" PRIu64
, stream_id
);
617 msg
.stream_id
= htobe64(stream_id
);
618 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
621 ret
= send_command(rsock
, RELAYD_DATA_PENDING
, (void *) &msg
,
627 /* Receive response */
628 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
633 reply
.ret_code
= be32toh(reply
.ret_code
);
635 /* Return session id or negative ret code. */
636 if (reply
.ret_code
>= LTTNG_OK
) {
637 ERR("Relayd data pending replied error %d", reply
.ret_code
);
640 /* At this point, the ret code is either 1 or 0 */
641 ret
= reply
.ret_code
;
643 DBG("Relayd data is %s pending for stream id %" PRIu64
,
644 ret
== 1 ? "" : "NOT", stream_id
);
651 * Check on the relayd side for a quiescent state on the control socket.
653 int relayd_quiescent_control(struct lttcomm_relayd_sock
*rsock
,
654 uint64_t metadata_stream_id
)
657 struct lttcomm_relayd_quiescent_control msg
;
658 struct lttcomm_relayd_generic_reply reply
;
660 /* Code flow error. Safety net. */
663 DBG("Relayd checking quiescent control state");
665 msg
.stream_id
= htobe64(metadata_stream_id
);
668 ret
= send_command(rsock
, RELAYD_QUIESCENT_CONTROL
, &msg
, sizeof(msg
), 0);
673 /* Receive response */
674 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
679 reply
.ret_code
= be32toh(reply
.ret_code
);
681 /* Return session id or negative ret code. */
682 if (reply
.ret_code
!= LTTNG_OK
) {
684 ERR("Relayd quiescent control replied error %d", reply
.ret_code
);
688 /* Control socket is quiescent */
696 * Begin a data pending command for a specific session id.
698 int relayd_begin_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
)
701 struct lttcomm_relayd_begin_data_pending msg
;
702 struct lttcomm_relayd_generic_reply reply
;
704 /* Code flow error. Safety net. */
707 DBG("Relayd begin data pending");
709 msg
.session_id
= htobe64(id
);
712 ret
= send_command(rsock
, RELAYD_BEGIN_DATA_PENDING
, &msg
, sizeof(msg
), 0);
717 /* Receive response */
718 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
723 reply
.ret_code
= be32toh(reply
.ret_code
);
725 /* Return session id or negative ret code. */
726 if (reply
.ret_code
!= LTTNG_OK
) {
728 ERR("Relayd begin data pending replied error %d", reply
.ret_code
);
739 * End a data pending command for a specific session id.
741 * Return 0 on success and set is_data_inflight to 0 if no data is being
742 * streamed or 1 if it is the case.
744 int relayd_end_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
,
745 unsigned int *is_data_inflight
)
748 struct lttcomm_relayd_end_data_pending msg
;
749 struct lttcomm_relayd_generic_reply reply
;
751 /* Code flow error. Safety net. */
754 DBG("Relayd end data pending");
756 msg
.session_id
= htobe64(id
);
759 ret
= send_command(rsock
, RELAYD_END_DATA_PENDING
, &msg
, sizeof(msg
), 0);
764 /* Receive response */
765 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
770 recv_ret
= be32toh(reply
.ret_code
);
776 *is_data_inflight
= recv_ret
;
778 DBG("Relayd end data pending is data inflight: %d", recv_ret
);
787 * Send index to the relayd.
789 int relayd_send_index(struct lttcomm_relayd_sock
*rsock
,
790 struct ctf_packet_index
*index
, uint64_t relay_stream_id
,
791 uint64_t net_seq_num
)
794 struct lttcomm_relayd_index msg
;
795 struct lttcomm_relayd_generic_reply reply
;
797 /* Code flow error. Safety net. */
800 if (rsock
->minor
< 4) {
801 DBG("Not sending indexes before protocol 2.4");
806 DBG("Relayd sending index for stream ID %" PRIu64
, relay_stream_id
);
808 msg
.relay_stream_id
= htobe64(relay_stream_id
);
809 msg
.net_seq_num
= htobe64(net_seq_num
);
811 /* The index is already in big endian. */
812 msg
.packet_size
= index
->packet_size
;
813 msg
.content_size
= index
->content_size
;
814 msg
.timestamp_begin
= index
->timestamp_begin
;
815 msg
.timestamp_end
= index
->timestamp_end
;
816 msg
.events_discarded
= index
->events_discarded
;
817 msg
.stream_id
= index
->stream_id
;
820 ret
= send_command(rsock
, RELAYD_SEND_INDEX
, &msg
, sizeof(msg
), 0);
825 /* Receive response */
826 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
831 reply
.ret_code
= be32toh(reply
.ret_code
);
833 /* Return session id or negative ret code. */
834 if (reply
.ret_code
!= LTTNG_OK
) {
836 ERR("Relayd send index replied error %d", reply
.ret_code
);