lttng enable-channel memsets lttng_channel to -1
[lttng-tools.git] / src / common / ust-consumer / ust-consumer.c
CommitLineData
3bd1e081
MD
1/*
2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 *
d14d33bf
AM
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
3bd1e081
MD
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
d14d33bf
AM
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
3bd1e081
MD
17 */
18
6c1c0768 19#define _LGPL_SOURCE
3bd1e081 20#include <assert.h>
f02e1e8a 21#include <lttng/ust-ctl.h>
3bd1e081
MD
22#include <poll.h>
23#include <pthread.h>
24#include <stdlib.h>
25#include <string.h>
26#include <sys/mman.h>
27#include <sys/socket.h>
dbb5dfe6 28#include <sys/stat.h>
3bd1e081 29#include <sys/types.h>
77c7c900 30#include <inttypes.h>
3bd1e081 31#include <unistd.h>
ffe60014 32#include <urcu/list.h>
331744e3 33#include <signal.h>
0857097f 34
51a9e1c7 35#include <bin/lttng-consumerd/health-consumerd.h>
990570ed 36#include <common/common.h>
10a8a223 37#include <common/sessiond-comm/sessiond-comm.h>
00e2e675 38#include <common/relayd/relayd.h>
dbb5dfe6 39#include <common/compat/fcntl.h>
f263b7fd 40#include <common/compat/endian.h>
c8fea79c
JR
41#include <common/consumer/consumer-metadata-cache.h>
42#include <common/consumer/consumer-stream.h>
43#include <common/consumer/consumer-timer.h>
fe4477ee 44#include <common/utils.h>
309167d2 45#include <common/index/index.h>
10a8a223
DG
46
47#include "ust-consumer.h"
3bd1e081 48
45863397 49#define INT_MAX_STR_LEN 12 /* includes \0 */
4628484a 50
3bd1e081
MD
51extern struct lttng_consumer_global_data consumer_data;
52extern int consumer_poll_timeout;
53extern volatile int consumer_quit;
54
55/*
ffe60014
DG
56 * Free channel object and all streams associated with it. This MUST be used
57 * only and only if the channel has _NEVER_ been added to the global channel
58 * hash table.
3bd1e081 59 */
ffe60014 60static void destroy_channel(struct lttng_consumer_channel *channel)
3bd1e081 61{
ffe60014
DG
62 struct lttng_consumer_stream *stream, *stmp;
63
64 assert(channel);
65
66 DBG("UST consumer cleaning stream list");
67
68 cds_list_for_each_entry_safe(stream, stmp, &channel->streams.head,
69 send_node) {
9ce5646a
MD
70
71 health_code_update();
72
ffe60014
DG
73 cds_list_del(&stream->send_node);
74 ustctl_destroy_stream(stream->ustream);
75 free(stream);
76 }
77
78 /*
79 * If a channel is available meaning that was created before the streams
80 * were, delete it.
81 */
82 if (channel->uchan) {
83 lttng_ustconsumer_del_channel(channel);
b83e03c4 84 lttng_ustconsumer_free_channel(channel);
ffe60014
DG
85 }
86 free(channel);
87}
3bd1e081
MD
88
89/*
ffe60014 90 * Add channel to internal consumer state.
3bd1e081 91 *
ffe60014 92 * Returns 0 on success or else a negative value.
3bd1e081 93 */
ffe60014
DG
94static int add_channel(struct lttng_consumer_channel *channel,
95 struct lttng_consumer_local_data *ctx)
3bd1e081
MD
96{
97 int ret = 0;
98
ffe60014
DG
99 assert(channel);
100 assert(ctx);
101
102 if (ctx->on_recv_channel != NULL) {
103 ret = ctx->on_recv_channel(channel);
104 if (ret == 0) {
d8ef542d 105 ret = consumer_add_channel(channel, ctx);
ffe60014
DG
106 } else if (ret < 0) {
107 /* Most likely an ENOMEM. */
108 lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_OUTFD_ERROR);
109 goto error;
110 }
111 } else {
d8ef542d 112 ret = consumer_add_channel(channel, ctx);
3bd1e081
MD
113 }
114
d88aee68 115 DBG("UST consumer channel added (key: %" PRIu64 ")", channel->key);
ffe60014
DG
116
117error:
3bd1e081
MD
118 return ret;
119}
120
121/*
ffe60014
DG
122 * Allocate and return a consumer channel object.
123 */
124static struct lttng_consumer_channel *allocate_channel(uint64_t session_id,
125 const char *pathname, const char *name, uid_t uid, gid_t gid,
da009f2c 126 uint64_t relayd_id, uint64_t key, enum lttng_event_output output,
2bba9e53 127 uint64_t tracefile_size, uint64_t tracefile_count,
ecc48a90 128 uint64_t session_id_per_pid, unsigned int monitor,
d7ba1388 129 unsigned int live_timer_interval,
3d071855 130 const char *root_shm_path, const char *shm_path)
ffe60014
DG
131{
132 assert(pathname);
133 assert(name);
134
1950109e
JD
135 return consumer_allocate_channel(key, session_id, pathname, name, uid,
136 gid, relayd_id, output, tracefile_size,
d7ba1388 137 tracefile_count, session_id_per_pid, monitor,
3d071855 138 live_timer_interval, root_shm_path, shm_path);
ffe60014
DG
139}
140
141/*
142 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
143 * error value if applicable is set in it else it is kept untouched.
3bd1e081 144 *
ffe60014 145 * Return NULL on error else the newly allocated stream object.
3bd1e081 146 */
ffe60014
DG
147static struct lttng_consumer_stream *allocate_stream(int cpu, int key,
148 struct lttng_consumer_channel *channel,
149 struct lttng_consumer_local_data *ctx, int *_alloc_ret)
150{
151 int alloc_ret;
152 struct lttng_consumer_stream *stream = NULL;
153
154 assert(channel);
155 assert(ctx);
156
157 stream = consumer_allocate_stream(channel->key,
158 key,
159 LTTNG_CONSUMER_ACTIVE_STREAM,
160 channel->name,
161 channel->uid,
162 channel->gid,
163 channel->relayd_id,
164 channel->session_id,
165 cpu,
166 &alloc_ret,
4891ece8
DG
167 channel->type,
168 channel->monitor);
ffe60014
DG
169 if (stream == NULL) {
170 switch (alloc_ret) {
171 case -ENOENT:
172 /*
173 * We could not find the channel. Can happen if cpu hotplug
174 * happens while tearing down.
175 */
176 DBG3("Could not find channel");
177 break;
178 case -ENOMEM:
179 case -EINVAL:
180 default:
181 lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_OUTFD_ERROR);
182 break;
183 }
184 goto error;
185 }
186
187 stream->chan = channel;
188
189error:
190 if (_alloc_ret) {
191 *_alloc_ret = alloc_ret;
192 }
193 return stream;
194}
195
196/*
197 * Send the given stream pointer to the corresponding thread.
198 *
199 * Returns 0 on success else a negative value.
200 */
201static int send_stream_to_thread(struct lttng_consumer_stream *stream,
202 struct lttng_consumer_local_data *ctx)
203{
dae10966
DG
204 int ret;
205 struct lttng_pipe *stream_pipe;
ffe60014
DG
206
207 /* Get the right pipe where the stream will be sent. */
208 if (stream->metadata_flag) {
5ab66908
MD
209 ret = consumer_add_metadata_stream(stream);
210 if (ret) {
211 ERR("Consumer add metadata stream %" PRIu64 " failed.",
212 stream->key);
213 goto error;
214 }
dae10966 215 stream_pipe = ctx->consumer_metadata_pipe;
ffe60014 216 } else {
5ab66908
MD
217 ret = consumer_add_data_stream(stream);
218 if (ret) {
219 ERR("Consumer add stream %" PRIu64 " failed.",
220 stream->key);
221 goto error;
222 }
dae10966 223 stream_pipe = ctx->consumer_data_pipe;
ffe60014
DG
224 }
225
5ab66908
MD
226 /*
227 * From this point on, the stream's ownership has been moved away from
228 * the channel and becomes globally visible.
229 */
230 stream->globally_visible = 1;
231
dae10966 232 ret = lttng_pipe_write(stream_pipe, &stream, sizeof(stream));
ffe60014 233 if (ret < 0) {
dae10966
DG
234 ERR("Consumer write %s stream to pipe %d",
235 stream->metadata_flag ? "metadata" : "data",
236 lttng_pipe_get_writefd(stream_pipe));
5ab66908
MD
237 if (stream->metadata_flag) {
238 consumer_del_stream_for_metadata(stream);
239 } else {
240 consumer_del_stream_for_data(stream);
241 }
ffe60014 242 }
5ab66908 243error:
ffe60014
DG
244 return ret;
245}
246
4628484a
MD
247static
248int get_stream_shm_path(char *stream_shm_path, const char *shm_path, int cpu)
249{
45863397 250 char cpu_nr[INT_MAX_STR_LEN]; /* int max len */
4628484a
MD
251 int ret;
252
253 strncpy(stream_shm_path, shm_path, PATH_MAX);
254 stream_shm_path[PATH_MAX - 1] = '\0';
45863397 255 ret = snprintf(cpu_nr, INT_MAX_STR_LEN, "%i", cpu);
67f8cb8d
MD
256 if (ret < 0) {
257 PERROR("snprintf");
4628484a
MD
258 goto end;
259 }
260 strncat(stream_shm_path, cpu_nr,
261 PATH_MAX - strlen(stream_shm_path) - 1);
262 ret = 0;
263end:
264 return ret;
265}
266
d88aee68
DG
267/*
268 * Create streams for the given channel using liblttng-ust-ctl.
269 *
270 * Return 0 on success else a negative value.
271 */
ffe60014
DG
272static int create_ust_streams(struct lttng_consumer_channel *channel,
273 struct lttng_consumer_local_data *ctx)
274{
275 int ret, cpu = 0;
276 struct ustctl_consumer_stream *ustream;
277 struct lttng_consumer_stream *stream;
278
279 assert(channel);
280 assert(ctx);
281
282 /*
283 * While a stream is available from ustctl. When NULL is returned, we've
284 * reached the end of the possible stream for the channel.
285 */
286 while ((ustream = ustctl_create_stream(channel->uchan, cpu))) {
287 int wait_fd;
04ef1097 288 int ust_metadata_pipe[2];
ffe60014 289
9ce5646a
MD
290 health_code_update();
291
04ef1097
MD
292 if (channel->type == CONSUMER_CHANNEL_TYPE_METADATA && channel->monitor) {
293 ret = utils_create_pipe_cloexec_nonblock(ust_metadata_pipe);
294 if (ret < 0) {
295 ERR("Create ust metadata poll pipe");
296 goto error;
297 }
298 wait_fd = ust_metadata_pipe[0];
299 } else {
300 wait_fd = ustctl_stream_get_wait_fd(ustream);
301 }
ffe60014
DG
302
303 /* Allocate consumer stream object. */
304 stream = allocate_stream(cpu, wait_fd, channel, ctx, &ret);
305 if (!stream) {
306 goto error_alloc;
307 }
308 stream->ustream = ustream;
309 /*
310 * Store it so we can save multiple function calls afterwards since
311 * this value is used heavily in the stream threads. This is UST
312 * specific so this is why it's done after allocation.
313 */
314 stream->wait_fd = wait_fd;
315
b31398bb
DG
316 /*
317 * Increment channel refcount since the channel reference has now been
318 * assigned in the allocation process above.
319 */
10a50311
JD
320 if (stream->chan->monitor) {
321 uatomic_inc(&stream->chan->refcount);
322 }
b31398bb 323
ffe60014
DG
324 /*
325 * Order is important this is why a list is used. On error, the caller
326 * should clean this list.
327 */
328 cds_list_add_tail(&stream->send_node, &channel->streams.head);
329
330 ret = ustctl_get_max_subbuf_size(stream->ustream,
331 &stream->max_sb_size);
332 if (ret < 0) {
333 ERR("ustctl_get_max_subbuf_size failed for stream %s",
334 stream->name);
335 goto error;
336 }
337
338 /* Do actions once stream has been received. */
339 if (ctx->on_recv_stream) {
340 ret = ctx->on_recv_stream(stream);
341 if (ret < 0) {
342 goto error;
343 }
344 }
345
d88aee68 346 DBG("UST consumer add stream %s (key: %" PRIu64 ") with relayd id %" PRIu64,
ffe60014
DG
347 stream->name, stream->key, stream->relayd_stream_id);
348
349 /* Set next CPU stream. */
350 channel->streams.count = ++cpu;
d88aee68
DG
351
352 /* Keep stream reference when creating metadata. */
353 if (channel->type == CONSUMER_CHANNEL_TYPE_METADATA) {
354 channel->metadata_stream = stream;
8de4f941
JG
355 if (channel->monitor) {
356 /* Set metadata poll pipe if we created one */
357 memcpy(stream->ust_metadata_poll_pipe,
358 ust_metadata_pipe,
359 sizeof(ust_metadata_pipe));
360 }
d88aee68 361 }
ffe60014
DG
362 }
363
364 return 0;
365
366error:
367error_alloc:
368 return ret;
369}
370
4628484a
MD
371/*
372 * create_posix_shm is never called concurrently within a process.
373 */
374static
375int create_posix_shm(void)
376{
377 char tmp_name[NAME_MAX];
378 int shmfd, ret;
379
380 ret = snprintf(tmp_name, NAME_MAX, "/ust-shm-consumer-%d", getpid());
381 if (ret < 0) {
382 PERROR("snprintf");
383 return -1;
384 }
385 /*
386 * Allocate shm, and immediately unlink its shm oject, keeping
387 * only the file descriptor as a reference to the object.
388 * We specifically do _not_ use the / at the beginning of the
389 * pathname so that some OS implementations can keep it local to
390 * the process (POSIX leaves this implementation-defined).
391 */
392 shmfd = shm_open(tmp_name, O_CREAT | O_EXCL | O_RDWR, 0700);
393 if (shmfd < 0) {
394 PERROR("shm_open");
395 goto error_shm_open;
396 }
397 ret = shm_unlink(tmp_name);
398 if (ret < 0 && errno != ENOENT) {
399 PERROR("shm_unlink");
400 goto error_shm_release;
401 }
402 return shmfd;
403
404error_shm_release:
405 ret = close(shmfd);
406 if (ret) {
407 PERROR("close");
408 }
409error_shm_open:
410 return -1;
411}
412
413static int open_ust_stream_fd(struct lttng_consumer_channel *channel,
414 struct ustctl_consumer_channel_attr *attr,
415 int cpu)
416{
417 char shm_path[PATH_MAX];
418 int ret;
419
420 if (!channel->shm_path[0]) {
421 return create_posix_shm();
422 }
423 ret = get_stream_shm_path(shm_path, channel->shm_path, cpu);
424 if (ret) {
425 goto error_shm_path;
426 }
427 return run_as_open(shm_path,
428 O_RDWR | O_CREAT | O_EXCL, S_IRUSR | S_IWUSR,
429 channel->uid, channel->gid);
430
431error_shm_path:
432 return -1;
433}
434
ffe60014
DG
435/*
436 * Create an UST channel with the given attributes and send it to the session
437 * daemon using the ust ctl API.
438 *
439 * Return 0 on success or else a negative value.
440 */
4628484a
MD
441static int create_ust_channel(struct lttng_consumer_channel *channel,
442 struct ustctl_consumer_channel_attr *attr,
443 struct ustctl_consumer_channel **ust_chanp)
ffe60014 444{
4628484a
MD
445 int ret, nr_stream_fds, i, j;
446 int *stream_fds;
447 struct ustctl_consumer_channel *ust_channel;
ffe60014 448
4628484a 449 assert(channel);
ffe60014 450 assert(attr);
4628484a 451 assert(ust_chanp);
ffe60014
DG
452
453 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
454 "subbuf_size: %" PRIu64 ", num_subbuf: %" PRIu64 ", "
455 "switch_timer_interval: %u, read_timer_interval: %u, "
456 "output: %d, type: %d", attr->overwrite, attr->subbuf_size,
457 attr->num_subbuf, attr->switch_timer_interval,
458 attr->read_timer_interval, attr->output, attr->type);
459
4628484a
MD
460 if (channel->type == CONSUMER_CHANNEL_TYPE_METADATA)
461 nr_stream_fds = 1;
462 else
463 nr_stream_fds = ustctl_get_nr_stream_per_channel();
464 stream_fds = zmalloc(nr_stream_fds * sizeof(*stream_fds));
465 if (!stream_fds) {
466 ret = -1;
467 goto error_alloc;
468 }
469 for (i = 0; i < nr_stream_fds; i++) {
470 stream_fds[i] = open_ust_stream_fd(channel, attr, i);
471 if (stream_fds[i] < 0) {
472 ret = -1;
473 goto error_open;
474 }
475 }
476 ust_channel = ustctl_create_channel(attr, stream_fds, nr_stream_fds);
477 if (!ust_channel) {
ffe60014
DG
478 ret = -1;
479 goto error_create;
480 }
4628484a
MD
481 channel->nr_stream_fds = nr_stream_fds;
482 channel->stream_fds = stream_fds;
483 *ust_chanp = ust_channel;
ffe60014
DG
484
485 return 0;
486
487error_create:
4628484a
MD
488error_open:
489 for (j = i - 1; j >= 0; j--) {
490 int closeret;
491
492 closeret = close(stream_fds[j]);
493 if (closeret) {
494 PERROR("close");
495 }
496 if (channel->shm_path[0]) {
497 char shm_path[PATH_MAX];
498
499 closeret = get_stream_shm_path(shm_path,
500 channel->shm_path, j);
501 if (closeret) {
502 ERR("Cannot get stream shm path");
503 }
504 closeret = run_as_unlink(shm_path,
505 channel->uid, channel->gid);
506 if (closeret) {
4628484a
MD
507 PERROR("unlink %s", shm_path);
508 }
509 }
510 }
511 /* Try to rmdir all directories under shm_path root. */
512 if (channel->root_shm_path[0]) {
513 (void) run_as_recursive_rmdir(channel->root_shm_path,
514 channel->uid, channel->gid);
515 }
516 free(stream_fds);
517error_alloc:
ffe60014
DG
518 return ret;
519}
520
d88aee68
DG
521/*
522 * Send a single given stream to the session daemon using the sock.
523 *
524 * Return 0 on success else a negative value.
525 */
ffe60014
DG
526static int send_sessiond_stream(int sock, struct lttng_consumer_stream *stream)
527{
528 int ret;
529
530 assert(stream);
531 assert(sock >= 0);
532
3eb914c0 533 DBG("UST consumer sending stream %" PRIu64 " to sessiond", stream->key);
ffe60014
DG
534
535 /* Send stream to session daemon. */
536 ret = ustctl_send_stream_to_sessiond(sock, stream->ustream);
537 if (ret < 0) {
538 goto error;
539 }
540
ffe60014
DG
541error:
542 return ret;
543}
544
545/*
546 * Send channel to sessiond.
547 *
d88aee68 548 * Return 0 on success or else a negative value.
ffe60014
DG
549 */
550static int send_sessiond_channel(int sock,
551 struct lttng_consumer_channel *channel,
552 struct lttng_consumer_local_data *ctx, int *relayd_error)
553{
0c759fc9 554 int ret, ret_code = LTTCOMM_CONSUMERD_SUCCESS;
ffe60014 555 struct lttng_consumer_stream *stream;
a4baae1b 556 uint64_t net_seq_idx = -1ULL;
ffe60014
DG
557
558 assert(channel);
559 assert(ctx);
560 assert(sock >= 0);
561
562 DBG("UST consumer sending channel %s to sessiond", channel->name);
563
62285ea4
DG
564 if (channel->relayd_id != (uint64_t) -1ULL) {
565 cds_list_for_each_entry(stream, &channel->streams.head, send_node) {
9ce5646a
MD
566
567 health_code_update();
568
62285ea4
DG
569 /* Try to send the stream to the relayd if one is available. */
570 ret = consumer_send_relayd_stream(stream, stream->chan->pathname);
571 if (ret < 0) {
572 /*
573 * Flag that the relayd was the problem here probably due to a
574 * communicaton error on the socket.
575 */
576 if (relayd_error) {
577 *relayd_error = 1;
578 }
725d28b2 579 ret_code = LTTCOMM_CONSUMERD_RELAYD_FAIL;
ffe60014 580 }
a4baae1b
JD
581 if (net_seq_idx == -1ULL) {
582 net_seq_idx = stream->net_seq_idx;
583 }
584 }
f2a444f1 585 }
ffe60014 586
f2a444f1
DG
587 /* Inform sessiond that we are about to send channel and streams. */
588 ret = consumer_send_status_msg(sock, ret_code);
0c759fc9 589 if (ret < 0 || ret_code != LTTCOMM_CONSUMERD_SUCCESS) {
f2a444f1
DG
590 /*
591 * Either the session daemon is not responding or the relayd died so we
592 * stop now.
593 */
594 goto error;
595 }
596
597 /* Send channel to sessiond. */
598 ret = ustctl_send_channel_to_sessiond(sock, channel->uchan);
599 if (ret < 0) {
600 goto error;
601 }
602
603 ret = ustctl_channel_close_wakeup_fd(channel->uchan);
604 if (ret < 0) {
605 goto error;
606 }
607
608 /* The channel was sent successfully to the sessiond at this point. */
609 cds_list_for_each_entry(stream, &channel->streams.head, send_node) {
9ce5646a
MD
610
611 health_code_update();
612
ffe60014
DG
613 /* Send stream to session daemon. */
614 ret = send_sessiond_stream(sock, stream);
615 if (ret < 0) {
616 goto error;
617 }
618 }
619
620 /* Tell sessiond there is no more stream. */
621 ret = ustctl_send_stream_to_sessiond(sock, NULL);
622 if (ret < 0) {
623 goto error;
624 }
625
626 DBG("UST consumer NULL stream sent to sessiond");
627
628 return 0;
629
630error:
0c759fc9 631 if (ret_code != LTTCOMM_CONSUMERD_SUCCESS) {
f2a444f1
DG
632 ret = -1;
633 }
ffe60014
DG
634 return ret;
635}
636
637/*
638 * Creates a channel and streams and add the channel it to the channel internal
639 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
640 * received.
641 *
642 * Return 0 on success or else, a negative value is returned and the channel
643 * MUST be destroyed by consumer_del_channel().
644 */
645static int ask_channel(struct lttng_consumer_local_data *ctx, int sock,
646 struct lttng_consumer_channel *channel,
647 struct ustctl_consumer_channel_attr *attr)
3bd1e081
MD
648{
649 int ret;
650
ffe60014
DG
651 assert(ctx);
652 assert(channel);
653 assert(attr);
654
655 /*
656 * This value is still used by the kernel consumer since for the kernel,
657 * the stream ownership is not IN the consumer so we need to have the
658 * number of left stream that needs to be initialized so we can know when
659 * to delete the channel (see consumer.c).
660 *
661 * As for the user space tracer now, the consumer creates and sends the
662 * stream to the session daemon which only sends them to the application
663 * once every stream of a channel is received making this value useless
664 * because we they will be added to the poll thread before the application
665 * receives them. This ensures that a stream can not hang up during
666 * initilization of a channel.
667 */
668 channel->nb_init_stream_left = 0;
669
670 /* The reply msg status is handled in the following call. */
4628484a 671 ret = create_ust_channel(channel, attr, &channel->uchan);
ffe60014 672 if (ret < 0) {
10a50311 673 goto end;
3bd1e081
MD
674 }
675
d8ef542d
MD
676 channel->wait_fd = ustctl_channel_get_wait_fd(channel->uchan);
677
10a50311
JD
678 /*
679 * For the snapshots (no monitor), we create the metadata streams
680 * on demand, not during the channel creation.
681 */
682 if (channel->type == CONSUMER_CHANNEL_TYPE_METADATA && !channel->monitor) {
683 ret = 0;
684 goto end;
685 }
686
ffe60014
DG
687 /* Open all streams for this channel. */
688 ret = create_ust_streams(channel, ctx);
689 if (ret < 0) {
10a50311 690 goto end;
ffe60014
DG
691 }
692
10a50311 693end:
3bd1e081
MD
694 return ret;
695}
696
d88aee68
DG
697/*
698 * Send all stream of a channel to the right thread handling it.
699 *
700 * On error, return a negative value else 0 on success.
701 */
702static int send_streams_to_thread(struct lttng_consumer_channel *channel,
703 struct lttng_consumer_local_data *ctx)
704{
705 int ret = 0;
706 struct lttng_consumer_stream *stream, *stmp;
707
708 assert(channel);
709 assert(ctx);
710
711 /* Send streams to the corresponding thread. */
712 cds_list_for_each_entry_safe(stream, stmp, &channel->streams.head,
713 send_node) {
9ce5646a
MD
714
715 health_code_update();
716
d88aee68
DG
717 /* Sending the stream to the thread. */
718 ret = send_stream_to_thread(stream, ctx);
719 if (ret < 0) {
720 /*
721 * If we are unable to send the stream to the thread, there is
722 * a big problem so just stop everything.
723 */
5ab66908
MD
724 /* Remove node from the channel stream list. */
725 cds_list_del(&stream->send_node);
d88aee68
DG
726 goto error;
727 }
728
729 /* Remove node from the channel stream list. */
730 cds_list_del(&stream->send_node);
4891ece8 731
d88aee68
DG
732 }
733
734error:
735 return ret;
736}
737
7972aab2
DG
738/*
739 * Flush channel's streams using the given key to retrieve the channel.
740 *
741 * Return 0 on success else an LTTng error code.
742 */
743static int flush_channel(uint64_t chan_key)
744{
745 int ret = 0;
746 struct lttng_consumer_channel *channel;
747 struct lttng_consumer_stream *stream;
748 struct lttng_ht *ht;
749 struct lttng_ht_iter iter;
750
8fd623e0 751 DBG("UST consumer flush channel key %" PRIu64, chan_key);
7972aab2 752
a500c257 753 rcu_read_lock();
7972aab2
DG
754 channel = consumer_find_channel(chan_key);
755 if (!channel) {
8fd623e0 756 ERR("UST consumer flush channel %" PRIu64 " not found", chan_key);
7972aab2
DG
757 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
758 goto error;
759 }
760
761 ht = consumer_data.stream_per_chan_id_ht;
762
763 /* For each stream of the channel id, flush it. */
7972aab2
DG
764 cds_lfht_for_each_entry_duplicate(ht->ht,
765 ht->hash_fct(&channel->key, lttng_ht_seed), ht->match_fct,
766 &channel->key, &iter.iter, stream, node_channel_id.node) {
9ce5646a
MD
767
768 health_code_update();
769
b8086166 770 ustctl_flush_buffer(stream->ustream, 1);
7972aab2 771 }
7972aab2 772error:
a500c257 773 rcu_read_unlock();
7972aab2
DG
774 return ret;
775}
776
d88aee68
DG
777/*
778 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
a500c257 779 * RCU read side lock MUST be acquired before calling this function.
d88aee68
DG
780 *
781 * Return 0 on success else an LTTng error code.
782 */
783static int close_metadata(uint64_t chan_key)
784{
ea88ca2a 785 int ret = 0;
d88aee68
DG
786 struct lttng_consumer_channel *channel;
787
8fd623e0 788 DBG("UST consumer close metadata key %" PRIu64, chan_key);
d88aee68
DG
789
790 channel = consumer_find_channel(chan_key);
791 if (!channel) {
84cc9aa0
DG
792 /*
793 * This is possible if the metadata thread has issue a delete because
794 * the endpoint point of the stream hung up. There is no way the
795 * session daemon can know about it thus use a DBG instead of an actual
796 * error.
797 */
798 DBG("UST consumer close metadata %" PRIu64 " not found", chan_key);
d88aee68
DG
799 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
800 goto error;
801 }
802
ea88ca2a 803 pthread_mutex_lock(&consumer_data.lock);
a9838785 804 pthread_mutex_lock(&channel->lock);
73811ecc
DG
805
806 if (cds_lfht_is_node_deleted(&channel->node.node)) {
807 goto error_unlock;
808 }
809
6d574024 810 lttng_ustconsumer_close_metadata(channel);
d88aee68 811
ea88ca2a 812error_unlock:
a9838785 813 pthread_mutex_unlock(&channel->lock);
ea88ca2a 814 pthread_mutex_unlock(&consumer_data.lock);
d88aee68
DG
815error:
816 return ret;
817}
818
819/*
820 * RCU read side lock MUST be acquired before calling this function.
821 *
822 * Return 0 on success else an LTTng error code.
823 */
824static int setup_metadata(struct lttng_consumer_local_data *ctx, uint64_t key)
825{
826 int ret;
827 struct lttng_consumer_channel *metadata;
828
8fd623e0 829 DBG("UST consumer setup metadata key %" PRIu64, key);
d88aee68
DG
830
831 metadata = consumer_find_channel(key);
832 if (!metadata) {
833 ERR("UST consumer push metadata %" PRIu64 " not found", key);
834 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
10a50311
JD
835 goto end;
836 }
837
838 /*
839 * In no monitor mode, the metadata channel has no stream(s) so skip the
840 * ownership transfer to the metadata thread.
841 */
842 if (!metadata->monitor) {
843 DBG("Metadata channel in no monitor");
844 ret = 0;
845 goto end;
d88aee68
DG
846 }
847
848 /*
849 * Send metadata stream to relayd if one available. Availability is
850 * known if the stream is still in the list of the channel.
851 */
852 if (cds_list_empty(&metadata->streams.head)) {
853 ERR("Metadata channel key %" PRIu64 ", no stream available.", key);
854 ret = LTTCOMM_CONSUMERD_ERROR_METADATA;
f5a0c9cf 855 goto error_no_stream;
d88aee68
DG
856 }
857
858 /* Send metadata stream to relayd if needed. */
62285ea4
DG
859 if (metadata->metadata_stream->net_seq_idx != (uint64_t) -1ULL) {
860 ret = consumer_send_relayd_stream(metadata->metadata_stream,
861 metadata->pathname);
862 if (ret < 0) {
863 ret = LTTCOMM_CONSUMERD_ERROR_METADATA;
864 goto error;
865 }
601262d6
JD
866 ret = consumer_send_relayd_streams_sent(
867 metadata->metadata_stream->net_seq_idx);
868 if (ret < 0) {
869 ret = LTTCOMM_CONSUMERD_RELAYD_FAIL;
870 goto error;
871 }
d88aee68
DG
872 }
873
874 ret = send_streams_to_thread(metadata, ctx);
875 if (ret < 0) {
876 /*
877 * If we are unable to send the stream to the thread, there is
878 * a big problem so just stop everything.
879 */
880 ret = LTTCOMM_CONSUMERD_FATAL;
881 goto error;
882 }
883 /* List MUST be empty after or else it could be reused. */
884 assert(cds_list_empty(&metadata->streams.head));
885
10a50311
JD
886 ret = 0;
887 goto end;
d88aee68
DG
888
889error:
f2a444f1
DG
890 /*
891 * Delete metadata channel on error. At this point, the metadata stream can
892 * NOT be monitored by the metadata thread thus having the guarantee that
893 * the stream is still in the local stream list of the channel. This call
894 * will make sure to clean that list.
895 */
f5a0c9cf 896 consumer_stream_destroy(metadata->metadata_stream, NULL);
212d67a2
DG
897 cds_list_del(&metadata->metadata_stream->send_node);
898 metadata->metadata_stream = NULL;
f5a0c9cf 899error_no_stream:
10a50311
JD
900end:
901 return ret;
902}
903
904/*
905 * Snapshot the whole metadata.
906 *
907 * Returns 0 on success, < 0 on error
908 */
909static int snapshot_metadata(uint64_t key, char *path, uint64_t relayd_id,
910 struct lttng_consumer_local_data *ctx)
911{
912 int ret = 0;
10a50311
JD
913 struct lttng_consumer_channel *metadata_channel;
914 struct lttng_consumer_stream *metadata_stream;
915
916 assert(path);
917 assert(ctx);
918
919 DBG("UST consumer snapshot metadata with key %" PRIu64 " at path %s",
920 key, path);
921
922 rcu_read_lock();
923
924 metadata_channel = consumer_find_channel(key);
925 if (!metadata_channel) {
6a00837f
MD
926 ERR("UST snapshot metadata channel not found for key %" PRIu64,
927 key);
10a50311
JD
928 ret = -1;
929 goto error;
930 }
931 assert(!metadata_channel->monitor);
932
9ce5646a
MD
933 health_code_update();
934
10a50311
JD
935 /*
936 * Ask the sessiond if we have new metadata waiting and update the
937 * consumer metadata cache.
938 */
94d49140 939 ret = lttng_ustconsumer_request_metadata(ctx, metadata_channel, 0, 1);
10a50311
JD
940 if (ret < 0) {
941 goto error;
942 }
943
9ce5646a
MD
944 health_code_update();
945
10a50311
JD
946 /*
947 * The metadata stream is NOT created in no monitor mode when the channel
948 * is created on a sessiond ask channel command.
949 */
950 ret = create_ust_streams(metadata_channel, ctx);
951 if (ret < 0) {
952 goto error;
953 }
954
955 metadata_stream = metadata_channel->metadata_stream;
956 assert(metadata_stream);
957
958 if (relayd_id != (uint64_t) -1ULL) {
959 metadata_stream->net_seq_idx = relayd_id;
960 ret = consumer_send_relayd_stream(metadata_stream, path);
961 if (ret < 0) {
962 goto error_stream;
963 }
964 } else {
965 ret = utils_create_stream_file(path, metadata_stream->name,
966 metadata_stream->chan->tracefile_size,
967 metadata_stream->tracefile_count_current,
309167d2 968 metadata_stream->uid, metadata_stream->gid, NULL);
10a50311
JD
969 if (ret < 0) {
970 goto error_stream;
971 }
972 metadata_stream->out_fd = ret;
973 metadata_stream->tracefile_size_current = 0;
974 }
975
04ef1097 976 do {
9ce5646a
MD
977 health_code_update();
978
10a50311
JD
979 ret = lttng_consumer_read_subbuffer(metadata_stream, ctx);
980 if (ret < 0) {
94d49140 981 goto error_stream;
10a50311 982 }
04ef1097 983 } while (ret > 0);
10a50311 984
10a50311
JD
985error_stream:
986 /*
987 * Clean up the stream completly because the next snapshot will use a new
988 * metadata stream.
989 */
10a50311 990 consumer_stream_destroy(metadata_stream, NULL);
212d67a2 991 cds_list_del(&metadata_stream->send_node);
10a50311
JD
992 metadata_channel->metadata_stream = NULL;
993
994error:
995 rcu_read_unlock();
996 return ret;
997}
998
999/*
1000 * Take a snapshot of all the stream of a channel.
1001 *
1002 * Returns 0 on success, < 0 on error
1003 */
1004static int snapshot_channel(uint64_t key, char *path, uint64_t relayd_id,
d07ceecd 1005 uint64_t nb_packets_per_stream, struct lttng_consumer_local_data *ctx)
10a50311
JD
1006{
1007 int ret;
1008 unsigned use_relayd = 0;
1009 unsigned long consumed_pos, produced_pos;
1010 struct lttng_consumer_channel *channel;
1011 struct lttng_consumer_stream *stream;
1012
1013 assert(path);
1014 assert(ctx);
1015
1016 rcu_read_lock();
1017
1018 if (relayd_id != (uint64_t) -1ULL) {
1019 use_relayd = 1;
1020 }
1021
1022 channel = consumer_find_channel(key);
1023 if (!channel) {
6a00837f 1024 ERR("UST snapshot channel not found for key %" PRIu64, key);
10a50311
JD
1025 ret = -1;
1026 goto error;
1027 }
1028 assert(!channel->monitor);
6a00837f 1029 DBG("UST consumer snapshot channel %" PRIu64, key);
10a50311
JD
1030
1031 cds_list_for_each_entry(stream, &channel->streams.head, send_node) {
9ce5646a
MD
1032
1033 health_code_update();
1034
10a50311
JD
1035 /* Lock stream because we are about to change its state. */
1036 pthread_mutex_lock(&stream->lock);
1037 stream->net_seq_idx = relayd_id;
1038
1039 if (use_relayd) {
1040 ret = consumer_send_relayd_stream(stream, path);
1041 if (ret < 0) {
1042 goto error_unlock;
1043 }
1044 } else {
1045 ret = utils_create_stream_file(path, stream->name,
1046 stream->chan->tracefile_size,
1047 stream->tracefile_count_current,
309167d2 1048 stream->uid, stream->gid, NULL);
10a50311
JD
1049 if (ret < 0) {
1050 goto error_unlock;
1051 }
1052 stream->out_fd = ret;
1053 stream->tracefile_size_current = 0;
1054
1055 DBG("UST consumer snapshot stream %s/%s (%" PRIu64 ")", path,
1056 stream->name, stream->key);
1057 }
a4baae1b
JD
1058 if (relayd_id != -1ULL) {
1059 ret = consumer_send_relayd_streams_sent(relayd_id);
1060 if (ret < 0) {
1061 goto error_unlock;
1062 }
1063 }
10a50311
JD
1064
1065 ustctl_flush_buffer(stream->ustream, 1);
1066
1067 ret = lttng_ustconsumer_take_snapshot(stream);
1068 if (ret < 0) {
1069 ERR("Taking UST snapshot");
1070 goto error_unlock;
1071 }
1072
1073 ret = lttng_ustconsumer_get_produced_snapshot(stream, &produced_pos);
1074 if (ret < 0) {
1075 ERR("Produced UST snapshot position");
1076 goto error_unlock;
1077 }
1078
1079 ret = lttng_ustconsumer_get_consumed_snapshot(stream, &consumed_pos);
1080 if (ret < 0) {
1081 ERR("Consumerd UST snapshot position");
1082 goto error_unlock;
1083 }
1084
5c786ded
JD
1085 /*
1086 * The original value is sent back if max stream size is larger than
d07ceecd 1087 * the possible size of the snapshot. Also, we assume that the session
5c786ded
JD
1088 * daemon should never send a maximum stream size that is lower than
1089 * subbuffer size.
1090 */
d07ceecd
MD
1091 consumed_pos = consumer_get_consume_start_pos(consumed_pos,
1092 produced_pos, nb_packets_per_stream,
1093 stream->max_sb_size);
5c786ded 1094
10a50311
JD
1095 while (consumed_pos < produced_pos) {
1096 ssize_t read_len;
1097 unsigned long len, padded_len;
1098
9ce5646a
MD
1099 health_code_update();
1100
10a50311
JD
1101 DBG("UST consumer taking snapshot at pos %lu", consumed_pos);
1102
1103 ret = ustctl_get_subbuf(stream->ustream, &consumed_pos);
1104 if (ret < 0) {
1105 if (ret != -EAGAIN) {
1106 PERROR("ustctl_get_subbuf snapshot");
1107 goto error_close_stream;
1108 }
1109 DBG("UST consumer get subbuf failed. Skipping it.");
1110 consumed_pos += stream->max_sb_size;
1111 continue;
1112 }
1113
1114 ret = ustctl_get_subbuf_size(stream->ustream, &len);
1115 if (ret < 0) {
1116 ERR("Snapshot ustctl_get_subbuf_size");
1117 goto error_put_subbuf;
1118 }
1119
1120 ret = ustctl_get_padded_subbuf_size(stream->ustream, &padded_len);
1121 if (ret < 0) {
1122 ERR("Snapshot ustctl_get_padded_subbuf_size");
1123 goto error_put_subbuf;
1124 }
1125
1126 read_len = lttng_consumer_on_read_subbuffer_mmap(ctx, stream, len,
309167d2 1127 padded_len - len, NULL);
10a50311
JD
1128 if (use_relayd) {
1129 if (read_len != len) {
56591bac 1130 ret = -EPERM;
10a50311
JD
1131 goto error_put_subbuf;
1132 }
1133 } else {
1134 if (read_len != padded_len) {
56591bac 1135 ret = -EPERM;
10a50311
JD
1136 goto error_put_subbuf;
1137 }
1138 }
1139
1140 ret = ustctl_put_subbuf(stream->ustream);
1141 if (ret < 0) {
1142 ERR("Snapshot ustctl_put_subbuf");
1143 goto error_close_stream;
1144 }
1145 consumed_pos += stream->max_sb_size;
1146 }
1147
1148 /* Simply close the stream so we can use it on the next snapshot. */
1149 consumer_stream_close(stream);
1150 pthread_mutex_unlock(&stream->lock);
1151 }
1152
1153 rcu_read_unlock();
1154 return 0;
1155
1156error_put_subbuf:
1157 if (ustctl_put_subbuf(stream->ustream) < 0) {
1158 ERR("Snapshot ustctl_put_subbuf");
1159 }
1160error_close_stream:
1161 consumer_stream_close(stream);
1162error_unlock:
1163 pthread_mutex_unlock(&stream->lock);
1164error:
1165 rcu_read_unlock();
d88aee68
DG
1166 return ret;
1167}
1168
331744e3 1169/*
c585821b
MD
1170 * Receive the metadata updates from the sessiond. Supports receiving
1171 * overlapping metadata, but is needs to always belong to a contiguous
1172 * range starting from 0.
1173 * Be careful about the locks held when calling this function: it needs
1174 * the metadata cache flush to concurrently progress in order to
1175 * complete.
331744e3
JD
1176 */
1177int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
5e41ebe1 1178 uint64_t len, struct lttng_consumer_channel *channel,
94d49140 1179 int timer, int wait)
331744e3 1180{
0c759fc9 1181 int ret, ret_code = LTTCOMM_CONSUMERD_SUCCESS;
331744e3
JD
1182 char *metadata_str;
1183
8fd623e0 1184 DBG("UST consumer push metadata key %" PRIu64 " of len %" PRIu64, key, len);
331744e3
JD
1185
1186 metadata_str = zmalloc(len * sizeof(char));
1187 if (!metadata_str) {
1188 PERROR("zmalloc metadata string");
1189 ret_code = LTTCOMM_CONSUMERD_ENOMEM;
1190 goto end;
1191 }
1192
9ce5646a
MD
1193 health_code_update();
1194
331744e3
JD
1195 /* Receive metadata string. */
1196 ret = lttcomm_recv_unix_sock(sock, metadata_str, len);
1197 if (ret < 0) {
1198 /* Session daemon is dead so return gracefully. */
1199 ret_code = ret;
1200 goto end_free;
1201 }
1202
9ce5646a
MD
1203 health_code_update();
1204
331744e3
JD
1205 pthread_mutex_lock(&channel->metadata_cache->lock);
1206 ret = consumer_metadata_cache_write(channel, offset, len, metadata_str);
1207 if (ret < 0) {
1208 /* Unable to handle metadata. Notify session daemon. */
1209 ret_code = LTTCOMM_CONSUMERD_ERROR_METADATA;
a32bd775
DG
1210 /*
1211 * Skip metadata flush on write error since the offset and len might
1212 * not have been updated which could create an infinite loop below when
1213 * waiting for the metadata cache to be flushed.
1214 */
1215 pthread_mutex_unlock(&channel->metadata_cache->lock);
a32bd775 1216 goto end_free;
331744e3
JD
1217 }
1218 pthread_mutex_unlock(&channel->metadata_cache->lock);
1219
94d49140
JD
1220 if (!wait) {
1221 goto end_free;
1222 }
5e41ebe1 1223 while (consumer_metadata_cache_flushed(channel, offset + len, timer)) {
331744e3 1224 DBG("Waiting for metadata to be flushed");
9ce5646a
MD
1225
1226 health_code_update();
1227
331744e3
JD
1228 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME);
1229 }
1230
1231end_free:
1232 free(metadata_str);
1233end:
1234 return ret_code;
1235}
1236
4cbc1a04
DG
1237/*
1238 * Receive command from session daemon and process it.
1239 *
1240 * Return 1 on success else a negative value or 0.
1241 */
3bd1e081
MD
1242int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
1243 int sock, struct pollfd *consumer_sockpoll)
1244{
1245 ssize_t ret;
0c759fc9 1246 enum lttcomm_return_code ret_code = LTTCOMM_CONSUMERD_SUCCESS;
3bd1e081 1247 struct lttcomm_consumer_msg msg;
ffe60014 1248 struct lttng_consumer_channel *channel = NULL;
3bd1e081 1249
9ce5646a
MD
1250 health_code_update();
1251
3bd1e081
MD
1252 ret = lttcomm_recv_unix_sock(sock, &msg, sizeof(msg));
1253 if (ret != sizeof(msg)) {
173af62f
DG
1254 DBG("Consumer received unexpected message size %zd (expects %zu)",
1255 ret, sizeof(msg));
3be74084
DG
1256 /*
1257 * The ret value might 0 meaning an orderly shutdown but this is ok
1258 * since the caller handles this.
1259 */
489f70e9 1260 if (ret > 0) {
c6857fcf 1261 lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_ERROR_RECV_CMD);
489f70e9
MD
1262 ret = -1;
1263 }
3bd1e081
MD
1264 return ret;
1265 }
9ce5646a
MD
1266
1267 health_code_update();
1268
84382d49
MD
1269 /* deprecated */
1270 assert(msg.cmd_type != LTTNG_CONSUMER_STOP);
3bd1e081 1271
9ce5646a
MD
1272 health_code_update();
1273
3f8e211f 1274 /* relayd needs RCU read-side lock */
b0b335c8
MD
1275 rcu_read_lock();
1276
3bd1e081 1277 switch (msg.cmd_type) {
00e2e675
DG
1278 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET:
1279 {
f50f23d9 1280 /* Session daemon status message are handled in the following call. */
7735ef9e
DG
1281 ret = consumer_add_relayd_socket(msg.u.relayd_sock.net_index,
1282 msg.u.relayd_sock.type, ctx, sock, consumer_sockpoll,
d3e2ba59
JD
1283 &msg.u.relayd_sock.sock, msg.u.relayd_sock.session_id,
1284 msg.u.relayd_sock.relayd_session_id);
00e2e675
DG
1285 goto end_nosignal;
1286 }
173af62f
DG
1287 case LTTNG_CONSUMER_DESTROY_RELAYD:
1288 {
a6ba4fe1 1289 uint64_t index = msg.u.destroy_relayd.net_seq_idx;
173af62f
DG
1290 struct consumer_relayd_sock_pair *relayd;
1291
a6ba4fe1 1292 DBG("UST consumer destroying relayd %" PRIu64, index);
173af62f
DG
1293
1294 /* Get relayd reference if exists. */
a6ba4fe1 1295 relayd = consumer_find_relayd(index);
173af62f 1296 if (relayd == NULL) {
3448e266 1297 DBG("Unable to find relayd %" PRIu64, index);
e462382a 1298 ret_code = LTTCOMM_CONSUMERD_RELAYD_FAIL;
173af62f
DG
1299 }
1300
a6ba4fe1
DG
1301 /*
1302 * Each relayd socket pair has a refcount of stream attached to it
1303 * which tells if the relayd is still active or not depending on the
1304 * refcount value.
1305 *
1306 * This will set the destroy flag of the relayd object and destroy it
1307 * if the refcount reaches zero when called.
1308 *
1309 * The destroy can happen either here or when a stream fd hangs up.
1310 */
f50f23d9
DG
1311 if (relayd) {
1312 consumer_flag_relayd_for_destroy(relayd);
1313 }
1314
d88aee68 1315 goto end_msg_sessiond;
173af62f 1316 }
3bd1e081
MD
1317 case LTTNG_CONSUMER_UPDATE_STREAM:
1318 {
3f8e211f 1319 rcu_read_unlock();
7ad0a0cb 1320 return -ENOSYS;
3bd1e081 1321 }
6d805429 1322 case LTTNG_CONSUMER_DATA_PENDING:
53632229 1323 {
3be74084 1324 int ret, is_data_pending;
6d805429 1325 uint64_t id = msg.u.data_pending.session_id;
ca22feea 1326
6d805429 1327 DBG("UST consumer data pending command for id %" PRIu64, id);
ca22feea 1328
3be74084 1329 is_data_pending = consumer_data_pending(id);
ca22feea
DG
1330
1331 /* Send back returned value to session daemon */
3be74084
DG
1332 ret = lttcomm_send_unix_sock(sock, &is_data_pending,
1333 sizeof(is_data_pending));
ca22feea 1334 if (ret < 0) {
3be74084 1335 DBG("Error when sending the data pending ret code: %d", ret);
489f70e9 1336 goto error_fatal;
ca22feea 1337 }
f50f23d9
DG
1338
1339 /*
1340 * No need to send back a status message since the data pending
1341 * returned value is the response.
1342 */
ca22feea 1343 break;
53632229 1344 }
ffe60014
DG
1345 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION:
1346 {
1347 int ret;
1348 struct ustctl_consumer_channel_attr attr;
1349
1350 /* Create a plain object and reserve a channel key. */
1351 channel = allocate_channel(msg.u.ask_channel.session_id,
1352 msg.u.ask_channel.pathname, msg.u.ask_channel.name,
1353 msg.u.ask_channel.uid, msg.u.ask_channel.gid,
1354 msg.u.ask_channel.relayd_id, msg.u.ask_channel.key,
1624d5b7
JD
1355 (enum lttng_event_output) msg.u.ask_channel.output,
1356 msg.u.ask_channel.tracefile_size,
2bba9e53 1357 msg.u.ask_channel.tracefile_count,
1950109e 1358 msg.u.ask_channel.session_id_per_pid,
ecc48a90 1359 msg.u.ask_channel.monitor,
d7ba1388 1360 msg.u.ask_channel.live_timer_interval,
3d071855 1361 msg.u.ask_channel.root_shm_path,
d7ba1388 1362 msg.u.ask_channel.shm_path);
ffe60014
DG
1363 if (!channel) {
1364 goto end_channel_error;
1365 }
1366
567eb353
DG
1367 /*
1368 * Assign UST application UID to the channel. This value is ignored for
1369 * per PID buffers. This is specific to UST thus setting this after the
1370 * allocation.
1371 */
1372 channel->ust_app_uid = msg.u.ask_channel.ust_app_uid;
1373
ffe60014
DG
1374 /* Build channel attributes from received message. */
1375 attr.subbuf_size = msg.u.ask_channel.subbuf_size;
1376 attr.num_subbuf = msg.u.ask_channel.num_subbuf;
1377 attr.overwrite = msg.u.ask_channel.overwrite;
1378 attr.switch_timer_interval = msg.u.ask_channel.switch_timer_interval;
1379 attr.read_timer_interval = msg.u.ask_channel.read_timer_interval;
7972aab2 1380 attr.chan_id = msg.u.ask_channel.chan_id;
ffe60014
DG
1381 memcpy(attr.uuid, msg.u.ask_channel.uuid, sizeof(attr.uuid));
1382
0c759fc9
DG
1383 /* Match channel buffer type to the UST abi. */
1384 switch (msg.u.ask_channel.output) {
1385 case LTTNG_EVENT_MMAP:
1386 default:
1387 attr.output = LTTNG_UST_MMAP;
1388 break;
1389 }
1390
ffe60014
DG
1391 /* Translate and save channel type. */
1392 switch (msg.u.ask_channel.type) {
1393 case LTTNG_UST_CHAN_PER_CPU:
1394 channel->type = CONSUMER_CHANNEL_TYPE_DATA;
1395 attr.type = LTTNG_UST_CHAN_PER_CPU;
8633d6e3
MD
1396 /*
1397 * Set refcount to 1 for owner. Below, we will
1398 * pass ownership to the
1399 * consumer_thread_channel_poll() thread.
1400 */
1401 channel->refcount = 1;
ffe60014
DG
1402 break;
1403 case LTTNG_UST_CHAN_METADATA:
1404 channel->type = CONSUMER_CHANNEL_TYPE_METADATA;
1405 attr.type = LTTNG_UST_CHAN_METADATA;
1406 break;
1407 default:
1408 assert(0);
1409 goto error_fatal;
1410 };
1411
9ce5646a
MD
1412 health_code_update();
1413
ffe60014
DG
1414 ret = ask_channel(ctx, sock, channel, &attr);
1415 if (ret < 0) {
1416 goto end_channel_error;
1417 }
1418
fc643247
MD
1419 if (msg.u.ask_channel.type == LTTNG_UST_CHAN_METADATA) {
1420 ret = consumer_metadata_cache_allocate(channel);
1421 if (ret < 0) {
1422 ERR("Allocating metadata cache");
1423 goto end_channel_error;
1424 }
1425 consumer_timer_switch_start(channel, attr.switch_timer_interval);
1426 attr.switch_timer_interval = 0;
94d49140
JD
1427 } else {
1428 consumer_timer_live_start(channel,
1429 msg.u.ask_channel.live_timer_interval);
fc643247
MD
1430 }
1431
9ce5646a
MD
1432 health_code_update();
1433
ffe60014
DG
1434 /*
1435 * Add the channel to the internal state AFTER all streams were created
1436 * and successfully sent to session daemon. This way, all streams must
1437 * be ready before this channel is visible to the threads.
fc643247
MD
1438 * If add_channel succeeds, ownership of the channel is
1439 * passed to consumer_thread_channel_poll().
ffe60014
DG
1440 */
1441 ret = add_channel(channel, ctx);
1442 if (ret < 0) {
ea88ca2a
MD
1443 if (msg.u.ask_channel.type == LTTNG_UST_CHAN_METADATA) {
1444 if (channel->switch_timer_enabled == 1) {
1445 consumer_timer_switch_stop(channel);
1446 }
1447 consumer_metadata_cache_destroy(channel);
1448 }
d3e2ba59
JD
1449 if (channel->live_timer_enabled == 1) {
1450 consumer_timer_live_stop(channel);
1451 }
ffe60014
DG
1452 goto end_channel_error;
1453 }
1454
9ce5646a
MD
1455 health_code_update();
1456
ffe60014
DG
1457 /*
1458 * Channel and streams are now created. Inform the session daemon that
1459 * everything went well and should wait to receive the channel and
1460 * streams with ustctl API.
1461 */
1462 ret = consumer_send_status_channel(sock, channel);
1463 if (ret < 0) {
1464 /*
489f70e9 1465 * There is probably a problem on the socket.
ffe60014 1466 */
489f70e9 1467 goto error_fatal;
ffe60014
DG
1468 }
1469
1470 break;
1471 }
1472 case LTTNG_CONSUMER_GET_CHANNEL:
1473 {
1474 int ret, relayd_err = 0;
d88aee68 1475 uint64_t key = msg.u.get_channel.key;
ffe60014 1476 struct lttng_consumer_channel *channel;
ffe60014
DG
1477
1478 channel = consumer_find_channel(key);
1479 if (!channel) {
8fd623e0 1480 ERR("UST consumer get channel key %" PRIu64 " not found", key);
e462382a 1481 ret_code = LTTCOMM_CONSUMERD_CHAN_NOT_FOUND;
ffe60014
DG
1482 goto end_msg_sessiond;
1483 }
1484
9ce5646a
MD
1485 health_code_update();
1486
ffe60014
DG
1487 /* Send everything to sessiond. */
1488 ret = send_sessiond_channel(sock, channel, ctx, &relayd_err);
1489 if (ret < 0) {
1490 if (relayd_err) {
1491 /*
1492 * We were unable to send to the relayd the stream so avoid
1493 * sending back a fatal error to the thread since this is OK
f2a444f1
DG
1494 * and the consumer can continue its work. The above call
1495 * has sent the error status message to the sessiond.
ffe60014 1496 */
f2a444f1 1497 goto end_nosignal;
ffe60014
DG
1498 }
1499 /*
1500 * The communicaton was broken hence there is a bad state between
1501 * the consumer and sessiond so stop everything.
1502 */
1503 goto error_fatal;
1504 }
1505
9ce5646a
MD
1506 health_code_update();
1507
10a50311
JD
1508 /*
1509 * In no monitor mode, the streams ownership is kept inside the channel
1510 * so don't send them to the data thread.
1511 */
1512 if (!channel->monitor) {
1513 goto end_msg_sessiond;
1514 }
1515
d88aee68
DG
1516 ret = send_streams_to_thread(channel, ctx);
1517 if (ret < 0) {
1518 /*
1519 * If we are unable to send the stream to the thread, there is
1520 * a big problem so just stop everything.
1521 */
1522 goto error_fatal;
ffe60014 1523 }
ffe60014
DG
1524 /* List MUST be empty after or else it could be reused. */
1525 assert(cds_list_empty(&channel->streams.head));
d88aee68
DG
1526 goto end_msg_sessiond;
1527 }
1528 case LTTNG_CONSUMER_DESTROY_CHANNEL:
1529 {
1530 uint64_t key = msg.u.destroy_channel.key;
d88aee68 1531
a0cbdd2e
MD
1532 /*
1533 * Only called if streams have not been sent to stream
1534 * manager thread. However, channel has been sent to
1535 * channel manager thread.
1536 */
1537 notify_thread_del_channel(ctx, key);
d88aee68 1538 goto end_msg_sessiond;
ffe60014 1539 }
d88aee68
DG
1540 case LTTNG_CONSUMER_CLOSE_METADATA:
1541 {
1542 int ret;
1543
1544 ret = close_metadata(msg.u.close_metadata.key);
1545 if (ret != 0) {
1546 ret_code = ret;
1547 }
1548
1549 goto end_msg_sessiond;
1550 }
7972aab2
DG
1551 case LTTNG_CONSUMER_FLUSH_CHANNEL:
1552 {
1553 int ret;
1554
1555 ret = flush_channel(msg.u.flush_channel.key);
1556 if (ret != 0) {
1557 ret_code = ret;
1558 }
1559
1560 goto end_msg_sessiond;
1561 }
d88aee68 1562 case LTTNG_CONSUMER_PUSH_METADATA:
ffe60014
DG
1563 {
1564 int ret;
d88aee68 1565 uint64_t len = msg.u.push_metadata.len;
d88aee68 1566 uint64_t key = msg.u.push_metadata.key;
331744e3 1567 uint64_t offset = msg.u.push_metadata.target_offset;
ffe60014
DG
1568 struct lttng_consumer_channel *channel;
1569
8fd623e0
DG
1570 DBG("UST consumer push metadata key %" PRIu64 " of len %" PRIu64, key,
1571 len);
ffe60014
DG
1572
1573 channel = consumer_find_channel(key);
1574 if (!channel) {
000baf6a
DG
1575 /*
1576 * This is possible if the metadata creation on the consumer side
1577 * is in flight vis-a-vis a concurrent push metadata from the
1578 * session daemon. Simply return that the channel failed and the
1579 * session daemon will handle that message correctly considering
1580 * that this race is acceptable thus the DBG() statement here.
1581 */
1582 DBG("UST consumer push metadata %" PRIu64 " not found", key);
1583 ret_code = LTTCOMM_CONSUMERD_CHANNEL_FAIL;
4a2eb0ca 1584 goto end_msg_sessiond;
d88aee68
DG
1585 }
1586
9ce5646a
MD
1587 health_code_update();
1588
c585821b
MD
1589 if (!len) {
1590 /*
1591 * There is nothing to receive. We have simply
1592 * checked whether the channel can be found.
1593 */
1594 ret_code = LTTCOMM_CONSUMERD_SUCCESS;
1595 goto end_msg_sessiond;
1596 }
1597
d88aee68 1598 /* Tell session daemon we are ready to receive the metadata. */
0c759fc9 1599 ret = consumer_send_status_msg(sock, LTTCOMM_CONSUMERD_SUCCESS);
ffe60014
DG
1600 if (ret < 0) {
1601 /* Somehow, the session daemon is not responding anymore. */
d88aee68
DG
1602 goto error_fatal;
1603 }
1604
9ce5646a
MD
1605 health_code_update();
1606
d88aee68 1607 /* Wait for more data. */
9ce5646a
MD
1608 health_poll_entry();
1609 ret = lttng_consumer_poll_socket(consumer_sockpoll);
1610 health_poll_exit();
84382d49 1611 if (ret) {
489f70e9 1612 goto error_fatal;
d88aee68
DG
1613 }
1614
9ce5646a
MD
1615 health_code_update();
1616
331744e3 1617 ret = lttng_ustconsumer_recv_metadata(sock, key, offset,
94d49140 1618 len, channel, 0, 1);
d88aee68 1619 if (ret < 0) {
331744e3 1620 /* error receiving from sessiond */
489f70e9 1621 goto error_fatal;
331744e3
JD
1622 } else {
1623 ret_code = ret;
d88aee68
DG
1624 goto end_msg_sessiond;
1625 }
d88aee68
DG
1626 }
1627 case LTTNG_CONSUMER_SETUP_METADATA:
1628 {
1629 int ret;
1630
1631 ret = setup_metadata(ctx, msg.u.setup_metadata.key);
1632 if (ret) {
1633 ret_code = ret;
1634 }
1635 goto end_msg_sessiond;
ffe60014 1636 }
6dc3064a
DG
1637 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL:
1638 {
10a50311
JD
1639 if (msg.u.snapshot_channel.metadata) {
1640 ret = snapshot_metadata(msg.u.snapshot_channel.key,
1641 msg.u.snapshot_channel.pathname,
1642 msg.u.snapshot_channel.relayd_id,
1643 ctx);
1644 if (ret < 0) {
1645 ERR("Snapshot metadata failed");
e462382a 1646 ret_code = LTTCOMM_CONSUMERD_ERROR_METADATA;
10a50311
JD
1647 }
1648 } else {
1649 ret = snapshot_channel(msg.u.snapshot_channel.key,
1650 msg.u.snapshot_channel.pathname,
1651 msg.u.snapshot_channel.relayd_id,
d07ceecd 1652 msg.u.snapshot_channel.nb_packets_per_stream,
10a50311
JD
1653 ctx);
1654 if (ret < 0) {
1655 ERR("Snapshot channel failed");
e462382a 1656 ret_code = LTTCOMM_CONSUMERD_CHANNEL_FAIL;
10a50311
JD
1657 }
1658 }
1659
9ce5646a 1660 health_code_update();
6dc3064a
DG
1661 ret = consumer_send_status_msg(sock, ret_code);
1662 if (ret < 0) {
1663 /* Somehow, the session daemon is not responding anymore. */
1664 goto end_nosignal;
1665 }
9ce5646a 1666 health_code_update();
6dc3064a
DG
1667 break;
1668 }
fb83fe64
JD
1669 case LTTNG_CONSUMER_DISCARDED_EVENTS:
1670 {
1671 uint64_t ret;
1672 struct lttng_ht_iter iter;
1673 struct lttng_ht *ht;
1674 struct lttng_consumer_stream *stream;
1675 uint64_t id = msg.u.discarded_events.session_id;
1676 uint64_t key = msg.u.discarded_events.channel_key;
1677
1678 DBG("UST consumer discarded events command for session id %"
1679 PRIu64, id);
1680 rcu_read_lock();
1681 pthread_mutex_lock(&consumer_data.lock);
1682
1683 ht = consumer_data.stream_list_ht;
1684
1685 /*
1686 * We only need a reference to the channel, but they are not
1687 * directly indexed, so we just use the first matching stream
1688 * to extract the information we need, we default to 0 if not
1689 * found (no events are dropped if the channel is not yet in
1690 * use).
1691 */
1692 ret = 0;
1693 cds_lfht_for_each_entry_duplicate(ht->ht,
1694 ht->hash_fct(&id, lttng_ht_seed),
1695 ht->match_fct, &id,
1696 &iter.iter, stream, node_session_id.node) {
1697 if (stream->chan->key == key) {
1698 ret = stream->chan->discarded_events;
1699 break;
1700 }
1701 }
1702 pthread_mutex_unlock(&consumer_data.lock);
1703 rcu_read_unlock();
1704
1705 DBG("UST consumer discarded events command for session id %"
1706 PRIu64 ", channel key %" PRIu64, id, key);
1707
1708 health_code_update();
1709
1710 /* Send back returned value to session daemon */
1711 ret = lttcomm_send_unix_sock(sock, &ret, sizeof(ret));
1712 if (ret < 0) {
1713 PERROR("send discarded events");
1714 goto error_fatal;
1715 }
1716
1717 break;
1718 }
1719 case LTTNG_CONSUMER_LOST_PACKETS:
1720 {
1721 uint64_t ret;
1722 struct lttng_ht_iter iter;
1723 struct lttng_ht *ht;
1724 struct lttng_consumer_stream *stream;
1725 uint64_t id = msg.u.lost_packets.session_id;
1726 uint64_t key = msg.u.lost_packets.channel_key;
1727
1728 DBG("UST consumer lost packets command for session id %"
1729 PRIu64, id);
1730 rcu_read_lock();
1731 pthread_mutex_lock(&consumer_data.lock);
1732
1733 ht = consumer_data.stream_list_ht;
1734
1735 /*
1736 * We only need a reference to the channel, but they are not
1737 * directly indexed, so we just use the first matching stream
1738 * to extract the information we need, we default to 0 if not
1739 * found (no packets lost if the channel is not yet in use).
1740 */
1741 ret = 0;
1742 cds_lfht_for_each_entry_duplicate(ht->ht,
1743 ht->hash_fct(&id, lttng_ht_seed),
1744 ht->match_fct, &id,
1745 &iter.iter, stream, node_session_id.node) {
1746 if (stream->chan->key == key) {
1747 ret = stream->chan->lost_packets;
1748 break;
1749 }
1750 }
1751 pthread_mutex_unlock(&consumer_data.lock);
1752 rcu_read_unlock();
1753
1754 DBG("UST consumer lost packets command for session id %"
1755 PRIu64 ", channel key %" PRIu64, id, key);
1756
1757 health_code_update();
1758
1759 /* Send back returned value to session daemon */
1760 ret = lttcomm_send_unix_sock(sock, &ret, sizeof(ret));
1761 if (ret < 0) {
1762 PERROR("send lost packets");
1763 goto error_fatal;
1764 }
1765
1766 break;
1767 }
3bd1e081
MD
1768 default:
1769 break;
1770 }
3f8e211f 1771
3bd1e081 1772end_nosignal:
b0b335c8 1773 rcu_read_unlock();
4cbc1a04 1774
9ce5646a
MD
1775 health_code_update();
1776
4cbc1a04
DG
1777 /*
1778 * Return 1 to indicate success since the 0 value can be a socket
1779 * shutdown during the recv() or send() call.
1780 */
1781 return 1;
ffe60014
DG
1782
1783end_msg_sessiond:
1784 /*
1785 * The returned value here is not useful since either way we'll return 1 to
1786 * the caller because the session daemon socket management is done
1787 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1788 */
489f70e9
MD
1789 ret = consumer_send_status_msg(sock, ret_code);
1790 if (ret < 0) {
1791 goto error_fatal;
1792 }
ffe60014 1793 rcu_read_unlock();
9ce5646a
MD
1794
1795 health_code_update();
1796
ffe60014
DG
1797 return 1;
1798end_channel_error:
1799 if (channel) {
1800 /*
1801 * Free channel here since no one has a reference to it. We don't
1802 * free after that because a stream can store this pointer.
1803 */
1804 destroy_channel(channel);
1805 }
1806 /* We have to send a status channel message indicating an error. */
1807 ret = consumer_send_status_channel(sock, NULL);
1808 if (ret < 0) {
1809 /* Stop everything if session daemon can not be notified. */
1810 goto error_fatal;
1811 }
1812 rcu_read_unlock();
9ce5646a
MD
1813
1814 health_code_update();
1815
ffe60014
DG
1816 return 1;
1817error_fatal:
1818 rcu_read_unlock();
1819 /* This will issue a consumer stop. */
1820 return -1;
3bd1e081
MD
1821}
1822
ffe60014
DG
1823/*
1824 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1825 * compiled out, we isolate it in this library.
1826 */
1827int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
1828 unsigned long *off)
3bd1e081 1829{
ffe60014
DG
1830 assert(stream);
1831 assert(stream->ustream);
b5c5fc29 1832
ffe60014 1833 return ustctl_get_mmap_read_offset(stream->ustream, off);
3bd1e081
MD
1834}
1835
ffe60014
DG
1836/*
1837 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1838 * compiled out, we isolate it in this library.
1839 */
1840void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream *stream)
d056b477 1841{
ffe60014
DG
1842 assert(stream);
1843 assert(stream->ustream);
1844
1845 return ustctl_get_mmap_base(stream->ustream);
d056b477
MD
1846}
1847
ffe60014
DG
1848/*
1849 * Take a snapshot for a specific fd
1850 *
1851 * Returns 0 on success, < 0 on error
1852 */
1853int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
3bd1e081 1854{
ffe60014
DG
1855 assert(stream);
1856 assert(stream->ustream);
1857
1858 return ustctl_snapshot(stream->ustream);
3bd1e081
MD
1859}
1860
ffe60014
DG
1861/*
1862 * Get the produced position
1863 *
1864 * Returns 0 on success, < 0 on error
1865 */
1866int lttng_ustconsumer_get_produced_snapshot(
1867 struct lttng_consumer_stream *stream, unsigned long *pos)
3bd1e081 1868{
ffe60014
DG
1869 assert(stream);
1870 assert(stream->ustream);
1871 assert(pos);
7a57cf92 1872
ffe60014
DG
1873 return ustctl_snapshot_get_produced(stream->ustream, pos);
1874}
7a57cf92 1875
10a50311
JD
1876/*
1877 * Get the consumed position
1878 *
1879 * Returns 0 on success, < 0 on error
1880 */
1881int lttng_ustconsumer_get_consumed_snapshot(
1882 struct lttng_consumer_stream *stream, unsigned long *pos)
1883{
1884 assert(stream);
1885 assert(stream->ustream);
1886 assert(pos);
1887
1888 return ustctl_snapshot_get_consumed(stream->ustream, pos);
1889}
1890
84a182ce
DG
1891void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
1892 int producer)
1893{
1894 assert(stream);
1895 assert(stream->ustream);
1896
1897 ustctl_flush_buffer(stream->ustream, producer);
1898}
1899
1900int lttng_ustconsumer_get_current_timestamp(
1901 struct lttng_consumer_stream *stream, uint64_t *ts)
1902{
1903 assert(stream);
1904 assert(stream->ustream);
1905 assert(ts);
1906
1907 return ustctl_get_current_timestamp(stream->ustream, ts);
1908}
1909
fb83fe64
JD
1910int lttng_ustconsumer_get_sequence_number(
1911 struct lttng_consumer_stream *stream, uint64_t *seq)
1912{
1913 assert(stream);
1914 assert(stream->ustream);
1915 assert(seq);
1916
1917 return ustctl_get_sequence_number(stream->ustream, seq);
1918}
1919
ffe60014
DG
1920/*
1921 * Called when the stream signal the consumer that it has hang up.
1922 */
1923void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
1924{
1925 assert(stream);
1926 assert(stream->ustream);
2c1dd183 1927
ffe60014
DG
1928 ustctl_flush_buffer(stream->ustream, 0);
1929 stream->hangup_flush_done = 1;
1930}
ee77a7b0 1931
ffe60014
DG
1932void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
1933{
4628484a
MD
1934 int i;
1935
ffe60014
DG
1936 assert(chan);
1937 assert(chan->uchan);
e316aad5 1938
ea88ca2a
MD
1939 if (chan->switch_timer_enabled == 1) {
1940 consumer_timer_switch_stop(chan);
1941 }
4628484a
MD
1942 for (i = 0; i < chan->nr_stream_fds; i++) {
1943 int ret;
1944
1945 ret = close(chan->stream_fds[i]);
1946 if (ret) {
1947 PERROR("close");
1948 }
1949 if (chan->shm_path[0]) {
1950 char shm_path[PATH_MAX];
1951
1952 ret = get_stream_shm_path(shm_path, chan->shm_path, i);
1953 if (ret) {
1954 ERR("Cannot get stream shm path");
1955 }
1956 ret = run_as_unlink(shm_path, chan->uid, chan->gid);
1957 if (ret) {
4628484a
MD
1958 PERROR("unlink %s", shm_path);
1959 }
1960 }
1961 }
3d071855
MD
1962 /* Try to rmdir all directories under shm_path root. */
1963 if (chan->root_shm_path[0]) {
4628484a
MD
1964 (void) run_as_recursive_rmdir(chan->root_shm_path,
1965 chan->uid, chan->gid);
3d071855 1966 }
3bd1e081
MD
1967}
1968
b83e03c4
MD
1969void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan)
1970{
1971 assert(chan);
1972 assert(chan->uchan);
1973
1974 consumer_metadata_cache_destroy(chan);
1975 ustctl_destroy_channel(chan->uchan);
1976 free(chan->stream_fds);
1977}
1978
3bd1e081
MD
1979void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
1980{
ffe60014
DG
1981 assert(stream);
1982 assert(stream->ustream);
d41f73b7 1983
ea88ca2a
MD
1984 if (stream->chan->switch_timer_enabled == 1) {
1985 consumer_timer_switch_stop(stream->chan);
1986 }
ffe60014
DG
1987 ustctl_destroy_stream(stream->ustream);
1988}
d41f73b7 1989
6d574024
DG
1990int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream *stream)
1991{
1992 assert(stream);
1993 assert(stream->ustream);
1994
1995 return ustctl_stream_get_wakeup_fd(stream->ustream);
1996}
1997
1998int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream *stream)
1999{
2000 assert(stream);
2001 assert(stream->ustream);
2002
2003 return ustctl_stream_close_wakeup_fd(stream->ustream);
2004}
2005
309167d2
JD
2006/*
2007 * Populate index values of a UST stream. Values are set in big endian order.
2008 *
2009 * Return 0 on success or else a negative value.
2010 */
50adc264 2011static int get_index_values(struct ctf_packet_index *index,
309167d2
JD
2012 struct ustctl_consumer_stream *ustream)
2013{
2014 int ret;
2015
2016 ret = ustctl_get_timestamp_begin(ustream, &index->timestamp_begin);
2017 if (ret < 0) {
2018 PERROR("ustctl_get_timestamp_begin");
2019 goto error;
2020 }
2021 index->timestamp_begin = htobe64(index->timestamp_begin);
2022
2023 ret = ustctl_get_timestamp_end(ustream, &index->timestamp_end);
2024 if (ret < 0) {
2025 PERROR("ustctl_get_timestamp_end");
2026 goto error;
2027 }
2028 index->timestamp_end = htobe64(index->timestamp_end);
2029
2030 ret = ustctl_get_events_discarded(ustream, &index->events_discarded);
2031 if (ret < 0) {
2032 PERROR("ustctl_get_events_discarded");
2033 goto error;
2034 }
2035 index->events_discarded = htobe64(index->events_discarded);
2036
2037 ret = ustctl_get_content_size(ustream, &index->content_size);
2038 if (ret < 0) {
2039 PERROR("ustctl_get_content_size");
2040 goto error;
2041 }
2042 index->content_size = htobe64(index->content_size);
2043
2044 ret = ustctl_get_packet_size(ustream, &index->packet_size);
2045 if (ret < 0) {
2046 PERROR("ustctl_get_packet_size");
2047 goto error;
2048 }
2049 index->packet_size = htobe64(index->packet_size);
2050
2051 ret = ustctl_get_stream_id(ustream, &index->stream_id);
2052 if (ret < 0) {
2053 PERROR("ustctl_get_stream_id");
2054 goto error;
2055 }
2056 index->stream_id = htobe64(index->stream_id);
2057
2058error:
2059 return ret;
2060}
2061
94d49140
JD
2062/*
2063 * Write up to one packet from the metadata cache to the channel.
2064 *
2065 * Returns the number of bytes pushed in the cache, or a negative value
2066 * on error.
2067 */
2068static
2069int commit_one_metadata_packet(struct lttng_consumer_stream *stream)
2070{
2071 ssize_t write_len;
2072 int ret;
2073
2074 pthread_mutex_lock(&stream->chan->metadata_cache->lock);
c585821b 2075 if (stream->chan->metadata_cache->max_offset
94d49140
JD
2076 == stream->ust_metadata_pushed) {
2077 ret = 0;
2078 goto end;
2079 }
2080
2081 write_len = ustctl_write_one_packet_to_channel(stream->chan->uchan,
2082 &stream->chan->metadata_cache->data[stream->ust_metadata_pushed],
c585821b 2083 stream->chan->metadata_cache->max_offset
94d49140
JD
2084 - stream->ust_metadata_pushed);
2085 assert(write_len != 0);
2086 if (write_len < 0) {
2087 ERR("Writing one metadata packet");
2088 ret = -1;
2089 goto end;
2090 }
2091 stream->ust_metadata_pushed += write_len;
2092
c585821b 2093 assert(stream->chan->metadata_cache->max_offset >=
94d49140
JD
2094 stream->ust_metadata_pushed);
2095 ret = write_len;
2096
2097end:
2098 pthread_mutex_unlock(&stream->chan->metadata_cache->lock);
2099 return ret;
2100}
2101
309167d2 2102
94d49140
JD
2103/*
2104 * Sync metadata meaning request them to the session daemon and snapshot to the
2105 * metadata thread can consumer them.
2106 *
c585821b
MD
2107 * Metadata stream lock is held here, but we need to release it when
2108 * interacting with sessiond, else we cause a deadlock with live
2109 * awaiting on metadata to be pushed out.
94d49140
JD
2110 *
2111 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
2112 * is empty or a negative value on error.
2113 */
2114int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
2115 struct lttng_consumer_stream *metadata)
2116{
2117 int ret;
2118 int retry = 0;
2119
2120 assert(ctx);
2121 assert(metadata);
2122
c585821b 2123 pthread_mutex_unlock(&metadata->lock);
94d49140
JD
2124 /*
2125 * Request metadata from the sessiond, but don't wait for the flush
2126 * because we locked the metadata thread.
2127 */
2128 ret = lttng_ustconsumer_request_metadata(ctx, metadata->chan, 0, 0);
2129 if (ret < 0) {
2130 goto end;
2131 }
c585821b 2132 pthread_mutex_lock(&metadata->lock);
94d49140
JD
2133
2134 ret = commit_one_metadata_packet(metadata);
2135 if (ret <= 0) {
2136 goto end;
2137 } else if (ret > 0) {
2138 retry = 1;
2139 }
2140
2141 ustctl_flush_buffer(metadata->ustream, 1);
2142 ret = ustctl_snapshot(metadata->ustream);
2143 if (ret < 0) {
2144 if (errno != EAGAIN) {
2145 ERR("Sync metadata, taking UST snapshot");
2146 goto end;
2147 }
2148 DBG("No new metadata when syncing them.");
2149 /* No new metadata, exit. */
2150 ret = ENODATA;
2151 goto end;
2152 }
2153
2154 /*
2155 * After this flush, we still need to extract metadata.
2156 */
2157 if (retry) {
2158 ret = EAGAIN;
2159 }
2160
2161end:
2162 return ret;
2163}
2164
02b3d176
DG
2165/*
2166 * Return 0 on success else a negative value.
2167 */
2168static int notify_if_more_data(struct lttng_consumer_stream *stream,
2169 struct lttng_consumer_local_data *ctx)
2170{
2171 int ret;
2172 struct ustctl_consumer_stream *ustream;
2173
2174 assert(stream);
2175 assert(ctx);
2176
2177 ustream = stream->ustream;
2178
2179 /*
2180 * First, we are going to check if there is a new subbuffer available
2181 * before reading the stream wait_fd.
2182 */
2183 /* Get the next subbuffer */
2184 ret = ustctl_get_next_subbuf(ustream);
2185 if (ret) {
2186 /* No more data found, flag the stream. */
2187 stream->has_data = 0;
2188 ret = 0;
2189 goto end;
2190 }
2191
5420e5db 2192 ret = ustctl_put_subbuf(ustream);
02b3d176
DG
2193 assert(!ret);
2194
2195 /* This stream still has data. Flag it and wake up the data thread. */
2196 stream->has_data = 1;
2197
2198 if (stream->monitor && !stream->hangup_flush_done && !ctx->has_wakeup) {
2199 ssize_t writelen;
2200
2201 writelen = lttng_pipe_write(ctx->consumer_wakeup_pipe, "!", 1);
2202 if (writelen < 0 && errno != EAGAIN && errno != EWOULDBLOCK) {
2203 ret = writelen;
2204 goto end;
2205 }
2206
2207 /* The wake up pipe has been notified. */
2208 ctx->has_wakeup = 1;
2209 }
2210 ret = 0;
2211
2212end:
2213 return ret;
2214}
2215
fb83fe64
JD
2216static
2217int update_stream_stats(struct lttng_consumer_stream *stream)
2218{
2219 int ret;
2220 uint64_t seq, discarded;
2221
2222 ret = ustctl_get_sequence_number(stream->ustream, &seq);
2223 if (ret < 0) {
2224 PERROR("ustctl_get_sequence_number");
2225 goto end;
2226 }
2227 /*
2228 * Start the sequence when we extract the first packet in case we don't
2229 * start at 0 (for example if a consumer is not connected to the
2230 * session immediately after the beginning).
2231 */
2232 if (stream->last_sequence_number == -1ULL) {
2233 stream->last_sequence_number = seq;
2234 } else if (seq > stream->last_sequence_number) {
2235 stream->chan->lost_packets += seq -
2236 stream->last_sequence_number - 1;
2237 } else {
2238 /* seq <= last_sequence_number */
2239 ERR("Sequence number inconsistent : prev = %" PRIu64
2240 ", current = %" PRIu64,
2241 stream->last_sequence_number, seq);
2242 ret = -1;
2243 goto end;
2244 }
2245 stream->last_sequence_number = seq;
2246
2247 ret = ustctl_get_events_discarded(stream->ustream, &discarded);
2248 if (ret < 0) {
2249 PERROR("kernctl_get_events_discarded");
2250 goto end;
2251 }
2252 if (discarded < stream->last_discarded_events) {
2253 /*
2254 * Overflow has occured. We assume only one wrap-around
2255 * has occured.
2256 */
2257 stream->chan->discarded_events +=
2258 (1ULL << (CAA_BITS_PER_LONG - 1)) -
2259 stream->last_discarded_events + discarded;
2260 } else {
2261 stream->chan->discarded_events += discarded -
2262 stream->last_discarded_events;
2263 }
2264 stream->last_discarded_events = discarded;
2265 ret = 0;
2266
2267end:
2268 return ret;
2269}
2270
94d49140
JD
2271/*
2272 * Read subbuffer from the given stream.
2273 *
2274 * Stream lock MUST be acquired.
2275 *
2276 * Return 0 on success else a negative value.
2277 */
d41f73b7
MD
2278int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
2279 struct lttng_consumer_local_data *ctx)
2280{
1d4dfdef 2281 unsigned long len, subbuf_size, padding;
1c20f0e2 2282 int err, write_index = 1;
d41f73b7 2283 long ret = 0;
ffe60014 2284 struct ustctl_consumer_stream *ustream;
50adc264 2285 struct ctf_packet_index index;
ffe60014
DG
2286
2287 assert(stream);
2288 assert(stream->ustream);
2289 assert(ctx);
d41f73b7 2290
3eb914c0 2291 DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream->wait_fd,
ffe60014
DG
2292 stream->name);
2293
2294 /* Ease our life for what's next. */
2295 ustream = stream->ustream;
d41f73b7 2296
6cd525e8 2297 /*
02b3d176
DG
2298 * We can consume the 1 byte written into the wait_fd by UST. Don't trigger
2299 * error if we cannot read this one byte (read returns 0), or if the error
2300 * is EAGAIN or EWOULDBLOCK.
2301 *
2302 * This is only done when the stream is monitored by a thread, before the
2303 * flush is done after a hangup and if the stream is not flagged with data
2304 * since there might be nothing to consume in the wait fd but still have
2305 * data available flagged by the consumer wake up pipe.
6cd525e8 2306 */
02b3d176
DG
2307 if (stream->monitor && !stream->hangup_flush_done && !stream->has_data) {
2308 char dummy;
c617c0c6
MD
2309 ssize_t readlen;
2310
6cd525e8
MD
2311 readlen = lttng_read(stream->wait_fd, &dummy, 1);
2312 if (readlen < 0 && errno != EAGAIN && errno != EWOULDBLOCK) {
effcf122
MD
2313 ret = readlen;
2314 goto end;
2315 }
d41f73b7
MD
2316 }
2317
04ef1097 2318retry:
d41f73b7 2319 /* Get the next subbuffer */
ffe60014 2320 err = ustctl_get_next_subbuf(ustream);
d41f73b7 2321 if (err != 0) {
04ef1097
MD
2322 /*
2323 * Populate metadata info if the existing info has
2324 * already been read.
2325 */
2326 if (stream->metadata_flag) {
94d49140
JD
2327 ret = commit_one_metadata_packet(stream);
2328 if (ret <= 0) {
04ef1097
MD
2329 goto end;
2330 }
04ef1097
MD
2331 ustctl_flush_buffer(stream->ustream, 1);
2332 goto retry;
2333 }
2334
1d4dfdef 2335 ret = err; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
d41f73b7
MD
2336 /*
2337 * This is a debug message even for single-threaded consumer,
2338 * because poll() have more relaxed criterions than get subbuf,
2339 * so get_subbuf may fail for short race windows where poll()
2340 * would issue wakeups.
2341 */
2342 DBG("Reserving sub buffer failed (everything is normal, "
ffe60014 2343 "it is due to concurrency) [ret: %d]", err);
d41f73b7
MD
2344 goto end;
2345 }
ffe60014 2346 assert(stream->chan->output == CONSUMER_CHANNEL_MMAP);
309167d2 2347
1c20f0e2 2348 if (!stream->metadata_flag) {
309167d2
JD
2349 index.offset = htobe64(stream->out_fd_offset);
2350 ret = get_index_values(&index, ustream);
2351 if (ret < 0) {
2352 goto end;
2353 }
fb83fe64
JD
2354
2355 /* Update the stream's sequence and discarded events count. */
2356 ret = update_stream_stats(stream);
2357 if (ret < 0) {
2358 PERROR("kernctl_get_events_discarded");
2359 goto end;
2360 }
1c20f0e2
JD
2361 } else {
2362 write_index = 0;
309167d2
JD
2363 }
2364
1d4dfdef 2365 /* Get the full padded subbuffer size */
ffe60014 2366 err = ustctl_get_padded_subbuf_size(ustream, &len);
effcf122 2367 assert(err == 0);
1d4dfdef
DG
2368
2369 /* Get subbuffer data size (without padding) */
ffe60014 2370 err = ustctl_get_subbuf_size(ustream, &subbuf_size);
1d4dfdef
DG
2371 assert(err == 0);
2372
2373 /* Make sure we don't get a subbuffer size bigger than the padded */
2374 assert(len >= subbuf_size);
2375
2376 padding = len - subbuf_size;
d41f73b7 2377 /* write the subbuffer to the tracefile */
309167d2 2378 ret = lttng_consumer_on_read_subbuffer_mmap(ctx, stream, subbuf_size, padding, &index);
91dfef6e
DG
2379 /*
2380 * The mmap operation should write subbuf_size amount of data when network
2381 * streaming or the full padding (len) size when we are _not_ streaming.
2382 */
d88aee68
DG
2383 if ((ret != subbuf_size && stream->net_seq_idx != (uint64_t) -1ULL) ||
2384 (ret != len && stream->net_seq_idx == (uint64_t) -1ULL)) {
d41f73b7 2385 /*
91dfef6e 2386 * Display the error but continue processing to try to release the
c5c45efa
DG
2387 * subbuffer. This is a DBG statement since any unexpected kill or
2388 * signal, the application gets unregistered, relayd gets closed or
2389 * anything that affects the buffer lifetime will trigger this error.
2390 * So, for the sake of the user, don't print this error since it can
2391 * happen and it is OK with the code flow.
d41f73b7 2392 */
c5c45efa 2393 DBG("Error writing to tracefile "
8fd623e0 2394 "(ret: %ld != len: %lu != subbuf_size: %lu)",
91dfef6e 2395 ret, len, subbuf_size);
309167d2 2396 write_index = 0;
d41f73b7 2397 }
ffe60014 2398 err = ustctl_put_next_subbuf(ustream);
effcf122 2399 assert(err == 0);
331744e3 2400
02b3d176
DG
2401 /*
2402 * This will consumer the byte on the wait_fd if and only if there is not
2403 * next subbuffer to be acquired.
2404 */
2405 if (!stream->metadata_flag) {
2406 ret = notify_if_more_data(stream, ctx);
2407 if (ret < 0) {
2408 goto end;
2409 }
2410 }
2411
309167d2 2412 /* Write index if needed. */
1c20f0e2
JD
2413 if (!write_index) {
2414 goto end;
2415 }
2416
94d49140
JD
2417 if (stream->chan->live_timer_interval && !stream->metadata_flag) {
2418 /*
2419 * In live, block until all the metadata is sent.
2420 */
c585821b
MD
2421 pthread_mutex_lock(&stream->metadata_timer_lock);
2422 assert(!stream->missed_metadata_flush);
2423 stream->waiting_on_metadata = true;
2424 pthread_mutex_unlock(&stream->metadata_timer_lock);
2425
94d49140 2426 err = consumer_stream_sync_metadata(ctx, stream->session_id);
c585821b
MD
2427
2428 pthread_mutex_lock(&stream->metadata_timer_lock);
2429 stream->waiting_on_metadata = false;
2430 if (stream->missed_metadata_flush) {
2431 stream->missed_metadata_flush = false;
2432 pthread_mutex_unlock(&stream->metadata_timer_lock);
2433 (void) consumer_flush_ust_index(stream);
2434 } else {
2435 pthread_mutex_unlock(&stream->metadata_timer_lock);
2436 }
2437
94d49140
JD
2438 if (err < 0) {
2439 goto end;
2440 }
2441 }
2442
1c20f0e2
JD
2443 assert(!stream->metadata_flag);
2444 err = consumer_stream_write_index(stream, &index);
2445 if (err < 0) {
2446 goto end;
309167d2
JD
2447 }
2448
d41f73b7
MD
2449end:
2450 return ret;
2451}
2452
ffe60014
DG
2453/*
2454 * Called when a stream is created.
fe4477ee
JD
2455 *
2456 * Return 0 on success or else a negative value.
ffe60014 2457 */
d41f73b7
MD
2458int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
2459{
fe4477ee
JD
2460 int ret;
2461
10a50311
JD
2462 assert(stream);
2463
fe4477ee 2464 /* Don't create anything if this is set for streaming. */
10a50311 2465 if (stream->net_seq_idx == (uint64_t) -1ULL && stream->chan->monitor) {
fe4477ee
JD
2466 ret = utils_create_stream_file(stream->chan->pathname, stream->name,
2467 stream->chan->tracefile_size, stream->tracefile_count_current,
309167d2 2468 stream->uid, stream->gid, NULL);
fe4477ee
JD
2469 if (ret < 0) {
2470 goto error;
2471 }
2472 stream->out_fd = ret;
2473 stream->tracefile_size_current = 0;
309167d2
JD
2474
2475 if (!stream->metadata_flag) {
2476 ret = index_create_file(stream->chan->pathname,
2477 stream->name, stream->uid, stream->gid,
2478 stream->chan->tracefile_size,
2479 stream->tracefile_count_current);
2480 if (ret < 0) {
2481 goto error;
2482 }
2483 stream->index_fd = ret;
2484 }
fe4477ee
JD
2485 }
2486 ret = 0;
2487
2488error:
2489 return ret;
d41f73b7 2490}
ca22feea
DG
2491
2492/*
2493 * Check if data is still being extracted from the buffers for a specific
4e9a4686
DG
2494 * stream. Consumer data lock MUST be acquired before calling this function
2495 * and the stream lock.
ca22feea 2496 *
6d805429 2497 * Return 1 if the traced data are still getting read else 0 meaning that the
ca22feea
DG
2498 * data is available for trace viewer reading.
2499 */
6d805429 2500int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
ca22feea
DG
2501{
2502 int ret;
2503
2504 assert(stream);
ffe60014 2505 assert(stream->ustream);
ca22feea 2506
6d805429 2507 DBG("UST consumer checking data pending");
c8f59ee5 2508
ca6b395f
MD
2509 if (stream->endpoint_status != CONSUMER_ENDPOINT_ACTIVE) {
2510 ret = 0;
2511 goto end;
2512 }
2513
04ef1097 2514 if (stream->chan->type == CONSUMER_CHANNEL_TYPE_METADATA) {
e6ee4eab
DG
2515 uint64_t contiguous, pushed;
2516
2517 /* Ease our life a bit. */
c585821b 2518 contiguous = stream->chan->metadata_cache->max_offset;
e6ee4eab
DG
2519 pushed = stream->ust_metadata_pushed;
2520
04ef1097
MD
2521 /*
2522 * We can simply check whether all contiguously available data
2523 * has been pushed to the ring buffer, since the push operation
2524 * is performed within get_next_subbuf(), and because both
2525 * get_next_subbuf() and put_next_subbuf() are issued atomically
2526 * thanks to the stream lock within
2527 * lttng_ustconsumer_read_subbuffer(). This basically means that
2528 * whetnever ust_metadata_pushed is incremented, the associated
2529 * metadata has been consumed from the metadata stream.
2530 */
2531 DBG("UST consumer metadata pending check: contiguous %" PRIu64 " vs pushed %" PRIu64,
e6ee4eab 2532 contiguous, pushed);
aa01b94c 2533 assert(((int64_t) (contiguous - pushed)) >= 0);
e6ee4eab 2534 if ((contiguous != pushed) ||
6acdf328 2535 (((int64_t) contiguous - pushed) > 0 || contiguous == 0)) {
04ef1097
MD
2536 ret = 1; /* Data is pending */
2537 goto end;
2538 }
2539 } else {
2540 ret = ustctl_get_next_subbuf(stream->ustream);
2541 if (ret == 0) {
2542 /*
2543 * There is still data so let's put back this
2544 * subbuffer.
2545 */
2546 ret = ustctl_put_subbuf(stream->ustream);
2547 assert(ret == 0);
2548 ret = 1; /* Data is pending */
2549 goto end;
2550 }
ca22feea
DG
2551 }
2552
6d805429
DG
2553 /* Data is NOT pending so ready to be read. */
2554 ret = 0;
ca22feea 2555
6efae65e
DG
2556end:
2557 return ret;
ca22feea 2558}
d88aee68 2559
6d574024
DG
2560/*
2561 * Stop a given metadata channel timer if enabled and close the wait fd which
2562 * is the poll pipe of the metadata stream.
2563 *
2564 * This MUST be called with the metadata channel acquired.
2565 */
2566void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata)
2567{
2568 int ret;
2569
2570 assert(metadata);
2571 assert(metadata->type == CONSUMER_CHANNEL_TYPE_METADATA);
2572
2573 DBG("Closing metadata channel key %" PRIu64, metadata->key);
2574
2575 if (metadata->switch_timer_enabled == 1) {
2576 consumer_timer_switch_stop(metadata);
2577 }
2578
2579 if (!metadata->metadata_stream) {
2580 goto end;
2581 }
2582
2583 /*
2584 * Closing write side so the thread monitoring the stream wakes up if any
2585 * and clean the metadata stream.
2586 */
2587 if (metadata->metadata_stream->ust_metadata_poll_pipe[1] >= 0) {
2588 ret = close(metadata->metadata_stream->ust_metadata_poll_pipe[1]);
2589 if (ret < 0) {
2590 PERROR("closing metadata pipe write side");
2591 }
2592 metadata->metadata_stream->ust_metadata_poll_pipe[1] = -1;
2593 }
2594
2595end:
2596 return;
2597}
2598
d88aee68
DG
2599/*
2600 * Close every metadata stream wait fd of the metadata hash table. This
2601 * function MUST be used very carefully so not to run into a race between the
2602 * metadata thread handling streams and this function closing their wait fd.
2603 *
2604 * For UST, this is used when the session daemon hangs up. Its the metadata
2605 * producer so calling this is safe because we are assured that no state change
2606 * can occur in the metadata thread for the streams in the hash table.
2607 */
6d574024 2608void lttng_ustconsumer_close_all_metadata(struct lttng_ht *metadata_ht)
d88aee68 2609{
d88aee68
DG
2610 struct lttng_ht_iter iter;
2611 struct lttng_consumer_stream *stream;
2612
2613 assert(metadata_ht);
2614 assert(metadata_ht->ht);
2615
2616 DBG("UST consumer closing all metadata streams");
2617
2618 rcu_read_lock();
2619 cds_lfht_for_each_entry(metadata_ht->ht, &iter.iter, stream,
2620 node.node) {
9ce5646a
MD
2621
2622 health_code_update();
2623
be2b50c7 2624 pthread_mutex_lock(&stream->chan->lock);
6d574024 2625 lttng_ustconsumer_close_metadata(stream->chan);
be2b50c7
DG
2626 pthread_mutex_unlock(&stream->chan->lock);
2627
d88aee68
DG
2628 }
2629 rcu_read_unlock();
2630}
d8ef542d
MD
2631
2632void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
2633{
2634 int ret;
2635
2636 ret = ustctl_stream_close_wakeup_fd(stream->ustream);
2637 if (ret < 0) {
2638 ERR("Unable to close wakeup fd");
2639 }
2640}
331744e3 2641
f666ae70
MD
2642/*
2643 * Please refer to consumer-timer.c before adding any lock within this
2644 * function or any of its callees. Timers have a very strict locking
2645 * semantic with respect to teardown. Failure to respect this semantic
2646 * introduces deadlocks.
c585821b
MD
2647 *
2648 * DON'T hold the metadata lock when calling this function, else this
2649 * can cause deadlock involving consumer awaiting for metadata to be
2650 * pushed out due to concurrent interaction with the session daemon.
f666ae70 2651 */
331744e3 2652int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
94d49140 2653 struct lttng_consumer_channel *channel, int timer, int wait)
331744e3
JD
2654{
2655 struct lttcomm_metadata_request_msg request;
2656 struct lttcomm_consumer_msg msg;
0c759fc9 2657 enum lttcomm_return_code ret_code = LTTCOMM_CONSUMERD_SUCCESS;
331744e3
JD
2658 uint64_t len, key, offset;
2659 int ret;
2660
2661 assert(channel);
2662 assert(channel->metadata_cache);
2663
53efb85a
MD
2664 memset(&request, 0, sizeof(request));
2665
331744e3
JD
2666 /* send the metadata request to sessiond */
2667 switch (consumer_data.type) {
2668 case LTTNG_CONSUMER64_UST:
2669 request.bits_per_long = 64;
2670 break;
2671 case LTTNG_CONSUMER32_UST:
2672 request.bits_per_long = 32;
2673 break;
2674 default:
2675 request.bits_per_long = 0;
2676 break;
2677 }
2678
2679 request.session_id = channel->session_id;
1950109e 2680 request.session_id_per_pid = channel->session_id_per_pid;
567eb353
DG
2681 /*
2682 * Request the application UID here so the metadata of that application can
2683 * be sent back. The channel UID corresponds to the user UID of the session
2684 * used for the rights on the stream file(s).
2685 */
2686 request.uid = channel->ust_app_uid;
331744e3 2687 request.key = channel->key;
567eb353 2688
1950109e 2689 DBG("Sending metadata request to sessiond, session id %" PRIu64
567eb353
DG
2690 ", per-pid %" PRIu64 ", app UID %u and channek key %" PRIu64,
2691 request.session_id, request.session_id_per_pid, request.uid,
2692 request.key);
331744e3 2693
75d83e50 2694 pthread_mutex_lock(&ctx->metadata_socket_lock);
9ce5646a
MD
2695
2696 health_code_update();
2697
331744e3
JD
2698 ret = lttcomm_send_unix_sock(ctx->consumer_metadata_socket, &request,
2699 sizeof(request));
2700 if (ret < 0) {
2701 ERR("Asking metadata to sessiond");
2702 goto end;
2703 }
2704
9ce5646a
MD
2705 health_code_update();
2706
331744e3
JD
2707 /* Receive the metadata from sessiond */
2708 ret = lttcomm_recv_unix_sock(ctx->consumer_metadata_socket, &msg,
2709 sizeof(msg));
2710 if (ret != sizeof(msg)) {
8fd623e0 2711 DBG("Consumer received unexpected message size %d (expects %zu)",
331744e3
JD
2712 ret, sizeof(msg));
2713 lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_ERROR_RECV_CMD);
2714 /*
2715 * The ret value might 0 meaning an orderly shutdown but this is ok
2716 * since the caller handles this.
2717 */
2718 goto end;
2719 }
2720
9ce5646a
MD
2721 health_code_update();
2722
331744e3
JD
2723 if (msg.cmd_type == LTTNG_ERR_UND) {
2724 /* No registry found */
2725 (void) consumer_send_status_msg(ctx->consumer_metadata_socket,
2726 ret_code);
2727 ret = 0;
2728 goto end;
2729 } else if (msg.cmd_type != LTTNG_CONSUMER_PUSH_METADATA) {
2730 ERR("Unexpected cmd_type received %d", msg.cmd_type);
2731 ret = -1;
2732 goto end;
2733 }
2734
2735 len = msg.u.push_metadata.len;
2736 key = msg.u.push_metadata.key;
2737 offset = msg.u.push_metadata.target_offset;
2738
2739 assert(key == channel->key);
2740 if (len == 0) {
2741 DBG("No new metadata to receive for key %" PRIu64, key);
2742 }
2743
9ce5646a
MD
2744 health_code_update();
2745
331744e3
JD
2746 /* Tell session daemon we are ready to receive the metadata. */
2747 ret = consumer_send_status_msg(ctx->consumer_metadata_socket,
0c759fc9 2748 LTTCOMM_CONSUMERD_SUCCESS);
331744e3
JD
2749 if (ret < 0 || len == 0) {
2750 /*
2751 * Somehow, the session daemon is not responding anymore or there is
2752 * nothing to receive.
2753 */
2754 goto end;
2755 }
2756
9ce5646a
MD
2757 health_code_update();
2758
1eb682be 2759 ret = lttng_ustconsumer_recv_metadata(ctx->consumer_metadata_socket,
94d49140 2760 key, offset, len, channel, timer, wait);
1eb682be 2761 if (ret >= 0) {
f2a444f1
DG
2762 /*
2763 * Only send the status msg if the sessiond is alive meaning a positive
2764 * ret code.
2765 */
1eb682be 2766 (void) consumer_send_status_msg(ctx->consumer_metadata_socket, ret);
f2a444f1 2767 }
331744e3
JD
2768 ret = 0;
2769
2770end:
9ce5646a
MD
2771 health_code_update();
2772
75d83e50 2773 pthread_mutex_unlock(&ctx->metadata_socket_lock);
331744e3
JD
2774 return ret;
2775}
70190e1c
DG
2776
2777/*
2778 * Return the ustctl call for the get stream id.
2779 */
2780int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream *stream,
2781 uint64_t *stream_id)
2782{
2783 assert(stream);
2784 assert(stream_id);
2785
2786 return ustctl_get_stream_id(stream->ustream, stream_id);
2787}
This page took 0.203501 seconds and 5 git commands to generate.