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 * Send a RELAYD_CREATE_SESSION command to the relayd with the given socket and
121 * set session_id of the relayd if we have a successful reply from the relayd.
123 * On success, return 0 else a negative value which is either an errno error or
124 * a lttng error code from the relayd.
126 int relayd_create_session(struct lttcomm_relayd_sock
*rsock
, uint64_t *session_id
)
129 struct lttcomm_relayd_status_session reply
;
134 DBG("Relayd create session");
137 ret
= send_command(rsock
, RELAYD_CREATE_SESSION
, NULL
, 0, 0);
142 /* Receive response */
143 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
148 reply
.session_id
= be64toh(reply
.session_id
);
149 reply
.ret_code
= be32toh(reply
.ret_code
);
151 /* Return session id or negative ret code. */
152 if (reply
.ret_code
!= LTTNG_OK
) {
154 ERR("Relayd create session replied error %d", reply
.ret_code
);
158 *session_id
= reply
.session_id
;
161 DBG("Relayd session created with id %" PRIu64
, reply
.session_id
);
168 * Add stream on the relayd and assign stream handle to the stream_id argument.
170 * On success return 0 else return ret_code negative value.
172 int relayd_add_stream(struct lttcomm_relayd_sock
*rsock
, const char *channel_name
,
173 const char *pathname
, uint64_t *stream_id
,
174 uint64_t tracefile_size
, uint64_t tracefile_count
)
177 struct lttcomm_relayd_add_stream msg
;
178 struct lttcomm_relayd_add_stream_2_2 msg_2_2
;
179 struct lttcomm_relayd_status_stream reply
;
181 /* Code flow error. Safety net. */
183 assert(channel_name
);
186 DBG("Relayd adding stream for channel name %s", channel_name
);
188 /* Compat with relayd 2.1 */
189 if (rsock
->minor
== 1) {
190 strncpy(msg
.channel_name
, channel_name
, sizeof(msg
.channel_name
));
191 strncpy(msg
.pathname
, pathname
, sizeof(msg
.pathname
));
194 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg
, sizeof(msg
), 0);
199 /* Compat with relayd 2.2+ */
200 strncpy(msg_2_2
.channel_name
, channel_name
, sizeof(msg_2_2
.channel_name
));
201 strncpy(msg_2_2
.pathname
, pathname
, sizeof(msg_2_2
.pathname
));
202 msg_2_2
.tracefile_size
= htobe64(tracefile_size
);
203 msg_2_2
.tracefile_count
= htobe64(tracefile_count
);
206 ret
= send_command(rsock
, RELAYD_ADD_STREAM
, (void *) &msg_2_2
, sizeof(msg_2_2
), 0);
212 /* Waiting for reply */
213 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
218 /* Back to host bytes order. */
219 reply
.handle
= be64toh(reply
.handle
);
220 reply
.ret_code
= be32toh(reply
.ret_code
);
222 /* Return session id or negative ret code. */
223 if (reply
.ret_code
!= LTTNG_OK
) {
225 ERR("Relayd add stream replied error %d", reply
.ret_code
);
229 *stream_id
= reply
.handle
;
232 DBG("Relayd stream added successfully with handle %" PRIu64
,
240 * Check version numbers on the relayd.
241 * If major versions are compatible, we assign minor_to_use to the
242 * minor version of the procotol we are going to use for this session.
244 * Return 0 if compatible else negative value.
246 int relayd_version_check(struct lttcomm_relayd_sock
*rsock
)
249 struct lttcomm_relayd_version msg
;
251 /* Code flow error. Safety net. */
254 DBG("Relayd version check for major.minor %u.%u", rsock
->major
,
257 /* Prepare network byte order before transmission. */
258 msg
.major
= htobe32(rsock
->major
);
259 msg
.minor
= htobe32(rsock
->minor
);
262 ret
= send_command(rsock
, RELAYD_VERSION
, (void *) &msg
, sizeof(msg
), 0);
267 /* Receive response */
268 ret
= recv_reply(rsock
, (void *) &msg
, sizeof(msg
));
273 /* Set back to host bytes order */
274 msg
.major
= be32toh(msg
.major
);
275 msg
.minor
= be32toh(msg
.minor
);
278 * Only validate the major version. If the other side is higher,
279 * communication is not possible. Only major version equal can talk to each
280 * other. If the minor version differs, the lowest version is used by both
283 if (msg
.major
!= rsock
->major
) {
286 DBG2("Relayd version is NOT compatible. Relayd version %u != %u (us)",
287 msg
.major
, rsock
->major
);
292 * If the relayd's minor version is higher, it will adapt to our version so
293 * we can continue to use the latest relayd communication data structure.
294 * If the received minor version is higher, the relayd should adapt to us.
296 if (rsock
->minor
> msg
.minor
) {
297 rsock
->minor
= msg
.minor
;
300 /* Version number compatible */
301 DBG2("Relayd version is compatible, using protocol version %u.%u",
302 rsock
->major
, rsock
->minor
);
310 * Add stream on the relayd and assign stream handle to the stream_id argument.
312 * On success return 0 else return ret_code negative value.
314 int relayd_send_metadata(struct lttcomm_relayd_sock
*rsock
, size_t len
)
318 /* Code flow error. Safety net. */
321 DBG("Relayd sending metadata of size %zu", len
);
324 ret
= send_command(rsock
, RELAYD_SEND_METADATA
, NULL
, len
, 0);
329 DBG2("Relayd metadata added successfully");
332 * After that call, the metadata data MUST be sent to the relayd so the
333 * receive size on the other end matches the len of the metadata packet
334 * header. This is why we don't wait for a reply here.
342 * Connect to relay daemon with an allocated lttcomm_relayd_sock.
344 int relayd_connect(struct lttcomm_relayd_sock
*rsock
)
346 /* Code flow error. Safety net. */
349 if (!rsock
->sock
.ops
) {
351 * Attempting a connect on a non-initialized socket.
356 DBG3("Relayd connect ...");
358 return rsock
->sock
.ops
->connect(&rsock
->sock
);
362 * Close relayd socket with an allocated lttcomm_relayd_sock.
364 * If no socket operations are found, simply return 0 meaning that everything
365 * is fine. Without operations, the socket can not possibly be opened or used.
366 * This is possible if the socket was allocated but not created. However, the
367 * caller could simply use it to store a valid file descriptor for instance
368 * passed over a Unix socket and call this to cleanup but still without a valid
371 * Return the close returned value. On error, a negative value is usually
372 * returned back from close(2).
374 int relayd_close(struct lttcomm_relayd_sock
*rsock
)
378 /* Code flow error. Safety net. */
381 /* An invalid fd is fine, return success. */
382 if (rsock
->sock
.fd
< 0) {
387 DBG3("Relayd closing socket %d", rsock
->sock
.fd
);
389 if (rsock
->sock
.ops
) {
390 ret
= rsock
->sock
.ops
->close(&rsock
->sock
);
392 /* Default call if no specific ops found. */
393 ret
= close(rsock
->sock
.fd
);
395 PERROR("relayd_close default close");
405 * Send data header structure to the relayd.
407 int relayd_send_data_hdr(struct lttcomm_relayd_sock
*rsock
,
408 struct lttcomm_relayd_data_hdr
*hdr
, size_t size
)
412 /* Code flow error. Safety net. */
416 if (rsock
->sock
.fd
< 0) {
420 DBG3("Relayd sending data header of size %zu", size
);
422 /* Again, safety net */
424 size
= sizeof(struct lttcomm_relayd_data_hdr
);
427 /* Only send data header. */
428 ret
= rsock
->sock
.ops
->sendmsg(&rsock
->sock
, hdr
, size
, 0);
435 * The data MUST be sent right after that command for the receive on the
436 * other end to match the size in the header.
444 * Send close stream command to the relayd.
446 int relayd_send_close_stream(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
447 uint64_t last_net_seq_num
)
450 struct lttcomm_relayd_close_stream msg
;
451 struct lttcomm_relayd_generic_reply reply
;
453 /* Code flow error. Safety net. */
456 DBG("Relayd closing stream id %" PRIu64
, stream_id
);
458 msg
.stream_id
= htobe64(stream_id
);
459 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
462 ret
= send_command(rsock
, RELAYD_CLOSE_STREAM
, (void *) &msg
, sizeof(msg
), 0);
467 /* Receive response */
468 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
473 reply
.ret_code
= be32toh(reply
.ret_code
);
475 /* Return session id or negative ret code. */
476 if (reply
.ret_code
!= LTTNG_OK
) {
478 ERR("Relayd close stream replied error %d", reply
.ret_code
);
484 DBG("Relayd close stream id %" PRIu64
" successfully", stream_id
);
491 * Check for data availability for a given stream id.
493 * Return 0 if NOT pending, 1 if so and a negative value on error.
495 int relayd_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t stream_id
,
496 uint64_t last_net_seq_num
)
499 struct lttcomm_relayd_data_pending msg
;
500 struct lttcomm_relayd_generic_reply reply
;
502 /* Code flow error. Safety net. */
505 DBG("Relayd data pending for stream id %" PRIu64
, stream_id
);
507 msg
.stream_id
= htobe64(stream_id
);
508 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
511 ret
= send_command(rsock
, RELAYD_DATA_PENDING
, (void *) &msg
,
517 /* Receive response */
518 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
523 reply
.ret_code
= be32toh(reply
.ret_code
);
525 /* Return session id or negative ret code. */
526 if (reply
.ret_code
>= LTTNG_OK
) {
527 ERR("Relayd data pending replied error %d", reply
.ret_code
);
530 /* At this point, the ret code is either 1 or 0 */
531 ret
= reply
.ret_code
;
533 DBG("Relayd data is %s pending for stream id %" PRIu64
,
534 ret
== 1 ? "" : "NOT", stream_id
);
541 * Check on the relayd side for a quiescent state on the control socket.
543 int relayd_quiescent_control(struct lttcomm_relayd_sock
*rsock
,
544 uint64_t metadata_stream_id
)
547 struct lttcomm_relayd_quiescent_control msg
;
548 struct lttcomm_relayd_generic_reply reply
;
550 /* Code flow error. Safety net. */
553 DBG("Relayd checking quiescent control state");
555 msg
.stream_id
= htobe64(metadata_stream_id
);
558 ret
= send_command(rsock
, RELAYD_QUIESCENT_CONTROL
, &msg
, sizeof(msg
), 0);
563 /* Receive response */
564 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
569 reply
.ret_code
= be32toh(reply
.ret_code
);
571 /* Return session id or negative ret code. */
572 if (reply
.ret_code
!= LTTNG_OK
) {
574 ERR("Relayd quiescent control replied error %d", reply
.ret_code
);
578 /* Control socket is quiescent */
586 * Begin a data pending command for a specific session id.
588 int relayd_begin_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
)
591 struct lttcomm_relayd_begin_data_pending msg
;
592 struct lttcomm_relayd_generic_reply reply
;
594 /* Code flow error. Safety net. */
597 DBG("Relayd begin data pending");
599 msg
.session_id
= htobe64(id
);
602 ret
= send_command(rsock
, RELAYD_BEGIN_DATA_PENDING
, &msg
, sizeof(msg
), 0);
607 /* Receive response */
608 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
613 reply
.ret_code
= be32toh(reply
.ret_code
);
615 /* Return session id or negative ret code. */
616 if (reply
.ret_code
!= LTTNG_OK
) {
618 ERR("Relayd begin data pending replied error %d", reply
.ret_code
);
629 * End a data pending command for a specific session id.
631 * Return 0 on success and set is_data_inflight to 0 if no data is being
632 * streamed or 1 if it is the case.
634 int relayd_end_data_pending(struct lttcomm_relayd_sock
*rsock
, uint64_t id
,
635 unsigned int *is_data_inflight
)
638 struct lttcomm_relayd_end_data_pending msg
;
639 struct lttcomm_relayd_generic_reply reply
;
641 /* Code flow error. Safety net. */
644 DBG("Relayd end data pending");
646 msg
.session_id
= htobe64(id
);
649 ret
= send_command(rsock
, RELAYD_END_DATA_PENDING
, &msg
, sizeof(msg
), 0);
654 /* Receive response */
655 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
660 reply
.ret_code
= be32toh(reply
.ret_code
);
661 if (reply
.ret_code
< 0) {
662 ret
= reply
.ret_code
;
666 *is_data_inflight
= reply
.ret_code
;
668 DBG("Relayd end data pending is data inflight: %d", reply
.ret_code
);
677 * Send index to the relayd.
679 int relayd_send_index(struct lttcomm_relayd_sock
*rsock
,
680 struct lttng_packet_index
*index
, uint64_t relay_stream_id
,
681 uint64_t net_seq_num
)
684 struct lttcomm_relayd_index msg
;
685 struct lttcomm_relayd_generic_reply reply
;
687 /* Code flow error. Safety net. */
690 if (rsock
->minor
< 4) {
691 DBG("Not sending indexes before protocol 2.4");
696 DBG("Relayd sending index for stream ID %" PRIu64
, relay_stream_id
);
698 msg
.relay_stream_id
= htobe64(relay_stream_id
);
699 msg
.net_seq_num
= htobe64(net_seq_num
);
701 /* The index is already in big endian. */
702 msg
.packet_size
= index
->packet_size
;
703 msg
.content_size
= index
->content_size
;
704 msg
.timestamp_begin
= index
->timestamp_begin
;
705 msg
.timestamp_end
= index
->timestamp_end
;
706 msg
.events_discarded
= index
->events_discarded
;
707 msg
.stream_id
= index
->stream_id
;
710 ret
= send_command(rsock
, RELAYD_SEND_INDEX
, &msg
, sizeof(msg
), 0);
715 /* Receive response */
716 ret
= recv_reply(rsock
, (void *) &reply
, sizeof(reply
));
721 reply
.ret_code
= be32toh(reply
.ret_code
);
723 /* Return session id or negative ret code. */
724 if (reply
.ret_code
!= LTTNG_OK
) {
726 ERR("Relayd send index replied error %d", reply
.ret_code
);