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 * Check version numbers on the relayd.
298 * If major versions are compatible, we assign minor_to_use to the
299 * minor version of the procotol we are going to use for this session.
301 * Return 0 if compatible else negative value.
303 int relayd_version_check(struct lttcomm_relayd_sock
*rsock
)
306 struct lttcomm_relayd_version msg
;
308 /* Code flow error. Safety net. */
311 DBG("Relayd version check for major.minor %u.%u", rsock
->major
,
314 /* Prepare network byte order before transmission. */
315 msg
.major
= htobe32(rsock
->major
);
316 msg
.minor
= htobe32(rsock
->minor
);
319 ret
= send_command(rsock
, RELAYD_VERSION
, (void *) &msg
, sizeof(msg
), 0);
324 /* Receive response */
325 ret
= recv_reply(rsock
, (void *) &msg
, sizeof(msg
));
330 /* Set back to host bytes order */
331 msg
.major
= be32toh(msg
.major
);
332 msg
.minor
= be32toh(msg
.minor
);
335 * Only validate the major version. If the other side is higher,
336 * communication is not possible. Only major version equal can talk to each
337 * other. If the minor version differs, the lowest version is used by both
340 if (msg
.major
!= rsock
->major
) {
343 DBG2("Relayd version is NOT compatible. Relayd version %u != %u (us)",
344 msg
.major
, rsock
->major
);
349 * If the relayd's minor version is higher, it will adapt to our version so
350 * we can continue to use the latest relayd communication data structure.
351 * If the received minor version is higher, the relayd should adapt to us.
353 if (rsock
->minor
> msg
.minor
) {
354 rsock
->minor
= msg
.minor
;
357 /* Version number compatible */
358 DBG2("Relayd version is compatible, using protocol version %u.%u",
359 rsock
->major
, rsock
->minor
);
367 * Add stream on the relayd and assign stream handle to the stream_id argument.
369 * On success return 0 else return ret_code negative value.
371 int relayd_send_metadata(struct lttcomm_relayd_sock
*rsock
, size_t len
)
375 /* Code flow error. Safety net. */
378 DBG("Relayd sending metadata of size %zu", len
);
381 ret
= send_command(rsock
, RELAYD_SEND_METADATA
, NULL
, len
, 0);
386 DBG2("Relayd metadata added successfully");
389 * After that call, the metadata data MUST be sent to the relayd so the
390 * receive size on the other end matches the len of the metadata packet
391 * header. This is why we don't wait for a reply here.
399 * Connect to relay daemon with an allocated lttcomm_relayd_sock.
401 int relayd_connect(struct lttcomm_relayd_sock
*rsock
)
403 /* Code flow error. Safety net. */
406 if (!rsock
->sock
.ops
) {
408 * Attempting a connect on a non-initialized socket.
413 DBG3("Relayd connect ...");
415 return rsock
->sock
.ops
->connect(&rsock
->sock
);
419 * Close relayd socket with an allocated lttcomm_relayd_sock.
421 * If no socket operations are found, simply return 0 meaning that everything
422 * is fine. Without operations, the socket can not possibly be opened or used.
423 * This is possible if the socket was allocated but not created. However, the
424 * caller could simply use it to store a valid file descriptor for instance
425 * passed over a Unix socket and call this to cleanup but still without a valid
428 * Return the close returned value. On error, a negative value is usually
429 * returned back from close(2).
431 int relayd_close(struct lttcomm_relayd_sock
*rsock
)
435 /* Code flow error. Safety net. */
438 /* An invalid fd is fine, return success. */
439 if (rsock
->sock
.fd
< 0) {
444 DBG3("Relayd closing socket %d", rsock
->sock
.fd
);
446 if (rsock
->sock
.ops
) {
447 ret
= rsock
->sock
.ops
->close(&rsock
->sock
);
449 /* Default call if no specific ops found. */
450 ret
= close(rsock
->sock
.fd
);
452 PERROR("relayd_close default close");
462 * Send data header structure to the relayd.
464 int relayd_send_data_hdr(struct lttcomm_relayd_sock
*rsock
,
465 struct lttcomm_relayd_data_hdr
*hdr
, size_t size
)
469 /* Code flow error. Safety net. */
473 if (rsock
->sock
.fd
< 0) {
477 DBG3("Relayd sending data header of size %zu", size
);
479 /* Again, safety net */
481 size
= sizeof(struct lttcomm_relayd_data_hdr
);
484 /* Only send data header. */
485 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, hdr
, size
, 0);
492 * The data MUST be sent right after that command for the receive on the
493 * other end to match the size in the header.
501 * Send close stream command to the relayd.
503 int relayd_send_close_stream(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
504 uint64_t last_net_seq_num
)
507 struct lttcomm_relayd_close_stream msg
;
508 struct lttcomm_relayd_generic_reply reply
;
510 /* Code flow error. Safety net. */
513 DBG("Relayd closing stream id %" PRIu64
, stream_id
);
515 msg
.stream_id
= htobe64(stream_id
);
516 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
519 ret
= send_command(rsock
, RELAYD_CLOSE_STREAM
, (void *) &msg
, sizeof(msg
), 0);
524 /* Receive response */
525 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
530 reply
.ret_code
= be32toh(reply
.ret_code
);
532 /* Return session id or negative ret code. */
533 if (reply
.ret_code
!= LTTNG_OK
) {
535 ERR("Relayd close stream replied error %d", reply
.ret_code
);
541 DBG("Relayd close stream id %" PRIu64
" successfully", stream_id
);
548 * Check for data availability for a given stream id.
550 * Return 0 if NOT pending, 1 if so and a negative value on error.
552 int relayd_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
553 uint64_t last_net_seq_num
)
556 struct lttcomm_relayd_data_pending msg
;
557 struct lttcomm_relayd_generic_reply reply
;
559 /* Code flow error. Safety net. */
562 DBG("Relayd data pending for stream id %" PRIu64
, stream_id
);
564 msg
.stream_id
= htobe64(stream_id
);
565 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
568 ret
= send_command(rsock
, RELAYD_DATA_PENDING
, (void *) &msg
,
574 /* Receive response */
575 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
580 reply
.ret_code
= be32toh(reply
.ret_code
);
582 /* Return session id or negative ret code. */
583 if (reply
.ret_code
>= LTTNG_OK
) {
584 ERR("Relayd data pending replied error %d", reply
.ret_code
);
587 /* At this point, the ret code is either 1 or 0 */
588 ret
= reply
.ret_code
;
590 DBG("Relayd data is %s pending for stream id %" PRIu64
,
591 ret
== 1 ? "" : "NOT", stream_id
);
598 * Check on the relayd side for a quiescent state on the control socket.
600 int relayd_quiescent_control(struct lttcomm_relayd_sock
*rsock
,
601 uint64_t metadata_stream_id
)
604 struct lttcomm_relayd_quiescent_control msg
;
605 struct lttcomm_relayd_generic_reply reply
;
607 /* Code flow error. Safety net. */
610 DBG("Relayd checking quiescent control state");
612 msg
.stream_id
= htobe64(metadata_stream_id
);
615 ret
= send_command(rsock
, RELAYD_QUIESCENT_CONTROL
, &msg
, sizeof(msg
), 0);
620 /* Receive response */
621 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
626 reply
.ret_code
= be32toh(reply
.ret_code
);
628 /* Return session id or negative ret code. */
629 if (reply
.ret_code
!= LTTNG_OK
) {
631 ERR("Relayd quiescent control replied error %d", reply
.ret_code
);
635 /* Control socket is quiescent */
643 * Begin a data pending command for a specific session id.
645 int relayd_begin_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
)
648 struct lttcomm_relayd_begin_data_pending msg
;
649 struct lttcomm_relayd_generic_reply reply
;
651 /* Code flow error. Safety net. */
654 DBG("Relayd begin data pending");
656 msg
.session_id
= htobe64(id
);
659 ret
= send_command(rsock
, RELAYD_BEGIN_DATA_PENDING
, &msg
, sizeof(msg
), 0);
664 /* Receive response */
665 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
670 reply
.ret_code
= be32toh(reply
.ret_code
);
672 /* Return session id or negative ret code. */
673 if (reply
.ret_code
!= LTTNG_OK
) {
675 ERR("Relayd begin data pending replied error %d", reply
.ret_code
);
686 * End a data pending command for a specific session id.
688 * Return 0 on success and set is_data_inflight to 0 if no data is being
689 * streamed or 1 if it is the case.
691 int relayd_end_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
,
692 unsigned int *is_data_inflight
)
695 struct lttcomm_relayd_end_data_pending msg
;
696 struct lttcomm_relayd_generic_reply reply
;
698 /* Code flow error. Safety net. */
701 DBG("Relayd end data pending");
703 msg
.session_id
= htobe64(id
);
706 ret
= send_command(rsock
, RELAYD_END_DATA_PENDING
, &msg
, sizeof(msg
), 0);
711 /* Receive response */
712 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
717 recv_ret
= be32toh(reply
.ret_code
);
723 *is_data_inflight
= recv_ret
;
725 DBG("Relayd end data pending is data inflight: %d", recv_ret
);
734 * Send index to the relayd.
736 int relayd_send_index(struct lttcomm_relayd_sock
*rsock
,
737 struct ctf_packet_index
*index
, uint64_t relay_stream_id
,
738 uint64_t net_seq_num
)
741 struct lttcomm_relayd_index msg
;
742 struct lttcomm_relayd_generic_reply reply
;
744 /* Code flow error. Safety net. */
747 if (rsock
->minor
< 4) {
748 DBG("Not sending indexes before protocol 2.4");
753 DBG("Relayd sending index for stream ID %" PRIu64
, relay_stream_id
);
755 msg
.relay_stream_id
= htobe64(relay_stream_id
);
756 msg
.net_seq_num
= htobe64(net_seq_num
);
758 /* The index is already in big endian. */
759 msg
.packet_size
= index
->packet_size
;
760 msg
.content_size
= index
->content_size
;
761 msg
.timestamp_begin
= index
->timestamp_begin
;
762 msg
.timestamp_end
= index
->timestamp_end
;
763 msg
.events_discarded
= index
->events_discarded
;
764 msg
.stream_id
= index
->stream_id
;
767 ret
= send_command(rsock
, RELAYD_SEND_INDEX
, &msg
, sizeof(msg
), 0);
772 /* Receive response */
773 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
778 reply
.ret_code
= be32toh(reply
.ret_code
);
780 /* Return session id or negative ret code. */
781 if (reply
.ret_code
!= LTTNG_OK
) {
783 ERR("Relayd send index replied error %d", reply
.ret_code
);