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