Commit | Line | Data |
---|---|---|
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 | |
51a9e1c7 | 35 | #include <bin/lttng-consumerd/health-consumerd.h> |
990570ed | 36 | #include <common/common.h> |
10a8a223 | 37 | #include <common/sessiond-comm/sessiond-comm.h> |
00e2e675 | 38 | #include <common/relayd/relayd.h> |
dbb5dfe6 | 39 | #include <common/compat/fcntl.h> |
f263b7fd | 40 | #include <common/compat/endian.h> |
331744e3 | 41 | #include <common/consumer-metadata-cache.h> |
10a50311 | 42 | #include <common/consumer-stream.h> |
331744e3 | 43 | #include <common/consumer-timer.h> |
fe4477ee | 44 | #include <common/utils.h> |
309167d2 | 45 | #include <common/index/index.h> |
10a8a223 DG |
46 | |
47 | #include "ust-consumer.h" | |
3bd1e081 MD |
48 | |
49 | extern struct lttng_consumer_global_data consumer_data; | |
50 | extern int consumer_poll_timeout; | |
51 | extern volatile int consumer_quit; | |
52 | ||
53 | /* | |
ffe60014 DG |
54 | * Free channel object and all streams associated with it. This MUST be used |
55 | * only and only if the channel has _NEVER_ been added to the global channel | |
56 | * hash table. | |
3bd1e081 | 57 | */ |
ffe60014 | 58 | static void destroy_channel(struct lttng_consumer_channel *channel) |
3bd1e081 | 59 | { |
ffe60014 DG |
60 | struct lttng_consumer_stream *stream, *stmp; |
61 | ||
62 | assert(channel); | |
63 | ||
64 | DBG("UST consumer cleaning stream list"); | |
65 | ||
66 | cds_list_for_each_entry_safe(stream, stmp, &channel->streams.head, | |
67 | send_node) { | |
9ce5646a MD |
68 | |
69 | health_code_update(); | |
70 | ||
ffe60014 DG |
71 | cds_list_del(&stream->send_node); |
72 | ustctl_destroy_stream(stream->ustream); | |
73 | free(stream); | |
74 | } | |
75 | ||
76 | /* | |
77 | * If a channel is available meaning that was created before the streams | |
78 | * were, delete it. | |
79 | */ | |
80 | if (channel->uchan) { | |
81 | lttng_ustconsumer_del_channel(channel); | |
4534c65b | 82 | lttng_ustconsumer_free_channel(channel); |
ffe60014 DG |
83 | } |
84 | free(channel); | |
85 | } | |
3bd1e081 MD |
86 | |
87 | /* | |
ffe60014 | 88 | * Add channel to internal consumer state. |
3bd1e081 | 89 | * |
ffe60014 | 90 | * Returns 0 on success or else a negative value. |
3bd1e081 | 91 | */ |
ffe60014 DG |
92 | static int add_channel(struct lttng_consumer_channel *channel, |
93 | struct lttng_consumer_local_data *ctx) | |
3bd1e081 MD |
94 | { |
95 | int ret = 0; | |
96 | ||
ffe60014 DG |
97 | assert(channel); |
98 | assert(ctx); | |
99 | ||
100 | if (ctx->on_recv_channel != NULL) { | |
101 | ret = ctx->on_recv_channel(channel); | |
102 | if (ret == 0) { | |
d8ef542d | 103 | ret = consumer_add_channel(channel, ctx); |
ffe60014 DG |
104 | } else if (ret < 0) { |
105 | /* Most likely an ENOMEM. */ | |
106 | lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_OUTFD_ERROR); | |
107 | goto error; | |
108 | } | |
109 | } else { | |
d8ef542d | 110 | ret = consumer_add_channel(channel, ctx); |
3bd1e081 MD |
111 | } |
112 | ||
d88aee68 | 113 | DBG("UST consumer channel added (key: %" PRIu64 ")", channel->key); |
ffe60014 DG |
114 | |
115 | error: | |
3bd1e081 MD |
116 | return ret; |
117 | } | |
118 | ||
119 | /* | |
ffe60014 DG |
120 | * Allocate and return a consumer channel object. |
121 | */ | |
122 | static struct lttng_consumer_channel *allocate_channel(uint64_t session_id, | |
123 | const char *pathname, const char *name, uid_t uid, gid_t gid, | |
da009f2c | 124 | uint64_t relayd_id, uint64_t key, enum lttng_event_output output, |
2bba9e53 | 125 | uint64_t tracefile_size, uint64_t tracefile_count, |
ecc48a90 JD |
126 | uint64_t session_id_per_pid, unsigned int monitor, |
127 | unsigned int live_timer_interval) | |
ffe60014 DG |
128 | { |
129 | assert(pathname); | |
130 | assert(name); | |
131 | ||
1950109e JD |
132 | return consumer_allocate_channel(key, session_id, pathname, name, uid, |
133 | gid, relayd_id, output, tracefile_size, | |
ecc48a90 | 134 | tracefile_count, session_id_per_pid, monitor, live_timer_interval); |
ffe60014 DG |
135 | } |
136 | ||
137 | /* | |
138 | * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the | |
139 | * error value if applicable is set in it else it is kept untouched. | |
3bd1e081 | 140 | * |
ffe60014 | 141 | * Return NULL on error else the newly allocated stream object. |
3bd1e081 | 142 | */ |
ffe60014 DG |
143 | static struct lttng_consumer_stream *allocate_stream(int cpu, int key, |
144 | struct lttng_consumer_channel *channel, | |
145 | struct lttng_consumer_local_data *ctx, int *_alloc_ret) | |
146 | { | |
147 | int alloc_ret; | |
148 | struct lttng_consumer_stream *stream = NULL; | |
149 | ||
150 | assert(channel); | |
151 | assert(ctx); | |
152 | ||
153 | stream = consumer_allocate_stream(channel->key, | |
154 | key, | |
155 | LTTNG_CONSUMER_ACTIVE_STREAM, | |
156 | channel->name, | |
157 | channel->uid, | |
158 | channel->gid, | |
159 | channel->relayd_id, | |
160 | channel->session_id, | |
161 | cpu, | |
162 | &alloc_ret, | |
4891ece8 DG |
163 | channel->type, |
164 | channel->monitor); | |
ffe60014 DG |
165 | if (stream == NULL) { |
166 | switch (alloc_ret) { | |
167 | case -ENOENT: | |
168 | /* | |
169 | * We could not find the channel. Can happen if cpu hotplug | |
170 | * happens while tearing down. | |
171 | */ | |
172 | DBG3("Could not find channel"); | |
173 | break; | |
174 | case -ENOMEM: | |
175 | case -EINVAL: | |
176 | default: | |
177 | lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_OUTFD_ERROR); | |
178 | break; | |
179 | } | |
180 | goto error; | |
181 | } | |
182 | ||
183 | stream->chan = channel; | |
184 | ||
185 | error: | |
186 | if (_alloc_ret) { | |
187 | *_alloc_ret = alloc_ret; | |
188 | } | |
189 | return stream; | |
190 | } | |
191 | ||
192 | /* | |
193 | * Send the given stream pointer to the corresponding thread. | |
194 | * | |
195 | * Returns 0 on success else a negative value. | |
196 | */ | |
197 | static int send_stream_to_thread(struct lttng_consumer_stream *stream, | |
198 | struct lttng_consumer_local_data *ctx) | |
199 | { | |
dae10966 DG |
200 | int ret; |
201 | struct lttng_pipe *stream_pipe; | |
ffe60014 DG |
202 | |
203 | /* Get the right pipe where the stream will be sent. */ | |
204 | if (stream->metadata_flag) { | |
5ab66908 MD |
205 | ret = consumer_add_metadata_stream(stream); |
206 | if (ret) { | |
207 | ERR("Consumer add metadata stream %" PRIu64 " failed.", | |
208 | stream->key); | |
209 | goto error; | |
210 | } | |
dae10966 | 211 | stream_pipe = ctx->consumer_metadata_pipe; |
ffe60014 | 212 | } else { |
5ab66908 MD |
213 | ret = consumer_add_data_stream(stream); |
214 | if (ret) { | |
215 | ERR("Consumer add stream %" PRIu64 " failed.", | |
216 | stream->key); | |
217 | goto error; | |
218 | } | |
dae10966 | 219 | stream_pipe = ctx->consumer_data_pipe; |
ffe60014 DG |
220 | } |
221 | ||
5ab66908 MD |
222 | /* |
223 | * From this point on, the stream's ownership has been moved away from | |
224 | * the channel and becomes globally visible. | |
225 | */ | |
226 | stream->globally_visible = 1; | |
227 | ||
dae10966 | 228 | ret = lttng_pipe_write(stream_pipe, &stream, sizeof(stream)); |
ffe60014 | 229 | if (ret < 0) { |
dae10966 DG |
230 | ERR("Consumer write %s stream to pipe %d", |
231 | stream->metadata_flag ? "metadata" : "data", | |
232 | lttng_pipe_get_writefd(stream_pipe)); | |
5ab66908 MD |
233 | if (stream->metadata_flag) { |
234 | consumer_del_stream_for_metadata(stream); | |
235 | } else { | |
236 | consumer_del_stream_for_data(stream); | |
237 | } | |
ffe60014 | 238 | } |
5ab66908 | 239 | error: |
ffe60014 DG |
240 | return ret; |
241 | } | |
242 | ||
d88aee68 DG |
243 | /* |
244 | * Create streams for the given channel using liblttng-ust-ctl. | |
245 | * | |
246 | * Return 0 on success else a negative value. | |
247 | */ | |
ffe60014 DG |
248 | static int create_ust_streams(struct lttng_consumer_channel *channel, |
249 | struct lttng_consumer_local_data *ctx) | |
250 | { | |
251 | int ret, cpu = 0; | |
252 | struct ustctl_consumer_stream *ustream; | |
253 | struct lttng_consumer_stream *stream; | |
254 | ||
255 | assert(channel); | |
256 | assert(ctx); | |
257 | ||
258 | /* | |
259 | * While a stream is available from ustctl. When NULL is returned, we've | |
260 | * reached the end of the possible stream for the channel. | |
261 | */ | |
262 | while ((ustream = ustctl_create_stream(channel->uchan, cpu))) { | |
263 | int wait_fd; | |
04ef1097 | 264 | int ust_metadata_pipe[2]; |
ffe60014 | 265 | |
9ce5646a MD |
266 | health_code_update(); |
267 | ||
04ef1097 MD |
268 | if (channel->type == CONSUMER_CHANNEL_TYPE_METADATA && channel->monitor) { |
269 | ret = utils_create_pipe_cloexec_nonblock(ust_metadata_pipe); | |
270 | if (ret < 0) { | |
271 | ERR("Create ust metadata poll pipe"); | |
272 | goto error; | |
273 | } | |
274 | wait_fd = ust_metadata_pipe[0]; | |
275 | } else { | |
276 | wait_fd = ustctl_stream_get_wait_fd(ustream); | |
277 | } | |
ffe60014 DG |
278 | |
279 | /* Allocate consumer stream object. */ | |
280 | stream = allocate_stream(cpu, wait_fd, channel, ctx, &ret); | |
281 | if (!stream) { | |
282 | goto error_alloc; | |
283 | } | |
284 | stream->ustream = ustream; | |
285 | /* | |
286 | * Store it so we can save multiple function calls afterwards since | |
287 | * this value is used heavily in the stream threads. This is UST | |
288 | * specific so this is why it's done after allocation. | |
289 | */ | |
290 | stream->wait_fd = wait_fd; | |
291 | ||
b31398bb DG |
292 | /* |
293 | * Increment channel refcount since the channel reference has now been | |
294 | * assigned in the allocation process above. | |
295 | */ | |
10a50311 JD |
296 | if (stream->chan->monitor) { |
297 | uatomic_inc(&stream->chan->refcount); | |
298 | } | |
b31398bb | 299 | |
ffe60014 DG |
300 | /* |
301 | * Order is important this is why a list is used. On error, the caller | |
302 | * should clean this list. | |
303 | */ | |
304 | cds_list_add_tail(&stream->send_node, &channel->streams.head); | |
305 | ||
306 | ret = ustctl_get_max_subbuf_size(stream->ustream, | |
307 | &stream->max_sb_size); | |
308 | if (ret < 0) { | |
309 | ERR("ustctl_get_max_subbuf_size failed for stream %s", | |
310 | stream->name); | |
311 | goto error; | |
312 | } | |
313 | ||
314 | /* Do actions once stream has been received. */ | |
315 | if (ctx->on_recv_stream) { | |
316 | ret = ctx->on_recv_stream(stream); | |
317 | if (ret < 0) { | |
318 | goto error; | |
319 | } | |
320 | } | |
321 | ||
d88aee68 | 322 | DBG("UST consumer add stream %s (key: %" PRIu64 ") with relayd id %" PRIu64, |
ffe60014 DG |
323 | stream->name, stream->key, stream->relayd_stream_id); |
324 | ||
325 | /* Set next CPU stream. */ | |
326 | channel->streams.count = ++cpu; | |
d88aee68 DG |
327 | |
328 | /* Keep stream reference when creating metadata. */ | |
329 | if (channel->type == CONSUMER_CHANNEL_TYPE_METADATA) { | |
330 | channel->metadata_stream = stream; | |
8a6c148b JG |
331 | if (channel->monitor) { |
332 | /* Set metadata poll pipe if we created one */ | |
333 | memcpy(stream->ust_metadata_poll_pipe, | |
334 | ust_metadata_pipe, | |
335 | sizeof(ust_metadata_pipe)); | |
336 | } | |
d88aee68 | 337 | } |
ffe60014 DG |
338 | } |
339 | ||
340 | return 0; | |
341 | ||
342 | error: | |
343 | error_alloc: | |
344 | return ret; | |
345 | } | |
346 | ||
347 | /* | |
348 | * Create an UST channel with the given attributes and send it to the session | |
349 | * daemon using the ust ctl API. | |
350 | * | |
351 | * Return 0 on success or else a negative value. | |
352 | */ | |
353 | static int create_ust_channel(struct ustctl_consumer_channel_attr *attr, | |
354 | struct ustctl_consumer_channel **chanp) | |
355 | { | |
356 | int ret; | |
357 | struct ustctl_consumer_channel *channel; | |
358 | ||
359 | assert(attr); | |
360 | assert(chanp); | |
361 | ||
362 | DBG3("Creating channel to ustctl with attr: [overwrite: %d, " | |
363 | "subbuf_size: %" PRIu64 ", num_subbuf: %" PRIu64 ", " | |
364 | "switch_timer_interval: %u, read_timer_interval: %u, " | |
365 | "output: %d, type: %d", attr->overwrite, attr->subbuf_size, | |
366 | attr->num_subbuf, attr->switch_timer_interval, | |
367 | attr->read_timer_interval, attr->output, attr->type); | |
368 | ||
369 | channel = ustctl_create_channel(attr); | |
370 | if (!channel) { | |
371 | ret = -1; | |
372 | goto error_create; | |
373 | } | |
374 | ||
375 | *chanp = channel; | |
376 | ||
377 | return 0; | |
378 | ||
379 | error_create: | |
380 | return ret; | |
381 | } | |
382 | ||
d88aee68 DG |
383 | /* |
384 | * Send a single given stream to the session daemon using the sock. | |
385 | * | |
386 | * Return 0 on success else a negative value. | |
387 | */ | |
ffe60014 DG |
388 | static int send_sessiond_stream(int sock, struct lttng_consumer_stream *stream) |
389 | { | |
390 | int ret; | |
391 | ||
392 | assert(stream); | |
393 | assert(sock >= 0); | |
394 | ||
3eb914c0 | 395 | DBG("UST consumer sending stream %" PRIu64 " to sessiond", stream->key); |
ffe60014 DG |
396 | |
397 | /* Send stream to session daemon. */ | |
398 | ret = ustctl_send_stream_to_sessiond(sock, stream->ustream); | |
399 | if (ret < 0) { | |
400 | goto error; | |
401 | } | |
402 | ||
ffe60014 DG |
403 | error: |
404 | return ret; | |
405 | } | |
406 | ||
407 | /* | |
408 | * Send channel to sessiond. | |
409 | * | |
d88aee68 | 410 | * Return 0 on success or else a negative value. |
ffe60014 DG |
411 | */ |
412 | static int send_sessiond_channel(int sock, | |
413 | struct lttng_consumer_channel *channel, | |
414 | struct lttng_consumer_local_data *ctx, int *relayd_error) | |
415 | { | |
0c759fc9 | 416 | int ret, ret_code = LTTCOMM_CONSUMERD_SUCCESS; |
ffe60014 | 417 | struct lttng_consumer_stream *stream; |
a4baae1b | 418 | uint64_t net_seq_idx = -1ULL; |
ffe60014 DG |
419 | |
420 | assert(channel); | |
421 | assert(ctx); | |
422 | assert(sock >= 0); | |
423 | ||
424 | DBG("UST consumer sending channel %s to sessiond", channel->name); | |
425 | ||
62285ea4 DG |
426 | if (channel->relayd_id != (uint64_t) -1ULL) { |
427 | cds_list_for_each_entry(stream, &channel->streams.head, send_node) { | |
9ce5646a MD |
428 | |
429 | health_code_update(); | |
430 | ||
62285ea4 DG |
431 | /* Try to send the stream to the relayd if one is available. */ |
432 | ret = consumer_send_relayd_stream(stream, stream->chan->pathname); | |
433 | if (ret < 0) { | |
434 | /* | |
435 | * Flag that the relayd was the problem here probably due to a | |
436 | * communicaton error on the socket. | |
437 | */ | |
438 | if (relayd_error) { | |
439 | *relayd_error = 1; | |
440 | } | |
441 | ret_code = LTTNG_ERR_RELAYD_CONNECT_FAIL; | |
ffe60014 | 442 | } |
a4baae1b JD |
443 | if (net_seq_idx == -1ULL) { |
444 | net_seq_idx = stream->net_seq_idx; | |
445 | } | |
446 | } | |
f2a444f1 | 447 | } |
ffe60014 | 448 | |
f2a444f1 DG |
449 | /* Inform sessiond that we are about to send channel and streams. */ |
450 | ret = consumer_send_status_msg(sock, ret_code); | |
0c759fc9 | 451 | if (ret < 0 || ret_code != LTTCOMM_CONSUMERD_SUCCESS) { |
f2a444f1 DG |
452 | /* |
453 | * Either the session daemon is not responding or the relayd died so we | |
454 | * stop now. | |
455 | */ | |
456 | goto error; | |
457 | } | |
458 | ||
459 | /* Send channel to sessiond. */ | |
460 | ret = ustctl_send_channel_to_sessiond(sock, channel->uchan); | |
461 | if (ret < 0) { | |
462 | goto error; | |
463 | } | |
464 | ||
465 | ret = ustctl_channel_close_wakeup_fd(channel->uchan); | |
466 | if (ret < 0) { | |
467 | goto error; | |
468 | } | |
469 | ||
470 | /* The channel was sent successfully to the sessiond at this point. */ | |
471 | cds_list_for_each_entry(stream, &channel->streams.head, send_node) { | |
9ce5646a MD |
472 | |
473 | health_code_update(); | |
474 | ||
ffe60014 DG |
475 | /* Send stream to session daemon. */ |
476 | ret = send_sessiond_stream(sock, stream); | |
477 | if (ret < 0) { | |
478 | goto error; | |
479 | } | |
480 | } | |
481 | ||
482 | /* Tell sessiond there is no more stream. */ | |
483 | ret = ustctl_send_stream_to_sessiond(sock, NULL); | |
484 | if (ret < 0) { | |
485 | goto error; | |
486 | } | |
487 | ||
488 | DBG("UST consumer NULL stream sent to sessiond"); | |
489 | ||
490 | return 0; | |
491 | ||
492 | error: | |
0c759fc9 | 493 | if (ret_code != LTTCOMM_CONSUMERD_SUCCESS) { |
f2a444f1 DG |
494 | ret = -1; |
495 | } | |
ffe60014 DG |
496 | return ret; |
497 | } | |
498 | ||
499 | /* | |
500 | * Creates a channel and streams and add the channel it to the channel internal | |
501 | * state. The created stream must ONLY be sent once the GET_CHANNEL command is | |
502 | * received. | |
503 | * | |
504 | * Return 0 on success or else, a negative value is returned and the channel | |
505 | * MUST be destroyed by consumer_del_channel(). | |
506 | */ | |
507 | static int ask_channel(struct lttng_consumer_local_data *ctx, int sock, | |
508 | struct lttng_consumer_channel *channel, | |
509 | struct ustctl_consumer_channel_attr *attr) | |
3bd1e081 MD |
510 | { |
511 | int ret; | |
512 | ||
ffe60014 DG |
513 | assert(ctx); |
514 | assert(channel); | |
515 | assert(attr); | |
516 | ||
517 | /* | |
518 | * This value is still used by the kernel consumer since for the kernel, | |
519 | * the stream ownership is not IN the consumer so we need to have the | |
520 | * number of left stream that needs to be initialized so we can know when | |
521 | * to delete the channel (see consumer.c). | |
522 | * | |
523 | * As for the user space tracer now, the consumer creates and sends the | |
524 | * stream to the session daemon which only sends them to the application | |
525 | * once every stream of a channel is received making this value useless | |
526 | * because we they will be added to the poll thread before the application | |
527 | * receives them. This ensures that a stream can not hang up during | |
528 | * initilization of a channel. | |
529 | */ | |
530 | channel->nb_init_stream_left = 0; | |
531 | ||
532 | /* The reply msg status is handled in the following call. */ | |
533 | ret = create_ust_channel(attr, &channel->uchan); | |
534 | if (ret < 0) { | |
10a50311 | 535 | goto end; |
3bd1e081 MD |
536 | } |
537 | ||
d8ef542d MD |
538 | channel->wait_fd = ustctl_channel_get_wait_fd(channel->uchan); |
539 | ||
10a50311 JD |
540 | /* |
541 | * For the snapshots (no monitor), we create the metadata streams | |
542 | * on demand, not during the channel creation. | |
543 | */ | |
544 | if (channel->type == CONSUMER_CHANNEL_TYPE_METADATA && !channel->monitor) { | |
545 | ret = 0; | |
546 | goto end; | |
547 | } | |
548 | ||
ffe60014 DG |
549 | /* Open all streams for this channel. */ |
550 | ret = create_ust_streams(channel, ctx); | |
551 | if (ret < 0) { | |
10a50311 | 552 | goto end; |
ffe60014 DG |
553 | } |
554 | ||
10a50311 | 555 | end: |
3bd1e081 MD |
556 | return ret; |
557 | } | |
558 | ||
d88aee68 DG |
559 | /* |
560 | * Send all stream of a channel to the right thread handling it. | |
561 | * | |
562 | * On error, return a negative value else 0 on success. | |
563 | */ | |
564 | static int send_streams_to_thread(struct lttng_consumer_channel *channel, | |
565 | struct lttng_consumer_local_data *ctx) | |
566 | { | |
567 | int ret = 0; | |
568 | struct lttng_consumer_stream *stream, *stmp; | |
569 | ||
570 | assert(channel); | |
571 | assert(ctx); | |
572 | ||
573 | /* Send streams to the corresponding thread. */ | |
574 | cds_list_for_each_entry_safe(stream, stmp, &channel->streams.head, | |
575 | send_node) { | |
9ce5646a MD |
576 | |
577 | health_code_update(); | |
578 | ||
d88aee68 DG |
579 | /* Sending the stream to the thread. */ |
580 | ret = send_stream_to_thread(stream, ctx); | |
581 | if (ret < 0) { | |
582 | /* | |
583 | * If we are unable to send the stream to the thread, there is | |
584 | * a big problem so just stop everything. | |
585 | */ | |
5ab66908 MD |
586 | /* Remove node from the channel stream list. */ |
587 | cds_list_del(&stream->send_node); | |
d88aee68 DG |
588 | goto error; |
589 | } | |
590 | ||
591 | /* Remove node from the channel stream list. */ | |
592 | cds_list_del(&stream->send_node); | |
4891ece8 | 593 | |
d88aee68 DG |
594 | } |
595 | ||
596 | error: | |
597 | return ret; | |
598 | } | |
599 | ||
7972aab2 DG |
600 | /* |
601 | * Flush channel's streams using the given key to retrieve the channel. | |
602 | * | |
603 | * Return 0 on success else an LTTng error code. | |
604 | */ | |
605 | static int flush_channel(uint64_t chan_key) | |
606 | { | |
607 | int ret = 0; | |
608 | struct lttng_consumer_channel *channel; | |
609 | struct lttng_consumer_stream *stream; | |
610 | struct lttng_ht *ht; | |
611 | struct lttng_ht_iter iter; | |
612 | ||
8fd623e0 | 613 | DBG("UST consumer flush channel key %" PRIu64, chan_key); |
7972aab2 | 614 | |
a500c257 | 615 | rcu_read_lock(); |
7972aab2 DG |
616 | channel = consumer_find_channel(chan_key); |
617 | if (!channel) { | |
8fd623e0 | 618 | ERR("UST consumer flush channel %" PRIu64 " not found", chan_key); |
7972aab2 DG |
619 | ret = LTTNG_ERR_UST_CHAN_NOT_FOUND; |
620 | goto error; | |
621 | } | |
622 | ||
623 | ht = consumer_data.stream_per_chan_id_ht; | |
624 | ||
625 | /* For each stream of the channel id, flush it. */ | |
7972aab2 DG |
626 | cds_lfht_for_each_entry_duplicate(ht->ht, |
627 | ht->hash_fct(&channel->key, lttng_ht_seed), ht->match_fct, | |
628 | &channel->key, &iter.iter, stream, node_channel_id.node) { | |
9ce5646a MD |
629 | |
630 | health_code_update(); | |
631 | ||
9c9abe17 MD |
632 | pthread_mutex_lock(&stream->lock); |
633 | if (!stream->quiescent) { | |
634 | ustctl_flush_buffer(stream->ustream, 0); | |
635 | stream->quiescent = true; | |
636 | } | |
637 | pthread_mutex_unlock(&stream->lock); | |
638 | } | |
639 | error: | |
640 | rcu_read_unlock(); | |
641 | return ret; | |
642 | } | |
643 | ||
644 | /* | |
645 | * Clear quiescent state from channel's streams using the given key to | |
646 | * retrieve the channel. | |
647 | * | |
648 | * Return 0 on success else an LTTng error code. | |
649 | */ | |
650 | static int clear_quiescent_channel(uint64_t chan_key) | |
651 | { | |
652 | int ret = 0; | |
653 | struct lttng_consumer_channel *channel; | |
654 | struct lttng_consumer_stream *stream; | |
655 | struct lttng_ht *ht; | |
656 | struct lttng_ht_iter iter; | |
657 | ||
658 | DBG("UST consumer clear quiescent channel key %" PRIu64, chan_key); | |
659 | ||
660 | rcu_read_lock(); | |
661 | channel = consumer_find_channel(chan_key); | |
662 | if (!channel) { | |
663 | ERR("UST consumer clear quiescent channel %" PRIu64 " not found", chan_key); | |
664 | ret = LTTNG_ERR_UST_CHAN_NOT_FOUND; | |
665 | goto error; | |
666 | } | |
667 | ||
668 | ht = consumer_data.stream_per_chan_id_ht; | |
669 | ||
670 | /* For each stream of the channel id, clear quiescent state. */ | |
671 | cds_lfht_for_each_entry_duplicate(ht->ht, | |
672 | ht->hash_fct(&channel->key, lttng_ht_seed), ht->match_fct, | |
673 | &channel->key, &iter.iter, stream, node_channel_id.node) { | |
674 | ||
675 | health_code_update(); | |
676 | ||
677 | pthread_mutex_lock(&stream->lock); | |
678 | stream->quiescent = false; | |
679 | pthread_mutex_unlock(&stream->lock); | |
7972aab2 | 680 | } |
7972aab2 | 681 | error: |
a500c257 | 682 | rcu_read_unlock(); |
7972aab2 DG |
683 | return ret; |
684 | } | |
685 | ||
d88aee68 DG |
686 | /* |
687 | * Close metadata stream wakeup_fd using the given key to retrieve the channel. | |
a500c257 | 688 | * RCU read side lock MUST be acquired before calling this function. |
d88aee68 DG |
689 | * |
690 | * Return 0 on success else an LTTng error code. | |
691 | */ | |
692 | static int close_metadata(uint64_t chan_key) | |
693 | { | |
ea88ca2a | 694 | int ret = 0; |
d88aee68 DG |
695 | struct lttng_consumer_channel *channel; |
696 | ||
8fd623e0 | 697 | DBG("UST consumer close metadata key %" PRIu64, chan_key); |
d88aee68 DG |
698 | |
699 | channel = consumer_find_channel(chan_key); | |
700 | if (!channel) { | |
84cc9aa0 DG |
701 | /* |
702 | * This is possible if the metadata thread has issue a delete because | |
703 | * the endpoint point of the stream hung up. There is no way the | |
704 | * session daemon can know about it thus use a DBG instead of an actual | |
705 | * error. | |
706 | */ | |
707 | DBG("UST consumer close metadata %" PRIu64 " not found", chan_key); | |
d88aee68 DG |
708 | ret = LTTNG_ERR_UST_CHAN_NOT_FOUND; |
709 | goto error; | |
710 | } | |
711 | ||
ea88ca2a | 712 | pthread_mutex_lock(&consumer_data.lock); |
a9838785 | 713 | pthread_mutex_lock(&channel->lock); |
73811ecc DG |
714 | |
715 | if (cds_lfht_is_node_deleted(&channel->node.node)) { | |
716 | goto error_unlock; | |
717 | } | |
718 | ||
6d574024 | 719 | lttng_ustconsumer_close_metadata(channel); |
d88aee68 | 720 | |
ea88ca2a | 721 | error_unlock: |
a9838785 | 722 | pthread_mutex_unlock(&channel->lock); |
ea88ca2a | 723 | pthread_mutex_unlock(&consumer_data.lock); |
d88aee68 DG |
724 | error: |
725 | return ret; | |
726 | } | |
727 | ||
728 | /* | |
729 | * RCU read side lock MUST be acquired before calling this function. | |
730 | * | |
731 | * Return 0 on success else an LTTng error code. | |
732 | */ | |
733 | static int setup_metadata(struct lttng_consumer_local_data *ctx, uint64_t key) | |
734 | { | |
735 | int ret; | |
736 | struct lttng_consumer_channel *metadata; | |
737 | ||
8fd623e0 | 738 | DBG("UST consumer setup metadata key %" PRIu64, key); |
d88aee68 DG |
739 | |
740 | metadata = consumer_find_channel(key); | |
741 | if (!metadata) { | |
742 | ERR("UST consumer push metadata %" PRIu64 " not found", key); | |
743 | ret = LTTNG_ERR_UST_CHAN_NOT_FOUND; | |
10a50311 JD |
744 | goto end; |
745 | } | |
746 | ||
747 | /* | |
748 | * In no monitor mode, the metadata channel has no stream(s) so skip the | |
749 | * ownership transfer to the metadata thread. | |
750 | */ | |
751 | if (!metadata->monitor) { | |
752 | DBG("Metadata channel in no monitor"); | |
753 | ret = 0; | |
754 | goto end; | |
d88aee68 DG |
755 | } |
756 | ||
757 | /* | |
758 | * Send metadata stream to relayd if one available. Availability is | |
759 | * known if the stream is still in the list of the channel. | |
760 | */ | |
761 | if (cds_list_empty(&metadata->streams.head)) { | |
762 | ERR("Metadata channel key %" PRIu64 ", no stream available.", key); | |
763 | ret = LTTCOMM_CONSUMERD_ERROR_METADATA; | |
f5a0c9cf | 764 | goto error_no_stream; |
d88aee68 DG |
765 | } |
766 | ||
767 | /* Send metadata stream to relayd if needed. */ | |
62285ea4 DG |
768 | if (metadata->metadata_stream->net_seq_idx != (uint64_t) -1ULL) { |
769 | ret = consumer_send_relayd_stream(metadata->metadata_stream, | |
770 | metadata->pathname); | |
771 | if (ret < 0) { | |
772 | ret = LTTCOMM_CONSUMERD_ERROR_METADATA; | |
773 | goto error; | |
774 | } | |
601262d6 JD |
775 | ret = consumer_send_relayd_streams_sent( |
776 | metadata->metadata_stream->net_seq_idx); | |
777 | if (ret < 0) { | |
778 | ret = LTTCOMM_CONSUMERD_RELAYD_FAIL; | |
779 | goto error; | |
780 | } | |
d88aee68 DG |
781 | } |
782 | ||
783 | ret = send_streams_to_thread(metadata, ctx); | |
784 | if (ret < 0) { | |
785 | /* | |
786 | * If we are unable to send the stream to the thread, there is | |
787 | * a big problem so just stop everything. | |
788 | */ | |
789 | ret = LTTCOMM_CONSUMERD_FATAL; | |
790 | goto error; | |
791 | } | |
792 | /* List MUST be empty after or else it could be reused. */ | |
793 | assert(cds_list_empty(&metadata->streams.head)); | |
794 | ||
10a50311 JD |
795 | ret = 0; |
796 | goto end; | |
d88aee68 DG |
797 | |
798 | error: | |
f2a444f1 DG |
799 | /* |
800 | * Delete metadata channel on error. At this point, the metadata stream can | |
801 | * NOT be monitored by the metadata thread thus having the guarantee that | |
802 | * the stream is still in the local stream list of the channel. This call | |
803 | * will make sure to clean that list. | |
804 | */ | |
f5a0c9cf | 805 | consumer_stream_destroy(metadata->metadata_stream, NULL); |
212d67a2 DG |
806 | cds_list_del(&metadata->metadata_stream->send_node); |
807 | metadata->metadata_stream = NULL; | |
f5a0c9cf | 808 | error_no_stream: |
10a50311 JD |
809 | end: |
810 | return ret; | |
811 | } | |
812 | ||
813 | /* | |
814 | * Snapshot the whole metadata. | |
815 | * | |
816 | * Returns 0 on success, < 0 on error | |
817 | */ | |
818 | static int snapshot_metadata(uint64_t key, char *path, uint64_t relayd_id, | |
819 | struct lttng_consumer_local_data *ctx) | |
820 | { | |
821 | int ret = 0; | |
10a50311 JD |
822 | struct lttng_consumer_channel *metadata_channel; |
823 | struct lttng_consumer_stream *metadata_stream; | |
824 | ||
825 | assert(path); | |
826 | assert(ctx); | |
827 | ||
828 | DBG("UST consumer snapshot metadata with key %" PRIu64 " at path %s", | |
829 | key, path); | |
830 | ||
831 | rcu_read_lock(); | |
832 | ||
833 | metadata_channel = consumer_find_channel(key); | |
834 | if (!metadata_channel) { | |
6a00837f MD |
835 | ERR("UST snapshot metadata channel not found for key %" PRIu64, |
836 | key); | |
10a50311 JD |
837 | ret = -1; |
838 | goto error; | |
839 | } | |
840 | assert(!metadata_channel->monitor); | |
841 | ||
9ce5646a MD |
842 | health_code_update(); |
843 | ||
10a50311 JD |
844 | /* |
845 | * Ask the sessiond if we have new metadata waiting and update the | |
846 | * consumer metadata cache. | |
847 | */ | |
94d49140 | 848 | ret = lttng_ustconsumer_request_metadata(ctx, metadata_channel, 0, 1); |
10a50311 JD |
849 | if (ret < 0) { |
850 | goto error; | |
851 | } | |
852 | ||
9ce5646a MD |
853 | health_code_update(); |
854 | ||
10a50311 JD |
855 | /* |
856 | * The metadata stream is NOT created in no monitor mode when the channel | |
857 | * is created on a sessiond ask channel command. | |
858 | */ | |
859 | ret = create_ust_streams(metadata_channel, ctx); | |
860 | if (ret < 0) { | |
861 | goto error; | |
862 | } | |
863 | ||
864 | metadata_stream = metadata_channel->metadata_stream; | |
865 | assert(metadata_stream); | |
866 | ||
867 | if (relayd_id != (uint64_t) -1ULL) { | |
868 | metadata_stream->net_seq_idx = relayd_id; | |
869 | ret = consumer_send_relayd_stream(metadata_stream, path); | |
870 | if (ret < 0) { | |
871 | goto error_stream; | |
872 | } | |
873 | } else { | |
874 | ret = utils_create_stream_file(path, metadata_stream->name, | |
875 | metadata_stream->chan->tracefile_size, | |
876 | metadata_stream->tracefile_count_current, | |
309167d2 | 877 | metadata_stream->uid, metadata_stream->gid, NULL); |
10a50311 JD |
878 | if (ret < 0) { |
879 | goto error_stream; | |
880 | } | |
881 | metadata_stream->out_fd = ret; | |
882 | metadata_stream->tracefile_size_current = 0; | |
883 | } | |
884 | ||
04ef1097 | 885 | do { |
9ce5646a MD |
886 | health_code_update(); |
887 | ||
10a50311 JD |
888 | ret = lttng_consumer_read_subbuffer(metadata_stream, ctx); |
889 | if (ret < 0) { | |
94d49140 | 890 | goto error_stream; |
10a50311 | 891 | } |
04ef1097 | 892 | } while (ret > 0); |
10a50311 | 893 | |
10a50311 JD |
894 | error_stream: |
895 | /* | |
896 | * Clean up the stream completly because the next snapshot will use a new | |
897 | * metadata stream. | |
898 | */ | |
10a50311 | 899 | consumer_stream_destroy(metadata_stream, NULL); |
212d67a2 | 900 | cds_list_del(&metadata_stream->send_node); |
10a50311 JD |
901 | metadata_channel->metadata_stream = NULL; |
902 | ||
903 | error: | |
904 | rcu_read_unlock(); | |
905 | return ret; | |
906 | } | |
907 | ||
908 | /* | |
909 | * Take a snapshot of all the stream of a channel. | |
910 | * | |
911 | * Returns 0 on success, < 0 on error | |
912 | */ | |
913 | static int snapshot_channel(uint64_t key, char *path, uint64_t relayd_id, | |
135347bd | 914 | uint64_t nb_packets_per_stream, struct lttng_consumer_local_data *ctx) |
10a50311 JD |
915 | { |
916 | int ret; | |
917 | unsigned use_relayd = 0; | |
918 | unsigned long consumed_pos, produced_pos; | |
919 | struct lttng_consumer_channel *channel; | |
920 | struct lttng_consumer_stream *stream; | |
921 | ||
922 | assert(path); | |
923 | assert(ctx); | |
924 | ||
925 | rcu_read_lock(); | |
926 | ||
927 | if (relayd_id != (uint64_t) -1ULL) { | |
928 | use_relayd = 1; | |
929 | } | |
930 | ||
931 | channel = consumer_find_channel(key); | |
932 | if (!channel) { | |
6a00837f | 933 | ERR("UST snapshot channel not found for key %" PRIu64, key); |
10a50311 JD |
934 | ret = -1; |
935 | goto error; | |
936 | } | |
937 | assert(!channel->monitor); | |
6a00837f | 938 | DBG("UST consumer snapshot channel %" PRIu64, key); |
10a50311 JD |
939 | |
940 | cds_list_for_each_entry(stream, &channel->streams.head, send_node) { | |
9ce5646a MD |
941 | |
942 | health_code_update(); | |
943 | ||
10a50311 JD |
944 | /* Lock stream because we are about to change its state. */ |
945 | pthread_mutex_lock(&stream->lock); | |
946 | stream->net_seq_idx = relayd_id; | |
947 | ||
948 | if (use_relayd) { | |
949 | ret = consumer_send_relayd_stream(stream, path); | |
950 | if (ret < 0) { | |
951 | goto error_unlock; | |
952 | } | |
953 | } else { | |
954 | ret = utils_create_stream_file(path, stream->name, | |
955 | stream->chan->tracefile_size, | |
956 | stream->tracefile_count_current, | |
309167d2 | 957 | stream->uid, stream->gid, NULL); |
10a50311 JD |
958 | if (ret < 0) { |
959 | goto error_unlock; | |
960 | } | |
961 | stream->out_fd = ret; | |
962 | stream->tracefile_size_current = 0; | |
963 | ||
964 | DBG("UST consumer snapshot stream %s/%s (%" PRIu64 ")", path, | |
965 | stream->name, stream->key); | |
966 | } | |
a4baae1b JD |
967 | if (relayd_id != -1ULL) { |
968 | ret = consumer_send_relayd_streams_sent(relayd_id); | |
969 | if (ret < 0) { | |
970 | goto error_unlock; | |
971 | } | |
972 | } | |
10a50311 JD |
973 | |
974 | ustctl_flush_buffer(stream->ustream, 1); | |
975 | ||
976 | ret = lttng_ustconsumer_take_snapshot(stream); | |
977 | if (ret < 0) { | |
978 | ERR("Taking UST snapshot"); | |
979 | goto error_unlock; | |
980 | } | |
981 | ||
982 | ret = lttng_ustconsumer_get_produced_snapshot(stream, &produced_pos); | |
983 | if (ret < 0) { | |
984 | ERR("Produced UST snapshot position"); | |
985 | goto error_unlock; | |
986 | } | |
987 | ||
988 | ret = lttng_ustconsumer_get_consumed_snapshot(stream, &consumed_pos); | |
989 | if (ret < 0) { | |
990 | ERR("Consumerd UST snapshot position"); | |
991 | goto error_unlock; | |
992 | } | |
993 | ||
5c786ded JD |
994 | /* |
995 | * The original value is sent back if max stream size is larger than | |
135347bd | 996 | * the possible size of the snapshot. Also, we assume that the session |
5c786ded JD |
997 | * daemon should never send a maximum stream size that is lower than |
998 | * subbuffer size. | |
999 | */ | |
135347bd MD |
1000 | consumed_pos = consumer_get_consume_start_pos(consumed_pos, |
1001 | produced_pos, nb_packets_per_stream, | |
1002 | stream->max_sb_size); | |
5c786ded | 1003 | |
10a50311 JD |
1004 | while (consumed_pos < produced_pos) { |
1005 | ssize_t read_len; | |
1006 | unsigned long len, padded_len; | |
1007 | ||
9ce5646a MD |
1008 | health_code_update(); |
1009 | ||
10a50311 JD |
1010 | DBG("UST consumer taking snapshot at pos %lu", consumed_pos); |
1011 | ||
1012 | ret = ustctl_get_subbuf(stream->ustream, &consumed_pos); | |
1013 | if (ret < 0) { | |
1014 | if (ret != -EAGAIN) { | |
1015 | PERROR("ustctl_get_subbuf snapshot"); | |
1016 | goto error_close_stream; | |
1017 | } | |
1018 | DBG("UST consumer get subbuf failed. Skipping it."); | |
1019 | consumed_pos += stream->max_sb_size; | |
1020 | continue; | |
1021 | } | |
1022 | ||
1023 | ret = ustctl_get_subbuf_size(stream->ustream, &len); | |
1024 | if (ret < 0) { | |
1025 | ERR("Snapshot ustctl_get_subbuf_size"); | |
1026 | goto error_put_subbuf; | |
1027 | } | |
1028 | ||
1029 | ret = ustctl_get_padded_subbuf_size(stream->ustream, &padded_len); | |
1030 | if (ret < 0) { | |
1031 | ERR("Snapshot ustctl_get_padded_subbuf_size"); | |
1032 | goto error_put_subbuf; | |
1033 | } | |
1034 | ||
1035 | read_len = lttng_consumer_on_read_subbuffer_mmap(ctx, stream, len, | |
309167d2 | 1036 | padded_len - len, NULL); |
10a50311 JD |
1037 | if (use_relayd) { |
1038 | if (read_len != len) { | |
56591bac | 1039 | ret = -EPERM; |
10a50311 JD |
1040 | goto error_put_subbuf; |
1041 | } | |
1042 | } else { | |
1043 | if (read_len != padded_len) { | |
56591bac | 1044 | ret = -EPERM; |
10a50311 JD |
1045 | goto error_put_subbuf; |
1046 | } | |
1047 | } | |
1048 | ||
1049 | ret = ustctl_put_subbuf(stream->ustream); | |
1050 | if (ret < 0) { | |
1051 | ERR("Snapshot ustctl_put_subbuf"); | |
1052 | goto error_close_stream; | |
1053 | } | |
1054 | consumed_pos += stream->max_sb_size; | |
1055 | } | |
1056 | ||
1057 | /* Simply close the stream so we can use it on the next snapshot. */ | |
1058 | consumer_stream_close(stream); | |
1059 | pthread_mutex_unlock(&stream->lock); | |
1060 | } | |
1061 | ||
1062 | rcu_read_unlock(); | |
1063 | return 0; | |
1064 | ||
1065 | error_put_subbuf: | |
1066 | if (ustctl_put_subbuf(stream->ustream) < 0) { | |
1067 | ERR("Snapshot ustctl_put_subbuf"); | |
1068 | } | |
1069 | error_close_stream: | |
1070 | consumer_stream_close(stream); | |
1071 | error_unlock: | |
1072 | pthread_mutex_unlock(&stream->lock); | |
1073 | error: | |
1074 | rcu_read_unlock(); | |
d88aee68 DG |
1075 | return ret; |
1076 | } | |
1077 | ||
331744e3 | 1078 | /* |
5cc6b3e4 MD |
1079 | * Receive the metadata updates from the sessiond. Supports receiving |
1080 | * overlapping metadata, but is needs to always belong to a contiguous | |
1081 | * range starting from 0. | |
1082 | * Be careful about the locks held when calling this function: it needs | |
1083 | * the metadata cache flush to concurrently progress in order to | |
1084 | * complete. | |
331744e3 JD |
1085 | */ |
1086 | int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset, | |
5e41ebe1 | 1087 | uint64_t len, struct lttng_consumer_channel *channel, |
94d49140 | 1088 | int timer, int wait) |
331744e3 | 1089 | { |
0c759fc9 | 1090 | int ret, ret_code = LTTCOMM_CONSUMERD_SUCCESS; |
331744e3 JD |
1091 | char *metadata_str; |
1092 | ||
8fd623e0 | 1093 | DBG("UST consumer push metadata key %" PRIu64 " of len %" PRIu64, key, len); |
331744e3 JD |
1094 | |
1095 | metadata_str = zmalloc(len * sizeof(char)); | |
1096 | if (!metadata_str) { | |
1097 | PERROR("zmalloc metadata string"); | |
1098 | ret_code = LTTCOMM_CONSUMERD_ENOMEM; | |
1099 | goto end; | |
1100 | } | |
1101 | ||
9ce5646a MD |
1102 | health_code_update(); |
1103 | ||
331744e3 JD |
1104 | /* Receive metadata string. */ |
1105 | ret = lttcomm_recv_unix_sock(sock, metadata_str, len); | |
1106 | if (ret < 0) { | |
1107 | /* Session daemon is dead so return gracefully. */ | |
1108 | ret_code = ret; | |
1109 | goto end_free; | |
1110 | } | |
1111 | ||
9ce5646a MD |
1112 | health_code_update(); |
1113 | ||
331744e3 JD |
1114 | pthread_mutex_lock(&channel->metadata_cache->lock); |
1115 | ret = consumer_metadata_cache_write(channel, offset, len, metadata_str); | |
1116 | if (ret < 0) { | |
1117 | /* Unable to handle metadata. Notify session daemon. */ | |
1118 | ret_code = LTTCOMM_CONSUMERD_ERROR_METADATA; | |
a32bd775 DG |
1119 | /* |
1120 | * Skip metadata flush on write error since the offset and len might | |
1121 | * not have been updated which could create an infinite loop below when | |
1122 | * waiting for the metadata cache to be flushed. | |
1123 | */ | |
1124 | pthread_mutex_unlock(&channel->metadata_cache->lock); | |
a32bd775 | 1125 | goto end_free; |
331744e3 JD |
1126 | } |
1127 | pthread_mutex_unlock(&channel->metadata_cache->lock); | |
1128 | ||
94d49140 JD |
1129 | if (!wait) { |
1130 | goto end_free; | |
1131 | } | |
5e41ebe1 | 1132 | while (consumer_metadata_cache_flushed(channel, offset + len, timer)) { |
331744e3 | 1133 | DBG("Waiting for metadata to be flushed"); |
9ce5646a MD |
1134 | |
1135 | health_code_update(); | |
1136 | ||
331744e3 JD |
1137 | usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME); |
1138 | } | |
1139 | ||
1140 | end_free: | |
1141 | free(metadata_str); | |
1142 | end: | |
1143 | return ret_code; | |
1144 | } | |
1145 | ||
4cbc1a04 DG |
1146 | /* |
1147 | * Receive command from session daemon and process it. | |
1148 | * | |
1149 | * Return 1 on success else a negative value or 0. | |
1150 | */ | |
3bd1e081 MD |
1151 | int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx, |
1152 | int sock, struct pollfd *consumer_sockpoll) | |
1153 | { | |
1154 | ssize_t ret; | |
0c759fc9 | 1155 | enum lttcomm_return_code ret_code = LTTCOMM_CONSUMERD_SUCCESS; |
3bd1e081 | 1156 | struct lttcomm_consumer_msg msg; |
ffe60014 | 1157 | struct lttng_consumer_channel *channel = NULL; |
3bd1e081 | 1158 | |
9ce5646a MD |
1159 | health_code_update(); |
1160 | ||
3bd1e081 MD |
1161 | ret = lttcomm_recv_unix_sock(sock, &msg, sizeof(msg)); |
1162 | if (ret != sizeof(msg)) { | |
173af62f DG |
1163 | DBG("Consumer received unexpected message size %zd (expects %zu)", |
1164 | ret, sizeof(msg)); | |
3be74084 DG |
1165 | /* |
1166 | * The ret value might 0 meaning an orderly shutdown but this is ok | |
1167 | * since the caller handles this. | |
1168 | */ | |
489f70e9 | 1169 | if (ret > 0) { |
c6857fcf | 1170 | lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_ERROR_RECV_CMD); |
489f70e9 MD |
1171 | ret = -1; |
1172 | } | |
3bd1e081 MD |
1173 | return ret; |
1174 | } | |
9ce5646a MD |
1175 | |
1176 | health_code_update(); | |
1177 | ||
84382d49 MD |
1178 | /* deprecated */ |
1179 | assert(msg.cmd_type != LTTNG_CONSUMER_STOP); | |
3bd1e081 | 1180 | |
9ce5646a MD |
1181 | health_code_update(); |
1182 | ||
3f8e211f | 1183 | /* relayd needs RCU read-side lock */ |
b0b335c8 MD |
1184 | rcu_read_lock(); |
1185 | ||
3bd1e081 | 1186 | switch (msg.cmd_type) { |
00e2e675 DG |
1187 | case LTTNG_CONSUMER_ADD_RELAYD_SOCKET: |
1188 | { | |
f50f23d9 | 1189 | /* Session daemon status message are handled in the following call. */ |
7735ef9e DG |
1190 | ret = consumer_add_relayd_socket(msg.u.relayd_sock.net_index, |
1191 | msg.u.relayd_sock.type, ctx, sock, consumer_sockpoll, | |
d3e2ba59 JD |
1192 | &msg.u.relayd_sock.sock, msg.u.relayd_sock.session_id, |
1193 | msg.u.relayd_sock.relayd_session_id); | |
00e2e675 DG |
1194 | goto end_nosignal; |
1195 | } | |
173af62f DG |
1196 | case LTTNG_CONSUMER_DESTROY_RELAYD: |
1197 | { | |
a6ba4fe1 | 1198 | uint64_t index = msg.u.destroy_relayd.net_seq_idx; |
173af62f DG |
1199 | struct consumer_relayd_sock_pair *relayd; |
1200 | ||
a6ba4fe1 | 1201 | DBG("UST consumer destroying relayd %" PRIu64, index); |
173af62f DG |
1202 | |
1203 | /* Get relayd reference if exists. */ | |
a6ba4fe1 | 1204 | relayd = consumer_find_relayd(index); |
173af62f | 1205 | if (relayd == NULL) { |
3448e266 | 1206 | DBG("Unable to find relayd %" PRIu64, index); |
e462382a | 1207 | ret_code = LTTCOMM_CONSUMERD_RELAYD_FAIL; |
173af62f DG |
1208 | } |
1209 | ||
a6ba4fe1 DG |
1210 | /* |
1211 | * Each relayd socket pair has a refcount of stream attached to it | |
1212 | * which tells if the relayd is still active or not depending on the | |
1213 | * refcount value. | |
1214 | * | |
1215 | * This will set the destroy flag of the relayd object and destroy it | |
1216 | * if the refcount reaches zero when called. | |
1217 | * | |
1218 | * The destroy can happen either here or when a stream fd hangs up. | |
1219 | */ | |
f50f23d9 DG |
1220 | if (relayd) { |
1221 | consumer_flag_relayd_for_destroy(relayd); | |
1222 | } | |
1223 | ||
d88aee68 | 1224 | goto end_msg_sessiond; |
173af62f | 1225 | } |
3bd1e081 MD |
1226 | case LTTNG_CONSUMER_UPDATE_STREAM: |
1227 | { | |
3f8e211f | 1228 | rcu_read_unlock(); |
7ad0a0cb | 1229 | return -ENOSYS; |
3bd1e081 | 1230 | } |
6d805429 | 1231 | case LTTNG_CONSUMER_DATA_PENDING: |
53632229 | 1232 | { |
3be74084 | 1233 | int ret, is_data_pending; |
6d805429 | 1234 | uint64_t id = msg.u.data_pending.session_id; |
ca22feea | 1235 | |
6d805429 | 1236 | DBG("UST consumer data pending command for id %" PRIu64, id); |
ca22feea | 1237 | |
3be74084 | 1238 | is_data_pending = consumer_data_pending(id); |
ca22feea DG |
1239 | |
1240 | /* Send back returned value to session daemon */ | |
3be74084 DG |
1241 | ret = lttcomm_send_unix_sock(sock, &is_data_pending, |
1242 | sizeof(is_data_pending)); | |
ca22feea | 1243 | if (ret < 0) { |
3be74084 | 1244 | DBG("Error when sending the data pending ret code: %d", ret); |
489f70e9 | 1245 | goto error_fatal; |
ca22feea | 1246 | } |
f50f23d9 DG |
1247 | |
1248 | /* | |
1249 | * No need to send back a status message since the data pending | |
1250 | * returned value is the response. | |
1251 | */ | |
ca22feea | 1252 | break; |
53632229 | 1253 | } |
ffe60014 DG |
1254 | case LTTNG_CONSUMER_ASK_CHANNEL_CREATION: |
1255 | { | |
1256 | int ret; | |
1257 | struct ustctl_consumer_channel_attr attr; | |
1258 | ||
1259 | /* Create a plain object and reserve a channel key. */ | |
1260 | channel = allocate_channel(msg.u.ask_channel.session_id, | |
1261 | msg.u.ask_channel.pathname, msg.u.ask_channel.name, | |
1262 | msg.u.ask_channel.uid, msg.u.ask_channel.gid, | |
1263 | msg.u.ask_channel.relayd_id, msg.u.ask_channel.key, | |
1624d5b7 JD |
1264 | (enum lttng_event_output) msg.u.ask_channel.output, |
1265 | msg.u.ask_channel.tracefile_size, | |
2bba9e53 | 1266 | msg.u.ask_channel.tracefile_count, |
1950109e | 1267 | msg.u.ask_channel.session_id_per_pid, |
ecc48a90 JD |
1268 | msg.u.ask_channel.monitor, |
1269 | msg.u.ask_channel.live_timer_interval); | |
ffe60014 DG |
1270 | if (!channel) { |
1271 | goto end_channel_error; | |
1272 | } | |
1273 | ||
567eb353 DG |
1274 | /* |
1275 | * Assign UST application UID to the channel. This value is ignored for | |
1276 | * per PID buffers. This is specific to UST thus setting this after the | |
1277 | * allocation. | |
1278 | */ | |
1279 | channel->ust_app_uid = msg.u.ask_channel.ust_app_uid; | |
1280 | ||
ffe60014 DG |
1281 | /* Build channel attributes from received message. */ |
1282 | attr.subbuf_size = msg.u.ask_channel.subbuf_size; | |
1283 | attr.num_subbuf = msg.u.ask_channel.num_subbuf; | |
1284 | attr.overwrite = msg.u.ask_channel.overwrite; | |
1285 | attr.switch_timer_interval = msg.u.ask_channel.switch_timer_interval; | |
1286 | attr.read_timer_interval = msg.u.ask_channel.read_timer_interval; | |
7972aab2 | 1287 | attr.chan_id = msg.u.ask_channel.chan_id; |
ffe60014 DG |
1288 | memcpy(attr.uuid, msg.u.ask_channel.uuid, sizeof(attr.uuid)); |
1289 | ||
0c759fc9 DG |
1290 | /* Match channel buffer type to the UST abi. */ |
1291 | switch (msg.u.ask_channel.output) { | |
1292 | case LTTNG_EVENT_MMAP: | |
1293 | default: | |
1294 | attr.output = LTTNG_UST_MMAP; | |
1295 | break; | |
1296 | } | |
1297 | ||
ffe60014 DG |
1298 | /* Translate and save channel type. */ |
1299 | switch (msg.u.ask_channel.type) { | |
1300 | case LTTNG_UST_CHAN_PER_CPU: | |
1301 | channel->type = CONSUMER_CHANNEL_TYPE_DATA; | |
1302 | attr.type = LTTNG_UST_CHAN_PER_CPU; | |
8633d6e3 MD |
1303 | /* |
1304 | * Set refcount to 1 for owner. Below, we will | |
1305 | * pass ownership to the | |
1306 | * consumer_thread_channel_poll() thread. | |
1307 | */ | |
1308 | channel->refcount = 1; | |
ffe60014 DG |
1309 | break; |
1310 | case LTTNG_UST_CHAN_METADATA: | |
1311 | channel->type = CONSUMER_CHANNEL_TYPE_METADATA; | |
1312 | attr.type = LTTNG_UST_CHAN_METADATA; | |
1313 | break; | |
1314 | default: | |
1315 | assert(0); | |
1316 | goto error_fatal; | |
1317 | }; | |
1318 | ||
9ce5646a MD |
1319 | health_code_update(); |
1320 | ||
ffe60014 DG |
1321 | ret = ask_channel(ctx, sock, channel, &attr); |
1322 | if (ret < 0) { | |
1323 | goto end_channel_error; | |
1324 | } | |
1325 | ||
fc643247 MD |
1326 | if (msg.u.ask_channel.type == LTTNG_UST_CHAN_METADATA) { |
1327 | ret = consumer_metadata_cache_allocate(channel); | |
1328 | if (ret < 0) { | |
1329 | ERR("Allocating metadata cache"); | |
1330 | goto end_channel_error; | |
1331 | } | |
1332 | consumer_timer_switch_start(channel, attr.switch_timer_interval); | |
1333 | attr.switch_timer_interval = 0; | |
94d49140 JD |
1334 | } else { |
1335 | consumer_timer_live_start(channel, | |
1336 | msg.u.ask_channel.live_timer_interval); | |
fc643247 MD |
1337 | } |
1338 | ||
9ce5646a MD |
1339 | health_code_update(); |
1340 | ||
ffe60014 DG |
1341 | /* |
1342 | * Add the channel to the internal state AFTER all streams were created | |
1343 | * and successfully sent to session daemon. This way, all streams must | |
1344 | * be ready before this channel is visible to the threads. | |
fc643247 MD |
1345 | * If add_channel succeeds, ownership of the channel is |
1346 | * passed to consumer_thread_channel_poll(). | |
ffe60014 DG |
1347 | */ |
1348 | ret = add_channel(channel, ctx); | |
1349 | if (ret < 0) { | |
ea88ca2a MD |
1350 | if (msg.u.ask_channel.type == LTTNG_UST_CHAN_METADATA) { |
1351 | if (channel->switch_timer_enabled == 1) { | |
1352 | consumer_timer_switch_stop(channel); | |
1353 | } | |
1354 | consumer_metadata_cache_destroy(channel); | |
1355 | } | |
d3e2ba59 JD |
1356 | if (channel->live_timer_enabled == 1) { |
1357 | consumer_timer_live_stop(channel); | |
1358 | } | |
ffe60014 DG |
1359 | goto end_channel_error; |
1360 | } | |
1361 | ||
9ce5646a MD |
1362 | health_code_update(); |
1363 | ||
ffe60014 DG |
1364 | /* |
1365 | * Channel and streams are now created. Inform the session daemon that | |
1366 | * everything went well and should wait to receive the channel and | |
1367 | * streams with ustctl API. | |
1368 | */ | |
1369 | ret = consumer_send_status_channel(sock, channel); | |
1370 | if (ret < 0) { | |
1371 | /* | |
489f70e9 | 1372 | * There is probably a problem on the socket. |
ffe60014 | 1373 | */ |
489f70e9 | 1374 | goto error_fatal; |
ffe60014 DG |
1375 | } |
1376 | ||
1377 | break; | |
1378 | } | |
1379 | case LTTNG_CONSUMER_GET_CHANNEL: | |
1380 | { | |
1381 | int ret, relayd_err = 0; | |
d88aee68 | 1382 | uint64_t key = msg.u.get_channel.key; |
ffe60014 | 1383 | struct lttng_consumer_channel *channel; |
ffe60014 DG |
1384 | |
1385 | channel = consumer_find_channel(key); | |
1386 | if (!channel) { | |
8fd623e0 | 1387 | ERR("UST consumer get channel key %" PRIu64 " not found", key); |
e462382a | 1388 | ret_code = LTTCOMM_CONSUMERD_CHAN_NOT_FOUND; |
ffe60014 DG |
1389 | goto end_msg_sessiond; |
1390 | } | |
1391 | ||
9ce5646a MD |
1392 | health_code_update(); |
1393 | ||
ffe60014 DG |
1394 | /* Send everything to sessiond. */ |
1395 | ret = send_sessiond_channel(sock, channel, ctx, &relayd_err); | |
1396 | if (ret < 0) { | |
1397 | if (relayd_err) { | |
1398 | /* | |
1399 | * We were unable to send to the relayd the stream so avoid | |
1400 | * sending back a fatal error to the thread since this is OK | |
f2a444f1 DG |
1401 | * and the consumer can continue its work. The above call |
1402 | * has sent the error status message to the sessiond. | |
ffe60014 | 1403 | */ |
f2a444f1 | 1404 | goto end_nosignal; |
ffe60014 DG |
1405 | } |
1406 | /* | |
1407 | * The communicaton was broken hence there is a bad state between | |
1408 | * the consumer and sessiond so stop everything. | |
1409 | */ | |
1410 | goto error_fatal; | |
1411 | } | |
1412 | ||
9ce5646a MD |
1413 | health_code_update(); |
1414 | ||
10a50311 JD |
1415 | /* |
1416 | * In no monitor mode, the streams ownership is kept inside the channel | |
1417 | * so don't send them to the data thread. | |
1418 | */ | |
1419 | if (!channel->monitor) { | |
1420 | goto end_msg_sessiond; | |
1421 | } | |
1422 | ||
d88aee68 DG |
1423 | ret = send_streams_to_thread(channel, ctx); |
1424 | if (ret < 0) { | |
1425 | /* | |
1426 | * If we are unable to send the stream to the thread, there is | |
1427 | * a big problem so just stop everything. | |
1428 | */ | |
1429 | goto error_fatal; | |
ffe60014 | 1430 | } |
ffe60014 DG |
1431 | /* List MUST be empty after or else it could be reused. */ |
1432 | assert(cds_list_empty(&channel->streams.head)); | |
d88aee68 DG |
1433 | goto end_msg_sessiond; |
1434 | } | |
1435 | case LTTNG_CONSUMER_DESTROY_CHANNEL: | |
1436 | { | |
1437 | uint64_t key = msg.u.destroy_channel.key; | |
d88aee68 | 1438 | |
a0cbdd2e MD |
1439 | /* |
1440 | * Only called if streams have not been sent to stream | |
1441 | * manager thread. However, channel has been sent to | |
1442 | * channel manager thread. | |
1443 | */ | |
1444 | notify_thread_del_channel(ctx, key); | |
d88aee68 | 1445 | goto end_msg_sessiond; |
ffe60014 | 1446 | } |
d88aee68 DG |
1447 | case LTTNG_CONSUMER_CLOSE_METADATA: |
1448 | { | |
1449 | int ret; | |
1450 | ||
1451 | ret = close_metadata(msg.u.close_metadata.key); | |
1452 | if (ret != 0) { | |
1453 | ret_code = ret; | |
1454 | } | |
1455 | ||
1456 | goto end_msg_sessiond; | |
1457 | } | |
7972aab2 DG |
1458 | case LTTNG_CONSUMER_FLUSH_CHANNEL: |
1459 | { | |
1460 | int ret; | |
1461 | ||
1462 | ret = flush_channel(msg.u.flush_channel.key); | |
1463 | if (ret != 0) { | |
1464 | ret_code = ret; | |
1465 | } | |
1466 | ||
1467 | goto end_msg_sessiond; | |
1468 | } | |
9c9abe17 MD |
1469 | case LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL: |
1470 | { | |
1471 | int ret; | |
1472 | ||
1473 | ret = clear_quiescent_channel( | |
1474 | msg.u.clear_quiescent_channel.key); | |
1475 | if (ret != 0) { | |
1476 | ret_code = ret; | |
1477 | } | |
1478 | ||
1479 | goto end_msg_sessiond; | |
1480 | } | |
d88aee68 | 1481 | case LTTNG_CONSUMER_PUSH_METADATA: |
ffe60014 DG |
1482 | { |
1483 | int ret; | |
d88aee68 | 1484 | uint64_t len = msg.u.push_metadata.len; |
d88aee68 | 1485 | uint64_t key = msg.u.push_metadata.key; |
331744e3 | 1486 | uint64_t offset = msg.u.push_metadata.target_offset; |
ffe60014 DG |
1487 | struct lttng_consumer_channel *channel; |
1488 | ||
8fd623e0 DG |
1489 | DBG("UST consumer push metadata key %" PRIu64 " of len %" PRIu64, key, |
1490 | len); | |
ffe60014 DG |
1491 | |
1492 | channel = consumer_find_channel(key); | |
1493 | if (!channel) { | |
000baf6a DG |
1494 | /* |
1495 | * This is possible if the metadata creation on the consumer side | |
1496 | * is in flight vis-a-vis a concurrent push metadata from the | |
1497 | * session daemon. Simply return that the channel failed and the | |
1498 | * session daemon will handle that message correctly considering | |
1499 | * that this race is acceptable thus the DBG() statement here. | |
1500 | */ | |
1501 | DBG("UST consumer push metadata %" PRIu64 " not found", key); | |
1502 | ret_code = LTTCOMM_CONSUMERD_CHANNEL_FAIL; | |
4a2eb0ca | 1503 | goto end_msg_sessiond; |
d88aee68 DG |
1504 | } |
1505 | ||
9ce5646a MD |
1506 | health_code_update(); |
1507 | ||
5cc6b3e4 MD |
1508 | if (!len) { |
1509 | /* | |
1510 | * There is nothing to receive. We have simply | |
1511 | * checked whether the channel can be found. | |
1512 | */ | |
1513 | ret_code = LTTCOMM_CONSUMERD_SUCCESS; | |
1514 | goto end_msg_sessiond; | |
1515 | } | |
1516 | ||
d88aee68 | 1517 | /* Tell session daemon we are ready to receive the metadata. */ |
0c759fc9 | 1518 | ret = consumer_send_status_msg(sock, LTTCOMM_CONSUMERD_SUCCESS); |
ffe60014 DG |
1519 | if (ret < 0) { |
1520 | /* Somehow, the session daemon is not responding anymore. */ | |
d88aee68 DG |
1521 | goto error_fatal; |
1522 | } | |
1523 | ||
9ce5646a MD |
1524 | health_code_update(); |
1525 | ||
d88aee68 | 1526 | /* Wait for more data. */ |
9ce5646a MD |
1527 | health_poll_entry(); |
1528 | ret = lttng_consumer_poll_socket(consumer_sockpoll); | |
1529 | health_poll_exit(); | |
84382d49 | 1530 | if (ret) { |
489f70e9 | 1531 | goto error_fatal; |
d88aee68 DG |
1532 | } |
1533 | ||
9ce5646a MD |
1534 | health_code_update(); |
1535 | ||
331744e3 | 1536 | ret = lttng_ustconsumer_recv_metadata(sock, key, offset, |
94d49140 | 1537 | len, channel, 0, 1); |
d88aee68 | 1538 | if (ret < 0) { |
331744e3 | 1539 | /* error receiving from sessiond */ |
489f70e9 | 1540 | goto error_fatal; |
331744e3 JD |
1541 | } else { |
1542 | ret_code = ret; | |
d88aee68 DG |
1543 | goto end_msg_sessiond; |
1544 | } | |
d88aee68 DG |
1545 | } |
1546 | case LTTNG_CONSUMER_SETUP_METADATA: | |
1547 | { | |
1548 | int ret; | |
1549 | ||
1550 | ret = setup_metadata(ctx, msg.u.setup_metadata.key); | |
1551 | if (ret) { | |
1552 | ret_code = ret; | |
1553 | } | |
1554 | goto end_msg_sessiond; | |
ffe60014 | 1555 | } |
6dc3064a DG |
1556 | case LTTNG_CONSUMER_SNAPSHOT_CHANNEL: |
1557 | { | |
10a50311 JD |
1558 | if (msg.u.snapshot_channel.metadata) { |
1559 | ret = snapshot_metadata(msg.u.snapshot_channel.key, | |
1560 | msg.u.snapshot_channel.pathname, | |
1561 | msg.u.snapshot_channel.relayd_id, | |
1562 | ctx); | |
1563 | if (ret < 0) { | |
1564 | ERR("Snapshot metadata failed"); | |
e462382a | 1565 | ret_code = LTTCOMM_CONSUMERD_ERROR_METADATA; |
10a50311 JD |
1566 | } |
1567 | } else { | |
1568 | ret = snapshot_channel(msg.u.snapshot_channel.key, | |
1569 | msg.u.snapshot_channel.pathname, | |
1570 | msg.u.snapshot_channel.relayd_id, | |
135347bd | 1571 | msg.u.snapshot_channel.nb_packets_per_stream, |
10a50311 JD |
1572 | ctx); |
1573 | if (ret < 0) { | |
1574 | ERR("Snapshot channel failed"); | |
e462382a | 1575 | ret_code = LTTCOMM_CONSUMERD_CHANNEL_FAIL; |
10a50311 JD |
1576 | } |
1577 | } | |
1578 | ||
9ce5646a | 1579 | health_code_update(); |
6dc3064a DG |
1580 | ret = consumer_send_status_msg(sock, ret_code); |
1581 | if (ret < 0) { | |
1582 | /* Somehow, the session daemon is not responding anymore. */ | |
1583 | goto end_nosignal; | |
1584 | } | |
9ce5646a | 1585 | health_code_update(); |
6dc3064a DG |
1586 | break; |
1587 | } | |
3bd1e081 MD |
1588 | default: |
1589 | break; | |
1590 | } | |
3f8e211f | 1591 | |
3bd1e081 | 1592 | end_nosignal: |
b0b335c8 | 1593 | rcu_read_unlock(); |
4cbc1a04 | 1594 | |
9ce5646a MD |
1595 | health_code_update(); |
1596 | ||
4cbc1a04 DG |
1597 | /* |
1598 | * Return 1 to indicate success since the 0 value can be a socket | |
1599 | * shutdown during the recv() or send() call. | |
1600 | */ | |
1601 | return 1; | |
ffe60014 DG |
1602 | |
1603 | end_msg_sessiond: | |
1604 | /* | |
1605 | * The returned value here is not useful since either way we'll return 1 to | |
1606 | * the caller because the session daemon socket management is done | |
1607 | * elsewhere. Returning a negative code or 0 will shutdown the consumer. | |
1608 | */ | |
489f70e9 MD |
1609 | ret = consumer_send_status_msg(sock, ret_code); |
1610 | if (ret < 0) { | |
1611 | goto error_fatal; | |
1612 | } | |
ffe60014 | 1613 | rcu_read_unlock(); |
9ce5646a MD |
1614 | |
1615 | health_code_update(); | |
1616 | ||
ffe60014 DG |
1617 | return 1; |
1618 | end_channel_error: | |
1619 | if (channel) { | |
1620 | /* | |
1621 | * Free channel here since no one has a reference to it. We don't | |
1622 | * free after that because a stream can store this pointer. | |
1623 | */ | |
1624 | destroy_channel(channel); | |
1625 | } | |
1626 | /* We have to send a status channel message indicating an error. */ | |
1627 | ret = consumer_send_status_channel(sock, NULL); | |
1628 | if (ret < 0) { | |
1629 | /* Stop everything if session daemon can not be notified. */ | |
1630 | goto error_fatal; | |
1631 | } | |
1632 | rcu_read_unlock(); | |
9ce5646a MD |
1633 | |
1634 | health_code_update(); | |
1635 | ||
ffe60014 DG |
1636 | return 1; |
1637 | error_fatal: | |
1638 | rcu_read_unlock(); | |
1639 | /* This will issue a consumer stop. */ | |
1640 | return -1; | |
3bd1e081 MD |
1641 | } |
1642 | ||
ffe60014 DG |
1643 | /* |
1644 | * Wrapper over the mmap() read offset from ust-ctl library. Since this can be | |
1645 | * compiled out, we isolate it in this library. | |
1646 | */ | |
1647 | int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream, | |
1648 | unsigned long *off) | |
3bd1e081 | 1649 | { |
ffe60014 DG |
1650 | assert(stream); |
1651 | assert(stream->ustream); | |
b5c5fc29 | 1652 | |
ffe60014 | 1653 | return ustctl_get_mmap_read_offset(stream->ustream, off); |
3bd1e081 MD |
1654 | } |
1655 | ||
ffe60014 DG |
1656 | /* |
1657 | * Wrapper over the mmap() read offset from ust-ctl library. Since this can be | |
1658 | * compiled out, we isolate it in this library. | |
1659 | */ | |
1660 | void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream *stream) | |
d056b477 | 1661 | { |
ffe60014 DG |
1662 | assert(stream); |
1663 | assert(stream->ustream); | |
1664 | ||
1665 | return ustctl_get_mmap_base(stream->ustream); | |
d056b477 MD |
1666 | } |
1667 | ||
ffe60014 DG |
1668 | /* |
1669 | * Take a snapshot for a specific fd | |
1670 | * | |
1671 | * Returns 0 on success, < 0 on error | |
1672 | */ | |
1673 | int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream) | |
3bd1e081 | 1674 | { |
ffe60014 DG |
1675 | assert(stream); |
1676 | assert(stream->ustream); | |
1677 | ||
1678 | return ustctl_snapshot(stream->ustream); | |
3bd1e081 MD |
1679 | } |
1680 | ||
ffe60014 DG |
1681 | /* |
1682 | * Get the produced position | |
1683 | * | |
1684 | * Returns 0 on success, < 0 on error | |
1685 | */ | |
1686 | int lttng_ustconsumer_get_produced_snapshot( | |
1687 | struct lttng_consumer_stream *stream, unsigned long *pos) | |
3bd1e081 | 1688 | { |
ffe60014 DG |
1689 | assert(stream); |
1690 | assert(stream->ustream); | |
1691 | assert(pos); | |
7a57cf92 | 1692 | |
ffe60014 DG |
1693 | return ustctl_snapshot_get_produced(stream->ustream, pos); |
1694 | } | |
7a57cf92 | 1695 | |
10a50311 JD |
1696 | /* |
1697 | * Get the consumed position | |
1698 | * | |
1699 | * Returns 0 on success, < 0 on error | |
1700 | */ | |
1701 | int lttng_ustconsumer_get_consumed_snapshot( | |
1702 | struct lttng_consumer_stream *stream, unsigned long *pos) | |
1703 | { | |
1704 | assert(stream); | |
1705 | assert(stream->ustream); | |
1706 | assert(pos); | |
1707 | ||
1708 | return ustctl_snapshot_get_consumed(stream->ustream, pos); | |
1709 | } | |
1710 | ||
84a182ce DG |
1711 | void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream, |
1712 | int producer) | |
1713 | { | |
1714 | assert(stream); | |
1715 | assert(stream->ustream); | |
1716 | ||
1717 | ustctl_flush_buffer(stream->ustream, producer); | |
1718 | } | |
1719 | ||
1720 | int lttng_ustconsumer_get_current_timestamp( | |
1721 | struct lttng_consumer_stream *stream, uint64_t *ts) | |
1722 | { | |
1723 | assert(stream); | |
1724 | assert(stream->ustream); | |
1725 | assert(ts); | |
1726 | ||
1727 | return ustctl_get_current_timestamp(stream->ustream, ts); | |
1728 | } | |
1729 | ||
ffe60014 | 1730 | /* |
9c9abe17 | 1731 | * Called when the stream signals the consumer that it has hung up. |
ffe60014 DG |
1732 | */ |
1733 | void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream) | |
1734 | { | |
1735 | assert(stream); | |
1736 | assert(stream->ustream); | |
2c1dd183 | 1737 | |
9c9abe17 MD |
1738 | pthread_mutex_lock(&stream->lock); |
1739 | if (!stream->quiescent) { | |
1740 | ustctl_flush_buffer(stream->ustream, 0); | |
1741 | stream->quiescent = true; | |
1742 | } | |
1743 | pthread_mutex_unlock(&stream->lock); | |
ffe60014 DG |
1744 | stream->hangup_flush_done = 1; |
1745 | } | |
ee77a7b0 | 1746 | |
ffe60014 DG |
1747 | void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan) |
1748 | { | |
1749 | assert(chan); | |
1750 | assert(chan->uchan); | |
e316aad5 | 1751 | |
ea88ca2a MD |
1752 | if (chan->switch_timer_enabled == 1) { |
1753 | consumer_timer_switch_stop(chan); | |
1754 | } | |
4534c65b MD |
1755 | } |
1756 | ||
1757 | void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan) | |
1758 | { | |
1759 | assert(chan); | |
1760 | assert(chan->uchan); | |
1761 | ||
ea88ca2a | 1762 | consumer_metadata_cache_destroy(chan); |
ffe60014 | 1763 | ustctl_destroy_channel(chan->uchan); |
3bd1e081 MD |
1764 | } |
1765 | ||
1766 | void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream) | |
1767 | { | |
ffe60014 DG |
1768 | assert(stream); |
1769 | assert(stream->ustream); | |
d41f73b7 | 1770 | |
ea88ca2a MD |
1771 | if (stream->chan->switch_timer_enabled == 1) { |
1772 | consumer_timer_switch_stop(stream->chan); | |
1773 | } | |
ffe60014 DG |
1774 | ustctl_destroy_stream(stream->ustream); |
1775 | } | |
d41f73b7 | 1776 | |
6d574024 DG |
1777 | int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream *stream) |
1778 | { | |
1779 | assert(stream); | |
1780 | assert(stream->ustream); | |
1781 | ||
1782 | return ustctl_stream_get_wakeup_fd(stream->ustream); | |
1783 | } | |
1784 | ||
1785 | int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream *stream) | |
1786 | { | |
1787 | assert(stream); | |
1788 | assert(stream->ustream); | |
1789 | ||
1790 | return ustctl_stream_close_wakeup_fd(stream->ustream); | |
1791 | } | |
1792 | ||
309167d2 JD |
1793 | /* |
1794 | * Populate index values of a UST stream. Values are set in big endian order. | |
1795 | * | |
1796 | * Return 0 on success or else a negative value. | |
1797 | */ | |
50adc264 | 1798 | static int get_index_values(struct ctf_packet_index *index, |
309167d2 JD |
1799 | struct ustctl_consumer_stream *ustream) |
1800 | { | |
1801 | int ret; | |
1802 | ||
1803 | ret = ustctl_get_timestamp_begin(ustream, &index->timestamp_begin); | |
1804 | if (ret < 0) { | |
1805 | PERROR("ustctl_get_timestamp_begin"); | |
1806 | goto error; | |
1807 | } | |
1808 | index->timestamp_begin = htobe64(index->timestamp_begin); | |
1809 | ||
1810 | ret = ustctl_get_timestamp_end(ustream, &index->timestamp_end); | |
1811 | if (ret < 0) { | |
1812 | PERROR("ustctl_get_timestamp_end"); | |
1813 | goto error; | |
1814 | } | |
1815 | index->timestamp_end = htobe64(index->timestamp_end); | |
1816 | ||
1817 | ret = ustctl_get_events_discarded(ustream, &index->events_discarded); | |
1818 | if (ret < 0) { | |
1819 | PERROR("ustctl_get_events_discarded"); | |
1820 | goto error; | |
1821 | } | |
1822 | index->events_discarded = htobe64(index->events_discarded); | |
1823 | ||
1824 | ret = ustctl_get_content_size(ustream, &index->content_size); | |
1825 | if (ret < 0) { | |
1826 | PERROR("ustctl_get_content_size"); | |
1827 | goto error; | |
1828 | } | |
1829 | index->content_size = htobe64(index->content_size); | |
1830 | ||
1831 | ret = ustctl_get_packet_size(ustream, &index->packet_size); | |
1832 | if (ret < 0) { | |
1833 | PERROR("ustctl_get_packet_size"); | |
1834 | goto error; | |
1835 | } | |
1836 | index->packet_size = htobe64(index->packet_size); | |
1837 | ||
1838 | ret = ustctl_get_stream_id(ustream, &index->stream_id); | |
1839 | if (ret < 0) { | |
1840 | PERROR("ustctl_get_stream_id"); | |
1841 | goto error; | |
1842 | } | |
1843 | index->stream_id = htobe64(index->stream_id); | |
1844 | ||
1845 | error: | |
1846 | return ret; | |
1847 | } | |
1848 | ||
94d49140 JD |
1849 | /* |
1850 | * Write up to one packet from the metadata cache to the channel. | |
1851 | * | |
1852 | * Returns the number of bytes pushed in the cache, or a negative value | |
1853 | * on error. | |
1854 | */ | |
1855 | static | |
1856 | int commit_one_metadata_packet(struct lttng_consumer_stream *stream) | |
1857 | { | |
1858 | ssize_t write_len; | |
1859 | int ret; | |
1860 | ||
1861 | pthread_mutex_lock(&stream->chan->metadata_cache->lock); | |
5cc6b3e4 | 1862 | if (stream->chan->metadata_cache->max_offset |
94d49140 JD |
1863 | == stream->ust_metadata_pushed) { |
1864 | ret = 0; | |
1865 | goto end; | |
1866 | } | |
1867 | ||
1868 | write_len = ustctl_write_one_packet_to_channel(stream->chan->uchan, | |
1869 | &stream->chan->metadata_cache->data[stream->ust_metadata_pushed], | |
5cc6b3e4 | 1870 | stream->chan->metadata_cache->max_offset |
94d49140 JD |
1871 | - stream->ust_metadata_pushed); |
1872 | assert(write_len != 0); | |
1873 | if (write_len < 0) { | |
1874 | ERR("Writing one metadata packet"); | |
1875 | ret = -1; | |
1876 | goto end; | |
1877 | } | |
1878 | stream->ust_metadata_pushed += write_len; | |
1879 | ||
5cc6b3e4 | 1880 | assert(stream->chan->metadata_cache->max_offset >= |
94d49140 JD |
1881 | stream->ust_metadata_pushed); |
1882 | ret = write_len; | |
1883 | ||
1884 | end: | |
1885 | pthread_mutex_unlock(&stream->chan->metadata_cache->lock); | |
1886 | return ret; | |
1887 | } | |
1888 | ||
309167d2 | 1889 | |
94d49140 JD |
1890 | /* |
1891 | * Sync metadata meaning request them to the session daemon and snapshot to the | |
1892 | * metadata thread can consumer them. | |
1893 | * | |
5cc6b3e4 MD |
1894 | * Metadata stream lock is held here, but we need to release it when |
1895 | * interacting with sessiond, else we cause a deadlock with live | |
1896 | * awaiting on metadata to be pushed out. | |
94d49140 JD |
1897 | * |
1898 | * Return 0 if new metadatda is available, EAGAIN if the metadata stream | |
1899 | * is empty or a negative value on error. | |
1900 | */ | |
1901 | int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx, | |
1902 | struct lttng_consumer_stream *metadata) | |
1903 | { | |
1904 | int ret; | |
1905 | int retry = 0; | |
1906 | ||
1907 | assert(ctx); | |
1908 | assert(metadata); | |
1909 | ||
5cc6b3e4 | 1910 | pthread_mutex_unlock(&metadata->lock); |
94d49140 JD |
1911 | /* |
1912 | * Request metadata from the sessiond, but don't wait for the flush | |
1913 | * because we locked the metadata thread. | |
1914 | */ | |
1915 | ret = lttng_ustconsumer_request_metadata(ctx, metadata->chan, 0, 0); | |
1916 | if (ret < 0) { | |
1917 | goto end; | |
1918 | } | |
5cc6b3e4 | 1919 | pthread_mutex_lock(&metadata->lock); |
94d49140 JD |
1920 | |
1921 | ret = commit_one_metadata_packet(metadata); | |
1922 | if (ret <= 0) { | |
1923 | goto end; | |
1924 | } else if (ret > 0) { | |
1925 | retry = 1; | |
1926 | } | |
1927 | ||
1928 | ustctl_flush_buffer(metadata->ustream, 1); | |
1929 | ret = ustctl_snapshot(metadata->ustream); | |
1930 | if (ret < 0) { | |
1931 | if (errno != EAGAIN) { | |
1932 | ERR("Sync metadata, taking UST snapshot"); | |
1933 | goto end; | |
1934 | } | |
1935 | DBG("No new metadata when syncing them."); | |
1936 | /* No new metadata, exit. */ | |
1937 | ret = ENODATA; | |
1938 | goto end; | |
1939 | } | |
1940 | ||
1941 | /* | |
1942 | * After this flush, we still need to extract metadata. | |
1943 | */ | |
1944 | if (retry) { | |
1945 | ret = EAGAIN; | |
1946 | } | |
1947 | ||
1948 | end: | |
1949 | return ret; | |
1950 | } | |
1951 | ||
02b3d176 DG |
1952 | /* |
1953 | * Return 0 on success else a negative value. | |
1954 | */ | |
1955 | static int notify_if_more_data(struct lttng_consumer_stream *stream, | |
1956 | struct lttng_consumer_local_data *ctx) | |
1957 | { | |
1958 | int ret; | |
1959 | struct ustctl_consumer_stream *ustream; | |
1960 | ||
1961 | assert(stream); | |
1962 | assert(ctx); | |
1963 | ||
1964 | ustream = stream->ustream; | |
1965 | ||
1966 | /* | |
1967 | * First, we are going to check if there is a new subbuffer available | |
1968 | * before reading the stream wait_fd. | |
1969 | */ | |
1970 | /* Get the next subbuffer */ | |
1971 | ret = ustctl_get_next_subbuf(ustream); | |
1972 | if (ret) { | |
1973 | /* No more data found, flag the stream. */ | |
1974 | stream->has_data = 0; | |
1975 | ret = 0; | |
1976 | goto end; | |
1977 | } | |
1978 | ||
4dbc8d72 | 1979 | ret = ustctl_put_subbuf(ustream); |
02b3d176 DG |
1980 | assert(!ret); |
1981 | ||
1982 | /* This stream still has data. Flag it and wake up the data thread. */ | |
1983 | stream->has_data = 1; | |
1984 | ||
1985 | if (stream->monitor && !stream->hangup_flush_done && !ctx->has_wakeup) { | |
1986 | ssize_t writelen; | |
1987 | ||
1988 | writelen = lttng_pipe_write(ctx->consumer_wakeup_pipe, "!", 1); | |
1989 | if (writelen < 0 && errno != EAGAIN && errno != EWOULDBLOCK) { | |
1990 | ret = writelen; | |
1991 | goto end; | |
1992 | } | |
1993 | ||
1994 | /* The wake up pipe has been notified. */ | |
1995 | ctx->has_wakeup = 1; | |
1996 | } | |
1997 | ret = 0; | |
1998 | ||
1999 | end: | |
2000 | return ret; | |
2001 | } | |
2002 | ||
94d49140 JD |
2003 | /* |
2004 | * Read subbuffer from the given stream. | |
2005 | * | |
2006 | * Stream lock MUST be acquired. | |
2007 | * | |
2008 | * Return 0 on success else a negative value. | |
2009 | */ | |
d41f73b7 MD |
2010 | int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream, |
2011 | struct lttng_consumer_local_data *ctx) | |
2012 | { | |
1d4dfdef | 2013 | unsigned long len, subbuf_size, padding; |
1c20f0e2 | 2014 | int err, write_index = 1; |
d41f73b7 | 2015 | long ret = 0; |
ffe60014 | 2016 | struct ustctl_consumer_stream *ustream; |
50adc264 | 2017 | struct ctf_packet_index index; |
ffe60014 DG |
2018 | |
2019 | assert(stream); | |
2020 | assert(stream->ustream); | |
2021 | assert(ctx); | |
d41f73b7 | 2022 | |
3eb914c0 | 2023 | DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream->wait_fd, |
ffe60014 DG |
2024 | stream->name); |
2025 | ||
2026 | /* Ease our life for what's next. */ | |
2027 | ustream = stream->ustream; | |
d41f73b7 | 2028 | |
6cd525e8 | 2029 | /* |
02b3d176 DG |
2030 | * We can consume the 1 byte written into the wait_fd by UST. Don't trigger |
2031 | * error if we cannot read this one byte (read returns 0), or if the error | |
2032 | * is EAGAIN or EWOULDBLOCK. | |
2033 | * | |
2034 | * This is only done when the stream is monitored by a thread, before the | |
2035 | * flush is done after a hangup and if the stream is not flagged with data | |
2036 | * since there might be nothing to consume in the wait fd but still have | |
2037 | * data available flagged by the consumer wake up pipe. | |
6cd525e8 | 2038 | */ |
02b3d176 DG |
2039 | if (stream->monitor && !stream->hangup_flush_done && !stream->has_data) { |
2040 | char dummy; | |
c617c0c6 MD |
2041 | ssize_t readlen; |
2042 | ||
6cd525e8 MD |
2043 | readlen = lttng_read(stream->wait_fd, &dummy, 1); |
2044 | if (readlen < 0 && errno != EAGAIN && errno != EWOULDBLOCK) { | |
effcf122 MD |
2045 | ret = readlen; |
2046 | goto end; | |
2047 | } | |
d41f73b7 MD |
2048 | } |
2049 | ||
04ef1097 | 2050 | retry: |
d41f73b7 | 2051 | /* Get the next subbuffer */ |
ffe60014 | 2052 | err = ustctl_get_next_subbuf(ustream); |
d41f73b7 | 2053 | if (err != 0) { |
04ef1097 MD |
2054 | /* |
2055 | * Populate metadata info if the existing info has | |
2056 | * already been read. | |
2057 | */ | |
2058 | if (stream->metadata_flag) { | |
94d49140 JD |
2059 | ret = commit_one_metadata_packet(stream); |
2060 | if (ret <= 0) { | |
04ef1097 MD |
2061 | goto end; |
2062 | } | |
04ef1097 MD |
2063 | ustctl_flush_buffer(stream->ustream, 1); |
2064 | goto retry; | |
2065 | } | |
2066 | ||
1d4dfdef | 2067 | ret = err; /* ustctl_get_next_subbuf returns negative, caller expect positive. */ |
d41f73b7 MD |
2068 | /* |
2069 | * This is a debug message even for single-threaded consumer, | |
2070 | * because poll() have more relaxed criterions than get subbuf, | |
2071 | * so get_subbuf may fail for short race windows where poll() | |
2072 | * would issue wakeups. | |
2073 | */ | |
2074 | DBG("Reserving sub buffer failed (everything is normal, " | |
ffe60014 | 2075 | "it is due to concurrency) [ret: %d]", err); |
d41f73b7 MD |
2076 | goto end; |
2077 | } | |
ffe60014 | 2078 | assert(stream->chan->output == CONSUMER_CHANNEL_MMAP); |
309167d2 | 2079 | |
1c20f0e2 | 2080 | if (!stream->metadata_flag) { |
309167d2 JD |
2081 | index.offset = htobe64(stream->out_fd_offset); |
2082 | ret = get_index_values(&index, ustream); | |
2083 | if (ret < 0) { | |
2084 | goto end; | |
2085 | } | |
1c20f0e2 JD |
2086 | } else { |
2087 | write_index = 0; | |
309167d2 JD |
2088 | } |
2089 | ||
1d4dfdef | 2090 | /* Get the full padded subbuffer size */ |
ffe60014 | 2091 | err = ustctl_get_padded_subbuf_size(ustream, &len); |
effcf122 | 2092 | assert(err == 0); |
1d4dfdef DG |
2093 | |
2094 | /* Get subbuffer data size (without padding) */ | |
ffe60014 | 2095 | err = ustctl_get_subbuf_size(ustream, &subbuf_size); |
1d4dfdef DG |
2096 | assert(err == 0); |
2097 | ||
2098 | /* Make sure we don't get a subbuffer size bigger than the padded */ | |
2099 | assert(len >= subbuf_size); | |
2100 | ||
2101 | padding = len - subbuf_size; | |
d41f73b7 | 2102 | /* write the subbuffer to the tracefile */ |
309167d2 | 2103 | ret = lttng_consumer_on_read_subbuffer_mmap(ctx, stream, subbuf_size, padding, &index); |
91dfef6e DG |
2104 | /* |
2105 | * The mmap operation should write subbuf_size amount of data when network | |
2106 | * streaming or the full padding (len) size when we are _not_ streaming. | |
2107 | */ | |
d88aee68 DG |
2108 | if ((ret != subbuf_size && stream->net_seq_idx != (uint64_t) -1ULL) || |
2109 | (ret != len && stream->net_seq_idx == (uint64_t) -1ULL)) { | |
d41f73b7 | 2110 | /* |
91dfef6e | 2111 | * Display the error but continue processing to try to release the |
c5c45efa DG |
2112 | * subbuffer. This is a DBG statement since any unexpected kill or |
2113 | * signal, the application gets unregistered, relayd gets closed or | |
2114 | * anything that affects the buffer lifetime will trigger this error. | |
2115 | * So, for the sake of the user, don't print this error since it can | |
2116 | * happen and it is OK with the code flow. | |
d41f73b7 | 2117 | */ |
c5c45efa | 2118 | DBG("Error writing to tracefile " |
8fd623e0 | 2119 | "(ret: %ld != len: %lu != subbuf_size: %lu)", |
91dfef6e | 2120 | ret, len, subbuf_size); |
309167d2 | 2121 | write_index = 0; |
d41f73b7 | 2122 | } |
ffe60014 | 2123 | err = ustctl_put_next_subbuf(ustream); |
effcf122 | 2124 | assert(err == 0); |
331744e3 | 2125 | |
02b3d176 DG |
2126 | /* |
2127 | * This will consumer the byte on the wait_fd if and only if there is not | |
2128 | * next subbuffer to be acquired. | |
2129 | */ | |
2130 | if (!stream->metadata_flag) { | |
2131 | ret = notify_if_more_data(stream, ctx); | |
2132 | if (ret < 0) { | |
2133 | goto end; | |
2134 | } | |
2135 | } | |
2136 | ||
309167d2 | 2137 | /* Write index if needed. */ |
1c20f0e2 JD |
2138 | if (!write_index) { |
2139 | goto end; | |
2140 | } | |
2141 | ||
94d49140 JD |
2142 | if (stream->chan->live_timer_interval && !stream->metadata_flag) { |
2143 | /* | |
2144 | * In live, block until all the metadata is sent. | |
2145 | */ | |
5cc6b3e4 MD |
2146 | pthread_mutex_lock(&stream->metadata_timer_lock); |
2147 | assert(!stream->missed_metadata_flush); | |
2148 | stream->waiting_on_metadata = true; | |
2149 | pthread_mutex_unlock(&stream->metadata_timer_lock); | |
2150 | ||
94d49140 | 2151 | err = consumer_stream_sync_metadata(ctx, stream->session_id); |
5cc6b3e4 MD |
2152 | |
2153 | pthread_mutex_lock(&stream->metadata_timer_lock); | |
2154 | stream->waiting_on_metadata = false; | |
2155 | if (stream->missed_metadata_flush) { | |
2156 | stream->missed_metadata_flush = false; | |
2157 | pthread_mutex_unlock(&stream->metadata_timer_lock); | |
2158 | (void) consumer_flush_ust_index(stream); | |
2159 | } else { | |
2160 | pthread_mutex_unlock(&stream->metadata_timer_lock); | |
2161 | } | |
2162 | ||
94d49140 JD |
2163 | if (err < 0) { |
2164 | goto end; | |
2165 | } | |
2166 | } | |
2167 | ||
1c20f0e2 JD |
2168 | assert(!stream->metadata_flag); |
2169 | err = consumer_stream_write_index(stream, &index); | |
2170 | if (err < 0) { | |
2171 | goto end; | |
309167d2 JD |
2172 | } |
2173 | ||
d41f73b7 MD |
2174 | end: |
2175 | return ret; | |
2176 | } | |
2177 | ||
ffe60014 DG |
2178 | /* |
2179 | * Called when a stream is created. | |
fe4477ee JD |
2180 | * |
2181 | * Return 0 on success or else a negative value. | |
ffe60014 | 2182 | */ |
d41f73b7 MD |
2183 | int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream) |
2184 | { | |
fe4477ee JD |
2185 | int ret; |
2186 | ||
10a50311 JD |
2187 | assert(stream); |
2188 | ||
fe4477ee | 2189 | /* Don't create anything if this is set for streaming. */ |
10a50311 | 2190 | if (stream->net_seq_idx == (uint64_t) -1ULL && stream->chan->monitor) { |
fe4477ee JD |
2191 | ret = utils_create_stream_file(stream->chan->pathname, stream->name, |
2192 | stream->chan->tracefile_size, stream->tracefile_count_current, | |
309167d2 | 2193 | stream->uid, stream->gid, NULL); |
fe4477ee JD |
2194 | if (ret < 0) { |
2195 | goto error; | |
2196 | } | |
2197 | stream->out_fd = ret; | |
2198 | stream->tracefile_size_current = 0; | |
309167d2 JD |
2199 | |
2200 | if (!stream->metadata_flag) { | |
2201 | ret = index_create_file(stream->chan->pathname, | |
2202 | stream->name, stream->uid, stream->gid, | |
2203 | stream->chan->tracefile_size, | |
2204 | stream->tracefile_count_current); | |
2205 | if (ret < 0) { | |
2206 | goto error; | |
2207 | } | |
2208 | stream->index_fd = ret; | |
2209 | } | |
fe4477ee JD |
2210 | } |
2211 | ret = 0; | |
2212 | ||
2213 | error: | |
2214 | return ret; | |
d41f73b7 | 2215 | } |
ca22feea DG |
2216 | |
2217 | /* | |
2218 | * Check if data is still being extracted from the buffers for a specific | |
4e9a4686 DG |
2219 | * stream. Consumer data lock MUST be acquired before calling this function |
2220 | * and the stream lock. | |
ca22feea | 2221 | * |
6d805429 | 2222 | * Return 1 if the traced data are still getting read else 0 meaning that the |
ca22feea DG |
2223 | * data is available for trace viewer reading. |
2224 | */ | |
6d805429 | 2225 | int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream) |
ca22feea DG |
2226 | { |
2227 | int ret; | |
2228 | ||
2229 | assert(stream); | |
ffe60014 | 2230 | assert(stream->ustream); |
ca22feea | 2231 | |
6d805429 | 2232 | DBG("UST consumer checking data pending"); |
c8f59ee5 | 2233 | |
ca6b395f MD |
2234 | if (stream->endpoint_status != CONSUMER_ENDPOINT_ACTIVE) { |
2235 | ret = 0; | |
2236 | goto end; | |
2237 | } | |
2238 | ||
04ef1097 | 2239 | if (stream->chan->type == CONSUMER_CHANNEL_TYPE_METADATA) { |
e6ee4eab DG |
2240 | uint64_t contiguous, pushed; |
2241 | ||
2242 | /* Ease our life a bit. */ | |
5cc6b3e4 | 2243 | contiguous = stream->chan->metadata_cache->max_offset; |
e6ee4eab DG |
2244 | pushed = stream->ust_metadata_pushed; |
2245 | ||
04ef1097 MD |
2246 | /* |
2247 | * We can simply check whether all contiguously available data | |
2248 | * has been pushed to the ring buffer, since the push operation | |
2249 | * is performed within get_next_subbuf(), and because both | |
2250 | * get_next_subbuf() and put_next_subbuf() are issued atomically | |
2251 | * thanks to the stream lock within | |
2252 | * lttng_ustconsumer_read_subbuffer(). This basically means that | |
2253 | * whetnever ust_metadata_pushed is incremented, the associated | |
2254 | * metadata has been consumed from the metadata stream. | |
2255 | */ | |
2256 | DBG("UST consumer metadata pending check: contiguous %" PRIu64 " vs pushed %" PRIu64, | |
e6ee4eab | 2257 | contiguous, pushed); |
aa01b94c | 2258 | assert(((int64_t) (contiguous - pushed)) >= 0); |
e6ee4eab | 2259 | if ((contiguous != pushed) || |
6acdf328 | 2260 | (((int64_t) contiguous - pushed) > 0 || contiguous == 0)) { |
04ef1097 MD |
2261 | ret = 1; /* Data is pending */ |
2262 | goto end; | |
2263 | } | |
2264 | } else { | |
2265 | ret = ustctl_get_next_subbuf(stream->ustream); | |
2266 | if (ret == 0) { | |
2267 | /* | |
2268 | * There is still data so let's put back this | |
2269 | * subbuffer. | |
2270 | */ | |
2271 | ret = ustctl_put_subbuf(stream->ustream); | |
2272 | assert(ret == 0); | |
2273 | ret = 1; /* Data is pending */ | |
2274 | goto end; | |
2275 | } | |
ca22feea DG |
2276 | } |
2277 | ||
6d805429 DG |
2278 | /* Data is NOT pending so ready to be read. */ |
2279 | ret = 0; | |
ca22feea | 2280 | |
6efae65e DG |
2281 | end: |
2282 | return ret; | |
ca22feea | 2283 | } |
d88aee68 | 2284 | |
6d574024 DG |
2285 | /* |
2286 | * Stop a given metadata channel timer if enabled and close the wait fd which | |
2287 | * is the poll pipe of the metadata stream. | |
2288 | * | |
2289 | * This MUST be called with the metadata channel acquired. | |
2290 | */ | |
2291 | void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata) | |
2292 | { | |
2293 | int ret; | |
2294 | ||
2295 | assert(metadata); | |
2296 | assert(metadata->type == CONSUMER_CHANNEL_TYPE_METADATA); | |
2297 | ||
2298 | DBG("Closing metadata channel key %" PRIu64, metadata->key); | |
2299 | ||
2300 | if (metadata->switch_timer_enabled == 1) { | |
2301 | consumer_timer_switch_stop(metadata); | |
2302 | } | |
2303 | ||
2304 | if (!metadata->metadata_stream) { | |
2305 | goto end; | |
2306 | } | |
2307 | ||
2308 | /* | |
2309 | * Closing write side so the thread monitoring the stream wakes up if any | |
2310 | * and clean the metadata stream. | |
2311 | */ | |
2312 | if (metadata->metadata_stream->ust_metadata_poll_pipe[1] >= 0) { | |
2313 | ret = close(metadata->metadata_stream->ust_metadata_poll_pipe[1]); | |
2314 | if (ret < 0) { | |
2315 | PERROR("closing metadata pipe write side"); | |
2316 | } | |
2317 | metadata->metadata_stream->ust_metadata_poll_pipe[1] = -1; | |
2318 | } | |
2319 | ||
2320 | end: | |
2321 | return; | |
2322 | } | |
2323 | ||
d88aee68 DG |
2324 | /* |
2325 | * Close every metadata stream wait fd of the metadata hash table. This | |
2326 | * function MUST be used very carefully so not to run into a race between the | |
2327 | * metadata thread handling streams and this function closing their wait fd. | |
2328 | * | |
2329 | * For UST, this is used when the session daemon hangs up. Its the metadata | |
2330 | * producer so calling this is safe because we are assured that no state change | |
2331 | * can occur in the metadata thread for the streams in the hash table. | |
2332 | */ | |
6d574024 | 2333 | void lttng_ustconsumer_close_all_metadata(struct lttng_ht *metadata_ht) |
d88aee68 | 2334 | { |
d88aee68 DG |
2335 | struct lttng_ht_iter iter; |
2336 | struct lttng_consumer_stream *stream; | |
2337 | ||
2338 | assert(metadata_ht); | |
2339 | assert(metadata_ht->ht); | |
2340 | ||
2341 | DBG("UST consumer closing all metadata streams"); | |
2342 | ||
2343 | rcu_read_lock(); | |
2344 | cds_lfht_for_each_entry(metadata_ht->ht, &iter.iter, stream, | |
2345 | node.node) { | |
9ce5646a MD |
2346 | |
2347 | health_code_update(); | |
2348 | ||
be2b50c7 | 2349 | pthread_mutex_lock(&stream->chan->lock); |
6d574024 | 2350 | lttng_ustconsumer_close_metadata(stream->chan); |
be2b50c7 DG |
2351 | pthread_mutex_unlock(&stream->chan->lock); |
2352 | ||
d88aee68 DG |
2353 | } |
2354 | rcu_read_unlock(); | |
2355 | } | |
d8ef542d MD |
2356 | |
2357 | void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream) | |
2358 | { | |
2359 | int ret; | |
2360 | ||
2361 | ret = ustctl_stream_close_wakeup_fd(stream->ustream); | |
2362 | if (ret < 0) { | |
2363 | ERR("Unable to close wakeup fd"); | |
2364 | } | |
2365 | } | |
331744e3 | 2366 | |
f666ae70 MD |
2367 | /* |
2368 | * Please refer to consumer-timer.c before adding any lock within this | |
2369 | * function or any of its callees. Timers have a very strict locking | |
2370 | * semantic with respect to teardown. Failure to respect this semantic | |
2371 | * introduces deadlocks. | |
5cc6b3e4 MD |
2372 | * |
2373 | * DON'T hold the metadata lock when calling this function, else this | |
2374 | * can cause deadlock involving consumer awaiting for metadata to be | |
2375 | * pushed out due to concurrent interaction with the session daemon. | |
f666ae70 | 2376 | */ |
331744e3 | 2377 | int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx, |
94d49140 | 2378 | struct lttng_consumer_channel *channel, int timer, int wait) |
331744e3 JD |
2379 | { |
2380 | struct lttcomm_metadata_request_msg request; | |
2381 | struct lttcomm_consumer_msg msg; | |
0c759fc9 | 2382 | enum lttcomm_return_code ret_code = LTTCOMM_CONSUMERD_SUCCESS; |
331744e3 JD |
2383 | uint64_t len, key, offset; |
2384 | int ret; | |
2385 | ||
2386 | assert(channel); | |
2387 | assert(channel->metadata_cache); | |
2388 | ||
53efb85a MD |
2389 | memset(&request, 0, sizeof(request)); |
2390 | ||
331744e3 JD |
2391 | /* send the metadata request to sessiond */ |
2392 | switch (consumer_data.type) { | |
2393 | case LTTNG_CONSUMER64_UST: | |
2394 | request.bits_per_long = 64; | |
2395 | break; | |
2396 | case LTTNG_CONSUMER32_UST: | |
2397 | request.bits_per_long = 32; | |
2398 | break; | |
2399 | default: | |
2400 | request.bits_per_long = 0; | |
2401 | break; | |
2402 | } | |
2403 | ||
2404 | request.session_id = channel->session_id; | |
1950109e | 2405 | request.session_id_per_pid = channel->session_id_per_pid; |
567eb353 DG |
2406 | /* |
2407 | * Request the application UID here so the metadata of that application can | |
2408 | * be sent back. The channel UID corresponds to the user UID of the session | |
2409 | * used for the rights on the stream file(s). | |
2410 | */ | |
2411 | request.uid = channel->ust_app_uid; | |
331744e3 | 2412 | request.key = channel->key; |
567eb353 | 2413 | |
1950109e | 2414 | DBG("Sending metadata request to sessiond, session id %" PRIu64 |
567eb353 DG |
2415 | ", per-pid %" PRIu64 ", app UID %u and channek key %" PRIu64, |
2416 | request.session_id, request.session_id_per_pid, request.uid, | |
2417 | request.key); | |
331744e3 | 2418 | |
75d83e50 | 2419 | pthread_mutex_lock(&ctx->metadata_socket_lock); |
9ce5646a MD |
2420 | |
2421 | health_code_update(); | |
2422 | ||
331744e3 JD |
2423 | ret = lttcomm_send_unix_sock(ctx->consumer_metadata_socket, &request, |
2424 | sizeof(request)); | |
2425 | if (ret < 0) { | |
2426 | ERR("Asking metadata to sessiond"); | |
2427 | goto end; | |
2428 | } | |
2429 | ||
9ce5646a MD |
2430 | health_code_update(); |
2431 | ||
331744e3 JD |
2432 | /* Receive the metadata from sessiond */ |
2433 | ret = lttcomm_recv_unix_sock(ctx->consumer_metadata_socket, &msg, | |
2434 | sizeof(msg)); | |
2435 | if (ret != sizeof(msg)) { | |
8fd623e0 | 2436 | DBG("Consumer received unexpected message size %d (expects %zu)", |
331744e3 JD |
2437 | ret, sizeof(msg)); |
2438 | lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_ERROR_RECV_CMD); | |
2439 | /* | |
2440 | * The ret value might 0 meaning an orderly shutdown but this is ok | |
2441 | * since the caller handles this. | |
2442 | */ | |
2443 | goto end; | |
2444 | } | |
2445 | ||
9ce5646a MD |
2446 | health_code_update(); |
2447 | ||
331744e3 JD |
2448 | if (msg.cmd_type == LTTNG_ERR_UND) { |
2449 | /* No registry found */ | |
2450 | (void) consumer_send_status_msg(ctx->consumer_metadata_socket, | |
2451 | ret_code); | |
2452 | ret = 0; | |
2453 | goto end; | |
2454 | } else if (msg.cmd_type != LTTNG_CONSUMER_PUSH_METADATA) { | |
2455 | ERR("Unexpected cmd_type received %d", msg.cmd_type); | |
2456 | ret = -1; | |
2457 | goto end; | |
2458 | } | |
2459 | ||
2460 | len = msg.u.push_metadata.len; | |
2461 | key = msg.u.push_metadata.key; | |
2462 | offset = msg.u.push_metadata.target_offset; | |
2463 | ||
2464 | assert(key == channel->key); | |
2465 | if (len == 0) { | |
2466 | DBG("No new metadata to receive for key %" PRIu64, key); | |
2467 | } | |
2468 | ||
9ce5646a MD |
2469 | health_code_update(); |
2470 | ||
331744e3 JD |
2471 | /* Tell session daemon we are ready to receive the metadata. */ |
2472 | ret = consumer_send_status_msg(ctx->consumer_metadata_socket, | |
0c759fc9 | 2473 | LTTCOMM_CONSUMERD_SUCCESS); |
331744e3 JD |
2474 | if (ret < 0 || len == 0) { |
2475 | /* | |
2476 | * Somehow, the session daemon is not responding anymore or there is | |
2477 | * nothing to receive. | |
2478 | */ | |
2479 | goto end; | |
2480 | } | |
2481 | ||
9ce5646a MD |
2482 | health_code_update(); |
2483 | ||
1eb682be | 2484 | ret = lttng_ustconsumer_recv_metadata(ctx->consumer_metadata_socket, |
94d49140 | 2485 | key, offset, len, channel, timer, wait); |
1eb682be | 2486 | if (ret >= 0) { |
f2a444f1 DG |
2487 | /* |
2488 | * Only send the status msg if the sessiond is alive meaning a positive | |
2489 | * ret code. | |
2490 | */ | |
1eb682be | 2491 | (void) consumer_send_status_msg(ctx->consumer_metadata_socket, ret); |
f2a444f1 | 2492 | } |
331744e3 JD |
2493 | ret = 0; |
2494 | ||
2495 | end: | |
9ce5646a MD |
2496 | health_code_update(); |
2497 | ||
75d83e50 | 2498 | pthread_mutex_unlock(&ctx->metadata_socket_lock); |
331744e3 JD |
2499 | return ret; |
2500 | } | |
70190e1c DG |
2501 | |
2502 | /* | |
2503 | * Return the ustctl call for the get stream id. | |
2504 | */ | |
2505 | int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream *stream, | |
2506 | uint64_t *stream_id) | |
2507 | { | |
2508 | assert(stream); | |
2509 | assert(stream_id); | |
2510 | ||
2511 | return ustctl_get_stream_id(stream->ustream, stream_id); | |
2512 | } |