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>
33 * Send command. Fill up the header and append the data.
35 static int send_command(struct lttcomm_sock
*sock
,
36 enum lttcomm_relayd_command cmd
, void *data
, size_t size
,
40 struct lttcomm_relayd_hdr header
;
42 uint64_t buf_size
= sizeof(header
);
48 buf
= zmalloc(buf_size
);
50 PERROR("zmalloc relayd send command buf");
55 header
.cmd
= htobe32(cmd
);
56 header
.data_size
= htobe64(size
);
58 /* Zeroed for now since not used. */
59 header
.cmd_version
= 0;
60 header
.circuit_id
= 0;
62 /* Prepare buffer to send. */
63 memcpy(buf
, &header
, sizeof(header
));
65 memcpy(buf
+ sizeof(header
), data
, size
);
68 ret
= sock
->ops
->sendmsg(sock
, buf
, buf_size
, flags
);
74 DBG3("Relayd sending command %d of size %" PRIu64
, cmd
, buf_size
);
83 * Receive reply data on socket. This MUST be call after send_command or else
84 * could result in unexpected behavior(s).
86 static int recv_reply(struct lttcomm_sock
*sock
, void *data
, size_t size
)
90 DBG3("Relayd waiting for reply of size %ld", size
);
92 ret
= sock
->ops
->recvmsg(sock
, data
, size
, 0);
93 if (ret
<= 0 || ret
!= size
) {
95 /* Orderly shutdown. */
96 DBG("Socket %d has performed an orderly shutdown", sock
->fd
);
98 DBG("Receiving reply failed on sock %d for size %lu with ret %d",
101 /* Always return -1 here and the caller can use errno. */
111 * Send a RELAYD_CREATE_SESSION command to the relayd with the given socket and
112 * set session_id of the relayd if we have a successful reply from the relayd.
114 * On success, return 0 else a negative value which is either an errno error or
115 * a lttng error code from the relayd.
117 int relayd_create_session(struct lttcomm_sock
*sock
, uint64_t *session_id
)
120 struct lttcomm_relayd_status_session reply
;
125 DBG("Relayd create session");
128 ret
= send_command(sock
, RELAYD_CREATE_SESSION
, NULL
, 0, 0);
133 /* Receive response */
134 ret
= recv_reply(sock
, (void *) &reply
, sizeof(reply
));
139 reply
.session_id
= be64toh(reply
.session_id
);
140 reply
.ret_code
= be32toh(reply
.ret_code
);
142 /* Return session id or negative ret code. */
143 if (reply
.ret_code
!= LTTNG_OK
) {
145 ERR("Relayd create session replied error %d", reply
.ret_code
);
149 *session_id
= reply
.session_id
;
152 DBG("Relayd session created with id %" PRIu64
, reply
.session_id
);
159 * Add stream on the relayd and assign stream handle to the stream_id argument.
161 * On success return 0 else return ret_code negative value.
163 int relayd_add_stream(struct lttcomm_sock
*sock
, const char *channel_name
,
164 const char *pathname
, uint64_t *stream_id
)
167 struct lttcomm_relayd_add_stream msg
;
168 struct lttcomm_relayd_status_stream reply
;
170 /* Code flow error. Safety net. */
172 assert(channel_name
);
175 DBG("Relayd adding stream for channel name %s", channel_name
);
177 strncpy(msg
.channel_name
, channel_name
, sizeof(msg
.channel_name
));
178 strncpy(msg
.pathname
, pathname
, sizeof(msg
.pathname
));
181 ret
= send_command(sock
, RELAYD_ADD_STREAM
, (void *) &msg
, sizeof(msg
), 0);
186 /* Waiting for reply */
187 ret
= recv_reply(sock
, (void *) &reply
, sizeof(reply
));
192 /* Back to host bytes order. */
193 reply
.handle
= be64toh(reply
.handle
);
194 reply
.ret_code
= be32toh(reply
.ret_code
);
196 /* Return session id or negative ret code. */
197 if (reply
.ret_code
!= LTTNG_OK
) {
199 ERR("Relayd add stream replied error %d", reply
.ret_code
);
203 *stream_id
= reply
.handle
;
206 DBG("Relayd stream added successfully with handle %" PRIu64
,
214 * Check version numbers on the relayd.
216 * Return 0 if compatible else negative value.
218 int relayd_version_check(struct lttcomm_sock
*sock
, uint32_t major
,
222 struct lttcomm_relayd_version msg
;
224 /* Code flow error. Safety net. */
227 DBG("Relayd version check for major.minor %u.%u", major
, minor
);
229 /* Prepare network byte order before transmission. */
230 msg
.major
= htobe32(major
);
231 msg
.minor
= htobe32(minor
);
234 ret
= send_command(sock
, RELAYD_VERSION
, (void *) &msg
, sizeof(msg
), 0);
239 /* Receive response */
240 ret
= recv_reply(sock
, (void *) &msg
, sizeof(msg
));
245 /* Set back to host bytes order */
246 msg
.major
= be32toh(msg
.major
);
247 msg
.minor
= be32toh(msg
.minor
);
250 * Only validate the major version. If the other side is higher,
251 * communication is not possible. Only major version equal can talk to each
252 * other. If the minor version differs, the lowest version is used by both
255 * For now, before 2.1.0 stable release, we don't have to check the minor
256 * because this new mechanism with the relayd will only be available with
259 if (msg
.major
== major
) {
262 DBG2("Relayd version is compatible");
267 * After 2.1.0 release, for the 2.2 release, at this point will have to
268 * check the minor version in order for the session daemon to know which
269 * structure to use to communicate with the relayd. If the relayd's minor
270 * version is higher, it will adapt to our version so we can continue to
271 * use the latest relayd communication data structure.
274 /* Version number not compatible */
275 DBG2("Relayd version is NOT compatible. Relayd version %u != %u (us)",
284 * Add stream on the relayd and assign stream handle to the stream_id argument.
286 * On success return 0 else return ret_code negative value.
288 int relayd_send_metadata(struct lttcomm_sock
*sock
, size_t len
)
292 /* Code flow error. Safety net. */
295 DBG("Relayd sending metadata of size %zu", len
);
298 ret
= send_command(sock
, RELAYD_SEND_METADATA
, NULL
, len
, 0);
303 DBG2("Relayd metadata added successfully");
306 * After that call, the metadata data MUST be sent to the relayd so the
307 * receive size on the other end matches the len of the metadata packet
308 * header. This is why we don't wait for a reply here.
316 * Connect to relay daemon with an allocated lttcomm_sock.
318 int relayd_connect(struct lttcomm_sock
*sock
)
320 /* Code flow error. Safety net. */
323 DBG3("Relayd connect ...");
325 return sock
->ops
->connect(sock
);
329 * Close relayd socket with an allocated lttcomm_sock.
331 int relayd_close(struct lttcomm_sock
*sock
)
333 /* Code flow error. Safety net. */
336 DBG3("Relayd closing socket %d", sock
->fd
);
338 return sock
->ops
->close(sock
);
342 * Send data header structure to the relayd.
344 int relayd_send_data_hdr(struct lttcomm_sock
*sock
,
345 struct lttcomm_relayd_data_hdr
*hdr
, size_t size
)
349 /* Code flow error. Safety net. */
353 DBG3("Relayd sending data header of size %ld", size
);
355 /* Again, safety net */
357 size
= sizeof(struct lttcomm_relayd_data_hdr
);
360 /* Only send data header. */
361 ret
= sock
->ops
->sendmsg(sock
, hdr
, size
, 0);
368 * The data MUST be sent right after that command for the receive on the
369 * other end to match the size in the header.
377 * Send close stream command to the relayd.
379 int relayd_send_close_stream(struct lttcomm_sock
*sock
, uint64_t stream_id
,
380 uint64_t last_net_seq_num
)
383 struct lttcomm_relayd_close_stream msg
;
384 struct lttcomm_relayd_generic_reply reply
;
386 /* Code flow error. Safety net. */
389 DBG("Relayd closing stream id %" PRIu64
, stream_id
);
391 msg
.stream_id
= htobe64(stream_id
);
392 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
395 ret
= send_command(sock
, RELAYD_CLOSE_STREAM
, (void *) &msg
, sizeof(msg
), 0);
400 /* Receive response */
401 ret
= recv_reply(sock
, (void *) &reply
, sizeof(reply
));
406 reply
.ret_code
= be32toh(reply
.ret_code
);
408 /* Return session id or negative ret code. */
409 if (reply
.ret_code
!= LTTNG_OK
) {
411 ERR("Relayd close stream replied error %d", reply
.ret_code
);
417 DBG("Relayd close stream id %" PRIu64
" successfully", stream_id
);
424 * Check for data availability for a given stream id.
426 * Return 0 if NOT pending, 1 if so and a negative value on error.
428 int relayd_data_pending(struct lttcomm_sock
*sock
, uint64_t stream_id
,
429 uint64_t last_net_seq_num
)
432 struct lttcomm_relayd_data_pending msg
;
433 struct lttcomm_relayd_generic_reply reply
;
435 /* Code flow error. Safety net. */
438 DBG("Relayd data pending for stream id %" PRIu64
, stream_id
);
440 msg
.stream_id
= htobe64(stream_id
);
441 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
444 ret
= send_command(sock
, RELAYD_DATA_PENDING
, (void *) &msg
,
450 /* Receive response */
451 ret
= recv_reply(sock
, (void *) &reply
, sizeof(reply
));
456 reply
.ret_code
= be32toh(reply
.ret_code
);
458 /* Return session id or negative ret code. */
459 if (reply
.ret_code
>= LTTNG_OK
) {
460 ERR("Relayd data pending replied error %d", reply
.ret_code
);
463 /* At this point, the ret code is either 1 or 0 */
464 ret
= reply
.ret_code
;
466 DBG("Relayd data is %s pending for stream id %" PRIu64
,
467 ret
== 1 ? "" : "NOT", stream_id
);
474 * Check on the relayd side for a quiescent state on the control socket.
476 int relayd_quiescent_control(struct lttcomm_sock
*sock
,
477 uint64_t metadata_stream_id
)
480 struct lttcomm_relayd_quiescent_control msg
;
481 struct lttcomm_relayd_generic_reply reply
;
483 /* Code flow error. Safety net. */
486 DBG("Relayd checking quiescent control state");
488 msg
.stream_id
= htobe64(metadata_stream_id
);
491 ret
= send_command(sock
, RELAYD_QUIESCENT_CONTROL
, &msg
, sizeof(msg
), 0);
496 /* Receive response */
497 ret
= recv_reply(sock
, (void *) &reply
, sizeof(reply
));
502 reply
.ret_code
= be32toh(reply
.ret_code
);
504 /* Return session id or negative ret code. */
505 if (reply
.ret_code
!= LTTNG_OK
) {
507 ERR("Relayd quiescent control replied error %d", reply
.ret_code
);
511 /* Control socket is quiescent */
519 * Begin a data pending command for a specific session id.
521 int relayd_begin_data_pending(struct lttcomm_sock
*sock
, uint64_t id
)
524 struct lttcomm_relayd_begin_data_pending msg
;
525 struct lttcomm_relayd_generic_reply reply
;
527 /* Code flow error. Safety net. */
530 DBG("Relayd begin data pending");
532 msg
.session_id
= htobe64(id
);
535 ret
= send_command(sock
, RELAYD_BEGIN_DATA_PENDING
, &msg
, sizeof(msg
), 0);
540 /* Receive response */
541 ret
= recv_reply(sock
, (void *) &reply
, sizeof(reply
));
546 reply
.ret_code
= be32toh(reply
.ret_code
);
548 /* Return session id or negative ret code. */
549 if (reply
.ret_code
!= LTTNG_OK
) {
551 ERR("Relayd begin data pending replied error %d", reply
.ret_code
);
562 * End a data pending command for a specific session id.
564 * Return 0 on success and set is_data_inflight to 0 if no data is being
565 * streamed or 1 if it is the case.
567 int relayd_end_data_pending(struct lttcomm_sock
*sock
, uint64_t id
,
568 unsigned int *is_data_inflight
)
571 struct lttcomm_relayd_end_data_pending msg
;
572 struct lttcomm_relayd_generic_reply reply
;
574 /* Code flow error. Safety net. */
577 DBG("Relayd end data pending");
579 msg
.session_id
= htobe64(id
);
582 ret
= send_command(sock
, RELAYD_END_DATA_PENDING
, &msg
, sizeof(msg
), 0);
587 /* Receive response */
588 ret
= recv_reply(sock
, (void *) &reply
, sizeof(reply
));
593 reply
.ret_code
= be32toh(reply
.ret_code
);
594 if (reply
.ret_code
< 0) {
595 ret
= reply
.ret_code
;
599 *is_data_inflight
= reply
.ret_code
;
601 DBG("Relayd end data pending is data inflight: %d", reply
.ret_code
);