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