Remove some unused includes in C++ files
[babeltrace.git] / src / plugins / ctf / lttng-live / viewer-connection.cpp
1 /*
2 * SPDX-License-Identifier: MIT
3 *
4 * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
5 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 */
7
8 #include <glib.h>
9 #include <stdint.h>
10 #include <stdio.h>
11
12 #include <babeltrace2/babeltrace.h>
13
14 #define BT_COMP_LOG_SELF_COMP (viewer_connection->self_comp)
15 #define BT_LOG_OUTPUT_LEVEL (viewer_connection->log_level)
16 #define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE/VIEWER"
17 #include "logging/comp-logging.h"
18
19 #include "common/common.h"
20 #include "compat/endian.h"
21 #include "compat/socket.h"
22
23 #include "data-stream.hpp"
24 #include "lttng-live.hpp"
25 #include "lttng-viewer-abi.hpp"
26 #include "metadata.hpp"
27 #include "viewer-connection.hpp"
28
29 #define viewer_handle_send_recv_status(_self_comp, _self_comp_class, _status, _action, _msg_str) \
30 do { \
31 switch (_status) { \
32 case LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED: \
33 break; \
34 case LTTNG_LIVE_VIEWER_STATUS_ERROR: \
35 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(_self_comp, _self_comp_class, \
36 "Error " _action " " _msg_str); \
37 break; \
38 default: \
39 bt_common_abort(); \
40 } \
41 } while (0)
42
43 #define viewer_handle_send_status(_self_comp, _self_comp_class, _status, _msg_str) \
44 viewer_handle_send_recv_status(_self_comp, _self_comp_class, _status, "sending", _msg_str)
45
46 #define viewer_handle_recv_status(_self_comp, _self_comp_class, _status, _msg_str) \
47 viewer_handle_send_recv_status(_self_comp, _self_comp_class, _status, "receiving", _msg_str)
48
49 #define LTTNG_LIVE_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE_ERRNO(_self_comp, _self_comp_class, _msg, \
50 _fmt, ...) \
51 do { \
52 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(_self_comp, _self_comp_class, _msg ": %s" _fmt, \
53 bt_socket_errormsg(), ##__VA_ARGS__); \
54 } while (0)
55
56 static const char *lttng_viewer_command_string(enum lttng_viewer_command cmd)
57 {
58 switch (cmd) {
59 case LTTNG_VIEWER_CONNECT:
60 return "CONNECT";
61 case LTTNG_VIEWER_LIST_SESSIONS:
62 return "LIST_SESSIONS";
63 case LTTNG_VIEWER_ATTACH_SESSION:
64 return "ATTACH_SESSION";
65 case LTTNG_VIEWER_GET_NEXT_INDEX:
66 return "GET_NEXT_INDEX";
67 case LTTNG_VIEWER_GET_PACKET:
68 return "GET_PACKET";
69 case LTTNG_VIEWER_GET_METADATA:
70 return "GET_METADATA";
71 case LTTNG_VIEWER_GET_NEW_STREAMS:
72 return "GET_NEW_STREAMS";
73 case LTTNG_VIEWER_CREATE_SESSION:
74 return "CREATE_SESSION";
75 case LTTNG_VIEWER_DETACH_SESSION:
76 return "DETACH_SESSION";
77 }
78
79 bt_common_abort();
80 }
81
82 static const char *
83 lttng_viewer_next_index_return_code_string(enum lttng_viewer_next_index_return_code code)
84 {
85 switch (code) {
86 case LTTNG_VIEWER_INDEX_OK:
87 return "INDEX_OK";
88 case LTTNG_VIEWER_INDEX_RETRY:
89 return "INDEX_RETRY";
90 case LTTNG_VIEWER_INDEX_HUP:
91 return "INDEX_HUP";
92 case LTTNG_VIEWER_INDEX_ERR:
93 return "INDEX_ERR";
94 case LTTNG_VIEWER_INDEX_INACTIVE:
95 return "INDEX_INACTIVE";
96 case LTTNG_VIEWER_INDEX_EOF:
97 return "INDEX_EOF";
98 }
99
100 bt_common_abort();
101 }
102
103 static const char *lttng_viewer_next_index_return_code_string(uint32_t code)
104 {
105 return lttng_viewer_next_index_return_code_string((lttng_viewer_next_index_return_code) code);
106 }
107
108 static const char *
109 lttng_viewer_get_packet_return_code_string(enum lttng_viewer_get_packet_return_code code)
110 {
111 switch (code) {
112 case LTTNG_VIEWER_GET_PACKET_OK:
113 return "GET_PACKET_OK";
114 case LTTNG_VIEWER_GET_PACKET_RETRY:
115 return "GET_PACKET_RETRY";
116 case LTTNG_VIEWER_GET_PACKET_ERR:
117 return "GET_PACKET_ERR";
118 case LTTNG_VIEWER_GET_PACKET_EOF:
119 return "GET_PACKET_EOF";
120 }
121
122 bt_common_abort();
123 };
124
125 static const char *lttng_viewer_get_packet_return_code_string(uint32_t code)
126 {
127 return lttng_viewer_get_packet_return_code_string((lttng_viewer_get_packet_return_code) code);
128 }
129
130 static const char *lttng_viewer_seek_string(enum lttng_viewer_seek seek)
131 {
132 switch (seek) {
133 case LTTNG_VIEWER_SEEK_BEGINNING:
134 return "SEEK_BEGINNING";
135 case LTTNG_VIEWER_SEEK_LAST:
136 return "SEEK_LAST";
137 }
138
139 bt_common_abort();
140 }
141
142 static inline enum lttng_live_iterator_status
143 viewer_status_to_live_iterator_status(enum lttng_live_viewer_status viewer_status)
144 {
145 switch (viewer_status) {
146 case LTTNG_LIVE_VIEWER_STATUS_OK:
147 return LTTNG_LIVE_ITERATOR_STATUS_OK;
148 case LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED:
149 return LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
150 case LTTNG_LIVE_VIEWER_STATUS_ERROR:
151 return LTTNG_LIVE_ITERATOR_STATUS_ERROR;
152 }
153
154 bt_common_abort();
155 }
156
157 static inline enum ctf_msg_iter_medium_status
158 viewer_status_to_ctf_msg_iter_medium_status(enum lttng_live_viewer_status viewer_status)
159 {
160 switch (viewer_status) {
161 case LTTNG_LIVE_VIEWER_STATUS_OK:
162 return CTF_MSG_ITER_MEDIUM_STATUS_OK;
163 case LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED:
164 return CTF_MSG_ITER_MEDIUM_STATUS_AGAIN;
165 case LTTNG_LIVE_VIEWER_STATUS_ERROR:
166 return CTF_MSG_ITER_MEDIUM_STATUS_ERROR;
167 }
168
169 bt_common_abort();
170 }
171
172 static inline void viewer_connection_close_socket(struct live_viewer_connection *viewer_connection)
173 {
174 bt_self_component_class *self_comp_class = viewer_connection->self_comp_class;
175 bt_self_component *self_comp = viewer_connection->self_comp;
176 int ret = bt_socket_close(viewer_connection->control_sock);
177 if (ret == -1) {
178 BT_COMP_OR_COMP_CLASS_LOGW_ERRNO(self_comp, self_comp_class,
179 "Error closing viewer connection socket: ", ".");
180 }
181
182 viewer_connection->control_sock = BT_INVALID_SOCKET;
183 }
184
185 /*
186 * This function receives a message from the Relay daemon.
187 * If it received the entire message, it returns _OK,
188 * If it's interrupted, it returns _INTERRUPTED,
189 * otherwise, it returns _ERROR.
190 */
191 static enum lttng_live_viewer_status
192 lttng_live_recv(struct live_viewer_connection *viewer_connection, void *buf, size_t len)
193 {
194 ssize_t received;
195 bt_self_component_class *self_comp_class = viewer_connection->self_comp_class;
196 bt_self_component *self_comp = viewer_connection->self_comp;
197 size_t total_received = 0, to_receive = len;
198 struct lttng_live_msg_iter *lttng_live_msg_iter = viewer_connection->lttng_live_msg_iter;
199 enum lttng_live_viewer_status status;
200 BT_SOCKET sock = viewer_connection->control_sock;
201
202 /*
203 * Receive a message from the Relay.
204 */
205 do {
206 received = bt_socket_recv(sock, (char *) buf + total_received, to_receive, 0);
207 if (received == BT_SOCKET_ERROR) {
208 if (bt_socket_interrupted()) {
209 if (lttng_live_graph_is_canceled(lttng_live_msg_iter)) {
210 /*
211 * This interruption was due to a
212 * SIGINT and the graph is being torn
213 * down.
214 */
215 status = LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED;
216 lttng_live_msg_iter->was_interrupted = true;
217 goto end;
218 } else {
219 /*
220 * A signal was received, but the graph
221 * is not being torn down. Carry on.
222 */
223 continue;
224 }
225 } else {
226 /*
227 * For any other types of socket error, close
228 * the socket and return an error.
229 */
230 LTTNG_LIVE_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE_ERRNO(
231 self_comp, self_comp_class, "Error receiving from Relay", ".");
232
233 viewer_connection_close_socket(viewer_connection);
234 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
235 goto end;
236 }
237 } else if (received == 0) {
238 /*
239 * The recv() call returned 0. This means the
240 * connection was orderly shutdown from the other peer.
241 * If that happens when we are trying to receive
242 * a message from it, it means something when wrong.
243 * Close the socket and return an error.
244 */
245 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
246 "Remote side has closed connection");
247 viewer_connection_close_socket(viewer_connection);
248 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
249 goto end;
250 }
251
252 BT_ASSERT(received <= to_receive);
253 total_received += received;
254 to_receive -= received;
255
256 } while (to_receive > 0);
257
258 BT_ASSERT(total_received == len);
259 status = LTTNG_LIVE_VIEWER_STATUS_OK;
260
261 end:
262 return status;
263 }
264
265 /*
266 * This function sends a message to the Relay daemon.
267 * If it send the message, it returns _OK,
268 * If it's interrupted, it returns _INTERRUPTED,
269 * otherwise, it returns _ERROR.
270 */
271 static enum lttng_live_viewer_status
272 lttng_live_send(struct live_viewer_connection *viewer_connection, const void *buf, size_t len)
273 {
274 enum lttng_live_viewer_status status;
275 bt_self_component_class *self_comp_class = viewer_connection->self_comp_class;
276 bt_self_component *self_comp = viewer_connection->self_comp;
277 struct lttng_live_msg_iter *lttng_live_msg_iter = viewer_connection->lttng_live_msg_iter;
278 BT_SOCKET sock = viewer_connection->control_sock;
279 size_t to_send = len;
280 ssize_t total_sent = 0;
281
282 do {
283 ssize_t sent = bt_socket_send_nosigpipe(sock, (char *) buf + total_sent, to_send);
284 if (sent == BT_SOCKET_ERROR) {
285 if (bt_socket_interrupted()) {
286 if (lttng_live_graph_is_canceled(lttng_live_msg_iter)) {
287 /*
288 * This interruption was a SIGINT and
289 * the graph is being teared down.
290 */
291 status = LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED;
292 lttng_live_msg_iter->was_interrupted = true;
293 goto end;
294 } else {
295 /*
296 * A signal was received, but the graph
297 * is not being teared down. Carry on.
298 */
299 continue;
300 }
301 } else {
302 /*
303 * For any other types of socket error, close
304 * the socket and return an error.
305 */
306 LTTNG_LIVE_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE_ERRNO(
307 self_comp, self_comp_class, "Error sending to Relay", ".");
308
309 viewer_connection_close_socket(viewer_connection);
310 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
311 goto end;
312 }
313 }
314
315 BT_ASSERT(sent <= to_send);
316 total_sent += sent;
317 to_send -= sent;
318
319 } while (to_send > 0);
320
321 BT_ASSERT(total_sent == len);
322 status = LTTNG_LIVE_VIEWER_STATUS_OK;
323
324 end:
325 return status;
326 }
327
328 static int parse_url(struct live_viewer_connection *viewer_connection)
329 {
330 char error_buf[256] = {0};
331 bt_self_component *self_comp = viewer_connection->self_comp;
332 bt_self_component_class *self_comp_class = viewer_connection->self_comp_class;
333 struct bt_common_lttng_live_url_parts lttng_live_url_parts = {};
334 int ret = -1;
335 const char *path = viewer_connection->url->str;
336
337 if (!path) {
338 goto end;
339 }
340
341 lttng_live_url_parts = bt_common_parse_lttng_live_url(path, error_buf, sizeof(error_buf));
342 if (!lttng_live_url_parts.proto) {
343 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
344 "Invalid LTTng live URL format: %s", error_buf);
345 goto end;
346 }
347 viewer_connection->proto = lttng_live_url_parts.proto;
348 lttng_live_url_parts.proto = NULL;
349
350 viewer_connection->relay_hostname = lttng_live_url_parts.hostname;
351 lttng_live_url_parts.hostname = NULL;
352
353 if (lttng_live_url_parts.port >= 0) {
354 viewer_connection->port = lttng_live_url_parts.port;
355 } else {
356 viewer_connection->port = LTTNG_DEFAULT_NETWORK_VIEWER_PORT;
357 }
358
359 viewer_connection->target_hostname = lttng_live_url_parts.target_hostname;
360 lttng_live_url_parts.target_hostname = NULL;
361
362 if (lttng_live_url_parts.session_name) {
363 viewer_connection->session_name = lttng_live_url_parts.session_name;
364 lttng_live_url_parts.session_name = NULL;
365 }
366
367 ret = 0;
368
369 end:
370 bt_common_destroy_lttng_live_url_parts(&lttng_live_url_parts);
371 return ret;
372 }
373
374 static enum lttng_live_viewer_status
375 lttng_live_handshake(struct live_viewer_connection *viewer_connection)
376 {
377 struct lttng_viewer_cmd cmd;
378 struct lttng_viewer_connect connect;
379 enum lttng_live_viewer_status status;
380 bt_self_component_class *self_comp_class = viewer_connection->self_comp_class;
381 bt_self_component *self_comp = viewer_connection->self_comp;
382 const size_t cmd_buf_len = sizeof(cmd) + sizeof(connect);
383 char cmd_buf[cmd_buf_len];
384
385 BT_COMP_OR_COMP_CLASS_LOGD(
386 self_comp, self_comp_class,
387 "Handshaking with the relay daemon: cmd=%s, major-version=%u, minor-version=%u",
388 lttng_viewer_command_string(LTTNG_VIEWER_CONNECT), LTTNG_LIVE_MAJOR, LTTNG_LIVE_MINOR);
389
390 cmd.cmd = htobe32(LTTNG_VIEWER_CONNECT);
391 cmd.data_size = htobe64((uint64_t) sizeof(connect));
392 cmd.cmd_version = htobe32(0);
393
394 connect.viewer_session_id = -1ULL; /* will be set on recv */
395 connect.major = htobe32(LTTNG_LIVE_MAJOR);
396 connect.minor = htobe32(LTTNG_LIVE_MINOR);
397 connect.type = htobe32(LTTNG_VIEWER_CLIENT_COMMAND);
398
399 /*
400 * Merge the cmd and connection request to prevent a write-write
401 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
402 * second write to be performed quickly in presence of Nagle's algorithm
403 */
404 memcpy(cmd_buf, &cmd, sizeof(cmd));
405 memcpy(cmd_buf + sizeof(cmd), &connect, sizeof(connect));
406
407 status = lttng_live_send(viewer_connection, &cmd_buf, cmd_buf_len);
408 if (status != LTTNG_LIVE_VIEWER_STATUS_OK) {
409 viewer_handle_send_status(self_comp, self_comp_class, status, "viewer connect command");
410 goto end;
411 }
412
413 status = lttng_live_recv(viewer_connection, &connect, sizeof(connect));
414 if (status != LTTNG_LIVE_VIEWER_STATUS_OK) {
415 viewer_handle_recv_status(self_comp, self_comp_class, status, "viewer connect reply");
416 goto end;
417 }
418
419 BT_COMP_OR_COMP_CLASS_LOGI(self_comp, self_comp_class, "Received viewer session ID : %" PRIu64,
420 (uint64_t) be64toh(connect.viewer_session_id));
421 BT_COMP_OR_COMP_CLASS_LOGI(self_comp, self_comp_class, "Relayd version : %u.%u",
422 be32toh(connect.major), be32toh(connect.minor));
423
424 if (LTTNG_LIVE_MAJOR != be32toh(connect.major)) {
425 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
426 "Incompatible lttng-relayd protocol");
427 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
428 goto end;
429 }
430 /* Use the smallest protocol version implemented. */
431 if (LTTNG_LIVE_MINOR > be32toh(connect.minor)) {
432 viewer_connection->minor = be32toh(connect.minor);
433 } else {
434 viewer_connection->minor = LTTNG_LIVE_MINOR;
435 }
436 viewer_connection->major = LTTNG_LIVE_MAJOR;
437
438 status = LTTNG_LIVE_VIEWER_STATUS_OK;
439
440 goto end;
441
442 end:
443 return status;
444 }
445
446 static enum lttng_live_viewer_status
447 lttng_live_connect_viewer(struct live_viewer_connection *viewer_connection)
448 {
449 struct hostent *host;
450 struct sockaddr_in server_addr;
451 enum lttng_live_viewer_status status;
452 bt_self_component_class *self_comp_class = viewer_connection->self_comp_class;
453 bt_self_component *self_comp = viewer_connection->self_comp;
454
455 if (parse_url(viewer_connection)) {
456 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, "Failed to parse URL");
457 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
458 goto error;
459 }
460
461 BT_COMP_OR_COMP_CLASS_LOGD(
462 self_comp, self_comp_class,
463 "Connecting to hostname : %s, port : %d, "
464 "target hostname : %s, session name : %s, proto : %s",
465 viewer_connection->relay_hostname->str, viewer_connection->port,
466 !viewer_connection->target_hostname ? "<none>" : viewer_connection->target_hostname->str,
467 !viewer_connection->session_name ? "<none>" : viewer_connection->session_name->str,
468 viewer_connection->proto->str);
469
470 host = gethostbyname(viewer_connection->relay_hostname->str);
471 if (!host) {
472 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
473 "Cannot lookup hostname: hostname=\"%s\"",
474 viewer_connection->relay_hostname->str);
475 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
476 goto error;
477 }
478
479 if ((viewer_connection->control_sock = socket(AF_INET, SOCK_STREAM, 0)) == BT_INVALID_SOCKET) {
480 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
481 "Socket creation failed: %s", bt_socket_errormsg());
482 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
483 goto error;
484 }
485
486 server_addr.sin_family = AF_INET;
487 server_addr.sin_port = htons(viewer_connection->port);
488 server_addr.sin_addr = *((struct in_addr *) host->h_addr);
489 memset(&(server_addr.sin_zero), 0, 8);
490
491 if (connect(viewer_connection->control_sock, (struct sockaddr *) &server_addr,
492 sizeof(struct sockaddr)) == BT_SOCKET_ERROR) {
493 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class, "Connection failed: %s",
494 bt_socket_errormsg());
495 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
496 goto error;
497 }
498
499 status = lttng_live_handshake(viewer_connection);
500
501 /*
502 * Only print error and append cause in case of error. not in case of
503 * interruption.
504 */
505 if (status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
506 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
507 "Viewer handshake failed");
508 goto error;
509 } else if (status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
510 goto end;
511 }
512
513 goto end;
514
515 error:
516 if (viewer_connection->control_sock != BT_INVALID_SOCKET) {
517 if (bt_socket_close(viewer_connection->control_sock) == BT_SOCKET_ERROR) {
518 BT_COMP_OR_COMP_CLASS_LOGW(self_comp, self_comp_class, "Error closing socket: %s.",
519 bt_socket_errormsg());
520 }
521 }
522 viewer_connection->control_sock = BT_INVALID_SOCKET;
523 end:
524 return status;
525 }
526
527 static void lttng_live_disconnect_viewer(struct live_viewer_connection *viewer_connection)
528 {
529 bt_self_component_class *self_comp_class = viewer_connection->self_comp_class;
530 bt_self_component *self_comp = viewer_connection->self_comp;
531
532 if (viewer_connection->control_sock == BT_INVALID_SOCKET) {
533 return;
534 }
535 if (bt_socket_close(viewer_connection->control_sock) == BT_SOCKET_ERROR) {
536 BT_COMP_OR_COMP_CLASS_LOGW(self_comp, self_comp_class, "Error closing socket: %s",
537 bt_socket_errormsg());
538 viewer_connection->control_sock = BT_INVALID_SOCKET;
539 }
540 }
541
542 static int list_update_session(bt_value *results, const struct lttng_viewer_session *session,
543 bool *_found, struct live_viewer_connection *viewer_connection)
544 {
545 bt_self_component_class *self_comp_class = viewer_connection->self_comp_class;
546 bt_self_component *self_comp = viewer_connection->self_comp;
547 int ret = 0;
548 uint64_t i, len;
549 bt_value *map = NULL;
550 bt_value *hostname = NULL;
551 bt_value *session_name = NULL;
552 bt_value *btval = NULL;
553 bool found = false;
554
555 len = bt_value_array_get_length(results);
556 for (i = 0; i < len; i++) {
557 const char *hostname_str = NULL;
558 const char *session_name_str = NULL;
559
560 map = bt_value_array_borrow_element_by_index(results, i);
561 hostname = bt_value_map_borrow_entry_value(map, "target-hostname");
562 if (!hostname) {
563 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
564 "Error borrowing \"target-hostname\" entry.");
565 ret = -1;
566 goto end;
567 }
568 session_name = bt_value_map_borrow_entry_value(map, "session-name");
569 if (!session_name) {
570 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
571 "Error borrowing \"session-name\" entry.");
572 ret = -1;
573 goto end;
574 }
575 hostname_str = bt_value_string_get(hostname);
576 session_name_str = bt_value_string_get(session_name);
577
578 if (strcmp(session->hostname, hostname_str) == 0 &&
579 strcmp(session->session_name, session_name_str) == 0) {
580 int64_t val;
581 uint32_t streams = be32toh(session->streams);
582 uint32_t clients = be32toh(session->clients);
583
584 found = true;
585
586 btval = bt_value_map_borrow_entry_value(map, "stream-count");
587 if (!btval) {
588 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
589 "Error borrowing \"stream-count\" entry.");
590 ret = -1;
591 goto end;
592 }
593 val = bt_value_integer_unsigned_get(btval);
594 /* sum */
595 val += streams;
596 bt_value_integer_unsigned_set(btval, val);
597
598 btval = bt_value_map_borrow_entry_value(map, "client-count");
599 if (!btval) {
600 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
601 "Error borrowing \"client-count\" entry.");
602 ret = -1;
603 goto end;
604 }
605 val = bt_value_integer_unsigned_get(btval);
606 /* max */
607 val = bt_max_t(int64_t, clients, val);
608 bt_value_integer_unsigned_set(btval, val);
609 }
610
611 if (found) {
612 break;
613 }
614 }
615 end:
616 *_found = found;
617 return ret;
618 }
619
620 static int list_append_session(bt_value *results, GString *base_url,
621 const struct lttng_viewer_session *session,
622 struct live_viewer_connection *viewer_connection)
623 {
624 int ret = 0;
625 bt_self_component_class *self_comp_class = viewer_connection->self_comp_class;
626 bt_value_map_insert_entry_status insert_status;
627 bt_value_array_append_element_status append_status;
628 bt_value *map = NULL;
629 GString *url = NULL;
630 bool found = false;
631
632 /*
633 * If the session already exists, add the stream count to it,
634 * and do max of client counts.
635 */
636 ret = list_update_session(results, session, &found, viewer_connection);
637 if (ret || found) {
638 goto end;
639 }
640
641 map = bt_value_map_create();
642 if (!map) {
643 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Error creating map value.");
644 ret = -1;
645 goto end;
646 }
647
648 if (base_url->len < 1) {
649 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Error: base_url length smaller than 1.");
650 ret = -1;
651 goto end;
652 }
653 /*
654 * key = "url",
655 * value = <string>,
656 */
657 url = g_string_new(base_url->str);
658 g_string_append(url, "/host/");
659 g_string_append(url, session->hostname);
660 g_string_append_c(url, '/');
661 g_string_append(url, session->session_name);
662
663 insert_status = bt_value_map_insert_string_entry(map, "url", url->str);
664 if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
665 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Error inserting \"url\" entry.");
666 ret = -1;
667 goto end;
668 }
669
670 /*
671 * key = "target-hostname",
672 * value = <string>,
673 */
674 insert_status = bt_value_map_insert_string_entry(map, "target-hostname", session->hostname);
675 if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
676 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
677 "Error inserting \"target-hostname\" entry.");
678 ret = -1;
679 goto end;
680 }
681
682 /*
683 * key = "session-name",
684 * value = <string>,
685 */
686 insert_status = bt_value_map_insert_string_entry(map, "session-name", session->session_name);
687 if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
688 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Error inserting \"session-name\" entry.");
689 ret = -1;
690 goto end;
691 }
692
693 /*
694 * key = "timer-us",
695 * value = <integer>,
696 */
697 {
698 uint32_t live_timer = be32toh(session->live_timer);
699
700 insert_status = bt_value_map_insert_unsigned_integer_entry(map, "timer-us", live_timer);
701 if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
702 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Error inserting \"timer-us\" entry.");
703 ret = -1;
704 goto end;
705 }
706 }
707
708 /*
709 * key = "stream-count",
710 * value = <integer>,
711 */
712 {
713 uint32_t streams = be32toh(session->streams);
714
715 insert_status = bt_value_map_insert_unsigned_integer_entry(map, "stream-count", streams);
716 if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
717 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
718 "Error inserting \"stream-count\" entry.");
719 ret = -1;
720 goto end;
721 }
722 }
723
724 /*
725 * key = "client-count",
726 * value = <integer>,
727 */
728 {
729 uint32_t clients = be32toh(session->clients);
730
731 insert_status = bt_value_map_insert_unsigned_integer_entry(map, "client-count", clients);
732 if (insert_status != BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK) {
733 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class,
734 "Error inserting \"client-count\" entry.");
735 ret = -1;
736 goto end;
737 }
738 }
739
740 append_status = bt_value_array_append_element(results, map);
741 if (append_status != BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK) {
742 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Error appending map to results.");
743 ret = -1;
744 }
745
746 end:
747 if (url) {
748 g_string_free(url, true);
749 }
750 BT_VALUE_PUT_REF_AND_RESET(map);
751 return ret;
752 }
753
754 /*
755 * Data structure returned:
756 *
757 * {
758 * <array> = {
759 * [n] = {
760 * <map> = {
761 * {
762 * key = "url",
763 * value = <string>,
764 * },
765 * {
766 * key = "target-hostname",
767 * value = <string>,
768 * },
769 * {
770 * key = "session-name",
771 * value = <string>,
772 * },
773 * {
774 * key = "timer-us",
775 * value = <integer>,
776 * },
777 * {
778 * key = "stream-count",
779 * value = <integer>,
780 * },
781 * {
782 * key = "client-count",
783 * value = <integer>,
784 * },
785 * },
786 * }
787 * }
788 */
789
790 bt_component_class_query_method_status
791 live_viewer_connection_list_sessions(struct live_viewer_connection *viewer_connection,
792 const bt_value **user_result)
793 {
794 bt_self_component_class *self_comp_class = viewer_connection->self_comp_class;
795 bt_component_class_query_method_status status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
796 bt_value *result = NULL;
797 enum lttng_live_viewer_status viewer_status;
798 struct lttng_viewer_cmd cmd;
799 struct lttng_viewer_list_sessions list;
800 uint32_t i, sessions_count;
801
802 result = bt_value_array_create();
803 if (!result) {
804 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Error creating array");
805 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
806 goto error;
807 }
808
809 BT_LOGD("Requesting list of sessions: cmd=%s",
810 lttng_viewer_command_string(LTTNG_VIEWER_LIST_SESSIONS));
811
812 cmd.cmd = htobe32(LTTNG_VIEWER_LIST_SESSIONS);
813 cmd.data_size = htobe64((uint64_t) 0);
814 cmd.cmd_version = htobe32(0);
815
816 viewer_status = lttng_live_send(viewer_connection, &cmd, sizeof(cmd));
817 if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
818 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Error sending list sessions command");
819 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
820 goto error;
821 } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
822 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN;
823 goto error;
824 }
825
826 viewer_status = lttng_live_recv(viewer_connection, &list, sizeof(list));
827 if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
828 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Error receiving session list");
829 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
830 goto error;
831 } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
832 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN;
833 goto error;
834 }
835
836 sessions_count = be32toh(list.sessions_count);
837 for (i = 0; i < sessions_count; i++) {
838 struct lttng_viewer_session lsession;
839
840 viewer_status = lttng_live_recv(viewer_connection, &lsession, sizeof(lsession));
841 if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
842 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Error receiving session:");
843 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
844 goto error;
845 } else if (viewer_status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
846 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_AGAIN;
847 goto error;
848 }
849
850 lsession.hostname[LTTNG_VIEWER_HOST_NAME_MAX - 1] = '\0';
851 lsession.session_name[LTTNG_VIEWER_NAME_MAX - 1] = '\0';
852 if (list_append_session(result, viewer_connection->url, &lsession, viewer_connection)) {
853 BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "Error appending session");
854 status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
855 goto error;
856 }
857 }
858
859 *user_result = result;
860 goto end;
861 error:
862 BT_VALUE_PUT_REF_AND_RESET(result);
863 end:
864 return status;
865 }
866
867 static enum lttng_live_viewer_status
868 lttng_live_query_session_ids(struct lttng_live_msg_iter *lttng_live_msg_iter)
869 {
870 struct lttng_viewer_cmd cmd;
871 struct lttng_viewer_list_sessions list;
872 struct lttng_viewer_session lsession;
873 uint32_t i, sessions_count;
874 uint64_t session_id;
875 enum lttng_live_viewer_status status;
876 struct live_viewer_connection *viewer_connection = lttng_live_msg_iter->viewer_connection;
877 bt_self_component *self_comp = viewer_connection->self_comp;
878 bt_self_component_class *self_comp_class = viewer_connection->self_comp_class;
879
880 BT_COMP_LOGD("Asking the relay daemon for the list of sessions: cmd=%s",
881 lttng_viewer_command_string(LTTNG_VIEWER_LIST_SESSIONS));
882
883 cmd.cmd = htobe32(LTTNG_VIEWER_LIST_SESSIONS);
884 cmd.data_size = htobe64((uint64_t) 0);
885 cmd.cmd_version = htobe32(0);
886
887 status = lttng_live_send(viewer_connection, &cmd, sizeof(cmd));
888 if (status != LTTNG_LIVE_VIEWER_STATUS_OK) {
889 viewer_handle_send_status(self_comp, self_comp_class, status, "list sessions command");
890 goto end;
891 }
892
893 status = lttng_live_recv(viewer_connection, &list, sizeof(list));
894 if (status != LTTNG_LIVE_VIEWER_STATUS_OK) {
895 viewer_handle_recv_status(self_comp, self_comp_class, status, "session list reply");
896 goto end;
897 }
898
899 sessions_count = be32toh(list.sessions_count);
900 for (i = 0; i < sessions_count; i++) {
901 status = lttng_live_recv(viewer_connection, &lsession, sizeof(lsession));
902 if (status != LTTNG_LIVE_VIEWER_STATUS_OK) {
903 viewer_handle_recv_status(self_comp, self_comp_class, status, "session reply");
904 goto end;
905 }
906 lsession.hostname[LTTNG_VIEWER_HOST_NAME_MAX - 1] = '\0';
907 lsession.session_name[LTTNG_VIEWER_NAME_MAX - 1] = '\0';
908 session_id = be64toh(lsession.id);
909
910 BT_COMP_LOGI("Adding session to internal list: "
911 "session-id=%" PRIu64 ", hostname=\"%s\", session-name=\"%s\"",
912 session_id, lsession.hostname, lsession.session_name);
913
914 if ((strncmp(lsession.session_name, viewer_connection->session_name->str,
915 LTTNG_VIEWER_NAME_MAX) == 0) &&
916 (strncmp(lsession.hostname, viewer_connection->target_hostname->str,
917 LTTNG_VIEWER_HOST_NAME_MAX) == 0)) {
918 if (lttng_live_add_session(lttng_live_msg_iter, session_id, lsession.hostname,
919 lsession.session_name)) {
920 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to add live session");
921 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
922 goto end;
923 }
924 }
925 }
926
927 status = LTTNG_LIVE_VIEWER_STATUS_OK;
928
929 end:
930 return status;
931 }
932
933 enum lttng_live_viewer_status
934 lttng_live_create_viewer_session(struct lttng_live_msg_iter *lttng_live_msg_iter)
935 {
936 struct lttng_viewer_cmd cmd;
937 struct lttng_viewer_create_session_response resp;
938 enum lttng_live_viewer_status status;
939 struct live_viewer_connection *viewer_connection = lttng_live_msg_iter->viewer_connection;
940 bt_self_component *self_comp = viewer_connection->self_comp;
941 bt_self_component_class *self_comp_class = viewer_connection->self_comp_class;
942
943 BT_COMP_OR_COMP_CLASS_LOGD(self_comp, self_comp_class, "Creating a viewer session: cmd=%s",
944 lttng_viewer_command_string(LTTNG_VIEWER_CREATE_SESSION));
945
946 cmd.cmd = htobe32(LTTNG_VIEWER_CREATE_SESSION);
947 cmd.data_size = htobe64((uint64_t) 0);
948 cmd.cmd_version = htobe32(0);
949
950 status = lttng_live_send(viewer_connection, &cmd, sizeof(cmd));
951 if (status != LTTNG_LIVE_VIEWER_STATUS_OK) {
952 viewer_handle_send_status(self_comp, self_comp_class, status, "create session command");
953 goto end;
954 }
955
956 status = lttng_live_recv(viewer_connection, &resp, sizeof(resp));
957 if (status != LTTNG_LIVE_VIEWER_STATUS_OK) {
958 viewer_handle_recv_status(self_comp, self_comp_class, status, "create session reply");
959 goto end;
960 }
961
962 if (be32toh(resp.status) != LTTNG_VIEWER_CREATE_SESSION_OK) {
963 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Error creating viewer session");
964 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
965 goto end;
966 }
967
968 status = lttng_live_query_session_ids(lttng_live_msg_iter);
969 if (status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
970 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to query live viewer session ids");
971 goto end;
972 } else if (status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
973 goto end;
974 }
975
976 end:
977 return status;
978 }
979
980 static enum lttng_live_viewer_status receive_streams(struct lttng_live_session *session,
981 uint32_t stream_count,
982 bt_self_message_iterator *self_msg_iter)
983 {
984 uint32_t i;
985 struct lttng_live_msg_iter *lttng_live_msg_iter = session->lttng_live_msg_iter;
986 enum lttng_live_viewer_status status;
987 struct live_viewer_connection *viewer_connection = lttng_live_msg_iter->viewer_connection;
988 bt_self_component *self_comp = viewer_connection->self_comp;
989
990 BT_COMP_LOGI("Getting %" PRIu32 " new streams", stream_count);
991 for (i = 0; i < stream_count; i++) {
992 struct lttng_viewer_stream stream;
993 struct lttng_live_stream_iterator *live_stream;
994 uint64_t stream_id;
995 uint64_t ctf_trace_id;
996
997 status = lttng_live_recv(viewer_connection, &stream, sizeof(stream));
998 if (status != LTTNG_LIVE_VIEWER_STATUS_OK) {
999 viewer_handle_recv_status(self_comp, NULL, status, "stream reply");
1000 goto end;
1001 }
1002 stream.path_name[LTTNG_VIEWER_PATH_MAX - 1] = '\0';
1003 stream.channel_name[LTTNG_VIEWER_NAME_MAX - 1] = '\0';
1004 stream_id = be64toh(stream.id);
1005 ctf_trace_id = be64toh(stream.ctf_trace_id);
1006
1007 if (stream.metadata_flag) {
1008 BT_COMP_LOGI(" metadata stream %" PRIu64 " : %s/%s", stream_id, stream.path_name,
1009 stream.channel_name);
1010 if (lttng_live_metadata_create_stream(session, ctf_trace_id, stream_id)) {
1011 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Error creating metadata stream");
1012 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
1013 goto end;
1014 }
1015 session->lazy_stream_msg_init = true;
1016 } else {
1017 BT_COMP_LOGI(" stream %" PRIu64 " : %s/%s", stream_id, stream.path_name,
1018 stream.channel_name);
1019 live_stream =
1020 lttng_live_stream_iterator_create(session, ctf_trace_id, stream_id, self_msg_iter);
1021 if (!live_stream) {
1022 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Error creating stream");
1023 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
1024 goto end;
1025 }
1026 }
1027 }
1028 status = LTTNG_LIVE_VIEWER_STATUS_OK;
1029
1030 end:
1031 return status;
1032 }
1033
1034 enum lttng_live_viewer_status lttng_live_session_attach(struct lttng_live_session *session,
1035 bt_self_message_iterator *self_msg_iter)
1036 {
1037 struct lttng_viewer_cmd cmd;
1038 enum lttng_live_viewer_status status;
1039 struct lttng_viewer_attach_session_request rq;
1040 struct lttng_viewer_attach_session_response rp;
1041 struct lttng_live_msg_iter *lttng_live_msg_iter = session->lttng_live_msg_iter;
1042 struct live_viewer_connection *viewer_connection = lttng_live_msg_iter->viewer_connection;
1043 bt_self_component *self_comp = viewer_connection->self_comp;
1044 uint64_t session_id = session->id;
1045 uint32_t streams_count;
1046 const size_t cmd_buf_len = sizeof(cmd) + sizeof(rq);
1047 char cmd_buf[cmd_buf_len];
1048
1049 BT_COMP_LOGD("Attaching to session: cmd=%s, session-id=%" PRIu64 ", seek=%s",
1050 lttng_viewer_command_string(LTTNG_VIEWER_ATTACH_SESSION), session_id,
1051 lttng_viewer_seek_string(LTTNG_VIEWER_SEEK_LAST));
1052
1053 cmd.cmd = htobe32(LTTNG_VIEWER_ATTACH_SESSION);
1054 cmd.data_size = htobe64((uint64_t) sizeof(rq));
1055 cmd.cmd_version = htobe32(0);
1056
1057 memset(&rq, 0, sizeof(rq));
1058 rq.session_id = htobe64(session_id);
1059 // TODO: add cmd line parameter to select seek beginning
1060 // rq.seek = htobe32(LTTNG_VIEWER_SEEK_BEGINNING);
1061 rq.seek = htobe32(LTTNG_VIEWER_SEEK_LAST);
1062
1063 /*
1064 * Merge the cmd and connection request to prevent a write-write
1065 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1066 * second write to be performed quickly in presence of Nagle's algorithm.
1067 */
1068 memcpy(cmd_buf, &cmd, sizeof(cmd));
1069 memcpy(cmd_buf + sizeof(cmd), &rq, sizeof(rq));
1070 status = lttng_live_send(viewer_connection, &cmd_buf, cmd_buf_len);
1071 if (status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1072 viewer_handle_send_status(self_comp, NULL, status, "attach session command");
1073 goto end;
1074 }
1075
1076 status = lttng_live_recv(viewer_connection, &rp, sizeof(rp));
1077 if (status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1078 viewer_handle_recv_status(self_comp, NULL, status, "attach session reply");
1079 goto end;
1080 }
1081
1082 streams_count = be32toh(rp.streams_count);
1083 switch (be32toh(rp.status)) {
1084 case LTTNG_VIEWER_ATTACH_OK:
1085 break;
1086 case LTTNG_VIEWER_ATTACH_UNK:
1087 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Session id %" PRIu64 " is unknown", session_id);
1088 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
1089 goto end;
1090 case LTTNG_VIEWER_ATTACH_ALREADY:
1091 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "There is already a viewer attached to this session");
1092 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
1093 goto end;
1094 case LTTNG_VIEWER_ATTACH_NOT_LIVE:
1095 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Not a live session");
1096 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
1097 goto end;
1098 case LTTNG_VIEWER_ATTACH_SEEK_ERR:
1099 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Wrong seek parameter");
1100 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
1101 goto end;
1102 default:
1103 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Unknown attach return code %u", be32toh(rp.status));
1104 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
1105 goto end;
1106 }
1107
1108 /* We receive the initial list of streams. */
1109 status = receive_streams(session, streams_count, self_msg_iter);
1110 switch (status) {
1111 case LTTNG_LIVE_VIEWER_STATUS_OK:
1112 break;
1113 case LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED:
1114 goto end;
1115 case LTTNG_LIVE_VIEWER_STATUS_ERROR:
1116 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Error receiving streams");
1117 goto end;
1118 default:
1119 bt_common_abort();
1120 }
1121
1122 session->attached = true;
1123 session->new_streams_needed = false;
1124
1125 end:
1126 return status;
1127 }
1128
1129 enum lttng_live_viewer_status lttng_live_session_detach(struct lttng_live_session *session)
1130 {
1131 struct lttng_viewer_cmd cmd;
1132 enum lttng_live_viewer_status status;
1133 struct lttng_viewer_detach_session_request rq;
1134 struct lttng_viewer_detach_session_response rp;
1135 struct lttng_live_msg_iter *lttng_live_msg_iter = session->lttng_live_msg_iter;
1136 bt_self_component *self_comp = session->self_comp;
1137 struct live_viewer_connection *viewer_connection = lttng_live_msg_iter->viewer_connection;
1138 uint64_t session_id = session->id;
1139 const size_t cmd_buf_len = sizeof(cmd) + sizeof(rq);
1140 char cmd_buf[cmd_buf_len];
1141
1142 /*
1143 * The session might already be detached and the viewer socket might
1144 * already been closed. This happens when calling this function when
1145 * tearing down the graph after an error.
1146 */
1147 if (!session->attached || viewer_connection->control_sock == BT_INVALID_SOCKET) {
1148 return LTTNG_LIVE_VIEWER_STATUS_OK;
1149 }
1150
1151 BT_COMP_LOGD("Detaching from session: cmd=%s, session-id=%" PRIu64,
1152 lttng_viewer_command_string(LTTNG_VIEWER_DETACH_SESSION), session_id);
1153
1154 cmd.cmd = htobe32(LTTNG_VIEWER_DETACH_SESSION);
1155 cmd.data_size = htobe64((uint64_t) sizeof(rq));
1156 cmd.cmd_version = htobe32(0);
1157
1158 memset(&rq, 0, sizeof(rq));
1159 rq.session_id = htobe64(session_id);
1160
1161 /*
1162 * Merge the cmd and connection request to prevent a write-write
1163 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1164 * second write to be performed quickly in presence of Nagle's algorithm.
1165 */
1166 memcpy(cmd_buf, &cmd, sizeof(cmd));
1167 memcpy(cmd_buf + sizeof(cmd), &rq, sizeof(rq));
1168 status = lttng_live_send(viewer_connection, &cmd_buf, cmd_buf_len);
1169 if (status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1170 viewer_handle_send_status(self_comp, NULL, status, "detach session command");
1171 goto end;
1172 }
1173
1174 status = lttng_live_recv(viewer_connection, &rp, sizeof(rp));
1175 if (status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1176 viewer_handle_recv_status(self_comp, NULL, status, "detach session reply");
1177 goto end;
1178 }
1179
1180 switch (be32toh(rp.status)) {
1181 case LTTNG_VIEWER_DETACH_SESSION_OK:
1182 break;
1183 case LTTNG_VIEWER_DETACH_SESSION_UNK:
1184 BT_COMP_LOGW("Session id %" PRIu64 " is unknown", session_id);
1185 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
1186 goto end;
1187 case LTTNG_VIEWER_DETACH_SESSION_ERR:
1188 BT_COMP_LOGW("Error detaching session id %" PRIu64 "", session_id);
1189 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
1190 goto end;
1191 default:
1192 BT_COMP_LOGE("Unknown detach return code %u", be32toh(rp.status));
1193 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
1194 goto end;
1195 }
1196
1197 session->attached = false;
1198
1199 status = LTTNG_LIVE_VIEWER_STATUS_OK;
1200
1201 end:
1202 return status;
1203 }
1204
1205 enum lttng_live_get_one_metadata_status
1206 lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace, FILE *fp, size_t *reply_len)
1207 {
1208 uint64_t len = 0;
1209 enum lttng_live_get_one_metadata_status status;
1210 enum lttng_live_viewer_status viewer_status;
1211 struct lttng_viewer_cmd cmd;
1212 struct lttng_viewer_get_metadata rq;
1213 struct lttng_viewer_metadata_packet rp;
1214 gchar *data = NULL;
1215 ssize_t writelen;
1216 struct lttng_live_session *session = trace->session;
1217 struct lttng_live_msg_iter *lttng_live_msg_iter = session->lttng_live_msg_iter;
1218 struct lttng_live_metadata *metadata = trace->metadata;
1219 struct live_viewer_connection *viewer_connection = lttng_live_msg_iter->viewer_connection;
1220 bt_self_component *self_comp = viewer_connection->self_comp;
1221 const size_t cmd_buf_len = sizeof(cmd) + sizeof(rq);
1222 char cmd_buf[cmd_buf_len];
1223
1224 BT_COMP_LOGD("Requesting new metadata for trace:"
1225 "cmd=%s, trace-id=%" PRIu64 ", metadata-stream-id=%" PRIu64,
1226 lttng_viewer_command_string(LTTNG_VIEWER_GET_METADATA), trace->id,
1227 metadata->stream_id);
1228
1229 rq.stream_id = htobe64(metadata->stream_id);
1230 cmd.cmd = htobe32(LTTNG_VIEWER_GET_METADATA);
1231 cmd.data_size = htobe64((uint64_t) sizeof(rq));
1232 cmd.cmd_version = htobe32(0);
1233
1234 /*
1235 * Merge the cmd and connection request to prevent a write-write
1236 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1237 * second write to be performed quickly in presence of Nagle's algorithm.
1238 */
1239 memcpy(cmd_buf, &cmd, sizeof(cmd));
1240 memcpy(cmd_buf + sizeof(cmd), &rq, sizeof(rq));
1241 viewer_status = lttng_live_send(viewer_connection, &cmd_buf, cmd_buf_len);
1242 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1243 viewer_handle_send_status(self_comp, NULL, viewer_status, "get metadata command");
1244 status = (enum lttng_live_get_one_metadata_status) viewer_status;
1245 goto end;
1246 }
1247
1248 viewer_status = lttng_live_recv(viewer_connection, &rp, sizeof(rp));
1249 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1250 viewer_handle_recv_status(self_comp, NULL, viewer_status, "get metadata reply");
1251 status = (enum lttng_live_get_one_metadata_status) viewer_status;
1252 goto end;
1253 }
1254
1255 switch (be32toh(rp.status)) {
1256 case LTTNG_VIEWER_METADATA_OK:
1257 BT_COMP_LOGD("Received get_metadata response: ok");
1258 break;
1259 case LTTNG_VIEWER_NO_NEW_METADATA:
1260 BT_COMP_LOGD("Received get_metadata response: no new");
1261 status = LTTNG_LIVE_GET_ONE_METADATA_STATUS_END;
1262 goto end;
1263 case LTTNG_VIEWER_METADATA_ERR:
1264 /*
1265 * The Relayd cannot find this stream id. Maybe its
1266 * gone already. This can happen in short lived UST app
1267 * in a per-pid session.
1268 */
1269 BT_COMP_LOGD("Received get_metadata response: error");
1270 status = LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED;
1271 goto end;
1272 default:
1273 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Received get_metadata response: unknown");
1274 status = LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR;
1275 goto end;
1276 }
1277
1278 len = be64toh(rp.len);
1279 if (len == 0) {
1280 /*
1281 * We received a `LTTNG_VIEWER_METADATA_OK` with a packet
1282 * length of 0. This means we must try again. This scenario
1283 * arises when a clear command is performed on an lttng session.
1284 */
1285 BT_COMP_LOGD(
1286 "Expecting a metadata packet of size 0. Retry to get a packet from the relay.");
1287 goto empty_metadata_packet_retry;
1288 }
1289
1290 BT_COMP_LOGD("Writing %" PRIu64 " bytes to metadata", len);
1291 if (len <= 0) {
1292 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Erroneous response length");
1293 status = LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR;
1294 goto end;
1295 }
1296
1297 data = g_new0(gchar, len);
1298 if (!data) {
1299 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp, "Failed to allocate data buffer", ".");
1300 status = LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR;
1301 goto end;
1302 }
1303
1304 viewer_status = lttng_live_recv(viewer_connection, data, len);
1305 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1306 viewer_handle_recv_status(self_comp, NULL, viewer_status, "get metadata packet");
1307 status = (enum lttng_live_get_one_metadata_status) viewer_status;
1308 goto end;
1309 }
1310
1311 /*
1312 * Write the metadata to the file handle.
1313 */
1314 writelen = fwrite(data, sizeof(uint8_t), len, fp);
1315 if (writelen != len) {
1316 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Writing in the metadata file stream");
1317 status = LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR;
1318 goto end;
1319 }
1320
1321 empty_metadata_packet_retry:
1322 *reply_len = len;
1323 status = LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK;
1324
1325 end:
1326 g_free(data);
1327 return status;
1328 }
1329
1330 /*
1331 * Assign the fields from a lttng_viewer_index to a packet_index.
1332 */
1333 static void lttng_index_to_packet_index(struct lttng_viewer_index *lindex,
1334 struct packet_index *pindex)
1335 {
1336 BT_ASSERT(lindex);
1337 BT_ASSERT(pindex);
1338
1339 pindex->offset = be64toh(lindex->offset);
1340 pindex->packet_size = be64toh(lindex->packet_size);
1341 pindex->content_size = be64toh(lindex->content_size);
1342 pindex->ts_cycles.timestamp_begin = be64toh(lindex->timestamp_begin);
1343 pindex->ts_cycles.timestamp_end = be64toh(lindex->timestamp_end);
1344 pindex->events_discarded = be64toh(lindex->events_discarded);
1345 }
1346
1347 static void lttng_live_need_new_streams(struct lttng_live_msg_iter *lttng_live_msg_iter)
1348 {
1349 uint64_t session_idx;
1350 struct live_viewer_connection *viewer_connection = lttng_live_msg_iter->viewer_connection;
1351
1352 for (session_idx = 0; session_idx < lttng_live_msg_iter->sessions->len; session_idx++) {
1353 struct lttng_live_session *session =
1354 (lttng_live_session *) g_ptr_array_index(lttng_live_msg_iter->sessions, session_idx);
1355 BT_COMP_LOGD("Marking session as needing new streams: "
1356 "session-id=%" PRIu64,
1357 session->id);
1358 session->new_streams_needed = true;
1359 }
1360 }
1361
1362 enum lttng_live_iterator_status
1363 lttng_live_get_next_index(struct lttng_live_msg_iter *lttng_live_msg_iter,
1364 struct lttng_live_stream_iterator *stream, struct packet_index *index)
1365 {
1366 struct lttng_viewer_cmd cmd;
1367 struct lttng_viewer_get_next_index rq;
1368 enum lttng_live_viewer_status viewer_status;
1369 struct lttng_viewer_index rp;
1370 enum lttng_live_iterator_status status;
1371 struct live_viewer_connection *viewer_connection = lttng_live_msg_iter->viewer_connection;
1372 bt_self_component *self_comp = viewer_connection->self_comp;
1373 struct lttng_live_trace *trace = stream->trace;
1374 const size_t cmd_buf_len = sizeof(cmd) + sizeof(rq);
1375 char cmd_buf[cmd_buf_len];
1376 uint32_t flags, rp_status;
1377
1378 BT_COMP_LOGD("Requesting next index for stream: cmd=%s, "
1379 "viewer-stream-id=%" PRIu64,
1380 lttng_viewer_command_string(LTTNG_VIEWER_GET_NEXT_INDEX),
1381 stream->viewer_stream_id);
1382 cmd.cmd = htobe32(LTTNG_VIEWER_GET_NEXT_INDEX);
1383 cmd.data_size = htobe64((uint64_t) sizeof(rq));
1384 cmd.cmd_version = htobe32(0);
1385
1386 memset(&rq, 0, sizeof(rq));
1387 rq.stream_id = htobe64(stream->viewer_stream_id);
1388
1389 /*
1390 * Merge the cmd and connection request to prevent a write-write
1391 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1392 * second write to be performed quickly in presence of Nagle's algorithm.
1393 */
1394 memcpy(cmd_buf, &cmd, sizeof(cmd));
1395 memcpy(cmd_buf + sizeof(cmd), &rq, sizeof(rq));
1396
1397 viewer_status = lttng_live_send(viewer_connection, &cmd_buf, cmd_buf_len);
1398 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1399 viewer_handle_send_status(self_comp, NULL, viewer_status, "get next index command");
1400 goto error;
1401 }
1402
1403 viewer_status = lttng_live_recv(viewer_connection, &rp, sizeof(rp));
1404 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1405 viewer_handle_recv_status(self_comp, NULL, viewer_status, "get next index reply");
1406 goto error;
1407 }
1408
1409 flags = be32toh(rp.flags);
1410 rp_status = be32toh(rp.status);
1411
1412 BT_COMP_LOGD("Received response from relay daemon: cmd=%s, response=%s",
1413 lttng_viewer_command_string(LTTNG_VIEWER_GET_NEXT_INDEX),
1414 lttng_viewer_next_index_return_code_string(rp_status));
1415 switch (rp_status) {
1416 case LTTNG_VIEWER_INDEX_INACTIVE:
1417 {
1418 uint64_t ctf_stream_class_id;
1419
1420 memset(index, 0, sizeof(struct packet_index));
1421 index->ts_cycles.timestamp_end = be64toh(rp.timestamp_end);
1422 stream->current_inactivity_ts = index->ts_cycles.timestamp_end;
1423 ctf_stream_class_id = be64toh(rp.stream_id);
1424 if (stream->ctf_stream_class_id.is_set) {
1425 BT_ASSERT(stream->ctf_stream_class_id.value == ctf_stream_class_id);
1426 } else {
1427 stream->ctf_stream_class_id.value = ctf_stream_class_id;
1428 stream->ctf_stream_class_id.is_set = true;
1429 }
1430 lttng_live_stream_iterator_set_state(stream, LTTNG_LIVE_STREAM_QUIESCENT);
1431 status = LTTNG_LIVE_ITERATOR_STATUS_OK;
1432 break;
1433 }
1434 case LTTNG_VIEWER_INDEX_OK:
1435 {
1436 uint64_t ctf_stream_class_id;
1437
1438 lttng_index_to_packet_index(&rp, index);
1439 ctf_stream_class_id = be64toh(rp.stream_id);
1440 if (stream->ctf_stream_class_id.is_set) {
1441 BT_ASSERT(stream->ctf_stream_class_id.value == ctf_stream_class_id);
1442 } else {
1443 stream->ctf_stream_class_id.value = ctf_stream_class_id;
1444 stream->ctf_stream_class_id.is_set = true;
1445 }
1446
1447 lttng_live_stream_iterator_set_state(stream, LTTNG_LIVE_STREAM_ACTIVE_DATA);
1448
1449 if (flags & LTTNG_VIEWER_FLAG_NEW_METADATA) {
1450 BT_COMP_LOGD("Marking trace as needing new metadata: "
1451 "response=%s, response-flag=NEW_METADATA, trace-id=%" PRIu64,
1452 lttng_viewer_next_index_return_code_string(rp_status), trace->id);
1453 trace->metadata_stream_state = LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED;
1454 }
1455 if (flags & LTTNG_VIEWER_FLAG_NEW_STREAM) {
1456 BT_COMP_LOGD("Marking all sessions as possibly needing new streams: "
1457 "response=%s, response-flag=NEW_STREAM",
1458 lttng_viewer_next_index_return_code_string(rp_status));
1459 lttng_live_need_new_streams(lttng_live_msg_iter);
1460 }
1461 status = LTTNG_LIVE_ITERATOR_STATUS_OK;
1462 break;
1463 }
1464 case LTTNG_VIEWER_INDEX_RETRY:
1465 memset(index, 0, sizeof(struct packet_index));
1466 lttng_live_stream_iterator_set_state(stream, LTTNG_LIVE_STREAM_ACTIVE_NO_DATA);
1467 status = LTTNG_LIVE_ITERATOR_STATUS_AGAIN;
1468 goto end;
1469 case LTTNG_VIEWER_INDEX_HUP:
1470 memset(index, 0, sizeof(struct packet_index));
1471 index->offset = EOF;
1472 lttng_live_stream_iterator_set_state(stream, LTTNG_LIVE_STREAM_EOF);
1473 stream->has_stream_hung_up = true;
1474 status = LTTNG_LIVE_ITERATOR_STATUS_END;
1475 break;
1476 case LTTNG_VIEWER_INDEX_ERR:
1477 memset(index, 0, sizeof(struct packet_index));
1478 lttng_live_stream_iterator_set_state(stream, LTTNG_LIVE_STREAM_ACTIVE_NO_DATA);
1479 status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
1480 goto end;
1481 default:
1482 BT_COMP_LOGD("Received get_next_index response: unknown value");
1483 memset(index, 0, sizeof(struct packet_index));
1484 lttng_live_stream_iterator_set_state(stream, LTTNG_LIVE_STREAM_ACTIVE_NO_DATA);
1485 status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
1486 goto end;
1487 }
1488 goto end;
1489
1490 error:
1491 status = viewer_status_to_live_iterator_status(viewer_status);
1492 end:
1493 return status;
1494 }
1495
1496 enum ctf_msg_iter_medium_status
1497 lttng_live_get_stream_bytes(struct lttng_live_msg_iter *lttng_live_msg_iter,
1498 struct lttng_live_stream_iterator *stream, uint8_t *buf,
1499 uint64_t offset, uint64_t req_len, uint64_t *recv_len)
1500 {
1501 enum ctf_msg_iter_medium_status status;
1502 enum lttng_live_viewer_status viewer_status;
1503 struct lttng_viewer_trace_packet rp;
1504 struct lttng_viewer_cmd cmd;
1505 struct lttng_viewer_get_packet rq;
1506 struct live_viewer_connection *viewer_connection = lttng_live_msg_iter->viewer_connection;
1507 bt_self_component *self_comp = viewer_connection->self_comp;
1508 struct lttng_live_trace *trace = stream->trace;
1509 const size_t cmd_buf_len = sizeof(cmd) + sizeof(rq);
1510 char cmd_buf[cmd_buf_len];
1511 uint32_t flags, rp_status;
1512
1513 BT_COMP_LOGD("Requesting data from stream: cmd=%s, "
1514 "offset=%" PRIu64 ", request-len=%" PRIu64,
1515 lttng_viewer_command_string(LTTNG_VIEWER_GET_PACKET), offset, req_len);
1516
1517 cmd.cmd = htobe32(LTTNG_VIEWER_GET_PACKET);
1518 cmd.data_size = htobe64((uint64_t) sizeof(rq));
1519 cmd.cmd_version = htobe32(0);
1520
1521 memset(&rq, 0, sizeof(rq));
1522 rq.stream_id = htobe64(stream->viewer_stream_id);
1523 rq.offset = htobe64(offset);
1524 rq.len = htobe32(req_len);
1525
1526 /*
1527 * Merge the cmd and connection request to prevent a write-write
1528 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1529 * second write to be performed quickly in presence of Nagle's algorithm.
1530 */
1531 memcpy(cmd_buf, &cmd, sizeof(cmd));
1532 memcpy(cmd_buf + sizeof(cmd), &rq, sizeof(rq));
1533
1534 viewer_status = lttng_live_send(viewer_connection, &cmd_buf, cmd_buf_len);
1535 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1536 viewer_handle_send_status(self_comp, NULL, viewer_status, "get data packet command");
1537 goto error_convert_status;
1538 }
1539
1540 viewer_status = lttng_live_recv(viewer_connection, &rp, sizeof(rp));
1541 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1542 viewer_handle_recv_status(self_comp, NULL, viewer_status, "get data packet reply");
1543 goto error_convert_status;
1544 }
1545
1546 flags = be32toh(rp.flags);
1547 rp_status = be32toh(rp.status);
1548
1549 BT_COMP_LOGD("Received response from relay daemon: cmd=%s, response=%s",
1550 lttng_viewer_command_string(LTTNG_VIEWER_GET_PACKET),
1551 lttng_viewer_get_packet_return_code_string(rp_status));
1552 switch (rp_status) {
1553 case LTTNG_VIEWER_GET_PACKET_OK:
1554 req_len = be32toh(rp.len);
1555 BT_COMP_LOGD("Got packet from relay daemon: response=%s, packet-len=%" PRIu64 "",
1556 lttng_viewer_get_packet_return_code_string(rp_status), req_len);
1557 break;
1558 case LTTNG_VIEWER_GET_PACKET_RETRY:
1559 /* Unimplemented by relay daemon */
1560 status = CTF_MSG_ITER_MEDIUM_STATUS_AGAIN;
1561 goto end;
1562 case LTTNG_VIEWER_GET_PACKET_ERR:
1563 if (flags & LTTNG_VIEWER_FLAG_NEW_METADATA) {
1564 BT_COMP_LOGD("Marking trace as needing new metadata: "
1565 "response=%s, response-flag=NEW_METADATA, trace-id=%" PRIu64,
1566 lttng_viewer_next_index_return_code_string(rp_status), trace->id);
1567 trace->metadata_stream_state = LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED;
1568 }
1569 if (flags & LTTNG_VIEWER_FLAG_NEW_STREAM) {
1570 BT_COMP_LOGD("Marking all sessions as possibly needing new streams: "
1571 "response=%s, response-flag=NEW_STREAM",
1572 lttng_viewer_next_index_return_code_string(rp_status));
1573 lttng_live_need_new_streams(lttng_live_msg_iter);
1574 }
1575 if (flags & (LTTNG_VIEWER_FLAG_NEW_METADATA | LTTNG_VIEWER_FLAG_NEW_STREAM)) {
1576 status = CTF_MSG_ITER_MEDIUM_STATUS_AGAIN;
1577 BT_COMP_LOGD("Reply with any one flags set means we should retry: response=%s",
1578 lttng_viewer_get_packet_return_code_string(rp_status));
1579 goto end;
1580 }
1581 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Received get_data_packet response: error");
1582 status = CTF_MSG_ITER_MEDIUM_STATUS_ERROR;
1583 goto end;
1584 case LTTNG_VIEWER_GET_PACKET_EOF:
1585 status = CTF_MSG_ITER_MEDIUM_STATUS_EOF;
1586 goto end;
1587 default:
1588 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Received get_data_packet response: unknown (%d)",
1589 rp_status);
1590 status = CTF_MSG_ITER_MEDIUM_STATUS_ERROR;
1591 goto end;
1592 }
1593
1594 if (req_len == 0) {
1595 status = CTF_MSG_ITER_MEDIUM_STATUS_ERROR;
1596 goto end;
1597 }
1598
1599 viewer_status = lttng_live_recv(viewer_connection, buf, req_len);
1600 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1601 viewer_handle_recv_status(self_comp, NULL, viewer_status, "get data packet");
1602 goto error_convert_status;
1603 }
1604 *recv_len = req_len;
1605
1606 status = CTF_MSG_ITER_MEDIUM_STATUS_OK;
1607 goto end;
1608
1609 error_convert_status:
1610 status = viewer_status_to_ctf_msg_iter_medium_status(viewer_status);
1611 end:
1612 return status;
1613 }
1614
1615 /*
1616 * Request new streams for a session.
1617 */
1618 enum lttng_live_iterator_status
1619 lttng_live_session_get_new_streams(struct lttng_live_session *session,
1620 bt_self_message_iterator *self_msg_iter)
1621 {
1622 enum lttng_live_iterator_status status = LTTNG_LIVE_ITERATOR_STATUS_OK;
1623 struct lttng_viewer_cmd cmd;
1624 struct lttng_viewer_new_streams_request rq;
1625 struct lttng_viewer_new_streams_response rp;
1626 struct lttng_live_msg_iter *lttng_live_msg_iter = session->lttng_live_msg_iter;
1627 enum lttng_live_viewer_status viewer_status;
1628 struct live_viewer_connection *viewer_connection = lttng_live_msg_iter->viewer_connection;
1629 bt_self_component *self_comp = viewer_connection->self_comp;
1630 uint32_t streams_count;
1631 const size_t cmd_buf_len = sizeof(cmd) + sizeof(rq);
1632 char cmd_buf[cmd_buf_len];
1633
1634 if (!session->new_streams_needed) {
1635 status = LTTNG_LIVE_ITERATOR_STATUS_OK;
1636 goto end;
1637 }
1638
1639 BT_COMP_LOGD("Requesting new streams for session: cmd=%s, "
1640 "session-id=%" PRIu64,
1641 lttng_viewer_command_string(LTTNG_VIEWER_GET_NEW_STREAMS), session->id);
1642
1643 cmd.cmd = htobe32(LTTNG_VIEWER_GET_NEW_STREAMS);
1644 cmd.data_size = htobe64((uint64_t) sizeof(rq));
1645 cmd.cmd_version = htobe32(0);
1646
1647 memset(&rq, 0, sizeof(rq));
1648 rq.session_id = htobe64(session->id);
1649
1650 /*
1651 * Merge the cmd and connection request to prevent a write-write
1652 * sequence on the TCP socket. Otherwise, a delayed ACK will prevent the
1653 * second write to be performed quickly in presence of Nagle's algorithm.
1654 */
1655 memcpy(cmd_buf, &cmd, sizeof(cmd));
1656 memcpy(cmd_buf + sizeof(cmd), &rq, sizeof(rq));
1657
1658 viewer_status = lttng_live_send(viewer_connection, &cmd_buf, cmd_buf_len);
1659 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1660 viewer_handle_send_status(self_comp, NULL, viewer_status, "get new streams command");
1661 status = viewer_status_to_live_iterator_status(viewer_status);
1662 goto end;
1663 }
1664
1665 viewer_status = lttng_live_recv(viewer_connection, &rp, sizeof(rp));
1666 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1667 viewer_handle_recv_status(self_comp, NULL, viewer_status, "get new streams reply");
1668 status = viewer_status_to_live_iterator_status(viewer_status);
1669 goto end;
1670 }
1671
1672 streams_count = be32toh(rp.streams_count);
1673
1674 switch (be32toh(rp.status)) {
1675 case LTTNG_VIEWER_NEW_STREAMS_OK:
1676 session->new_streams_needed = false;
1677 break;
1678 case LTTNG_VIEWER_NEW_STREAMS_NO_NEW:
1679 session->new_streams_needed = false;
1680 goto end;
1681 case LTTNG_VIEWER_NEW_STREAMS_HUP:
1682 session->new_streams_needed = false;
1683 session->closed = true;
1684 status = LTTNG_LIVE_ITERATOR_STATUS_END;
1685 goto end;
1686 case LTTNG_VIEWER_NEW_STREAMS_ERR:
1687 BT_COMP_LOGD("Received get_new_streams response: error");
1688 status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
1689 goto end;
1690 default:
1691 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
1692 "Received get_new_streams response: Unknown:"
1693 "return code %u",
1694 be32toh(rp.status));
1695 status = LTTNG_LIVE_ITERATOR_STATUS_ERROR;
1696 goto end;
1697 }
1698
1699 viewer_status = receive_streams(session, streams_count, self_msg_iter);
1700 if (viewer_status != LTTNG_LIVE_VIEWER_STATUS_OK) {
1701 viewer_handle_recv_status(self_comp, NULL, viewer_status, "new streams");
1702 status = viewer_status_to_live_iterator_status(viewer_status);
1703 goto end;
1704 }
1705
1706 status = LTTNG_LIVE_ITERATOR_STATUS_OK;
1707 end:
1708 return status;
1709 }
1710
1711 enum lttng_live_viewer_status live_viewer_connection_create(
1712 bt_self_component *self_comp, bt_self_component_class *self_comp_class,
1713 bt_logging_level log_level, const char *url, bool in_query,
1714 struct lttng_live_msg_iter *lttng_live_msg_iter, struct live_viewer_connection **viewer)
1715 {
1716 struct live_viewer_connection *viewer_connection;
1717 enum lttng_live_viewer_status status;
1718
1719 viewer_connection = g_new0(struct live_viewer_connection, 1);
1720
1721 if (bt_socket_init(log_level) != 0) {
1722 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
1723 "Failed to init socket");
1724 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
1725 goto error;
1726 }
1727
1728 viewer_connection->log_level = log_level;
1729
1730 viewer_connection->self_comp = self_comp;
1731 viewer_connection->self_comp_class = self_comp_class;
1732
1733 viewer_connection->control_sock = BT_INVALID_SOCKET;
1734 viewer_connection->port = -1;
1735 viewer_connection->in_query = in_query;
1736 viewer_connection->lttng_live_msg_iter = lttng_live_msg_iter;
1737 viewer_connection->url = g_string_new(url);
1738 if (!viewer_connection->url) {
1739 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
1740 "Failed to allocate URL buffer");
1741 status = LTTNG_LIVE_VIEWER_STATUS_ERROR;
1742 goto error;
1743 }
1744
1745 BT_COMP_OR_COMP_CLASS_LOGD(self_comp, self_comp_class,
1746 "Establishing connection to url \"%s\"...", url);
1747 status = lttng_live_connect_viewer(viewer_connection);
1748 /*
1749 * Only print error and append cause in case of error. not in case of
1750 * interruption.
1751 */
1752 if (status == LTTNG_LIVE_VIEWER_STATUS_ERROR) {
1753 BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp, self_comp_class,
1754 "Failed to establish connection: "
1755 "url=\"%s\"",
1756 url);
1757 goto error;
1758 } else if (status == LTTNG_LIVE_VIEWER_STATUS_INTERRUPTED) {
1759 goto error;
1760 }
1761 BT_COMP_OR_COMP_CLASS_LOGD(self_comp, self_comp_class,
1762 "Connection to url \"%s\" is established", url);
1763
1764 *viewer = viewer_connection;
1765 status = LTTNG_LIVE_VIEWER_STATUS_OK;
1766 goto end;
1767
1768 error:
1769 if (viewer_connection) {
1770 live_viewer_connection_destroy(viewer_connection);
1771 }
1772 end:
1773 return status;
1774 }
1775
1776 void live_viewer_connection_destroy(struct live_viewer_connection *viewer_connection)
1777 {
1778 bt_self_component *self_comp = viewer_connection->self_comp;
1779 bt_self_component_class *self_comp_class = viewer_connection->self_comp_class;
1780
1781 if (!viewer_connection) {
1782 goto end;
1783 }
1784
1785 BT_COMP_OR_COMP_CLASS_LOGD(self_comp, self_comp_class,
1786 "Closing connection to relay:"
1787 "relay-url=\"%s\"",
1788 viewer_connection->url->str);
1789
1790 lttng_live_disconnect_viewer(viewer_connection);
1791
1792 if (viewer_connection->url) {
1793 g_string_free(viewer_connection->url, true);
1794 }
1795
1796 if (viewer_connection->relay_hostname) {
1797 g_string_free(viewer_connection->relay_hostname, true);
1798 }
1799
1800 if (viewer_connection->target_hostname) {
1801 g_string_free(viewer_connection->target_hostname, true);
1802 }
1803
1804 if (viewer_connection->session_name) {
1805 g_string_free(viewer_connection->session_name, true);
1806 }
1807
1808 if (viewer_connection->proto) {
1809 g_string_free(viewer_connection->proto, true);
1810 }
1811
1812 g_free(viewer_connection);
1813
1814 bt_socket_fini();
1815
1816 end:
1817 return;
1818 }
This page took 0.067987 seconds and 4 git commands to generate.