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