Change consumer_data_pipe to be a lttng_pipe
[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
990570ed 35#include <common/common.h>
10a8a223 36#include <common/sessiond-comm/sessiond-comm.h>
00e2e675 37#include <common/relayd/relayd.h>
dbb5dfe6 38#include <common/compat/fcntl.h>
331744e3
JD
39#include <common/consumer-metadata-cache.h>
40#include <common/consumer-timer.h>
fe4477ee 41#include <common/utils.h>
10a8a223
DG
42
43#include "ust-consumer.h"
3bd1e081
MD
44
45extern struct lttng_consumer_global_data consumer_data;
46extern int consumer_poll_timeout;
47extern volatile int consumer_quit;
48
49/*
ffe60014
DG
50 * Free channel object and all streams associated with it. This MUST be used
51 * only and only if the channel has _NEVER_ been added to the global channel
52 * hash table.
3bd1e081 53 */
ffe60014 54static void destroy_channel(struct lttng_consumer_channel *channel)
3bd1e081 55{
ffe60014
DG
56 struct lttng_consumer_stream *stream, *stmp;
57
58 assert(channel);
59
60 DBG("UST consumer cleaning stream list");
61
62 cds_list_for_each_entry_safe(stream, stmp, &channel->streams.head,
63 send_node) {
64 cds_list_del(&stream->send_node);
65 ustctl_destroy_stream(stream->ustream);
66 free(stream);
67 }
68
69 /*
70 * If a channel is available meaning that was created before the streams
71 * were, delete it.
72 */
73 if (channel->uchan) {
74 lttng_ustconsumer_del_channel(channel);
75 }
76 free(channel);
77}
3bd1e081
MD
78
79/*
ffe60014 80 * Add channel to internal consumer state.
3bd1e081 81 *
ffe60014 82 * Returns 0 on success or else a negative value.
3bd1e081 83 */
ffe60014
DG
84static int add_channel(struct lttng_consumer_channel *channel,
85 struct lttng_consumer_local_data *ctx)
3bd1e081
MD
86{
87 int ret = 0;
88
ffe60014
DG
89 assert(channel);
90 assert(ctx);
91
92 if (ctx->on_recv_channel != NULL) {
93 ret = ctx->on_recv_channel(channel);
94 if (ret == 0) {
d8ef542d 95 ret = consumer_add_channel(channel, ctx);
ffe60014
DG
96 } else if (ret < 0) {
97 /* Most likely an ENOMEM. */
98 lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_OUTFD_ERROR);
99 goto error;
100 }
101 } else {
d8ef542d 102 ret = consumer_add_channel(channel, ctx);
3bd1e081
MD
103 }
104
d88aee68 105 DBG("UST consumer channel added (key: %" PRIu64 ")", channel->key);
ffe60014
DG
106
107error:
3bd1e081
MD
108 return ret;
109}
110
111/*
ffe60014
DG
112 * Allocate and return a consumer channel object.
113 */
114static struct lttng_consumer_channel *allocate_channel(uint64_t session_id,
115 const char *pathname, const char *name, uid_t uid, gid_t gid,
1624d5b7
JD
116 int relayd_id, uint64_t key, enum lttng_event_output output,
117 uint64_t tracefile_size, uint64_t tracefile_count)
ffe60014
DG
118{
119 assert(pathname);
120 assert(name);
121
122 return consumer_allocate_channel(key, session_id, pathname, name, uid, gid,
1624d5b7 123 relayd_id, output, tracefile_size, tracefile_count);
ffe60014
DG
124}
125
126/*
127 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
128 * error value if applicable is set in it else it is kept untouched.
3bd1e081 129 *
ffe60014 130 * Return NULL on error else the newly allocated stream object.
3bd1e081 131 */
ffe60014
DG
132static struct lttng_consumer_stream *allocate_stream(int cpu, int key,
133 struct lttng_consumer_channel *channel,
134 struct lttng_consumer_local_data *ctx, int *_alloc_ret)
135{
136 int alloc_ret;
137 struct lttng_consumer_stream *stream = NULL;
138
139 assert(channel);
140 assert(ctx);
141
142 stream = consumer_allocate_stream(channel->key,
143 key,
144 LTTNG_CONSUMER_ACTIVE_STREAM,
145 channel->name,
146 channel->uid,
147 channel->gid,
148 channel->relayd_id,
149 channel->session_id,
150 cpu,
151 &alloc_ret,
152 channel->type);
153 if (stream == NULL) {
154 switch (alloc_ret) {
155 case -ENOENT:
156 /*
157 * We could not find the channel. Can happen if cpu hotplug
158 * happens while tearing down.
159 */
160 DBG3("Could not find channel");
161 break;
162 case -ENOMEM:
163 case -EINVAL:
164 default:
165 lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_OUTFD_ERROR);
166 break;
167 }
168 goto error;
169 }
170
171 stream->chan = channel;
172
173error:
174 if (_alloc_ret) {
175 *_alloc_ret = alloc_ret;
176 }
177 return stream;
178}
179
180/*
181 * Send the given stream pointer to the corresponding thread.
182 *
183 * Returns 0 on success else a negative value.
184 */
185static int send_stream_to_thread(struct lttng_consumer_stream *stream,
186 struct lttng_consumer_local_data *ctx)
187{
188 int ret, stream_pipe;
189
190 /* Get the right pipe where the stream will be sent. */
191 if (stream->metadata_flag) {
192 stream_pipe = ctx->consumer_metadata_pipe[1];
193 } else {
acdb9057 194 stream_pipe = lttng_pipe_get_writefd(ctx->consumer_data_pipe);
ffe60014
DG
195 }
196
197 do {
198 ret = write(stream_pipe, &stream, sizeof(stream));
199 } while (ret < 0 && errno == EINTR);
200 if (ret < 0) {
201 PERROR("Consumer write %s stream to pipe %d",
202 stream->metadata_flag ? "metadata" : "data", stream_pipe);
203 }
204
205 return ret;
206}
207
208/*
209 * Search for a relayd object related to the stream. If found, send the stream
210 * to the relayd.
211 *
212 * On success, returns 0 else a negative value.
213 */
214static int send_stream_to_relayd(struct lttng_consumer_stream *stream)
215{
216 int ret = 0;
217 struct consumer_relayd_sock_pair *relayd;
218
219 assert(stream);
220
221 relayd = consumer_find_relayd(stream->net_seq_idx);
222 if (relayd != NULL) {
223 pthread_mutex_lock(&relayd->ctrl_sock_mutex);
224 /* Add stream on the relayd */
225 ret = relayd_add_stream(&relayd->control_sock, stream->name,
0f907de1
JD
226 stream->chan->pathname, &stream->relayd_stream_id,
227 stream->chan->tracefile_size,
228 stream->chan->tracefile_count);
ffe60014
DG
229 pthread_mutex_unlock(&relayd->ctrl_sock_mutex);
230 if (ret < 0) {
231 goto error;
232 }
d88aee68
DG
233 } else if (stream->net_seq_idx != (uint64_t) -1ULL) {
234 ERR("Network sequence index %" PRIu64 " unknown. Not adding stream.",
ffe60014
DG
235 stream->net_seq_idx);
236 ret = -1;
237 goto error;
238 }
239
240error:
241 return ret;
242}
243
d88aee68
DG
244/*
245 * Create streams for the given channel using liblttng-ust-ctl.
246 *
247 * Return 0 on success else a negative value.
248 */
ffe60014
DG
249static int create_ust_streams(struct lttng_consumer_channel *channel,
250 struct lttng_consumer_local_data *ctx)
251{
252 int ret, cpu = 0;
253 struct ustctl_consumer_stream *ustream;
254 struct lttng_consumer_stream *stream;
255
256 assert(channel);
257 assert(ctx);
258
259 /*
260 * While a stream is available from ustctl. When NULL is returned, we've
261 * reached the end of the possible stream for the channel.
262 */
263 while ((ustream = ustctl_create_stream(channel->uchan, cpu))) {
264 int wait_fd;
265
749d339a 266 wait_fd = ustctl_stream_get_wait_fd(ustream);
ffe60014
DG
267
268 /* Allocate consumer stream object. */
269 stream = allocate_stream(cpu, wait_fd, channel, ctx, &ret);
270 if (!stream) {
271 goto error_alloc;
272 }
273 stream->ustream = ustream;
274 /*
275 * Store it so we can save multiple function calls afterwards since
276 * this value is used heavily in the stream threads. This is UST
277 * specific so this is why it's done after allocation.
278 */
279 stream->wait_fd = wait_fd;
280
b31398bb
DG
281 /*
282 * Increment channel refcount since the channel reference has now been
283 * assigned in the allocation process above.
284 */
285 uatomic_inc(&stream->chan->refcount);
286
ffe60014
DG
287 /*
288 * Order is important this is why a list is used. On error, the caller
289 * should clean this list.
290 */
291 cds_list_add_tail(&stream->send_node, &channel->streams.head);
292
293 ret = ustctl_get_max_subbuf_size(stream->ustream,
294 &stream->max_sb_size);
295 if (ret < 0) {
296 ERR("ustctl_get_max_subbuf_size failed for stream %s",
297 stream->name);
298 goto error;
299 }
300
301 /* Do actions once stream has been received. */
302 if (ctx->on_recv_stream) {
303 ret = ctx->on_recv_stream(stream);
304 if (ret < 0) {
305 goto error;
306 }
307 }
308
d88aee68 309 DBG("UST consumer add stream %s (key: %" PRIu64 ") with relayd id %" PRIu64,
ffe60014
DG
310 stream->name, stream->key, stream->relayd_stream_id);
311
312 /* Set next CPU stream. */
313 channel->streams.count = ++cpu;
d88aee68
DG
314
315 /* Keep stream reference when creating metadata. */
316 if (channel->type == CONSUMER_CHANNEL_TYPE_METADATA) {
317 channel->metadata_stream = stream;
318 }
ffe60014
DG
319 }
320
321 return 0;
322
323error:
324error_alloc:
325 return ret;
326}
327
328/*
329 * Create an UST channel with the given attributes and send it to the session
330 * daemon using the ust ctl API.
331 *
332 * Return 0 on success or else a negative value.
333 */
334static int create_ust_channel(struct ustctl_consumer_channel_attr *attr,
335 struct ustctl_consumer_channel **chanp)
336{
337 int ret;
338 struct ustctl_consumer_channel *channel;
339
340 assert(attr);
341 assert(chanp);
342
343 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
344 "subbuf_size: %" PRIu64 ", num_subbuf: %" PRIu64 ", "
345 "switch_timer_interval: %u, read_timer_interval: %u, "
346 "output: %d, type: %d", attr->overwrite, attr->subbuf_size,
347 attr->num_subbuf, attr->switch_timer_interval,
348 attr->read_timer_interval, attr->output, attr->type);
349
350 channel = ustctl_create_channel(attr);
351 if (!channel) {
352 ret = -1;
353 goto error_create;
354 }
355
356 *chanp = channel;
357
358 return 0;
359
360error_create:
361 return ret;
362}
363
d88aee68
DG
364/*
365 * Send a single given stream to the session daemon using the sock.
366 *
367 * Return 0 on success else a negative value.
368 */
ffe60014
DG
369static int send_sessiond_stream(int sock, struct lttng_consumer_stream *stream)
370{
371 int ret;
372
373 assert(stream);
374 assert(sock >= 0);
375
d88aee68 376 DBG2("UST consumer sending stream %" PRIu64 " to sessiond", stream->key);
ffe60014
DG
377
378 /* Send stream to session daemon. */
379 ret = ustctl_send_stream_to_sessiond(sock, stream->ustream);
380 if (ret < 0) {
381 goto error;
382 }
383
ffe60014
DG
384error:
385 return ret;
386}
387
388/*
389 * Send channel to sessiond.
390 *
d88aee68 391 * Return 0 on success or else a negative value.
ffe60014
DG
392 */
393static int send_sessiond_channel(int sock,
394 struct lttng_consumer_channel *channel,
395 struct lttng_consumer_local_data *ctx, int *relayd_error)
396{
397 int ret;
398 struct lttng_consumer_stream *stream;
399
400 assert(channel);
401 assert(ctx);
402 assert(sock >= 0);
403
404 DBG("UST consumer sending channel %s to sessiond", channel->name);
405
406 /* Send channel to sessiond. */
407 ret = ustctl_send_channel_to_sessiond(sock, channel->uchan);
408 if (ret < 0) {
409 goto error;
410 }
411
d8ef542d
MD
412 ret = ustctl_channel_close_wakeup_fd(channel->uchan);
413 if (ret < 0) {
414 goto error;
415 }
416
ffe60014
DG
417 /* The channel was sent successfully to the sessiond at this point. */
418 cds_list_for_each_entry(stream, &channel->streams.head, send_node) {
419 /* Try to send the stream to the relayd if one is available. */
420 ret = send_stream_to_relayd(stream);
421 if (ret < 0) {
422 /*
423 * Flag that the relayd was the problem here probably due to a
424 * communicaton error on the socket.
425 */
426 if (relayd_error) {
427 *relayd_error = 1;
428 }
429 goto error;
430 }
431
432 /* Send stream to session daemon. */
433 ret = send_sessiond_stream(sock, stream);
434 if (ret < 0) {
435 goto error;
436 }
437 }
438
439 /* Tell sessiond there is no more stream. */
440 ret = ustctl_send_stream_to_sessiond(sock, NULL);
441 if (ret < 0) {
442 goto error;
443 }
444
445 DBG("UST consumer NULL stream sent to sessiond");
446
447 return 0;
448
449error:
450 return ret;
451}
452
453/*
454 * Creates a channel and streams and add the channel it to the channel internal
455 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
456 * received.
457 *
458 * Return 0 on success or else, a negative value is returned and the channel
459 * MUST be destroyed by consumer_del_channel().
460 */
461static int ask_channel(struct lttng_consumer_local_data *ctx, int sock,
462 struct lttng_consumer_channel *channel,
463 struct ustctl_consumer_channel_attr *attr)
3bd1e081
MD
464{
465 int ret;
466
ffe60014
DG
467 assert(ctx);
468 assert(channel);
469 assert(attr);
470
471 /*
472 * This value is still used by the kernel consumer since for the kernel,
473 * the stream ownership is not IN the consumer so we need to have the
474 * number of left stream that needs to be initialized so we can know when
475 * to delete the channel (see consumer.c).
476 *
477 * As for the user space tracer now, the consumer creates and sends the
478 * stream to the session daemon which only sends them to the application
479 * once every stream of a channel is received making this value useless
480 * because we they will be added to the poll thread before the application
481 * receives them. This ensures that a stream can not hang up during
482 * initilization of a channel.
483 */
484 channel->nb_init_stream_left = 0;
485
486 /* The reply msg status is handled in the following call. */
487 ret = create_ust_channel(attr, &channel->uchan);
488 if (ret < 0) {
489 goto error;
3bd1e081
MD
490 }
491
d8ef542d
MD
492 channel->wait_fd = ustctl_channel_get_wait_fd(channel->uchan);
493
494 if (ret < 0) {
495 goto error;
496 }
497
ffe60014
DG
498 /* Open all streams for this channel. */
499 ret = create_ust_streams(channel, ctx);
500 if (ret < 0) {
501 goto error;
502 }
503
504error:
3bd1e081
MD
505 return ret;
506}
507
d88aee68
DG
508/*
509 * Send all stream of a channel to the right thread handling it.
510 *
511 * On error, return a negative value else 0 on success.
512 */
513static int send_streams_to_thread(struct lttng_consumer_channel *channel,
514 struct lttng_consumer_local_data *ctx)
515{
516 int ret = 0;
517 struct lttng_consumer_stream *stream, *stmp;
518
519 assert(channel);
520 assert(ctx);
521
522 /* Send streams to the corresponding thread. */
523 cds_list_for_each_entry_safe(stream, stmp, &channel->streams.head,
524 send_node) {
525 /* Sending the stream to the thread. */
526 ret = send_stream_to_thread(stream, ctx);
527 if (ret < 0) {
528 /*
529 * If we are unable to send the stream to the thread, there is
530 * a big problem so just stop everything.
531 */
532 goto error;
533 }
534
535 /* Remove node from the channel stream list. */
536 cds_list_del(&stream->send_node);
537 }
538
539error:
540 return ret;
541}
542
543/*
544 * Write metadata to the given channel using ustctl to convert the string to
545 * the ringbuffer.
331744e3
JD
546 * Called only from consumer_metadata_cache_write.
547 * The metadata cache lock MUST be acquired to write in the cache.
d88aee68
DG
548 *
549 * Return 0 on success else a negative value.
550 */
331744e3 551int lttng_ustconsumer_push_metadata(struct lttng_consumer_channel *metadata,
d88aee68
DG
552 const char *metadata_str, uint64_t target_offset, uint64_t len)
553{
554 int ret;
555
556 assert(metadata);
557 assert(metadata_str);
558
559 DBG("UST consumer writing metadata to channel %s", metadata->name);
560
331744e3
JD
561 assert(target_offset <= metadata->metadata_cache->max_offset);
562 ret = ustctl_write_metadata_to_channel(metadata->uchan,
563 metadata_str + target_offset, len);
d88aee68 564 if (ret < 0) {
8fd623e0 565 ERR("ustctl write metadata fail with ret %d, len %" PRIu64, ret, len);
d88aee68
DG
566 goto error;
567 }
d88aee68
DG
568
569 ustctl_flush_buffer(metadata->metadata_stream->ustream, 1);
570
571error:
572 return ret;
573}
574
7972aab2
DG
575/*
576 * Flush channel's streams using the given key to retrieve the channel.
577 *
578 * Return 0 on success else an LTTng error code.
579 */
580static int flush_channel(uint64_t chan_key)
581{
582 int ret = 0;
583 struct lttng_consumer_channel *channel;
584 struct lttng_consumer_stream *stream;
585 struct lttng_ht *ht;
586 struct lttng_ht_iter iter;
587
8fd623e0 588 DBG("UST consumer flush channel key %" PRIu64, chan_key);
7972aab2 589
a500c257 590 rcu_read_lock();
7972aab2
DG
591 channel = consumer_find_channel(chan_key);
592 if (!channel) {
8fd623e0 593 ERR("UST consumer flush channel %" PRIu64 " not found", chan_key);
7972aab2
DG
594 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
595 goto error;
596 }
597
598 ht = consumer_data.stream_per_chan_id_ht;
599
600 /* For each stream of the channel id, flush it. */
7972aab2
DG
601 cds_lfht_for_each_entry_duplicate(ht->ht,
602 ht->hash_fct(&channel->key, lttng_ht_seed), ht->match_fct,
603 &channel->key, &iter.iter, stream, node_channel_id.node) {
604 ustctl_flush_buffer(stream->ustream, 1);
605 }
7972aab2 606error:
a500c257 607 rcu_read_unlock();
7972aab2
DG
608 return ret;
609}
610
d88aee68
DG
611/*
612 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
a500c257 613 * RCU read side lock MUST be acquired before calling this function.
d88aee68
DG
614 *
615 * Return 0 on success else an LTTng error code.
616 */
617static int close_metadata(uint64_t chan_key)
618{
ea88ca2a 619 int ret = 0;
d88aee68
DG
620 struct lttng_consumer_channel *channel;
621
8fd623e0 622 DBG("UST consumer close metadata key %" PRIu64, chan_key);
d88aee68
DG
623
624 channel = consumer_find_channel(chan_key);
625 if (!channel) {
8fd623e0 626 ERR("UST consumer close metadata %" PRIu64 " not found", chan_key);
d88aee68
DG
627 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
628 goto error;
629 }
630
ea88ca2a
MD
631 pthread_mutex_lock(&consumer_data.lock);
632 if (!cds_lfht_is_node_deleted(&channel->node.node)) {
633 if (channel->switch_timer_enabled == 1) {
634 DBG("Deleting timer on metadata channel");
635 consumer_timer_switch_stop(channel);
636 }
637 ret = ustctl_stream_close_wakeup_fd(channel->metadata_stream->ustream);
638 if (ret < 0) {
639 ERR("UST consumer unable to close fd of metadata (ret: %d)", ret);
640 ret = LTTCOMM_CONSUMERD_ERROR_METADATA;
641 goto error_unlock;
642 }
331744e3 643 }
d88aee68 644
ea88ca2a
MD
645error_unlock:
646 pthread_mutex_unlock(&consumer_data.lock);
d88aee68
DG
647error:
648 return ret;
649}
650
651/*
652 * RCU read side lock MUST be acquired before calling this function.
653 *
654 * Return 0 on success else an LTTng error code.
655 */
656static int setup_metadata(struct lttng_consumer_local_data *ctx, uint64_t key)
657{
658 int ret;
659 struct lttng_consumer_channel *metadata;
660
8fd623e0 661 DBG("UST consumer setup metadata key %" PRIu64, key);
d88aee68
DG
662
663 metadata = consumer_find_channel(key);
664 if (!metadata) {
665 ERR("UST consumer push metadata %" PRIu64 " not found", key);
666 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
667 goto error;
668 }
669
670 /*
671 * Send metadata stream to relayd if one available. Availability is
672 * known if the stream is still in the list of the channel.
673 */
674 if (cds_list_empty(&metadata->streams.head)) {
675 ERR("Metadata channel key %" PRIu64 ", no stream available.", key);
676 ret = LTTCOMM_CONSUMERD_ERROR_METADATA;
677 goto error;
678 }
679
680 /* Send metadata stream to relayd if needed. */
681 ret = send_stream_to_relayd(metadata->metadata_stream);
682 if (ret < 0) {
683 ret = LTTCOMM_CONSUMERD_ERROR_METADATA;
684 goto error;
685 }
686
687 ret = send_streams_to_thread(metadata, ctx);
688 if (ret < 0) {
689 /*
690 * If we are unable to send the stream to the thread, there is
691 * a big problem so just stop everything.
692 */
693 ret = LTTCOMM_CONSUMERD_FATAL;
694 goto error;
695 }
696 /* List MUST be empty after or else it could be reused. */
697 assert(cds_list_empty(&metadata->streams.head));
698
699 ret = 0;
700
701error:
702 return ret;
703}
704
331744e3
JD
705/*
706 * Receive the metadata updates from the sessiond.
707 */
708int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
709 uint64_t len, struct lttng_consumer_channel *channel)
710{
711 int ret, ret_code = LTTNG_OK;
712 char *metadata_str;
713
8fd623e0 714 DBG("UST consumer push metadata key %" PRIu64 " of len %" PRIu64, key, len);
331744e3
JD
715
716 metadata_str = zmalloc(len * sizeof(char));
717 if (!metadata_str) {
718 PERROR("zmalloc metadata string");
719 ret_code = LTTCOMM_CONSUMERD_ENOMEM;
720 goto end;
721 }
722
723 /* Receive metadata string. */
724 ret = lttcomm_recv_unix_sock(sock, metadata_str, len);
725 if (ret < 0) {
726 /* Session daemon is dead so return gracefully. */
727 ret_code = ret;
728 goto end_free;
729 }
730
731 pthread_mutex_lock(&channel->metadata_cache->lock);
732 ret = consumer_metadata_cache_write(channel, offset, len, metadata_str);
733 if (ret < 0) {
734 /* Unable to handle metadata. Notify session daemon. */
735 ret_code = LTTCOMM_CONSUMERD_ERROR_METADATA;
736 }
737 pthread_mutex_unlock(&channel->metadata_cache->lock);
738
739 while (consumer_metadata_cache_flushed(channel, offset + len)) {
740 DBG("Waiting for metadata to be flushed");
741 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME);
742 }
743
744end_free:
745 free(metadata_str);
746end:
747 return ret_code;
748}
749
4cbc1a04
DG
750/*
751 * Receive command from session daemon and process it.
752 *
753 * Return 1 on success else a negative value or 0.
754 */
3bd1e081
MD
755int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
756 int sock, struct pollfd *consumer_sockpoll)
757{
758 ssize_t ret;
f50f23d9 759 enum lttng_error_code ret_code = LTTNG_OK;
3bd1e081 760 struct lttcomm_consumer_msg msg;
ffe60014 761 struct lttng_consumer_channel *channel = NULL;
3bd1e081
MD
762
763 ret = lttcomm_recv_unix_sock(sock, &msg, sizeof(msg));
764 if (ret != sizeof(msg)) {
173af62f
DG
765 DBG("Consumer received unexpected message size %zd (expects %zu)",
766 ret, sizeof(msg));
ffe60014 767 lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_ERROR_RECV_CMD);
3be74084
DG
768 /*
769 * The ret value might 0 meaning an orderly shutdown but this is ok
770 * since the caller handles this.
771 */
3bd1e081
MD
772 return ret;
773 }
774 if (msg.cmd_type == LTTNG_CONSUMER_STOP) {
f50f23d9
DG
775 /*
776 * Notify the session daemon that the command is completed.
777 *
778 * On transport layer error, the function call will print an error
779 * message so handling the returned code is a bit useless since we
780 * return an error code anyway.
781 */
782 (void) consumer_send_status_msg(sock, ret_code);
3bd1e081
MD
783 return -ENOENT;
784 }
785
3f8e211f 786 /* relayd needs RCU read-side lock */
b0b335c8
MD
787 rcu_read_lock();
788
3bd1e081 789 switch (msg.cmd_type) {
00e2e675
DG
790 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET:
791 {
f50f23d9 792 /* Session daemon status message are handled in the following call. */
7735ef9e
DG
793 ret = consumer_add_relayd_socket(msg.u.relayd_sock.net_index,
794 msg.u.relayd_sock.type, ctx, sock, consumer_sockpoll,
46e6455f 795 &msg.u.relayd_sock.sock, msg.u.relayd_sock.session_id);
00e2e675
DG
796 goto end_nosignal;
797 }
173af62f
DG
798 case LTTNG_CONSUMER_DESTROY_RELAYD:
799 {
a6ba4fe1 800 uint64_t index = msg.u.destroy_relayd.net_seq_idx;
173af62f
DG
801 struct consumer_relayd_sock_pair *relayd;
802
a6ba4fe1 803 DBG("UST consumer destroying relayd %" PRIu64, index);
173af62f
DG
804
805 /* Get relayd reference if exists. */
a6ba4fe1 806 relayd = consumer_find_relayd(index);
173af62f 807 if (relayd == NULL) {
3448e266 808 DBG("Unable to find relayd %" PRIu64, index);
f50f23d9 809 ret_code = LTTNG_ERR_NO_CONSUMER;
173af62f
DG
810 }
811
a6ba4fe1
DG
812 /*
813 * Each relayd socket pair has a refcount of stream attached to it
814 * which tells if the relayd is still active or not depending on the
815 * refcount value.
816 *
817 * This will set the destroy flag of the relayd object and destroy it
818 * if the refcount reaches zero when called.
819 *
820 * The destroy can happen either here or when a stream fd hangs up.
821 */
f50f23d9
DG
822 if (relayd) {
823 consumer_flag_relayd_for_destroy(relayd);
824 }
825
d88aee68 826 goto end_msg_sessiond;
173af62f 827 }
3bd1e081
MD
828 case LTTNG_CONSUMER_UPDATE_STREAM:
829 {
3f8e211f 830 rcu_read_unlock();
7ad0a0cb 831 return -ENOSYS;
3bd1e081 832 }
6d805429 833 case LTTNG_CONSUMER_DATA_PENDING:
53632229 834 {
3be74084 835 int ret, is_data_pending;
6d805429 836 uint64_t id = msg.u.data_pending.session_id;
ca22feea 837
6d805429 838 DBG("UST consumer data pending command for id %" PRIu64, id);
ca22feea 839
3be74084 840 is_data_pending = consumer_data_pending(id);
ca22feea
DG
841
842 /* Send back returned value to session daemon */
3be74084
DG
843 ret = lttcomm_send_unix_sock(sock, &is_data_pending,
844 sizeof(is_data_pending));
ca22feea 845 if (ret < 0) {
3be74084 846 DBG("Error when sending the data pending ret code: %d", ret);
ca22feea 847 }
f50f23d9
DG
848
849 /*
850 * No need to send back a status message since the data pending
851 * returned value is the response.
852 */
ca22feea 853 break;
53632229 854 }
ffe60014
DG
855 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION:
856 {
857 int ret;
858 struct ustctl_consumer_channel_attr attr;
859
860 /* Create a plain object and reserve a channel key. */
861 channel = allocate_channel(msg.u.ask_channel.session_id,
862 msg.u.ask_channel.pathname, msg.u.ask_channel.name,
863 msg.u.ask_channel.uid, msg.u.ask_channel.gid,
864 msg.u.ask_channel.relayd_id, msg.u.ask_channel.key,
1624d5b7
JD
865 (enum lttng_event_output) msg.u.ask_channel.output,
866 msg.u.ask_channel.tracefile_size,
867 msg.u.ask_channel.tracefile_count);
ffe60014
DG
868 if (!channel) {
869 goto end_channel_error;
870 }
871
872 /* Build channel attributes from received message. */
873 attr.subbuf_size = msg.u.ask_channel.subbuf_size;
874 attr.num_subbuf = msg.u.ask_channel.num_subbuf;
875 attr.overwrite = msg.u.ask_channel.overwrite;
876 attr.switch_timer_interval = msg.u.ask_channel.switch_timer_interval;
877 attr.read_timer_interval = msg.u.ask_channel.read_timer_interval;
7972aab2 878 attr.chan_id = msg.u.ask_channel.chan_id;
ffe60014
DG
879 memcpy(attr.uuid, msg.u.ask_channel.uuid, sizeof(attr.uuid));
880
881 /* Translate the event output type to UST. */
882 switch (channel->output) {
883 case LTTNG_EVENT_SPLICE:
884 /* Splice not supported so fallback on mmap(). */
885 case LTTNG_EVENT_MMAP:
886 default:
887 attr.output = CONSUMER_CHANNEL_MMAP;
888 break;
889 };
890
891 /* Translate and save channel type. */
892 switch (msg.u.ask_channel.type) {
893 case LTTNG_UST_CHAN_PER_CPU:
894 channel->type = CONSUMER_CHANNEL_TYPE_DATA;
895 attr.type = LTTNG_UST_CHAN_PER_CPU;
8633d6e3
MD
896 /*
897 * Set refcount to 1 for owner. Below, we will
898 * pass ownership to the
899 * consumer_thread_channel_poll() thread.
900 */
901 channel->refcount = 1;
ffe60014
DG
902 break;
903 case LTTNG_UST_CHAN_METADATA:
904 channel->type = CONSUMER_CHANNEL_TYPE_METADATA;
905 attr.type = LTTNG_UST_CHAN_METADATA;
906 break;
907 default:
908 assert(0);
909 goto error_fatal;
910 };
911
912 ret = ask_channel(ctx, sock, channel, &attr);
913 if (ret < 0) {
914 goto end_channel_error;
915 }
916
fc643247
MD
917 if (msg.u.ask_channel.type == LTTNG_UST_CHAN_METADATA) {
918 ret = consumer_metadata_cache_allocate(channel);
919 if (ret < 0) {
920 ERR("Allocating metadata cache");
921 goto end_channel_error;
922 }
923 consumer_timer_switch_start(channel, attr.switch_timer_interval);
924 attr.switch_timer_interval = 0;
925 }
926
ffe60014
DG
927 /*
928 * Add the channel to the internal state AFTER all streams were created
929 * and successfully sent to session daemon. This way, all streams must
930 * be ready before this channel is visible to the threads.
fc643247
MD
931 * If add_channel succeeds, ownership of the channel is
932 * passed to consumer_thread_channel_poll().
ffe60014
DG
933 */
934 ret = add_channel(channel, ctx);
935 if (ret < 0) {
ea88ca2a
MD
936 if (msg.u.ask_channel.type == LTTNG_UST_CHAN_METADATA) {
937 if (channel->switch_timer_enabled == 1) {
938 consumer_timer_switch_stop(channel);
939 }
940 consumer_metadata_cache_destroy(channel);
941 }
ffe60014
DG
942 goto end_channel_error;
943 }
944
945 /*
946 * Channel and streams are now created. Inform the session daemon that
947 * everything went well and should wait to receive the channel and
948 * streams with ustctl API.
949 */
950 ret = consumer_send_status_channel(sock, channel);
951 if (ret < 0) {
952 /*
953 * There is probably a problem on the socket so the poll will get
954 * it and clean everything up.
955 */
956 goto end_nosignal;
957 }
958
959 break;
960 }
961 case LTTNG_CONSUMER_GET_CHANNEL:
962 {
963 int ret, relayd_err = 0;
d88aee68 964 uint64_t key = msg.u.get_channel.key;
ffe60014 965 struct lttng_consumer_channel *channel;
ffe60014
DG
966
967 channel = consumer_find_channel(key);
968 if (!channel) {
8fd623e0 969 ERR("UST consumer get channel key %" PRIu64 " not found", key);
ffe60014
DG
970 ret_code = LTTNG_ERR_UST_CHAN_NOT_FOUND;
971 goto end_msg_sessiond;
972 }
973
974 /* Inform sessiond that we are about to send channel and streams. */
975 ret = consumer_send_status_msg(sock, LTTNG_OK);
976 if (ret < 0) {
977 /* Somehow, the session daemon is not responding anymore. */
978 goto end_nosignal;
979 }
980
981 /* Send everything to sessiond. */
982 ret = send_sessiond_channel(sock, channel, ctx, &relayd_err);
983 if (ret < 0) {
984 if (relayd_err) {
985 /*
986 * We were unable to send to the relayd the stream so avoid
987 * sending back a fatal error to the thread since this is OK
988 * and the consumer can continue its work.
989 */
990 ret_code = LTTNG_ERR_RELAYD_CONNECT_FAIL;
991 goto end_msg_sessiond;
992 }
993 /*
994 * The communicaton was broken hence there is a bad state between
995 * the consumer and sessiond so stop everything.
996 */
997 goto error_fatal;
998 }
999
d88aee68
DG
1000 ret = send_streams_to_thread(channel, ctx);
1001 if (ret < 0) {
1002 /*
1003 * If we are unable to send the stream to the thread, there is
1004 * a big problem so just stop everything.
1005 */
1006 goto error_fatal;
ffe60014 1007 }
ffe60014
DG
1008 /* List MUST be empty after or else it could be reused. */
1009 assert(cds_list_empty(&channel->streams.head));
1010
d88aee68
DG
1011 goto end_msg_sessiond;
1012 }
1013 case LTTNG_CONSUMER_DESTROY_CHANNEL:
1014 {
1015 uint64_t key = msg.u.destroy_channel.key;
d88aee68 1016
a0cbdd2e
MD
1017 /*
1018 * Only called if streams have not been sent to stream
1019 * manager thread. However, channel has been sent to
1020 * channel manager thread.
1021 */
1022 notify_thread_del_channel(ctx, key);
d88aee68 1023 goto end_msg_sessiond;
ffe60014 1024 }
d88aee68
DG
1025 case LTTNG_CONSUMER_CLOSE_METADATA:
1026 {
1027 int ret;
1028
1029 ret = close_metadata(msg.u.close_metadata.key);
1030 if (ret != 0) {
1031 ret_code = ret;
1032 }
1033
1034 goto end_msg_sessiond;
1035 }
7972aab2
DG
1036 case LTTNG_CONSUMER_FLUSH_CHANNEL:
1037 {
1038 int ret;
1039
1040 ret = flush_channel(msg.u.flush_channel.key);
1041 if (ret != 0) {
1042 ret_code = ret;
1043 }
1044
1045 goto end_msg_sessiond;
1046 }
d88aee68 1047 case LTTNG_CONSUMER_PUSH_METADATA:
ffe60014
DG
1048 {
1049 int ret;
d88aee68 1050 uint64_t len = msg.u.push_metadata.len;
d88aee68 1051 uint64_t key = msg.u.push_metadata.key;
331744e3 1052 uint64_t offset = msg.u.push_metadata.target_offset;
ffe60014
DG
1053 struct lttng_consumer_channel *channel;
1054
8fd623e0
DG
1055 DBG("UST consumer push metadata key %" PRIu64 " of len %" PRIu64, key,
1056 len);
ffe60014
DG
1057
1058 channel = consumer_find_channel(key);
1059 if (!channel) {
8fd623e0 1060 ERR("UST consumer push metadata %" PRIu64 " not found", key);
ffe60014 1061 ret_code = LTTNG_ERR_UST_CHAN_NOT_FOUND;
4a2eb0ca 1062 goto end_msg_sessiond;
d88aee68
DG
1063 }
1064
1065 /* Tell session daemon we are ready to receive the metadata. */
ffe60014
DG
1066 ret = consumer_send_status_msg(sock, LTTNG_OK);
1067 if (ret < 0) {
1068 /* Somehow, the session daemon is not responding anymore. */
d88aee68
DG
1069 goto error_fatal;
1070 }
1071
1072 /* Wait for more data. */
1073 if (lttng_consumer_poll_socket(consumer_sockpoll) < 0) {
1074 goto end_nosignal;
1075 }
1076
331744e3
JD
1077 ret = lttng_ustconsumer_recv_metadata(sock, key, offset,
1078 len, channel);
d88aee68 1079 if (ret < 0) {
331744e3 1080 /* error receiving from sessiond */
ffe60014 1081 goto end_nosignal;
331744e3
JD
1082 } else {
1083 ret_code = ret;
d88aee68
DG
1084 goto end_msg_sessiond;
1085 }
d88aee68
DG
1086 }
1087 case LTTNG_CONSUMER_SETUP_METADATA:
1088 {
1089 int ret;
1090
1091 ret = setup_metadata(ctx, msg.u.setup_metadata.key);
1092 if (ret) {
1093 ret_code = ret;
1094 }
1095 goto end_msg_sessiond;
ffe60014 1096 }
3bd1e081
MD
1097 default:
1098 break;
1099 }
3f8e211f 1100
3bd1e081 1101end_nosignal:
b0b335c8 1102 rcu_read_unlock();
4cbc1a04
DG
1103
1104 /*
1105 * Return 1 to indicate success since the 0 value can be a socket
1106 * shutdown during the recv() or send() call.
1107 */
1108 return 1;
ffe60014
DG
1109
1110end_msg_sessiond:
1111 /*
1112 * The returned value here is not useful since either way we'll return 1 to
1113 * the caller because the session daemon socket management is done
1114 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1115 */
1116 (void) consumer_send_status_msg(sock, ret_code);
1117 rcu_read_unlock();
1118 return 1;
1119end_channel_error:
1120 if (channel) {
1121 /*
1122 * Free channel here since no one has a reference to it. We don't
1123 * free after that because a stream can store this pointer.
1124 */
1125 destroy_channel(channel);
1126 }
1127 /* We have to send a status channel message indicating an error. */
1128 ret = consumer_send_status_channel(sock, NULL);
1129 if (ret < 0) {
1130 /* Stop everything if session daemon can not be notified. */
1131 goto error_fatal;
1132 }
1133 rcu_read_unlock();
1134 return 1;
1135error_fatal:
1136 rcu_read_unlock();
1137 /* This will issue a consumer stop. */
1138 return -1;
3bd1e081
MD
1139}
1140
ffe60014
DG
1141/*
1142 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1143 * compiled out, we isolate it in this library.
1144 */
1145int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
1146 unsigned long *off)
3bd1e081 1147{
ffe60014
DG
1148 assert(stream);
1149 assert(stream->ustream);
b5c5fc29 1150
ffe60014 1151 return ustctl_get_mmap_read_offset(stream->ustream, off);
3bd1e081
MD
1152}
1153
ffe60014
DG
1154/*
1155 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1156 * compiled out, we isolate it in this library.
1157 */
1158void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream *stream)
d056b477 1159{
ffe60014
DG
1160 assert(stream);
1161 assert(stream->ustream);
1162
1163 return ustctl_get_mmap_base(stream->ustream);
d056b477
MD
1164}
1165
ffe60014
DG
1166/*
1167 * Take a snapshot for a specific fd
1168 *
1169 * Returns 0 on success, < 0 on error
1170 */
1171int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
3bd1e081 1172{
ffe60014
DG
1173 assert(stream);
1174 assert(stream->ustream);
1175
1176 return ustctl_snapshot(stream->ustream);
3bd1e081
MD
1177}
1178
ffe60014
DG
1179/*
1180 * Get the produced position
1181 *
1182 * Returns 0 on success, < 0 on error
1183 */
1184int lttng_ustconsumer_get_produced_snapshot(
1185 struct lttng_consumer_stream *stream, unsigned long *pos)
3bd1e081 1186{
ffe60014
DG
1187 assert(stream);
1188 assert(stream->ustream);
1189 assert(pos);
7a57cf92 1190
ffe60014
DG
1191 return ustctl_snapshot_get_produced(stream->ustream, pos);
1192}
7a57cf92 1193
ffe60014
DG
1194/*
1195 * Called when the stream signal the consumer that it has hang up.
1196 */
1197void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
1198{
1199 assert(stream);
1200 assert(stream->ustream);
2c1dd183 1201
ffe60014
DG
1202 ustctl_flush_buffer(stream->ustream, 0);
1203 stream->hangup_flush_done = 1;
1204}
ee77a7b0 1205
ffe60014
DG
1206void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
1207{
1208 assert(chan);
1209 assert(chan->uchan);
e316aad5 1210
ea88ca2a
MD
1211 if (chan->switch_timer_enabled == 1) {
1212 consumer_timer_switch_stop(chan);
1213 }
1214 consumer_metadata_cache_destroy(chan);
ffe60014 1215 ustctl_destroy_channel(chan->uchan);
3bd1e081
MD
1216}
1217
1218void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
1219{
ffe60014
DG
1220 assert(stream);
1221 assert(stream->ustream);
d41f73b7 1222
ea88ca2a
MD
1223 if (stream->chan->switch_timer_enabled == 1) {
1224 consumer_timer_switch_stop(stream->chan);
1225 }
ffe60014
DG
1226 ustctl_destroy_stream(stream->ustream);
1227}
d41f73b7
MD
1228
1229int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
1230 struct lttng_consumer_local_data *ctx)
1231{
1d4dfdef 1232 unsigned long len, subbuf_size, padding;
d41f73b7
MD
1233 int err;
1234 long ret = 0;
d41f73b7 1235 char dummy;
ffe60014
DG
1236 struct ustctl_consumer_stream *ustream;
1237
1238 assert(stream);
1239 assert(stream->ustream);
1240 assert(ctx);
d41f73b7 1241
ffe60014
DG
1242 DBG2("In UST read_subbuffer (wait_fd: %d, name: %s)", stream->wait_fd,
1243 stream->name);
1244
1245 /* Ease our life for what's next. */
1246 ustream = stream->ustream;
d41f73b7
MD
1247
1248 /* We can consume the 1 byte written into the wait_fd by UST */
effcf122 1249 if (!stream->hangup_flush_done) {
c617c0c6
MD
1250 ssize_t readlen;
1251
effcf122
MD
1252 do {
1253 readlen = read(stream->wait_fd, &dummy, 1);
87dc6a9c 1254 } while (readlen == -1 && errno == EINTR);
effcf122
MD
1255 if (readlen == -1) {
1256 ret = readlen;
1257 goto end;
1258 }
d41f73b7
MD
1259 }
1260
d41f73b7 1261 /* Get the next subbuffer */
ffe60014 1262 err = ustctl_get_next_subbuf(ustream);
d41f73b7 1263 if (err != 0) {
1d4dfdef 1264 ret = err; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
d41f73b7
MD
1265 /*
1266 * This is a debug message even for single-threaded consumer,
1267 * because poll() have more relaxed criterions than get subbuf,
1268 * so get_subbuf may fail for short race windows where poll()
1269 * would issue wakeups.
1270 */
1271 DBG("Reserving sub buffer failed (everything is normal, "
ffe60014 1272 "it is due to concurrency) [ret: %d]", err);
d41f73b7
MD
1273 goto end;
1274 }
ffe60014 1275 assert(stream->chan->output == CONSUMER_CHANNEL_MMAP);
1d4dfdef 1276 /* Get the full padded subbuffer size */
ffe60014 1277 err = ustctl_get_padded_subbuf_size(ustream, &len);
effcf122 1278 assert(err == 0);
1d4dfdef
DG
1279
1280 /* Get subbuffer data size (without padding) */
ffe60014 1281 err = ustctl_get_subbuf_size(ustream, &subbuf_size);
1d4dfdef
DG
1282 assert(err == 0);
1283
1284 /* Make sure we don't get a subbuffer size bigger than the padded */
1285 assert(len >= subbuf_size);
1286
1287 padding = len - subbuf_size;
d41f73b7 1288 /* write the subbuffer to the tracefile */
1d4dfdef 1289 ret = lttng_consumer_on_read_subbuffer_mmap(ctx, stream, subbuf_size, padding);
91dfef6e
DG
1290 /*
1291 * The mmap operation should write subbuf_size amount of data when network
1292 * streaming or the full padding (len) size when we are _not_ streaming.
1293 */
d88aee68
DG
1294 if ((ret != subbuf_size && stream->net_seq_idx != (uint64_t) -1ULL) ||
1295 (ret != len && stream->net_seq_idx == (uint64_t) -1ULL)) {
d41f73b7 1296 /*
91dfef6e 1297 * Display the error but continue processing to try to release the
c5c45efa
DG
1298 * subbuffer. This is a DBG statement since any unexpected kill or
1299 * signal, the application gets unregistered, relayd gets closed or
1300 * anything that affects the buffer lifetime will trigger this error.
1301 * So, for the sake of the user, don't print this error since it can
1302 * happen and it is OK with the code flow.
d41f73b7 1303 */
c5c45efa 1304 DBG("Error writing to tracefile "
8fd623e0 1305 "(ret: %ld != len: %lu != subbuf_size: %lu)",
91dfef6e 1306 ret, len, subbuf_size);
d41f73b7 1307 }
ffe60014 1308 err = ustctl_put_next_subbuf(ustream);
effcf122 1309 assert(err == 0);
331744e3 1310
d41f73b7
MD
1311end:
1312 return ret;
1313}
1314
ffe60014
DG
1315/*
1316 * Called when a stream is created.
fe4477ee
JD
1317 *
1318 * Return 0 on success or else a negative value.
ffe60014 1319 */
d41f73b7
MD
1320int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
1321{
fe4477ee
JD
1322 int ret;
1323
1324 /* Don't create anything if this is set for streaming. */
1325 if (stream->net_seq_idx == (uint64_t) -1ULL) {
1326 ret = utils_create_stream_file(stream->chan->pathname, stream->name,
1327 stream->chan->tracefile_size, stream->tracefile_count_current,
1328 stream->uid, stream->gid);
1329 if (ret < 0) {
1330 goto error;
1331 }
1332 stream->out_fd = ret;
1333 stream->tracefile_size_current = 0;
1334 }
1335 ret = 0;
1336
1337error:
1338 return ret;
d41f73b7 1339}
ca22feea
DG
1340
1341/*
1342 * Check if data is still being extracted from the buffers for a specific
4e9a4686
DG
1343 * stream. Consumer data lock MUST be acquired before calling this function
1344 * and the stream lock.
ca22feea 1345 *
6d805429 1346 * Return 1 if the traced data are still getting read else 0 meaning that the
ca22feea
DG
1347 * data is available for trace viewer reading.
1348 */
6d805429 1349int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
ca22feea
DG
1350{
1351 int ret;
1352
1353 assert(stream);
ffe60014 1354 assert(stream->ustream);
ca22feea 1355
6d805429 1356 DBG("UST consumer checking data pending");
c8f59ee5 1357
ffe60014 1358 ret = ustctl_get_next_subbuf(stream->ustream);
ca22feea
DG
1359 if (ret == 0) {
1360 /* There is still data so let's put back this subbuffer. */
ffe60014 1361 ret = ustctl_put_subbuf(stream->ustream);
ca22feea 1362 assert(ret == 0);
6d805429 1363 ret = 1; /* Data is pending */
4e9a4686 1364 goto end;
ca22feea
DG
1365 }
1366
6d805429
DG
1367 /* Data is NOT pending so ready to be read. */
1368 ret = 0;
ca22feea 1369
6efae65e
DG
1370end:
1371 return ret;
ca22feea 1372}
d88aee68
DG
1373
1374/*
1375 * Close every metadata stream wait fd of the metadata hash table. This
1376 * function MUST be used very carefully so not to run into a race between the
1377 * metadata thread handling streams and this function closing their wait fd.
1378 *
1379 * For UST, this is used when the session daemon hangs up. Its the metadata
1380 * producer so calling this is safe because we are assured that no state change
1381 * can occur in the metadata thread for the streams in the hash table.
1382 */
1383void lttng_ustconsumer_close_metadata(struct lttng_ht *metadata_ht)
1384{
1385 int ret;
1386 struct lttng_ht_iter iter;
1387 struct lttng_consumer_stream *stream;
1388
1389 assert(metadata_ht);
1390 assert(metadata_ht->ht);
1391
1392 DBG("UST consumer closing all metadata streams");
1393
1394 rcu_read_lock();
1395 cds_lfht_for_each_entry(metadata_ht->ht, &iter.iter, stream,
1396 node.node) {
1397 int fd = stream->wait_fd;
1398
1399 /*
1400 * Whatever happens here we have to continue to try to close every
1401 * streams. Let's report at least the error on failure.
1402 */
1403 ret = ustctl_stream_close_wakeup_fd(stream->ustream);
1404 if (ret) {
1405 ERR("Unable to close metadata stream fd %d ret %d", fd, ret);
1406 }
1407 DBG("Metadata wait fd %d closed", fd);
1408 }
1409 rcu_read_unlock();
1410}
d8ef542d
MD
1411
1412void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
1413{
1414 int ret;
1415
1416 ret = ustctl_stream_close_wakeup_fd(stream->ustream);
1417 if (ret < 0) {
1418 ERR("Unable to close wakeup fd");
1419 }
1420}
331744e3
JD
1421
1422int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
1423 struct lttng_consumer_channel *channel)
1424{
1425 struct lttcomm_metadata_request_msg request;
1426 struct lttcomm_consumer_msg msg;
1427 enum lttng_error_code ret_code = LTTNG_OK;
1428 uint64_t len, key, offset;
1429 int ret;
1430
1431 assert(channel);
1432 assert(channel->metadata_cache);
1433
1434 /* send the metadata request to sessiond */
1435 switch (consumer_data.type) {
1436 case LTTNG_CONSUMER64_UST:
1437 request.bits_per_long = 64;
1438 break;
1439 case LTTNG_CONSUMER32_UST:
1440 request.bits_per_long = 32;
1441 break;
1442 default:
1443 request.bits_per_long = 0;
1444 break;
1445 }
1446
1447 request.session_id = channel->session_id;
1448 request.uid = channel->uid;
1449 request.key = channel->key;
1450 DBG("Sending metadata request to sessiond, session %" PRIu64,
1451 channel->session_id);
1452
1453 ret = lttcomm_send_unix_sock(ctx->consumer_metadata_socket, &request,
1454 sizeof(request));
1455 if (ret < 0) {
1456 ERR("Asking metadata to sessiond");
1457 goto end;
1458 }
1459
1460 /* Receive the metadata from sessiond */
1461 ret = lttcomm_recv_unix_sock(ctx->consumer_metadata_socket, &msg,
1462 sizeof(msg));
1463 if (ret != sizeof(msg)) {
8fd623e0 1464 DBG("Consumer received unexpected message size %d (expects %zu)",
331744e3
JD
1465 ret, sizeof(msg));
1466 lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_ERROR_RECV_CMD);
1467 /*
1468 * The ret value might 0 meaning an orderly shutdown but this is ok
1469 * since the caller handles this.
1470 */
1471 goto end;
1472 }
1473
1474 if (msg.cmd_type == LTTNG_ERR_UND) {
1475 /* No registry found */
1476 (void) consumer_send_status_msg(ctx->consumer_metadata_socket,
1477 ret_code);
1478 ret = 0;
1479 goto end;
1480 } else if (msg.cmd_type != LTTNG_CONSUMER_PUSH_METADATA) {
1481 ERR("Unexpected cmd_type received %d", msg.cmd_type);
1482 ret = -1;
1483 goto end;
1484 }
1485
1486 len = msg.u.push_metadata.len;
1487 key = msg.u.push_metadata.key;
1488 offset = msg.u.push_metadata.target_offset;
1489
1490 assert(key == channel->key);
1491 if (len == 0) {
1492 DBG("No new metadata to receive for key %" PRIu64, key);
1493 }
1494
1495 /* Tell session daemon we are ready to receive the metadata. */
1496 ret = consumer_send_status_msg(ctx->consumer_metadata_socket,
1497 LTTNG_OK);
1498 if (ret < 0 || len == 0) {
1499 /*
1500 * Somehow, the session daemon is not responding anymore or there is
1501 * nothing to receive.
1502 */
1503 goto end;
1504 }
1505
1506 ret_code = lttng_ustconsumer_recv_metadata(ctx->consumer_metadata_socket,
1507 key, offset, len, channel);
1508 (void) consumer_send_status_msg(ctx->consumer_metadata_socket, ret_code);
1509 ret = 0;
1510
1511end:
1512 return ret;
1513}
This page took 0.107403 seconds and 4 git commands to generate.