Debugger support: introduce LTTNG_DEBUG_NOCLONE env. var.
[lttng-tools.git] / src / common / consumer.c
CommitLineData
3bd1e081
MD
1/*
2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; only version 2
8 * of the License.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 */
19
20#define _GNU_SOURCE
21#include <assert.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>
28#include <sys/types.h>
29#include <unistd.h>
30
990570ed 31#include <common/common.h>
10a8a223
DG
32#include <common/kernel-ctl/kernel-ctl.h>
33#include <common/sessiond-comm/sessiond-comm.h>
34#include <common/kernel-consumer/kernel-consumer.h>
35#include <common/ust-consumer/ust-consumer.h>
36
37#include "consumer.h"
3bd1e081
MD
38
39struct lttng_consumer_global_data consumer_data = {
3bd1e081
MD
40 .stream_count = 0,
41 .need_update = 1,
42 .type = LTTNG_CONSUMER_UNKNOWN,
43};
44
45/* timeout parameter, to control the polling thread grace period. */
46int consumer_poll_timeout = -1;
47
48/*
49 * Flag to inform the polling thread to quit when all fd hung up. Updated by
50 * the consumer_thread_receive_fds when it notices that all fds has hung up.
51 * Also updated by the signal handler (consumer_should_exit()). Read by the
52 * polling threads.
53 */
54volatile int consumer_quit = 0;
55
56/*
57 * Find a stream. The consumer_data.lock must be locked during this
58 * call.
59 */
60static struct lttng_consumer_stream *consumer_find_stream(int key)
61{
e4421fec
DG
62 struct lttng_ht_iter iter;
63 struct lttng_ht_node_ulong *node;
64 struct lttng_consumer_stream *stream = NULL;
3bd1e081 65
7ad0a0cb
MD
66 /* Negative keys are lookup failures */
67 if (key < 0)
68 return NULL;
e4421fec 69
6065ceec
DG
70 rcu_read_lock();
71
e4421fec
DG
72 lttng_ht_lookup(consumer_data.stream_ht, (void *)((unsigned long) key),
73 &iter);
74 node = lttng_ht_iter_get_node_ulong(&iter);
75 if (node != NULL) {
76 stream = caa_container_of(node, struct lttng_consumer_stream, node);
3bd1e081 77 }
e4421fec 78
6065ceec
DG
79 rcu_read_unlock();
80
e4421fec 81 return stream;
3bd1e081
MD
82}
83
7ad0a0cb
MD
84static void consumer_steal_stream_key(int key)
85{
86 struct lttng_consumer_stream *stream;
87
88 stream = consumer_find_stream(key);
89 if (stream)
90 stream->key = -1;
91}
92
3bd1e081
MD
93static struct lttng_consumer_channel *consumer_find_channel(int key)
94{
e4421fec
DG
95 struct lttng_ht_iter iter;
96 struct lttng_ht_node_ulong *node;
97 struct lttng_consumer_channel *channel = NULL;
3bd1e081 98
7ad0a0cb
MD
99 /* Negative keys are lookup failures */
100 if (key < 0)
101 return NULL;
e4421fec 102
6065ceec
DG
103 rcu_read_lock();
104
e4421fec
DG
105 lttng_ht_lookup(consumer_data.channel_ht, (void *)((unsigned long) key),
106 &iter);
107 node = lttng_ht_iter_get_node_ulong(&iter);
108 if (node != NULL) {
109 channel = caa_container_of(node, struct lttng_consumer_channel, node);
3bd1e081 110 }
e4421fec 111
6065ceec
DG
112 rcu_read_unlock();
113
e4421fec 114 return channel;
3bd1e081
MD
115}
116
7ad0a0cb
MD
117static void consumer_steal_channel_key(int key)
118{
119 struct lttng_consumer_channel *channel;
120
121 channel = consumer_find_channel(key);
122 if (channel)
123 channel->key = -1;
124}
125
3bd1e081
MD
126/*
127 * Remove a stream from the global list protected by a mutex. This
128 * function is also responsible for freeing its data structures.
129 */
130void consumer_del_stream(struct lttng_consumer_stream *stream)
131{
132 int ret;
e4421fec 133 struct lttng_ht_iter iter;
3bd1e081
MD
134 struct lttng_consumer_channel *free_chan = NULL;
135
136 pthread_mutex_lock(&consumer_data.lock);
137
138 switch (consumer_data.type) {
139 case LTTNG_CONSUMER_KERNEL:
140 if (stream->mmap_base != NULL) {
141 ret = munmap(stream->mmap_base, stream->mmap_len);
142 if (ret != 0) {
143 perror("munmap");
144 }
145 }
146 break;
7753dea8
MD
147 case LTTNG_CONSUMER32_UST:
148 case LTTNG_CONSUMER64_UST:
3bd1e081
MD
149 lttng_ustconsumer_del_stream(stream);
150 break;
151 default:
152 ERR("Unknown consumer_data type");
153 assert(0);
154 goto end;
155 }
156
6065ceec
DG
157 rcu_read_lock();
158
e4421fec
DG
159 /* Get stream node from hash table */
160 lttng_ht_lookup(consumer_data.stream_ht,
161 (void *)((unsigned long) stream->key), &iter);
162 /* Remove stream node from hash table */
163 ret = lttng_ht_del(consumer_data.stream_ht, &iter);
164 assert(!ret);
165
6065ceec
DG
166 rcu_read_unlock();
167
3bd1e081
MD
168 if (consumer_data.stream_count <= 0) {
169 goto end;
170 }
171 consumer_data.stream_count--;
172 if (!stream) {
173 goto end;
174 }
175 if (stream->out_fd >= 0) {
176 close(stream->out_fd);
177 }
b5c5fc29 178 if (stream->wait_fd >= 0 && !stream->wait_fd_is_copy) {
3bd1e081
MD
179 close(stream->wait_fd);
180 }
2c1dd183 181 if (stream->shm_fd >= 0 && stream->wait_fd != stream->shm_fd) {
3bd1e081
MD
182 close(stream->shm_fd);
183 }
184 if (!--stream->chan->refcount)
185 free_chan = stream->chan;
186 free(stream);
187end:
188 consumer_data.need_update = 1;
189 pthread_mutex_unlock(&consumer_data.lock);
190
191 if (free_chan)
192 consumer_del_channel(free_chan);
193}
194
6065ceec
DG
195static void consumer_del_stream_rcu(struct rcu_head *head)
196{
197 struct lttng_ht_node_ulong *node =
198 caa_container_of(head, struct lttng_ht_node_ulong, head);
199 struct lttng_consumer_stream *stream =
200 caa_container_of(node, struct lttng_consumer_stream, node);
201
202 consumer_del_stream(stream);
203}
204
3bd1e081
MD
205struct lttng_consumer_stream *consumer_allocate_stream(
206 int channel_key, int stream_key,
207 int shm_fd, int wait_fd,
208 enum lttng_consumer_stream_state state,
209 uint64_t mmap_len,
210 enum lttng_event_output output,
6df2e2c9
MD
211 const char *path_name,
212 uid_t uid,
213 gid_t gid)
3bd1e081
MD
214{
215 struct lttng_consumer_stream *stream;
216 int ret;
217
effcf122 218 stream = zmalloc(sizeof(*stream));
3bd1e081
MD
219 if (stream == NULL) {
220 perror("malloc struct lttng_consumer_stream");
221 goto end;
222 }
223 stream->chan = consumer_find_channel(channel_key);
224 if (!stream->chan) {
225 perror("Unable to find channel key");
226 goto end;
227 }
228 stream->chan->refcount++;
229 stream->key = stream_key;
230 stream->shm_fd = shm_fd;
231 stream->wait_fd = wait_fd;
232 stream->out_fd = -1;
233 stream->out_fd_offset = 0;
234 stream->state = state;
235 stream->mmap_len = mmap_len;
236 stream->mmap_base = NULL;
237 stream->output = output;
6df2e2c9
MD
238 stream->uid = uid;
239 stream->gid = gid;
3bd1e081
MD
240 strncpy(stream->path_name, path_name, PATH_MAX - 1);
241 stream->path_name[PATH_MAX - 1] = '\0';
e4421fec 242 lttng_ht_node_init_ulong(&stream->node, stream->key);
3bd1e081
MD
243
244 switch (consumer_data.type) {
245 case LTTNG_CONSUMER_KERNEL:
246 break;
7753dea8
MD
247 case LTTNG_CONSUMER32_UST:
248 case LTTNG_CONSUMER64_UST:
5af2f756 249 stream->cpu = stream->chan->cpucount++;
3bd1e081
MD
250 ret = lttng_ustconsumer_allocate_stream(stream);
251 if (ret) {
252 free(stream);
253 return NULL;
254 }
255 break;
256 default:
257 ERR("Unknown consumer_data type");
258 assert(0);
259 goto end;
260 }
261 DBG("Allocated stream %s (key %d, shm_fd %d, wait_fd %d, mmap_len %llu, out_fd %d)",
262 stream->path_name, stream->key,
263 stream->shm_fd,
264 stream->wait_fd,
265 (unsigned long long) stream->mmap_len,
266 stream->out_fd);
267end:
268 return stream;
269}
270
271/*
272 * Add a stream to the global list protected by a mutex.
273 */
274int consumer_add_stream(struct lttng_consumer_stream *stream)
275{
276 int ret = 0;
277
278 pthread_mutex_lock(&consumer_data.lock);
7ad0a0cb
MD
279 /* Steal stream identifier, for UST */
280 consumer_steal_stream_key(stream->key);
6065ceec 281 rcu_read_lock();
e4421fec 282 lttng_ht_add_unique_ulong(consumer_data.stream_ht, &stream->node);
6065ceec 283 rcu_read_unlock();
3bd1e081
MD
284 consumer_data.stream_count++;
285 consumer_data.need_update = 1;
286
287 switch (consumer_data.type) {
288 case LTTNG_CONSUMER_KERNEL:
289 break;
7753dea8
MD
290 case LTTNG_CONSUMER32_UST:
291 case LTTNG_CONSUMER64_UST:
3bd1e081
MD
292 /* Streams are in CPU number order (we rely on this) */
293 stream->cpu = stream->chan->nr_streams++;
294 break;
295 default:
296 ERR("Unknown consumer_data type");
297 assert(0);
298 goto end;
299 }
300
301end:
302 pthread_mutex_unlock(&consumer_data.lock);
303 return ret;
304}
305
306/*
307 * Update a stream according to what we just received.
308 */
309void consumer_change_stream_state(int stream_key,
310 enum lttng_consumer_stream_state state)
311{
312 struct lttng_consumer_stream *stream;
313
314 pthread_mutex_lock(&consumer_data.lock);
315 stream = consumer_find_stream(stream_key);
316 if (stream) {
317 stream->state = state;
318 }
319 consumer_data.need_update = 1;
320 pthread_mutex_unlock(&consumer_data.lock);
321}
322
323/*
324 * Remove a channel from the global list protected by a mutex. This
325 * function is also responsible for freeing its data structures.
326 */
327void consumer_del_channel(struct lttng_consumer_channel *channel)
328{
329 int ret;
e4421fec 330 struct lttng_ht_iter iter;
3bd1e081
MD
331
332 pthread_mutex_lock(&consumer_data.lock);
333
334 switch (consumer_data.type) {
335 case LTTNG_CONSUMER_KERNEL:
336 break;
7753dea8
MD
337 case LTTNG_CONSUMER32_UST:
338 case LTTNG_CONSUMER64_UST:
3bd1e081
MD
339 lttng_ustconsumer_del_channel(channel);
340 break;
341 default:
342 ERR("Unknown consumer_data type");
343 assert(0);
344 goto end;
345 }
346
6065ceec
DG
347 rcu_read_lock();
348
e4421fec
DG
349 lttng_ht_lookup(consumer_data.channel_ht,
350 (void *)((unsigned long) channel->key), &iter);
351 ret = lttng_ht_del(consumer_data.channel_ht, &iter);
352 assert(!ret);
353
6065ceec
DG
354 rcu_read_unlock();
355
3bd1e081
MD
356 if (channel->mmap_base != NULL) {
357 ret = munmap(channel->mmap_base, channel->mmap_len);
358 if (ret != 0) {
359 perror("munmap");
360 }
361 }
b5c5fc29 362 if (channel->wait_fd >= 0 && !channel->wait_fd_is_copy) {
3bd1e081
MD
363 close(channel->wait_fd);
364 }
2c1dd183 365 if (channel->shm_fd >= 0 && channel->wait_fd != channel->shm_fd) {
3bd1e081
MD
366 close(channel->shm_fd);
367 }
368 free(channel);
369end:
370 pthread_mutex_unlock(&consumer_data.lock);
371}
372
6065ceec
DG
373static void consumer_del_channel_rcu(struct rcu_head *head)
374{
375 struct lttng_ht_node_ulong *node =
376 caa_container_of(head, struct lttng_ht_node_ulong, head);
377 struct lttng_consumer_channel *channel=
378 caa_container_of(node, struct lttng_consumer_channel, node);
379
380 consumer_del_channel(channel);
381}
382
3bd1e081
MD
383struct lttng_consumer_channel *consumer_allocate_channel(
384 int channel_key,
385 int shm_fd, int wait_fd,
386 uint64_t mmap_len,
387 uint64_t max_sb_size)
388{
389 struct lttng_consumer_channel *channel;
390 int ret;
391
276b26d1 392 channel = zmalloc(sizeof(*channel));
3bd1e081
MD
393 if (channel == NULL) {
394 perror("malloc struct lttng_consumer_channel");
395 goto end;
396 }
397 channel->key = channel_key;
398 channel->shm_fd = shm_fd;
399 channel->wait_fd = wait_fd;
400 channel->mmap_len = mmap_len;
401 channel->max_sb_size = max_sb_size;
402 channel->refcount = 0;
403 channel->nr_streams = 0;
e4421fec 404 lttng_ht_node_init_ulong(&channel->node, channel->key);
3bd1e081
MD
405
406 switch (consumer_data.type) {
407 case LTTNG_CONSUMER_KERNEL:
408 channel->mmap_base = NULL;
409 channel->mmap_len = 0;
410 break;
7753dea8
MD
411 case LTTNG_CONSUMER32_UST:
412 case LTTNG_CONSUMER64_UST:
3bd1e081
MD
413 ret = lttng_ustconsumer_allocate_channel(channel);
414 if (ret) {
415 free(channel);
416 return NULL;
417 }
418 break;
419 default:
420 ERR("Unknown consumer_data type");
421 assert(0);
422 goto end;
423 }
424 DBG("Allocated channel (key %d, shm_fd %d, wait_fd %d, mmap_len %llu, max_sb_size %llu)",
425 channel->key,
426 channel->shm_fd,
427 channel->wait_fd,
428 (unsigned long long) channel->mmap_len,
429 (unsigned long long) channel->max_sb_size);
430end:
431 return channel;
432}
433
434/*
435 * Add a channel to the global list protected by a mutex.
436 */
437int consumer_add_channel(struct lttng_consumer_channel *channel)
438{
3bd1e081 439 pthread_mutex_lock(&consumer_data.lock);
7ad0a0cb
MD
440 /* Steal channel identifier, for UST */
441 consumer_steal_channel_key(channel->key);
6065ceec 442 rcu_read_lock();
e4421fec 443 lttng_ht_add_unique_ulong(consumer_data.channel_ht, &channel->node);
6065ceec 444 rcu_read_unlock();
3bd1e081 445 pthread_mutex_unlock(&consumer_data.lock);
7ad0a0cb 446 return 0;
3bd1e081
MD
447}
448
449/*
450 * Allocate the pollfd structure and the local view of the out fds to avoid
451 * doing a lookup in the linked list and concurrency issues when writing is
452 * needed. Called with consumer_data.lock held.
453 *
454 * Returns the number of fds in the structures.
455 */
456int consumer_update_poll_array(
457 struct lttng_consumer_local_data *ctx, struct pollfd **pollfd,
458 struct lttng_consumer_stream **local_stream)
459{
3bd1e081 460 int i = 0;
e4421fec
DG
461 struct lttng_ht_iter iter;
462 struct lttng_consumer_stream *stream;
3bd1e081
MD
463
464 DBG("Updating poll fd array");
e4421fec
DG
465 cds_lfht_for_each_entry(consumer_data.stream_ht->ht, &iter.iter, stream,
466 node.node) {
467 if (stream->state != LTTNG_CONSUMER_ACTIVE_STREAM) {
3bd1e081
MD
468 continue;
469 }
e4421fec
DG
470 DBG("Active FD %d", stream->wait_fd);
471 (*pollfd)[i].fd = stream->wait_fd;
3bd1e081 472 (*pollfd)[i].events = POLLIN | POLLPRI;
e4421fec 473 local_stream[i] = stream;
3bd1e081
MD
474 i++;
475 }
476
477 /*
478 * Insert the consumer_poll_pipe at the end of the array and don't
479 * increment i so nb_fd is the number of real FD.
480 */
481 (*pollfd)[i].fd = ctx->consumer_poll_pipe[0];
482 (*pollfd)[i].events = POLLIN;
483 return i;
484}
485
486/*
487 * Poll on the should_quit pipe and the command socket return -1 on error and
488 * should exit, 0 if data is available on the command socket
489 */
490int lttng_consumer_poll_socket(struct pollfd *consumer_sockpoll)
491{
492 int num_rdy;
493
494 num_rdy = poll(consumer_sockpoll, 2, -1);
495 if (num_rdy == -1) {
496 perror("Poll error");
497 goto exit;
498 }
499 if (consumer_sockpoll[0].revents == POLLIN) {
500 DBG("consumer_should_quit wake up");
501 goto exit;
502 }
503 return 0;
504
505exit:
506 return -1;
507}
508
509/*
510 * Set the error socket.
511 */
512void lttng_consumer_set_error_sock(
513 struct lttng_consumer_local_data *ctx, int sock)
514{
515 ctx->consumer_error_socket = sock;
516}
517
518/*
519 * Set the command socket path.
520 */
521
522void lttng_consumer_set_command_sock_path(
523 struct lttng_consumer_local_data *ctx, char *sock)
524{
525 ctx->consumer_command_sock_path = sock;
526}
527
528/*
529 * Send return code to the session daemon.
530 * If the socket is not defined, we return 0, it is not a fatal error
531 */
532int lttng_consumer_send_error(
533 struct lttng_consumer_local_data *ctx, int cmd)
534{
535 if (ctx->consumer_error_socket > 0) {
536 return lttcomm_send_unix_sock(ctx->consumer_error_socket, &cmd,
537 sizeof(enum lttcomm_sessiond_command));
538 }
539
540 return 0;
541}
542
543/*
544 * Close all the tracefiles and stream fds, should be called when all instances
545 * are destroyed.
546 */
547void lttng_consumer_cleanup(void)
548{
e4421fec
DG
549 int ret;
550 struct lttng_ht_iter iter;
6065ceec
DG
551 struct lttng_ht_node_ulong *node;
552
553 rcu_read_lock();
3bd1e081
MD
554
555 /*
6065ceec
DG
556 * close all outfd. Called when there are no more threads running (after
557 * joining on the threads), no need to protect list iteration with mutex.
3bd1e081 558 */
6065ceec
DG
559 cds_lfht_for_each_entry(consumer_data.stream_ht->ht, &iter.iter, node,
560 node) {
e4421fec
DG
561 ret = lttng_ht_del(consumer_data.stream_ht, &iter);
562 assert(!ret);
6065ceec 563 call_rcu(&node->head, consumer_del_stream_rcu);
3bd1e081 564 }
e4421fec 565
6065ceec
DG
566 cds_lfht_for_each_entry(consumer_data.channel_ht->ht, &iter.iter, node,
567 node) {
e4421fec
DG
568 ret = lttng_ht_del(consumer_data.channel_ht, &iter);
569 assert(!ret);
6065ceec 570 call_rcu(&node->head, consumer_del_channel_rcu);
3bd1e081 571 }
6065ceec
DG
572
573 rcu_read_unlock();
3bd1e081
MD
574}
575
576/*
577 * Called from signal handler.
578 */
579void lttng_consumer_should_exit(struct lttng_consumer_local_data *ctx)
580{
581 int ret;
582 consumer_quit = 1;
583 ret = write(ctx->consumer_should_quit[1], "4", 1);
584 if (ret < 0) {
585 perror("write consumer quit");
586 }
587}
588
589void lttng_consumer_sync_trace_file(
590 struct lttng_consumer_stream *stream, off_t orig_offset)
591{
592 int outfd = stream->out_fd;
593
594 /*
595 * This does a blocking write-and-wait on any page that belongs to the
596 * subbuffer prior to the one we just wrote.
597 * Don't care about error values, as these are just hints and ways to
598 * limit the amount of page cache used.
599 */
600 if (orig_offset < stream->chan->max_sb_size) {
601 return;
602 }
b9182dd9 603 lttng_sync_file_range(outfd, orig_offset - stream->chan->max_sb_size,
3bd1e081
MD
604 stream->chan->max_sb_size,
605 SYNC_FILE_RANGE_WAIT_BEFORE
606 | SYNC_FILE_RANGE_WRITE
607 | SYNC_FILE_RANGE_WAIT_AFTER);
608 /*
609 * Give hints to the kernel about how we access the file:
610 * POSIX_FADV_DONTNEED : we won't re-access data in a near future after
611 * we write it.
612 *
613 * We need to call fadvise again after the file grows because the
614 * kernel does not seem to apply fadvise to non-existing parts of the
615 * file.
616 *
617 * Call fadvise _after_ having waited for the page writeback to
618 * complete because the dirty page writeback semantic is not well
619 * defined. So it can be expected to lead to lower throughput in
620 * streaming.
621 */
622 posix_fadvise(outfd, orig_offset - stream->chan->max_sb_size,
623 stream->chan->max_sb_size, POSIX_FADV_DONTNEED);
624}
625
626/*
627 * Initialise the necessary environnement :
628 * - create a new context
629 * - create the poll_pipe
630 * - create the should_quit pipe (for signal handler)
631 * - create the thread pipe (for splice)
632 *
633 * Takes a function pointer as argument, this function is called when data is
634 * available on a buffer. This function is responsible to do the
635 * kernctl_get_next_subbuf, read the data with mmap or splice depending on the
636 * buffer configuration and then kernctl_put_next_subbuf at the end.
637 *
638 * Returns a pointer to the new context or NULL on error.
639 */
640struct lttng_consumer_local_data *lttng_consumer_create(
641 enum lttng_consumer_type type,
d41f73b7
MD
642 int (*buffer_ready)(struct lttng_consumer_stream *stream,
643 struct lttng_consumer_local_data *ctx),
3bd1e081
MD
644 int (*recv_channel)(struct lttng_consumer_channel *channel),
645 int (*recv_stream)(struct lttng_consumer_stream *stream),
646 int (*update_stream)(int stream_key, uint32_t state))
647{
648 int ret, i;
649 struct lttng_consumer_local_data *ctx;
650
651 assert(consumer_data.type == LTTNG_CONSUMER_UNKNOWN ||
652 consumer_data.type == type);
653 consumer_data.type = type;
654
effcf122 655 ctx = zmalloc(sizeof(struct lttng_consumer_local_data));
3bd1e081
MD
656 if (ctx == NULL) {
657 perror("allocating context");
658 goto error;
659 }
660
661 ctx->consumer_error_socket = -1;
662 /* assign the callbacks */
663 ctx->on_buffer_ready = buffer_ready;
664 ctx->on_recv_channel = recv_channel;
665 ctx->on_recv_stream = recv_stream;
666 ctx->on_update_stream = update_stream;
667
668 ret = pipe(ctx->consumer_poll_pipe);
669 if (ret < 0) {
670 perror("Error creating poll pipe");
671 goto error_poll_pipe;
672 }
673
674 ret = pipe(ctx->consumer_should_quit);
675 if (ret < 0) {
676 perror("Error creating recv pipe");
677 goto error_quit_pipe;
678 }
679
680 ret = pipe(ctx->consumer_thread_pipe);
681 if (ret < 0) {
682 perror("Error creating thread pipe");
683 goto error_thread_pipe;
684 }
685
686 return ctx;
687
688
689error_thread_pipe:
690 for (i = 0; i < 2; i++) {
691 int err;
692
693 err = close(ctx->consumer_should_quit[i]);
694 assert(!err);
695 }
696error_quit_pipe:
697 for (i = 0; i < 2; i++) {
698 int err;
699
700 err = close(ctx->consumer_poll_pipe[i]);
701 assert(!err);
702 }
703error_poll_pipe:
704 free(ctx);
705error:
706 return NULL;
707}
708
709/*
710 * Close all fds associated with the instance and free the context.
711 */
712void lttng_consumer_destroy(struct lttng_consumer_local_data *ctx)
713{
714 close(ctx->consumer_error_socket);
715 close(ctx->consumer_thread_pipe[0]);
716 close(ctx->consumer_thread_pipe[1]);
717 close(ctx->consumer_poll_pipe[0]);
718 close(ctx->consumer_poll_pipe[1]);
719 close(ctx->consumer_should_quit[0]);
720 close(ctx->consumer_should_quit[1]);
721 unlink(ctx->consumer_command_sock_path);
722 free(ctx);
723}
724
725/*
726 * Mmap the ring buffer, read it and write the data to the tracefile.
727 *
728 * Returns the number of bytes written
729 */
730int lttng_consumer_on_read_subbuffer_mmap(
731 struct lttng_consumer_local_data *ctx,
732 struct lttng_consumer_stream *stream, unsigned long len)
733{
734 switch (consumer_data.type) {
735 case LTTNG_CONSUMER_KERNEL:
736 return lttng_kconsumer_on_read_subbuffer_mmap(ctx, stream, len);
7753dea8
MD
737 case LTTNG_CONSUMER32_UST:
738 case LTTNG_CONSUMER64_UST:
3bd1e081
MD
739 return lttng_ustconsumer_on_read_subbuffer_mmap(ctx, stream, len);
740 default:
741 ERR("Unknown consumer_data type");
742 assert(0);
743 }
b9182dd9
DG
744
745 return 0;
3bd1e081
MD
746}
747
748/*
749 * Splice the data from the ring buffer to the tracefile.
750 *
751 * Returns the number of bytes spliced.
752 */
753int lttng_consumer_on_read_subbuffer_splice(
754 struct lttng_consumer_local_data *ctx,
755 struct lttng_consumer_stream *stream, unsigned long len)
756{
757 switch (consumer_data.type) {
758 case LTTNG_CONSUMER_KERNEL:
759 return lttng_kconsumer_on_read_subbuffer_splice(ctx, stream, len);
7753dea8
MD
760 case LTTNG_CONSUMER32_UST:
761 case LTTNG_CONSUMER64_UST:
3bd1e081
MD
762 return -ENOSYS;
763 default:
764 ERR("Unknown consumer_data type");
765 assert(0);
766 return -ENOSYS;
767 }
768
769}
770
771/*
772 * Take a snapshot for a specific fd
773 *
774 * Returns 0 on success, < 0 on error
775 */
776int lttng_consumer_take_snapshot(struct lttng_consumer_local_data *ctx,
777 struct lttng_consumer_stream *stream)
778{
779 switch (consumer_data.type) {
780 case LTTNG_CONSUMER_KERNEL:
781 return lttng_kconsumer_take_snapshot(ctx, stream);
7753dea8
MD
782 case LTTNG_CONSUMER32_UST:
783 case LTTNG_CONSUMER64_UST:
3bd1e081
MD
784 return lttng_ustconsumer_take_snapshot(ctx, stream);
785 default:
786 ERR("Unknown consumer_data type");
787 assert(0);
788 return -ENOSYS;
789 }
790
791}
792
793/*
794 * Get the produced position
795 *
796 * Returns 0 on success, < 0 on error
797 */
798int lttng_consumer_get_produced_snapshot(
799 struct lttng_consumer_local_data *ctx,
800 struct lttng_consumer_stream *stream,
801 unsigned long *pos)
802{
803 switch (consumer_data.type) {
804 case LTTNG_CONSUMER_KERNEL:
805 return lttng_kconsumer_get_produced_snapshot(ctx, stream, pos);
7753dea8
MD
806 case LTTNG_CONSUMER32_UST:
807 case LTTNG_CONSUMER64_UST:
3bd1e081
MD
808 return lttng_ustconsumer_get_produced_snapshot(ctx, stream, pos);
809 default:
810 ERR("Unknown consumer_data type");
811 assert(0);
812 return -ENOSYS;
813 }
814}
815
816int lttng_consumer_recv_cmd(struct lttng_consumer_local_data *ctx,
817 int sock, struct pollfd *consumer_sockpoll)
818{
819 switch (consumer_data.type) {
820 case LTTNG_CONSUMER_KERNEL:
821 return lttng_kconsumer_recv_cmd(ctx, sock, consumer_sockpoll);
7753dea8
MD
822 case LTTNG_CONSUMER32_UST:
823 case LTTNG_CONSUMER64_UST:
3bd1e081
MD
824 return lttng_ustconsumer_recv_cmd(ctx, sock, consumer_sockpoll);
825 default:
826 ERR("Unknown consumer_data type");
827 assert(0);
828 return -ENOSYS;
829 }
830}
831
832/*
e4421fec 833 * This thread polls the fds in the set to consume the data and write
3bd1e081
MD
834 * it to tracefile if necessary.
835 */
836void *lttng_consumer_thread_poll_fds(void *data)
837{
838 int num_rdy, num_hup, high_prio, ret, i;
839 struct pollfd *pollfd = NULL;
840 /* local view of the streams */
841 struct lttng_consumer_stream **local_stream = NULL;
842 /* local view of consumer_data.fds_count */
843 int nb_fd = 0;
844 char tmp;
845 int tmp2;
846 struct lttng_consumer_local_data *ctx = data;
847
e7b994a3
DG
848 rcu_register_thread();
849
effcf122 850 local_stream = zmalloc(sizeof(struct lttng_consumer_stream));
3bd1e081
MD
851
852 while (1) {
853 high_prio = 0;
854 num_hup = 0;
855
856 /*
e4421fec 857 * the fds set has been updated, we need to update our
3bd1e081
MD
858 * local array as well
859 */
860 pthread_mutex_lock(&consumer_data.lock);
861 if (consumer_data.need_update) {
862 if (pollfd != NULL) {
863 free(pollfd);
864 pollfd = NULL;
865 }
866 if (local_stream != NULL) {
867 free(local_stream);
868 local_stream = NULL;
869 }
870
871 /* allocate for all fds + 1 for the consumer_poll_pipe */
effcf122 872 pollfd = zmalloc((consumer_data.stream_count + 1) * sizeof(struct pollfd));
3bd1e081
MD
873 if (pollfd == NULL) {
874 perror("pollfd malloc");
875 pthread_mutex_unlock(&consumer_data.lock);
876 goto end;
877 }
878
879 /* allocate for all fds + 1 for the consumer_poll_pipe */
effcf122 880 local_stream = zmalloc((consumer_data.stream_count + 1) *
3bd1e081
MD
881 sizeof(struct lttng_consumer_stream));
882 if (local_stream == NULL) {
883 perror("local_stream malloc");
884 pthread_mutex_unlock(&consumer_data.lock);
885 goto end;
886 }
887 ret = consumer_update_poll_array(ctx, &pollfd, local_stream);
888 if (ret < 0) {
889 ERR("Error in allocating pollfd or local_outfds");
890 lttng_consumer_send_error(ctx, CONSUMERD_POLL_ERROR);
891 pthread_mutex_unlock(&consumer_data.lock);
892 goto end;
893 }
894 nb_fd = ret;
895 consumer_data.need_update = 0;
896 }
897 pthread_mutex_unlock(&consumer_data.lock);
898
899 /* poll on the array of fds */
900 DBG("polling on %d fd", nb_fd + 1);
901 num_rdy = poll(pollfd, nb_fd + 1, consumer_poll_timeout);
902 DBG("poll num_rdy : %d", num_rdy);
903 if (num_rdy == -1) {
904 perror("Poll error");
905 lttng_consumer_send_error(ctx, CONSUMERD_POLL_ERROR);
906 goto end;
907 } else if (num_rdy == 0) {
908 DBG("Polling thread timed out");
909 goto end;
910 }
911
d41f73b7 912 /* No FDs and consumer_quit, consumer_cleanup the thread */
3bd1e081
MD
913 if (nb_fd == 0 && consumer_quit == 1) {
914 goto end;
915 }
916
917 /*
918 * If the consumer_poll_pipe triggered poll go
919 * directly to the beginning of the loop to update the
920 * array. We want to prioritize array update over
921 * low-priority reads.
922 */
d41f73b7 923 if (pollfd[nb_fd].revents & POLLIN) {
3bd1e081
MD
924 DBG("consumer_poll_pipe wake up");
925 tmp2 = read(ctx->consumer_poll_pipe[0], &tmp, 1);
926 if (tmp2 < 0) {
d41f73b7 927 perror("read consumer poll");
3bd1e081
MD
928 }
929 continue;
930 }
931
932 /* Take care of high priority channels first. */
933 for (i = 0; i < nb_fd; i++) {
d41f73b7
MD
934 if (pollfd[i].revents & POLLPRI) {
935 DBG("Urgent read on fd %d", pollfd[i].fd);
936 high_prio = 1;
937 ret = ctx->on_buffer_ready(local_stream[i], ctx);
938 /* it's ok to have an unavailable sub-buffer */
939 if (ret == EAGAIN) {
940 ret = 0;
941 }
942 } else if (pollfd[i].revents & POLLERR) {
3bd1e081 943 ERR("Error returned in polling fd %d.", pollfd[i].fd);
6065ceec
DG
944 rcu_read_lock();
945 consumer_del_stream_rcu(&local_stream[i]->node.head);
946 rcu_read_unlock();
3bd1e081 947 num_hup++;
d41f73b7
MD
948 } else if (pollfd[i].revents & POLLNVAL) {
949 ERR("Polling fd %d tells fd is not open.", pollfd[i].fd);
6065ceec
DG
950 rcu_read_lock();
951 consumer_del_stream_rcu(&local_stream[i]->node.head);
952 rcu_read_unlock();
3bd1e081 953 num_hup++;
1c3c14ac
MD
954 } else if ((pollfd[i].revents & POLLHUP) &&
955 !(pollfd[i].revents & POLLIN)) {
7753dea8
MD
956 if (consumer_data.type == LTTNG_CONSUMER32_UST
957 || consumer_data.type == LTTNG_CONSUMER64_UST) {
d056b477
MD
958 DBG("Polling fd %d tells it has hung up. Attempting flush and read.",
959 pollfd[i].fd);
960 if (!local_stream[i]->hangup_flush_done) {
961 lttng_ustconsumer_on_stream_hangup(local_stream[i]);
effcf122
MD
962 /* read after flush */
963 do {
964 ret = ctx->on_buffer_ready(local_stream[i], ctx);
965 } while (ret == EAGAIN);
d056b477
MD
966 }
967 } else {
968 DBG("Polling fd %d tells it has hung up.", pollfd[i].fd);
969 }
6065ceec
DG
970 rcu_read_lock();
971 consumer_del_stream_rcu(&local_stream[i]->node.head);
972 rcu_read_unlock();
3bd1e081 973 num_hup++;
3bd1e081
MD
974 }
975 }
976
977 /* If every buffer FD has hung up, we end the read loop here */
978 if (nb_fd > 0 && num_hup == nb_fd) {
979 DBG("every buffer FD has hung up\n");
980 if (consumer_quit == 1) {
981 goto end;
982 }
983 continue;
984 }
985
986 /* Take care of low priority channels. */
987 if (high_prio == 0) {
988 for (i = 0; i < nb_fd; i++) {
d41f73b7 989 if (pollfd[i].revents & POLLIN) {
3bd1e081 990 DBG("Normal read on fd %d", pollfd[i].fd);
d41f73b7 991 ret = ctx->on_buffer_ready(local_stream[i], ctx);
3bd1e081
MD
992 /* it's ok to have an unavailable subbuffer */
993 if (ret == EAGAIN) {
994 ret = 0;
995 }
996 }
997 }
998 }
999 }
1000end:
1001 DBG("polling thread exiting");
1002 if (pollfd != NULL) {
1003 free(pollfd);
1004 pollfd = NULL;
1005 }
1006 if (local_stream != NULL) {
1007 free(local_stream);
1008 local_stream = NULL;
1009 }
e7b994a3 1010 rcu_unregister_thread();
3bd1e081
MD
1011 return NULL;
1012}
1013
1014/*
1015 * This thread listens on the consumerd socket and receives the file
1016 * descriptors from the session daemon.
1017 */
1018void *lttng_consumer_thread_receive_fds(void *data)
1019{
1020 int sock, client_socket, ret;
1021 /*
1022 * structure to poll for incoming data on communication socket avoids
1023 * making blocking sockets.
1024 */
1025 struct pollfd consumer_sockpoll[2];
1026 struct lttng_consumer_local_data *ctx = data;
1027
e7b994a3
DG
1028 rcu_register_thread();
1029
3bd1e081
MD
1030 DBG("Creating command socket %s", ctx->consumer_command_sock_path);
1031 unlink(ctx->consumer_command_sock_path);
1032 client_socket = lttcomm_create_unix_sock(ctx->consumer_command_sock_path);
1033 if (client_socket < 0) {
1034 ERR("Cannot create command socket");
1035 goto end;
1036 }
1037
1038 ret = lttcomm_listen_unix_sock(client_socket);
1039 if (ret < 0) {
1040 goto end;
1041 }
1042
32258573 1043 DBG("Sending ready command to lttng-sessiond");
3bd1e081
MD
1044 ret = lttng_consumer_send_error(ctx, CONSUMERD_COMMAND_SOCK_READY);
1045 /* return < 0 on error, but == 0 is not fatal */
1046 if (ret < 0) {
32258573 1047 ERR("Error sending ready command to lttng-sessiond");
3bd1e081
MD
1048 goto end;
1049 }
1050
1051 ret = fcntl(client_socket, F_SETFL, O_NONBLOCK);
1052 if (ret < 0) {
1053 perror("fcntl O_NONBLOCK");
1054 goto end;
1055 }
1056
1057 /* prepare the FDs to poll : to client socket and the should_quit pipe */
1058 consumer_sockpoll[0].fd = ctx->consumer_should_quit[0];
1059 consumer_sockpoll[0].events = POLLIN | POLLPRI;
1060 consumer_sockpoll[1].fd = client_socket;
1061 consumer_sockpoll[1].events = POLLIN | POLLPRI;
1062
1063 if (lttng_consumer_poll_socket(consumer_sockpoll) < 0) {
1064 goto end;
1065 }
1066 DBG("Connection on client_socket");
1067
1068 /* Blocking call, waiting for transmission */
1069 sock = lttcomm_accept_unix_sock(client_socket);
1070 if (sock <= 0) {
1071 WARN("On accept");
1072 goto end;
1073 }
1074 ret = fcntl(sock, F_SETFL, O_NONBLOCK);
1075 if (ret < 0) {
1076 perror("fcntl O_NONBLOCK");
1077 goto end;
1078 }
1079
1080 /* update the polling structure to poll on the established socket */
1081 consumer_sockpoll[1].fd = sock;
1082 consumer_sockpoll[1].events = POLLIN | POLLPRI;
1083
1084 while (1) {
1085 if (lttng_consumer_poll_socket(consumer_sockpoll) < 0) {
1086 goto end;
1087 }
1088 DBG("Incoming command on sock");
1089 ret = lttng_consumer_recv_cmd(ctx, sock, consumer_sockpoll);
1090 if (ret == -ENOENT) {
1091 DBG("Received STOP command");
1092 goto end;
1093 }
1094 if (ret < 0) {
1095 ERR("Communication interrupted on command socket");
1096 goto end;
1097 }
1098 if (consumer_quit) {
1099 DBG("consumer_thread_receive_fds received quit from signal");
1100 goto end;
1101 }
1102 DBG("received fds on sock");
1103 }
1104end:
1105 DBG("consumer_thread_receive_fds exiting");
1106
1107 /*
1108 * when all fds have hung up, the polling thread
1109 * can exit cleanly
1110 */
1111 consumer_quit = 1;
1112
1113 /*
1114 * 2s of grace period, if no polling events occur during
1115 * this period, the polling thread will exit even if there
1116 * are still open FDs (should not happen, but safety mechanism).
1117 */
1118 consumer_poll_timeout = LTTNG_CONSUMER_POLL_TIMEOUT;
1119
1120 /* wake up the polling thread */
1121 ret = write(ctx->consumer_poll_pipe[1], "4", 1);
1122 if (ret < 0) {
1123 perror("poll pipe write");
1124 }
e7b994a3 1125 rcu_unregister_thread();
3bd1e081
MD
1126 return NULL;
1127}
d41f73b7
MD
1128
1129int lttng_consumer_read_subbuffer(struct lttng_consumer_stream *stream,
1130 struct lttng_consumer_local_data *ctx)
1131{
1132 switch (consumer_data.type) {
1133 case LTTNG_CONSUMER_KERNEL:
1134 return lttng_kconsumer_read_subbuffer(stream, ctx);
7753dea8
MD
1135 case LTTNG_CONSUMER32_UST:
1136 case LTTNG_CONSUMER64_UST:
d41f73b7
MD
1137 return lttng_ustconsumer_read_subbuffer(stream, ctx);
1138 default:
1139 ERR("Unknown consumer_data type");
1140 assert(0);
1141 return -ENOSYS;
1142 }
1143}
1144
1145int lttng_consumer_on_recv_stream(struct lttng_consumer_stream *stream)
1146{
1147 switch (consumer_data.type) {
1148 case LTTNG_CONSUMER_KERNEL:
1149 return lttng_kconsumer_on_recv_stream(stream);
7753dea8
MD
1150 case LTTNG_CONSUMER32_UST:
1151 case LTTNG_CONSUMER64_UST:
d41f73b7
MD
1152 return lttng_ustconsumer_on_recv_stream(stream);
1153 default:
1154 ERR("Unknown consumer_data type");
1155 assert(0);
1156 return -ENOSYS;
1157 }
1158}
e4421fec
DG
1159
1160/*
1161 * Allocate and set consumer data hash tables.
1162 */
1163void lttng_consumer_init(void)
1164{
1165 consumer_data.stream_ht = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
1166 consumer_data.channel_ht = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
1167}
1168
This page took 0.134672 seconds and 4 git commands to generate.