Fix: relayd: failure to open chunk files concurrently with session clear
[lttng-tools.git] / src / bin / lttng-relayd / live.c
CommitLineData
d3e2ba59 1/*
ab5be9fa
MJ
2 * Copyright (C) 2013 Julien Desfossez <jdesfossez@efficios.com>
3 * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
4 * Copyright (C) 2015 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
d3e2ba59 5 *
ab5be9fa 6 * SPDX-License-Identifier: GPL-2.0-only
d3e2ba59 7 *
d3e2ba59
JD
8 */
9
6c1c0768 10#define _LGPL_SOURCE
8bb66c3c 11#include <fcntl.h>
d3e2ba59
JD
12#include <getopt.h>
13#include <grp.h>
8bb66c3c 14#include <inttypes.h>
d3e2ba59
JD
15#include <limits.h>
16#include <pthread.h>
17#include <signal.h>
18#include <stdio.h>
19#include <stdlib.h>
20#include <string.h>
21#include <sys/mman.h>
22#include <sys/mount.h>
23#include <sys/resource.h>
24#include <sys/socket.h>
25#include <sys/stat.h>
26#include <sys/types.h>
27#include <sys/wait.h>
8bb66c3c 28#include <unistd.h>
d3e2ba59 29#include <urcu/futex.h>
7591bab1 30#include <urcu/rculist.h>
8bb66c3c 31#include <urcu/uatomic.h>
d3e2ba59 32
d3e2ba59 33#include <common/common.h>
8bb66c3c 34#include <common/compat/endian.h>
d3e2ba59
JD
35#include <common/compat/poll.h>
36#include <common/compat/socket.h>
37#include <common/defaults.h>
8bb66c3c
JG
38#include <common/fd-tracker/utils.h>
39#include <common/fs-handle.h>
d3e2ba59 40#include <common/futex.h>
2f8f53af 41#include <common/index/index.h>
d3e2ba59
JD
42#include <common/sessiond-comm/inet.h>
43#include <common/sessiond-comm/relayd.h>
8bb66c3c 44#include <common/sessiond-comm/sessiond-comm.h>
d3e2ba59
JD
45#include <common/uri.h>
46#include <common/utils.h>
8bb66c3c 47#include <lttng/lttng.h>
d3e2ba59
JD
48
49#include "cmd.h"
8bb66c3c
JG
50#include "connection.h"
51#include "ctf-trace.h"
52#include "health-relayd.h"
d3e2ba59
JD
53#include "live.h"
54#include "lttng-relayd.h"
2a174661 55#include "session.h"
8bb66c3c
JG
56#include "stream.h"
57#include "testpoint.h"
58#include "utils.h"
7591bab1 59#include "viewer-session.h"
8bb66c3c 60#include "viewer-stream.h"
7591bab1
MD
61
62#define SESSION_BUF_DEFAULT_COUNT 16
d3e2ba59
JD
63
64static struct lttng_uri *live_uri;
65
d3e2ba59
JD
66/*
67 * This pipe is used to inform the worker thread that a command is queued and
68 * ready to be processed.
69 */
58eb9381 70static int live_conn_pipe[2] = { -1, -1 };
d3e2ba59
JD
71
72/* Shared between threads */
73static int live_dispatch_thread_exit;
74
75static pthread_t live_listener_thread;
76static pthread_t live_dispatcher_thread;
77static pthread_t live_worker_thread;
78
79/*
80 * Relay command queue.
81 *
82 * The live_thread_listener and live_thread_dispatcher communicate with this
83 * queue.
84 */
58eb9381 85static struct relay_conn_queue viewer_conn_queue;
d3e2ba59
JD
86
87static uint64_t last_relay_viewer_session_id;
7591bab1
MD
88static pthread_mutex_t last_relay_viewer_session_id_lock =
89 PTHREAD_MUTEX_INITIALIZER;
d3e2ba59
JD
90
91/*
92 * Cleanup the daemon
93 */
94static
178a0557 95void cleanup_relayd_live(void)
d3e2ba59
JD
96{
97 DBG("Cleaning up");
98
d3e2ba59
JD
99 free(live_uri);
100}
101
2f8f53af
DG
102/*
103 * Receive a request buffer using a given socket, destination allocated buffer
104 * of length size.
105 *
106 * Return the size of the received message or else a negative value on error
107 * with errno being set by recvmsg() syscall.
108 */
109static
110ssize_t recv_request(struct lttcomm_sock *sock, void *buf, size_t size)
111{
112 ssize_t ret;
113
2f8f53af
DG
114 ret = sock->ops->recvmsg(sock, buf, size, 0);
115 if (ret < 0 || ret != size) {
116 if (ret == 0) {
117 /* Orderly shutdown. Not necessary to print an error. */
118 DBG("Socket %d did an orderly shutdown", sock->fd);
119 } else {
120 ERR("Relay failed to receive request.");
121 }
122 ret = -1;
123 }
124
125 return ret;
126}
127
128/*
129 * Send a response buffer using a given socket, source allocated buffer of
130 * length size.
131 *
132 * Return the size of the sent message or else a negative value on error with
133 * errno being set by sendmsg() syscall.
134 */
135static
136ssize_t send_response(struct lttcomm_sock *sock, void *buf, size_t size)
137{
138 ssize_t ret;
139
2f8f53af
DG
140 ret = sock->ops->sendmsg(sock, buf, size, 0);
141 if (ret < 0) {
142 ERR("Relayd failed to send response.");
143 }
144
145 return ret;
146}
147
148/*
f04a971b
JD
149 * Atomically check if new streams got added in one of the sessions attached
150 * and reset the flag to 0.
2f8f53af
DG
151 *
152 * Returns 1 if new streams got added, 0 if nothing changed, a negative value
153 * on error.
154 */
155static
f04a971b 156int check_new_streams(struct relay_connection *conn)
2f8f53af 157{
2f8f53af 158 struct relay_session *session;
f04a971b
JD
159 unsigned long current_val;
160 int ret = 0;
2f8f53af 161
f04a971b
JD
162 if (!conn->viewer_session) {
163 goto end;
164 }
7591bab1
MD
165 rcu_read_lock();
166 cds_list_for_each_entry_rcu(session,
167 &conn->viewer_session->session_list,
168 viewer_session_node) {
169 if (!session_get(session)) {
170 continue;
171 }
f04a971b
JD
172 current_val = uatomic_cmpxchg(&session->new_streams, 1, 0);
173 ret = current_val;
7591bab1 174 session_put(session);
f04a971b
JD
175 if (ret == 1) {
176 goto end;
177 }
2f8f53af 178 }
f04a971b 179end:
7591bab1 180 rcu_read_unlock();
2f8f53af
DG
181 return ret;
182}
183
184/*
185 * Send viewer streams to the given socket. The ignore_sent_flag indicates if
186 * this function should ignore the sent flag or not.
187 *
188 * Return 0 on success or else a negative value.
189 */
190static
191ssize_t send_viewer_streams(struct lttcomm_sock *sock,
c06fdd95 192 uint64_t session_id, unsigned int ignore_sent_flag)
2f8f53af
DG
193{
194 ssize_t ret;
2f8f53af
DG
195 struct lttng_ht_iter iter;
196 struct relay_viewer_stream *vstream;
197
2f8f53af
DG
198 rcu_read_lock();
199
200 cds_lfht_for_each_entry(viewer_streams_ht->ht, &iter.iter, vstream,
201 stream_n.node) {
2a174661 202 struct ctf_trace *ctf_trace;
aaabc543 203 struct lttng_viewer_stream send_stream = {};
2a174661 204
2f8f53af
DG
205 health_code_update();
206
7591bab1
MD
207 if (!viewer_stream_get(vstream)) {
208 continue;
209 }
210
211 pthread_mutex_lock(&vstream->stream->lock);
2f8f53af 212 /* Ignore if not the same session. */
c06fdd95 213 if (vstream->stream->trace->session->id != session_id ||
2f8f53af 214 (!ignore_sent_flag && vstream->sent_flag)) {
7591bab1
MD
215 pthread_mutex_unlock(&vstream->stream->lock);
216 viewer_stream_put(vstream);
2f8f53af
DG
217 continue;
218 }
219
7591bab1
MD
220 ctf_trace = vstream->stream->trace;
221 send_stream.id = htobe64(vstream->stream->stream_handle);
2a174661 222 send_stream.ctf_trace_id = htobe64(ctf_trace->id);
7591bab1
MD
223 send_stream.metadata_flag = htobe32(
224 vstream->stream->is_metadata);
f8f011fb
MD
225 if (lttng_strncpy(send_stream.path_name, vstream->path_name,
226 sizeof(send_stream.path_name))) {
227 pthread_mutex_unlock(&vstream->stream->lock);
228 viewer_stream_put(vstream);
229 ret = -1; /* Error. */
230 goto end_unlock;
231 }
232 if (lttng_strncpy(send_stream.channel_name,
233 vstream->channel_name,
234 sizeof(send_stream.channel_name))) {
235 pthread_mutex_unlock(&vstream->stream->lock);
236 viewer_stream_put(vstream);
237 ret = -1; /* Error. */
238 goto end_unlock;
239 }
2f8f53af 240
7591bab1
MD
241 DBG("Sending stream %" PRIu64 " to viewer",
242 vstream->stream->stream_handle);
243 vstream->sent_flag = 1;
244 pthread_mutex_unlock(&vstream->stream->lock);
245
2f8f53af 246 ret = send_response(sock, &send_stream, sizeof(send_stream));
7591bab1 247 viewer_stream_put(vstream);
2f8f53af
DG
248 if (ret < 0) {
249 goto end_unlock;
250 }
2f8f53af
DG
251 }
252
253 ret = 0;
254
255end_unlock:
256 rcu_read_unlock();
257 return ret;
258}
259
260/*
261 * Create every viewer stream possible for the given session with the seek
262 * type. Three counters *can* be return which are in order the total amount of
263 * viewer stream of the session, the number of unsent stream and the number of
264 * stream created. Those counters can be NULL and thus will be ignored.
265 *
c06fdd95
JG
266 * session must be locked to ensure that we see either none or all initial
267 * streams for a session, but no intermediate state..
268 *
2f8f53af
DG
269 * Return 0 on success or else a negative value.
270 */
9edaf114
JG
271static int make_viewer_streams(struct relay_session *relay_session,
272 struct relay_viewer_session *viewer_session,
b66a15d1
JG
273 enum lttng_viewer_seek seek_t,
274 uint32_t *nb_total,
275 uint32_t *nb_unsent,
276 uint32_t *nb_created,
277 bool *closed)
2f8f53af
DG
278{
279 int ret;
2f8f53af 280 struct lttng_ht_iter iter;
2a174661 281 struct ctf_trace *ctf_trace;
9edaf114 282 struct relay_stream *relay_stream = NULL;
2f8f53af 283
9edaf114
JG
284 assert(relay_session);
285 ASSERT_LOCKED(relay_session->lock);
2f8f53af 286
9edaf114 287 if (relay_session->connection_closed) {
bddf80e4
MD
288 *closed = true;
289 }
290
2f8f53af 291 /*
7591bab1
MD
292 * Create viewer streams for relay streams that are ready to be
293 * used for a the given session id only.
2f8f53af 294 */
2a174661 295 rcu_read_lock();
9edaf114
JG
296 cds_lfht_for_each_entry (relay_session->ctf_traces_ht->ht, &iter.iter,
297 ctf_trace, node.node) {
123ed7c2 298 bool trace_has_metadata_stream = false;
2f8f53af
DG
299
300 health_code_update();
301
7591bab1 302 if (!ctf_trace_get(ctf_trace)) {
2f8f53af
DG
303 continue;
304 }
305
123ed7c2
FD
306 /*
307 * Iterate over all the streams of the trace to see if we have a
308 * metadata stream.
309 */
9edaf114
JG
310 cds_list_for_each_entry_rcu(relay_stream,
311 &ctf_trace->stream_list, stream_node)
123ed7c2 312 {
9edaf114
JG
313 bool is_metadata_stream;
314
315 pthread_mutex_lock(&relay_stream->lock);
316 is_metadata_stream = relay_stream->is_metadata;
317 pthread_mutex_unlock(&relay_stream->lock);
318
319 if (is_metadata_stream) {
123ed7c2
FD
320 trace_has_metadata_stream = true;
321 break;
322 }
323 }
324
9edaf114
JG
325 relay_stream = NULL;
326
123ed7c2
FD
327 /*
328 * If there is no metadata stream in this trace at the moment
329 * and we never sent one to the viewer, skip the trace. We
330 * accept that the viewer will not see this trace at all.
331 */
332 if (!trace_has_metadata_stream &&
333 !ctf_trace->metadata_stream_sent_to_viewer) {
3d7708ff
JG
334 ctf_trace_put(ctf_trace);
335 continue;
123ed7c2
FD
336 }
337
9edaf114
JG
338 cds_list_for_each_entry_rcu(relay_stream,
339 &ctf_trace->stream_list, stream_node)
340 {
341 struct relay_viewer_stream *viewer_stream;
2a174661 342
9edaf114 343 if (!stream_get(relay_stream)) {
2a174661
DG
344 continue;
345 }
9edaf114
JG
346
347 pthread_mutex_lock(&relay_stream->lock);
7591bab1 348 /*
d812ecb9 349 * stream published is protected by the session lock.
7591bab1 350 */
9edaf114 351 if (!relay_stream->published) {
7591bab1
MD
352 goto next;
353 }
9edaf114
JG
354 viewer_stream = viewer_stream_get_by_id(
355 relay_stream->stream_handle);
356 if (!viewer_stream) {
80516611 357 struct lttng_trace_chunk *viewer_stream_trace_chunk = NULL;
9edaf114 358
123ed7c2
FD
359 /*
360 * Save that we sent the metadata stream to the
361 * viewer. So that we know what trace the viewer
362 * is aware of.
363 */
9edaf114
JG
364 if (relay_stream->is_metadata) {
365 ctf_trace->metadata_stream_sent_to_viewer = true;
366 }
367
368 /*
369 * If a rotation is ongoing, use a copy of the
370 * relay stream's chunk to ensure the stream
371 * files exist.
372 *
373 * Otherwise, the viewer session's current trace
374 * chunk can be used safely.
375 */
376 if ((relay_stream->ongoing_rotation.is_set ||
377 relay_session->ongoing_rotation) &&
378 relay_stream->trace_chunk) {
379 viewer_stream_trace_chunk = lttng_trace_chunk_copy(
380 relay_stream->trace_chunk);
381 if (!viewer_stream_trace_chunk) {
382 ret = -1;
383 ctf_trace_put(ctf_trace);
384 goto error_unlock;
385 }
386 } else {
80516611
JG
387 /*
388 * Transition the viewer session into the newest trace chunk available.
389 */
390 if (!lttng_trace_chunk_ids_equal(viewer_session->current_trace_chunk,
391 relay_stream->trace_chunk)) {
392
393 ret = viewer_session_set_trace_chunk_copy(
394 viewer_session,
395 relay_stream->trace_chunk);
396 if (ret) {
397 ret = -1;
398 ctf_trace_put(ctf_trace);
399 goto error_unlock;
400 }
401 }
9edaf114 402
7a962c33
JG
403 if (relay_stream->trace_chunk) {
404 /*
405 * If the corresponding relay
406 * stream's trace chunk is set,
407 * the viewer stream will be
408 * created under it.
409 *
410 * Note that a relay stream can
411 * have a NULL output trace
412 * chunk (for instance, after a
413 * clear against a stopped
414 * session).
415 */
416 const bool reference_acquired = lttng_trace_chunk_get(
417 viewer_session->current_trace_chunk);
418
419 assert(reference_acquired);
420 viewer_stream_trace_chunk =
421 viewer_session->current_trace_chunk;
422 }
123ed7c2 423 }
9edaf114
JG
424
425 viewer_stream = viewer_stream_create(
426 relay_stream,
427 viewer_stream_trace_chunk,
428 seek_t);
429 lttng_trace_chunk_put(viewer_stream_trace_chunk);
430 viewer_stream_trace_chunk = NULL;
431 if (!viewer_stream) {
2a174661 432 ret = -1;
7591bab1 433 ctf_trace_put(ctf_trace);
2a174661
DG
434 goto error_unlock;
435 }
2a174661
DG
436
437 if (nb_created) {
438 /* Update number of created stream counter. */
439 (*nb_created)++;
440 }
2229a09c
MD
441 /*
442 * Ensure a self-reference is preserved even
443 * after we have put our local reference.
444 */
9edaf114 445 if (!viewer_stream_get(viewer_stream)) {
862d3a3b
MD
446 ERR("Unable to get self-reference on viewer stream, logic error.");
447 abort();
448 }
7591bab1 449 } else {
9edaf114 450 if (!viewer_stream->sent_flag && nb_unsent) {
7591bab1
MD
451 /* Update number of unsent stream counter. */
452 (*nb_unsent)++;
453 }
2f8f53af 454 }
2a174661
DG
455 /* Update number of total stream counter. */
456 if (nb_total) {
9edaf114
JG
457 if (relay_stream->is_metadata) {
458 if (!relay_stream->closed ||
459 relay_stream->metadata_received >
460 viewer_stream->metadata_sent) {
2229a09c
MD
461 (*nb_total)++;
462 }
463 } else {
9edaf114
JG
464 if (!relay_stream->closed ||
465 !(((int64_t)(relay_stream->prev_data_seq -
466 relay_stream->last_net_seq_num)) >=
467 0)) {
2229a09c
MD
468 (*nb_total)++;
469 }
470 }
2f8f53af 471 }
2229a09c 472 /* Put local reference. */
9edaf114 473 viewer_stream_put(viewer_stream);
7591bab1 474 next:
9edaf114
JG
475 pthread_mutex_unlock(&relay_stream->lock);
476 stream_put(relay_stream);
2f8f53af 477 }
9edaf114 478 relay_stream = NULL;
7591bab1 479 ctf_trace_put(ctf_trace);
2f8f53af
DG
480 }
481
482 ret = 0;
483
484error_unlock:
2a174661 485 rcu_read_unlock();
80516611 486
9edaf114
JG
487 if (relay_stream) {
488 pthread_mutex_unlock(&relay_stream->lock);
489 stream_put(relay_stream);
490 }
491
2f8f53af
DG
492 return ret;
493}
494
b4aacfdc 495int relayd_live_stop(void)
d3e2ba59 496{
b4aacfdc 497 /* Stop dispatch thread */
d3e2ba59 498 CMM_STORE_SHARED(live_dispatch_thread_exit, 1);
58eb9381 499 futex_nto1_wake(&viewer_conn_queue.futex);
b4aacfdc 500 return 0;
d3e2ba59
JD
501}
502
d3e2ba59
JD
503/*
504 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
505 */
506static
23f940ff
JG
507int create_named_thread_poll_set(struct lttng_poll_event *events,
508 int size, const char *name)
d3e2ba59
JD
509{
510 int ret;
511
512 if (events == NULL || size == 0) {
513 ret = -1;
514 goto error;
515 }
516
23f940ff
JG
517 ret = fd_tracker_util_poll_create(the_fd_tracker,
518 name, events, 1, LTTNG_CLOEXEC);
ad36f3a7
JG
519 if (ret) {
520 PERROR("Failed to create \"%s\" poll file descriptor", name);
521 goto error;
522 }
d3e2ba59
JD
523
524 /* Add quit pipe */
bcf4a440 525 ret = lttng_poll_add(events, thread_quit_pipe[0], LPOLLIN | LPOLLERR);
d3e2ba59
JD
526 if (ret < 0) {
527 goto error;
528 }
529
530 return 0;
531
532error:
533 return ret;
534}
535
536/*
537 * Check if the thread quit pipe was triggered.
538 *
539 * Return 1 if it was triggered else 0;
540 */
541static
bcf4a440 542int check_thread_quit_pipe(int fd, uint32_t events)
d3e2ba59 543{
bcf4a440 544 if (fd == thread_quit_pipe[0] && (events & LPOLLIN)) {
d3e2ba59
JD
545 return 1;
546 }
547
548 return 0;
549}
550
8855795d
JG
551static
552int create_sock(void *data, int *out_fd)
553{
554 int ret;
555 struct lttcomm_sock *sock = data;
556
557 ret = lttcomm_create_sock(sock);
558 if (ret < 0) {
559 goto end;
560 }
561
562 *out_fd = sock->fd;
563end:
564 return ret;
565}
566
567static
568int close_sock(void *data, int *in_fd)
569{
570 struct lttcomm_sock *sock = data;
571
572 return sock->ops->close(sock);
573}
574
29555a78
JG
575static int accept_sock(void *data, int *out_fd)
576{
577 int ret = 0;
578 /* Socks is an array of in_sock, out_sock. */
579 struct lttcomm_sock **socks = data;
580 struct lttcomm_sock *in_sock = socks[0];
581
582 socks[1] = in_sock->ops->accept(in_sock);
583 if (!socks[1]) {
584 ret = -1;
585 goto end;
586 }
587 *out_fd = socks[1]->fd;
588end:
589 return ret;
590}
591
592static
593struct lttcomm_sock *accept_live_sock(struct lttcomm_sock *listening_sock,
594 const char *name)
595{
596 int out_fd, ret;
597 struct lttcomm_sock *socks[2] = { listening_sock, NULL };
598 struct lttcomm_sock *new_sock = NULL;
599
600 ret = fd_tracker_open_unsuspendable_fd(the_fd_tracker, &out_fd,
601 (const char **) &name, 1, accept_sock, &socks);
602 if (ret) {
603 goto end;
604 }
605 new_sock = socks[1];
606 DBG("%s accepted, socket %d", name, new_sock->fd);
607end:
608 return new_sock;
609}
610
d3e2ba59
JD
611/*
612 * Create and init socket from uri.
613 */
614static
8855795d 615struct lttcomm_sock *init_socket(struct lttng_uri *uri, const char *name)
d3e2ba59 616{
8855795d 617 int ret, sock_fd;
d3e2ba59 618 struct lttcomm_sock *sock = NULL;
8855795d
JG
619 char uri_str[LTTNG_PATH_MAX];
620 char *formated_name = NULL;
d3e2ba59
JD
621
622 sock = lttcomm_alloc_sock_from_uri(uri);
623 if (sock == NULL) {
624 ERR("Allocating socket");
625 goto error;
626 }
627
8855795d
JG
628 /*
629 * Don't fail to create the socket if the name can't be built as it is
630 * only used for debugging purposes.
631 */
632 ret = uri_to_str_url(uri, uri_str, sizeof(uri_str));
633 uri_str[sizeof(uri_str) - 1] = '\0';
634 if (ret >= 0) {
635 ret = asprintf(&formated_name, "%s socket @ %s", name,
636 uri_str);
637 if (ret < 0) {
638 formated_name = NULL;
639 }
d3e2ba59 640 }
8855795d
JG
641
642 ret = fd_tracker_open_unsuspendable_fd(the_fd_tracker, &sock_fd,
643 (const char **) (formated_name ? &formated_name : NULL),
644 1, create_sock, sock);
d546eeec
JG
645 if (ret) {
646 PERROR("Failed to create \"%s\" socket",
647 formated_name ?: "Unknown");
648 goto error;
649 }
8855795d 650 DBG("Listening on %s socket %d", name, sock->fd);
d3e2ba59
JD
651
652 ret = sock->ops->bind(sock);
653 if (ret < 0) {
2288467f 654 PERROR("Failed to bind lttng-live socket");
d3e2ba59
JD
655 goto error;
656 }
657
658 ret = sock->ops->listen(sock, -1);
659 if (ret < 0) {
660 goto error;
661
662 }
663
d546eeec 664 free(formated_name);
d3e2ba59
JD
665 return sock;
666
667error:
668 if (sock) {
669 lttcomm_destroy_sock(sock);
670 }
d546eeec 671 free(formated_name);
d3e2ba59
JD
672 return NULL;
673}
674
675/*
676 * This thread manages the listening for new connections on the network
677 */
678static
679void *thread_listener(void *data)
680{
681 int i, ret, pollfd, err = -1;
d3e2ba59
JD
682 uint32_t revents, nb_fd;
683 struct lttng_poll_event events;
684 struct lttcomm_sock *live_control_sock;
685
686 DBG("[thread] Relay live listener started");
687
8fba2b8d 688 rcu_register_thread();
eea7556c
MD
689 health_register(health_relayd, HEALTH_RELAYD_TYPE_LIVE_LISTENER);
690
691 health_code_update();
692
8855795d 693 live_control_sock = init_socket(live_uri, "Live listener");
d3e2ba59
JD
694 if (!live_control_sock) {
695 goto error_sock_control;
696 }
697
fb4d42ab 698 /* Pass 2 as size here for the thread quit pipe and control sockets. */
23f940ff
JG
699 ret = create_named_thread_poll_set(&events, 2,
700 "Live listener thread epoll");
d3e2ba59
JD
701 if (ret < 0) {
702 goto error_create_poll;
703 }
704
705 /* Add the control socket */
706 ret = lttng_poll_add(&events, live_control_sock->fd, LPOLLIN | LPOLLRDHUP);
707 if (ret < 0) {
708 goto error_poll_add;
709 }
710
3fd27398
MD
711 lttng_relay_notify_ready();
712
9b5e0863
MD
713 if (testpoint(relayd_thread_live_listener)) {
714 goto error_testpoint;
715 }
716
d3e2ba59 717 while (1) {
eea7556c
MD
718 health_code_update();
719
d3e2ba59
JD
720 DBG("Listener accepting live viewers connections");
721
722restart:
eea7556c 723 health_poll_entry();
d3e2ba59 724 ret = lttng_poll_wait(&events, -1);
eea7556c 725 health_poll_exit();
d3e2ba59
JD
726 if (ret < 0) {
727 /*
728 * Restart interrupted system call.
729 */
730 if (errno == EINTR) {
731 goto restart;
732 }
733 goto error;
734 }
735 nb_fd = ret;
736
737 DBG("Relay new viewer connection received");
738 for (i = 0; i < nb_fd; i++) {
eea7556c
MD
739 health_code_update();
740
d3e2ba59
JD
741 /* Fetch once the poll data */
742 revents = LTTNG_POLL_GETEV(&events, i);
743 pollfd = LTTNG_POLL_GETFD(&events, i);
744
745 /* Thread quit pipe has been closed. Killing thread. */
bcf4a440 746 ret = check_thread_quit_pipe(pollfd, revents);
d3e2ba59
JD
747 if (ret) {
748 err = 0;
749 goto exit;
750 }
751
03e43155 752 if (revents & LPOLLIN) {
d3e2ba59 753 /*
7591bab1
MD
754 * A new connection is requested, therefore a
755 * viewer connection is allocated in this
756 * thread, enqueued to a global queue and
757 * dequeued (and freed) in the worker thread.
d3e2ba59 758 */
58eb9381
DG
759 int val = 1;
760 struct relay_connection *new_conn;
d3e2ba59
JD
761 struct lttcomm_sock *newsock;
762
29555a78
JG
763 newsock = accept_live_sock(live_control_sock,
764 "Live socket to client");
d3e2ba59
JD
765 if (!newsock) {
766 PERROR("accepting control sock");
d3e2ba59
JD
767 goto error;
768 }
769 DBG("Relay viewer connection accepted socket %d", newsock->fd);
58eb9381 770
d3e2ba59 771 ret = setsockopt(newsock->fd, SOL_SOCKET, SO_REUSEADDR, &val,
58eb9381 772 sizeof(val));
d3e2ba59
JD
773 if (ret < 0) {
774 PERROR("setsockopt inet");
775 lttcomm_destroy_sock(newsock);
d3e2ba59
JD
776 goto error;
777 }
7591bab1
MD
778 new_conn = connection_create(newsock, RELAY_CONNECTION_UNKNOWN);
779 if (!new_conn) {
780 lttcomm_destroy_sock(newsock);
781 goto error;
782 }
783 /* Ownership assumed by the connection. */
784 newsock = NULL;
d3e2ba59 785
58eb9381 786 /* Enqueue request for the dispatcher thread. */
8bdee6e2
SM
787 cds_wfcq_enqueue(&viewer_conn_queue.head, &viewer_conn_queue.tail,
788 &new_conn->qnode);
d3e2ba59
JD
789
790 /*
7591bab1
MD
791 * Wake the dispatch queue futex.
792 * Implicit memory barrier with the
793 * exchange in cds_wfcq_enqueue.
d3e2ba59 794 */
58eb9381 795 futex_nto1_wake(&viewer_conn_queue.futex);
03e43155
MD
796 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
797 ERR("socket poll error");
798 goto error;
799 } else {
800 ERR("Unexpected poll events %u for sock %d", revents, pollfd);
801 goto error;
d3e2ba59
JD
802 }
803 }
804 }
805
806exit:
807error:
808error_poll_add:
9b5e0863 809error_testpoint:
23f940ff 810 (void) fd_tracker_util_poll_clean(the_fd_tracker, &events);
d3e2ba59
JD
811error_create_poll:
812 if (live_control_sock->fd >= 0) {
8855795d
JG
813 int sock_fd = live_control_sock->fd;
814
815 ret = fd_tracker_close_unsuspendable_fd(the_fd_tracker,
816 &sock_fd, 1, close_sock,
817 live_control_sock);
d3e2ba59
JD
818 if (ret) {
819 PERROR("close");
820 }
8855795d 821 live_control_sock->fd = -1;
d3e2ba59
JD
822 }
823 lttcomm_destroy_sock(live_control_sock);
824error_sock_control:
825 if (err) {
eea7556c 826 health_error();
d3e2ba59
JD
827 DBG("Live viewer listener thread exited with error");
828 }
eea7556c 829 health_unregister(health_relayd);
8fba2b8d 830 rcu_unregister_thread();
d3e2ba59 831 DBG("Live viewer listener thread cleanup complete");
b4aacfdc
MD
832 if (lttng_relay_stop_threads()) {
833 ERR("Error stopping threads");
178a0557 834 }
d3e2ba59
JD
835 return NULL;
836}
837
838/*
839 * This thread manages the dispatching of the requests to worker threads
840 */
841static
842void *thread_dispatcher(void *data)
843{
6cd525e8
MD
844 int err = -1;
845 ssize_t ret;
8bdee6e2 846 struct cds_wfcq_node *node;
58eb9381 847 struct relay_connection *conn = NULL;
d3e2ba59
JD
848
849 DBG("[thread] Live viewer relay dispatcher started");
850
eea7556c
MD
851 health_register(health_relayd, HEALTH_RELAYD_TYPE_LIVE_DISPATCHER);
852
9b5e0863
MD
853 if (testpoint(relayd_thread_live_dispatcher)) {
854 goto error_testpoint;
855 }
856
eea7556c
MD
857 health_code_update();
858
0ed3b1a8 859 for (;;) {
eea7556c
MD
860 health_code_update();
861
d3e2ba59 862 /* Atomically prepare the queue futex */
58eb9381 863 futex_nto1_prepare(&viewer_conn_queue.futex);
d3e2ba59 864
0ed3b1a8
MD
865 if (CMM_LOAD_SHARED(live_dispatch_thread_exit)) {
866 break;
867 }
868
d3e2ba59 869 do {
eea7556c
MD
870 health_code_update();
871
d3e2ba59 872 /* Dequeue commands */
8bdee6e2
SM
873 node = cds_wfcq_dequeue_blocking(&viewer_conn_queue.head,
874 &viewer_conn_queue.tail);
d3e2ba59
JD
875 if (node == NULL) {
876 DBG("Woken up but nothing in the live-viewer "
877 "relay command queue");
878 /* Continue thread execution */
879 break;
880 }
58eb9381 881 conn = caa_container_of(node, struct relay_connection, qnode);
d3e2ba59 882 DBG("Dispatching viewer request waiting on sock %d",
58eb9381 883 conn->sock->fd);
d3e2ba59
JD
884
885 /*
7591bab1
MD
886 * Inform worker thread of the new request. This
887 * call is blocking so we can be assured that
888 * the data will be read at some point in time
889 * or wait to the end of the world :)
d3e2ba59 890 */
58eb9381
DG
891 ret = lttng_write(live_conn_pipe[1], &conn, sizeof(conn));
892 if (ret < 0) {
893 PERROR("write conn pipe");
7591bab1 894 connection_put(conn);
d3e2ba59
JD
895 goto error;
896 }
897 } while (node != NULL);
898
899 /* Futex wait on queue. Blocking call on futex() */
eea7556c 900 health_poll_entry();
58eb9381 901 futex_nto1_wait(&viewer_conn_queue.futex);
eea7556c 902 health_poll_exit();
d3e2ba59
JD
903 }
904
eea7556c
MD
905 /* Normal exit, no error */
906 err = 0;
907
d3e2ba59 908error:
9b5e0863 909error_testpoint:
eea7556c
MD
910 if (err) {
911 health_error();
912 ERR("Health error occurred in %s", __func__);
913 }
914 health_unregister(health_relayd);
d3e2ba59 915 DBG("Live viewer dispatch thread dying");
b4aacfdc
MD
916 if (lttng_relay_stop_threads()) {
917 ERR("Error stopping threads");
178a0557 918 }
d3e2ba59
JD
919 return NULL;
920}
921
922/*
923 * Establish connection with the viewer and check the versions.
924 *
925 * Return 0 on success or else negative value.
926 */
927static
58eb9381 928int viewer_connect(struct relay_connection *conn)
d3e2ba59
JD
929{
930 int ret;
931 struct lttng_viewer_connect reply, msg;
932
58eb9381 933 conn->version_check_done = 1;
d3e2ba59 934
eea7556c
MD
935 health_code_update();
936
2f8f53af
DG
937 DBG("Viewer is establishing a connection to the relayd.");
938
58eb9381 939 ret = recv_request(conn->sock, &msg, sizeof(msg));
2f8f53af 940 if (ret < 0) {
d3e2ba59
JD
941 goto end;
942 }
943
eea7556c
MD
944 health_code_update();
945
f46b2ce6 946 memset(&reply, 0, sizeof(reply));
d3e2ba59
JD
947 reply.major = RELAYD_VERSION_COMM_MAJOR;
948 reply.minor = RELAYD_VERSION_COMM_MINOR;
949
950 /* Major versions must be the same */
951 if (reply.major != be32toh(msg.major)) {
2f8f53af
DG
952 DBG("Incompatible major versions ([relayd] %u vs [client] %u)",
953 reply.major, be32toh(msg.major));
72180669 954 ret = -1;
d3e2ba59
JD
955 goto end;
956 }
957
58eb9381 958 conn->major = reply.major;
d3e2ba59
JD
959 /* We adapt to the lowest compatible version */
960 if (reply.minor <= be32toh(msg.minor)) {
58eb9381 961 conn->minor = reply.minor;
d3e2ba59 962 } else {
58eb9381 963 conn->minor = be32toh(msg.minor);
d3e2ba59
JD
964 }
965
c4e361a4 966 if (be32toh(msg.type) == LTTNG_VIEWER_CLIENT_COMMAND) {
58eb9381 967 conn->type = RELAY_VIEWER_COMMAND;
c4e361a4 968 } else if (be32toh(msg.type) == LTTNG_VIEWER_CLIENT_NOTIFICATION) {
58eb9381 969 conn->type = RELAY_VIEWER_NOTIFICATION;
d3e2ba59
JD
970 } else {
971 ERR("Unknown connection type : %u", be32toh(msg.type));
972 ret = -1;
973 goto end;
974 }
975
976 reply.major = htobe32(reply.major);
977 reply.minor = htobe32(reply.minor);
58eb9381 978 if (conn->type == RELAY_VIEWER_COMMAND) {
93b4787b 979 /*
7591bab1
MD
980 * Increment outside of htobe64 macro, because the argument can
981 * be used more than once within the macro, and thus the
982 * operation may be undefined.
93b4787b 983 */
7591bab1 984 pthread_mutex_lock(&last_relay_viewer_session_id_lock);
93b4787b 985 last_relay_viewer_session_id++;
7591bab1 986 pthread_mutex_unlock(&last_relay_viewer_session_id_lock);
93b4787b 987 reply.viewer_session_id = htobe64(last_relay_viewer_session_id);
d3e2ba59 988 }
eea7556c
MD
989
990 health_code_update();
991
58eb9381 992 ret = send_response(conn->sock, &reply, sizeof(reply));
d3e2ba59 993 if (ret < 0) {
2f8f53af 994 goto end;
d3e2ba59
JD
995 }
996
eea7556c
MD
997 health_code_update();
998
58eb9381 999 DBG("Version check done using protocol %u.%u", conn->major, conn->minor);
d3e2ba59
JD
1000 ret = 0;
1001
1002end:
1003 return ret;
1004}
1005
1006/*
1007 * Send the viewer the list of current sessions.
7591bab1
MD
1008 * We need to create a copy of the hash table content because otherwise
1009 * we cannot assume the number of entries stays the same between getting
1010 * the number of HT elements and iteration over the HT.
d3e2ba59
JD
1011 *
1012 * Return 0 on success or else a negative value.
1013 */
1014static
58eb9381 1015int viewer_list_sessions(struct relay_connection *conn)
d3e2ba59 1016{
5f10c6b1 1017 int ret = 0;
d3e2ba59 1018 struct lttng_viewer_list_sessions session_list;
d3e2ba59 1019 struct lttng_ht_iter iter;
d3e2ba59 1020 struct relay_session *session;
7591bab1
MD
1021 struct lttng_viewer_session *send_session_buf = NULL;
1022 uint32_t buf_count = SESSION_BUF_DEFAULT_COUNT;
1023 uint32_t count = 0;
d3e2ba59
JD
1024
1025 DBG("List sessions received");
1026
7591bab1
MD
1027 send_session_buf = zmalloc(SESSION_BUF_DEFAULT_COUNT * sizeof(*send_session_buf));
1028 if (!send_session_buf) {
1029 return -1;
d3e2ba59
JD
1030 }
1031
7591bab1
MD
1032 rcu_read_lock();
1033 cds_lfht_for_each_entry(sessions_ht->ht, &iter.iter, session,
2f8f53af 1034 session_n.node) {
7591bab1 1035 struct lttng_viewer_session *send_session;
d3e2ba59 1036
eea7556c
MD
1037 health_code_update();
1038
d995f382 1039 pthread_mutex_lock(&session->lock);
7e0a4379
JR
1040 if (session->connection_closed) {
1041 /* Skip closed session */
d995f382
JG
1042 goto next_session;
1043 }
7e0a4379 1044
7591bab1
MD
1045 if (count >= buf_count) {
1046 struct lttng_viewer_session *newbuf;
1047 uint32_t new_buf_count = buf_count << 1;
eea7556c 1048
7591bab1
MD
1049 newbuf = realloc(send_session_buf,
1050 new_buf_count * sizeof(*send_session_buf));
1051 if (!newbuf) {
1052 ret = -1;
d995f382 1053 goto break_loop;
7591bab1
MD
1054 }
1055 send_session_buf = newbuf;
1056 buf_count = new_buf_count;
6763619c 1057 }
7591bab1 1058 send_session = &send_session_buf[count];
bfc3fb17
MD
1059 if (lttng_strncpy(send_session->session_name,
1060 session->session_name,
1061 sizeof(send_session->session_name))) {
1062 ret = -1;
d995f382 1063 goto break_loop;
bfc3fb17
MD
1064 }
1065 if (lttng_strncpy(send_session->hostname, session->hostname,
1066 sizeof(send_session->hostname))) {
1067 ret = -1;
d995f382 1068 goto break_loop;
bfc3fb17 1069 }
7591bab1
MD
1070 send_session->id = htobe64(session->id);
1071 send_session->live_timer = htobe32(session->live_timer);
1072 if (session->viewer_attached) {
1073 send_session->clients = htobe32(1);
1074 } else {
1075 send_session->clients = htobe32(0);
d227d5bd 1076 }
7591bab1
MD
1077 send_session->streams = htobe32(session->stream_count);
1078 count++;
d995f382
JG
1079 next_session:
1080 pthread_mutex_unlock(&session->lock);
1081 continue;
1082 break_loop:
1083 pthread_mutex_unlock(&session->lock);
1084 break;
7591bab1
MD
1085 }
1086 rcu_read_unlock();
5f10c6b1
JG
1087 if (ret < 0) {
1088 goto end_free;
1089 }
d227d5bd 1090
7591bab1 1091 session_list.sessions_count = htobe32(count);
d227d5bd 1092
7591bab1 1093 health_code_update();
d227d5bd 1094
7591bab1
MD
1095 ret = send_response(conn->sock, &session_list, sizeof(session_list));
1096 if (ret < 0) {
1097 goto end_free;
d227d5bd 1098 }
d227d5bd 1099
7591bab1 1100 health_code_update();
d227d5bd 1101
7591bab1
MD
1102 ret = send_response(conn->sock, send_session_buf,
1103 count * sizeof(*send_session_buf));
1104 if (ret < 0) {
1105 goto end_free;
d227d5bd 1106 }
7591bab1 1107 health_code_update();
d227d5bd 1108
7591bab1
MD
1109 ret = 0;
1110end_free:
1111 free(send_session_buf);
1112 return ret;
d227d5bd
JD
1113}
1114
80e8027a 1115/*
7591bab1 1116 * Send the viewer the list of current streams.
80e8027a
JD
1117 */
1118static
58eb9381 1119int viewer_get_new_streams(struct relay_connection *conn)
80e8027a
JD
1120{
1121 int ret, send_streams = 0;
7591bab1 1122 uint32_t nb_created = 0, nb_unsent = 0, nb_streams = 0, nb_total = 0;
80e8027a
JD
1123 struct lttng_viewer_new_streams_request request;
1124 struct lttng_viewer_new_streams_response response;
b66a15d1 1125 struct relay_session *session = NULL;
6763619c 1126 uint64_t session_id;
bddf80e4 1127 bool closed = false;
80e8027a 1128
58eb9381 1129 assert(conn);
80e8027a
JD
1130
1131 DBG("Get new streams received");
1132
80e8027a
JD
1133 health_code_update();
1134
2f8f53af 1135 /* Receive the request from the connected client. */
58eb9381 1136 ret = recv_request(conn->sock, &request, sizeof(request));
2f8f53af 1137 if (ret < 0) {
80e8027a
JD
1138 goto error;
1139 }
6763619c 1140 session_id = be64toh(request.session_id);
80e8027a
JD
1141
1142 health_code_update();
1143
53efb85a
MD
1144 memset(&response, 0, sizeof(response));
1145
7591bab1 1146 session = session_get_by_id(session_id);
2f8f53af 1147 if (!session) {
6763619c 1148 DBG("Relay session %" PRIu64 " not found", session_id);
c4e361a4 1149 response.status = htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR);
80e8027a
JD
1150 goto send_reply;
1151 }
1152
7591bab1 1153 if (!viewer_session_is_attached(conn->viewer_session, session)) {
c4e361a4 1154 response.status = htobe32(LTTNG_VIEWER_NEW_STREAMS_ERR);
80e8027a
JD
1155 goto send_reply;
1156 }
1157
36c20907
JR
1158 /*
1159 * For any new stream, create it with LTTNG_VIEWER_SEEK_BEGINNING since
1160 * that at this point the client is already attached to the session.Aany
1161 * initial stream will have been created with the seek type at attach
1162 * time (for now most readers use the LTTNG_VIEWER_SEEK_LAST on attach).
1163 * Otherwise any event happening in a new stream between the attach and
1164 * a call to viewer_get_new_streams will be "lost" (never received) from
1165 * the viewer's point of view.
1166 */
c06fdd95 1167 pthread_mutex_lock(&session->lock);
8433d916
MD
1168 /*
1169 * If a session rotation is ongoing, do not attempt to open any
1170 * stream, because the chunk can be in an intermediate state
1171 * due to directory renaming.
1172 */
1173 if (session->ongoing_rotation) {
1174 DBG("Relay session %" PRIu64 " rotation ongoing", session_id);
1175 response.status = htobe32(LTTNG_VIEWER_NEW_STREAMS_NO_NEW);
1176 goto send_reply_unlock;
1177 }
b66a15d1 1178 ret = make_viewer_streams(session,
9edaf114 1179 conn->viewer_session,
36c20907 1180 LTTNG_VIEWER_SEEK_BEGINNING, &nb_total, &nb_unsent,
bddf80e4 1181 &nb_created, &closed);
2f8f53af 1182 if (ret < 0) {
b66a15d1 1183 goto error_unlock_session;
2f8f53af 1184 }
3d0bbd40
JG
1185 send_streams = 1;
1186 response.status = htobe32(LTTNG_VIEWER_NEW_STREAMS_OK);
b66a15d1 1187
2f8f53af
DG
1188 /* Only send back the newly created streams with the unsent ones. */
1189 nb_streams = nb_created + nb_unsent;
80e8027a
JD
1190 response.streams_count = htobe32(nb_streams);
1191
4479f682 1192 /*
2229a09c
MD
1193 * If the session is closed, HUP when there are no more streams
1194 * with data.
4479f682 1195 */
bddf80e4 1196 if (closed && nb_total == 0) {
4479f682 1197 send_streams = 0;
bddf80e4 1198 response.streams_count = 0;
4479f682 1199 response.status = htobe32(LTTNG_VIEWER_NEW_STREAMS_HUP);
3d0bbd40 1200 goto send_reply_unlock;
4479f682 1201 }
3d0bbd40
JG
1202send_reply_unlock:
1203 pthread_mutex_unlock(&session->lock);
4479f682 1204
80e8027a
JD
1205send_reply:
1206 health_code_update();
58eb9381 1207 ret = send_response(conn->sock, &response, sizeof(response));
80e8027a 1208 if (ret < 0) {
7591bab1 1209 goto end_put_session;
80e8027a
JD
1210 }
1211 health_code_update();
1212
1213 /*
7591bab1
MD
1214 * Unknown or empty session, just return gracefully, the viewer
1215 * knows what is happening.
80e8027a
JD
1216 */
1217 if (!send_streams || !nb_streams) {
1218 ret = 0;
7591bab1 1219 goto end_put_session;
80e8027a
JD
1220 }
1221
2f8f53af 1222 /*
7591bab1
MD
1223 * Send stream and *DON'T* ignore the sent flag so every viewer
1224 * streams that were not sent from that point will be sent to
1225 * the viewer.
2f8f53af 1226 */
c06fdd95 1227 ret = send_viewer_streams(conn->sock, session_id, 0);
2f8f53af 1228 if (ret < 0) {
7591bab1 1229 goto end_put_session;
80e8027a
JD
1230 }
1231
7591bab1
MD
1232end_put_session:
1233 if (session) {
1234 session_put(session);
1235 }
80e8027a
JD
1236error:
1237 return ret;
b66a15d1
JG
1238error_unlock_session:
1239 pthread_mutex_unlock(&session->lock);
1240 session_put(session);
1241 return ret;
80e8027a
JD
1242}
1243
d3e2ba59
JD
1244/*
1245 * Send the viewer the list of current sessions.
1246 */
1247static
58eb9381 1248int viewer_attach_session(struct relay_connection *conn)
d3e2ba59 1249{
2f8f53af
DG
1250 int send_streams = 0;
1251 ssize_t ret;
80e8027a 1252 uint32_t nb_streams = 0;
2f8f53af 1253 enum lttng_viewer_seek seek_type;
d3e2ba59
JD
1254 struct lttng_viewer_attach_session_request request;
1255 struct lttng_viewer_attach_session_response response;
7591bab1 1256 struct relay_session *session = NULL;
dbd6665b 1257 enum lttng_viewer_attach_return_code viewer_attach_status;
bddf80e4 1258 bool closed = false;
c06fdd95 1259 uint64_t session_id;
d3e2ba59 1260
58eb9381 1261 assert(conn);
d3e2ba59 1262
eea7556c
MD
1263 health_code_update();
1264
2f8f53af 1265 /* Receive the request from the connected client. */
58eb9381 1266 ret = recv_request(conn->sock, &request, sizeof(request));
2f8f53af 1267 if (ret < 0) {
d3e2ba59
JD
1268 goto error;
1269 }
1270
c06fdd95 1271 session_id = be64toh(request.session_id);
eea7556c
MD
1272 health_code_update();
1273
53efb85a
MD
1274 memset(&response, 0, sizeof(response));
1275
c3b7390b
JD
1276 if (!conn->viewer_session) {
1277 DBG("Client trying to attach before creating a live viewer session");
1278 response.status = htobe32(LTTNG_VIEWER_ATTACH_NO_SESSION);
1279 goto send_reply;
1280 }
1281
c06fdd95 1282 session = session_get_by_id(session_id);
2f8f53af 1283 if (!session) {
c06fdd95 1284 DBG("Relay session %" PRIu64 " not found", session_id);
c4e361a4 1285 response.status = htobe32(LTTNG_VIEWER_ATTACH_UNK);
d3e2ba59
JD
1286 goto send_reply;
1287 }
c06fdd95 1288 DBG("Attach session ID %" PRIu64 " received", session_id);
d3e2ba59 1289
c06fdd95 1290 pthread_mutex_lock(&session->lock);
7591bab1 1291 if (session->live_timer == 0) {
d3e2ba59 1292 DBG("Not live session");
c4e361a4 1293 response.status = htobe32(LTTNG_VIEWER_ATTACH_NOT_LIVE);
d3e2ba59 1294 goto send_reply;
7591bab1
MD
1295 }
1296
1297 send_streams = 1;
dbd6665b
JG
1298 viewer_attach_status = viewer_session_attach(conn->viewer_session,
1299 session);
1300 if (viewer_attach_status != LTTNG_VIEWER_ATTACH_OK) {
1301 response.status = htobe32(viewer_attach_status);
7591bab1 1302 goto send_reply;
d3e2ba59
JD
1303 }
1304
1305 switch (be32toh(request.seek)) {
c4e361a4
JD
1306 case LTTNG_VIEWER_SEEK_BEGINNING:
1307 case LTTNG_VIEWER_SEEK_LAST:
7591bab1 1308 response.status = htobe32(LTTNG_VIEWER_ATTACH_OK);
2f8f53af 1309 seek_type = be32toh(request.seek);
d3e2ba59
JD
1310 break;
1311 default:
1312 ERR("Wrong seek parameter");
c4e361a4 1313 response.status = htobe32(LTTNG_VIEWER_ATTACH_SEEK_ERR);
d3e2ba59
JD
1314 send_streams = 0;
1315 goto send_reply;
1316 }
1317
8433d916
MD
1318 /*
1319 * If a session rotation is ongoing, do not attempt to open any
1320 * stream, because the chunk can be in an intermediate state
1321 * due to directory renaming.
1322 */
1323 if (session->ongoing_rotation) {
1324 DBG("Relay session %" PRIu64 " rotation ongoing", session_id);
1325 send_streams = 0;
1326 goto send_reply;
1327 }
1328
b66a15d1 1329 ret = make_viewer_streams(session,
9edaf114 1330 conn->viewer_session, seek_type,
b66a15d1 1331 &nb_streams, NULL, NULL, &closed);
2f8f53af 1332 if (ret < 0) {
7591bab1 1333 goto end_put_session;
d3e2ba59 1334 }
c06fdd95
JG
1335 pthread_mutex_unlock(&session->lock);
1336 session_put(session);
1337 session = NULL;
1338
1339 response.streams_count = htobe32(nb_streams);
bddf80e4
MD
1340 /*
1341 * If the session is closed when the viewer is attaching, it
1342 * means some of the streams may have been concurrently removed,
1343 * so we don't allow the viewer to attach, even if there are
1344 * streams available.
1345 */
1346 if (closed) {
1347 send_streams = 0;
1348 response.streams_count = 0;
06079f15 1349 response.status = htobe32(LTTNG_VIEWER_ATTACH_UNK);
bddf80e4
MD
1350 goto send_reply;
1351 }
1352
d3e2ba59 1353send_reply:
eea7556c 1354 health_code_update();
58eb9381 1355 ret = send_response(conn->sock, &response, sizeof(response));
d3e2ba59 1356 if (ret < 0) {
7591bab1 1357 goto end_put_session;
d3e2ba59 1358 }
eea7556c 1359 health_code_update();
d3e2ba59
JD
1360
1361 /*
7591bab1
MD
1362 * Unknown or empty session, just return gracefully, the viewer
1363 * knows what is happening.
d3e2ba59 1364 */
157df586 1365 if (!send_streams || !nb_streams) {
d3e2ba59 1366 ret = 0;
7591bab1 1367 goto end_put_session;
d3e2ba59
JD
1368 }
1369
2f8f53af 1370 /* Send stream and ignore the sent flag. */
c06fdd95 1371 ret = send_viewer_streams(conn->sock, session_id, 1);
2f8f53af 1372 if (ret < 0) {
7591bab1 1373 goto end_put_session;
d3e2ba59 1374 }
d3e2ba59 1375
7591bab1
MD
1376end_put_session:
1377 if (session) {
c06fdd95 1378 pthread_mutex_unlock(&session->lock);
7591bab1
MD
1379 session_put(session);
1380 }
4a9daf17
JD
1381error:
1382 return ret;
1383}
1384
878c34cf
DG
1385/*
1386 * Open the index file if needed for the given vstream.
1387 *
f8f3885c
MD
1388 * If an index file is successfully opened, the vstream will set it as its
1389 * current index file.
878c34cf
DG
1390 *
1391 * Return 0 on success, a negative value on error (-ENOENT if not ready yet).
7591bab1
MD
1392 *
1393 * Called with rstream lock held.
878c34cf
DG
1394 */
1395static int try_open_index(struct relay_viewer_stream *vstream,
1396 struct relay_stream *rstream)
1397{
1398 int ret = 0;
ebb29c10
JG
1399 const uint32_t connection_major = rstream->trace->session->major;
1400 const uint32_t connection_minor = rstream->trace->session->minor;
3ff5c5db 1401 enum lttng_trace_chunk_status chunk_status;
878c34cf 1402
f8f3885c 1403 if (vstream->index_file) {
878c34cf
DG
1404 goto end;
1405 }
1406
1407 /*
7591bab1 1408 * First time, we open the index file and at least one index is ready.
878c34cf 1409 */
80516611
JG
1410 if (rstream->index_received_seqcount == 0 ||
1411 !vstream->stream_file.trace_chunk) {
878c34cf
DG
1412 ret = -ENOENT;
1413 goto end;
1414 }
80516611 1415
3ff5c5db 1416 chunk_status = lttng_index_file_create_from_trace_chunk_read_only(
b66a15d1 1417 vstream->stream_file.trace_chunk, rstream->path_name,
ebb29c10
JG
1418 rstream->channel_name, rstream->tracefile_size,
1419 vstream->current_tracefile_id,
1420 lttng_to_index_major(connection_major, connection_minor),
3ff5c5db
MD
1421 lttng_to_index_minor(connection_major, connection_minor),
1422 true, &vstream->index_file);
1423 if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) {
1424 if (chunk_status == LTTNG_TRACE_CHUNK_STATUS_NO_FILE) {
1425 ret = -ENOENT;
1426 } else {
1427 ret = -1;
1428 }
878c34cf
DG
1429 }
1430
1431end:
1432 return ret;
1433}
1434
1435/*
7591bab1
MD
1436 * Check the status of the index for the given stream. This function
1437 * updates the index structure if needed and can put (close) the vstream
1438 * in the HUP situation.
1439 *
1440 * Return 0 means that we can proceed with the index. A value of 1 means
1441 * that the index has been updated and is ready to be sent to the
1442 * client. A negative value indicates an error that can't be handled.
878c34cf 1443 *
7591bab1 1444 * Called with rstream lock held.
878c34cf
DG
1445 */
1446static int check_index_status(struct relay_viewer_stream *vstream,
1447 struct relay_stream *rstream, struct ctf_trace *trace,
1448 struct lttng_viewer_index *index)
1449{
1450 int ret;
1451
68c40154
MD
1452 DBG("Check index status: index_received_seqcount %" PRIu64 " "
1453 "index_sent_seqcount %" PRIu64 " "
1454 "for stream %" PRIu64,
1455 rstream->index_received_seqcount,
1456 vstream->index_sent_seqcount,
1457 vstream->stream->stream_handle);
797bc362 1458 if ((trace->session->connection_closed || rstream->closed)
a44ca2ca
MD
1459 && rstream->index_received_seqcount
1460 == vstream->index_sent_seqcount) {
797bc362
MD
1461 /*
1462 * Last index sent and session connection or relay
1463 * stream are closed.
1464 */
7591bab1
MD
1465 index->status = htobe32(LTTNG_VIEWER_INDEX_HUP);
1466 goto hup;
1467 } else if (rstream->beacon_ts_end != -1ULL &&
b0d240a2
MD
1468 (rstream->index_received_seqcount == 0 ||
1469 (vstream->index_sent_seqcount != 0 &&
a44ca2ca 1470 rstream->index_received_seqcount
b0d240a2 1471 <= vstream->index_sent_seqcount))) {
7591bab1
MD
1472 /*
1473 * We've received a synchronization beacon and the last index
1474 * available has been sent, the index for now is inactive.
1475 *
1476 * In this case, we have received a beacon which allows us to
1477 * inform the client of a time interval during which we can
1478 * guarantee that there are no events to read (and never will
1479 * be).
b0d240a2
MD
1480 *
1481 * The sent seqcount can grow higher than receive seqcount on
1482 * clear because the rotation performed by clear will push
1483 * the index_sent_seqcount ahead (see
1484 * viewer_stream_sync_tracefile_array_tail) and skip over
1485 * packet sequence numbers.
7591bab1
MD
1486 */
1487 index->status = htobe32(LTTNG_VIEWER_INDEX_INACTIVE);
1488 index->timestamp_end = htobe64(rstream->beacon_ts_end);
1489 index->stream_id = htobe64(rstream->ctf_stream_id);
68c40154
MD
1490 DBG("Check index status: inactive with beacon, for stream %" PRIu64,
1491 vstream->stream->stream_handle);
7591bab1 1492 goto index_ready;
b0d240a2
MD
1493 } else if (rstream->index_received_seqcount == 0 ||
1494 (vstream->index_sent_seqcount != 0 &&
1495 rstream->index_received_seqcount
1496 <= vstream->index_sent_seqcount)) {
7591bab1 1497 /*
b0d240a2 1498 * This checks whether received <= sent seqcount. In
a44ca2ca
MD
1499 * this case, we have not received a beacon. Therefore,
1500 * we can only ask the client to retry later.
b0d240a2
MD
1501 *
1502 * The sent seqcount can grow higher than receive seqcount on
1503 * clear because the rotation performed by clear will push
1504 * the index_sent_seqcount ahead (see
1505 * viewer_stream_sync_tracefile_array_tail) and skip over
1506 * packet sequence numbers.
7591bab1
MD
1507 */
1508 index->status = htobe32(LTTNG_VIEWER_INDEX_RETRY);
68c40154
MD
1509 DBG("Check index status: retry for stream %" PRIu64,
1510 vstream->stream->stream_handle);
7591bab1 1511 goto index_ready;
a44ca2ca
MD
1512 } else if (!tracefile_array_seq_in_file(rstream->tfa,
1513 vstream->current_tracefile_id,
1514 vstream->index_sent_seqcount)) {
7591bab1 1515 /*
a44ca2ca
MD
1516 * The next index we want to send cannot be read either
1517 * because we need to perform a rotation, or due to
1518 * the producer having overwritten its trace file.
7591bab1 1519 */
a44ca2ca 1520 DBG("Viewer stream %" PRIu64 " rotation",
7591bab1
MD
1521 vstream->stream->stream_handle);
1522 ret = viewer_stream_rotate(vstream);
b0d240a2 1523 if (ret == 1) {
7591bab1
MD
1524 /* EOF across entire stream. */
1525 index->status = htobe32(LTTNG_VIEWER_INDEX_HUP);
1526 goto hup;
1527 }
7591bab1 1528 /*
a44ca2ca
MD
1529 * If we have been pushed due to overwrite, it
1530 * necessarily means there is data that can be read in
1531 * the stream. If we rotated because we reached the end
1532 * of a tracefile, it means the following tracefile
1533 * needs to contain at least one index, else we would
1534 * have already returned LTTNG_VIEWER_INDEX_RETRY to the
1535 * viewer. The updated index_sent_seqcount needs to
1536 * point to a readable index entry now.
1537 *
1538 * In the case where we "rotate" on a single file, we
1539 * can end up in a case where the requested index is
1540 * still unavailable.
7591bab1 1541 */
a44ca2ca
MD
1542 if (rstream->tracefile_count == 1 &&
1543 !tracefile_array_seq_in_file(
1544 rstream->tfa,
1545 vstream->current_tracefile_id,
1546 vstream->index_sent_seqcount)) {
1547 index->status = htobe32(LTTNG_VIEWER_INDEX_RETRY);
68c40154
MD
1548 DBG("Check index status: retry: "
1549 "tracefile array sequence number %" PRIu64
1550 " not in file for stream %" PRIu64,
1551 vstream->index_sent_seqcount,
1552 vstream->stream->stream_handle);
a44ca2ca 1553 goto index_ready;
878c34cf 1554 }
a44ca2ca
MD
1555 assert(tracefile_array_seq_in_file(rstream->tfa,
1556 vstream->current_tracefile_id,
1557 vstream->index_sent_seqcount));
878c34cf 1558 }
a44ca2ca
MD
1559 /* ret == 0 means successful so we continue. */
1560 ret = 0;
878c34cf
DG
1561 return ret;
1562
1563hup:
7591bab1 1564 viewer_stream_put(vstream);
878c34cf
DG
1565index_ready:
1566 return 1;
1567}
1568
80516611
JG
1569static
1570void viewer_stream_rotate_to_trace_chunk(struct relay_viewer_stream *vstream,
1571 struct lttng_trace_chunk *new_trace_chunk)
1572{
1573 lttng_trace_chunk_put(vstream->stream_file.trace_chunk);
1574
1575 if (new_trace_chunk) {
1576 const bool acquired_reference = lttng_trace_chunk_get(
1577 new_trace_chunk);
1578
1579 assert(acquired_reference);
1580 }
1581
1582 vstream->stream_file.trace_chunk = new_trace_chunk;
1583 viewer_stream_sync_tracefile_array_tail(vstream);
1584 viewer_stream_close_files(vstream);
1585}
1586
d3e2ba59
JD
1587/*
1588 * Send the next index for a stream.
1589 *
1590 * Return 0 on success or else a negative value.
1591 */
1592static
58eb9381 1593int viewer_get_next_index(struct relay_connection *conn)
d3e2ba59
JD
1594{
1595 int ret;
1596 struct lttng_viewer_get_next_index request_index;
1597 struct lttng_viewer_index viewer_index;
50adc264 1598 struct ctf_packet_index packet_index;
7591bab1
MD
1599 struct relay_viewer_stream *vstream = NULL;
1600 struct relay_stream *rstream = NULL;
1601 struct ctf_trace *ctf_trace = NULL;
1602 struct relay_viewer_stream *metadata_viewer_stream = NULL;
d3e2ba59 1603
58eb9381 1604 assert(conn);
d3e2ba59
JD
1605
1606 DBG("Viewer get next index");
1607
7591bab1 1608 memset(&viewer_index, 0, sizeof(viewer_index));
eea7556c 1609 health_code_update();
2f8f53af 1610
58eb9381 1611 ret = recv_request(conn->sock, &request_index, sizeof(request_index));
2f8f53af 1612 if (ret < 0) {
d3e2ba59
JD
1613 goto end;
1614 }
eea7556c 1615 health_code_update();
d3e2ba59 1616
7591bab1 1617 vstream = viewer_stream_get_by_id(be64toh(request_index.stream_id));
6763619c 1618 if (!vstream) {
a44ca2ca 1619 DBG("Client requested index of unknown stream id %" PRIu64,
9b9f9f94 1620 (uint64_t) be64toh(request_index.stream_id));
f1883937
MD
1621 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_ERR);
1622 goto send_reply;
2a174661
DG
1623 }
1624
7591bab1
MD
1625 /* Use back. ref. Protected by refcounts. */
1626 rstream = vstream->stream;
1627 ctf_trace = rstream->trace;
d3e2ba59 1628
7591bab1
MD
1629 /* metadata_viewer_stream may be NULL. */
1630 metadata_viewer_stream =
1631 ctf_trace_get_viewer_metadata_stream(ctf_trace);
2a174661 1632
7591bab1 1633 pthread_mutex_lock(&rstream->lock);
d3e2ba59
JD
1634
1635 /*
1636 * The viewer should not ask for index on metadata stream.
1637 */
7591bab1 1638 if (rstream->is_metadata) {
c4e361a4 1639 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_HUP);
d3e2ba59
JD
1640 goto send_reply;
1641 }
1642
b0d240a2
MD
1643 if (rstream->ongoing_rotation.is_set) {
1644 /* Rotation is ongoing, try again later. */
1645 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_RETRY);
1646 goto send_reply;
1647 }
1648
1649 if (rstream->trace->session->ongoing_rotation) {
1650 /* Rotation is ongoing, try again later. */
1651 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_RETRY);
1652 goto send_reply;
1653 }
1654
80516611
JG
1655 /*
1656 * Transition the viewer session into the newest trace chunk available.
1657 */
1658 if (!lttng_trace_chunk_ids_equal(
ad8bec24
JG
1659 conn->viewer_session->current_trace_chunk,
1660 rstream->trace_chunk)) {
9a9c8637 1661 DBG("Relay stream and viewer chunk ids differ");
b0d240a2 1662
ad8bec24
JG
1663 ret = viewer_session_set_trace_chunk_copy(
1664 conn->viewer_session,
1665 rstream->trace_chunk);
1666 if (ret) {
b0d240a2
MD
1667 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_ERR);
1668 goto send_reply;
1669 }
b0d240a2 1670 }
b0d240a2 1671
80516611
JG
1672 /*
1673 * Transition the viewer stream into the latest trace chunk available.
1674 *
1675 * Note that the stream must _not_ rotate in one precise condition:
1676 * the relay stream has rotated to a NULL trace chunk and the viewer
1677 * stream is consuming the trace chunk that was active just before
1678 * that rotation to NULL.
1679 *
1680 * This allows clients to consume all the packets of a trace chunk
1681 * after a session's destruction.
1682 */
17cb7bac 1683 if (!lttng_trace_chunk_ids_equal(conn->viewer_session->current_trace_chunk, vstream->stream_file.trace_chunk) &&
80516611 1684 !(rstream->completed_rotation_count == vstream->last_seen_rotation_count + 1 && !rstream->trace_chunk)) {
17cb7bac 1685 DBG("Viewer session and viewer stream chunk IDs differ: "
b0d240a2
MD
1686 "vsession chunk %p vstream chunk %p",
1687 conn->viewer_session->current_trace_chunk,
1688 vstream->stream_file.trace_chunk);
80516611
JG
1689 viewer_stream_rotate_to_trace_chunk(vstream,
1690 conn->viewer_session->current_trace_chunk);
1691 vstream->last_seen_rotation_count =
1692 rstream->completed_rotation_count;
d3e2ba59
JD
1693 }
1694
878c34cf 1695 ret = check_index_status(vstream, rstream, ctf_trace, &viewer_index);
878c34cf 1696 if (ret < 0) {
7591bab1 1697 goto error_put;
878c34cf
DG
1698 } else if (ret == 1) {
1699 /*
7591bab1
MD
1700 * We have no index to send and check_index_status has populated
1701 * viewer_index's status.
878c34cf 1702 */
d3e2ba59
JD
1703 goto send_reply;
1704 }
7591bab1 1705 /* At this point, ret is 0 thus we will be able to read the index. */
878c34cf 1706 assert(!ret);
d3e2ba59 1707
b0d240a2
MD
1708 /* Try to open an index if one is needed for that stream. */
1709 ret = try_open_index(vstream, rstream);
1710 if (ret == -ENOENT) {
1711 if (rstream->closed) {
1712 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_HUP);
1713 goto send_reply;
1714 } else {
1715 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_RETRY);
1716 goto send_reply;
1717 }
1718 }
1719 if (ret < 0) {
1720 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_ERR);
1721 goto send_reply;
1722 }
1723
7591bab1
MD
1724 /*
1725 * vstream->stream_fd may be NULL if it has been closed by
1726 * tracefile rotation, or if we are at the beginning of the
1727 * stream. We open the data stream file here to protect against
1728 * overwrite caused by tracefile rotation (in association with
1729 * unlink performed before overwrite).
1730 */
8bb66c3c 1731 if (!vstream->stream_file.handle) {
ebb29c10
JG
1732 char file_path[LTTNG_PATH_MAX];
1733 enum lttng_trace_chunk_status status;
8bb66c3c 1734 struct fs_handle *fs_handle;
ebb29c10
JG
1735
1736 ret = utils_stream_file_path(rstream->path_name,
1737 rstream->channel_name, rstream->tracefile_size,
1738 vstream->current_tracefile_id, NULL, file_path,
1739 sizeof(file_path));
7591bab1
MD
1740 if (ret < 0) {
1741 goto error_put;
1742 }
ebb29c10 1743
3ff5c5db
MD
1744 /*
1745 * It is possible the the file we are trying to open is
1746 * missing if the stream has been closed (application exits with
1747 * per-pid buffers) and a clear command has been performed.
1748 */
8bb66c3c 1749 status = lttng_trace_chunk_open_fs_handle(
ebb29c10 1750 vstream->stream_file.trace_chunk,
8bb66c3c 1751 file_path, O_RDONLY, 0, &fs_handle, true);
ebb29c10 1752 if (status != LTTNG_TRACE_CHUNK_STATUS_OK) {
b0d240a2
MD
1753 if (status == LTTNG_TRACE_CHUNK_STATUS_NO_FILE &&
1754 rstream->closed) {
1755 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_HUP);
1756 goto send_reply;
1757 }
ebb29c10 1758 PERROR("Failed to open trace file for viewer stream");
7591bab1
MD
1759 goto error_put;
1760 }
8bb66c3c 1761 vstream->stream_file.handle = fs_handle;
d3e2ba59
JD
1762 }
1763
f04a971b 1764 ret = check_new_streams(conn);
4a9daf17 1765 if (ret < 0) {
7591bab1
MD
1766 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_ERR);
1767 goto send_reply;
4a9daf17
JD
1768 } else if (ret == 1) {
1769 viewer_index.flags |= LTTNG_VIEWER_FLAG_NEW_STREAM;
1770 }
1771
f8f3885c
MD
1772 ret = lttng_index_file_read(vstream->index_file, &packet_index);
1773 if (ret) {
8bb66c3c 1774 ERR("Relay error reading index file");
7591bab1 1775 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_ERR);
6b6b9a5a 1776 goto send_reply;
d3e2ba59 1777 } else {
c4e361a4 1778 viewer_index.status = htobe32(LTTNG_VIEWER_INDEX_OK);
a44ca2ca 1779 vstream->index_sent_seqcount++;
d3e2ba59
JD
1780 }
1781
1782 /*
1783 * Indexes are stored in big endian, no need to switch before sending.
1784 */
7591bab1
MD
1785 DBG("Sending viewer index for stream %" PRIu64 " offset %" PRIu64,
1786 rstream->stream_handle,
9b9f9f94 1787 (uint64_t) be64toh(packet_index.offset));
d3e2ba59
JD
1788 viewer_index.offset = packet_index.offset;
1789 viewer_index.packet_size = packet_index.packet_size;
1790 viewer_index.content_size = packet_index.content_size;
1791 viewer_index.timestamp_begin = packet_index.timestamp_begin;
1792 viewer_index.timestamp_end = packet_index.timestamp_end;
1793 viewer_index.events_discarded = packet_index.events_discarded;
1794 viewer_index.stream_id = packet_index.stream_id;
1795
1796send_reply:
f1883937
MD
1797 if (rstream) {
1798 pthread_mutex_unlock(&rstream->lock);
1799 }
7591bab1
MD
1800
1801 if (metadata_viewer_stream) {
1802 pthread_mutex_lock(&metadata_viewer_stream->stream->lock);
1803 DBG("get next index metadata check: recv %" PRIu64
1804 " sent %" PRIu64,
1805 metadata_viewer_stream->stream->metadata_received,
1806 metadata_viewer_stream->metadata_sent);
1807 if (!metadata_viewer_stream->stream->metadata_received ||
1808 metadata_viewer_stream->stream->metadata_received >
1809 metadata_viewer_stream->metadata_sent) {
1810 viewer_index.flags |= LTTNG_VIEWER_FLAG_NEW_METADATA;
1811 }
1812 pthread_mutex_unlock(&metadata_viewer_stream->stream->lock);
1813 }
1814
d3e2ba59 1815 viewer_index.flags = htobe32(viewer_index.flags);
eea7556c 1816 health_code_update();
2f8f53af 1817
58eb9381 1818 ret = send_response(conn->sock, &viewer_index, sizeof(viewer_index));
d3e2ba59 1819 if (ret < 0) {
7591bab1 1820 goto end;
d3e2ba59 1821 }
eea7556c 1822 health_code_update();
d3e2ba59 1823
9237e6a1
MD
1824 if (vstream) {
1825 DBG("Index %" PRIu64 " for stream %" PRIu64 " sent",
a44ca2ca 1826 vstream->index_sent_seqcount,
9237e6a1
MD
1827 vstream->stream->stream_handle);
1828 }
d3e2ba59 1829end:
7591bab1
MD
1830 if (metadata_viewer_stream) {
1831 viewer_stream_put(metadata_viewer_stream);
1832 }
1833 if (vstream) {
1834 viewer_stream_put(vstream);
1835 }
1836 return ret;
1837
1838error_put:
1839 pthread_mutex_unlock(&rstream->lock);
1840 if (metadata_viewer_stream) {
1841 viewer_stream_put(metadata_viewer_stream);
1842 }
1843 viewer_stream_put(vstream);
d3e2ba59
JD
1844 return ret;
1845}
1846
1847/*
1848 * Send the next index for a stream
1849 *
1850 * Return 0 on success or else a negative value.
1851 */
1852static
58eb9381 1853int viewer_get_packet(struct relay_connection *conn)
d3e2ba59 1854{
b6025e94 1855 int ret;
a5df8828 1856 off_t lseek_ret;
553b2adb 1857 char *reply = NULL;
d3e2ba59 1858 struct lttng_viewer_get_packet get_packet_info;
553b2adb 1859 struct lttng_viewer_trace_packet reply_header;
7591bab1 1860 struct relay_viewer_stream *vstream = NULL;
553b2adb 1861 uint32_t reply_size = sizeof(reply_header);
b6025e94
JR
1862 uint32_t packet_data_len = 0;
1863 ssize_t read_len;
8bb66c3c 1864 uint64_t stream_id;
d3e2ba59
JD
1865
1866 DBG2("Relay get data packet");
1867
eea7556c 1868 health_code_update();
2f8f53af 1869
7591bab1
MD
1870 ret = recv_request(conn->sock, &get_packet_info,
1871 sizeof(get_packet_info));
2f8f53af 1872 if (ret < 0) {
d3e2ba59
JD
1873 goto end;
1874 }
eea7556c 1875 health_code_update();
d3e2ba59 1876
0233a6a5 1877 /* From this point on, the error label can be reached. */
553b2adb 1878 memset(&reply_header, 0, sizeof(reply_header));
8bb66c3c 1879 stream_id = (uint64_t) be64toh(get_packet_info.stream_id);
0233a6a5 1880
8bb66c3c 1881 vstream = viewer_stream_get_by_id(stream_id);
7591bab1 1882 if (!vstream) {
a44ca2ca 1883 DBG("Client requested packet of unknown stream id %" PRIu64,
8bb66c3c 1884 stream_id);
553b2adb
JG
1885 reply_header.status = htobe32(LTTNG_VIEWER_GET_PACKET_ERR);
1886 goto send_reply_nolock;
b6025e94
JR
1887 } else {
1888 packet_data_len = be32toh(get_packet_info.len);
553b2adb 1889 reply_size += packet_data_len;
d3e2ba59 1890 }
2a174661 1891
553b2adb
JG
1892 reply = zmalloc(reply_size);
1893 if (!reply) {
1894 PERROR("packet reply zmalloc");
1895 reply_size = sizeof(reply_header);
d3e2ba59
JD
1896 goto error;
1897 }
1898
b6025e94 1899 pthread_mutex_lock(&vstream->stream->lock);
8bb66c3c 1900 lseek_ret = fs_handle_seek(vstream->stream_file.handle,
ebb29c10 1901 be64toh(get_packet_info.offset), SEEK_SET);
a5df8828 1902 if (lseek_ret < 0) {
8bb66c3c
JG
1903 PERROR("Failed to seek file system handle of viewer stream %" PRIu64
1904 " to offset %" PRIu64,
1905 stream_id,
ebb29c10 1906 (uint64_t) be64toh(get_packet_info.offset));
7591bab1 1907 goto error;
d3e2ba59 1908 }
8bb66c3c 1909 read_len = fs_handle_read(vstream->stream_file.handle,
ebb29c10 1910 reply + sizeof(reply_header), packet_data_len);
b6025e94 1911 if (read_len < packet_data_len) {
8bb66c3c
JG
1912 PERROR("Failed to read from file system handle of viewer stream id %" PRIu64
1913 ", offset: %" PRIu64,
1914 stream_id,
9b9f9f94 1915 (uint64_t) be64toh(get_packet_info.offset));
7591bab1 1916 goto error;
d3e2ba59 1917 }
553b2adb
JG
1918 reply_header.status = htobe32(LTTNG_VIEWER_GET_PACKET_OK);
1919 reply_header.len = htobe32(packet_data_len);
d3e2ba59
JD
1920 goto send_reply;
1921
1922error:
f28ecb10
JG
1923 /* No payload to send on error. */
1924 reply_size = sizeof(reply_header);
553b2adb 1925 reply_header.status = htobe32(LTTNG_VIEWER_GET_PACKET_ERR);
d3e2ba59
JD
1926
1927send_reply:
7591bab1
MD
1928 if (vstream) {
1929 pthread_mutex_unlock(&vstream->stream->lock);
1930 }
1931send_reply_nolock:
eea7556c
MD
1932
1933 health_code_update();
2f8f53af 1934
553b2adb
JG
1935 if (reply) {
1936 memcpy(reply, &reply_header, sizeof(reply_header));
1937 ret = send_response(conn->sock, reply, reply_size);
1938 } else {
1939 /* No reply to send. */
1940 ret = send_response(conn->sock, &reply_header,
1941 reply_size);
1942 }
1943
b6025e94 1944 health_code_update();
d3e2ba59 1945 if (ret < 0) {
b6025e94 1946 PERROR("sendmsg of packet data failed");
7591bab1 1947 goto end_free;
d3e2ba59 1948 }
d3e2ba59 1949
8bb66c3c 1950 DBG("Sent %u bytes for stream %" PRIu64, reply_size, stream_id);
d3e2ba59 1951
7591bab1 1952end_free:
553b2adb 1953 free(reply);
d3e2ba59 1954end:
7591bab1
MD
1955 if (vstream) {
1956 viewer_stream_put(vstream);
1957 }
d3e2ba59
JD
1958 return ret;
1959}
1960
1961/*
1962 * Send the session's metadata
1963 *
1964 * Return 0 on success else a negative value.
1965 */
1966static
58eb9381 1967int viewer_get_metadata(struct relay_connection *conn)
d3e2ba59
JD
1968{
1969 int ret = 0;
8bb66c3c 1970 int fd = -1;
d3e2ba59
JD
1971 ssize_t read_len;
1972 uint64_t len = 0;
1973 char *data = NULL;
1974 struct lttng_viewer_get_metadata request;
1975 struct lttng_viewer_metadata_packet reply;
7591bab1 1976 struct relay_viewer_stream *vstream = NULL;
d3e2ba59 1977
58eb9381 1978 assert(conn);
d3e2ba59
JD
1979
1980 DBG("Relay get metadata");
1981
eea7556c 1982 health_code_update();
2f8f53af 1983
58eb9381 1984 ret = recv_request(conn->sock, &request, sizeof(request));
2f8f53af 1985 if (ret < 0) {
d3e2ba59
JD
1986 goto end;
1987 }
eea7556c 1988 health_code_update();
d3e2ba59 1989
53efb85a
MD
1990 memset(&reply, 0, sizeof(reply));
1991
7591bab1
MD
1992 vstream = viewer_stream_get_by_id(be64toh(request.stream_id));
1993 if (!vstream) {
3b463131
MD
1994 /*
1995 * The metadata stream can be closed by a CLOSE command
1996 * just before we attach. It can also be closed by
1997 * per-pid tracing during tracing. Therefore, it is
1998 * possible that we cannot find this viewer stream.
1999 * Reply back to the client with an error if we cannot
2000 * find it.
2001 */
a44ca2ca 2002 DBG("Client requested metadata of unknown stream id %" PRIu64,
9b9f9f94 2003 (uint64_t) be64toh(request.stream_id));
3b463131 2004 reply.status = htobe32(LTTNG_VIEWER_METADATA_ERR);
7591bab1 2005 goto send_reply;
d3e2ba59 2006 }
7591bab1
MD
2007 pthread_mutex_lock(&vstream->stream->lock);
2008 if (!vstream->stream->is_metadata) {
2009 ERR("Invalid metadata stream");
6763619c
JD
2010 goto error;
2011 }
2012
b0d240a2 2013 if (vstream->metadata_sent >= vstream->stream->metadata_received) {
94f73d08
MD
2014 /*
2015 * The live viewers expect to receive a NO_NEW_METADATA
2016 * status before a stream disappears, otherwise they abort the
2017 * entire live connection when receiving an error status.
b0d240a2
MD
2018 *
2019 * Clear feature resets the metadata_sent to 0 until the
2020 * same metadata is received again.
94f73d08 2021 */
c4e361a4 2022 reply.status = htobe32(LTTNG_VIEWER_NO_NEW_METADATA);
94f73d08
MD
2023 /*
2024 * The live viewer considers a closed 0 byte metadata stream as
2025 * an error.
2026 */
2027 if (vstream->metadata_sent > 0) {
50c089cf 2028 if (vstream->stream->closed && vstream->stream->no_new_metadata_notified) {
94f73d08
MD
2029 /* Release ownership for the viewer metadata stream. */
2030 viewer_stream_put(vstream);
2031 }
50c089cf 2032 vstream->stream->no_new_metadata_notified = true;
94f73d08 2033 }
d3e2ba59
JD
2034 goto send_reply;
2035 }
2036
ad8bec24
JG
2037 if (vstream->stream->trace_chunk &&
2038 !lttng_trace_chunk_ids_equal(
2039 conn->viewer_session->current_trace_chunk,
2040 vstream->stream->trace_chunk)) {
2041 /* A rotation has occurred on the relay stream. */
2042 DBG("Metadata relay stream and viewer chunk ids differ");
2043
2044 ret = viewer_session_set_trace_chunk_copy(
2045 conn->viewer_session,
2046 vstream->stream->trace_chunk);
2047 if (ret) {
2048 reply.status = htobe32(LTTNG_VIEWER_METADATA_ERR);
2049 goto send_reply;
2050 }
2051 }
2052
7a962c33 2053 if (conn->viewer_session->current_trace_chunk &&
17cb7bac
MD
2054 !lttng_trace_chunk_ids_equal(conn->viewer_session->current_trace_chunk,
2055 vstream->stream_file.trace_chunk)) {
ad8bec24
JG
2056 bool acquired_reference;
2057
2058 DBG("Viewer session and viewer stream chunk differ: "
2059 "vsession chunk %p vstream chunk %p",
2060 conn->viewer_session->current_trace_chunk,
2061 vstream->stream_file.trace_chunk);
2062 lttng_trace_chunk_put(vstream->stream_file.trace_chunk);
2063 acquired_reference = lttng_trace_chunk_get(conn->viewer_session->current_trace_chunk);
2064 assert(acquired_reference);
2065 vstream->stream_file.trace_chunk =
2066 conn->viewer_session->current_trace_chunk;
2067 viewer_stream_close_files(vstream);
2068 }
2069
b0d240a2
MD
2070 len = vstream->stream->metadata_received - vstream->metadata_sent;
2071
7a962c33
JG
2072 if (!vstream->stream_file.trace_chunk) {
2073 reply.status = htobe32(LTTNG_VIEWER_NO_NEW_METADATA);
2074 len = 0;
2075 goto send_reply;
2076 } else if (vstream->stream_file.trace_chunk &&
2077 !vstream->stream_file.handle && len > 0) {
2078 /*
2079 * Either this is the first time the metadata file is read, or a
2080 * rotation of the corresponding relay stream has occurred.
2081 */
8bb66c3c 2082 struct fs_handle *fs_handle;
ebb29c10
JG
2083 char file_path[LTTNG_PATH_MAX];
2084 enum lttng_trace_chunk_status status;
2085 struct relay_stream *rstream = vstream->stream;
2086
2087 ret = utils_stream_file_path(rstream->path_name,
2088 rstream->channel_name, rstream->tracefile_size,
2089 vstream->current_tracefile_id, NULL, file_path,
2090 sizeof(file_path));
d3e2ba59
JD
2091 if (ret < 0) {
2092 goto error;
2093 }
ebb29c10 2094
3ff5c5db
MD
2095 /*
2096 * It is possible the the metadata file we are trying to open is
2097 * missing if the stream has been closed (application exits with
2098 * per-pid buffers) and a clear command has been performed.
2099 */
8bb66c3c 2100 status = lttng_trace_chunk_open_fs_handle(
ebb29c10 2101 vstream->stream_file.trace_chunk,
8bb66c3c 2102 file_path, O_RDONLY, 0, &fs_handle, true);
ebb29c10 2103 if (status != LTTNG_TRACE_CHUNK_STATUS_OK) {
b0d240a2
MD
2104 if (status == LTTNG_TRACE_CHUNK_STATUS_NO_FILE) {
2105 reply.status = htobe32(LTTNG_VIEWER_NO_NEW_METADATA);
2106 len = 0;
2107 if (vstream->stream->closed) {
2108 viewer_stream_put(vstream);
2109 }
2110 goto send_reply;
2111 }
ebb29c10 2112 PERROR("Failed to open metadata file for viewer stream");
d3e2ba59
JD
2113 goto error;
2114 }
8bb66c3c 2115 vstream->stream_file.handle = fs_handle;
ad8bec24
JG
2116
2117 if (vstream->metadata_sent != 0) {
2118 /*
2119 * The client does not expect to receive any metadata
2120 * it has received and metadata files in successive
2121 * chunks must be a strict superset of one another.
2122 *
2123 * Skip the first `metadata_sent` bytes to ensure
2124 * they are not sent a second time to the client.
2125 *
2126 * Baring a block layer error or an internal error,
2127 * this seek should not fail as
2128 * `vstream->stream->metadata_received` is reset when
2129 * a relay stream is rotated. If this is reached, it is
2130 * safe to assume that
2131 * `metadata_received` > `metadata_sent`.
2132 */
2133 const off_t seek_ret = fs_handle_seek(fs_handle,
2134 vstream->metadata_sent, SEEK_SET);
2135
2136 if (seek_ret < 0) {
2137 PERROR("Failed to seek metadata viewer stream file to `sent` position: pos = %" PRId64,
2138 vstream->metadata_sent);
2139 reply.status = htobe32(LTTNG_VIEWER_METADATA_ERR);
2140 goto send_reply;
2141 }
2142 }
d3e2ba59
JD
2143 }
2144
2145 reply.len = htobe64(len);
2146 data = zmalloc(len);
2147 if (!data) {
2148 PERROR("viewer metadata zmalloc");
2149 goto error;
2150 }
2151
8bb66c3c
JG
2152 fd = fs_handle_get_fd(vstream->stream_file.handle);
2153 if (fd < 0) {
2154 ERR("Failed to restore viewer stream file system handle");
2155 goto error;
2156 }
2157 read_len = lttng_read(fd, data, len);
2158 fs_handle_put_fd(vstream->stream_file.handle);
2159 fd = -1;
6cd525e8 2160 if (read_len < len) {
ad8bec24
JG
2161 if (read_len < 0) {
2162 PERROR("Failed to read metadata file");
2163 goto error;
2164 } else {
2165 /*
2166 * A clear has been performed which prevents the relay
2167 * from sending `len` bytes of metadata.
2168 *
2169 * It is important not to send any metadata if we
2170 * couldn't read all the available metadata in one shot:
2171 * sending partial metadata can cause the client to
2172 * attempt to parse an incomplete (incoherent) metadata
2173 * stream, which would result in an error.
2174 */
2175 const off_t seek_ret = fs_handle_seek(
2176 vstream->stream_file.handle, -read_len,
2177 SEEK_CUR);
2178
cfa1e2c2 2179 DBG("Failed to read metadata: requested = %" PRIu64 ", got = %zd",
ad8bec24
JG
2180 len, read_len);
2181 read_len = 0;
2182 len = 0;
2183 if (seek_ret < 0) {
2184 PERROR("Failed to restore metadata file position after partial read");
2185 ret = -1;
2186 goto error;
2187 }
2188 }
d3e2ba59 2189 }
7591bab1 2190 vstream->metadata_sent += read_len;
c4e361a4 2191 reply.status = htobe32(LTTNG_VIEWER_METADATA_OK);
7591bab1 2192
d3e2ba59
JD
2193 goto send_reply;
2194
2195error:
c4e361a4 2196 reply.status = htobe32(LTTNG_VIEWER_METADATA_ERR);
d3e2ba59
JD
2197
2198send_reply:
eea7556c 2199 health_code_update();
7591bab1
MD
2200 if (vstream) {
2201 pthread_mutex_unlock(&vstream->stream->lock);
2202 }
58eb9381 2203 ret = send_response(conn->sock, &reply, sizeof(reply));
d3e2ba59 2204 if (ret < 0) {
7591bab1 2205 goto end_free;
d3e2ba59 2206 }
eea7556c 2207 health_code_update();
d3e2ba59
JD
2208
2209 if (len > 0) {
58eb9381 2210 ret = send_response(conn->sock, data, len);
d3e2ba59 2211 if (ret < 0) {
7591bab1 2212 goto end_free;
d3e2ba59
JD
2213 }
2214 }
2215
2216 DBG("Sent %" PRIu64 " bytes of metadata for stream %" PRIu64, len,
9b9f9f94 2217 (uint64_t) be64toh(request.stream_id));
d3e2ba59
JD
2218
2219 DBG("Metadata sent");
2220
7591bab1 2221end_free:
d3e2ba59 2222 free(data);
d3e2ba59 2223end:
7591bab1
MD
2224 if (vstream) {
2225 viewer_stream_put(vstream);
2226 }
d3e2ba59
JD
2227 return ret;
2228}
2229
c3b7390b
JD
2230/*
2231 * Create a viewer session.
2232 *
2233 * Return 0 on success or else a negative value.
2234 */
2235static
2236int viewer_create_session(struct relay_connection *conn)
2237{
2238 int ret;
2239 struct lttng_viewer_create_session_response resp;
2240
2241 DBG("Viewer create session received");
2242
53efb85a 2243 memset(&resp, 0, sizeof(resp));
c3b7390b 2244 resp.status = htobe32(LTTNG_VIEWER_CREATE_SESSION_OK);
7591bab1 2245 conn->viewer_session = viewer_session_create();
c3b7390b
JD
2246 if (!conn->viewer_session) {
2247 ERR("Allocation viewer session");
2248 resp.status = htobe32(LTTNG_VIEWER_CREATE_SESSION_ERR);
2249 goto send_reply;
2250 }
c3b7390b
JD
2251
2252send_reply:
2253 health_code_update();
2254 ret = send_response(conn->sock, &resp, sizeof(resp));
2255 if (ret < 0) {
2256 goto end;
2257 }
2258 health_code_update();
2259 ret = 0;
2260
2261end:
2262 return ret;
2263}
2264
d62023be
JD
2265/*
2266 * Detach a viewer session.
2267 *
2268 * Return 0 on success or else a negative value.
2269 */
2270static
2271int viewer_detach_session(struct relay_connection *conn)
2272{
2273 int ret;
2274 struct lttng_viewer_detach_session_response response;
2275 struct lttng_viewer_detach_session_request request;
2276 struct relay_session *session = NULL;
2277 uint64_t viewer_session_to_close;
2278
2279 DBG("Viewer detach session received");
2280
2281 assert(conn);
2282
2283 health_code_update();
2284
2285 /* Receive the request from the connected client. */
2286 ret = recv_request(conn->sock, &request, sizeof(request));
2287 if (ret < 0) {
2288 goto end;
2289 }
2290 viewer_session_to_close = be64toh(request.session_id);
2291
2292 if (!conn->viewer_session) {
2293 DBG("Client trying to detach before creating a live viewer session");
2294 response.status = htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR);
2295 goto send_reply;
2296 }
2297
2298 health_code_update();
2299
2300 memset(&response, 0, sizeof(response));
2301 DBG("Detaching from session ID %" PRIu64, viewer_session_to_close);
2302
2303 session = session_get_by_id(be64toh(request.session_id));
2304 if (!session) {
2305 DBG("Relay session %" PRIu64 " not found",
9b9f9f94 2306 (uint64_t) be64toh(request.session_id));
d62023be
JD
2307 response.status = htobe32(LTTNG_VIEWER_DETACH_SESSION_UNK);
2308 goto send_reply;
2309 }
2310
2311 ret = viewer_session_is_attached(conn->viewer_session, session);
2312 if (ret != 1) {
2313 DBG("Not attached to this session");
2314 response.status = htobe32(LTTNG_VIEWER_DETACH_SESSION_ERR);
2315 goto send_reply_put;
2316 }
2317
2318 viewer_session_close_one_session(conn->viewer_session, session);
2319 response.status = htobe32(LTTNG_VIEWER_DETACH_SESSION_OK);
2320 DBG("Session %" PRIu64 " detached.", viewer_session_to_close);
2321
2322send_reply_put:
2323 session_put(session);
2324
2325send_reply:
2326 health_code_update();
2327 ret = send_response(conn->sock, &response, sizeof(response));
2328 if (ret < 0) {
2329 goto end;
2330 }
2331 health_code_update();
2332 ret = 0;
2333
2334end:
2335 return ret;
2336}
c3b7390b 2337
d3e2ba59
JD
2338/*
2339 * live_relay_unknown_command: send -1 if received unknown command
2340 */
2341static
58eb9381 2342void live_relay_unknown_command(struct relay_connection *conn)
d3e2ba59
JD
2343{
2344 struct lttcomm_relayd_generic_reply reply;
d3e2ba59 2345
53efb85a 2346 memset(&reply, 0, sizeof(reply));
d3e2ba59 2347 reply.ret_code = htobe32(LTTNG_ERR_UNK);
58eb9381 2348 (void) send_response(conn->sock, &reply, sizeof(reply));
d3e2ba59
JD
2349}
2350
2351/*
2352 * Process the commands received on the control socket
2353 */
2354static
2355int process_control(struct lttng_viewer_cmd *recv_hdr,
58eb9381 2356 struct relay_connection *conn)
d3e2ba59
JD
2357{
2358 int ret = 0;
2f8f53af
DG
2359 uint32_t msg_value;
2360
2f8f53af
DG
2361 msg_value = be32toh(recv_hdr->cmd);
2362
2363 /*
2364 * Make sure we've done the version check before any command other then a
2365 * new client connection.
2366 */
c4e361a4 2367 if (msg_value != LTTNG_VIEWER_CONNECT && !conn->version_check_done) {
58eb9381 2368 ERR("Viewer conn value %" PRIu32 " before version check", msg_value);
2f8f53af
DG
2369 ret = -1;
2370 goto end;
2371 }
d3e2ba59 2372
2f8f53af 2373 switch (msg_value) {
c4e361a4 2374 case LTTNG_VIEWER_CONNECT:
58eb9381 2375 ret = viewer_connect(conn);
d3e2ba59 2376 break;
c4e361a4 2377 case LTTNG_VIEWER_LIST_SESSIONS:
58eb9381 2378 ret = viewer_list_sessions(conn);
d3e2ba59 2379 break;
c4e361a4 2380 case LTTNG_VIEWER_ATTACH_SESSION:
58eb9381 2381 ret = viewer_attach_session(conn);
d3e2ba59 2382 break;
c4e361a4 2383 case LTTNG_VIEWER_GET_NEXT_INDEX:
58eb9381 2384 ret = viewer_get_next_index(conn);
d3e2ba59 2385 break;
c4e361a4 2386 case LTTNG_VIEWER_GET_PACKET:
58eb9381 2387 ret = viewer_get_packet(conn);
d3e2ba59 2388 break;
c4e361a4 2389 case LTTNG_VIEWER_GET_METADATA:
58eb9381 2390 ret = viewer_get_metadata(conn);
d3e2ba59 2391 break;
c4e361a4 2392 case LTTNG_VIEWER_GET_NEW_STREAMS:
58eb9381 2393 ret = viewer_get_new_streams(conn);
80e8027a 2394 break;
c3b7390b
JD
2395 case LTTNG_VIEWER_CREATE_SESSION:
2396 ret = viewer_create_session(conn);
2397 break;
d62023be
JD
2398 case LTTNG_VIEWER_DETACH_SESSION:
2399 ret = viewer_detach_session(conn);
2400 break;
d3e2ba59 2401 default:
7591bab1
MD
2402 ERR("Received unknown viewer command (%u)",
2403 be32toh(recv_hdr->cmd));
58eb9381 2404 live_relay_unknown_command(conn);
d3e2ba59
JD
2405 ret = -1;
2406 goto end;
2407 }
2408
2409end:
2410 return ret;
2411}
2412
2413static
58eb9381 2414void cleanup_connection_pollfd(struct lttng_poll_event *events, int pollfd)
d3e2ba59
JD
2415{
2416 int ret;
2417
58eb9381 2418 (void) lttng_poll_del(events, pollfd);
d3e2ba59 2419
29555a78
JG
2420 ret = fd_tracker_close_unsuspendable_fd(the_fd_tracker, &pollfd, 1,
2421 fd_tracker_util_close_fd, NULL);
d3e2ba59
JD
2422 if (ret < 0) {
2423 ERR("Closing pollfd %d", pollfd);
2424 }
2425}
2426
d3e2ba59
JD
2427/*
2428 * This thread does the actual work
2429 */
2430static
2431void *thread_worker(void *data)
2432{
2433 int ret, err = -1;
2434 uint32_t nb_fd;
d3e2ba59 2435 struct lttng_poll_event events;
7591bab1 2436 struct lttng_ht *viewer_connections_ht;
d3e2ba59
JD
2437 struct lttng_ht_iter iter;
2438 struct lttng_viewer_cmd recv_hdr;
302d8906 2439 struct relay_connection *destroy_conn;
d3e2ba59
JD
2440
2441 DBG("[thread] Live viewer relay worker started");
2442
2443 rcu_register_thread();
2444
eea7556c
MD
2445 health_register(health_relayd, HEALTH_RELAYD_TYPE_LIVE_WORKER);
2446
9b5e0863
MD
2447 if (testpoint(relayd_thread_live_worker)) {
2448 goto error_testpoint;
2449 }
2450
d3e2ba59 2451 /* table of connections indexed on socket */
7591bab1
MD
2452 viewer_connections_ht = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
2453 if (!viewer_connections_ht) {
2454 goto viewer_connections_ht_error;
d3e2ba59
JD
2455 }
2456
35bc1f58
JG
2457 ret = create_named_thread_poll_set(&events, 2,
2458 "Live viewer worker thread epoll");
d3e2ba59
JD
2459 if (ret < 0) {
2460 goto error_poll_create;
2461 }
2462
58eb9381 2463 ret = lttng_poll_add(&events, live_conn_pipe[0], LPOLLIN | LPOLLRDHUP);
d3e2ba59
JD
2464 if (ret < 0) {
2465 goto error;
2466 }
2467
2468restart:
2469 while (1) {
2470 int i;
2471
eea7556c
MD
2472 health_code_update();
2473
d3e2ba59
JD
2474 /* Infinite blocking call, waiting for transmission */
2475 DBG3("Relayd live viewer worker thread polling...");
eea7556c 2476 health_poll_entry();
d3e2ba59 2477 ret = lttng_poll_wait(&events, -1);
eea7556c 2478 health_poll_exit();
d3e2ba59
JD
2479 if (ret < 0) {
2480 /*
2481 * Restart interrupted system call.
2482 */
2483 if (errno == EINTR) {
2484 goto restart;
2485 }
2486 goto error;
2487 }
2488
2489 nb_fd = ret;
2490
2491 /*
2492 * Process control. The control connection is prioritised so we don't
2493 * starve it with high throughput tracing data on the data
2494 * connection.
2495 */
2496 for (i = 0; i < nb_fd; i++) {
2497 /* Fetch once the poll data */
2498 uint32_t revents = LTTNG_POLL_GETEV(&events, i);
2499 int pollfd = LTTNG_POLL_GETFD(&events, i);
2500
eea7556c
MD
2501 health_code_update();
2502
d3e2ba59 2503 /* Thread quit pipe has been closed. Killing thread. */
bcf4a440 2504 ret = check_thread_quit_pipe(pollfd, revents);
d3e2ba59
JD
2505 if (ret) {
2506 err = 0;
2507 goto exit;
2508 }
2509
7591bab1 2510 /* Inspect the relay conn pipe for new connection. */
58eb9381 2511 if (pollfd == live_conn_pipe[0]) {
03e43155 2512 if (revents & LPOLLIN) {
302d8906
JG
2513 struct relay_connection *conn;
2514
7591bab1
MD
2515 ret = lttng_read(live_conn_pipe[0],
2516 &conn, sizeof(conn));
d3e2ba59
JD
2517 if (ret < 0) {
2518 goto error;
2519 }
73039936
FD
2520 ret = lttng_poll_add(&events,
2521 conn->sock->fd,
58eb9381 2522 LPOLLIN | LPOLLRDHUP);
73039936
FD
2523 if (ret) {
2524 ERR("Failed to add new live connection file descriptor to poll set");
2525 goto error;
2526 }
7591bab1
MD
2527 connection_ht_add(viewer_connections_ht, conn);
2528 DBG("Connection socket %d added to poll", conn->sock->fd);
03e43155
MD
2529 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
2530 ERR("Relay live pipe error");
2531 goto error;
2532 } else {
2533 ERR("Unexpected poll events %u for sock %d", revents, pollfd);
2534 goto error;
d3e2ba59 2535 }
58eb9381 2536 } else {
7591bab1 2537 /* Connection activity. */
302d8906
JG
2538 struct relay_connection *conn;
2539
7591bab1
MD
2540 conn = connection_get_by_sock(viewer_connections_ht, pollfd);
2541 if (!conn) {
2542 continue;
2543 }
58eb9381 2544
03e43155 2545 if (revents & LPOLLIN) {
58eb9381
DG
2546 ret = conn->sock->ops->recvmsg(conn->sock, &recv_hdr,
2547 sizeof(recv_hdr), 0);
d3e2ba59 2548 if (ret <= 0) {
7591bab1 2549 /* Connection closed. */
58eb9381 2550 cleanup_connection_pollfd(&events, pollfd);
7591bab1
MD
2551 /* Put "create" ownership reference. */
2552 connection_put(conn);
58eb9381 2553 DBG("Viewer control conn closed with %d", pollfd);
d3e2ba59 2554 } else {
58eb9381 2555 ret = process_control(&recv_hdr, conn);
d3e2ba59
JD
2556 if (ret < 0) {
2557 /* Clear the session on error. */
58eb9381 2558 cleanup_connection_pollfd(&events, pollfd);
7591bab1
MD
2559 /* Put "create" ownership reference. */
2560 connection_put(conn);
d3e2ba59
JD
2561 DBG("Viewer connection closed with %d", pollfd);
2562 }
2563 }
03e43155
MD
2564 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
2565 cleanup_connection_pollfd(&events, pollfd);
2566 /* Put "create" ownership reference. */
2567 connection_put(conn);
2568 } else {
2569 ERR("Unexpected poll events %u for sock %d", revents, pollfd);
2570 connection_put(conn);
2571 goto error;
d3e2ba59 2572 }
7591bab1
MD
2573 /* Put local "get_by_sock" reference. */
2574 connection_put(conn);
d3e2ba59
JD
2575 }
2576 }
2577 }
2578
2579exit:
2580error:
35bc1f58 2581 (void) fd_tracker_util_poll_clean(the_fd_tracker, &events);
d3e2ba59 2582
71efa8ef 2583 /* Cleanup remaining connection object. */
d3e2ba59 2584 rcu_read_lock();
7591bab1 2585 cds_lfht_for_each_entry(viewer_connections_ht->ht, &iter.iter,
302d8906 2586 destroy_conn,
58eb9381 2587 sock_n.node) {
eea7556c 2588 health_code_update();
7591bab1 2589 connection_put(destroy_conn);
d3e2ba59
JD
2590 }
2591 rcu_read_unlock();
2592error_poll_create:
7591bab1
MD
2593 lttng_ht_destroy(viewer_connections_ht);
2594viewer_connections_ht_error:
58eb9381 2595 /* Close relay conn pipes */
87bcbe91 2596 (void) fd_tracker_util_pipe_close(the_fd_tracker, live_conn_pipe);
d3e2ba59
JD
2597 if (err) {
2598 DBG("Viewer worker thread exited with error");
2599 }
2600 DBG("Viewer worker thread cleanup complete");
9b5e0863 2601error_testpoint:
eea7556c
MD
2602 if (err) {
2603 health_error();
2604 ERR("Health error occurred in %s", __func__);
2605 }
2606 health_unregister(health_relayd);
b4aacfdc
MD
2607 if (lttng_relay_stop_threads()) {
2608 ERR("Error stopping threads");
178a0557 2609 }
d3e2ba59
JD
2610 rcu_unregister_thread();
2611 return NULL;
2612}
2613
2614/*
2615 * Create the relay command pipe to wake thread_manage_apps.
2616 * Closed in cleanup().
2617 */
58eb9381 2618static int create_conn_pipe(void)
d3e2ba59 2619{
87bcbe91
JG
2620 return fd_tracker_util_pipe_open_cloexec(the_fd_tracker,
2621 "Live connection pipe", live_conn_pipe);
178a0557 2622}
d3e2ba59 2623
178a0557 2624int relayd_live_join(void)
d3e2ba59 2625{
178a0557 2626 int ret, retval = 0;
d3e2ba59
JD
2627 void *status;
2628
d3e2ba59 2629 ret = pthread_join(live_listener_thread, &status);
178a0557
MD
2630 if (ret) {
2631 errno = ret;
d3e2ba59 2632 PERROR("pthread_join live listener");
178a0557 2633 retval = -1;
d3e2ba59
JD
2634 }
2635
2636 ret = pthread_join(live_worker_thread, &status);
178a0557
MD
2637 if (ret) {
2638 errno = ret;
d3e2ba59 2639 PERROR("pthread_join live worker");
178a0557 2640 retval = -1;
d3e2ba59
JD
2641 }
2642
2643 ret = pthread_join(live_dispatcher_thread, &status);
178a0557
MD
2644 if (ret) {
2645 errno = ret;
d3e2ba59 2646 PERROR("pthread_join live dispatcher");
178a0557 2647 retval = -1;
d3e2ba59
JD
2648 }
2649
178a0557 2650 cleanup_relayd_live();
d3e2ba59 2651
178a0557 2652 return retval;
d3e2ba59
JD
2653}
2654
2655/*
2656 * main
2657 */
7591bab1 2658int relayd_live_create(struct lttng_uri *uri)
d3e2ba59 2659{
178a0557 2660 int ret = 0, retval = 0;
d3e2ba59
JD
2661 void *status;
2662 int is_root;
2663
178a0557
MD
2664 if (!uri) {
2665 retval = -1;
2666 goto exit_init_data;
2667 }
d3e2ba59
JD
2668 live_uri = uri;
2669
d3e2ba59
JD
2670 /* Check if daemon is UID = 0 */
2671 is_root = !getuid();
2672
2673 if (!is_root) {
2674 if (live_uri->port < 1024) {
2675 ERR("Need to be root to use ports < 1024");
178a0557
MD
2676 retval = -1;
2677 goto exit_init_data;
d3e2ba59
JD
2678 }
2679 }
2680
2681 /* Setup the thread apps communication pipe. */
178a0557
MD
2682 if (create_conn_pipe()) {
2683 retval = -1;
2684 goto exit_init_data;
d3e2ba59
JD
2685 }
2686
2687 /* Init relay command queue. */
8bdee6e2 2688 cds_wfcq_init(&viewer_conn_queue.head, &viewer_conn_queue.tail);
d3e2ba59
JD
2689
2690 /* Set up max poll set size */
25b397f9
MD
2691 if (lttng_poll_set_max_size()) {
2692 retval = -1;
2693 goto exit_init_data;
2694 }
d3e2ba59
JD
2695
2696 /* Setup the dispatcher thread */
1a1a34b4 2697 ret = pthread_create(&live_dispatcher_thread, default_pthread_attr(),
d3e2ba59 2698 thread_dispatcher, (void *) NULL);
178a0557
MD
2699 if (ret) {
2700 errno = ret;
d3e2ba59 2701 PERROR("pthread_create viewer dispatcher");
178a0557
MD
2702 retval = -1;
2703 goto exit_dispatcher_thread;
d3e2ba59
JD
2704 }
2705
2706 /* Setup the worker thread */
1a1a34b4 2707 ret = pthread_create(&live_worker_thread, default_pthread_attr(),
7591bab1 2708 thread_worker, NULL);
178a0557
MD
2709 if (ret) {
2710 errno = ret;
d3e2ba59 2711 PERROR("pthread_create viewer worker");
178a0557
MD
2712 retval = -1;
2713 goto exit_worker_thread;
d3e2ba59
JD
2714 }
2715
2716 /* Setup the listener thread */
1a1a34b4 2717 ret = pthread_create(&live_listener_thread, default_pthread_attr(),
d3e2ba59 2718 thread_listener, (void *) NULL);
178a0557
MD
2719 if (ret) {
2720 errno = ret;
d3e2ba59 2721 PERROR("pthread_create viewer listener");
178a0557
MD
2722 retval = -1;
2723 goto exit_listener_thread;
d3e2ba59
JD
2724 }
2725
178a0557
MD
2726 /*
2727 * All OK, started all threads.
2728 */
2729 return retval;
2730
9911d21b
JG
2731 /*
2732 * Join on the live_listener_thread should anything be added after
2733 * the live_listener thread's creation.
2734 */
d3e2ba59 2735
178a0557 2736exit_listener_thread:
d3e2ba59 2737
d3e2ba59 2738 ret = pthread_join(live_worker_thread, &status);
178a0557
MD
2739 if (ret) {
2740 errno = ret;
d3e2ba59 2741 PERROR("pthread_join live worker");
178a0557 2742 retval = -1;
d3e2ba59 2743 }
178a0557 2744exit_worker_thread:
d3e2ba59 2745
d3e2ba59 2746 ret = pthread_join(live_dispatcher_thread, &status);
178a0557
MD
2747 if (ret) {
2748 errno = ret;
d3e2ba59 2749 PERROR("pthread_join live dispatcher");
178a0557 2750 retval = -1;
d3e2ba59 2751 }
178a0557 2752exit_dispatcher_thread:
d3e2ba59 2753
178a0557
MD
2754exit_init_data:
2755 cleanup_relayd_live();
d3e2ba59 2756
178a0557 2757 return retval;
d3e2ba59 2758}
This page took 0.212895 seconds and 4 git commands to generate.