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