2a810aba15fd2db25f4c47bf5d98bf3a70b0d607
[lttng-tools.git] / src / bin / lttng-sessiond / ust-app.c
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 *
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.
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 *
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.
17 */
18
19 #define _LGPL_SOURCE
20 #include <errno.h>
21 #include <inttypes.h>
22 #include <pthread.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <sys/stat.h>
27 #include <sys/types.h>
28 #include <unistd.h>
29 #include <urcu/compiler.h>
30 #include <lttng/ust-error.h>
31 #include <signal.h>
32
33 #include <common/common.h>
34 #include <common/sessiond-comm/sessiond-comm.h>
35
36 #include "buffer-registry.h"
37 #include "fd-limit.h"
38 #include "health-sessiond.h"
39 #include "ust-app.h"
40 #include "ust-consumer.h"
41 #include "ust-ctl.h"
42 #include "utils.h"
43 #include "session.h"
44 #include "lttng-sessiond.h"
45 #include "notification-thread-commands.h"
46 #include "rotate.h"
47
48 static
49 int ust_app_flush_app_session(struct ust_app *app, struct ust_app_session *ua_sess);
50
51 /* Next available channel key. Access under next_channel_key_lock. */
52 static uint64_t _next_channel_key;
53 static pthread_mutex_t next_channel_key_lock = PTHREAD_MUTEX_INITIALIZER;
54
55 /* Next available session ID. Access under next_session_id_lock. */
56 static uint64_t _next_session_id;
57 static pthread_mutex_t next_session_id_lock = PTHREAD_MUTEX_INITIALIZER;
58
59 /*
60 * Return the incremented value of next_channel_key.
61 */
62 static uint64_t get_next_channel_key(void)
63 {
64 uint64_t ret;
65
66 pthread_mutex_lock(&next_channel_key_lock);
67 ret = ++_next_channel_key;
68 pthread_mutex_unlock(&next_channel_key_lock);
69 return ret;
70 }
71
72 /*
73 * Return the atomically incremented value of next_session_id.
74 */
75 static uint64_t get_next_session_id(void)
76 {
77 uint64_t ret;
78
79 pthread_mutex_lock(&next_session_id_lock);
80 ret = ++_next_session_id;
81 pthread_mutex_unlock(&next_session_id_lock);
82 return ret;
83 }
84
85 static void copy_channel_attr_to_ustctl(
86 struct ustctl_consumer_channel_attr *attr,
87 struct lttng_ust_channel_attr *uattr)
88 {
89 /* Copy event attributes since the layout is different. */
90 attr->subbuf_size = uattr->subbuf_size;
91 attr->num_subbuf = uattr->num_subbuf;
92 attr->overwrite = uattr->overwrite;
93 attr->switch_timer_interval = uattr->switch_timer_interval;
94 attr->read_timer_interval = uattr->read_timer_interval;
95 attr->output = uattr->output;
96 attr->blocking_timeout = uattr->u.s.blocking_timeout;
97 }
98
99 /*
100 * Match function for the hash table lookup.
101 *
102 * It matches an ust app event based on three attributes which are the event
103 * name, the filter bytecode and the loglevel.
104 */
105 static int ht_match_ust_app_event(struct cds_lfht_node *node, const void *_key)
106 {
107 struct ust_app_event *event;
108 const struct ust_app_ht_key *key;
109 int ev_loglevel_value;
110
111 assert(node);
112 assert(_key);
113
114 event = caa_container_of(node, struct ust_app_event, node.node);
115 key = _key;
116 ev_loglevel_value = event->attr.loglevel;
117
118 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
119
120 /* Event name */
121 if (strncmp(event->attr.name, key->name, sizeof(event->attr.name)) != 0) {
122 goto no_match;
123 }
124
125 /* Event loglevel. */
126 if (ev_loglevel_value != key->loglevel_type) {
127 if (event->attr.loglevel_type == LTTNG_UST_LOGLEVEL_ALL
128 && key->loglevel_type == 0 &&
129 ev_loglevel_value == -1) {
130 /*
131 * Match is accepted. This is because on event creation, the
132 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
133 * -1 are accepted for this loglevel type since 0 is the one set by
134 * the API when receiving an enable event.
135 */
136 } else {
137 goto no_match;
138 }
139 }
140
141 /* One of the filters is NULL, fail. */
142 if ((key->filter && !event->filter) || (!key->filter && event->filter)) {
143 goto no_match;
144 }
145
146 if (key->filter && event->filter) {
147 /* Both filters exists, check length followed by the bytecode. */
148 if (event->filter->len != key->filter->len ||
149 memcmp(event->filter->data, key->filter->data,
150 event->filter->len) != 0) {
151 goto no_match;
152 }
153 }
154
155 /* One of the exclusions is NULL, fail. */
156 if ((key->exclusion && !event->exclusion) || (!key->exclusion && event->exclusion)) {
157 goto no_match;
158 }
159
160 if (key->exclusion && event->exclusion) {
161 /* Both exclusions exists, check count followed by the names. */
162 if (event->exclusion->count != key->exclusion->count ||
163 memcmp(event->exclusion->names, key->exclusion->names,
164 event->exclusion->count * LTTNG_UST_SYM_NAME_LEN) != 0) {
165 goto no_match;
166 }
167 }
168
169
170 /* Match. */
171 return 1;
172
173 no_match:
174 return 0;
175 }
176
177 /*
178 * Unique add of an ust app event in the given ht. This uses the custom
179 * ht_match_ust_app_event match function and the event name as hash.
180 */
181 static void add_unique_ust_app_event(struct ust_app_channel *ua_chan,
182 struct ust_app_event *event)
183 {
184 struct cds_lfht_node *node_ptr;
185 struct ust_app_ht_key key;
186 struct lttng_ht *ht;
187
188 assert(ua_chan);
189 assert(ua_chan->events);
190 assert(event);
191
192 ht = ua_chan->events;
193 key.name = event->attr.name;
194 key.filter = event->filter;
195 key.loglevel_type = event->attr.loglevel;
196 key.exclusion = event->exclusion;
197
198 node_ptr = cds_lfht_add_unique(ht->ht,
199 ht->hash_fct(event->node.key, lttng_ht_seed),
200 ht_match_ust_app_event, &key, &event->node.node);
201 assert(node_ptr == &event->node.node);
202 }
203
204 /*
205 * Close the notify socket from the given RCU head object. This MUST be called
206 * through a call_rcu().
207 */
208 static void close_notify_sock_rcu(struct rcu_head *head)
209 {
210 int ret;
211 struct ust_app_notify_sock_obj *obj =
212 caa_container_of(head, struct ust_app_notify_sock_obj, head);
213
214 /* Must have a valid fd here. */
215 assert(obj->fd >= 0);
216
217 ret = close(obj->fd);
218 if (ret) {
219 ERR("close notify sock %d RCU", obj->fd);
220 }
221 lttng_fd_put(LTTNG_FD_APPS, 1);
222
223 free(obj);
224 }
225
226 /*
227 * Return the session registry according to the buffer type of the given
228 * session.
229 *
230 * A registry per UID object MUST exists before calling this function or else
231 * it assert() if not found. RCU read side lock must be acquired.
232 */
233 static struct ust_registry_session *get_session_registry(
234 struct ust_app_session *ua_sess)
235 {
236 struct ust_registry_session *registry = NULL;
237
238 assert(ua_sess);
239
240 switch (ua_sess->buffer_type) {
241 case LTTNG_BUFFER_PER_PID:
242 {
243 struct buffer_reg_pid *reg_pid = buffer_reg_pid_find(ua_sess->id);
244 if (!reg_pid) {
245 goto error;
246 }
247 registry = reg_pid->registry->reg.ust;
248 break;
249 }
250 case LTTNG_BUFFER_PER_UID:
251 {
252 struct buffer_reg_uid *reg_uid = buffer_reg_uid_find(
253 ua_sess->tracing_id, ua_sess->bits_per_long, ua_sess->uid);
254 if (!reg_uid) {
255 goto error;
256 }
257 registry = reg_uid->registry->reg.ust;
258 break;
259 }
260 default:
261 assert(0);
262 };
263
264 error:
265 return registry;
266 }
267
268 /*
269 * Delete ust context safely. RCU read lock must be held before calling
270 * this function.
271 */
272 static
273 void delete_ust_app_ctx(int sock, struct ust_app_ctx *ua_ctx,
274 struct ust_app *app)
275 {
276 int ret;
277
278 assert(ua_ctx);
279
280 if (ua_ctx->obj) {
281 pthread_mutex_lock(&app->sock_lock);
282 ret = ustctl_release_object(sock, ua_ctx->obj);
283 pthread_mutex_unlock(&app->sock_lock);
284 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
285 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
286 sock, ua_ctx->obj->handle, ret);
287 }
288 free(ua_ctx->obj);
289 }
290 free(ua_ctx);
291 }
292
293 /*
294 * Delete ust app event safely. RCU read lock must be held before calling
295 * this function.
296 */
297 static
298 void delete_ust_app_event(int sock, struct ust_app_event *ua_event,
299 struct ust_app *app)
300 {
301 int ret;
302
303 assert(ua_event);
304
305 free(ua_event->filter);
306 if (ua_event->exclusion != NULL)
307 free(ua_event->exclusion);
308 if (ua_event->obj != NULL) {
309 pthread_mutex_lock(&app->sock_lock);
310 ret = ustctl_release_object(sock, ua_event->obj);
311 pthread_mutex_unlock(&app->sock_lock);
312 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
313 ERR("UST app sock %d release event obj failed with ret %d",
314 sock, ret);
315 }
316 free(ua_event->obj);
317 }
318 free(ua_event);
319 }
320
321 /*
322 * Release ust data object of the given stream.
323 *
324 * Return 0 on success or else a negative value.
325 */
326 static int release_ust_app_stream(int sock, struct ust_app_stream *stream,
327 struct ust_app *app)
328 {
329 int ret = 0;
330
331 assert(stream);
332
333 if (stream->obj) {
334 pthread_mutex_lock(&app->sock_lock);
335 ret = ustctl_release_object(sock, stream->obj);
336 pthread_mutex_unlock(&app->sock_lock);
337 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
338 ERR("UST app sock %d release stream obj failed with ret %d",
339 sock, ret);
340 }
341 lttng_fd_put(LTTNG_FD_APPS, 2);
342 free(stream->obj);
343 }
344
345 return ret;
346 }
347
348 /*
349 * Delete ust app stream safely. RCU read lock must be held before calling
350 * this function.
351 */
352 static
353 void delete_ust_app_stream(int sock, struct ust_app_stream *stream,
354 struct ust_app *app)
355 {
356 assert(stream);
357
358 (void) release_ust_app_stream(sock, stream, app);
359 free(stream);
360 }
361
362 /*
363 * We need to execute ht_destroy outside of RCU read-side critical
364 * section and outside of call_rcu thread, so we postpone its execution
365 * using ht_cleanup_push. It is simpler than to change the semantic of
366 * the many callers of delete_ust_app_session().
367 */
368 static
369 void delete_ust_app_channel_rcu(struct rcu_head *head)
370 {
371 struct ust_app_channel *ua_chan =
372 caa_container_of(head, struct ust_app_channel, rcu_head);
373
374 ht_cleanup_push(ua_chan->ctx);
375 ht_cleanup_push(ua_chan->events);
376 free(ua_chan);
377 }
378
379 /*
380 * Extract the lost packet or discarded events counter when the channel is
381 * being deleted and store the value in the parent channel so we can
382 * access it from lttng list and at stop/destroy.
383 *
384 * The session list lock must be held by the caller.
385 */
386 static
387 void save_per_pid_lost_discarded_counters(struct ust_app_channel *ua_chan)
388 {
389 uint64_t discarded = 0, lost = 0;
390 struct ltt_session *session;
391 struct ltt_ust_channel *uchan;
392
393 if (ua_chan->attr.type != LTTNG_UST_CHAN_PER_CPU) {
394 return;
395 }
396
397 rcu_read_lock();
398 session = session_find_by_id(ua_chan->session->tracing_id);
399 if (!session || !session->ust_session) {
400 /*
401 * Not finding the session is not an error because there are
402 * multiple ways the channels can be torn down.
403 *
404 * 1) The session daemon can initiate the destruction of the
405 * ust app session after receiving a destroy command or
406 * during its shutdown/teardown.
407 * 2) The application, since we are in per-pid tracing, is
408 * unregistering and tearing down its ust app session.
409 *
410 * Both paths are protected by the session list lock which
411 * ensures that the accounting of lost packets and discarded
412 * events is done exactly once. The session is then unpublished
413 * from the session list, resulting in this condition.
414 */
415 goto end;
416 }
417
418 if (ua_chan->attr.overwrite) {
419 consumer_get_lost_packets(ua_chan->session->tracing_id,
420 ua_chan->key, session->ust_session->consumer,
421 &lost);
422 } else {
423 consumer_get_discarded_events(ua_chan->session->tracing_id,
424 ua_chan->key, session->ust_session->consumer,
425 &discarded);
426 }
427 uchan = trace_ust_find_channel_by_name(
428 session->ust_session->domain_global.channels,
429 ua_chan->name);
430 if (!uchan) {
431 ERR("Missing UST channel to store discarded counters");
432 goto end;
433 }
434
435 uchan->per_pid_closed_app_discarded += discarded;
436 uchan->per_pid_closed_app_lost += lost;
437
438 end:
439 rcu_read_unlock();
440 }
441
442 /*
443 * Delete ust app channel safely. RCU read lock must be held before calling
444 * this function.
445 *
446 * The session list lock must be held by the caller.
447 */
448 static
449 void delete_ust_app_channel(int sock, struct ust_app_channel *ua_chan,
450 struct ust_app *app)
451 {
452 int ret;
453 struct lttng_ht_iter iter;
454 struct ust_app_event *ua_event;
455 struct ust_app_ctx *ua_ctx;
456 struct ust_app_stream *stream, *stmp;
457 struct ust_registry_session *registry;
458
459 assert(ua_chan);
460
461 DBG3("UST app deleting channel %s", ua_chan->name);
462
463 /* Wipe stream */
464 cds_list_for_each_entry_safe(stream, stmp, &ua_chan->streams.head, list) {
465 cds_list_del(&stream->list);
466 delete_ust_app_stream(sock, stream, app);
467 }
468
469 /* Wipe context */
470 cds_lfht_for_each_entry(ua_chan->ctx->ht, &iter.iter, ua_ctx, node.node) {
471 cds_list_del(&ua_ctx->list);
472 ret = lttng_ht_del(ua_chan->ctx, &iter);
473 assert(!ret);
474 delete_ust_app_ctx(sock, ua_ctx, app);
475 }
476
477 /* Wipe events */
478 cds_lfht_for_each_entry(ua_chan->events->ht, &iter.iter, ua_event,
479 node.node) {
480 ret = lttng_ht_del(ua_chan->events, &iter);
481 assert(!ret);
482 delete_ust_app_event(sock, ua_event, app);
483 }
484
485 if (ua_chan->session->buffer_type == LTTNG_BUFFER_PER_PID) {
486 /* Wipe and free registry from session registry. */
487 registry = get_session_registry(ua_chan->session);
488 if (registry) {
489 ust_registry_channel_del_free(registry, ua_chan->key,
490 true);
491 }
492 save_per_pid_lost_discarded_counters(ua_chan);
493 }
494
495 if (ua_chan->obj != NULL) {
496 /* Remove channel from application UST object descriptor. */
497 iter.iter.node = &ua_chan->ust_objd_node.node;
498 ret = lttng_ht_del(app->ust_objd, &iter);
499 assert(!ret);
500 pthread_mutex_lock(&app->sock_lock);
501 ret = ustctl_release_object(sock, ua_chan->obj);
502 pthread_mutex_unlock(&app->sock_lock);
503 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
504 ERR("UST app sock %d release channel obj failed with ret %d",
505 sock, ret);
506 }
507 lttng_fd_put(LTTNG_FD_APPS, 1);
508 free(ua_chan->obj);
509 }
510 call_rcu(&ua_chan->rcu_head, delete_ust_app_channel_rcu);
511 }
512
513 int ust_app_register_done(struct ust_app *app)
514 {
515 int ret;
516
517 pthread_mutex_lock(&app->sock_lock);
518 ret = ustctl_register_done(app->sock);
519 pthread_mutex_unlock(&app->sock_lock);
520 return ret;
521 }
522
523 int ust_app_release_object(struct ust_app *app, struct lttng_ust_object_data *data)
524 {
525 int ret, sock;
526
527 if (app) {
528 pthread_mutex_lock(&app->sock_lock);
529 sock = app->sock;
530 } else {
531 sock = -1;
532 }
533 ret = ustctl_release_object(sock, data);
534 if (app) {
535 pthread_mutex_unlock(&app->sock_lock);
536 }
537 return ret;
538 }
539
540 /*
541 * Push metadata to consumer socket.
542 *
543 * RCU read-side lock must be held to guarantee existance of socket.
544 * Must be called with the ust app session lock held.
545 * Must be called with the registry lock held.
546 *
547 * On success, return the len of metadata pushed or else a negative value.
548 * Returning a -EPIPE return value means we could not send the metadata,
549 * but it can be caused by recoverable errors (e.g. the application has
550 * terminated concurrently).
551 */
552 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
553 struct consumer_socket *socket, int send_zero_data)
554 {
555 int ret;
556 char *metadata_str = NULL;
557 size_t len, offset, new_metadata_len_sent;
558 ssize_t ret_val;
559 uint64_t metadata_key, metadata_version;
560
561 assert(registry);
562 assert(socket);
563
564 metadata_key = registry->metadata_key;
565
566 /*
567 * Means that no metadata was assigned to the session. This can
568 * happens if no start has been done previously.
569 */
570 if (!metadata_key) {
571 return 0;
572 }
573
574 offset = registry->metadata_len_sent;
575 len = registry->metadata_len - registry->metadata_len_sent;
576 new_metadata_len_sent = registry->metadata_len;
577 metadata_version = registry->metadata_version;
578 if (len == 0) {
579 DBG3("No metadata to push for metadata key %" PRIu64,
580 registry->metadata_key);
581 ret_val = len;
582 if (send_zero_data) {
583 DBG("No metadata to push");
584 goto push_data;
585 }
586 goto end;
587 }
588
589 /* Allocate only what we have to send. */
590 metadata_str = zmalloc(len);
591 if (!metadata_str) {
592 PERROR("zmalloc ust app metadata string");
593 ret_val = -ENOMEM;
594 goto error;
595 }
596 /* Copy what we haven't sent out. */
597 memcpy(metadata_str, registry->metadata + offset, len);
598
599 push_data:
600 pthread_mutex_unlock(&registry->lock);
601 /*
602 * We need to unlock the registry while we push metadata to
603 * break a circular dependency between the consumerd metadata
604 * lock and the sessiond registry lock. Indeed, pushing metadata
605 * to the consumerd awaits that it gets pushed all the way to
606 * relayd, but doing so requires grabbing the metadata lock. If
607 * a concurrent metadata request is being performed by
608 * consumerd, this can try to grab the registry lock on the
609 * sessiond while holding the metadata lock on the consumer
610 * daemon. Those push and pull schemes are performed on two
611 * different bidirectionnal communication sockets.
612 */
613 ret = consumer_push_metadata(socket, metadata_key,
614 metadata_str, len, offset, metadata_version);
615 pthread_mutex_lock(&registry->lock);
616 if (ret < 0) {
617 /*
618 * There is an acceptable race here between the registry
619 * metadata key assignment and the creation on the
620 * consumer. The session daemon can concurrently push
621 * metadata for this registry while being created on the
622 * consumer since the metadata key of the registry is
623 * assigned *before* it is setup to avoid the consumer
624 * to ask for metadata that could possibly be not found
625 * in the session daemon.
626 *
627 * The metadata will get pushed either by the session
628 * being stopped or the consumer requesting metadata if
629 * that race is triggered.
630 */
631 if (ret == -LTTCOMM_CONSUMERD_CHANNEL_FAIL) {
632 ret = 0;
633 } else {
634 ERR("Error pushing metadata to consumer");
635 }
636 ret_val = ret;
637 goto error_push;
638 } else {
639 /*
640 * Metadata may have been concurrently pushed, since
641 * we're not holding the registry lock while pushing to
642 * consumer. This is handled by the fact that we send
643 * the metadata content, size, and the offset at which
644 * that metadata belongs. This may arrive out of order
645 * on the consumer side, and the consumer is able to
646 * deal with overlapping fragments. The consumer
647 * supports overlapping fragments, which must be
648 * contiguous starting from offset 0. We keep the
649 * largest metadata_len_sent value of the concurrent
650 * send.
651 */
652 registry->metadata_len_sent =
653 max_t(size_t, registry->metadata_len_sent,
654 new_metadata_len_sent);
655 }
656 free(metadata_str);
657 return len;
658
659 end:
660 error:
661 if (ret_val) {
662 /*
663 * On error, flag the registry that the metadata is
664 * closed. We were unable to push anything and this
665 * means that either the consumer is not responding or
666 * the metadata cache has been destroyed on the
667 * consumer.
668 */
669 registry->metadata_closed = 1;
670 }
671 error_push:
672 free(metadata_str);
673 return ret_val;
674 }
675
676 /*
677 * For a given application and session, push metadata to consumer.
678 * Either sock or consumer is required : if sock is NULL, the default
679 * socket to send the metadata is retrieved from consumer, if sock
680 * is not NULL we use it to send the metadata.
681 * RCU read-side lock must be held while calling this function,
682 * therefore ensuring existance of registry. It also ensures existance
683 * of socket throughout this function.
684 *
685 * Return 0 on success else a negative error.
686 * Returning a -EPIPE return value means we could not send the metadata,
687 * but it can be caused by recoverable errors (e.g. the application has
688 * terminated concurrently).
689 */
690 static int push_metadata(struct ust_registry_session *registry,
691 struct consumer_output *consumer)
692 {
693 int ret_val;
694 ssize_t ret;
695 struct consumer_socket *socket;
696
697 assert(registry);
698 assert(consumer);
699
700 pthread_mutex_lock(&registry->lock);
701 if (registry->metadata_closed) {
702 ret_val = -EPIPE;
703 goto error;
704 }
705
706 /* Get consumer socket to use to push the metadata.*/
707 socket = consumer_find_socket_by_bitness(registry->bits_per_long,
708 consumer);
709 if (!socket) {
710 ret_val = -1;
711 goto error;
712 }
713
714 ret = ust_app_push_metadata(registry, socket, 0);
715 if (ret < 0) {
716 ret_val = ret;
717 goto error;
718 }
719 pthread_mutex_unlock(&registry->lock);
720 return 0;
721
722 error:
723 pthread_mutex_unlock(&registry->lock);
724 return ret_val;
725 }
726
727 /*
728 * Send to the consumer a close metadata command for the given session. Once
729 * done, the metadata channel is deleted and the session metadata pointer is
730 * nullified. The session lock MUST be held unless the application is
731 * in the destroy path.
732 *
733 * Return 0 on success else a negative value.
734 */
735 static int close_metadata(struct ust_registry_session *registry,
736 struct consumer_output *consumer)
737 {
738 int ret;
739 struct consumer_socket *socket;
740
741 assert(registry);
742 assert(consumer);
743
744 rcu_read_lock();
745
746 pthread_mutex_lock(&registry->lock);
747
748 if (!registry->metadata_key || registry->metadata_closed) {
749 ret = 0;
750 goto end;
751 }
752
753 /* Get consumer socket to use to push the metadata.*/
754 socket = consumer_find_socket_by_bitness(registry->bits_per_long,
755 consumer);
756 if (!socket) {
757 ret = -1;
758 goto error;
759 }
760
761 ret = consumer_close_metadata(socket, registry->metadata_key);
762 if (ret < 0) {
763 goto error;
764 }
765
766 error:
767 /*
768 * Metadata closed. Even on error this means that the consumer is not
769 * responding or not found so either way a second close should NOT be emit
770 * for this registry.
771 */
772 registry->metadata_closed = 1;
773 end:
774 pthread_mutex_unlock(&registry->lock);
775 rcu_read_unlock();
776 return ret;
777 }
778
779 /*
780 * We need to execute ht_destroy outside of RCU read-side critical
781 * section and outside of call_rcu thread, so we postpone its execution
782 * using ht_cleanup_push. It is simpler than to change the semantic of
783 * the many callers of delete_ust_app_session().
784 */
785 static
786 void delete_ust_app_session_rcu(struct rcu_head *head)
787 {
788 struct ust_app_session *ua_sess =
789 caa_container_of(head, struct ust_app_session, rcu_head);
790
791 ht_cleanup_push(ua_sess->channels);
792 free(ua_sess);
793 }
794
795 /*
796 * Delete ust app session safely. RCU read lock must be held before calling
797 * this function.
798 *
799 * The session list lock must be held by the caller.
800 */
801 static
802 void delete_ust_app_session(int sock, struct ust_app_session *ua_sess,
803 struct ust_app *app)
804 {
805 int ret;
806 struct lttng_ht_iter iter;
807 struct ust_app_channel *ua_chan;
808 struct ust_registry_session *registry;
809
810 assert(ua_sess);
811
812 pthread_mutex_lock(&ua_sess->lock);
813
814 assert(!ua_sess->deleted);
815 ua_sess->deleted = true;
816
817 registry = get_session_registry(ua_sess);
818 /* Registry can be null on error path during initialization. */
819 if (registry) {
820 /* Push metadata for application before freeing the application. */
821 (void) push_metadata(registry, ua_sess->consumer);
822
823 /*
824 * Don't ask to close metadata for global per UID buffers. Close
825 * metadata only on destroy trace session in this case. Also, the
826 * previous push metadata could have flag the metadata registry to
827 * close so don't send a close command if closed.
828 */
829 if (ua_sess->buffer_type != LTTNG_BUFFER_PER_UID) {
830 /* And ask to close it for this session registry. */
831 (void) close_metadata(registry, ua_sess->consumer);
832 }
833 }
834
835 cds_lfht_for_each_entry(ua_sess->channels->ht, &iter.iter, ua_chan,
836 node.node) {
837 ret = lttng_ht_del(ua_sess->channels, &iter);
838 assert(!ret);
839 delete_ust_app_channel(sock, ua_chan, app);
840 }
841
842 /* In case of per PID, the registry is kept in the session. */
843 if (ua_sess->buffer_type == LTTNG_BUFFER_PER_PID) {
844 struct buffer_reg_pid *reg_pid = buffer_reg_pid_find(ua_sess->id);
845 if (reg_pid) {
846 /*
847 * Registry can be null on error path during
848 * initialization.
849 */
850 buffer_reg_pid_remove(reg_pid);
851 buffer_reg_pid_destroy(reg_pid);
852 }
853 }
854
855 if (ua_sess->handle != -1) {
856 pthread_mutex_lock(&app->sock_lock);
857 ret = ustctl_release_handle(sock, ua_sess->handle);
858 pthread_mutex_unlock(&app->sock_lock);
859 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
860 ERR("UST app sock %d release session handle failed with ret %d",
861 sock, ret);
862 }
863 /* Remove session from application UST object descriptor. */
864 iter.iter.node = &ua_sess->ust_objd_node.node;
865 ret = lttng_ht_del(app->ust_sessions_objd, &iter);
866 assert(!ret);
867 }
868
869 pthread_mutex_unlock(&ua_sess->lock);
870
871 consumer_output_put(ua_sess->consumer);
872
873 call_rcu(&ua_sess->rcu_head, delete_ust_app_session_rcu);
874 }
875
876 /*
877 * Delete a traceable application structure from the global list. Never call
878 * this function outside of a call_rcu call.
879 *
880 * RCU read side lock should _NOT_ be held when calling this function.
881 */
882 static
883 void delete_ust_app(struct ust_app *app)
884 {
885 int ret, sock;
886 struct ust_app_session *ua_sess, *tmp_ua_sess;
887
888 /*
889 * The session list lock must be held during this function to guarantee
890 * the existence of ua_sess.
891 */
892 session_lock_list();
893 /* Delete ust app sessions info */
894 sock = app->sock;
895 app->sock = -1;
896
897 /* Wipe sessions */
898 cds_list_for_each_entry_safe(ua_sess, tmp_ua_sess, &app->teardown_head,
899 teardown_node) {
900 /* Free every object in the session and the session. */
901 rcu_read_lock();
902 delete_ust_app_session(sock, ua_sess, app);
903 rcu_read_unlock();
904 }
905
906 ht_cleanup_push(app->sessions);
907 ht_cleanup_push(app->ust_sessions_objd);
908 ht_cleanup_push(app->ust_objd);
909
910 /*
911 * Wait until we have deleted the application from the sock hash table
912 * before closing this socket, otherwise an application could re-use the
913 * socket ID and race with the teardown, using the same hash table entry.
914 *
915 * It's OK to leave the close in call_rcu. We want it to stay unique for
916 * all RCU readers that could run concurrently with unregister app,
917 * therefore we _need_ to only close that socket after a grace period. So
918 * it should stay in this RCU callback.
919 *
920 * This close() is a very important step of the synchronization model so
921 * every modification to this function must be carefully reviewed.
922 */
923 ret = close(sock);
924 if (ret) {
925 PERROR("close");
926 }
927 lttng_fd_put(LTTNG_FD_APPS, 1);
928
929 DBG2("UST app pid %d deleted", app->pid);
930 free(app);
931 session_unlock_list();
932 }
933
934 /*
935 * URCU intermediate call to delete an UST app.
936 */
937 static
938 void delete_ust_app_rcu(struct rcu_head *head)
939 {
940 struct lttng_ht_node_ulong *node =
941 caa_container_of(head, struct lttng_ht_node_ulong, head);
942 struct ust_app *app =
943 caa_container_of(node, struct ust_app, pid_n);
944
945 DBG3("Call RCU deleting app PID %d", app->pid);
946 delete_ust_app(app);
947 }
948
949 /*
950 * Delete the session from the application ht and delete the data structure by
951 * freeing every object inside and releasing them.
952 *
953 * The session list lock must be held by the caller.
954 */
955 static void destroy_app_session(struct ust_app *app,
956 struct ust_app_session *ua_sess)
957 {
958 int ret;
959 struct lttng_ht_iter iter;
960
961 assert(app);
962 assert(ua_sess);
963
964 iter.iter.node = &ua_sess->node.node;
965 ret = lttng_ht_del(app->sessions, &iter);
966 if (ret) {
967 /* Already scheduled for teardown. */
968 goto end;
969 }
970
971 /* Once deleted, free the data structure. */
972 delete_ust_app_session(app->sock, ua_sess, app);
973
974 end:
975 return;
976 }
977
978 /*
979 * Alloc new UST app session.
980 */
981 static
982 struct ust_app_session *alloc_ust_app_session(void)
983 {
984 struct ust_app_session *ua_sess;
985
986 /* Init most of the default value by allocating and zeroing */
987 ua_sess = zmalloc(sizeof(struct ust_app_session));
988 if (ua_sess == NULL) {
989 PERROR("malloc");
990 goto error_free;
991 }
992
993 ua_sess->handle = -1;
994 ua_sess->channels = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
995 ua_sess->metadata_attr.type = LTTNG_UST_CHAN_METADATA;
996 pthread_mutex_init(&ua_sess->lock, NULL);
997
998 return ua_sess;
999
1000 error_free:
1001 return NULL;
1002 }
1003
1004 /*
1005 * Alloc new UST app channel.
1006 */
1007 static
1008 struct ust_app_channel *alloc_ust_app_channel(char *name,
1009 struct ust_app_session *ua_sess,
1010 struct lttng_ust_channel_attr *attr)
1011 {
1012 struct ust_app_channel *ua_chan;
1013
1014 /* Init most of the default value by allocating and zeroing */
1015 ua_chan = zmalloc(sizeof(struct ust_app_channel));
1016 if (ua_chan == NULL) {
1017 PERROR("malloc");
1018 goto error;
1019 }
1020
1021 /* Setup channel name */
1022 strncpy(ua_chan->name, name, sizeof(ua_chan->name));
1023 ua_chan->name[sizeof(ua_chan->name) - 1] = '\0';
1024
1025 ua_chan->enabled = 1;
1026 ua_chan->handle = -1;
1027 ua_chan->session = ua_sess;
1028 ua_chan->key = get_next_channel_key();
1029 ua_chan->ctx = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
1030 ua_chan->events = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
1031 lttng_ht_node_init_str(&ua_chan->node, ua_chan->name);
1032
1033 CDS_INIT_LIST_HEAD(&ua_chan->streams.head);
1034 CDS_INIT_LIST_HEAD(&ua_chan->ctx_list);
1035
1036 /* Copy attributes */
1037 if (attr) {
1038 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
1039 ua_chan->attr.subbuf_size = attr->subbuf_size;
1040 ua_chan->attr.num_subbuf = attr->num_subbuf;
1041 ua_chan->attr.overwrite = attr->overwrite;
1042 ua_chan->attr.switch_timer_interval = attr->switch_timer_interval;
1043 ua_chan->attr.read_timer_interval = attr->read_timer_interval;
1044 ua_chan->attr.output = attr->output;
1045 ua_chan->attr.blocking_timeout = attr->u.s.blocking_timeout;
1046 }
1047 /* By default, the channel is a per cpu channel. */
1048 ua_chan->attr.type = LTTNG_UST_CHAN_PER_CPU;
1049
1050 DBG3("UST app channel %s allocated", ua_chan->name);
1051
1052 return ua_chan;
1053
1054 error:
1055 return NULL;
1056 }
1057
1058 /*
1059 * Allocate and initialize a UST app stream.
1060 *
1061 * Return newly allocated stream pointer or NULL on error.
1062 */
1063 struct ust_app_stream *ust_app_alloc_stream(void)
1064 {
1065 struct ust_app_stream *stream = NULL;
1066
1067 stream = zmalloc(sizeof(*stream));
1068 if (stream == NULL) {
1069 PERROR("zmalloc ust app stream");
1070 goto error;
1071 }
1072
1073 /* Zero could be a valid value for a handle so flag it to -1. */
1074 stream->handle = -1;
1075
1076 error:
1077 return stream;
1078 }
1079
1080 /*
1081 * Alloc new UST app event.
1082 */
1083 static
1084 struct ust_app_event *alloc_ust_app_event(char *name,
1085 struct lttng_ust_event *attr)
1086 {
1087 struct ust_app_event *ua_event;
1088
1089 /* Init most of the default value by allocating and zeroing */
1090 ua_event = zmalloc(sizeof(struct ust_app_event));
1091 if (ua_event == NULL) {
1092 PERROR("malloc");
1093 goto error;
1094 }
1095
1096 ua_event->enabled = 1;
1097 strncpy(ua_event->name, name, sizeof(ua_event->name));
1098 ua_event->name[sizeof(ua_event->name) - 1] = '\0';
1099 lttng_ht_node_init_str(&ua_event->node, ua_event->name);
1100
1101 /* Copy attributes */
1102 if (attr) {
1103 memcpy(&ua_event->attr, attr, sizeof(ua_event->attr));
1104 }
1105
1106 DBG3("UST app event %s allocated", ua_event->name);
1107
1108 return ua_event;
1109
1110 error:
1111 return NULL;
1112 }
1113
1114 /*
1115 * Alloc new UST app context.
1116 */
1117 static
1118 struct ust_app_ctx *alloc_ust_app_ctx(struct lttng_ust_context_attr *uctx)
1119 {
1120 struct ust_app_ctx *ua_ctx;
1121
1122 ua_ctx = zmalloc(sizeof(struct ust_app_ctx));
1123 if (ua_ctx == NULL) {
1124 goto error;
1125 }
1126
1127 CDS_INIT_LIST_HEAD(&ua_ctx->list);
1128
1129 if (uctx) {
1130 memcpy(&ua_ctx->ctx, uctx, sizeof(ua_ctx->ctx));
1131 if (uctx->ctx == LTTNG_UST_CONTEXT_APP_CONTEXT) {
1132 char *provider_name = NULL, *ctx_name = NULL;
1133
1134 provider_name = strdup(uctx->u.app_ctx.provider_name);
1135 ctx_name = strdup(uctx->u.app_ctx.ctx_name);
1136 if (!provider_name || !ctx_name) {
1137 free(provider_name);
1138 free(ctx_name);
1139 goto error;
1140 }
1141
1142 ua_ctx->ctx.u.app_ctx.provider_name = provider_name;
1143 ua_ctx->ctx.u.app_ctx.ctx_name = ctx_name;
1144 }
1145 }
1146
1147 DBG3("UST app context %d allocated", ua_ctx->ctx.ctx);
1148 return ua_ctx;
1149 error:
1150 free(ua_ctx);
1151 return NULL;
1152 }
1153
1154 /*
1155 * Allocate a filter and copy the given original filter.
1156 *
1157 * Return allocated filter or NULL on error.
1158 */
1159 static struct lttng_filter_bytecode *copy_filter_bytecode(
1160 struct lttng_filter_bytecode *orig_f)
1161 {
1162 struct lttng_filter_bytecode *filter = NULL;
1163
1164 /* Copy filter bytecode */
1165 filter = zmalloc(sizeof(*filter) + orig_f->len);
1166 if (!filter) {
1167 PERROR("zmalloc alloc filter bytecode");
1168 goto error;
1169 }
1170
1171 memcpy(filter, orig_f, sizeof(*filter) + orig_f->len);
1172
1173 error:
1174 return filter;
1175 }
1176
1177 /*
1178 * Create a liblttng-ust filter bytecode from given bytecode.
1179 *
1180 * Return allocated filter or NULL on error.
1181 */
1182 static struct lttng_ust_filter_bytecode *create_ust_bytecode_from_bytecode(
1183 struct lttng_filter_bytecode *orig_f)
1184 {
1185 struct lttng_ust_filter_bytecode *filter = NULL;
1186
1187 /* Copy filter bytecode */
1188 filter = zmalloc(sizeof(*filter) + orig_f->len);
1189 if (!filter) {
1190 PERROR("zmalloc alloc ust filter bytecode");
1191 goto error;
1192 }
1193
1194 assert(sizeof(struct lttng_filter_bytecode) ==
1195 sizeof(struct lttng_ust_filter_bytecode));
1196 memcpy(filter, orig_f, sizeof(*filter) + orig_f->len);
1197 error:
1198 return filter;
1199 }
1200
1201 /*
1202 * Find an ust_app using the sock and return it. RCU read side lock must be
1203 * held before calling this helper function.
1204 */
1205 struct ust_app *ust_app_find_by_sock(int sock)
1206 {
1207 struct lttng_ht_node_ulong *node;
1208 struct lttng_ht_iter iter;
1209
1210 lttng_ht_lookup(ust_app_ht_by_sock, (void *)((unsigned long) sock), &iter);
1211 node = lttng_ht_iter_get_node_ulong(&iter);
1212 if (node == NULL) {
1213 DBG2("UST app find by sock %d not found", sock);
1214 goto error;
1215 }
1216
1217 return caa_container_of(node, struct ust_app, sock_n);
1218
1219 error:
1220 return NULL;
1221 }
1222
1223 /*
1224 * Find an ust_app using the notify sock and return it. RCU read side lock must
1225 * be held before calling this helper function.
1226 */
1227 static struct ust_app *find_app_by_notify_sock(int sock)
1228 {
1229 struct lttng_ht_node_ulong *node;
1230 struct lttng_ht_iter iter;
1231
1232 lttng_ht_lookup(ust_app_ht_by_notify_sock, (void *)((unsigned long) sock),
1233 &iter);
1234 node = lttng_ht_iter_get_node_ulong(&iter);
1235 if (node == NULL) {
1236 DBG2("UST app find by notify sock %d not found", sock);
1237 goto error;
1238 }
1239
1240 return caa_container_of(node, struct ust_app, notify_sock_n);
1241
1242 error:
1243 return NULL;
1244 }
1245
1246 /*
1247 * Lookup for an ust app event based on event name, filter bytecode and the
1248 * event loglevel.
1249 *
1250 * Return an ust_app_event object or NULL on error.
1251 */
1252 static struct ust_app_event *find_ust_app_event(struct lttng_ht *ht,
1253 char *name, struct lttng_filter_bytecode *filter,
1254 int loglevel_value,
1255 const struct lttng_event_exclusion *exclusion)
1256 {
1257 struct lttng_ht_iter iter;
1258 struct lttng_ht_node_str *node;
1259 struct ust_app_event *event = NULL;
1260 struct ust_app_ht_key key;
1261
1262 assert(name);
1263 assert(ht);
1264
1265 /* Setup key for event lookup. */
1266 key.name = name;
1267 key.filter = filter;
1268 key.loglevel_type = loglevel_value;
1269 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1270 key.exclusion = exclusion;
1271
1272 /* Lookup using the event name as hash and a custom match fct. */
1273 cds_lfht_lookup(ht->ht, ht->hash_fct((void *) name, lttng_ht_seed),
1274 ht_match_ust_app_event, &key, &iter.iter);
1275 node = lttng_ht_iter_get_node_str(&iter);
1276 if (node == NULL) {
1277 goto end;
1278 }
1279
1280 event = caa_container_of(node, struct ust_app_event, node);
1281
1282 end:
1283 return event;
1284 }
1285
1286 /*
1287 * Create the channel context on the tracer.
1288 *
1289 * Called with UST app session lock held.
1290 */
1291 static
1292 int create_ust_channel_context(struct ust_app_channel *ua_chan,
1293 struct ust_app_ctx *ua_ctx, struct ust_app *app)
1294 {
1295 int ret;
1296
1297 health_code_update();
1298
1299 pthread_mutex_lock(&app->sock_lock);
1300 ret = ustctl_add_context(app->sock, &ua_ctx->ctx,
1301 ua_chan->obj, &ua_ctx->obj);
1302 pthread_mutex_unlock(&app->sock_lock);
1303 if (ret < 0) {
1304 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1305 ERR("UST app create channel context failed for app (pid: %d) "
1306 "with ret %d", app->pid, ret);
1307 } else {
1308 /*
1309 * This is normal behavior, an application can die during the
1310 * creation process. Don't report an error so the execution can
1311 * continue normally.
1312 */
1313 ret = 0;
1314 DBG3("UST app disable event failed. Application is dead.");
1315 }
1316 goto error;
1317 }
1318
1319 ua_ctx->handle = ua_ctx->obj->handle;
1320
1321 DBG2("UST app context handle %d created successfully for channel %s",
1322 ua_ctx->handle, ua_chan->name);
1323
1324 error:
1325 health_code_update();
1326 return ret;
1327 }
1328
1329 /*
1330 * Set the filter on the tracer.
1331 */
1332 static
1333 int set_ust_event_filter(struct ust_app_event *ua_event,
1334 struct ust_app *app)
1335 {
1336 int ret;
1337 struct lttng_ust_filter_bytecode *ust_bytecode = NULL;
1338
1339 health_code_update();
1340
1341 if (!ua_event->filter) {
1342 ret = 0;
1343 goto error;
1344 }
1345
1346 ust_bytecode = create_ust_bytecode_from_bytecode(ua_event->filter);
1347 if (!ust_bytecode) {
1348 ret = -LTTNG_ERR_NOMEM;
1349 goto error;
1350 }
1351 pthread_mutex_lock(&app->sock_lock);
1352 ret = ustctl_set_filter(app->sock, ust_bytecode,
1353 ua_event->obj);
1354 pthread_mutex_unlock(&app->sock_lock);
1355 if (ret < 0) {
1356 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1357 ERR("UST app event %s filter failed for app (pid: %d) "
1358 "with ret %d", ua_event->attr.name, app->pid, ret);
1359 } else {
1360 /*
1361 * This is normal behavior, an application can die during the
1362 * creation process. Don't report an error so the execution can
1363 * continue normally.
1364 */
1365 ret = 0;
1366 DBG3("UST app filter event failed. Application is dead.");
1367 }
1368 goto error;
1369 }
1370
1371 DBG2("UST filter set successfully for event %s", ua_event->name);
1372
1373 error:
1374 health_code_update();
1375 free(ust_bytecode);
1376 return ret;
1377 }
1378
1379 static
1380 struct lttng_ust_event_exclusion *create_ust_exclusion_from_exclusion(
1381 struct lttng_event_exclusion *exclusion)
1382 {
1383 struct lttng_ust_event_exclusion *ust_exclusion = NULL;
1384 size_t exclusion_alloc_size = sizeof(struct lttng_ust_event_exclusion) +
1385 LTTNG_UST_SYM_NAME_LEN * exclusion->count;
1386
1387 ust_exclusion = zmalloc(exclusion_alloc_size);
1388 if (!ust_exclusion) {
1389 PERROR("malloc");
1390 goto end;
1391 }
1392
1393 assert(sizeof(struct lttng_event_exclusion) ==
1394 sizeof(struct lttng_ust_event_exclusion));
1395 memcpy(ust_exclusion, exclusion, exclusion_alloc_size);
1396 end:
1397 return ust_exclusion;
1398 }
1399
1400 /*
1401 * Set event exclusions on the tracer.
1402 */
1403 static
1404 int set_ust_event_exclusion(struct ust_app_event *ua_event,
1405 struct ust_app *app)
1406 {
1407 int ret;
1408 struct lttng_ust_event_exclusion *ust_exclusion = NULL;
1409
1410 health_code_update();
1411
1412 if (!ua_event->exclusion || !ua_event->exclusion->count) {
1413 ret = 0;
1414 goto error;
1415 }
1416
1417 ust_exclusion = create_ust_exclusion_from_exclusion(
1418 ua_event->exclusion);
1419 if (!ust_exclusion) {
1420 ret = -LTTNG_ERR_NOMEM;
1421 goto error;
1422 }
1423 pthread_mutex_lock(&app->sock_lock);
1424 ret = ustctl_set_exclusion(app->sock, ust_exclusion, ua_event->obj);
1425 pthread_mutex_unlock(&app->sock_lock);
1426 if (ret < 0) {
1427 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1428 ERR("UST app event %s exclusions failed for app (pid: %d) "
1429 "with ret %d", ua_event->attr.name, app->pid, ret);
1430 } else {
1431 /*
1432 * This is normal behavior, an application can die during the
1433 * creation process. Don't report an error so the execution can
1434 * continue normally.
1435 */
1436 ret = 0;
1437 DBG3("UST app event exclusion failed. Application is dead.");
1438 }
1439 goto error;
1440 }
1441
1442 DBG2("UST exclusion set successfully for event %s", ua_event->name);
1443
1444 error:
1445 health_code_update();
1446 free(ust_exclusion);
1447 return ret;
1448 }
1449
1450 /*
1451 * Disable the specified event on to UST tracer for the UST session.
1452 */
1453 static int disable_ust_event(struct ust_app *app,
1454 struct ust_app_session *ua_sess, struct ust_app_event *ua_event)
1455 {
1456 int ret;
1457
1458 health_code_update();
1459
1460 pthread_mutex_lock(&app->sock_lock);
1461 ret = ustctl_disable(app->sock, ua_event->obj);
1462 pthread_mutex_unlock(&app->sock_lock);
1463 if (ret < 0) {
1464 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1465 ERR("UST app event %s disable failed for app (pid: %d) "
1466 "and session handle %d with ret %d",
1467 ua_event->attr.name, app->pid, ua_sess->handle, ret);
1468 } else {
1469 /*
1470 * This is normal behavior, an application can die during the
1471 * creation process. Don't report an error so the execution can
1472 * continue normally.
1473 */
1474 ret = 0;
1475 DBG3("UST app disable event failed. Application is dead.");
1476 }
1477 goto error;
1478 }
1479
1480 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1481 ua_event->attr.name, app->pid);
1482
1483 error:
1484 health_code_update();
1485 return ret;
1486 }
1487
1488 /*
1489 * Disable the specified channel on to UST tracer for the UST session.
1490 */
1491 static int disable_ust_channel(struct ust_app *app,
1492 struct ust_app_session *ua_sess, struct ust_app_channel *ua_chan)
1493 {
1494 int ret;
1495
1496 health_code_update();
1497
1498 pthread_mutex_lock(&app->sock_lock);
1499 ret = ustctl_disable(app->sock, ua_chan->obj);
1500 pthread_mutex_unlock(&app->sock_lock);
1501 if (ret < 0) {
1502 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1503 ERR("UST app channel %s disable failed for app (pid: %d) "
1504 "and session handle %d with ret %d",
1505 ua_chan->name, app->pid, ua_sess->handle, ret);
1506 } else {
1507 /*
1508 * This is normal behavior, an application can die during the
1509 * creation process. Don't report an error so the execution can
1510 * continue normally.
1511 */
1512 ret = 0;
1513 DBG3("UST app disable channel failed. Application is dead.");
1514 }
1515 goto error;
1516 }
1517
1518 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1519 ua_chan->name, app->pid);
1520
1521 error:
1522 health_code_update();
1523 return ret;
1524 }
1525
1526 /*
1527 * Enable the specified channel on to UST tracer for the UST session.
1528 */
1529 static int enable_ust_channel(struct ust_app *app,
1530 struct ust_app_session *ua_sess, struct ust_app_channel *ua_chan)
1531 {
1532 int ret;
1533
1534 health_code_update();
1535
1536 pthread_mutex_lock(&app->sock_lock);
1537 ret = ustctl_enable(app->sock, ua_chan->obj);
1538 pthread_mutex_unlock(&app->sock_lock);
1539 if (ret < 0) {
1540 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1541 ERR("UST app channel %s enable failed for app (pid: %d) "
1542 "and session handle %d with ret %d",
1543 ua_chan->name, app->pid, ua_sess->handle, ret);
1544 } else {
1545 /*
1546 * This is normal behavior, an application can die during the
1547 * creation process. Don't report an error so the execution can
1548 * continue normally.
1549 */
1550 ret = 0;
1551 DBG3("UST app enable channel failed. Application is dead.");
1552 }
1553 goto error;
1554 }
1555
1556 ua_chan->enabled = 1;
1557
1558 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1559 ua_chan->name, app->pid);
1560
1561 error:
1562 health_code_update();
1563 return ret;
1564 }
1565
1566 /*
1567 * Enable the specified event on to UST tracer for the UST session.
1568 */
1569 static int enable_ust_event(struct ust_app *app,
1570 struct ust_app_session *ua_sess, struct ust_app_event *ua_event)
1571 {
1572 int ret;
1573
1574 health_code_update();
1575
1576 pthread_mutex_lock(&app->sock_lock);
1577 ret = ustctl_enable(app->sock, ua_event->obj);
1578 pthread_mutex_unlock(&app->sock_lock);
1579 if (ret < 0) {
1580 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1581 ERR("UST app event %s enable failed for app (pid: %d) "
1582 "and session handle %d with ret %d",
1583 ua_event->attr.name, app->pid, ua_sess->handle, ret);
1584 } else {
1585 /*
1586 * This is normal behavior, an application can die during the
1587 * creation process. Don't report an error so the execution can
1588 * continue normally.
1589 */
1590 ret = 0;
1591 DBG3("UST app enable event failed. Application is dead.");
1592 }
1593 goto error;
1594 }
1595
1596 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1597 ua_event->attr.name, app->pid);
1598
1599 error:
1600 health_code_update();
1601 return ret;
1602 }
1603
1604 /*
1605 * Send channel and stream buffer to application.
1606 *
1607 * Return 0 on success. On error, a negative value is returned.
1608 */
1609 static int send_channel_pid_to_ust(struct ust_app *app,
1610 struct ust_app_session *ua_sess, struct ust_app_channel *ua_chan)
1611 {
1612 int ret;
1613 struct ust_app_stream *stream, *stmp;
1614
1615 assert(app);
1616 assert(ua_sess);
1617 assert(ua_chan);
1618
1619 health_code_update();
1620
1621 DBG("UST app sending channel %s to UST app sock %d", ua_chan->name,
1622 app->sock);
1623
1624 /* Send channel to the application. */
1625 ret = ust_consumer_send_channel_to_ust(app, ua_sess, ua_chan);
1626 if (ret == -EPIPE || ret == -LTTNG_UST_ERR_EXITING) {
1627 ret = -ENOTCONN; /* Caused by app exiting. */
1628 goto error;
1629 } else if (ret < 0) {
1630 goto error;
1631 }
1632
1633 health_code_update();
1634
1635 /* Send all streams to application. */
1636 cds_list_for_each_entry_safe(stream, stmp, &ua_chan->streams.head, list) {
1637 ret = ust_consumer_send_stream_to_ust(app, ua_chan, stream);
1638 if (ret == -EPIPE || ret == -LTTNG_UST_ERR_EXITING) {
1639 ret = -ENOTCONN; /* Caused by app exiting. */
1640 goto error;
1641 } else if (ret < 0) {
1642 goto error;
1643 }
1644 /* We don't need the stream anymore once sent to the tracer. */
1645 cds_list_del(&stream->list);
1646 delete_ust_app_stream(-1, stream, app);
1647 }
1648 /* Flag the channel that it is sent to the application. */
1649 ua_chan->is_sent = 1;
1650
1651 error:
1652 health_code_update();
1653 return ret;
1654 }
1655
1656 /*
1657 * Create the specified event onto the UST tracer for a UST session.
1658 *
1659 * Should be called with session mutex held.
1660 */
1661 static
1662 int create_ust_event(struct ust_app *app, struct ust_app_session *ua_sess,
1663 struct ust_app_channel *ua_chan, struct ust_app_event *ua_event)
1664 {
1665 int ret = 0;
1666
1667 health_code_update();
1668
1669 /* Create UST event on tracer */
1670 pthread_mutex_lock(&app->sock_lock);
1671 ret = ustctl_create_event(app->sock, &ua_event->attr, ua_chan->obj,
1672 &ua_event->obj);
1673 pthread_mutex_unlock(&app->sock_lock);
1674 if (ret < 0) {
1675 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1676 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1677 ua_event->attr.name, app->pid, ret);
1678 } else {
1679 /*
1680 * This is normal behavior, an application can die during the
1681 * creation process. Don't report an error so the execution can
1682 * continue normally.
1683 */
1684 ret = 0;
1685 DBG3("UST app create event failed. Application is dead.");
1686 }
1687 goto error;
1688 }
1689
1690 ua_event->handle = ua_event->obj->handle;
1691
1692 DBG2("UST app event %s created successfully for pid:%d",
1693 ua_event->attr.name, app->pid);
1694
1695 health_code_update();
1696
1697 /* Set filter if one is present. */
1698 if (ua_event->filter) {
1699 ret = set_ust_event_filter(ua_event, app);
1700 if (ret < 0) {
1701 goto error;
1702 }
1703 }
1704
1705 /* Set exclusions for the event */
1706 if (ua_event->exclusion) {
1707 ret = set_ust_event_exclusion(ua_event, app);
1708 if (ret < 0) {
1709 goto error;
1710 }
1711 }
1712
1713 /* If event not enabled, disable it on the tracer */
1714 if (ua_event->enabled) {
1715 /*
1716 * We now need to explicitly enable the event, since it
1717 * is now disabled at creation.
1718 */
1719 ret = enable_ust_event(app, ua_sess, ua_event);
1720 if (ret < 0) {
1721 /*
1722 * If we hit an EPERM, something is wrong with our enable call. If
1723 * we get an EEXIST, there is a problem on the tracer side since we
1724 * just created it.
1725 */
1726 switch (ret) {
1727 case -LTTNG_UST_ERR_PERM:
1728 /* Code flow problem */
1729 assert(0);
1730 case -LTTNG_UST_ERR_EXIST:
1731 /* It's OK for our use case. */
1732 ret = 0;
1733 break;
1734 default:
1735 break;
1736 }
1737 goto error;
1738 }
1739 }
1740
1741 error:
1742 health_code_update();
1743 return ret;
1744 }
1745
1746 /*
1747 * Copy data between an UST app event and a LTT event.
1748 */
1749 static void shadow_copy_event(struct ust_app_event *ua_event,
1750 struct ltt_ust_event *uevent)
1751 {
1752 size_t exclusion_alloc_size;
1753
1754 strncpy(ua_event->name, uevent->attr.name, sizeof(ua_event->name));
1755 ua_event->name[sizeof(ua_event->name) - 1] = '\0';
1756
1757 ua_event->enabled = uevent->enabled;
1758
1759 /* Copy event attributes */
1760 memcpy(&ua_event->attr, &uevent->attr, sizeof(ua_event->attr));
1761
1762 /* Copy filter bytecode */
1763 if (uevent->filter) {
1764 ua_event->filter = copy_filter_bytecode(uevent->filter);
1765 /* Filter might be NULL here in case of ENONEM. */
1766 }
1767
1768 /* Copy exclusion data */
1769 if (uevent->exclusion) {
1770 exclusion_alloc_size = sizeof(struct lttng_event_exclusion) +
1771 LTTNG_UST_SYM_NAME_LEN * uevent->exclusion->count;
1772 ua_event->exclusion = zmalloc(exclusion_alloc_size);
1773 if (ua_event->exclusion == NULL) {
1774 PERROR("malloc");
1775 } else {
1776 memcpy(ua_event->exclusion, uevent->exclusion,
1777 exclusion_alloc_size);
1778 }
1779 }
1780 }
1781
1782 /*
1783 * Copy data between an UST app channel and a LTT channel.
1784 */
1785 static void shadow_copy_channel(struct ust_app_channel *ua_chan,
1786 struct ltt_ust_channel *uchan)
1787 {
1788 struct lttng_ht_iter iter;
1789 struct ltt_ust_event *uevent;
1790 struct ltt_ust_context *uctx;
1791 struct ust_app_event *ua_event;
1792
1793 DBG2("UST app shadow copy of channel %s started", ua_chan->name);
1794
1795 strncpy(ua_chan->name, uchan->name, sizeof(ua_chan->name));
1796 ua_chan->name[sizeof(ua_chan->name) - 1] = '\0';
1797
1798 ua_chan->tracefile_size = uchan->tracefile_size;
1799 ua_chan->tracefile_count = uchan->tracefile_count;
1800
1801 /* Copy event attributes since the layout is different. */
1802 ua_chan->attr.subbuf_size = uchan->attr.subbuf_size;
1803 ua_chan->attr.num_subbuf = uchan->attr.num_subbuf;
1804 ua_chan->attr.overwrite = uchan->attr.overwrite;
1805 ua_chan->attr.switch_timer_interval = uchan->attr.switch_timer_interval;
1806 ua_chan->attr.read_timer_interval = uchan->attr.read_timer_interval;
1807 ua_chan->monitor_timer_interval = uchan->monitor_timer_interval;
1808 ua_chan->attr.output = uchan->attr.output;
1809 ua_chan->attr.blocking_timeout = uchan->attr.u.s.blocking_timeout;
1810
1811 /*
1812 * Note that the attribute channel type is not set since the channel on the
1813 * tracing registry side does not have this information.
1814 */
1815
1816 ua_chan->enabled = uchan->enabled;
1817 ua_chan->tracing_channel_id = uchan->id;
1818
1819 cds_list_for_each_entry(uctx, &uchan->ctx_list, list) {
1820 struct ust_app_ctx *ua_ctx = alloc_ust_app_ctx(&uctx->ctx);
1821
1822 if (ua_ctx == NULL) {
1823 continue;
1824 }
1825 lttng_ht_node_init_ulong(&ua_ctx->node,
1826 (unsigned long) ua_ctx->ctx.ctx);
1827 lttng_ht_add_ulong(ua_chan->ctx, &ua_ctx->node);
1828 cds_list_add_tail(&ua_ctx->list, &ua_chan->ctx_list);
1829 }
1830
1831 /* Copy all events from ltt ust channel to ust app channel */
1832 cds_lfht_for_each_entry(uchan->events->ht, &iter.iter, uevent, node.node) {
1833 ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
1834 uevent->filter, uevent->attr.loglevel, uevent->exclusion);
1835 if (ua_event == NULL) {
1836 DBG2("UST event %s not found on shadow copy channel",
1837 uevent->attr.name);
1838 ua_event = alloc_ust_app_event(uevent->attr.name, &uevent->attr);
1839 if (ua_event == NULL) {
1840 continue;
1841 }
1842 shadow_copy_event(ua_event, uevent);
1843 add_unique_ust_app_event(ua_chan, ua_event);
1844 }
1845 }
1846
1847 DBG3("UST app shadow copy of channel %s done", ua_chan->name);
1848 }
1849
1850 /*
1851 * Copy data between a UST app session and a regular LTT session.
1852 */
1853 static void shadow_copy_session(struct ust_app_session *ua_sess,
1854 struct ltt_ust_session *usess, struct ust_app *app)
1855 {
1856 struct lttng_ht_node_str *ua_chan_node;
1857 struct lttng_ht_iter iter;
1858 struct ltt_ust_channel *uchan;
1859 struct ust_app_channel *ua_chan;
1860 time_t rawtime;
1861 struct tm *timeinfo;
1862 char datetime[16];
1863 int ret;
1864 char tmp_shm_path[PATH_MAX];
1865
1866 /* Get date and time for unique app path */
1867 time(&rawtime);
1868 timeinfo = localtime(&rawtime);
1869 strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);
1870
1871 DBG2("Shadow copy of session handle %d", ua_sess->handle);
1872
1873 ua_sess->tracing_id = usess->id;
1874 ua_sess->id = get_next_session_id();
1875 ua_sess->uid = app->uid;
1876 ua_sess->gid = app->gid;
1877 ua_sess->euid = usess->uid;
1878 ua_sess->egid = usess->gid;
1879 ua_sess->buffer_type = usess->buffer_type;
1880 ua_sess->bits_per_long = app->bits_per_long;
1881
1882 /* There is only one consumer object per session possible. */
1883 consumer_output_get(usess->consumer);
1884 ua_sess->consumer = usess->consumer;
1885
1886 ua_sess->output_traces = usess->output_traces;
1887 ua_sess->live_timer_interval = usess->live_timer_interval;
1888 copy_channel_attr_to_ustctl(&ua_sess->metadata_attr,
1889 &usess->metadata_attr);
1890
1891 switch (ua_sess->buffer_type) {
1892 case LTTNG_BUFFER_PER_PID:
1893 ret = snprintf(ua_sess->path, sizeof(ua_sess->path),
1894 DEFAULT_UST_TRACE_PID_PATH "/%s-%d-%s", app->name, app->pid,
1895 datetime);
1896 break;
1897 case LTTNG_BUFFER_PER_UID:
1898 ret = snprintf(ua_sess->path, sizeof(ua_sess->path),
1899 DEFAULT_UST_TRACE_UID_PATH, ua_sess->uid, app->bits_per_long);
1900 break;
1901 default:
1902 assert(0);
1903 goto error;
1904 }
1905 if (ret < 0) {
1906 PERROR("asprintf UST shadow copy session");
1907 assert(0);
1908 goto error;
1909 }
1910
1911 strncpy(ua_sess->root_shm_path, usess->root_shm_path,
1912 sizeof(ua_sess->root_shm_path));
1913 ua_sess->root_shm_path[sizeof(ua_sess->root_shm_path) - 1] = '\0';
1914 strncpy(ua_sess->shm_path, usess->shm_path,
1915 sizeof(ua_sess->shm_path));
1916 ua_sess->shm_path[sizeof(ua_sess->shm_path) - 1] = '\0';
1917 if (ua_sess->shm_path[0]) {
1918 switch (ua_sess->buffer_type) {
1919 case LTTNG_BUFFER_PER_PID:
1920 ret = snprintf(tmp_shm_path, sizeof(tmp_shm_path),
1921 DEFAULT_UST_TRACE_PID_PATH "/%s-%d-%s",
1922 app->name, app->pid, datetime);
1923 break;
1924 case LTTNG_BUFFER_PER_UID:
1925 ret = snprintf(tmp_shm_path, sizeof(tmp_shm_path),
1926 DEFAULT_UST_TRACE_UID_PATH,
1927 app->uid, app->bits_per_long);
1928 break;
1929 default:
1930 assert(0);
1931 goto error;
1932 }
1933 if (ret < 0) {
1934 PERROR("sprintf UST shadow copy session");
1935 assert(0);
1936 goto error;
1937 }
1938 strncat(ua_sess->shm_path, tmp_shm_path,
1939 sizeof(ua_sess->shm_path) - strlen(ua_sess->shm_path) - 1);
1940 ua_sess->shm_path[sizeof(ua_sess->shm_path) - 1] = '\0';
1941 }
1942
1943 /* Iterate over all channels in global domain. */
1944 cds_lfht_for_each_entry(usess->domain_global.channels->ht, &iter.iter,
1945 uchan, node.node) {
1946 struct lttng_ht_iter uiter;
1947
1948 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
1949 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
1950 if (ua_chan_node != NULL) {
1951 /* Session exist. Contiuing. */
1952 continue;
1953 }
1954
1955 DBG2("Channel %s not found on shadow session copy, creating it",
1956 uchan->name);
1957 ua_chan = alloc_ust_app_channel(uchan->name, ua_sess,
1958 &uchan->attr);
1959 if (ua_chan == NULL) {
1960 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1961 continue;
1962 }
1963 shadow_copy_channel(ua_chan, uchan);
1964 /*
1965 * The concept of metadata channel does not exist on the tracing
1966 * registry side of the session daemon so this can only be a per CPU
1967 * channel and not metadata.
1968 */
1969 ua_chan->attr.type = LTTNG_UST_CHAN_PER_CPU;
1970
1971 lttng_ht_add_unique_str(ua_sess->channels, &ua_chan->node);
1972 }
1973 return;
1974
1975 error:
1976 consumer_output_put(ua_sess->consumer);
1977 }
1978
1979 /*
1980 * Lookup sesison wrapper.
1981 */
1982 static
1983 void __lookup_session_by_app(struct ltt_ust_session *usess,
1984 struct ust_app *app, struct lttng_ht_iter *iter)
1985 {
1986 /* Get right UST app session from app */
1987 lttng_ht_lookup(app->sessions, &usess->id, iter);
1988 }
1989
1990 /*
1991 * Return ust app session from the app session hashtable using the UST session
1992 * id.
1993 */
1994 static struct ust_app_session *lookup_session_by_app(
1995 struct ltt_ust_session *usess, struct ust_app *app)
1996 {
1997 struct lttng_ht_iter iter;
1998 struct lttng_ht_node_u64 *node;
1999
2000 __lookup_session_by_app(usess, app, &iter);
2001 node = lttng_ht_iter_get_node_u64(&iter);
2002 if (node == NULL) {
2003 goto error;
2004 }
2005
2006 return caa_container_of(node, struct ust_app_session, node);
2007
2008 error:
2009 return NULL;
2010 }
2011
2012 /*
2013 * Setup buffer registry per PID for the given session and application. If none
2014 * is found, a new one is created, added to the global registry and
2015 * initialized. If regp is valid, it's set with the newly created object.
2016 *
2017 * Return 0 on success or else a negative value.
2018 */
2019 static int setup_buffer_reg_pid(struct ust_app_session *ua_sess,
2020 struct ust_app *app, struct buffer_reg_pid **regp)
2021 {
2022 int ret = 0;
2023 struct buffer_reg_pid *reg_pid;
2024
2025 assert(ua_sess);
2026 assert(app);
2027
2028 rcu_read_lock();
2029
2030 reg_pid = buffer_reg_pid_find(ua_sess->id);
2031 if (!reg_pid) {
2032 /*
2033 * This is the create channel path meaning that if there is NO
2034 * registry available, we have to create one for this session.
2035 */
2036 ret = buffer_reg_pid_create(ua_sess->id, &reg_pid,
2037 ua_sess->root_shm_path, ua_sess->shm_path);
2038 if (ret < 0) {
2039 goto error;
2040 }
2041 } else {
2042 goto end;
2043 }
2044
2045 /* Initialize registry. */
2046 ret = ust_registry_session_init(&reg_pid->registry->reg.ust, app,
2047 app->bits_per_long, app->uint8_t_alignment,
2048 app->uint16_t_alignment, app->uint32_t_alignment,
2049 app->uint64_t_alignment, app->long_alignment,
2050 app->byte_order, app->version.major,
2051 app->version.minor, reg_pid->root_shm_path,
2052 reg_pid->shm_path,
2053 ua_sess->euid, ua_sess->egid);
2054 if (ret < 0) {
2055 /*
2056 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2057 * destroy the buffer registry, because it is always expected
2058 * that if the buffer registry can be found, its ust registry is
2059 * non-NULL.
2060 */
2061 buffer_reg_pid_destroy(reg_pid);
2062 goto error;
2063 }
2064
2065 buffer_reg_pid_add(reg_pid);
2066
2067 DBG3("UST app buffer registry per PID created successfully");
2068
2069 end:
2070 if (regp) {
2071 *regp = reg_pid;
2072 }
2073 error:
2074 rcu_read_unlock();
2075 return ret;
2076 }
2077
2078 /*
2079 * Setup buffer registry per UID for the given session and application. If none
2080 * is found, a new one is created, added to the global registry and
2081 * initialized. If regp is valid, it's set with the newly created object.
2082 *
2083 * Return 0 on success or else a negative value.
2084 */
2085 static int setup_buffer_reg_uid(struct ltt_ust_session *usess,
2086 struct ust_app_session *ua_sess,
2087 struct ust_app *app, struct buffer_reg_uid **regp)
2088 {
2089 int ret = 0;
2090 struct buffer_reg_uid *reg_uid;
2091
2092 assert(usess);
2093 assert(app);
2094
2095 rcu_read_lock();
2096
2097 reg_uid = buffer_reg_uid_find(usess->id, app->bits_per_long, app->uid);
2098 if (!reg_uid) {
2099 /*
2100 * This is the create channel path meaning that if there is NO
2101 * registry available, we have to create one for this session.
2102 */
2103 ret = buffer_reg_uid_create(usess->id, app->bits_per_long, app->uid,
2104 LTTNG_DOMAIN_UST, &reg_uid,
2105 ua_sess->root_shm_path, ua_sess->shm_path);
2106 if (ret < 0) {
2107 goto error;
2108 }
2109 } else {
2110 goto end;
2111 }
2112
2113 /* Initialize registry. */
2114 ret = ust_registry_session_init(&reg_uid->registry->reg.ust, NULL,
2115 app->bits_per_long, app->uint8_t_alignment,
2116 app->uint16_t_alignment, app->uint32_t_alignment,
2117 app->uint64_t_alignment, app->long_alignment,
2118 app->byte_order, app->version.major,
2119 app->version.minor, reg_uid->root_shm_path,
2120 reg_uid->shm_path, usess->uid, usess->gid);
2121 if (ret < 0) {
2122 /*
2123 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2124 * destroy the buffer registry, because it is always expected
2125 * that if the buffer registry can be found, its ust registry is
2126 * non-NULL.
2127 */
2128 buffer_reg_uid_destroy(reg_uid, NULL);
2129 goto error;
2130 }
2131 /* Add node to teardown list of the session. */
2132 cds_list_add(&reg_uid->lnode, &usess->buffer_reg_uid_list);
2133
2134 buffer_reg_uid_add(reg_uid);
2135
2136 DBG3("UST app buffer registry per UID created successfully");
2137 end:
2138 if (regp) {
2139 *regp = reg_uid;
2140 }
2141 error:
2142 rcu_read_unlock();
2143 return ret;
2144 }
2145
2146 /*
2147 * Create a session on the tracer side for the given app.
2148 *
2149 * On success, ua_sess_ptr is populated with the session pointer or else left
2150 * untouched. If the session was created, is_created is set to 1. On error,
2151 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2152 * be NULL.
2153 *
2154 * Returns 0 on success or else a negative code which is either -ENOMEM or
2155 * -ENOTCONN which is the default code if the ustctl_create_session fails.
2156 */
2157 static int find_or_create_ust_app_session(struct ltt_ust_session *usess,
2158 struct ust_app *app, struct ust_app_session **ua_sess_ptr,
2159 int *is_created)
2160 {
2161 int ret, created = 0;
2162 struct ust_app_session *ua_sess;
2163
2164 assert(usess);
2165 assert(app);
2166 assert(ua_sess_ptr);
2167
2168 health_code_update();
2169
2170 ua_sess = lookup_session_by_app(usess, app);
2171 if (ua_sess == NULL) {
2172 DBG2("UST app pid: %d session id %" PRIu64 " not found, creating it",
2173 app->pid, usess->id);
2174 ua_sess = alloc_ust_app_session();
2175 if (ua_sess == NULL) {
2176 /* Only malloc can failed so something is really wrong */
2177 ret = -ENOMEM;
2178 goto error;
2179 }
2180 shadow_copy_session(ua_sess, usess, app);
2181 created = 1;
2182 }
2183
2184 switch (usess->buffer_type) {
2185 case LTTNG_BUFFER_PER_PID:
2186 /* Init local registry. */
2187 ret = setup_buffer_reg_pid(ua_sess, app, NULL);
2188 if (ret < 0) {
2189 delete_ust_app_session(-1, ua_sess, app);
2190 goto error;
2191 }
2192 break;
2193 case LTTNG_BUFFER_PER_UID:
2194 /* Look for a global registry. If none exists, create one. */
2195 ret = setup_buffer_reg_uid(usess, ua_sess, app, NULL);
2196 if (ret < 0) {
2197 delete_ust_app_session(-1, ua_sess, app);
2198 goto error;
2199 }
2200 break;
2201 default:
2202 assert(0);
2203 ret = -EINVAL;
2204 goto error;
2205 }
2206
2207 health_code_update();
2208
2209 if (ua_sess->handle == -1) {
2210 pthread_mutex_lock(&app->sock_lock);
2211 ret = ustctl_create_session(app->sock);
2212 pthread_mutex_unlock(&app->sock_lock);
2213 if (ret < 0) {
2214 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
2215 ERR("Creating session for app pid %d with ret %d",
2216 app->pid, ret);
2217 } else {
2218 DBG("UST app creating session failed. Application is dead");
2219 /*
2220 * This is normal behavior, an application can die during the
2221 * creation process. Don't report an error so the execution can
2222 * continue normally. This will get flagged ENOTCONN and the
2223 * caller will handle it.
2224 */
2225 ret = 0;
2226 }
2227 delete_ust_app_session(-1, ua_sess, app);
2228 if (ret != -ENOMEM) {
2229 /*
2230 * Tracer is probably gone or got an internal error so let's
2231 * behave like it will soon unregister or not usable.
2232 */
2233 ret = -ENOTCONN;
2234 }
2235 goto error;
2236 }
2237
2238 ua_sess->handle = ret;
2239
2240 /* Add ust app session to app's HT */
2241 lttng_ht_node_init_u64(&ua_sess->node,
2242 ua_sess->tracing_id);
2243 lttng_ht_add_unique_u64(app->sessions, &ua_sess->node);
2244 lttng_ht_node_init_ulong(&ua_sess->ust_objd_node, ua_sess->handle);
2245 lttng_ht_add_unique_ulong(app->ust_sessions_objd,
2246 &ua_sess->ust_objd_node);
2247
2248 DBG2("UST app session created successfully with handle %d", ret);
2249 }
2250
2251 *ua_sess_ptr = ua_sess;
2252 if (is_created) {
2253 *is_created = created;
2254 }
2255
2256 /* Everything went well. */
2257 ret = 0;
2258
2259 error:
2260 health_code_update();
2261 return ret;
2262 }
2263
2264 /*
2265 * Match function for a hash table lookup of ust_app_ctx.
2266 *
2267 * It matches an ust app context based on the context type and, in the case
2268 * of perf counters, their name.
2269 */
2270 static int ht_match_ust_app_ctx(struct cds_lfht_node *node, const void *_key)
2271 {
2272 struct ust_app_ctx *ctx;
2273 const struct lttng_ust_context_attr *key;
2274
2275 assert(node);
2276 assert(_key);
2277
2278 ctx = caa_container_of(node, struct ust_app_ctx, node.node);
2279 key = _key;
2280
2281 /* Context type */
2282 if (ctx->ctx.ctx != key->ctx) {
2283 goto no_match;
2284 }
2285
2286 switch(key->ctx) {
2287 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER:
2288 if (strncmp(key->u.perf_counter.name,
2289 ctx->ctx.u.perf_counter.name,
2290 sizeof(key->u.perf_counter.name))) {
2291 goto no_match;
2292 }
2293 break;
2294 case LTTNG_UST_CONTEXT_APP_CONTEXT:
2295 if (strcmp(key->u.app_ctx.provider_name,
2296 ctx->ctx.u.app_ctx.provider_name) ||
2297 strcmp(key->u.app_ctx.ctx_name,
2298 ctx->ctx.u.app_ctx.ctx_name)) {
2299 goto no_match;
2300 }
2301 break;
2302 default:
2303 break;
2304 }
2305
2306 /* Match. */
2307 return 1;
2308
2309 no_match:
2310 return 0;
2311 }
2312
2313 /*
2314 * Lookup for an ust app context from an lttng_ust_context.
2315 *
2316 * Must be called while holding RCU read side lock.
2317 * Return an ust_app_ctx object or NULL on error.
2318 */
2319 static
2320 struct ust_app_ctx *find_ust_app_context(struct lttng_ht *ht,
2321 struct lttng_ust_context_attr *uctx)
2322 {
2323 struct lttng_ht_iter iter;
2324 struct lttng_ht_node_ulong *node;
2325 struct ust_app_ctx *app_ctx = NULL;
2326
2327 assert(uctx);
2328 assert(ht);
2329
2330 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2331 cds_lfht_lookup(ht->ht, ht->hash_fct((void *) uctx->ctx, lttng_ht_seed),
2332 ht_match_ust_app_ctx, uctx, &iter.iter);
2333 node = lttng_ht_iter_get_node_ulong(&iter);
2334 if (!node) {
2335 goto end;
2336 }
2337
2338 app_ctx = caa_container_of(node, struct ust_app_ctx, node);
2339
2340 end:
2341 return app_ctx;
2342 }
2343
2344 /*
2345 * Create a context for the channel on the tracer.
2346 *
2347 * Called with UST app session lock held and a RCU read side lock.
2348 */
2349 static
2350 int create_ust_app_channel_context(struct ust_app_channel *ua_chan,
2351 struct lttng_ust_context_attr *uctx,
2352 struct ust_app *app)
2353 {
2354 int ret = 0;
2355 struct ust_app_ctx *ua_ctx;
2356
2357 DBG2("UST app adding context to channel %s", ua_chan->name);
2358
2359 ua_ctx = find_ust_app_context(ua_chan->ctx, uctx);
2360 if (ua_ctx) {
2361 ret = -EEXIST;
2362 goto error;
2363 }
2364
2365 ua_ctx = alloc_ust_app_ctx(uctx);
2366 if (ua_ctx == NULL) {
2367 /* malloc failed */
2368 ret = -ENOMEM;
2369 goto error;
2370 }
2371
2372 lttng_ht_node_init_ulong(&ua_ctx->node, (unsigned long) ua_ctx->ctx.ctx);
2373 lttng_ht_add_ulong(ua_chan->ctx, &ua_ctx->node);
2374 cds_list_add_tail(&ua_ctx->list, &ua_chan->ctx_list);
2375
2376 ret = create_ust_channel_context(ua_chan, ua_ctx, app);
2377 if (ret < 0) {
2378 goto error;
2379 }
2380
2381 error:
2382 return ret;
2383 }
2384
2385 /*
2386 * Enable on the tracer side a ust app event for the session and channel.
2387 *
2388 * Called with UST app session lock held.
2389 */
2390 static
2391 int enable_ust_app_event(struct ust_app_session *ua_sess,
2392 struct ust_app_event *ua_event, struct ust_app *app)
2393 {
2394 int ret;
2395
2396 ret = enable_ust_event(app, ua_sess, ua_event);
2397 if (ret < 0) {
2398 goto error;
2399 }
2400
2401 ua_event->enabled = 1;
2402
2403 error:
2404 return ret;
2405 }
2406
2407 /*
2408 * Disable on the tracer side a ust app event for the session and channel.
2409 */
2410 static int disable_ust_app_event(struct ust_app_session *ua_sess,
2411 struct ust_app_event *ua_event, struct ust_app *app)
2412 {
2413 int ret;
2414
2415 ret = disable_ust_event(app, ua_sess, ua_event);
2416 if (ret < 0) {
2417 goto error;
2418 }
2419
2420 ua_event->enabled = 0;
2421
2422 error:
2423 return ret;
2424 }
2425
2426 /*
2427 * Lookup ust app channel for session and disable it on the tracer side.
2428 */
2429 static
2430 int disable_ust_app_channel(struct ust_app_session *ua_sess,
2431 struct ust_app_channel *ua_chan, struct ust_app *app)
2432 {
2433 int ret;
2434
2435 ret = disable_ust_channel(app, ua_sess, ua_chan);
2436 if (ret < 0) {
2437 goto error;
2438 }
2439
2440 ua_chan->enabled = 0;
2441
2442 error:
2443 return ret;
2444 }
2445
2446 /*
2447 * Lookup ust app channel for session and enable it on the tracer side. This
2448 * MUST be called with a RCU read side lock acquired.
2449 */
2450 static int enable_ust_app_channel(struct ust_app_session *ua_sess,
2451 struct ltt_ust_channel *uchan, struct ust_app *app)
2452 {
2453 int ret = 0;
2454 struct lttng_ht_iter iter;
2455 struct lttng_ht_node_str *ua_chan_node;
2456 struct ust_app_channel *ua_chan;
2457
2458 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &iter);
2459 ua_chan_node = lttng_ht_iter_get_node_str(&iter);
2460 if (ua_chan_node == NULL) {
2461 DBG2("Unable to find channel %s in ust session id %" PRIu64,
2462 uchan->name, ua_sess->tracing_id);
2463 goto error;
2464 }
2465
2466 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
2467
2468 ret = enable_ust_channel(app, ua_sess, ua_chan);
2469 if (ret < 0) {
2470 goto error;
2471 }
2472
2473 error:
2474 return ret;
2475 }
2476
2477 /*
2478 * Ask the consumer to create a channel and get it if successful.
2479 *
2480 * Called with UST app session lock held.
2481 *
2482 * Return 0 on success or else a negative value.
2483 */
2484 static int do_consumer_create_channel(struct ltt_ust_session *usess,
2485 struct ust_app_session *ua_sess, struct ust_app_channel *ua_chan,
2486 int bitness, struct ust_registry_session *registry,
2487 uint64_t trace_archive_id)
2488 {
2489 int ret;
2490 unsigned int nb_fd = 0;
2491 struct consumer_socket *socket;
2492
2493 assert(usess);
2494 assert(ua_sess);
2495 assert(ua_chan);
2496 assert(registry);
2497
2498 rcu_read_lock();
2499 health_code_update();
2500
2501 /* Get the right consumer socket for the application. */
2502 socket = consumer_find_socket_by_bitness(bitness, usess->consumer);
2503 if (!socket) {
2504 ret = -EINVAL;
2505 goto error;
2506 }
2507
2508 health_code_update();
2509
2510 /* Need one fd for the channel. */
2511 ret = lttng_fd_get(LTTNG_FD_APPS, 1);
2512 if (ret < 0) {
2513 ERR("Exhausted number of available FD upon create channel");
2514 goto error;
2515 }
2516
2517 /*
2518 * Ask consumer to create channel. The consumer will return the number of
2519 * stream we have to expect.
2520 */
2521 ret = ust_consumer_ask_channel(ua_sess, ua_chan, usess->consumer, socket,
2522 registry, trace_archive_id);
2523 if (ret < 0) {
2524 goto error_ask;
2525 }
2526
2527 /*
2528 * Compute the number of fd needed before receiving them. It must be 2 per
2529 * stream (2 being the default value here).
2530 */
2531 nb_fd = DEFAULT_UST_STREAM_FD_NUM * ua_chan->expected_stream_count;
2532
2533 /* Reserve the amount of file descriptor we need. */
2534 ret = lttng_fd_get(LTTNG_FD_APPS, nb_fd);
2535 if (ret < 0) {
2536 ERR("Exhausted number of available FD upon create channel");
2537 goto error_fd_get_stream;
2538 }
2539
2540 health_code_update();
2541
2542 /*
2543 * Now get the channel from the consumer. This call wil populate the stream
2544 * list of that channel and set the ust objects.
2545 */
2546 if (usess->consumer->enabled) {
2547 ret = ust_consumer_get_channel(socket, ua_chan);
2548 if (ret < 0) {
2549 goto error_destroy;
2550 }
2551 }
2552
2553 rcu_read_unlock();
2554 return 0;
2555
2556 error_destroy:
2557 lttng_fd_put(LTTNG_FD_APPS, nb_fd);
2558 error_fd_get_stream:
2559 /*
2560 * Initiate a destroy channel on the consumer since we had an error
2561 * handling it on our side. The return value is of no importance since we
2562 * already have a ret value set by the previous error that we need to
2563 * return.
2564 */
2565 (void) ust_consumer_destroy_channel(socket, ua_chan);
2566 error_ask:
2567 lttng_fd_put(LTTNG_FD_APPS, 1);
2568 error:
2569 health_code_update();
2570 rcu_read_unlock();
2571 return ret;
2572 }
2573
2574 /*
2575 * Duplicate the ust data object of the ust app stream and save it in the
2576 * buffer registry stream.
2577 *
2578 * Return 0 on success or else a negative value.
2579 */
2580 static int duplicate_stream_object(struct buffer_reg_stream *reg_stream,
2581 struct ust_app_stream *stream)
2582 {
2583 int ret;
2584
2585 assert(reg_stream);
2586 assert(stream);
2587
2588 /* Reserve the amount of file descriptor we need. */
2589 ret = lttng_fd_get(LTTNG_FD_APPS, 2);
2590 if (ret < 0) {
2591 ERR("Exhausted number of available FD upon duplicate stream");
2592 goto error;
2593 }
2594
2595 /* Duplicate object for stream once the original is in the registry. */
2596 ret = ustctl_duplicate_ust_object_data(&stream->obj,
2597 reg_stream->obj.ust);
2598 if (ret < 0) {
2599 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2600 reg_stream->obj.ust, stream->obj, ret);
2601 lttng_fd_put(LTTNG_FD_APPS, 2);
2602 goto error;
2603 }
2604 stream->handle = stream->obj->handle;
2605
2606 error:
2607 return ret;
2608 }
2609
2610 /*
2611 * Duplicate the ust data object of the ust app. channel and save it in the
2612 * buffer registry channel.
2613 *
2614 * Return 0 on success or else a negative value.
2615 */
2616 static int duplicate_channel_object(struct buffer_reg_channel *reg_chan,
2617 struct ust_app_channel *ua_chan)
2618 {
2619 int ret;
2620
2621 assert(reg_chan);
2622 assert(ua_chan);
2623
2624 /* Need two fds for the channel. */
2625 ret = lttng_fd_get(LTTNG_FD_APPS, 1);
2626 if (ret < 0) {
2627 ERR("Exhausted number of available FD upon duplicate channel");
2628 goto error_fd_get;
2629 }
2630
2631 /* Duplicate object for stream once the original is in the registry. */
2632 ret = ustctl_duplicate_ust_object_data(&ua_chan->obj, reg_chan->obj.ust);
2633 if (ret < 0) {
2634 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2635 reg_chan->obj.ust, ua_chan->obj, ret);
2636 goto error;
2637 }
2638 ua_chan->handle = ua_chan->obj->handle;
2639
2640 return 0;
2641
2642 error:
2643 lttng_fd_put(LTTNG_FD_APPS, 1);
2644 error_fd_get:
2645 return ret;
2646 }
2647
2648 /*
2649 * For a given channel buffer registry, setup all streams of the given ust
2650 * application channel.
2651 *
2652 * Return 0 on success or else a negative value.
2653 */
2654 static int setup_buffer_reg_streams(struct buffer_reg_channel *reg_chan,
2655 struct ust_app_channel *ua_chan,
2656 struct ust_app *app)
2657 {
2658 int ret = 0;
2659 struct ust_app_stream *stream, *stmp;
2660
2661 assert(reg_chan);
2662 assert(ua_chan);
2663
2664 DBG2("UST app setup buffer registry stream");
2665
2666 /* Send all streams to application. */
2667 cds_list_for_each_entry_safe(stream, stmp, &ua_chan->streams.head, list) {
2668 struct buffer_reg_stream *reg_stream;
2669
2670 ret = buffer_reg_stream_create(&reg_stream);
2671 if (ret < 0) {
2672 goto error;
2673 }
2674
2675 /*
2676 * Keep original pointer and nullify it in the stream so the delete
2677 * stream call does not release the object.
2678 */
2679 reg_stream->obj.ust = stream->obj;
2680 stream->obj = NULL;
2681 buffer_reg_stream_add(reg_stream, reg_chan);
2682
2683 /* We don't need the streams anymore. */
2684 cds_list_del(&stream->list);
2685 delete_ust_app_stream(-1, stream, app);
2686 }
2687
2688 error:
2689 return ret;
2690 }
2691
2692 /*
2693 * Create a buffer registry channel for the given session registry and
2694 * application channel object. If regp pointer is valid, it's set with the
2695 * created object. Important, the created object is NOT added to the session
2696 * registry hash table.
2697 *
2698 * Return 0 on success else a negative value.
2699 */
2700 static int create_buffer_reg_channel(struct buffer_reg_session *reg_sess,
2701 struct ust_app_channel *ua_chan, struct buffer_reg_channel **regp)
2702 {
2703 int ret;
2704 struct buffer_reg_channel *reg_chan = NULL;
2705
2706 assert(reg_sess);
2707 assert(ua_chan);
2708
2709 DBG2("UST app creating buffer registry channel for %s", ua_chan->name);
2710
2711 /* Create buffer registry channel. */
2712 ret = buffer_reg_channel_create(ua_chan->tracing_channel_id, &reg_chan);
2713 if (ret < 0) {
2714 goto error_create;
2715 }
2716 assert(reg_chan);
2717 reg_chan->consumer_key = ua_chan->key;
2718 reg_chan->subbuf_size = ua_chan->attr.subbuf_size;
2719 reg_chan->num_subbuf = ua_chan->attr.num_subbuf;
2720
2721 /* Create and add a channel registry to session. */
2722 ret = ust_registry_channel_add(reg_sess->reg.ust,
2723 ua_chan->tracing_channel_id);
2724 if (ret < 0) {
2725 goto error;
2726 }
2727 buffer_reg_channel_add(reg_sess, reg_chan);
2728
2729 if (regp) {
2730 *regp = reg_chan;
2731 }
2732
2733 return 0;
2734
2735 error:
2736 /* Safe because the registry channel object was not added to any HT. */
2737 buffer_reg_channel_destroy(reg_chan, LTTNG_DOMAIN_UST);
2738 error_create:
2739 return ret;
2740 }
2741
2742 /*
2743 * Setup buffer registry channel for the given session registry and application
2744 * channel object. If regp pointer is valid, it's set with the created object.
2745 *
2746 * Return 0 on success else a negative value.
2747 */
2748 static int setup_buffer_reg_channel(struct buffer_reg_session *reg_sess,
2749 struct ust_app_channel *ua_chan, struct buffer_reg_channel *reg_chan,
2750 struct ust_app *app)
2751 {
2752 int ret;
2753
2754 assert(reg_sess);
2755 assert(reg_chan);
2756 assert(ua_chan);
2757 assert(ua_chan->obj);
2758
2759 DBG2("UST app setup buffer registry channel for %s", ua_chan->name);
2760
2761 /* Setup all streams for the registry. */
2762 ret = setup_buffer_reg_streams(reg_chan, ua_chan, app);
2763 if (ret < 0) {
2764 goto error;
2765 }
2766
2767 reg_chan->obj.ust = ua_chan->obj;
2768 ua_chan->obj = NULL;
2769
2770 return 0;
2771
2772 error:
2773 buffer_reg_channel_remove(reg_sess, reg_chan);
2774 buffer_reg_channel_destroy(reg_chan, LTTNG_DOMAIN_UST);
2775 return ret;
2776 }
2777
2778 /*
2779 * Send buffer registry channel to the application.
2780 *
2781 * Return 0 on success else a negative value.
2782 */
2783 static int send_channel_uid_to_ust(struct buffer_reg_channel *reg_chan,
2784 struct ust_app *app, struct ust_app_session *ua_sess,
2785 struct ust_app_channel *ua_chan)
2786 {
2787 int ret;
2788 struct buffer_reg_stream *reg_stream;
2789
2790 assert(reg_chan);
2791 assert(app);
2792 assert(ua_sess);
2793 assert(ua_chan);
2794
2795 DBG("UST app sending buffer registry channel to ust sock %d", app->sock);
2796
2797 ret = duplicate_channel_object(reg_chan, ua_chan);
2798 if (ret < 0) {
2799 goto error;
2800 }
2801
2802 /* Send channel to the application. */
2803 ret = ust_consumer_send_channel_to_ust(app, ua_sess, ua_chan);
2804 if (ret == -EPIPE || ret == -LTTNG_UST_ERR_EXITING) {
2805 ret = -ENOTCONN; /* Caused by app exiting. */
2806 goto error;
2807 } else if (ret < 0) {
2808 goto error;
2809 }
2810
2811 health_code_update();
2812
2813 /* Send all streams to application. */
2814 pthread_mutex_lock(&reg_chan->stream_list_lock);
2815 cds_list_for_each_entry(reg_stream, &reg_chan->streams, lnode) {
2816 struct ust_app_stream stream;
2817
2818 ret = duplicate_stream_object(reg_stream, &stream);
2819 if (ret < 0) {
2820 goto error_stream_unlock;
2821 }
2822
2823 ret = ust_consumer_send_stream_to_ust(app, ua_chan, &stream);
2824 if (ret < 0) {
2825 (void) release_ust_app_stream(-1, &stream, app);
2826 if (ret == -EPIPE || ret == -LTTNG_UST_ERR_EXITING) {
2827 ret = -ENOTCONN; /* Caused by app exiting. */
2828 }
2829 goto error_stream_unlock;
2830 }
2831
2832 /*
2833 * The return value is not important here. This function will output an
2834 * error if needed.
2835 */
2836 (void) release_ust_app_stream(-1, &stream, app);
2837 }
2838 ua_chan->is_sent = 1;
2839
2840 error_stream_unlock:
2841 pthread_mutex_unlock(&reg_chan->stream_list_lock);
2842 error:
2843 return ret;
2844 }
2845
2846 /*
2847 * Create and send to the application the created buffers with per UID buffers.
2848 *
2849 * This MUST be called with a RCU read side lock acquired.
2850 * The session list lock and the session's lock must be acquired.
2851 *
2852 * Return 0 on success else a negative value.
2853 */
2854 static int create_channel_per_uid(struct ust_app *app,
2855 struct ltt_ust_session *usess, struct ust_app_session *ua_sess,
2856 struct ust_app_channel *ua_chan)
2857 {
2858 int ret;
2859 struct buffer_reg_uid *reg_uid;
2860 struct buffer_reg_channel *reg_chan;
2861 struct ltt_session *session;
2862 enum lttng_error_code notification_ret;
2863 struct ust_registry_channel *chan_reg;
2864
2865 assert(app);
2866 assert(usess);
2867 assert(ua_sess);
2868 assert(ua_chan);
2869
2870 DBG("UST app creating channel %s with per UID buffers", ua_chan->name);
2871
2872 reg_uid = buffer_reg_uid_find(usess->id, app->bits_per_long, app->uid);
2873 /*
2874 * The session creation handles the creation of this global registry
2875 * object. If none can be find, there is a code flow problem or a
2876 * teardown race.
2877 */
2878 assert(reg_uid);
2879
2880 reg_chan = buffer_reg_channel_find(ua_chan->tracing_channel_id,
2881 reg_uid);
2882 if (reg_chan) {
2883 goto send_channel;
2884 }
2885
2886 /* Create the buffer registry channel object. */
2887 ret = create_buffer_reg_channel(reg_uid->registry, ua_chan, &reg_chan);
2888 if (ret < 0) {
2889 ERR("Error creating the UST channel \"%s\" registry instance",
2890 ua_chan->name);
2891 goto error;
2892 }
2893
2894 session = session_find_by_id(ua_sess->tracing_id);
2895 assert(session);
2896 assert(pthread_mutex_trylock(&session->lock));
2897 assert(session_trylock_list());
2898
2899 /*
2900 * Create the buffers on the consumer side. This call populates the
2901 * ust app channel object with all streams and data object.
2902 */
2903 ret = do_consumer_create_channel(usess, ua_sess, ua_chan,
2904 app->bits_per_long, reg_uid->registry->reg.ust,
2905 session->current_archive_id);
2906 if (ret < 0) {
2907 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2908 ua_chan->name);
2909
2910 /*
2911 * Let's remove the previously created buffer registry channel so
2912 * it's not visible anymore in the session registry.
2913 */
2914 ust_registry_channel_del_free(reg_uid->registry->reg.ust,
2915 ua_chan->tracing_channel_id, false);
2916 buffer_reg_channel_remove(reg_uid->registry, reg_chan);
2917 buffer_reg_channel_destroy(reg_chan, LTTNG_DOMAIN_UST);
2918 goto error;
2919 }
2920
2921 /*
2922 * Setup the streams and add it to the session registry.
2923 */
2924 ret = setup_buffer_reg_channel(reg_uid->registry,
2925 ua_chan, reg_chan, app);
2926 if (ret < 0) {
2927 ERR("Error setting up UST channel \"%s\"", ua_chan->name);
2928 goto error;
2929 }
2930
2931 /* Notify the notification subsystem of the channel's creation. */
2932 pthread_mutex_lock(&reg_uid->registry->reg.ust->lock);
2933 chan_reg = ust_registry_channel_find(reg_uid->registry->reg.ust,
2934 ua_chan->tracing_channel_id);
2935 assert(chan_reg);
2936 chan_reg->consumer_key = ua_chan->key;
2937 chan_reg = NULL;
2938 pthread_mutex_unlock(&reg_uid->registry->reg.ust->lock);
2939
2940 notification_ret = notification_thread_command_add_channel(
2941 notification_thread_handle, session->name,
2942 ua_sess->euid, ua_sess->egid,
2943 ua_chan->name,
2944 ua_chan->key,
2945 LTTNG_DOMAIN_UST,
2946 ua_chan->attr.subbuf_size * ua_chan->attr.num_subbuf);
2947 if (notification_ret != LTTNG_OK) {
2948 ret = - (int) notification_ret;
2949 ERR("Failed to add channel to notification thread");
2950 goto error;
2951 }
2952
2953 send_channel:
2954 /* Send buffers to the application. */
2955 ret = send_channel_uid_to_ust(reg_chan, app, ua_sess, ua_chan);
2956 if (ret < 0) {
2957 if (ret != -ENOTCONN) {
2958 ERR("Error sending channel to application");
2959 }
2960 goto error;
2961 }
2962
2963 error:
2964 return ret;
2965 }
2966
2967 /*
2968 * Create and send to the application the created buffers with per PID buffers.
2969 *
2970 * Called with UST app session lock held.
2971 * The session list lock and the session's lock must be acquired.
2972 *
2973 * Return 0 on success else a negative value.
2974 */
2975 static int create_channel_per_pid(struct ust_app *app,
2976 struct ltt_ust_session *usess, struct ust_app_session *ua_sess,
2977 struct ust_app_channel *ua_chan)
2978 {
2979 int ret;
2980 struct ust_registry_session *registry;
2981 enum lttng_error_code cmd_ret;
2982 struct ltt_session *session;
2983 uint64_t chan_reg_key;
2984 struct ust_registry_channel *chan_reg;
2985
2986 assert(app);
2987 assert(usess);
2988 assert(ua_sess);
2989 assert(ua_chan);
2990
2991 DBG("UST app creating channel %s with per PID buffers", ua_chan->name);
2992
2993 rcu_read_lock();
2994
2995 registry = get_session_registry(ua_sess);
2996 /* The UST app session lock is held, registry shall not be null. */
2997 assert(registry);
2998
2999 /* Create and add a new channel registry to session. */
3000 ret = ust_registry_channel_add(registry, ua_chan->key);
3001 if (ret < 0) {
3002 ERR("Error creating the UST channel \"%s\" registry instance",
3003 ua_chan->name);
3004 goto error;
3005 }
3006
3007 session = session_find_by_id(ua_sess->tracing_id);
3008 assert(session);
3009
3010 assert(pthread_mutex_trylock(&session->lock));
3011 assert(session_trylock_list());
3012
3013 /* Create and get channel on the consumer side. */
3014 ret = do_consumer_create_channel(usess, ua_sess, ua_chan,
3015 app->bits_per_long, registry,
3016 session->current_archive_id);
3017 if (ret < 0) {
3018 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3019 ua_chan->name);
3020 goto error;
3021 }
3022
3023 ret = send_channel_pid_to_ust(app, ua_sess, ua_chan);
3024 if (ret < 0) {
3025 if (ret != -ENOTCONN) {
3026 ERR("Error sending channel to application");
3027 }
3028 goto error;
3029 }
3030
3031 chan_reg_key = ua_chan->key;
3032 pthread_mutex_lock(&registry->lock);
3033 chan_reg = ust_registry_channel_find(registry, chan_reg_key);
3034 assert(chan_reg);
3035 chan_reg->consumer_key = ua_chan->key;
3036 pthread_mutex_unlock(&registry->lock);
3037
3038 cmd_ret = notification_thread_command_add_channel(
3039 notification_thread_handle, session->name,
3040 ua_sess->euid, ua_sess->egid,
3041 ua_chan->name,
3042 ua_chan->key,
3043 LTTNG_DOMAIN_UST,
3044 ua_chan->attr.subbuf_size * ua_chan->attr.num_subbuf);
3045 if (cmd_ret != LTTNG_OK) {
3046 ret = - (int) cmd_ret;
3047 ERR("Failed to add channel to notification thread");
3048 goto error;
3049 }
3050
3051 error:
3052 rcu_read_unlock();
3053 return ret;
3054 }
3055
3056 /*
3057 * From an already allocated ust app channel, create the channel buffers if
3058 * need and send it to the application. This MUST be called with a RCU read
3059 * side lock acquired.
3060 *
3061 * Called with UST app session lock held.
3062 *
3063 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3064 * the application exited concurrently.
3065 */
3066 static int do_create_channel(struct ust_app *app,
3067 struct ltt_ust_session *usess, struct ust_app_session *ua_sess,
3068 struct ust_app_channel *ua_chan)
3069 {
3070 int ret;
3071
3072 assert(app);
3073 assert(usess);
3074 assert(ua_sess);
3075 assert(ua_chan);
3076
3077 /* Handle buffer type before sending the channel to the application. */
3078 switch (usess->buffer_type) {
3079 case LTTNG_BUFFER_PER_UID:
3080 {
3081 ret = create_channel_per_uid(app, usess, ua_sess, ua_chan);
3082 if (ret < 0) {
3083 goto error;
3084 }
3085 break;
3086 }
3087 case LTTNG_BUFFER_PER_PID:
3088 {
3089 ret = create_channel_per_pid(app, usess, ua_sess, ua_chan);
3090 if (ret < 0) {
3091 goto error;
3092 }
3093 break;
3094 }
3095 default:
3096 assert(0);
3097 ret = -EINVAL;
3098 goto error;
3099 }
3100
3101 /* Initialize ust objd object using the received handle and add it. */
3102 lttng_ht_node_init_ulong(&ua_chan->ust_objd_node, ua_chan->handle);
3103 lttng_ht_add_unique_ulong(app->ust_objd, &ua_chan->ust_objd_node);
3104
3105 /* If channel is not enabled, disable it on the tracer */
3106 if (!ua_chan->enabled) {
3107 ret = disable_ust_channel(app, ua_sess, ua_chan);
3108 if (ret < 0) {
3109 goto error;
3110 }
3111 }
3112
3113 error:
3114 return ret;
3115 }
3116
3117 /*
3118 * Create UST app channel and create it on the tracer. Set ua_chanp of the
3119 * newly created channel if not NULL.
3120 *
3121 * Called with UST app session lock and RCU read-side lock held.
3122 *
3123 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3124 * the application exited concurrently.
3125 */
3126 static int create_ust_app_channel(struct ust_app_session *ua_sess,
3127 struct ltt_ust_channel *uchan, struct ust_app *app,
3128 enum lttng_ust_chan_type type, struct ltt_ust_session *usess,
3129 struct ust_app_channel **ua_chanp)
3130 {
3131 int ret = 0;
3132 struct lttng_ht_iter iter;
3133 struct lttng_ht_node_str *ua_chan_node;
3134 struct ust_app_channel *ua_chan;
3135
3136 /* Lookup channel in the ust app session */
3137 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &iter);
3138 ua_chan_node = lttng_ht_iter_get_node_str(&iter);
3139 if (ua_chan_node != NULL) {
3140 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
3141 goto end;
3142 }
3143
3144 ua_chan = alloc_ust_app_channel(uchan->name, ua_sess, &uchan->attr);
3145 if (ua_chan == NULL) {
3146 /* Only malloc can fail here */
3147 ret = -ENOMEM;
3148 goto error_alloc;
3149 }
3150 shadow_copy_channel(ua_chan, uchan);
3151
3152 /* Set channel type. */
3153 ua_chan->attr.type = type;
3154
3155 ret = do_create_channel(app, usess, ua_sess, ua_chan);
3156 if (ret < 0) {
3157 goto error;
3158 }
3159
3160 DBG2("UST app create channel %s for PID %d completed", ua_chan->name,
3161 app->pid);
3162
3163 /* Only add the channel if successful on the tracer side. */
3164 lttng_ht_add_unique_str(ua_sess->channels, &ua_chan->node);
3165 end:
3166 if (ua_chanp) {
3167 *ua_chanp = ua_chan;
3168 }
3169
3170 /* Everything went well. */
3171 return 0;
3172
3173 error:
3174 delete_ust_app_channel(ua_chan->is_sent ? app->sock : -1, ua_chan, app);
3175 error_alloc:
3176 return ret;
3177 }
3178
3179 /*
3180 * Create UST app event and create it on the tracer side.
3181 *
3182 * Called with ust app session mutex held.
3183 */
3184 static
3185 int create_ust_app_event(struct ust_app_session *ua_sess,
3186 struct ust_app_channel *ua_chan, struct ltt_ust_event *uevent,
3187 struct ust_app *app)
3188 {
3189 int ret = 0;
3190 struct ust_app_event *ua_event;
3191
3192 /* Get event node */
3193 ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
3194 uevent->filter, uevent->attr.loglevel, uevent->exclusion);
3195 if (ua_event != NULL) {
3196 ret = -EEXIST;
3197 goto end;
3198 }
3199
3200 /* Does not exist so create one */
3201 ua_event = alloc_ust_app_event(uevent->attr.name, &uevent->attr);
3202 if (ua_event == NULL) {
3203 /* Only malloc can failed so something is really wrong */
3204 ret = -ENOMEM;
3205 goto end;
3206 }
3207 shadow_copy_event(ua_event, uevent);
3208
3209 /* Create it on the tracer side */
3210 ret = create_ust_event(app, ua_sess, ua_chan, ua_event);
3211 if (ret < 0) {
3212 /* Not found previously means that it does not exist on the tracer */
3213 assert(ret != -LTTNG_UST_ERR_EXIST);
3214 goto error;
3215 }
3216
3217 add_unique_ust_app_event(ua_chan, ua_event);
3218
3219 DBG2("UST app create event %s for PID %d completed", ua_event->name,
3220 app->pid);
3221
3222 end:
3223 return ret;
3224
3225 error:
3226 /* Valid. Calling here is already in a read side lock */
3227 delete_ust_app_event(-1, ua_event, app);
3228 return ret;
3229 }
3230
3231 /*
3232 * Create UST metadata and open it on the tracer side.
3233 *
3234 * Called with UST app session lock held and RCU read side lock.
3235 */
3236 static int create_ust_app_metadata(struct ust_app_session *ua_sess,
3237 struct ust_app *app, struct consumer_output *consumer)
3238 {
3239 int ret = 0;
3240 struct ust_app_channel *metadata;
3241 struct consumer_socket *socket;
3242 struct ust_registry_session *registry;
3243 struct ltt_session *session;
3244
3245 assert(ua_sess);
3246 assert(app);
3247 assert(consumer);
3248
3249 registry = get_session_registry(ua_sess);
3250 /* The UST app session is held registry shall not be null. */
3251 assert(registry);
3252
3253 pthread_mutex_lock(&registry->lock);
3254
3255 /* Metadata already exists for this registry or it was closed previously */
3256 if (registry->metadata_key || registry->metadata_closed) {
3257 ret = 0;
3258 goto error;
3259 }
3260
3261 /* Allocate UST metadata */
3262 metadata = alloc_ust_app_channel(DEFAULT_METADATA_NAME, ua_sess, NULL);
3263 if (!metadata) {
3264 /* malloc() failed */
3265 ret = -ENOMEM;
3266 goto error;
3267 }
3268
3269 memcpy(&metadata->attr, &ua_sess->metadata_attr, sizeof(metadata->attr));
3270
3271 /* Need one fd for the channel. */
3272 ret = lttng_fd_get(LTTNG_FD_APPS, 1);
3273 if (ret < 0) {
3274 ERR("Exhausted number of available FD upon create metadata");
3275 goto error;
3276 }
3277
3278 /* Get the right consumer socket for the application. */
3279 socket = consumer_find_socket_by_bitness(app->bits_per_long, consumer);
3280 if (!socket) {
3281 ret = -EINVAL;
3282 goto error_consumer;
3283 }
3284
3285 /*
3286 * Keep metadata key so we can identify it on the consumer side. Assign it
3287 * to the registry *before* we ask the consumer so we avoid the race of the
3288 * consumer requesting the metadata and the ask_channel call on our side
3289 * did not returned yet.
3290 */
3291 registry->metadata_key = metadata->key;
3292
3293 session = session_find_by_id(ua_sess->tracing_id);
3294 assert(session);
3295
3296 assert(pthread_mutex_trylock(&session->lock));
3297 assert(session_trylock_list());
3298
3299 /*
3300 * Ask the metadata channel creation to the consumer. The metadata object
3301 * will be created by the consumer and kept their. However, the stream is
3302 * never added or monitored until we do a first push metadata to the
3303 * consumer.
3304 */
3305 ret = ust_consumer_ask_channel(ua_sess, metadata, consumer, socket,
3306 registry, session->current_archive_id);
3307 if (ret < 0) {
3308 /* Nullify the metadata key so we don't try to close it later on. */
3309 registry->metadata_key = 0;
3310 goto error_consumer;
3311 }
3312
3313 /*
3314 * The setup command will make the metadata stream be sent to the relayd,
3315 * if applicable, and the thread managing the metadatas. This is important
3316 * because after this point, if an error occurs, the only way the stream
3317 * can be deleted is to be monitored in the consumer.
3318 */
3319 ret = consumer_setup_metadata(socket, metadata->key);
3320 if (ret < 0) {
3321 /* Nullify the metadata key so we don't try to close it later on. */
3322 registry->metadata_key = 0;
3323 goto error_consumer;
3324 }
3325
3326 DBG2("UST metadata with key %" PRIu64 " created for app pid %d",
3327 metadata->key, app->pid);
3328
3329 error_consumer:
3330 lttng_fd_put(LTTNG_FD_APPS, 1);
3331 delete_ust_app_channel(-1, metadata, app);
3332 error:
3333 pthread_mutex_unlock(&registry->lock);
3334 return ret;
3335 }
3336
3337 /*
3338 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3339 * acquired before calling this function.
3340 */
3341 struct ust_app *ust_app_find_by_pid(pid_t pid)
3342 {
3343 struct ust_app *app = NULL;
3344 struct lttng_ht_node_ulong *node;
3345 struct lttng_ht_iter iter;
3346
3347 lttng_ht_lookup(ust_app_ht, (void *)((unsigned long) pid), &iter);
3348 node = lttng_ht_iter_get_node_ulong(&iter);
3349 if (node == NULL) {
3350 DBG2("UST app no found with pid %d", pid);
3351 goto error;
3352 }
3353
3354 DBG2("Found UST app by pid %d", pid);
3355
3356 app = caa_container_of(node, struct ust_app, pid_n);
3357
3358 error:
3359 return app;
3360 }
3361
3362 /*
3363 * Allocate and init an UST app object using the registration information and
3364 * the command socket. This is called when the command socket connects to the
3365 * session daemon.
3366 *
3367 * The object is returned on success or else NULL.
3368 */
3369 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
3370 {
3371 struct ust_app *lta = NULL;
3372
3373 assert(msg);
3374 assert(sock >= 0);
3375
3376 DBG3("UST app creating application for socket %d", sock);
3377
3378 if ((msg->bits_per_long == 64 &&
3379 (uatomic_read(&ust_consumerd64_fd) == -EINVAL))
3380 || (msg->bits_per_long == 32 &&
3381 (uatomic_read(&ust_consumerd32_fd) == -EINVAL))) {
3382 ERR("Registration failed: application \"%s\" (pid: %d) has "
3383 "%d-bit long, but no consumerd for this size is available.\n",
3384 msg->name, msg->pid, msg->bits_per_long);
3385 goto error;
3386 }
3387
3388 lta = zmalloc(sizeof(struct ust_app));
3389 if (lta == NULL) {
3390 PERROR("malloc");
3391 goto error;
3392 }
3393
3394 lta->ppid = msg->ppid;
3395 lta->uid = msg->uid;
3396 lta->gid = msg->gid;
3397
3398 lta->bits_per_long = msg->bits_per_long;
3399 lta->uint8_t_alignment = msg->uint8_t_alignment;
3400 lta->uint16_t_alignment = msg->uint16_t_alignment;
3401 lta->uint32_t_alignment = msg->uint32_t_alignment;
3402 lta->uint64_t_alignment = msg->uint64_t_alignment;
3403 lta->long_alignment = msg->long_alignment;
3404 lta->byte_order = msg->byte_order;
3405
3406 lta->v_major = msg->major;
3407 lta->v_minor = msg->minor;
3408 lta->sessions = lttng_ht_new(0, LTTNG_HT_TYPE_U64);
3409 lta->ust_objd = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
3410 lta->ust_sessions_objd = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
3411 lta->notify_sock = -1;
3412
3413 /* Copy name and make sure it's NULL terminated. */
3414 strncpy(lta->name, msg->name, sizeof(lta->name));
3415 lta->name[UST_APP_PROCNAME_LEN] = '\0';
3416
3417 /*
3418 * Before this can be called, when receiving the registration information,
3419 * the application compatibility is checked. So, at this point, the
3420 * application can work with this session daemon.
3421 */
3422 lta->compatible = 1;
3423
3424 lta->pid = msg->pid;
3425 lttng_ht_node_init_ulong(&lta->pid_n, (unsigned long) lta->pid);
3426 lta->sock = sock;
3427 pthread_mutex_init(&lta->sock_lock, NULL);
3428 lttng_ht_node_init_ulong(&lta->sock_n, (unsigned long) lta->sock);
3429
3430 CDS_INIT_LIST_HEAD(&lta->teardown_head);
3431 error:
3432 return lta;
3433 }
3434
3435 /*
3436 * For a given application object, add it to every hash table.
3437 */
3438 void ust_app_add(struct ust_app *app)
3439 {
3440 assert(app);
3441 assert(app->notify_sock >= 0);
3442
3443 rcu_read_lock();
3444
3445 /*
3446 * On a re-registration, we want to kick out the previous registration of
3447 * that pid
3448 */
3449 lttng_ht_add_replace_ulong(ust_app_ht, &app->pid_n);
3450
3451 /*
3452 * The socket _should_ be unique until _we_ call close. So, a add_unique
3453 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3454 * already in the table.
3455 */
3456 lttng_ht_add_unique_ulong(ust_app_ht_by_sock, &app->sock_n);
3457
3458 /* Add application to the notify socket hash table. */
3459 lttng_ht_node_init_ulong(&app->notify_sock_n, app->notify_sock);
3460 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock, &app->notify_sock_n);
3461
3462 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3463 "notify_sock:%d (version %d.%d)", app->pid, app->ppid, app->uid,
3464 app->gid, app->sock, app->name, app->notify_sock, app->v_major,
3465 app->v_minor);
3466
3467 rcu_read_unlock();
3468 }
3469
3470 /*
3471 * Set the application version into the object.
3472 *
3473 * Return 0 on success else a negative value either an errno code or a
3474 * LTTng-UST error code.
3475 */
3476 int ust_app_version(struct ust_app *app)
3477 {
3478 int ret;
3479
3480 assert(app);
3481
3482 pthread_mutex_lock(&app->sock_lock);
3483 ret = ustctl_tracer_version(app->sock, &app->version);
3484 pthread_mutex_unlock(&app->sock_lock);
3485 if (ret < 0) {
3486 if (ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
3487 ERR("UST app %d version failed with ret %d", app->sock, ret);
3488 } else {
3489 DBG3("UST app %d version failed. Application is dead", app->sock);
3490 }
3491 }
3492
3493 return ret;
3494 }
3495
3496 /*
3497 * Unregister app by removing it from the global traceable app list and freeing
3498 * the data struct.
3499 *
3500 * The socket is already closed at this point so no close to sock.
3501 */
3502 void ust_app_unregister(int sock)
3503 {
3504 struct ust_app *lta;
3505 struct lttng_ht_node_ulong *node;
3506 struct lttng_ht_iter ust_app_sock_iter;
3507 struct lttng_ht_iter iter;
3508 struct ust_app_session *ua_sess;
3509 int ret;
3510
3511 rcu_read_lock();
3512
3513 /* Get the node reference for a call_rcu */
3514 lttng_ht_lookup(ust_app_ht_by_sock, (void *)((unsigned long) sock), &ust_app_sock_iter);
3515 node = lttng_ht_iter_get_node_ulong(&ust_app_sock_iter);
3516 assert(node);
3517
3518 lta = caa_container_of(node, struct ust_app, sock_n);
3519 DBG("PID %d unregistering with sock %d", lta->pid, sock);
3520
3521 /*
3522 * For per-PID buffers, perform "push metadata" and flush all
3523 * application streams before removing app from hash tables,
3524 * ensuring proper behavior of data_pending check.
3525 * Remove sessions so they are not visible during deletion.
3526 */
3527 cds_lfht_for_each_entry(lta->sessions->ht, &iter.iter, ua_sess,
3528 node.node) {
3529 struct ust_registry_session *registry;
3530
3531 ret = lttng_ht_del(lta->sessions, &iter);
3532 if (ret) {
3533 /* The session was already removed so scheduled for teardown. */
3534 continue;
3535 }
3536
3537 if (ua_sess->buffer_type == LTTNG_BUFFER_PER_PID) {
3538 (void) ust_app_flush_app_session(lta, ua_sess);
3539 }
3540
3541 /*
3542 * Add session to list for teardown. This is safe since at this point we
3543 * are the only one using this list.
3544 */
3545 pthread_mutex_lock(&ua_sess->lock);
3546
3547 if (ua_sess->deleted) {
3548 pthread_mutex_unlock(&ua_sess->lock);
3549 continue;
3550 }
3551
3552 /*
3553 * Normally, this is done in the delete session process which is
3554 * executed in the call rcu below. However, upon registration we can't
3555 * afford to wait for the grace period before pushing data or else the
3556 * data pending feature can race between the unregistration and stop
3557 * command where the data pending command is sent *before* the grace
3558 * period ended.
3559 *
3560 * The close metadata below nullifies the metadata pointer in the
3561 * session so the delete session will NOT push/close a second time.
3562 */
3563 registry = get_session_registry(ua_sess);
3564 if (registry) {
3565 /* Push metadata for application before freeing the application. */
3566 (void) push_metadata(registry, ua_sess->consumer);
3567
3568 /*
3569 * Don't ask to close metadata for global per UID buffers. Close
3570 * metadata only on destroy trace session in this case. Also, the
3571 * previous push metadata could have flag the metadata registry to
3572 * close so don't send a close command if closed.
3573 */
3574 if (ua_sess->buffer_type != LTTNG_BUFFER_PER_UID) {
3575 /* And ask to close it for this session registry. */
3576 (void) close_metadata(registry, ua_sess->consumer);
3577 }
3578 }
3579 cds_list_add(&ua_sess->teardown_node, &lta->teardown_head);
3580
3581 pthread_mutex_unlock(&ua_sess->lock);
3582 }
3583
3584 /* Remove application from PID hash table */
3585 ret = lttng_ht_del(ust_app_ht_by_sock, &ust_app_sock_iter);
3586 assert(!ret);
3587
3588 /*
3589 * Remove application from notify hash table. The thread handling the
3590 * notify socket could have deleted the node so ignore on error because
3591 * either way it's valid. The close of that socket is handled by the
3592 * apps_notify_thread.
3593 */
3594 iter.iter.node = &lta->notify_sock_n.node;
3595 (void) lttng_ht_del(ust_app_ht_by_notify_sock, &iter);
3596
3597 /*
3598 * Ignore return value since the node might have been removed before by an
3599 * add replace during app registration because the PID can be reassigned by
3600 * the OS.
3601 */
3602 iter.iter.node = &lta->pid_n.node;
3603 ret = lttng_ht_del(ust_app_ht, &iter);
3604 if (ret) {
3605 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3606 lta->pid);
3607 }
3608
3609 /* Free memory */
3610 call_rcu(&lta->pid_n.head, delete_ust_app_rcu);
3611
3612 rcu_read_unlock();
3613 return;
3614 }
3615
3616 /*
3617 * Fill events array with all events name of all registered apps.
3618 */
3619 int ust_app_list_events(struct lttng_event **events)
3620 {
3621 int ret, handle;
3622 size_t nbmem, count = 0;
3623 struct lttng_ht_iter iter;
3624 struct ust_app *app;
3625 struct lttng_event *tmp_event;
3626
3627 nbmem = UST_APP_EVENT_LIST_SIZE;
3628 tmp_event = zmalloc(nbmem * sizeof(struct lttng_event));
3629 if (tmp_event == NULL) {
3630 PERROR("zmalloc ust app events");
3631 ret = -ENOMEM;
3632 goto error;
3633 }
3634
3635 rcu_read_lock();
3636
3637 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3638 struct lttng_ust_tracepoint_iter uiter;
3639
3640 health_code_update();
3641
3642 if (!app->compatible) {
3643 /*
3644 * TODO: In time, we should notice the caller of this error by
3645 * telling him that this is a version error.
3646 */
3647 continue;
3648 }
3649 pthread_mutex_lock(&app->sock_lock);
3650 handle = ustctl_tracepoint_list(app->sock);
3651 if (handle < 0) {
3652 if (handle != -EPIPE && handle != -LTTNG_UST_ERR_EXITING) {
3653 ERR("UST app list events getting handle failed for app pid %d",
3654 app->pid);
3655 }
3656 pthread_mutex_unlock(&app->sock_lock);
3657 continue;
3658 }
3659
3660 while ((ret = ustctl_tracepoint_list_get(app->sock, handle,
3661 &uiter)) != -LTTNG_UST_ERR_NOENT) {
3662 /* Handle ustctl error. */
3663 if (ret < 0) {
3664 int release_ret;
3665
3666 if (ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
3667 ERR("UST app tp list get failed for app %d with ret %d",
3668 app->sock, ret);
3669 } else {
3670 DBG3("UST app tp list get failed. Application is dead");
3671 /*
3672 * This is normal behavior, an application can die during the
3673 * creation process. Don't report an error so the execution can
3674 * continue normally. Continue normal execution.
3675 */
3676 break;
3677 }
3678 free(tmp_event);
3679 release_ret = ustctl_release_handle(app->sock, handle);
3680 if (release_ret < 0 &&
3681 release_ret != -LTTNG_UST_ERR_EXITING &&
3682 release_ret != -EPIPE) {
3683 ERR("Error releasing app handle for app %d with ret %d", app->sock, release_ret);
3684 }
3685 pthread_mutex_unlock(&app->sock_lock);
3686 goto rcu_error;
3687 }
3688
3689 health_code_update();
3690 if (count >= nbmem) {
3691 /* In case the realloc fails, we free the memory */
3692 struct lttng_event *new_tmp_event;
3693 size_t new_nbmem;
3694
3695 new_nbmem = nbmem << 1;
3696 DBG2("Reallocating event list from %zu to %zu entries",
3697 nbmem, new_nbmem);
3698 new_tmp_event = realloc(tmp_event,
3699 new_nbmem * sizeof(struct lttng_event));
3700 if (new_tmp_event == NULL) {
3701 int release_ret;
3702
3703 PERROR("realloc ust app events");
3704 free(tmp_event);
3705 ret = -ENOMEM;
3706 release_ret = ustctl_release_handle(app->sock, handle);
3707 if (release_ret < 0 &&
3708 release_ret != -LTTNG_UST_ERR_EXITING &&
3709 release_ret != -EPIPE) {
3710 ERR("Error releasing app handle for app %d with ret %d", app->sock, release_ret);
3711 }
3712 pthread_mutex_unlock(&app->sock_lock);
3713 goto rcu_error;
3714 }
3715 /* Zero the new memory */
3716 memset(new_tmp_event + nbmem, 0,
3717 (new_nbmem - nbmem) * sizeof(struct lttng_event));
3718 nbmem = new_nbmem;
3719 tmp_event = new_tmp_event;
3720 }
3721 memcpy(tmp_event[count].name, uiter.name, LTTNG_UST_SYM_NAME_LEN);
3722 tmp_event[count].loglevel = uiter.loglevel;