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