8ce7f30b19ee7d795af047ca35f78fbf9b7f3ecb
[lttng-tools.git] / src / common / consumer / consumer-metadata-cache.h
1 /*
2 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
4 *
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.
8 *
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
13 *
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.
17 */
18
19 #ifndef CONSUMER_METADATA_CACHE_H
20 #define CONSUMER_METADATA_CACHE_H
21
22 #include <common/consumer/consumer.h>
23
24 struct consumer_metadata_cache {
25 char *data;
26 uint64_t cache_alloc_size;
27 /*
28 * The upper-limit of data written inside the buffer.
29 *
30 * With the total_bytes_written it allows us to keep track of when the
31 * cache contains contiguous metadata ready to be sent to the RB.
32 * All cached data is contiguous.
33 */
34 uint64_t max_offset;
35 /*
36 * Lock to update the metadata cache and push into the ring_buffer
37 * (ustctl_write_metadata_to_channel).
38 *
39 * This is nested INSIDE the consumer_data lock.
40 */
41 pthread_mutex_t lock;
42 };
43
44 int consumer_metadata_cache_write(struct lttng_consumer_channel *channel,
45 unsigned int offset, unsigned int len, char *data);
46 int consumer_metadata_cache_allocate(struct lttng_consumer_channel *channel);
47 void consumer_metadata_cache_destroy(struct lttng_consumer_channel *channel);
48 int consumer_metadata_cache_flushed(struct lttng_consumer_channel *channel,
49 uint64_t offset, int timer);
50
51 #endif /* CONSUMER_METADATA_CACHE_H */
This page took 0.031718 seconds and 4 git commands to generate.