Commit | Line | Data |
---|---|---|
2a174661 DG |
1 | /* |
2 | * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com> | |
3 | * David Goulet <dgoulet@efficios.com> | |
7591bab1 | 4 | * 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
2a174661 DG |
5 | * |
6 | * This program is free software; you can redistribute it and/or modify it | |
7 | * under the terms of the GNU General Public License, version 2 only, as | |
8 | * published by the Free Software Foundation. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, but WITHOUT | |
11 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
12 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for | |
13 | * more details. | |
14 | * | |
15 | * You should have received a copy of the GNU General Public License along with | |
16 | * this program; if not, write to the Free Software Foundation, Inc., 51 | |
17 | * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
18 | */ | |
19 | ||
20 | #define _GNU_SOURCE | |
6c1c0768 | 21 | #define _LGPL_SOURCE |
2a174661 | 22 | #include <common/common.h> |
7591bab1 MD |
23 | #include <common/utils.h> |
24 | #include <common/defaults.h> | |
25 | #include <urcu/rculist.h> | |
26 | #include <sys/stat.h> | |
2a174661 | 27 | |
7591bab1 | 28 | #include "lttng-relayd.h" |
2a174661 DG |
29 | #include "index.h" |
30 | #include "stream.h" | |
31 | #include "viewer-stream.h" | |
32 | ||
7591bab1 MD |
33 | /* Should be called with RCU read-side lock held. */ |
34 | bool stream_get(struct relay_stream *stream) | |
35 | { | |
36 | bool has_ref = false; | |
37 | ||
38 | pthread_mutex_lock(&stream->reflock); | |
39 | if (stream->ref.refcount != 0) { | |
40 | has_ref = true; | |
41 | urcu_ref_get(&stream->ref); | |
42 | } | |
43 | pthread_mutex_unlock(&stream->reflock); | |
44 | ||
45 | return has_ref; | |
46 | } | |
47 | ||
2a174661 | 48 | /* |
7591bab1 MD |
49 | * Get stream from stream id from the streams hash table. Return stream |
50 | * if found else NULL. A stream reference is taken when a stream is | |
51 | * returned. stream_put() must be called on that stream. | |
2a174661 | 52 | */ |
7591bab1 | 53 | struct relay_stream *stream_get_by_id(uint64_t stream_id) |
2a174661 DG |
54 | { |
55 | struct lttng_ht_node_u64 *node; | |
56 | struct lttng_ht_iter iter; | |
57 | struct relay_stream *stream = NULL; | |
58 | ||
7591bab1 MD |
59 | rcu_read_lock(); |
60 | lttng_ht_lookup(relay_streams_ht, &stream_id, &iter); | |
2a174661 | 61 | node = lttng_ht_iter_get_node_u64(&iter); |
7591bab1 | 62 | if (!node) { |
2a174661 DG |
63 | DBG("Relay stream %" PRIu64 " not found", stream_id); |
64 | goto end; | |
65 | } | |
66 | stream = caa_container_of(node, struct relay_stream, node); | |
7591bab1 MD |
67 | if (!stream_get(stream)) { |
68 | stream = NULL; | |
69 | } | |
2a174661 | 70 | end: |
7591bab1 | 71 | rcu_read_unlock(); |
2a174661 DG |
72 | return stream; |
73 | } | |
74 | ||
75 | /* | |
7591bab1 | 76 | * We keep ownership of path_name and channel_name. |
2a174661 | 77 | */ |
7591bab1 MD |
78 | struct relay_stream *stream_create(struct ctf_trace *trace, |
79 | uint64_t stream_handle, char *path_name, | |
80 | char *channel_name, uint64_t tracefile_size, | |
81 | uint64_t tracefile_count) | |
2a174661 | 82 | { |
7591bab1 MD |
83 | int ret; |
84 | struct relay_stream *stream = NULL; | |
85 | struct relay_session *session = trace->session; | |
2a174661 | 86 | |
7591bab1 MD |
87 | stream = zmalloc(sizeof(struct relay_stream)); |
88 | if (stream == NULL) { | |
89 | PERROR("relay stream zmalloc"); | |
90 | ret = -1; | |
91 | goto error_no_alloc; | |
92 | } | |
2a174661 | 93 | |
7591bab1 MD |
94 | stream->stream_handle = stream_handle; |
95 | stream->prev_seq = -1ULL; | |
96 | stream->ctf_stream_id = -1ULL; | |
97 | stream->tracefile_size = tracefile_size; | |
98 | stream->tracefile_count = tracefile_count; | |
99 | stream->path_name = path_name; | |
100 | stream->channel_name = channel_name; | |
101 | lttng_ht_node_init_u64(&stream->node, stream->stream_handle); | |
102 | pthread_mutex_init(&stream->lock, NULL); | |
103 | pthread_mutex_init(&stream->reflock, NULL); | |
104 | urcu_ref_init(&stream->ref); | |
105 | ctf_trace_get(trace); | |
106 | stream->trace = trace; | |
2a174661 | 107 | |
7591bab1 MD |
108 | stream->indexes_ht = lttng_ht_new(0, LTTNG_HT_TYPE_U64); |
109 | if (!stream->indexes_ht) { | |
110 | ERR("Cannot created indexes_ht"); | |
111 | ret = -1; | |
112 | goto end; | |
2a174661 DG |
113 | } |
114 | ||
7591bab1 MD |
115 | ret = utils_mkdir_recursive(stream->path_name, S_IRWXU | S_IRWXG, |
116 | -1, -1); | |
117 | if (ret < 0) { | |
118 | ERR("relay creating output directory"); | |
119 | goto end; | |
120 | } | |
2a174661 | 121 | |
7591bab1 MD |
122 | /* |
123 | * No need to use run_as API here because whatever we receive, | |
124 | * the relayd uses its own credentials for the stream files. | |
125 | */ | |
126 | ret = utils_create_stream_file(stream->path_name, stream->channel_name, | |
127 | stream->tracefile_size, 0, -1, -1, NULL); | |
128 | if (ret < 0) { | |
129 | ERR("Create output file"); | |
130 | goto end; | |
131 | } | |
132 | stream->stream_fd = stream_fd_create(ret); | |
133 | if (!stream->stream_fd) { | |
134 | if (close(ret)) { | |
135 | PERROR("Error closing file %d", ret); | |
2a174661 | 136 | } |
7591bab1 MD |
137 | ret = -1; |
138 | goto end; | |
2a174661 | 139 | } |
a44ca2ca MD |
140 | stream->tfa = tracefile_array_create(stream->tracefile_count); |
141 | if (!stream->tfa) { | |
142 | ret = -1; | |
143 | goto end; | |
144 | } | |
7591bab1 MD |
145 | if (stream->tracefile_size) { |
146 | DBG("Tracefile %s/%s_0 created", stream->path_name, stream->channel_name); | |
147 | } else { | |
148 | DBG("Tracefile %s/%s created", stream->path_name, stream->channel_name); | |
149 | } | |
150 | ||
151 | if (!strncmp(stream->channel_name, DEFAULT_METADATA_NAME, NAME_MAX)) { | |
152 | stream->is_metadata = 1; | |
153 | } | |
154 | ||
155 | stream->in_recv_list = true; | |
156 | ||
157 | /* | |
158 | * Add the stream in the recv list of the session. Once the end stream | |
159 | * message is received, all session streams are published. | |
160 | */ | |
161 | pthread_mutex_lock(&session->recv_list_lock); | |
162 | cds_list_add_rcu(&stream->recv_node, &session->recv_list); | |
163 | session->stream_count++; | |
164 | pthread_mutex_unlock(&session->recv_list_lock); | |
165 | ||
166 | /* | |
167 | * Both in the ctf_trace object and the global stream ht since the data | |
168 | * side of the relayd does not have the concept of session. | |
169 | */ | |
170 | lttng_ht_add_unique_u64(relay_streams_ht, &stream->node); | |
2a174661 | 171 | |
7591bab1 MD |
172 | DBG("Relay new stream added %s with ID %" PRIu64, stream->channel_name, |
173 | stream->stream_handle); | |
174 | ret = 0; | |
175 | ||
176 | end: | |
177 | if (ret) { | |
178 | if (stream->stream_fd) { | |
179 | stream_fd_put(stream->stream_fd); | |
180 | stream->stream_fd = NULL; | |
2a174661 | 181 | } |
7591bab1 MD |
182 | stream_put(stream); |
183 | stream = NULL; | |
2a174661 | 184 | } |
7591bab1 | 185 | return stream; |
2a174661 | 186 | |
7591bab1 MD |
187 | error_no_alloc: |
188 | /* | |
189 | * path_name and channel_name need to be freed explicitly here | |
190 | * because we cannot rely on stream_put(). | |
191 | */ | |
192 | free(path_name); | |
193 | free(channel_name); | |
194 | return NULL; | |
195 | } | |
196 | ||
197 | /* | |
198 | * Called with the session lock held. | |
199 | */ | |
200 | void stream_publish(struct relay_stream *stream) | |
201 | { | |
202 | struct relay_session *session; | |
203 | ||
204 | pthread_mutex_lock(&stream->lock); | |
205 | if (stream->published) { | |
206 | goto unlock; | |
2a174661 DG |
207 | } |
208 | ||
7591bab1 | 209 | session = stream->trace->session; |
2a174661 | 210 | |
7591bab1 MD |
211 | pthread_mutex_lock(&session->recv_list_lock); |
212 | if (stream->in_recv_list) { | |
213 | cds_list_del_rcu(&stream->recv_node); | |
214 | stream->in_recv_list = false; | |
215 | } | |
216 | pthread_mutex_unlock(&session->recv_list_lock); | |
2a174661 | 217 | |
7591bab1 MD |
218 | pthread_mutex_lock(&stream->trace->stream_list_lock); |
219 | cds_list_add_rcu(&stream->stream_node, &stream->trace->stream_list); | |
220 | pthread_mutex_unlock(&stream->trace->stream_list_lock); | |
2a174661 | 221 | |
7591bab1 MD |
222 | stream->published = true; |
223 | unlock: | |
2a174661 | 224 | pthread_mutex_unlock(&stream->lock); |
2a174661 DG |
225 | } |
226 | ||
7591bab1 MD |
227 | /* |
228 | * Only called from destroy. No stream lock needed, since there is a | |
229 | * single user at this point. This is ensured by having the refcount | |
230 | * reaching 0. | |
231 | */ | |
232 | static void stream_unpublish(struct relay_stream *stream) | |
2a174661 | 233 | { |
7591bab1 MD |
234 | if (!stream->published) { |
235 | return; | |
236 | } | |
237 | pthread_mutex_lock(&stream->trace->stream_list_lock); | |
238 | cds_list_del_rcu(&stream->stream_node); | |
239 | pthread_mutex_unlock(&stream->trace->stream_list_lock); | |
240 | ||
241 | stream->published = false; | |
242 | } | |
243 | ||
244 | static void stream_destroy(struct relay_stream *stream) | |
245 | { | |
246 | if (stream->indexes_ht) { | |
247 | lttng_ht_destroy(stream->indexes_ht); | |
248 | } | |
a44ca2ca MD |
249 | if (stream->tfa) { |
250 | tracefile_array_destroy(stream->tfa); | |
251 | } | |
7591bab1 MD |
252 | free(stream->path_name); |
253 | free(stream->channel_name); | |
254 | free(stream); | |
255 | } | |
256 | ||
257 | static void stream_destroy_rcu(struct rcu_head *rcu_head) | |
258 | { | |
259 | struct relay_stream *stream = | |
260 | caa_container_of(rcu_head, struct relay_stream, rcu_node); | |
261 | ||
262 | stream_destroy(stream); | |
263 | } | |
264 | ||
265 | /* | |
266 | * No need to take stream->lock since this is only called on the final | |
267 | * stream_put which ensures that a single thread may act on the stream. | |
268 | * | |
269 | * At that point, the object is also protected by the reflock which | |
270 | * guarantees that no other thread may share ownership of this stream. | |
271 | */ | |
272 | static void stream_release(struct urcu_ref *ref) | |
273 | { | |
274 | struct relay_stream *stream = | |
275 | caa_container_of(ref, struct relay_stream, ref); | |
276 | struct relay_session *session; | |
2a174661 DG |
277 | int ret; |
278 | struct lttng_ht_iter iter; | |
279 | ||
7591bab1 MD |
280 | session = stream->trace->session; |
281 | ||
282 | DBG("Releasing stream id %" PRIu64, stream->stream_handle); | |
283 | ||
284 | pthread_mutex_lock(&session->recv_list_lock); | |
285 | session->stream_count--; | |
286 | if (stream->in_recv_list) { | |
287 | cds_list_del_rcu(&stream->recv_node); | |
288 | stream->in_recv_list = false; | |
289 | } | |
290 | pthread_mutex_unlock(&session->recv_list_lock); | |
2a174661 DG |
291 | |
292 | iter.iter.node = &stream->node.node; | |
7591bab1 | 293 | ret = lttng_ht_del(relay_streams_ht, &iter); |
2a174661 DG |
294 | assert(!ret); |
295 | ||
7591bab1 MD |
296 | stream_unpublish(stream); |
297 | ||
298 | if (stream->stream_fd) { | |
299 | stream_fd_put(stream->stream_fd); | |
300 | stream->stream_fd = NULL; | |
301 | } | |
302 | if (stream->index_fd) { | |
303 | stream_fd_put(stream->index_fd); | |
304 | stream->index_fd = NULL; | |
305 | } | |
306 | if (stream->trace) { | |
307 | ctf_trace_put(stream->trace); | |
308 | stream->trace = NULL; | |
309 | } | |
310 | ||
311 | call_rcu(&stream->rcu_node, stream_destroy_rcu); | |
2a174661 DG |
312 | } |
313 | ||
7591bab1 | 314 | void stream_put(struct relay_stream *stream) |
2a174661 | 315 | { |
7591bab1 MD |
316 | DBG("stream put for stream id %" PRIu64, stream->stream_handle); |
317 | /* | |
318 | * Ensure existence of stream->reflock for stream unlock. | |
319 | */ | |
320 | rcu_read_lock(); | |
321 | /* | |
322 | * Stream reflock ensures that concurrent test and update of | |
323 | * stream ref is atomic. | |
324 | */ | |
325 | pthread_mutex_lock(&stream->reflock); | |
326 | assert(stream->ref.refcount != 0); | |
327 | /* | |
328 | * Wait until we have processed all the stream packets before | |
329 | * actually putting our last stream reference. | |
330 | */ | |
331 | DBG("stream put stream id %" PRIu64 " refcount %d", | |
332 | stream->stream_handle, | |
333 | (int) stream->ref.refcount); | |
334 | urcu_ref_put(&stream->ref, stream_release); | |
335 | pthread_mutex_unlock(&stream->reflock); | |
336 | rcu_read_unlock(); | |
337 | } | |
338 | ||
339 | void stream_close(struct relay_stream *stream) | |
340 | { | |
341 | DBG("closing stream %" PRIu64, stream->stream_handle); | |
342 | pthread_mutex_lock(&stream->lock); | |
2229a09c | 343 | stream->closed = true; |
7591bab1 MD |
344 | relay_index_close_all(stream); |
345 | pthread_mutex_unlock(&stream->lock); | |
346 | stream_put(stream); | |
347 | } | |
348 | ||
349 | void print_relay_streams(void) | |
350 | { | |
351 | struct lttng_ht_iter iter; | |
352 | struct relay_stream *stream; | |
353 | ||
354 | rcu_read_lock(); | |
355 | cds_lfht_for_each_entry(relay_streams_ht->ht, &iter.iter, stream, | |
356 | node.node) { | |
357 | if (!stream_get(stream)) { | |
358 | continue; | |
359 | } | |
360 | DBG("stream %p refcount %ld stream %" PRIu64 " trace %" PRIu64 | |
361 | " session %" PRIu64, | |
362 | stream, | |
363 | stream->ref.refcount, | |
364 | stream->stream_handle, | |
365 | stream->trace->id, | |
366 | stream->trace->session->id); | |
367 | stream_put(stream); | |
368 | } | |
369 | rcu_read_unlock(); | |
2a174661 | 370 | } |