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