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/lttng-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
)
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
);
135 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, &msg
, sizeof(msg
), 0);
145 * RELAYD_CREATE_SESSION from 2.1 to 2.3.
147 static int relayd_create_session_2_1(struct lttcomm_relayd_sock
*rsock
,
148 uint64_t *session_id
)
153 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, NULL
, 0, 0);
163 * Send a RELAYD_CREATE_SESSION command to the relayd with the given socket and
164 * set session_id of the relayd if we have a successful reply from the relayd.
166 * On success, return 0 else a negative value which is either an errno error or
167 * a lttng error code from the relayd.
169 int relayd_create_session(struct lttcomm_relayd_sock
*rsock
, uint64_t *session_id
,
170 char *session_name
, char *hostname
, int session_live_timer
)
173 struct lttcomm_relayd_status_session reply
;
178 DBG("Relayd create session");
180 switch(rsock
->minor
) {
184 ret
= relayd_create_session_2_1(rsock
, session_id
);
187 ret
= relayd_create_session_2_4(rsock
, session_id
,
188 session_name
, hostname
,
196 /* Receive response */
197 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
202 reply
.session_id
= be64toh(reply
.session_id
);
203 reply
.ret_code
= be32toh(reply
.ret_code
);
205 /* Return session id or negative ret code. */
206 if (reply
.ret_code
!= LTTNG_OK
) {
208 ERR("Relayd create session replied error %d", reply
.ret_code
);
212 *session_id
= reply
.session_id
;
215 DBG("Relayd session created with id %" PRIu64
, reply
.session_id
);
222 * Add stream on the relayd and assign stream handle to the stream_id argument.
224 * On success return 0 else return ret_code negative value.
226 int relayd_add_stream(struct lttcomm_relayd_sock
*rsock
, const char *channel_name
,
227 const char *pathname
, uint64_t *stream_id
,
228 uint64_t tracefile_size
, uint64_t tracefile_count
)
231 struct lttcomm_relayd_add_stream msg
;
232 struct lttcomm_relayd_add_stream_2_2 msg_2_2
;
233 struct lttcomm_relayd_status_stream reply
;
235 /* Code flow error. Safety net. */
237 assert(channel_name
);
240 DBG("Relayd adding stream for channel name %s", channel_name
);
242 /* Compat with relayd 2.1 */
243 if (rsock
->minor
== 1) {
244 strncpy(msg
.channel_name
, channel_name
, sizeof(msg
.channel_name
));
245 strncpy(msg
.pathname
, pathname
, sizeof(msg
.pathname
));
248 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg
, sizeof(msg
), 0);
253 /* Compat with relayd 2.2+ */
254 strncpy(msg_2_2
.channel_name
, channel_name
, sizeof(msg_2_2
.channel_name
));
255 strncpy(msg_2_2
.pathname
, pathname
, sizeof(msg_2_2
.pathname
));
256 msg_2_2
.tracefile_size
= htobe64(tracefile_size
);
257 msg_2_2
.tracefile_count
= htobe64(tracefile_count
);
260 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg_2_2
, sizeof(msg_2_2
), 0);
266 /* Waiting for reply */
267 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
272 /* Back to host bytes order. */
273 reply
.handle
= be64toh(reply
.handle
);
274 reply
.ret_code
= be32toh(reply
.ret_code
);
276 /* Return session id or negative ret code. */
277 if (reply
.ret_code
!= LTTNG_OK
) {
279 ERR("Relayd add stream replied error %d", reply
.ret_code
);
283 *stream_id
= reply
.handle
;
286 DBG("Relayd stream added successfully with handle %" PRIu64
,
294 * Check version numbers on the relayd.
295 * If major versions are compatible, we assign minor_to_use to the
296 * minor version of the procotol we are going to use for this session.
298 * Return 0 if compatible else negative value.
300 int relayd_version_check(struct lttcomm_relayd_sock
*rsock
)
303 struct lttcomm_relayd_version msg
;
305 /* Code flow error. Safety net. */
308 DBG("Relayd version check for major.minor %u.%u", rsock
->major
,
311 /* Prepare network byte order before transmission. */
312 msg
.major
= htobe32(rsock
->major
);
313 msg
.minor
= htobe32(rsock
->minor
);
316 ret
= send_command(rsock
, RELAYD_VERSION
, (void *) &msg
, sizeof(msg
), 0);
321 /* Receive response */
322 ret
= recv_reply(rsock
, (void *) &msg
, sizeof(msg
));
327 /* Set back to host bytes order */
328 msg
.major
= be32toh(msg
.major
);
329 msg
.minor
= be32toh(msg
.minor
);
332 * Only validate the major version. If the other side is higher,
333 * communication is not possible. Only major version equal can talk to each
334 * other. If the minor version differs, the lowest version is used by both
337 if (msg
.major
!= rsock
->major
) {
340 DBG2("Relayd version is NOT compatible. Relayd version %u != %u (us)",
341 msg
.major
, rsock
->major
);
346 * If the relayd's minor version is higher, it will adapt to our version so
347 * we can continue to use the latest relayd communication data structure.
348 * If the received minor version is higher, the relayd should adapt to us.
350 if (rsock
->minor
> msg
.minor
) {
351 rsock
->minor
= msg
.minor
;
354 /* Version number compatible */
355 DBG2("Relayd version is compatible, using protocol version %u.%u",
356 rsock
->major
, rsock
->minor
);
364 * Add stream on the relayd and assign stream handle to the stream_id argument.
366 * On success return 0 else return ret_code negative value.
368 int relayd_send_metadata(struct lttcomm_relayd_sock
*rsock
, size_t len
)
372 /* Code flow error. Safety net. */
375 DBG("Relayd sending metadata of size %zu", len
);
378 ret
= send_command(rsock
, RELAYD_SEND_METADATA
, NULL
, len
, 0);
383 DBG2("Relayd metadata added successfully");
386 * After that call, the metadata data MUST be sent to the relayd so the
387 * receive size on the other end matches the len of the metadata packet
388 * header. This is why we don't wait for a reply here.
396 * Connect to relay daemon with an allocated lttcomm_relayd_sock.
398 int relayd_connect(struct lttcomm_relayd_sock
*rsock
)
400 /* Code flow error. Safety net. */
403 if (!rsock
->sock
.ops
) {
405 * Attempting a connect on a non-initialized socket.
410 DBG3("Relayd connect ...");
412 return rsock
->sock
.ops
->connect(&rsock
->sock
);
416 * Close relayd socket with an allocated lttcomm_relayd_sock.
418 * If no socket operations are found, simply return 0 meaning that everything
419 * is fine. Without operations, the socket can not possibly be opened or used.
420 * This is possible if the socket was allocated but not created. However, the
421 * caller could simply use it to store a valid file descriptor for instance
422 * passed over a Unix socket and call this to cleanup but still without a valid
425 * Return the close returned value. On error, a negative value is usually
426 * returned back from close(2).
428 int relayd_close(struct lttcomm_relayd_sock
*rsock
)
432 /* Code flow error. Safety net. */
435 /* An invalid fd is fine, return success. */
436 if (rsock
->sock
.fd
< 0) {
441 DBG3("Relayd closing socket %d", rsock
->sock
.fd
);
443 if (rsock
->sock
.ops
) {
444 ret
= rsock
->sock
.ops
->close(&rsock
->sock
);
446 /* Default call if no specific ops found. */
447 ret
= close(rsock
->sock
.fd
);
449 PERROR("relayd_close default close");
459 * Send data header structure to the relayd.
461 int relayd_send_data_hdr(struct lttcomm_relayd_sock
*rsock
,
462 struct lttcomm_relayd_data_hdr
*hdr
, size_t size
)
466 /* Code flow error. Safety net. */
470 if (rsock
->sock
.fd
< 0) {
474 DBG3("Relayd sending data header of size %zu", size
);
476 /* Again, safety net */
478 size
= sizeof(struct lttcomm_relayd_data_hdr
);
481 /* Only send data header. */
482 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, hdr
, size
, 0);
489 * The data MUST be sent right after that command for the receive on the
490 * other end to match the size in the header.
498 * Send close stream command to the relayd.
500 int relayd_send_close_stream(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
501 uint64_t last_net_seq_num
)
504 struct lttcomm_relayd_close_stream msg
;
505 struct lttcomm_relayd_generic_reply reply
;
507 /* Code flow error. Safety net. */
510 DBG("Relayd closing stream id %" PRIu64
, stream_id
);
512 msg
.stream_id
= htobe64(stream_id
);
513 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
516 ret
= send_command(rsock
, RELAYD_CLOSE_STREAM
, (void *) &msg
, sizeof(msg
), 0);
521 /* Receive response */
522 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
527 reply
.ret_code
= be32toh(reply
.ret_code
);
529 /* Return session id or negative ret code. */
530 if (reply
.ret_code
!= LTTNG_OK
) {
532 ERR("Relayd close stream replied error %d", reply
.ret_code
);
538 DBG("Relayd close stream id %" PRIu64
" successfully", stream_id
);
545 * Check for data availability for a given stream id.
547 * Return 0 if NOT pending, 1 if so and a negative value on error.
549 int relayd_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
550 uint64_t last_net_seq_num
)
553 struct lttcomm_relayd_data_pending msg
;
554 struct lttcomm_relayd_generic_reply reply
;
556 /* Code flow error. Safety net. */
559 DBG("Relayd data pending for stream id %" PRIu64
, stream_id
);
561 msg
.stream_id
= htobe64(stream_id
);
562 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
565 ret
= send_command(rsock
, RELAYD_DATA_PENDING
, (void *) &msg
,
571 /* Receive response */
572 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
577 reply
.ret_code
= be32toh(reply
.ret_code
);
579 /* Return session id or negative ret code. */
580 if (reply
.ret_code
>= LTTNG_OK
) {
581 ERR("Relayd data pending replied error %d", reply
.ret_code
);
584 /* At this point, the ret code is either 1 or 0 */
585 ret
= reply
.ret_code
;
587 DBG("Relayd data is %s pending for stream id %" PRIu64
,
588 ret
== 1 ? "" : "NOT", stream_id
);
595 * Check on the relayd side for a quiescent state on the control socket.
597 int relayd_quiescent_control(struct lttcomm_relayd_sock
*rsock
,
598 uint64_t metadata_stream_id
)
601 struct lttcomm_relayd_quiescent_control msg
;
602 struct lttcomm_relayd_generic_reply reply
;
604 /* Code flow error. Safety net. */
607 DBG("Relayd checking quiescent control state");
609 msg
.stream_id
= htobe64(metadata_stream_id
);
612 ret
= send_command(rsock
, RELAYD_QUIESCENT_CONTROL
, &msg
, sizeof(msg
), 0);
617 /* Receive response */
618 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
623 reply
.ret_code
= be32toh(reply
.ret_code
);
625 /* Return session id or negative ret code. */
626 if (reply
.ret_code
!= LTTNG_OK
) {
628 ERR("Relayd quiescent control replied error %d", reply
.ret_code
);
632 /* Control socket is quiescent */
640 * Begin a data pending command for a specific session id.
642 int relayd_begin_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
)
645 struct lttcomm_relayd_begin_data_pending msg
;
646 struct lttcomm_relayd_generic_reply reply
;
648 /* Code flow error. Safety net. */
651 DBG("Relayd begin data pending");
653 msg
.session_id
= htobe64(id
);
656 ret
= send_command(rsock
, RELAYD_BEGIN_DATA_PENDING
, &msg
, sizeof(msg
), 0);
661 /* Receive response */
662 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
667 reply
.ret_code
= be32toh(reply
.ret_code
);
669 /* Return session id or negative ret code. */
670 if (reply
.ret_code
!= LTTNG_OK
) {
672 ERR("Relayd begin data pending replied error %d", reply
.ret_code
);
683 * End a data pending command for a specific session id.
685 * Return 0 on success and set is_data_inflight to 0 if no data is being
686 * streamed or 1 if it is the case.
688 int relayd_end_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
,
689 unsigned int *is_data_inflight
)
692 struct lttcomm_relayd_end_data_pending msg
;
693 struct lttcomm_relayd_generic_reply reply
;
695 /* Code flow error. Safety net. */
698 DBG("Relayd end data pending");
700 msg
.session_id
= htobe64(id
);
703 ret
= send_command(rsock
, RELAYD_END_DATA_PENDING
, &msg
, sizeof(msg
), 0);
708 /* Receive response */
709 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
714 reply
.ret_code
= be32toh(reply
.ret_code
);
715 if (reply
.ret_code
< 0) {
716 ret
= reply
.ret_code
;
720 *is_data_inflight
= reply
.ret_code
;
722 DBG("Relayd end data pending is data inflight: %d", reply
.ret_code
);
731 * Send index to the relayd.
733 int relayd_send_index(struct lttcomm_relayd_sock
*rsock
,
734 struct lttng_packet_index
*index
, uint64_t relay_stream_id
,
735 uint64_t net_seq_num
)
738 struct lttcomm_relayd_index msg
;
739 struct lttcomm_relayd_generic_reply reply
;
741 /* Code flow error. Safety net. */
744 if (rsock
->minor
< 4) {
745 DBG("Not sending indexes before protocol 2.4");
750 DBG("Relayd sending index for stream ID %" PRIu64
, relay_stream_id
);
752 msg
.relay_stream_id
= htobe64(relay_stream_id
);
753 msg
.net_seq_num
= htobe64(net_seq_num
);
755 /* The index is already in big endian. */
756 msg
.packet_size
= index
->packet_size
;
757 msg
.content_size
= index
->content_size
;
758 msg
.timestamp_begin
= index
->timestamp_begin
;
759 msg
.timestamp_end
= index
->timestamp_end
;
760 msg
.events_discarded
= index
->events_discarded
;
761 msg
.stream_id
= index
->stream_id
;
764 ret
= send_command(rsock
, RELAYD_SEND_INDEX
, &msg
, sizeof(msg
), 0);
769 /* Receive response */
770 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
775 reply
.ret_code
= be32toh(reply
.ret_code
);
777 /* Return session id or negative ret code. */
778 if (reply
.ret_code
!= LTTNG_OK
) {
780 ERR("Relayd send index replied error %d", reply
.ret_code
);