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 JD |
39 | #include <common/consumer-metadata-cache.h> |
40 | #include <common/consumer-timer.h> | |
fe4477ee | 41 | #include <common/utils.h> |
10a8a223 DG |
42 | |
43 | #include "ust-consumer.h" | |
3bd1e081 MD |
44 | |
45 | extern struct lttng_consumer_global_data consumer_data; | |
46 | extern int consumer_poll_timeout; | |
47 | extern volatile int consumer_quit; | |
48 | ||
49 | /* | |
ffe60014 DG |
50 | * Free channel object and all streams associated with it. This MUST be used |
51 | * only and only if the channel has _NEVER_ been added to the global channel | |
52 | * hash table. | |
3bd1e081 | 53 | */ |
ffe60014 | 54 | static void destroy_channel(struct lttng_consumer_channel *channel) |
3bd1e081 | 55 | { |
ffe60014 DG |
56 | struct lttng_consumer_stream *stream, *stmp; |
57 | ||
58 | assert(channel); | |
59 | ||
60 | DBG("UST consumer cleaning stream list"); | |
61 | ||
62 | cds_list_for_each_entry_safe(stream, stmp, &channel->streams.head, | |
63 | send_node) { | |
64 | cds_list_del(&stream->send_node); | |
65 | ustctl_destroy_stream(stream->ustream); | |
66 | free(stream); | |
67 | } | |
68 | ||
69 | /* | |
70 | * If a channel is available meaning that was created before the streams | |
71 | * were, delete it. | |
72 | */ | |
73 | if (channel->uchan) { | |
74 | lttng_ustconsumer_del_channel(channel); | |
75 | } | |
76 | free(channel); | |
77 | } | |
3bd1e081 MD |
78 | |
79 | /* | |
ffe60014 | 80 | * Add channel to internal consumer state. |
3bd1e081 | 81 | * |
ffe60014 | 82 | * Returns 0 on success or else a negative value. |
3bd1e081 | 83 | */ |
ffe60014 DG |
84 | static int add_channel(struct lttng_consumer_channel *channel, |
85 | struct lttng_consumer_local_data *ctx) | |
3bd1e081 MD |
86 | { |
87 | int ret = 0; | |
88 | ||
ffe60014 DG |
89 | assert(channel); |
90 | assert(ctx); | |
91 | ||
92 | if (ctx->on_recv_channel != NULL) { | |
93 | ret = ctx->on_recv_channel(channel); | |
94 | if (ret == 0) { | |
d8ef542d | 95 | ret = consumer_add_channel(channel, ctx); |
ffe60014 DG |
96 | } else if (ret < 0) { |
97 | /* Most likely an ENOMEM. */ | |
98 | lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_OUTFD_ERROR); | |
99 | goto error; | |
100 | } | |
101 | } else { | |
d8ef542d | 102 | ret = consumer_add_channel(channel, ctx); |
3bd1e081 MD |
103 | } |
104 | ||
d88aee68 | 105 | DBG("UST consumer channel added (key: %" PRIu64 ")", channel->key); |
ffe60014 DG |
106 | |
107 | error: | |
3bd1e081 MD |
108 | return ret; |
109 | } | |
110 | ||
111 | /* | |
ffe60014 DG |
112 | * Allocate and return a consumer channel object. |
113 | */ | |
114 | static struct lttng_consumer_channel *allocate_channel(uint64_t session_id, | |
115 | const char *pathname, const char *name, uid_t uid, gid_t gid, | |
da009f2c | 116 | uint64_t relayd_id, uint64_t key, enum lttng_event_output output, |
2bba9e53 | 117 | uint64_t tracefile_size, uint64_t tracefile_count, |
1950109e | 118 | uint64_t session_id_per_pid, unsigned int monitor) |
ffe60014 DG |
119 | { |
120 | assert(pathname); | |
121 | assert(name); | |
122 | ||
1950109e JD |
123 | return consumer_allocate_channel(key, session_id, pathname, name, uid, |
124 | gid, relayd_id, output, tracefile_size, | |
125 | tracefile_count, session_id_per_pid, monitor); | |
ffe60014 DG |
126 | } |
127 | ||
128 | /* | |
129 | * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the | |
130 | * error value if applicable is set in it else it is kept untouched. | |
3bd1e081 | 131 | * |
ffe60014 | 132 | * Return NULL on error else the newly allocated stream object. |
3bd1e081 | 133 | */ |
ffe60014 DG |
134 | static struct lttng_consumer_stream *allocate_stream(int cpu, int key, |
135 | struct lttng_consumer_channel *channel, | |
136 | struct lttng_consumer_local_data *ctx, int *_alloc_ret) | |
137 | { | |
138 | int alloc_ret; | |
139 | struct lttng_consumer_stream *stream = NULL; | |
140 | ||
141 | assert(channel); | |
142 | assert(ctx); | |
143 | ||
144 | stream = consumer_allocate_stream(channel->key, | |
145 | key, | |
146 | LTTNG_CONSUMER_ACTIVE_STREAM, | |
147 | channel->name, | |
148 | channel->uid, | |
149 | channel->gid, | |
150 | channel->relayd_id, | |
151 | channel->session_id, | |
152 | cpu, | |
153 | &alloc_ret, | |
154 | channel->type); | |
155 | if (stream == NULL) { | |
156 | switch (alloc_ret) { | |
157 | case -ENOENT: | |
158 | /* | |
159 | * We could not find the channel. Can happen if cpu hotplug | |
160 | * happens while tearing down. | |
161 | */ | |
162 | DBG3("Could not find channel"); | |
163 | break; | |
164 | case -ENOMEM: | |
165 | case -EINVAL: | |
166 | default: | |
167 | lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_OUTFD_ERROR); | |
168 | break; | |
169 | } | |
170 | goto error; | |
171 | } | |
172 | ||
173 | stream->chan = channel; | |
174 | ||
175 | error: | |
176 | if (_alloc_ret) { | |
177 | *_alloc_ret = alloc_ret; | |
178 | } | |
179 | return stream; | |
180 | } | |
181 | ||
182 | /* | |
183 | * Send the given stream pointer to the corresponding thread. | |
184 | * | |
185 | * Returns 0 on success else a negative value. | |
186 | */ | |
187 | static int send_stream_to_thread(struct lttng_consumer_stream *stream, | |
188 | struct lttng_consumer_local_data *ctx) | |
189 | { | |
dae10966 DG |
190 | int ret; |
191 | struct lttng_pipe *stream_pipe; | |
ffe60014 DG |
192 | |
193 | /* Get the right pipe where the stream will be sent. */ | |
194 | if (stream->metadata_flag) { | |
dae10966 | 195 | stream_pipe = ctx->consumer_metadata_pipe; |
ffe60014 | 196 | } else { |
dae10966 | 197 | stream_pipe = ctx->consumer_data_pipe; |
ffe60014 DG |
198 | } |
199 | ||
dae10966 | 200 | ret = lttng_pipe_write(stream_pipe, &stream, sizeof(stream)); |
ffe60014 | 201 | if (ret < 0) { |
dae10966 DG |
202 | ERR("Consumer write %s stream to pipe %d", |
203 | stream->metadata_flag ? "metadata" : "data", | |
204 | lttng_pipe_get_writefd(stream_pipe)); | |
ffe60014 DG |
205 | } |
206 | ||
207 | return ret; | |
208 | } | |
209 | ||
210 | /* | |
211 | * Search for a relayd object related to the stream. If found, send the stream | |
212 | * to the relayd. | |
213 | * | |
214 | * On success, returns 0 else a negative value. | |
215 | */ | |
216 | static int send_stream_to_relayd(struct lttng_consumer_stream *stream) | |
217 | { | |
218 | int ret = 0; | |
219 | struct consumer_relayd_sock_pair *relayd; | |
220 | ||
221 | assert(stream); | |
222 | ||
223 | relayd = consumer_find_relayd(stream->net_seq_idx); | |
224 | if (relayd != NULL) { | |
225 | pthread_mutex_lock(&relayd->ctrl_sock_mutex); | |
226 | /* Add stream on the relayd */ | |
227 | ret = relayd_add_stream(&relayd->control_sock, stream->name, | |
0f907de1 JD |
228 | stream->chan->pathname, &stream->relayd_stream_id, |
229 | stream->chan->tracefile_size, | |
230 | stream->chan->tracefile_count); | |
ffe60014 DG |
231 | pthread_mutex_unlock(&relayd->ctrl_sock_mutex); |
232 | if (ret < 0) { | |
233 | goto error; | |
234 | } | |
d88aee68 DG |
235 | } else if (stream->net_seq_idx != (uint64_t) -1ULL) { |
236 | ERR("Network sequence index %" PRIu64 " unknown. Not adding stream.", | |
ffe60014 DG |
237 | stream->net_seq_idx); |
238 | ret = -1; | |
239 | goto error; | |
240 | } | |
241 | ||
242 | error: | |
243 | return ret; | |
244 | } | |
245 | ||
d88aee68 DG |
246 | /* |
247 | * Create streams for the given channel using liblttng-ust-ctl. | |
248 | * | |
249 | * Return 0 on success else a negative value. | |
250 | */ | |
ffe60014 DG |
251 | static int create_ust_streams(struct lttng_consumer_channel *channel, |
252 | struct lttng_consumer_local_data *ctx) | |
253 | { | |
254 | int ret, cpu = 0; | |
255 | struct ustctl_consumer_stream *ustream; | |
256 | struct lttng_consumer_stream *stream; | |
257 | ||
258 | assert(channel); | |
259 | assert(ctx); | |
260 | ||
261 | /* | |
262 | * While a stream is available from ustctl. When NULL is returned, we've | |
263 | * reached the end of the possible stream for the channel. | |
264 | */ | |
265 | while ((ustream = ustctl_create_stream(channel->uchan, cpu))) { | |
266 | int wait_fd; | |
267 | ||
749d339a | 268 | wait_fd = ustctl_stream_get_wait_fd(ustream); |
ffe60014 DG |
269 | |
270 | /* Allocate consumer stream object. */ | |
271 | stream = allocate_stream(cpu, wait_fd, channel, ctx, &ret); | |
272 | if (!stream) { | |
273 | goto error_alloc; | |
274 | } | |
275 | stream->ustream = ustream; | |
276 | /* | |
277 | * Store it so we can save multiple function calls afterwards since | |
278 | * this value is used heavily in the stream threads. This is UST | |
279 | * specific so this is why it's done after allocation. | |
280 | */ | |
281 | stream->wait_fd = wait_fd; | |
282 | ||
b31398bb DG |
283 | /* |
284 | * Increment channel refcount since the channel reference has now been | |
285 | * assigned in the allocation process above. | |
286 | */ | |
287 | uatomic_inc(&stream->chan->refcount); | |
288 | ||
ffe60014 DG |
289 | /* |
290 | * Order is important this is why a list is used. On error, the caller | |
291 | * should clean this list. | |
292 | */ | |
293 | cds_list_add_tail(&stream->send_node, &channel->streams.head); | |
294 | ||
295 | ret = ustctl_get_max_subbuf_size(stream->ustream, | |
296 | &stream->max_sb_size); | |
297 | if (ret < 0) { | |
298 | ERR("ustctl_get_max_subbuf_size failed for stream %s", | |
299 | stream->name); | |
300 | goto error; | |
301 | } | |
302 | ||
303 | /* Do actions once stream has been received. */ | |
304 | if (ctx->on_recv_stream) { | |
305 | ret = ctx->on_recv_stream(stream); | |
306 | if (ret < 0) { | |
307 | goto error; | |
308 | } | |
309 | } | |
310 | ||
d88aee68 | 311 | DBG("UST consumer add stream %s (key: %" PRIu64 ") with relayd id %" PRIu64, |
ffe60014 DG |
312 | stream->name, stream->key, stream->relayd_stream_id); |
313 | ||
314 | /* Set next CPU stream. */ | |
315 | channel->streams.count = ++cpu; | |
d88aee68 DG |
316 | |
317 | /* Keep stream reference when creating metadata. */ | |
318 | if (channel->type == CONSUMER_CHANNEL_TYPE_METADATA) { | |
319 | channel->metadata_stream = stream; | |
320 | } | |
ffe60014 DG |
321 | } |
322 | ||
323 | return 0; | |
324 | ||
325 | error: | |
326 | error_alloc: | |
327 | return ret; | |
328 | } | |
329 | ||
330 | /* | |
331 | * Create an UST channel with the given attributes and send it to the session | |
332 | * daemon using the ust ctl API. | |
333 | * | |
334 | * Return 0 on success or else a negative value. | |
335 | */ | |
336 | static int create_ust_channel(struct ustctl_consumer_channel_attr *attr, | |
337 | struct ustctl_consumer_channel **chanp) | |
338 | { | |
339 | int ret; | |
340 | struct ustctl_consumer_channel *channel; | |
341 | ||
342 | assert(attr); | |
343 | assert(chanp); | |
344 | ||
345 | DBG3("Creating channel to ustctl with attr: [overwrite: %d, " | |
346 | "subbuf_size: %" PRIu64 ", num_subbuf: %" PRIu64 ", " | |
347 | "switch_timer_interval: %u, read_timer_interval: %u, " | |
348 | "output: %d, type: %d", attr->overwrite, attr->subbuf_size, | |
349 | attr->num_subbuf, attr->switch_timer_interval, | |
350 | attr->read_timer_interval, attr->output, attr->type); | |
351 | ||
352 | channel = ustctl_create_channel(attr); | |
353 | if (!channel) { | |
354 | ret = -1; | |
355 | goto error_create; | |
356 | } | |
357 | ||
358 | *chanp = channel; | |
359 | ||
360 | return 0; | |
361 | ||
362 | error_create: | |
363 | return ret; | |
364 | } | |
365 | ||
d88aee68 DG |
366 | /* |
367 | * Send a single given stream to the session daemon using the sock. | |
368 | * | |
369 | * Return 0 on success else a negative value. | |
370 | */ | |
ffe60014 DG |
371 | static int send_sessiond_stream(int sock, struct lttng_consumer_stream *stream) |
372 | { | |
373 | int ret; | |
374 | ||
375 | assert(stream); | |
376 | assert(sock >= 0); | |
377 | ||
d88aee68 | 378 | DBG2("UST consumer sending stream %" PRIu64 " to sessiond", stream->key); |
ffe60014 DG |
379 | |
380 | /* Send stream to session daemon. */ | |
381 | ret = ustctl_send_stream_to_sessiond(sock, stream->ustream); | |
382 | if (ret < 0) { | |
383 | goto error; | |
384 | } | |
385 | ||
ffe60014 DG |
386 | error: |
387 | return ret; | |
388 | } | |
389 | ||
390 | /* | |
391 | * Send channel to sessiond. | |
392 | * | |
d88aee68 | 393 | * Return 0 on success or else a negative value. |
ffe60014 DG |
394 | */ |
395 | static int send_sessiond_channel(int sock, | |
396 | struct lttng_consumer_channel *channel, | |
397 | struct lttng_consumer_local_data *ctx, int *relayd_error) | |
398 | { | |
f2a444f1 | 399 | int ret, ret_code = LTTNG_OK; |
ffe60014 DG |
400 | struct lttng_consumer_stream *stream; |
401 | ||
402 | assert(channel); | |
403 | assert(ctx); | |
404 | assert(sock >= 0); | |
405 | ||
406 | DBG("UST consumer sending channel %s to sessiond", channel->name); | |
407 | ||
ffe60014 DG |
408 | cds_list_for_each_entry(stream, &channel->streams.head, send_node) { |
409 | /* Try to send the stream to the relayd if one is available. */ | |
410 | ret = send_stream_to_relayd(stream); | |
411 | if (ret < 0) { | |
412 | /* | |
413 | * Flag that the relayd was the problem here probably due to a | |
414 | * communicaton error on the socket. | |
415 | */ | |
416 | if (relayd_error) { | |
417 | *relayd_error = 1; | |
418 | } | |
f2a444f1 | 419 | ret_code = LTTNG_ERR_RELAYD_CONNECT_FAIL; |
ffe60014 | 420 | } |
f2a444f1 | 421 | } |
ffe60014 | 422 | |
f2a444f1 DG |
423 | /* Inform sessiond that we are about to send channel and streams. */ |
424 | ret = consumer_send_status_msg(sock, ret_code); | |
425 | if (ret < 0 || ret_code != LTTNG_OK) { | |
426 | /* | |
427 | * Either the session daemon is not responding or the relayd died so we | |
428 | * stop now. | |
429 | */ | |
430 | goto error; | |
431 | } | |
432 | ||
433 | /* Send channel to sessiond. */ | |
434 | ret = ustctl_send_channel_to_sessiond(sock, channel->uchan); | |
435 | if (ret < 0) { | |
436 | goto error; | |
437 | } | |
438 | ||
439 | ret = ustctl_channel_close_wakeup_fd(channel->uchan); | |
440 | if (ret < 0) { | |
441 | goto error; | |
442 | } | |
443 | ||
444 | /* The channel was sent successfully to the sessiond at this point. */ | |
445 | cds_list_for_each_entry(stream, &channel->streams.head, send_node) { | |
ffe60014 DG |
446 | /* Send stream to session daemon. */ |
447 | ret = send_sessiond_stream(sock, stream); | |
448 | if (ret < 0) { | |
449 | goto error; | |
450 | } | |
451 | } | |
452 | ||
453 | /* Tell sessiond there is no more stream. */ | |
454 | ret = ustctl_send_stream_to_sessiond(sock, NULL); | |
455 | if (ret < 0) { | |
456 | goto error; | |
457 | } | |
458 | ||
459 | DBG("UST consumer NULL stream sent to sessiond"); | |
460 | ||
461 | return 0; | |
462 | ||
463 | error: | |
f2a444f1 DG |
464 | if (ret_code != LTTNG_OK) { |
465 | ret = -1; | |
466 | } | |
ffe60014 DG |
467 | return ret; |
468 | } | |
469 | ||
470 | /* | |
471 | * Creates a channel and streams and add the channel it to the channel internal | |
472 | * state. The created stream must ONLY be sent once the GET_CHANNEL command is | |
473 | * received. | |
474 | * | |
475 | * Return 0 on success or else, a negative value is returned and the channel | |
476 | * MUST be destroyed by consumer_del_channel(). | |
477 | */ | |
478 | static int ask_channel(struct lttng_consumer_local_data *ctx, int sock, | |
479 | struct lttng_consumer_channel *channel, | |
480 | struct ustctl_consumer_channel_attr *attr) | |
3bd1e081 MD |
481 | { |
482 | int ret; | |
483 | ||
ffe60014 DG |
484 | assert(ctx); |
485 | assert(channel); | |
486 | assert(attr); | |
487 | ||
488 | /* | |
489 | * This value is still used by the kernel consumer since for the kernel, | |
490 | * the stream ownership is not IN the consumer so we need to have the | |
491 | * number of left stream that needs to be initialized so we can know when | |
492 | * to delete the channel (see consumer.c). | |
493 | * | |
494 | * As for the user space tracer now, the consumer creates and sends the | |
495 | * stream to the session daemon which only sends them to the application | |
496 | * once every stream of a channel is received making this value useless | |
497 | * because we they will be added to the poll thread before the application | |
498 | * receives them. This ensures that a stream can not hang up during | |
499 | * initilization of a channel. | |
500 | */ | |
501 | channel->nb_init_stream_left = 0; | |
502 | ||
503 | /* The reply msg status is handled in the following call. */ | |
504 | ret = create_ust_channel(attr, &channel->uchan); | |
505 | if (ret < 0) { | |
506 | goto error; | |
3bd1e081 MD |
507 | } |
508 | ||
d8ef542d MD |
509 | channel->wait_fd = ustctl_channel_get_wait_fd(channel->uchan); |
510 | ||
ffe60014 DG |
511 | /* Open all streams for this channel. */ |
512 | ret = create_ust_streams(channel, ctx); | |
513 | if (ret < 0) { | |
514 | goto error; | |
515 | } | |
516 | ||
517 | error: | |
3bd1e081 MD |
518 | return ret; |
519 | } | |
520 | ||
d88aee68 DG |
521 | /* |
522 | * Send all stream of a channel to the right thread handling it. | |
523 | * | |
524 | * On error, return a negative value else 0 on success. | |
525 | */ | |
526 | static int send_streams_to_thread(struct lttng_consumer_channel *channel, | |
527 | struct lttng_consumer_local_data *ctx) | |
528 | { | |
529 | int ret = 0; | |
530 | struct lttng_consumer_stream *stream, *stmp; | |
531 | ||
532 | assert(channel); | |
533 | assert(ctx); | |
534 | ||
535 | /* Send streams to the corresponding thread. */ | |
536 | cds_list_for_each_entry_safe(stream, stmp, &channel->streams.head, | |
537 | send_node) { | |
538 | /* Sending the stream to the thread. */ | |
539 | ret = send_stream_to_thread(stream, ctx); | |
540 | if (ret < 0) { | |
541 | /* | |
542 | * If we are unable to send the stream to the thread, there is | |
543 | * a big problem so just stop everything. | |
544 | */ | |
545 | goto error; | |
546 | } | |
547 | ||
548 | /* Remove node from the channel stream list. */ | |
549 | cds_list_del(&stream->send_node); | |
550 | } | |
551 | ||
552 | error: | |
553 | return ret; | |
554 | } | |
555 | ||
556 | /* | |
557 | * Write metadata to the given channel using ustctl to convert the string to | |
558 | * the ringbuffer. | |
331744e3 JD |
559 | * Called only from consumer_metadata_cache_write. |
560 | * The metadata cache lock MUST be acquired to write in the cache. | |
d88aee68 DG |
561 | * |
562 | * Return 0 on success else a negative value. | |
563 | */ | |
331744e3 | 564 | int lttng_ustconsumer_push_metadata(struct lttng_consumer_channel *metadata, |
d88aee68 DG |
565 | const char *metadata_str, uint64_t target_offset, uint64_t len) |
566 | { | |
567 | int ret; | |
568 | ||
569 | assert(metadata); | |
570 | assert(metadata_str); | |
571 | ||
572 | DBG("UST consumer writing metadata to channel %s", metadata->name); | |
573 | ||
73811ecc DG |
574 | if (!metadata->metadata_stream) { |
575 | ret = 0; | |
576 | goto error; | |
577 | } | |
578 | ||
331744e3 JD |
579 | assert(target_offset <= metadata->metadata_cache->max_offset); |
580 | ret = ustctl_write_metadata_to_channel(metadata->uchan, | |
581 | metadata_str + target_offset, len); | |
d88aee68 | 582 | if (ret < 0) { |
8fd623e0 | 583 | ERR("ustctl write metadata fail with ret %d, len %" PRIu64, ret, len); |
d88aee68 DG |
584 | goto error; |
585 | } | |
d88aee68 DG |
586 | |
587 | ustctl_flush_buffer(metadata->metadata_stream->ustream, 1); | |
588 | ||
589 | error: | |
590 | return ret; | |
591 | } | |
592 | ||
7972aab2 DG |
593 | /* |
594 | * Flush channel's streams using the given key to retrieve the channel. | |
595 | * | |
596 | * Return 0 on success else an LTTng error code. | |
597 | */ | |
598 | static int flush_channel(uint64_t chan_key) | |
599 | { | |
600 | int ret = 0; | |
601 | struct lttng_consumer_channel *channel; | |
602 | struct lttng_consumer_stream *stream; | |
603 | struct lttng_ht *ht; | |
604 | struct lttng_ht_iter iter; | |
605 | ||
8fd623e0 | 606 | DBG("UST consumer flush channel key %" PRIu64, chan_key); |
7972aab2 | 607 | |
a500c257 | 608 | rcu_read_lock(); |
7972aab2 DG |
609 | channel = consumer_find_channel(chan_key); |
610 | if (!channel) { | |
8fd623e0 | 611 | ERR("UST consumer flush channel %" PRIu64 " not found", chan_key); |
7972aab2 DG |
612 | ret = LTTNG_ERR_UST_CHAN_NOT_FOUND; |
613 | goto error; | |
614 | } | |
615 | ||
616 | ht = consumer_data.stream_per_chan_id_ht; | |
617 | ||
618 | /* For each stream of the channel id, flush it. */ | |
7972aab2 DG |
619 | cds_lfht_for_each_entry_duplicate(ht->ht, |
620 | ht->hash_fct(&channel->key, lttng_ht_seed), ht->match_fct, | |
621 | &channel->key, &iter.iter, stream, node_channel_id.node) { | |
622 | ustctl_flush_buffer(stream->ustream, 1); | |
623 | } | |
7972aab2 | 624 | error: |
a500c257 | 625 | rcu_read_unlock(); |
7972aab2 DG |
626 | return ret; |
627 | } | |
628 | ||
d88aee68 DG |
629 | /* |
630 | * Close metadata stream wakeup_fd using the given key to retrieve the channel. | |
a500c257 | 631 | * RCU read side lock MUST be acquired before calling this function. |
d88aee68 DG |
632 | * |
633 | * Return 0 on success else an LTTng error code. | |
634 | */ | |
635 | static int close_metadata(uint64_t chan_key) | |
636 | { | |
ea88ca2a | 637 | int ret = 0; |
d88aee68 DG |
638 | struct lttng_consumer_channel *channel; |
639 | ||
8fd623e0 | 640 | DBG("UST consumer close metadata key %" PRIu64, chan_key); |
d88aee68 DG |
641 | |
642 | channel = consumer_find_channel(chan_key); | |
643 | if (!channel) { | |
84cc9aa0 DG |
644 | /* |
645 | * This is possible if the metadata thread has issue a delete because | |
646 | * the endpoint point of the stream hung up. There is no way the | |
647 | * session daemon can know about it thus use a DBG instead of an actual | |
648 | * error. | |
649 | */ | |
650 | DBG("UST consumer close metadata %" PRIu64 " not found", chan_key); | |
d88aee68 DG |
651 | ret = LTTNG_ERR_UST_CHAN_NOT_FOUND; |
652 | goto error; | |
653 | } | |
654 | ||
ea88ca2a | 655 | pthread_mutex_lock(&consumer_data.lock); |
73811ecc DG |
656 | |
657 | if (cds_lfht_is_node_deleted(&channel->node.node)) { | |
658 | goto error_unlock; | |
659 | } | |
660 | ||
661 | if (channel->switch_timer_enabled == 1) { | |
662 | DBG("Deleting timer on metadata channel"); | |
663 | consumer_timer_switch_stop(channel); | |
664 | } | |
665 | ||
666 | if (channel->metadata_stream) { | |
ea88ca2a MD |
667 | ret = ustctl_stream_close_wakeup_fd(channel->metadata_stream->ustream); |
668 | if (ret < 0) { | |
669 | ERR("UST consumer unable to close fd of metadata (ret: %d)", ret); | |
670 | ret = LTTCOMM_CONSUMERD_ERROR_METADATA; | |
671 | goto error_unlock; | |
672 | } | |
331744e3 | 673 | } |
d88aee68 | 674 | |
ea88ca2a MD |
675 | error_unlock: |
676 | pthread_mutex_unlock(&consumer_data.lock); | |
d88aee68 DG |
677 | error: |
678 | return ret; | |
679 | } | |
680 | ||
681 | /* | |
682 | * RCU read side lock MUST be acquired before calling this function. | |
683 | * | |
684 | * Return 0 on success else an LTTng error code. | |
685 | */ | |
686 | static int setup_metadata(struct lttng_consumer_local_data *ctx, uint64_t key) | |
687 | { | |
688 | int ret; | |
689 | struct lttng_consumer_channel *metadata; | |
690 | ||
8fd623e0 | 691 | DBG("UST consumer setup metadata key %" PRIu64, key); |
d88aee68 DG |
692 | |
693 | metadata = consumer_find_channel(key); | |
694 | if (!metadata) { | |
695 | ERR("UST consumer push metadata %" PRIu64 " not found", key); | |
696 | ret = LTTNG_ERR_UST_CHAN_NOT_FOUND; | |
f2a444f1 | 697 | goto error_find; |
d88aee68 DG |
698 | } |
699 | ||
700 | /* | |
701 | * Send metadata stream to relayd if one available. Availability is | |
702 | * known if the stream is still in the list of the channel. | |
703 | */ | |
704 | if (cds_list_empty(&metadata->streams.head)) { | |
705 | ERR("Metadata channel key %" PRIu64 ", no stream available.", key); | |
706 | ret = LTTCOMM_CONSUMERD_ERROR_METADATA; | |
707 | goto error; | |
708 | } | |
709 | ||
710 | /* Send metadata stream to relayd if needed. */ | |
711 | ret = send_stream_to_relayd(metadata->metadata_stream); | |
712 | if (ret < 0) { | |
713 | ret = LTTCOMM_CONSUMERD_ERROR_METADATA; | |
714 | goto error; | |
715 | } | |
716 | ||
717 | ret = send_streams_to_thread(metadata, ctx); | |
718 | if (ret < 0) { | |
719 | /* | |
720 | * If we are unable to send the stream to the thread, there is | |
721 | * a big problem so just stop everything. | |
722 | */ | |
723 | ret = LTTCOMM_CONSUMERD_FATAL; | |
724 | goto error; | |
725 | } | |
726 | /* List MUST be empty after or else it could be reused. */ | |
727 | assert(cds_list_empty(&metadata->streams.head)); | |
728 | ||
f2a444f1 | 729 | return 0; |
d88aee68 DG |
730 | |
731 | error: | |
f2a444f1 DG |
732 | /* |
733 | * Delete metadata channel on error. At this point, the metadata stream can | |
734 | * NOT be monitored by the metadata thread thus having the guarantee that | |
735 | * the stream is still in the local stream list of the channel. This call | |
736 | * will make sure to clean that list. | |
737 | */ | |
738 | consumer_del_channel(metadata); | |
739 | error_find: | |
d88aee68 DG |
740 | return ret; |
741 | } | |
742 | ||
331744e3 JD |
743 | /* |
744 | * Receive the metadata updates from the sessiond. | |
745 | */ | |
746 | int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset, | |
747 | uint64_t len, struct lttng_consumer_channel *channel) | |
748 | { | |
749 | int ret, ret_code = LTTNG_OK; | |
750 | char *metadata_str; | |
751 | ||
8fd623e0 | 752 | DBG("UST consumer push metadata key %" PRIu64 " of len %" PRIu64, key, len); |
331744e3 JD |
753 | |
754 | metadata_str = zmalloc(len * sizeof(char)); | |
755 | if (!metadata_str) { | |
756 | PERROR("zmalloc metadata string"); | |
757 | ret_code = LTTCOMM_CONSUMERD_ENOMEM; | |
758 | goto end; | |
759 | } | |
760 | ||
761 | /* Receive metadata string. */ | |
762 | ret = lttcomm_recv_unix_sock(sock, metadata_str, len); | |
763 | if (ret < 0) { | |
764 | /* Session daemon is dead so return gracefully. */ | |
765 | ret_code = ret; | |
766 | goto end_free; | |
767 | } | |
768 | ||
73811ecc DG |
769 | /* |
770 | * XXX: The consumer data lock is acquired before calling metadata cache | |
771 | * write which calls push metadata that MUST be protected by the consumer | |
772 | * lock in order to be able to check the validity of the metadata stream of | |
773 | * the channel. | |
774 | * | |
775 | * Note that this will be subject to change to better fine grained locking | |
776 | * and ultimately try to get rid of this global consumer data lock. | |
777 | */ | |
778 | pthread_mutex_lock(&consumer_data.lock); | |
779 | ||
331744e3 JD |
780 | pthread_mutex_lock(&channel->metadata_cache->lock); |
781 | ret = consumer_metadata_cache_write(channel, offset, len, metadata_str); | |
782 | if (ret < 0) { | |
783 | /* Unable to handle metadata. Notify session daemon. */ | |
784 | ret_code = LTTCOMM_CONSUMERD_ERROR_METADATA; | |
a32bd775 DG |
785 | /* |
786 | * Skip metadata flush on write error since the offset and len might | |
787 | * not have been updated which could create an infinite loop below when | |
788 | * waiting for the metadata cache to be flushed. | |
789 | */ | |
790 | pthread_mutex_unlock(&channel->metadata_cache->lock); | |
791 | pthread_mutex_unlock(&consumer_data.lock); | |
792 | goto end_free; | |
331744e3 JD |
793 | } |
794 | pthread_mutex_unlock(&channel->metadata_cache->lock); | |
73811ecc | 795 | pthread_mutex_unlock(&consumer_data.lock); |
331744e3 JD |
796 | |
797 | while (consumer_metadata_cache_flushed(channel, offset + len)) { | |
798 | DBG("Waiting for metadata to be flushed"); | |
799 | usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME); | |
800 | } | |
801 | ||
802 | end_free: | |
803 | free(metadata_str); | |
804 | end: | |
805 | return ret_code; | |
806 | } | |
807 | ||
4cbc1a04 DG |
808 | /* |
809 | * Receive command from session daemon and process it. | |
810 | * | |
811 | * Return 1 on success else a negative value or 0. | |
812 | */ | |
3bd1e081 MD |
813 | int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx, |
814 | int sock, struct pollfd *consumer_sockpoll) | |
815 | { | |
816 | ssize_t ret; | |
f50f23d9 | 817 | enum lttng_error_code ret_code = LTTNG_OK; |
3bd1e081 | 818 | struct lttcomm_consumer_msg msg; |
ffe60014 | 819 | struct lttng_consumer_channel *channel = NULL; |
3bd1e081 MD |
820 | |
821 | ret = lttcomm_recv_unix_sock(sock, &msg, sizeof(msg)); | |
822 | if (ret != sizeof(msg)) { | |
173af62f DG |
823 | DBG("Consumer received unexpected message size %zd (expects %zu)", |
824 | ret, sizeof(msg)); | |
ffe60014 | 825 | lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_ERROR_RECV_CMD); |
3be74084 DG |
826 | /* |
827 | * The ret value might 0 meaning an orderly shutdown but this is ok | |
828 | * since the caller handles this. | |
829 | */ | |
489f70e9 MD |
830 | if (ret > 0) { |
831 | ret = -1; | |
832 | } | |
3bd1e081 MD |
833 | return ret; |
834 | } | |
835 | if (msg.cmd_type == LTTNG_CONSUMER_STOP) { | |
f50f23d9 DG |
836 | /* |
837 | * Notify the session daemon that the command is completed. | |
838 | * | |
839 | * On transport layer error, the function call will print an error | |
840 | * message so handling the returned code is a bit useless since we | |
841 | * return an error code anyway. | |
842 | */ | |
843 | (void) consumer_send_status_msg(sock, ret_code); | |
3bd1e081 MD |
844 | return -ENOENT; |
845 | } | |
846 | ||
3f8e211f | 847 | /* relayd needs RCU read-side lock */ |
b0b335c8 MD |
848 | rcu_read_lock(); |
849 | ||
3bd1e081 | 850 | switch (msg.cmd_type) { |
00e2e675 DG |
851 | case LTTNG_CONSUMER_ADD_RELAYD_SOCKET: |
852 | { | |
f50f23d9 | 853 | /* Session daemon status message are handled in the following call. */ |
7735ef9e DG |
854 | ret = consumer_add_relayd_socket(msg.u.relayd_sock.net_index, |
855 | msg.u.relayd_sock.type, ctx, sock, consumer_sockpoll, | |
46e6455f | 856 | &msg.u.relayd_sock.sock, msg.u.relayd_sock.session_id); |
00e2e675 DG |
857 | goto end_nosignal; |
858 | } | |
173af62f DG |
859 | case LTTNG_CONSUMER_DESTROY_RELAYD: |
860 | { | |
a6ba4fe1 | 861 | uint64_t index = msg.u.destroy_relayd.net_seq_idx; |
173af62f DG |
862 | struct consumer_relayd_sock_pair *relayd; |
863 | ||
a6ba4fe1 | 864 | DBG("UST consumer destroying relayd %" PRIu64, index); |
173af62f DG |
865 | |
866 | /* Get relayd reference if exists. */ | |
a6ba4fe1 | 867 | relayd = consumer_find_relayd(index); |
173af62f | 868 | if (relayd == NULL) { |
3448e266 | 869 | DBG("Unable to find relayd %" PRIu64, index); |
f50f23d9 | 870 | ret_code = LTTNG_ERR_NO_CONSUMER; |
173af62f DG |
871 | } |
872 | ||
a6ba4fe1 DG |
873 | /* |
874 | * Each relayd socket pair has a refcount of stream attached to it | |
875 | * which tells if the relayd is still active or not depending on the | |
876 | * refcount value. | |
877 | * | |
878 | * This will set the destroy flag of the relayd object and destroy it | |
879 | * if the refcount reaches zero when called. | |
880 | * | |
881 | * The destroy can happen either here or when a stream fd hangs up. | |
882 | */ | |
f50f23d9 DG |
883 | if (relayd) { |
884 | consumer_flag_relayd_for_destroy(relayd); | |
885 | } | |
886 | ||
d88aee68 | 887 | goto end_msg_sessiond; |
173af62f | 888 | } |
3bd1e081 MD |
889 | case LTTNG_CONSUMER_UPDATE_STREAM: |
890 | { | |
3f8e211f | 891 | rcu_read_unlock(); |
7ad0a0cb | 892 | return -ENOSYS; |
3bd1e081 | 893 | } |
6d805429 | 894 | case LTTNG_CONSUMER_DATA_PENDING: |
53632229 | 895 | { |
3be74084 | 896 | int ret, is_data_pending; |
6d805429 | 897 | uint64_t id = msg.u.data_pending.session_id; |
ca22feea | 898 | |
6d805429 | 899 | DBG("UST consumer data pending command for id %" PRIu64, id); |
ca22feea | 900 | |
3be74084 | 901 | is_data_pending = consumer_data_pending(id); |
ca22feea DG |
902 | |
903 | /* Send back returned value to session daemon */ | |
3be74084 DG |
904 | ret = lttcomm_send_unix_sock(sock, &is_data_pending, |
905 | sizeof(is_data_pending)); | |
ca22feea | 906 | if (ret < 0) { |
3be74084 | 907 | DBG("Error when sending the data pending ret code: %d", ret); |
489f70e9 | 908 | goto error_fatal; |
ca22feea | 909 | } |
f50f23d9 DG |
910 | |
911 | /* | |
912 | * No need to send back a status message since the data pending | |
913 | * returned value is the response. | |
914 | */ | |
ca22feea | 915 | break; |
53632229 | 916 | } |
ffe60014 DG |
917 | case LTTNG_CONSUMER_ASK_CHANNEL_CREATION: |
918 | { | |
919 | int ret; | |
920 | struct ustctl_consumer_channel_attr attr; | |
921 | ||
922 | /* Create a plain object and reserve a channel key. */ | |
923 | channel = allocate_channel(msg.u.ask_channel.session_id, | |
924 | msg.u.ask_channel.pathname, msg.u.ask_channel.name, | |
925 | msg.u.ask_channel.uid, msg.u.ask_channel.gid, | |
926 | msg.u.ask_channel.relayd_id, msg.u.ask_channel.key, | |
1624d5b7 JD |
927 | (enum lttng_event_output) msg.u.ask_channel.output, |
928 | msg.u.ask_channel.tracefile_size, | |
2bba9e53 | 929 | msg.u.ask_channel.tracefile_count, |
1950109e | 930 | msg.u.ask_channel.session_id_per_pid, |
2bba9e53 | 931 | msg.u.ask_channel.monitor); |
ffe60014 DG |
932 | if (!channel) { |
933 | goto end_channel_error; | |
934 | } | |
935 | ||
936 | /* Build channel attributes from received message. */ | |
937 | attr.subbuf_size = msg.u.ask_channel.subbuf_size; | |
938 | attr.num_subbuf = msg.u.ask_channel.num_subbuf; | |
939 | attr.overwrite = msg.u.ask_channel.overwrite; | |
940 | attr.switch_timer_interval = msg.u.ask_channel.switch_timer_interval; | |
941 | attr.read_timer_interval = msg.u.ask_channel.read_timer_interval; | |
7972aab2 | 942 | attr.chan_id = msg.u.ask_channel.chan_id; |
ffe60014 DG |
943 | memcpy(attr.uuid, msg.u.ask_channel.uuid, sizeof(attr.uuid)); |
944 | ||
ffe60014 DG |
945 | /* Translate and save channel type. */ |
946 | switch (msg.u.ask_channel.type) { | |
947 | case LTTNG_UST_CHAN_PER_CPU: | |
948 | channel->type = CONSUMER_CHANNEL_TYPE_DATA; | |
949 | attr.type = LTTNG_UST_CHAN_PER_CPU; | |
8633d6e3 MD |
950 | /* |
951 | * Set refcount to 1 for owner. Below, we will | |
952 | * pass ownership to the | |
953 | * consumer_thread_channel_poll() thread. | |
954 | */ | |
955 | channel->refcount = 1; | |
ffe60014 DG |
956 | break; |
957 | case LTTNG_UST_CHAN_METADATA: | |
958 | channel->type = CONSUMER_CHANNEL_TYPE_METADATA; | |
959 | attr.type = LTTNG_UST_CHAN_METADATA; | |
960 | break; | |
961 | default: | |
962 | assert(0); | |
963 | goto error_fatal; | |
964 | }; | |
965 | ||
966 | ret = ask_channel(ctx, sock, channel, &attr); | |
967 | if (ret < 0) { | |
968 | goto end_channel_error; | |
969 | } | |
970 | ||
fc643247 MD |
971 | if (msg.u.ask_channel.type == LTTNG_UST_CHAN_METADATA) { |
972 | ret = consumer_metadata_cache_allocate(channel); | |
973 | if (ret < 0) { | |
974 | ERR("Allocating metadata cache"); | |
975 | goto end_channel_error; | |
976 | } | |
977 | consumer_timer_switch_start(channel, attr.switch_timer_interval); | |
978 | attr.switch_timer_interval = 0; | |
979 | } | |
980 | ||
ffe60014 DG |
981 | /* |
982 | * Add the channel to the internal state AFTER all streams were created | |
983 | * and successfully sent to session daemon. This way, all streams must | |
984 | * be ready before this channel is visible to the threads. | |
fc643247 MD |
985 | * If add_channel succeeds, ownership of the channel is |
986 | * passed to consumer_thread_channel_poll(). | |
ffe60014 DG |
987 | */ |
988 | ret = add_channel(channel, ctx); | |
989 | if (ret < 0) { | |
ea88ca2a MD |
990 | if (msg.u.ask_channel.type == LTTNG_UST_CHAN_METADATA) { |
991 | if (channel->switch_timer_enabled == 1) { | |
992 | consumer_timer_switch_stop(channel); | |
993 | } | |
994 | consumer_metadata_cache_destroy(channel); | |
995 | } | |
ffe60014 DG |
996 | goto end_channel_error; |
997 | } | |
998 | ||
999 | /* | |
1000 | * Channel and streams are now created. Inform the session daemon that | |
1001 | * everything went well and should wait to receive the channel and | |
1002 | * streams with ustctl API. | |
1003 | */ | |
1004 | ret = consumer_send_status_channel(sock, channel); | |
1005 | if (ret < 0) { | |
1006 | /* | |
489f70e9 | 1007 | * There is probably a problem on the socket. |
ffe60014 | 1008 | */ |
489f70e9 | 1009 | goto error_fatal; |
ffe60014 DG |
1010 | } |
1011 | ||
1012 | break; | |
1013 | } | |
1014 | case LTTNG_CONSUMER_GET_CHANNEL: | |
1015 | { | |
1016 | int ret, relayd_err = 0; | |
d88aee68 | 1017 | uint64_t key = msg.u.get_channel.key; |
ffe60014 | 1018 | struct lttng_consumer_channel *channel; |
ffe60014 DG |
1019 | |
1020 | channel = consumer_find_channel(key); | |
1021 | if (!channel) { | |
8fd623e0 | 1022 | ERR("UST consumer get channel key %" PRIu64 " not found", key); |
ffe60014 DG |
1023 | ret_code = LTTNG_ERR_UST_CHAN_NOT_FOUND; |
1024 | goto end_msg_sessiond; | |
1025 | } | |
1026 | ||
ffe60014 DG |
1027 | /* Send everything to sessiond. */ |
1028 | ret = send_sessiond_channel(sock, channel, ctx, &relayd_err); | |
1029 | if (ret < 0) { | |
1030 | if (relayd_err) { | |
1031 | /* | |
1032 | * We were unable to send to the relayd the stream so avoid | |
1033 | * sending back a fatal error to the thread since this is OK | |
f2a444f1 DG |
1034 | * and the consumer can continue its work. The above call |
1035 | * has sent the error status message to the sessiond. | |
ffe60014 | 1036 | */ |
f2a444f1 | 1037 | goto end_nosignal; |
ffe60014 DG |
1038 | } |
1039 | /* | |
1040 | * The communicaton was broken hence there is a bad state between | |
1041 | * the consumer and sessiond so stop everything. | |
1042 | */ | |
1043 | goto error_fatal; | |
1044 | } | |
1045 | ||
d88aee68 DG |
1046 | ret = send_streams_to_thread(channel, ctx); |
1047 | if (ret < 0) { | |
1048 | /* | |
1049 | * If we are unable to send the stream to the thread, there is | |
1050 | * a big problem so just stop everything. | |
1051 | */ | |
1052 | goto error_fatal; | |
ffe60014 | 1053 | } |
ffe60014 DG |
1054 | /* List MUST be empty after or else it could be reused. */ |
1055 | assert(cds_list_empty(&channel->streams.head)); | |
1056 | ||
d88aee68 DG |
1057 | goto end_msg_sessiond; |
1058 | } | |
1059 | case LTTNG_CONSUMER_DESTROY_CHANNEL: | |
1060 | { | |
1061 | uint64_t key = msg.u.destroy_channel.key; | |
d88aee68 | 1062 | |
a0cbdd2e MD |
1063 | /* |
1064 | * Only called if streams have not been sent to stream | |
1065 | * manager thread. However, channel has been sent to | |
1066 | * channel manager thread. | |
1067 | */ | |
1068 | notify_thread_del_channel(ctx, key); | |
d88aee68 | 1069 | goto end_msg_sessiond; |
ffe60014 | 1070 | } |
d88aee68 DG |
1071 | case LTTNG_CONSUMER_CLOSE_METADATA: |
1072 | { | |
1073 | int ret; | |
1074 | ||
1075 | ret = close_metadata(msg.u.close_metadata.key); | |
1076 | if (ret != 0) { | |
1077 | ret_code = ret; | |
1078 | } | |
1079 | ||
1080 | goto end_msg_sessiond; | |
1081 | } | |
7972aab2 DG |
1082 | case LTTNG_CONSUMER_FLUSH_CHANNEL: |
1083 | { | |
1084 | int ret; | |
1085 | ||
1086 | ret = flush_channel(msg.u.flush_channel.key); | |
1087 | if (ret != 0) { | |
1088 | ret_code = ret; | |
1089 | } | |
1090 | ||
1091 | goto end_msg_sessiond; | |
1092 | } | |
d88aee68 | 1093 | case LTTNG_CONSUMER_PUSH_METADATA: |
ffe60014 DG |
1094 | { |
1095 | int ret; | |
d88aee68 | 1096 | uint64_t len = msg.u.push_metadata.len; |
d88aee68 | 1097 | uint64_t key = msg.u.push_metadata.key; |
331744e3 | 1098 | uint64_t offset = msg.u.push_metadata.target_offset; |
ffe60014 DG |
1099 | struct lttng_consumer_channel *channel; |
1100 | ||
8fd623e0 DG |
1101 | DBG("UST consumer push metadata key %" PRIu64 " of len %" PRIu64, key, |
1102 | len); | |
ffe60014 DG |
1103 | |
1104 | channel = consumer_find_channel(key); | |
1105 | if (!channel) { | |
8fd623e0 | 1106 | ERR("UST consumer push metadata %" PRIu64 " not found", key); |
ffe60014 | 1107 | ret_code = LTTNG_ERR_UST_CHAN_NOT_FOUND; |
4a2eb0ca | 1108 | goto end_msg_sessiond; |
d88aee68 DG |
1109 | } |
1110 | ||
1111 | /* Tell session daemon we are ready to receive the metadata. */ | |
ffe60014 DG |
1112 | ret = consumer_send_status_msg(sock, LTTNG_OK); |
1113 | if (ret < 0) { | |
1114 | /* Somehow, the session daemon is not responding anymore. */ | |
d88aee68 DG |
1115 | goto error_fatal; |
1116 | } | |
1117 | ||
1118 | /* Wait for more data. */ | |
1119 | if (lttng_consumer_poll_socket(consumer_sockpoll) < 0) { | |
489f70e9 | 1120 | goto error_fatal; |
d88aee68 DG |
1121 | } |
1122 | ||
331744e3 JD |
1123 | ret = lttng_ustconsumer_recv_metadata(sock, key, offset, |
1124 | len, channel); | |
d88aee68 | 1125 | if (ret < 0) { |
331744e3 | 1126 | /* error receiving from sessiond */ |
489f70e9 | 1127 | goto error_fatal; |
331744e3 JD |
1128 | } else { |
1129 | ret_code = ret; | |
d88aee68 DG |
1130 | goto end_msg_sessiond; |
1131 | } | |
d88aee68 DG |
1132 | } |
1133 | case LTTNG_CONSUMER_SETUP_METADATA: | |
1134 | { | |
1135 | int ret; | |
1136 | ||
1137 | ret = setup_metadata(ctx, msg.u.setup_metadata.key); | |
1138 | if (ret) { | |
1139 | ret_code = ret; | |
1140 | } | |
1141 | goto end_msg_sessiond; | |
ffe60014 | 1142 | } |
6dc3064a DG |
1143 | case LTTNG_CONSUMER_SNAPSHOT_CHANNEL: |
1144 | { | |
1145 | ret = consumer_send_status_msg(sock, ret_code); | |
1146 | if (ret < 0) { | |
1147 | /* Somehow, the session daemon is not responding anymore. */ | |
1148 | goto end_nosignal; | |
1149 | } | |
1150 | break; | |
1151 | } | |
3bd1e081 MD |
1152 | default: |
1153 | break; | |
1154 | } | |
3f8e211f | 1155 | |
3bd1e081 | 1156 | end_nosignal: |
b0b335c8 | 1157 | rcu_read_unlock(); |
4cbc1a04 DG |
1158 | |
1159 | /* | |
1160 | * Return 1 to indicate success since the 0 value can be a socket | |
1161 | * shutdown during the recv() or send() call. | |
1162 | */ | |
1163 | return 1; | |
ffe60014 DG |
1164 | |
1165 | end_msg_sessiond: | |
1166 | /* | |
1167 | * The returned value here is not useful since either way we'll return 1 to | |
1168 | * the caller because the session daemon socket management is done | |
1169 | * elsewhere. Returning a negative code or 0 will shutdown the consumer. | |
1170 | */ | |
489f70e9 MD |
1171 | ret = consumer_send_status_msg(sock, ret_code); |
1172 | if (ret < 0) { | |
1173 | goto error_fatal; | |
1174 | } | |
ffe60014 DG |
1175 | rcu_read_unlock(); |
1176 | return 1; | |
1177 | end_channel_error: | |
1178 | if (channel) { | |
1179 | /* | |
1180 | * Free channel here since no one has a reference to it. We don't | |
1181 | * free after that because a stream can store this pointer. | |
1182 | */ | |
1183 | destroy_channel(channel); | |
1184 | } | |
1185 | /* We have to send a status channel message indicating an error. */ | |
1186 | ret = consumer_send_status_channel(sock, NULL); | |
1187 | if (ret < 0) { | |
1188 | /* Stop everything if session daemon can not be notified. */ | |
1189 | goto error_fatal; | |
1190 | } | |
1191 | rcu_read_unlock(); | |
1192 | return 1; | |
1193 | error_fatal: | |
1194 | rcu_read_unlock(); | |
1195 | /* This will issue a consumer stop. */ | |
1196 | return -1; | |
3bd1e081 MD |
1197 | } |
1198 | ||
ffe60014 DG |
1199 | /* |
1200 | * Wrapper over the mmap() read offset from ust-ctl library. Since this can be | |
1201 | * compiled out, we isolate it in this library. | |
1202 | */ | |
1203 | int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream, | |
1204 | unsigned long *off) | |
3bd1e081 | 1205 | { |
ffe60014 DG |
1206 | assert(stream); |
1207 | assert(stream->ustream); | |
b5c5fc29 | 1208 | |
ffe60014 | 1209 | return ustctl_get_mmap_read_offset(stream->ustream, off); |
3bd1e081 MD |
1210 | } |
1211 | ||
ffe60014 DG |
1212 | /* |
1213 | * Wrapper over the mmap() read offset from ust-ctl library. Since this can be | |
1214 | * compiled out, we isolate it in this library. | |
1215 | */ | |
1216 | void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream *stream) | |
d056b477 | 1217 | { |
ffe60014 DG |
1218 | assert(stream); |
1219 | assert(stream->ustream); | |
1220 | ||
1221 | return ustctl_get_mmap_base(stream->ustream); | |
d056b477 MD |
1222 | } |
1223 | ||
ffe60014 DG |
1224 | /* |
1225 | * Take a snapshot for a specific fd | |
1226 | * | |
1227 | * Returns 0 on success, < 0 on error | |
1228 | */ | |
1229 | int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream) | |
3bd1e081 | 1230 | { |
ffe60014 DG |
1231 | assert(stream); |
1232 | assert(stream->ustream); | |
1233 | ||
1234 | return ustctl_snapshot(stream->ustream); | |
3bd1e081 MD |
1235 | } |
1236 | ||
ffe60014 DG |
1237 | /* |
1238 | * Get the produced position | |
1239 | * | |
1240 | * Returns 0 on success, < 0 on error | |
1241 | */ | |
1242 | int lttng_ustconsumer_get_produced_snapshot( | |
1243 | struct lttng_consumer_stream *stream, unsigned long *pos) | |
3bd1e081 | 1244 | { |
ffe60014 DG |
1245 | assert(stream); |
1246 | assert(stream->ustream); | |
1247 | assert(pos); | |
7a57cf92 | 1248 | |
ffe60014 DG |
1249 | return ustctl_snapshot_get_produced(stream->ustream, pos); |
1250 | } | |
7a57cf92 | 1251 | |
ffe60014 DG |
1252 | /* |
1253 | * Called when the stream signal the consumer that it has hang up. | |
1254 | */ | |
1255 | void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream) | |
1256 | { | |
1257 | assert(stream); | |
1258 | assert(stream->ustream); | |
2c1dd183 | 1259 | |
ffe60014 DG |
1260 | ustctl_flush_buffer(stream->ustream, 0); |
1261 | stream->hangup_flush_done = 1; | |
1262 | } | |
ee77a7b0 | 1263 | |
ffe60014 DG |
1264 | void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan) |
1265 | { | |
1266 | assert(chan); | |
1267 | assert(chan->uchan); | |
e316aad5 | 1268 | |
ea88ca2a MD |
1269 | if (chan->switch_timer_enabled == 1) { |
1270 | consumer_timer_switch_stop(chan); | |
1271 | } | |
1272 | consumer_metadata_cache_destroy(chan); | |
ffe60014 | 1273 | ustctl_destroy_channel(chan->uchan); |
3bd1e081 MD |
1274 | } |
1275 | ||
1276 | void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream) | |
1277 | { | |
ffe60014 DG |
1278 | assert(stream); |
1279 | assert(stream->ustream); | |
d41f73b7 | 1280 | |
ea88ca2a MD |
1281 | if (stream->chan->switch_timer_enabled == 1) { |
1282 | consumer_timer_switch_stop(stream->chan); | |
1283 | } | |
ffe60014 DG |
1284 | ustctl_destroy_stream(stream->ustream); |
1285 | } | |
d41f73b7 MD |
1286 | |
1287 | int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream, | |
1288 | struct lttng_consumer_local_data *ctx) | |
1289 | { | |
1d4dfdef | 1290 | unsigned long len, subbuf_size, padding; |
d41f73b7 MD |
1291 | int err; |
1292 | long ret = 0; | |
d41f73b7 | 1293 | char dummy; |
ffe60014 DG |
1294 | struct ustctl_consumer_stream *ustream; |
1295 | ||
1296 | assert(stream); | |
1297 | assert(stream->ustream); | |
1298 | assert(ctx); | |
d41f73b7 | 1299 | |
ffe60014 DG |
1300 | DBG2("In UST read_subbuffer (wait_fd: %d, name: %s)", stream->wait_fd, |
1301 | stream->name); | |
1302 | ||
1303 | /* Ease our life for what's next. */ | |
1304 | ustream = stream->ustream; | |
d41f73b7 MD |
1305 | |
1306 | /* We can consume the 1 byte written into the wait_fd by UST */ | |
effcf122 | 1307 | if (!stream->hangup_flush_done) { |
c617c0c6 MD |
1308 | ssize_t readlen; |
1309 | ||
effcf122 MD |
1310 | do { |
1311 | readlen = read(stream->wait_fd, &dummy, 1); | |
87dc6a9c | 1312 | } while (readlen == -1 && errno == EINTR); |
effcf122 MD |
1313 | if (readlen == -1) { |
1314 | ret = readlen; | |
1315 | goto end; | |
1316 | } | |
d41f73b7 MD |
1317 | } |
1318 | ||
d41f73b7 | 1319 | /* Get the next subbuffer */ |
ffe60014 | 1320 | err = ustctl_get_next_subbuf(ustream); |
d41f73b7 | 1321 | if (err != 0) { |
1d4dfdef | 1322 | ret = err; /* ustctl_get_next_subbuf returns negative, caller expect positive. */ |
d41f73b7 MD |
1323 | /* |
1324 | * This is a debug message even for single-threaded consumer, | |
1325 | * because poll() have more relaxed criterions than get subbuf, | |
1326 | * so get_subbuf may fail for short race windows where poll() | |
1327 | * would issue wakeups. | |
1328 | */ | |
1329 | DBG("Reserving sub buffer failed (everything is normal, " | |
ffe60014 | 1330 | "it is due to concurrency) [ret: %d]", err); |
d41f73b7 MD |
1331 | goto end; |
1332 | } | |
ffe60014 | 1333 | assert(stream->chan->output == CONSUMER_CHANNEL_MMAP); |
1d4dfdef | 1334 | /* Get the full padded subbuffer size */ |
ffe60014 | 1335 | err = ustctl_get_padded_subbuf_size(ustream, &len); |
effcf122 | 1336 | assert(err == 0); |
1d4dfdef DG |
1337 | |
1338 | /* Get subbuffer data size (without padding) */ | |
ffe60014 | 1339 | err = ustctl_get_subbuf_size(ustream, &subbuf_size); |
1d4dfdef DG |
1340 | assert(err == 0); |
1341 | ||
1342 | /* Make sure we don't get a subbuffer size bigger than the padded */ | |
1343 | assert(len >= subbuf_size); | |
1344 | ||
1345 | padding = len - subbuf_size; | |
d41f73b7 | 1346 | /* write the subbuffer to the tracefile */ |
1d4dfdef | 1347 | ret = lttng_consumer_on_read_subbuffer_mmap(ctx, stream, subbuf_size, padding); |
91dfef6e DG |
1348 | /* |
1349 | * The mmap operation should write subbuf_size amount of data when network | |
1350 | * streaming or the full padding (len) size when we are _not_ streaming. | |
1351 | */ | |
d88aee68 DG |
1352 | if ((ret != subbuf_size && stream->net_seq_idx != (uint64_t) -1ULL) || |
1353 | (ret != len && stream->net_seq_idx == (uint64_t) -1ULL)) { | |
d41f73b7 | 1354 | /* |
91dfef6e | 1355 | * Display the error but continue processing to try to release the |
c5c45efa DG |
1356 | * subbuffer. This is a DBG statement since any unexpected kill or |
1357 | * signal, the application gets unregistered, relayd gets closed or | |
1358 | * anything that affects the buffer lifetime will trigger this error. | |
1359 | * So, for the sake of the user, don't print this error since it can | |
1360 | * happen and it is OK with the code flow. | |
d41f73b7 | 1361 | */ |
c5c45efa | 1362 | DBG("Error writing to tracefile " |
8fd623e0 | 1363 | "(ret: %ld != len: %lu != subbuf_size: %lu)", |
91dfef6e | 1364 | ret, len, subbuf_size); |
d41f73b7 | 1365 | } |
ffe60014 | 1366 | err = ustctl_put_next_subbuf(ustream); |
effcf122 | 1367 | assert(err == 0); |
331744e3 | 1368 | |
d41f73b7 MD |
1369 | end: |
1370 | return ret; | |
1371 | } | |
1372 | ||
ffe60014 DG |
1373 | /* |
1374 | * Called when a stream is created. | |
fe4477ee JD |
1375 | * |
1376 | * Return 0 on success or else a negative value. | |
ffe60014 | 1377 | */ |
d41f73b7 MD |
1378 | int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream) |
1379 | { | |
fe4477ee JD |
1380 | int ret; |
1381 | ||
1382 | /* Don't create anything if this is set for streaming. */ | |
1383 | if (stream->net_seq_idx == (uint64_t) -1ULL) { | |
1384 | ret = utils_create_stream_file(stream->chan->pathname, stream->name, | |
1385 | stream->chan->tracefile_size, stream->tracefile_count_current, | |
1386 | stream->uid, stream->gid); | |
1387 | if (ret < 0) { | |
1388 | goto error; | |
1389 | } | |
1390 | stream->out_fd = ret; | |
1391 | stream->tracefile_size_current = 0; | |
1392 | } | |
1393 | ret = 0; | |
1394 | ||
1395 | error: | |
1396 | return ret; | |
d41f73b7 | 1397 | } |
ca22feea DG |
1398 | |
1399 | /* | |
1400 | * Check if data is still being extracted from the buffers for a specific | |
4e9a4686 DG |
1401 | * stream. Consumer data lock MUST be acquired before calling this function |
1402 | * and the stream lock. | |
ca22feea | 1403 | * |
6d805429 | 1404 | * Return 1 if the traced data are still getting read else 0 meaning that the |
ca22feea DG |
1405 | * data is available for trace viewer reading. |
1406 | */ | |
6d805429 | 1407 | int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream) |
ca22feea DG |
1408 | { |
1409 | int ret; | |
1410 | ||
1411 | assert(stream); | |
ffe60014 | 1412 | assert(stream->ustream); |
ca22feea | 1413 | |
6d805429 | 1414 | DBG("UST consumer checking data pending"); |
c8f59ee5 | 1415 | |
ffe60014 | 1416 | ret = ustctl_get_next_subbuf(stream->ustream); |
ca22feea DG |
1417 | if (ret == 0) { |
1418 | /* There is still data so let's put back this subbuffer. */ | |
ffe60014 | 1419 | ret = ustctl_put_subbuf(stream->ustream); |
ca22feea | 1420 | assert(ret == 0); |
6d805429 | 1421 | ret = 1; /* Data is pending */ |
4e9a4686 | 1422 | goto end; |
ca22feea DG |
1423 | } |
1424 | ||
6d805429 DG |
1425 | /* Data is NOT pending so ready to be read. */ |
1426 | ret = 0; | |
ca22feea | 1427 | |
6efae65e DG |
1428 | end: |
1429 | return ret; | |
ca22feea | 1430 | } |
d88aee68 DG |
1431 | |
1432 | /* | |
1433 | * Close every metadata stream wait fd of the metadata hash table. This | |
1434 | * function MUST be used very carefully so not to run into a race between the | |
1435 | * metadata thread handling streams and this function closing their wait fd. | |
1436 | * | |
1437 | * For UST, this is used when the session daemon hangs up. Its the metadata | |
1438 | * producer so calling this is safe because we are assured that no state change | |
1439 | * can occur in the metadata thread for the streams in the hash table. | |
1440 | */ | |
1441 | void lttng_ustconsumer_close_metadata(struct lttng_ht *metadata_ht) | |
1442 | { | |
1443 | int ret; | |
1444 | struct lttng_ht_iter iter; | |
1445 | struct lttng_consumer_stream *stream; | |
1446 | ||
1447 | assert(metadata_ht); | |
1448 | assert(metadata_ht->ht); | |
1449 | ||
1450 | DBG("UST consumer closing all metadata streams"); | |
1451 | ||
1452 | rcu_read_lock(); | |
1453 | cds_lfht_for_each_entry(metadata_ht->ht, &iter.iter, stream, | |
1454 | node.node) { | |
1455 | int fd = stream->wait_fd; | |
1456 | ||
1457 | /* | |
1458 | * Whatever happens here we have to continue to try to close every | |
1459 | * streams. Let's report at least the error on failure. | |
1460 | */ | |
1461 | ret = ustctl_stream_close_wakeup_fd(stream->ustream); | |
1462 | if (ret) { | |
1463 | ERR("Unable to close metadata stream fd %d ret %d", fd, ret); | |
1464 | } | |
1465 | DBG("Metadata wait fd %d closed", fd); | |
1466 | } | |
1467 | rcu_read_unlock(); | |
1468 | } | |
d8ef542d MD |
1469 | |
1470 | void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream) | |
1471 | { | |
1472 | int ret; | |
1473 | ||
1474 | ret = ustctl_stream_close_wakeup_fd(stream->ustream); | |
1475 | if (ret < 0) { | |
1476 | ERR("Unable to close wakeup fd"); | |
1477 | } | |
1478 | } | |
331744e3 JD |
1479 | |
1480 | int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx, | |
1481 | struct lttng_consumer_channel *channel) | |
1482 | { | |
1483 | struct lttcomm_metadata_request_msg request; | |
1484 | struct lttcomm_consumer_msg msg; | |
1485 | enum lttng_error_code ret_code = LTTNG_OK; | |
1486 | uint64_t len, key, offset; | |
1487 | int ret; | |
1488 | ||
1489 | assert(channel); | |
1490 | assert(channel->metadata_cache); | |
1491 | ||
1492 | /* send the metadata request to sessiond */ | |
1493 | switch (consumer_data.type) { | |
1494 | case LTTNG_CONSUMER64_UST: | |
1495 | request.bits_per_long = 64; | |
1496 | break; | |
1497 | case LTTNG_CONSUMER32_UST: | |
1498 | request.bits_per_long = 32; | |
1499 | break; | |
1500 | default: | |
1501 | request.bits_per_long = 0; | |
1502 | break; | |
1503 | } | |
1504 | ||
1505 | request.session_id = channel->session_id; | |
1950109e | 1506 | request.session_id_per_pid = channel->session_id_per_pid; |
331744e3 JD |
1507 | request.uid = channel->uid; |
1508 | request.key = channel->key; | |
1950109e JD |
1509 | DBG("Sending metadata request to sessiond, session id %" PRIu64 |
1510 | ", per-pid %" PRIu64, | |
1511 | channel->session_id, | |
1512 | channel->session_id_per_pid); | |
331744e3 JD |
1513 | |
1514 | ret = lttcomm_send_unix_sock(ctx->consumer_metadata_socket, &request, | |
1515 | sizeof(request)); | |
1516 | if (ret < 0) { | |
1517 | ERR("Asking metadata to sessiond"); | |
1518 | goto end; | |
1519 | } | |
1520 | ||
1521 | /* Receive the metadata from sessiond */ | |
1522 | ret = lttcomm_recv_unix_sock(ctx->consumer_metadata_socket, &msg, | |
1523 | sizeof(msg)); | |
1524 | if (ret != sizeof(msg)) { | |
8fd623e0 | 1525 | DBG("Consumer received unexpected message size %d (expects %zu)", |
331744e3 JD |
1526 | ret, sizeof(msg)); |
1527 | lttng_consumer_send_error(ctx, LTTCOMM_CONSUMERD_ERROR_RECV_CMD); | |
1528 | /* | |
1529 | * The ret value might 0 meaning an orderly shutdown but this is ok | |
1530 | * since the caller handles this. | |
1531 | */ | |
1532 | goto end; | |
1533 | } | |
1534 | ||
1535 | if (msg.cmd_type == LTTNG_ERR_UND) { | |
1536 | /* No registry found */ | |
1537 | (void) consumer_send_status_msg(ctx->consumer_metadata_socket, | |
1538 | ret_code); | |
1539 | ret = 0; | |
1540 | goto end; | |
1541 | } else if (msg.cmd_type != LTTNG_CONSUMER_PUSH_METADATA) { | |
1542 | ERR("Unexpected cmd_type received %d", msg.cmd_type); | |
1543 | ret = -1; | |
1544 | goto end; | |
1545 | } | |
1546 | ||
1547 | len = msg.u.push_metadata.len; | |
1548 | key = msg.u.push_metadata.key; | |
1549 | offset = msg.u.push_metadata.target_offset; | |
1550 | ||
1551 | assert(key == channel->key); | |
1552 | if (len == 0) { | |
1553 | DBG("No new metadata to receive for key %" PRIu64, key); | |
1554 | } | |
1555 | ||
1556 | /* Tell session daemon we are ready to receive the metadata. */ | |
1557 | ret = consumer_send_status_msg(ctx->consumer_metadata_socket, | |
1558 | LTTNG_OK); | |
1559 | if (ret < 0 || len == 0) { | |
1560 | /* | |
1561 | * Somehow, the session daemon is not responding anymore or there is | |
1562 | * nothing to receive. | |
1563 | */ | |
1564 | goto end; | |
1565 | } | |
1566 | ||
1567 | ret_code = lttng_ustconsumer_recv_metadata(ctx->consumer_metadata_socket, | |
1568 | key, offset, len, channel); | |
f2a444f1 DG |
1569 | if (ret_code >= 0) { |
1570 | /* | |
1571 | * Only send the status msg if the sessiond is alive meaning a positive | |
1572 | * ret code. | |
1573 | */ | |
1574 | (void) consumer_send_status_msg(ctx->consumer_metadata_socket, ret_code); | |
1575 | } | |
331744e3 JD |
1576 | ret = 0; |
1577 | ||
1578 | end: | |
1579 | return ret; | |
1580 | } |