2 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
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.
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
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.
24 #include <sys/types.h>
28 #include <common/common.h>
29 #include <common/utils.h>
30 #include <common/sessiond-comm/sessiond-comm.h>
31 #include <common/ust-consumer/ust-consumer.h>
32 #include <common/consumer.h>
34 #include "consumer-metadata-cache.h"
36 extern struct lttng_consumer_global_data consumer_data
;
39 * Extend the allocated size of the metadata cache. Called only from
40 * lttng_ustconsumer_write_metadata_cache.
42 * Return 0 on success, a negative value on error.
44 static int extend_metadata_cache(struct lttng_consumer_channel
*channel
,
49 unsigned int new_size
;
52 assert(channel
->metadata_cache
);
54 new_size
= max_t(unsigned int,
55 channel
->metadata_cache
->cache_alloc_size
+ size
,
56 channel
->metadata_cache
->cache_alloc_size
<< 1);
57 DBG("Extending metadata cache to %u", new_size
);
58 tmp_data_ptr
= realloc(channel
->metadata_cache
->data
, new_size
);
60 ERR("Reallocating metadata cache");
61 free(channel
->metadata_cache
->data
);
65 channel
->metadata_cache
->data
= tmp_data_ptr
;
66 channel
->metadata_cache
->cache_alloc_size
= new_size
;
73 * Write metadata to the cache, extend the cache if necessary. We support
74 * non-contiguous updates but not overlapping ones. If there is contiguous
75 * metadata in the cache, we send it to the ring buffer. The metadata cache
76 * lock MUST be acquired to write in the cache.
78 * Return 0 on success, a negative value on error.
80 int consumer_metadata_cache_write(struct lttng_consumer_channel
*channel
,
81 unsigned int offset
, unsigned int len
, char *data
)
85 struct consumer_metadata_cache
*cache
;
88 assert(channel
->metadata_cache
);
90 cache
= channel
->metadata_cache
;
91 DBG("Writing %u bytes from offset %u in metadata cache", len
, offset
);
93 if (offset
+ len
> cache
->cache_alloc_size
) {
94 ret
= extend_metadata_cache(channel
,
95 len
- cache
->cache_alloc_size
+ offset
);
97 ERR("Extending metadata cache");
102 memcpy(cache
->data
+ offset
, data
, len
);
103 cache
->total_bytes_written
+= len
;
104 if (offset
+ len
> cache
->max_offset
) {
105 cache
->max_offset
= offset
+ len
;
108 if (cache
->max_offset
== cache
->total_bytes_written
) {
111 cache
->contiguous
= cache
->max_offset
;
112 if (channel
->monitor
) {
113 size_ret
= lttng_write(channel
->metadata_stream
->ust_metadata_poll_pipe
[1],
116 ERR("Wakeup UST metadata pipe");
128 * Create the metadata cache, original allocated size: max_sb_size
130 * Return 0 on success, a negative value on error.
132 int consumer_metadata_cache_allocate(struct lttng_consumer_channel
*channel
)
138 channel
->metadata_cache
= zmalloc(
139 sizeof(struct consumer_metadata_cache
));
140 if (!channel
->metadata_cache
) {
141 PERROR("zmalloc metadata cache struct");
145 ret
= pthread_mutex_init(&channel
->metadata_cache
->lock
, NULL
);
147 PERROR("mutex init");
151 channel
->metadata_cache
->cache_alloc_size
= DEFAULT_METADATA_CACHE_SIZE
;
152 channel
->metadata_cache
->data
= zmalloc(
153 channel
->metadata_cache
->cache_alloc_size
* sizeof(char));
154 if (!channel
->metadata_cache
->data
) {
155 PERROR("zmalloc metadata cache data");
159 DBG("Allocated metadata cache of %" PRIu64
" bytes",
160 channel
->metadata_cache
->cache_alloc_size
);
166 pthread_mutex_destroy(&channel
->metadata_cache
->lock
);
168 free(channel
->metadata_cache
);
174 * Destroy and free the metadata cache
176 void consumer_metadata_cache_destroy(struct lttng_consumer_channel
*channel
)
178 if (!channel
|| !channel
->metadata_cache
) {
182 DBG("Destroying metadata cache");
184 pthread_mutex_destroy(&channel
->metadata_cache
->lock
);
185 free(channel
->metadata_cache
->data
);
186 free(channel
->metadata_cache
);
190 * Check if the cache is flushed up to the offset passed in parameter.
192 * Return 0 if everything has been flushed, 1 if there is data not flushed.
194 int consumer_metadata_cache_flushed(struct lttng_consumer_channel
*channel
,
195 uint64_t offset
, int timer
)
198 struct lttng_consumer_stream
*metadata_stream
;
201 assert(channel
->metadata_cache
);
204 * If not called from a timer handler, we have to take the
205 * channel lock to be mutually exclusive with channel teardown.
206 * Timer handler does not need to take this lock because it is
207 * already synchronized by timer stop (and, more importantly,
208 * taking this lock in a timer handler would cause a deadlock).
211 pthread_mutex_lock(&channel
->lock
);
213 pthread_mutex_lock(&channel
->timer_lock
);
214 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
216 metadata_stream
= channel
->metadata_stream
;
218 if (!metadata_stream
) {
220 * Having no metadata stream means the channel is being destroyed so there
221 * is no cache to flush anymore.
224 } else if (metadata_stream
->ust_metadata_pushed
>= offset
) {
226 } else if (channel
->metadata_stream
->endpoint_status
!=
227 CONSUMER_ENDPOINT_ACTIVE
) {
228 /* An inactive endpoint means we don't have to flush anymore. */
231 /* Still not completely flushed. */
235 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
236 pthread_mutex_unlock(&channel
->timer_lock
);
238 pthread_mutex_unlock(&channel
->lock
);