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/sessiond-comm/relayd.h>
30 #include <common/index/ctf-index.h>
35 * Send command. Fill up the header and append the data.
37 static int send_command(struct lttcomm_relayd_sock
*rsock
,
38 enum lttcomm_relayd_command cmd
, void *data
, size_t size
,
42 struct lttcomm_relayd_hdr header
;
44 uint64_t buf_size
= sizeof(header
);
46 if (rsock
->sock
.fd
< 0) {
54 buf
= zmalloc(buf_size
);
56 PERROR("zmalloc relayd send command buf");
61 memset(&header
, 0, sizeof(header
));
62 header
.cmd
= htobe32(cmd
);
63 header
.data_size
= htobe64(size
);
65 /* Zeroed for now since not used. */
66 header
.cmd_version
= 0;
67 header
.circuit_id
= 0;
69 /* Prepare buffer to send. */
70 memcpy(buf
, &header
, sizeof(header
));
72 memcpy(buf
+ sizeof(header
), data
, size
);
75 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, buf
, buf_size
, flags
);
81 DBG3("Relayd sending command %d of size %" PRIu64
, cmd
, buf_size
);
90 * Receive reply data on socket. This MUST be call after send_command or else
91 * could result in unexpected behavior(s).
93 static int recv_reply(struct lttcomm_relayd_sock
*rsock
, void *data
, size_t size
)
97 if (rsock
->sock
.fd
< 0) {
101 DBG3("Relayd waiting for reply of size %zu", size
);
103 ret
= rsock
->sock
.ops
->recvmsg(&rsock
->sock
, data
, size
, 0);
104 if (ret
<= 0 || ret
!= size
) {
106 /* Orderly shutdown. */
107 DBG("Socket %d has performed an orderly shutdown", rsock
->sock
.fd
);
109 DBG("Receiving reply failed on sock %d for size %zu with ret %d",
110 rsock
->sock
.fd
, size
, ret
);
112 /* Always return -1 here and the caller can use errno. */
122 * Starting at 2.4, RELAYD_CREATE_SESSION takes additional parameters to
123 * support the live reading capability.
125 static int relayd_create_session_2_4(struct lttcomm_relayd_sock
*rsock
,
126 uint64_t *session_id
, char *session_name
, char *hostname
,
127 int session_live_timer
, unsigned int snapshot
)
130 struct lttcomm_relayd_create_session_2_4 msg
;
132 if (lttng_strncpy(msg
.session_name
, session_name
,
133 sizeof(msg
.session_name
))) {
137 if (lttng_strncpy(msg
.hostname
, hostname
, sizeof(msg
.hostname
))) {
141 msg
.live_timer
= htobe32(session_live_timer
);
142 msg
.snapshot
= htobe32(snapshot
);
145 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, &msg
, sizeof(msg
), 0);
155 * RELAYD_CREATE_SESSION from 2.1 to 2.3.
157 static int relayd_create_session_2_1(struct lttcomm_relayd_sock
*rsock
,
158 uint64_t *session_id
)
163 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, NULL
, 0, 0);
173 * Send a RELAYD_CREATE_SESSION command to the relayd with the given socket and
174 * set session_id of the relayd if we have a successful reply from the relayd.
176 * On success, return 0 else a negative value which is either an errno error or
177 * a lttng error code from the relayd.
179 int relayd_create_session(struct lttcomm_relayd_sock
*rsock
, uint64_t *session_id
,
180 char *session_name
, char *hostname
, int session_live_timer
,
181 unsigned int snapshot
)
184 struct lttcomm_relayd_status_session reply
;
189 DBG("Relayd create session");
191 switch(rsock
->minor
) {
195 ret
= relayd_create_session_2_1(rsock
, session_id
);
199 ret
= relayd_create_session_2_4(rsock
, session_id
, session_name
,
200 hostname
, session_live_timer
, snapshot
);
208 /* Receive response */
209 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
214 reply
.session_id
= be64toh(reply
.session_id
);
215 reply
.ret_code
= be32toh(reply
.ret_code
);
217 /* Return session id or negative ret code. */
218 if (reply
.ret_code
!= LTTNG_OK
) {
220 ERR("Relayd create session replied error %d", reply
.ret_code
);
224 *session_id
= reply
.session_id
;
227 DBG("Relayd session created with id %" PRIu64
, reply
.session_id
);
234 * Add stream on the relayd and assign stream handle to the stream_id argument.
236 * On success return 0 else return ret_code negative value.
238 int relayd_add_stream(struct lttcomm_relayd_sock
*rsock
, const char *channel_name
,
239 const char *pathname
, uint64_t *stream_id
,
240 uint64_t tracefile_size
, uint64_t tracefile_count
)
243 struct lttcomm_relayd_add_stream msg
;
244 struct lttcomm_relayd_add_stream_2_2 msg_2_2
;
245 struct lttcomm_relayd_status_stream reply
;
247 /* Code flow error. Safety net. */
249 assert(channel_name
);
252 DBG("Relayd adding stream for channel name %s", channel_name
);
254 /* Compat with relayd 2.1 */
255 if (rsock
->minor
== 1) {
256 memset(&msg
, 0, sizeof(msg
));
257 if (lttng_strncpy(msg
.channel_name
, channel_name
,
258 sizeof(msg
.channel_name
))) {
262 if (lttng_strncpy(msg
.pathname
, pathname
,
263 sizeof(msg
.pathname
))) {
269 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg
, sizeof(msg
), 0);
274 memset(&msg_2_2
, 0, sizeof(msg_2_2
));
275 /* Compat with relayd 2.2+ */
276 if (lttng_strncpy(msg_2_2
.channel_name
, channel_name
,
277 sizeof(msg_2_2
.channel_name
))) {
281 if (lttng_strncpy(msg_2_2
.pathname
, pathname
,
282 sizeof(msg_2_2
.pathname
))) {
286 msg_2_2
.tracefile_size
= htobe64(tracefile_size
);
287 msg_2_2
.tracefile_count
= htobe64(tracefile_count
);
290 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg_2_2
, sizeof(msg_2_2
), 0);
296 /* Waiting for reply */
297 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
302 /* Back to host bytes order. */
303 reply
.handle
= be64toh(reply
.handle
);
304 reply
.ret_code
= be32toh(reply
.ret_code
);
306 /* Return session id or negative ret code. */
307 if (reply
.ret_code
!= LTTNG_OK
) {
309 ERR("Relayd add stream replied error %d", reply
.ret_code
);
313 *stream_id
= reply
.handle
;
316 DBG("Relayd stream added successfully with handle %" PRIu64
,
324 * Inform the relay that all the streams for the current channel has been sent.
326 * On success return 0 else return ret_code negative value.
328 int relayd_streams_sent(struct lttcomm_relayd_sock
*rsock
)
331 struct lttcomm_relayd_generic_reply reply
;
333 /* Code flow error. Safety net. */
336 DBG("Relayd sending streams sent.");
338 /* This feature was introduced in 2.4, ignore it for earlier versions. */
339 if (rsock
->minor
< 4) {
345 ret
= send_command(rsock
, RELAYD_STREAMS_SENT
, NULL
, 0, 0);
350 /* Waiting for reply */
351 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
356 /* Back to host bytes order. */
357 reply
.ret_code
= be32toh(reply
.ret_code
);
359 /* Return session id or negative ret code. */
360 if (reply
.ret_code
!= LTTNG_OK
) {
362 ERR("Relayd streams sent replied error %d", reply
.ret_code
);
369 DBG("Relayd streams sent success");
377 * Check version numbers on the relayd.
378 * If major versions are compatible, we assign minor_to_use to the
379 * minor version of the procotol we are going to use for this session.
381 * Return 0 if compatible else negative value.
383 int relayd_version_check(struct lttcomm_relayd_sock
*rsock
)
386 struct lttcomm_relayd_version msg
;
388 /* Code flow error. Safety net. */
391 DBG("Relayd version check for major.minor %u.%u", rsock
->major
,
394 memset(&msg
, 0, sizeof(msg
));
395 /* Prepare network byte order before transmission. */
396 msg
.major
= htobe32(rsock
->major
);
397 msg
.minor
= htobe32(rsock
->minor
);
400 ret
= send_command(rsock
, RELAYD_VERSION
, (void *) &msg
, sizeof(msg
), 0);
405 /* Receive response */
406 ret
= recv_reply(rsock
, (void *) &msg
, sizeof(msg
));
411 /* Set back to host bytes order */
412 msg
.major
= be32toh(msg
.major
);
413 msg
.minor
= be32toh(msg
.minor
);
416 * Only validate the major version. If the other side is higher,
417 * communication is not possible. Only major version equal can talk to each
418 * other. If the minor version differs, the lowest version is used by both
421 if (msg
.major
!= rsock
->major
) {
424 DBG2("Relayd version is NOT compatible. Relayd version %u != %u (us)",
425 msg
.major
, rsock
->major
);
430 * If the relayd's minor version is higher, it will adapt to our version so
431 * we can continue to use the latest relayd communication data structure.
432 * If the received minor version is higher, the relayd should adapt to us.
434 if (rsock
->minor
> msg
.minor
) {
435 rsock
->minor
= msg
.minor
;
438 /* Version number compatible */
439 DBG2("Relayd version is compatible, using protocol version %u.%u",
440 rsock
->major
, rsock
->minor
);
448 * Add stream on the relayd and assign stream handle to the stream_id argument.
450 * On success return 0 else return ret_code negative value.
452 int relayd_send_metadata(struct lttcomm_relayd_sock
*rsock
, size_t len
)
456 /* Code flow error. Safety net. */
459 DBG("Relayd sending metadata of size %zu", len
);
462 ret
= send_command(rsock
, RELAYD_SEND_METADATA
, NULL
, len
, 0);
467 DBG2("Relayd metadata added successfully");
470 * After that call, the metadata data MUST be sent to the relayd so the
471 * receive size on the other end matches the len of the metadata packet
472 * header. This is why we don't wait for a reply here.
480 * Connect to relay daemon with an allocated lttcomm_relayd_sock.
482 int relayd_connect(struct lttcomm_relayd_sock
*rsock
)
484 /* Code flow error. Safety net. */
487 if (!rsock
->sock
.ops
) {
489 * Attempting a connect on a non-initialized socket.
494 DBG3("Relayd connect ...");
496 return rsock
->sock
.ops
->connect(&rsock
->sock
);
500 * Close relayd socket with an allocated lttcomm_relayd_sock.
502 * If no socket operations are found, simply return 0 meaning that everything
503 * is fine. Without operations, the socket can not possibly be opened or used.
504 * This is possible if the socket was allocated but not created. However, the
505 * caller could simply use it to store a valid file descriptor for instance
506 * passed over a Unix socket and call this to cleanup but still without a valid
509 * Return the close returned value. On error, a negative value is usually
510 * returned back from close(2).
512 int relayd_close(struct lttcomm_relayd_sock
*rsock
)
516 /* Code flow error. Safety net. */
519 /* An invalid fd is fine, return success. */
520 if (rsock
->sock
.fd
< 0) {
525 DBG3("Relayd closing socket %d", rsock
->sock
.fd
);
527 if (rsock
->sock
.ops
) {
528 ret
= rsock
->sock
.ops
->close(&rsock
->sock
);
530 /* Default call if no specific ops found. */
531 ret
= close(rsock
->sock
.fd
);
533 PERROR("relayd_close default close");
543 * Send data header structure to the relayd.
545 int relayd_send_data_hdr(struct lttcomm_relayd_sock
*rsock
,
546 struct lttcomm_relayd_data_hdr
*hdr
, size_t size
)
550 /* Code flow error. Safety net. */
554 if (rsock
->sock
.fd
< 0) {
558 DBG3("Relayd sending data header of size %zu", size
);
560 /* Again, safety net */
562 size
= sizeof(struct lttcomm_relayd_data_hdr
);
565 /* Only send data header. */
566 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, hdr
, size
, 0);
573 * The data MUST be sent right after that command for the receive on the
574 * other end to match the size in the header.
582 * Send close stream command to the relayd.
584 int relayd_send_close_stream(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
585 uint64_t last_net_seq_num
)
588 struct lttcomm_relayd_close_stream msg
;
589 struct lttcomm_relayd_generic_reply reply
;
591 /* Code flow error. Safety net. */
594 DBG("Relayd closing stream id %" PRIu64
, stream_id
);
596 memset(&msg
, 0, sizeof(msg
));
597 msg
.stream_id
= htobe64(stream_id
);
598 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
601 ret
= send_command(rsock
, RELAYD_CLOSE_STREAM
, (void *) &msg
, sizeof(msg
), 0);
606 /* Receive response */
607 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
612 reply
.ret_code
= be32toh(reply
.ret_code
);
614 /* Return session id or negative ret code. */
615 if (reply
.ret_code
!= LTTNG_OK
) {
617 ERR("Relayd close stream replied error %d", reply
.ret_code
);
623 DBG("Relayd close stream id %" PRIu64
" successfully", stream_id
);
630 * Check for data availability for a given stream id.
632 * Return 0 if NOT pending, 1 if so and a negative value on error.
634 int relayd_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
635 uint64_t last_net_seq_num
)
638 struct lttcomm_relayd_data_pending msg
;
639 struct lttcomm_relayd_generic_reply reply
;
641 /* Code flow error. Safety net. */
644 DBG("Relayd data pending for stream id %" PRIu64
, stream_id
);
646 memset(&msg
, 0, sizeof(msg
));
647 msg
.stream_id
= htobe64(stream_id
);
648 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
651 ret
= send_command(rsock
, RELAYD_DATA_PENDING
, (void *) &msg
,
657 /* Receive response */
658 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
663 reply
.ret_code
= be32toh(reply
.ret_code
);
665 /* Return session id or negative ret code. */
666 if (reply
.ret_code
>= LTTNG_OK
) {
667 ERR("Relayd data pending replied error %d", reply
.ret_code
);
670 /* At this point, the ret code is either 1 or 0 */
671 ret
= reply
.ret_code
;
673 DBG("Relayd data is %s pending for stream id %" PRIu64
,
674 ret
== 1 ? "" : "NOT", stream_id
);
681 * Check on the relayd side for a quiescent state on the control socket.
683 int relayd_quiescent_control(struct lttcomm_relayd_sock
*rsock
,
684 uint64_t metadata_stream_id
)
687 struct lttcomm_relayd_quiescent_control msg
;
688 struct lttcomm_relayd_generic_reply reply
;
690 /* Code flow error. Safety net. */
693 DBG("Relayd checking quiescent control state");
695 memset(&msg
, 0, sizeof(msg
));
696 msg
.stream_id
= htobe64(metadata_stream_id
);
699 ret
= send_command(rsock
, RELAYD_QUIESCENT_CONTROL
, &msg
, sizeof(msg
), 0);
704 /* Receive response */
705 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
710 reply
.ret_code
= be32toh(reply
.ret_code
);
712 /* Return session id or negative ret code. */
713 if (reply
.ret_code
!= LTTNG_OK
) {
715 ERR("Relayd quiescent control replied error %d", reply
.ret_code
);
719 /* Control socket is quiescent */
727 * Begin a data pending command for a specific session id.
729 int relayd_begin_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
)
732 struct lttcomm_relayd_begin_data_pending msg
;
733 struct lttcomm_relayd_generic_reply reply
;
735 /* Code flow error. Safety net. */
738 DBG("Relayd begin data pending");
740 memset(&msg
, 0, sizeof(msg
));
741 msg
.session_id
= htobe64(id
);
744 ret
= send_command(rsock
, RELAYD_BEGIN_DATA_PENDING
, &msg
, sizeof(msg
), 0);
749 /* Receive response */
750 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
755 reply
.ret_code
= be32toh(reply
.ret_code
);
757 /* Return session id or negative ret code. */
758 if (reply
.ret_code
!= LTTNG_OK
) {
760 ERR("Relayd begin data pending replied error %d", reply
.ret_code
);
771 * End a data pending command for a specific session id.
773 * Return 0 on success and set is_data_inflight to 0 if no data is being
774 * streamed or 1 if it is the case.
776 int relayd_end_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
,
777 unsigned int *is_data_inflight
)
780 struct lttcomm_relayd_end_data_pending msg
;
781 struct lttcomm_relayd_generic_reply reply
;
783 /* Code flow error. Safety net. */
786 DBG("Relayd end data pending");
788 memset(&msg
, 0, sizeof(msg
));
789 msg
.session_id
= htobe64(id
);
792 ret
= send_command(rsock
, RELAYD_END_DATA_PENDING
, &msg
, sizeof(msg
), 0);
797 /* Receive response */
798 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
803 recv_ret
= be32toh(reply
.ret_code
);
809 *is_data_inflight
= recv_ret
;
811 DBG("Relayd end data pending is data inflight: %d", recv_ret
);
820 * Send index to the relayd.
822 int relayd_send_index(struct lttcomm_relayd_sock
*rsock
,
823 struct ctf_packet_index
*index
, uint64_t relay_stream_id
,
824 uint64_t net_seq_num
)
827 struct lttcomm_relayd_index msg
;
828 struct lttcomm_relayd_generic_reply reply
;
830 /* Code flow error. Safety net. */
833 if (rsock
->minor
< 4) {
834 DBG("Not sending indexes before protocol 2.4");
839 DBG("Relayd sending index for stream ID %" PRIu64
, relay_stream_id
);
841 memset(&msg
, 0, sizeof(msg
));
842 msg
.relay_stream_id
= htobe64(relay_stream_id
);
843 msg
.net_seq_num
= htobe64(net_seq_num
);
845 /* The index is already in big endian. */
846 msg
.packet_size
= index
->packet_size
;
847 msg
.content_size
= index
->content_size
;
848 msg
.timestamp_begin
= index
->timestamp_begin
;
849 msg
.timestamp_end
= index
->timestamp_end
;
850 msg
.events_discarded
= index
->events_discarded
;
851 msg
.stream_id
= index
->stream_id
;
853 if (rsock
->minor
>= 8) {
854 msg
.stream_instance_id
= index
->stream_instance_id
;
855 msg
.packet_seq_num
= index
->packet_seq_num
;
859 ret
= send_command(rsock
, RELAYD_SEND_INDEX
, &msg
,
860 lttcomm_relayd_index_len(lttng_to_index_major(rsock
->major
,
862 lttng_to_index_minor(rsock
->major
, rsock
->minor
)),
868 /* Receive response */
869 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
874 reply
.ret_code
= be32toh(reply
.ret_code
);
876 /* Return session id or negative ret code. */
877 if (reply
.ret_code
!= LTTNG_OK
) {
879 ERR("Relayd send index replied error %d", reply
.ret_code
);
890 * Ask the relay to reset the metadata trace file (regeneration).
892 int relayd_reset_metadata(struct lttcomm_relayd_sock
*rsock
,
893 uint64_t stream_id
, uint64_t version
)
896 struct lttcomm_relayd_reset_metadata msg
;
897 struct lttcomm_relayd_generic_reply reply
;
899 /* Code flow error. Safety net. */
902 /* Should have been prevented by the sessiond. */
903 if (rsock
->minor
< 8) {
904 ERR("Metadata regeneration unsupported before 2.8");
909 DBG("Relayd reset metadata stream id %" PRIu64
, stream_id
);
911 memset(&msg
, 0, sizeof(msg
));
912 msg
.stream_id
= htobe64(stream_id
);
913 msg
.version
= htobe64(version
);
916 ret
= send_command(rsock
, RELAYD_RESET_METADATA
, (void *) &msg
, sizeof(msg
), 0);
921 /* Receive response */
922 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
927 reply
.ret_code
= be32toh(reply
.ret_code
);
929 /* Return session id or negative ret code. */
930 if (reply
.ret_code
!= LTTNG_OK
) {
932 ERR("Relayd reset metadata replied error %d", reply
.ret_code
);
938 DBG("Relayd reset metadata stream id %" PRIu64
" successfully", stream_id
);