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.
215 * If major versions are compatible, we assign minor_to_use to the
216 * minor version of the procotol we are going to use for this session.
218 * Return 0 if compatible else negative value.
220 int relayd_version_check(struct lttcomm_sock
*sock
, uint32_t major
,
221 uint32_t minor
, uint32_t *minor_to_use
)
224 struct lttcomm_relayd_version msg
;
226 /* Code flow error. Safety net. */
229 DBG("Relayd version check for major.minor %u.%u", major
, minor
);
231 /* Prepare network byte order before transmission. */
232 msg
.major
= htobe32(major
);
233 msg
.minor
= htobe32(minor
);
236 ret
= send_command(sock
, RELAYD_VERSION
, (void *) &msg
, sizeof(msg
), 0);
241 /* Receive response */
242 ret
= recv_reply(sock
, (void *) &msg
, sizeof(msg
));
247 /* Set back to host bytes order */
248 msg
.major
= be32toh(msg
.major
);
249 msg
.minor
= be32toh(msg
.minor
);
252 * Only validate the major version. If the other side is higher,
253 * communication is not possible. Only major version equal can talk to each
254 * other. If the minor version differs, the lowest version is used by both
257 if (msg
.major
!= major
) {
260 DBG2("Relayd version is NOT compatible. Relayd version %u != %u (us)",
266 * After 2.1.0 release, for the 2.2 release, at this point will have to
267 * check the minor version in order for the session daemon to know which
268 * structure to use to communicate with the relayd. If the relayd's minor
269 * version is higher, it will adapt to our version so we can continue to
270 * use the latest relayd communication data structure.
272 if (minor
<= msg
.minor
) {
273 *minor_to_use
= minor
;
275 *minor_to_use
= msg
.minor
;
278 /* Version number compatible */
279 DBG2("Relayd version is compatible, using protocol version %u.%u",
280 major
, *minor_to_use
);
288 * Add stream on the relayd and assign stream handle to the stream_id argument.
290 * On success return 0 else return ret_code negative value.
292 int relayd_send_metadata(struct lttcomm_sock
*sock
, size_t len
)
296 /* Code flow error. Safety net. */
299 DBG("Relayd sending metadata of size %zu", len
);
302 ret
= send_command(sock
, RELAYD_SEND_METADATA
, NULL
, len
, 0);
307 DBG2("Relayd metadata added successfully");
310 * After that call, the metadata data MUST be sent to the relayd so the
311 * receive size on the other end matches the len of the metadata packet
312 * header. This is why we don't wait for a reply here.
320 * Connect to relay daemon with an allocated lttcomm_sock.
322 int relayd_connect(struct lttcomm_sock
*sock
)
324 /* Code flow error. Safety net. */
327 DBG3("Relayd connect ...");
329 return sock
->ops
->connect(sock
);
333 * Close relayd socket with an allocated lttcomm_sock.
335 * If no socket operations are found, simply return 0 meaning that everything
336 * is fine. Without operations, the socket can not possibly be opened or used.
337 * This is possible if the socket was allocated but not created. However, the
338 * caller could simply use it to store a valid file descriptor for instance
339 * passed over a Unix socket and call this to cleanup but still without a valid
342 * Return the close returned value. On error, a negative value is usually
343 * returned back from close(2).
345 int relayd_close(struct lttcomm_sock
*sock
)
349 /* Code flow error. Safety net. */
352 /* An invalid fd is fine, return success. */
358 DBG3("Relayd closing socket %d", sock
->fd
);
361 ret
= sock
->ops
->close(sock
);
363 /* Default call if no specific ops found. */
364 ret
= close(sock
->fd
);
366 PERROR("relayd_close default close");
375 * Send data header structure to the relayd.
377 int relayd_send_data_hdr(struct lttcomm_sock
*sock
,
378 struct lttcomm_relayd_data_hdr
*hdr
, size_t size
)
382 /* Code flow error. Safety net. */
386 DBG3("Relayd sending data header of size %ld", size
);
388 /* Again, safety net */
390 size
= sizeof(struct lttcomm_relayd_data_hdr
);
393 /* Only send data header. */
394 ret
= sock
->ops
->sendmsg(sock
, hdr
, size
, 0);
401 * The data MUST be sent right after that command for the receive on the
402 * other end to match the size in the header.
410 * Send close stream command to the relayd.
412 int relayd_send_close_stream(struct lttcomm_sock
*sock
, uint64_t stream_id
,
413 uint64_t last_net_seq_num
)
416 struct lttcomm_relayd_close_stream msg
;
417 struct lttcomm_relayd_generic_reply reply
;
419 /* Code flow error. Safety net. */
422 DBG("Relayd closing stream id %" PRIu64
, stream_id
);
424 msg
.stream_id
= htobe64(stream_id
);
425 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
428 ret
= send_command(sock
, RELAYD_CLOSE_STREAM
, (void *) &msg
, sizeof(msg
), 0);
433 /* Receive response */
434 ret
= recv_reply(sock
, (void *) &reply
, sizeof(reply
));
439 reply
.ret_code
= be32toh(reply
.ret_code
);
441 /* Return session id or negative ret code. */
442 if (reply
.ret_code
!= LTTNG_OK
) {
444 ERR("Relayd close stream replied error %d", reply
.ret_code
);
450 DBG("Relayd close stream id %" PRIu64
" successfully", stream_id
);
457 * Check for data availability for a given stream id.
459 * Return 0 if NOT pending, 1 if so and a negative value on error.
461 int relayd_data_pending(struct lttcomm_sock
*sock
, uint64_t stream_id
,
462 uint64_t last_net_seq_num
)
465 struct lttcomm_relayd_data_pending msg
;
466 struct lttcomm_relayd_generic_reply reply
;
468 /* Code flow error. Safety net. */
471 DBG("Relayd data pending for stream id %" PRIu64
, stream_id
);
473 msg
.stream_id
= htobe64(stream_id
);
474 msg
.last_net_seq_num
= htobe64(last_net_seq_num
);
477 ret
= send_command(sock
, RELAYD_DATA_PENDING
, (void *) &msg
,
483 /* Receive response */
484 ret
= recv_reply(sock
, (void *) &reply
, sizeof(reply
));
489 reply
.ret_code
= be32toh(reply
.ret_code
);
491 /* Return session id or negative ret code. */
492 if (reply
.ret_code
>= LTTNG_OK
) {
493 ERR("Relayd data pending replied error %d", reply
.ret_code
);
496 /* At this point, the ret code is either 1 or 0 */
497 ret
= reply
.ret_code
;
499 DBG("Relayd data is %s pending for stream id %" PRIu64
,
500 ret
== 1 ? "" : "NOT", stream_id
);
507 * Check on the relayd side for a quiescent state on the control socket.
509 int relayd_quiescent_control(struct lttcomm_sock
*sock
,
510 uint64_t metadata_stream_id
)
513 struct lttcomm_relayd_quiescent_control msg
;
514 struct lttcomm_relayd_generic_reply reply
;
516 /* Code flow error. Safety net. */
519 DBG("Relayd checking quiescent control state");
521 msg
.stream_id
= htobe64(metadata_stream_id
);
524 ret
= send_command(sock
, RELAYD_QUIESCENT_CONTROL
, &msg
, sizeof(msg
), 0);
529 /* Receive response */
530 ret
= recv_reply(sock
, (void *) &reply
, sizeof(reply
));
535 reply
.ret_code
= be32toh(reply
.ret_code
);
537 /* Return session id or negative ret code. */
538 if (reply
.ret_code
!= LTTNG_OK
) {
540 ERR("Relayd quiescent control replied error %d", reply
.ret_code
);
544 /* Control socket is quiescent */
552 * Begin a data pending command for a specific session id.
554 int relayd_begin_data_pending(struct lttcomm_sock
*sock
, uint64_t id
)
557 struct lttcomm_relayd_begin_data_pending msg
;
558 struct lttcomm_relayd_generic_reply reply
;
560 /* Code flow error. Safety net. */
563 DBG("Relayd begin data pending");
565 msg
.session_id
= htobe64(id
);
568 ret
= send_command(sock
, RELAYD_BEGIN_DATA_PENDING
, &msg
, sizeof(msg
), 0);
573 /* Receive response */
574 ret
= recv_reply(sock
, (void *) &reply
, sizeof(reply
));
579 reply
.ret_code
= be32toh(reply
.ret_code
);
581 /* Return session id or negative ret code. */
582 if (reply
.ret_code
!= LTTNG_OK
) {
584 ERR("Relayd begin data pending replied error %d", reply
.ret_code
);
595 * End a data pending command for a specific session id.
597 * Return 0 on success and set is_data_inflight to 0 if no data is being
598 * streamed or 1 if it is the case.
600 int relayd_end_data_pending(struct lttcomm_sock
*sock
, uint64_t id
,
601 unsigned int *is_data_inflight
)
604 struct lttcomm_relayd_end_data_pending msg
;
605 struct lttcomm_relayd_generic_reply reply
;
607 /* Code flow error. Safety net. */
610 DBG("Relayd end data pending");
612 msg
.session_id
= htobe64(id
);
615 ret
= send_command(sock
, RELAYD_END_DATA_PENDING
, &msg
, sizeof(msg
), 0);
620 /* Receive response */
621 ret
= recv_reply(sock
, (void *) &reply
, sizeof(reply
));
626 reply
.ret_code
= be32toh(reply
.ret_code
);
627 if (reply
.ret_code
< 0) {
628 ret
= reply
.ret_code
;
632 *is_data_inflight
= reply
.ret_code
;
634 DBG("Relayd end data pending is data inflight: %d", reply
.ret_code
);