54c22df766f2badb44a9a1e4ae66dab17984c2c4
[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
45 static
46 int ust_app_flush_app_session(struct ust_app *app, struct ust_app_session *ua_sess);
47
48 /* Next available channel key. Access under next_channel_key_lock. */
49 static uint64_t _next_channel_key;
50 static pthread_mutex_t next_channel_key_lock = PTHREAD_MUTEX_INITIALIZER;
51
52 /* Next available session ID. Access under next_session_id_lock. */
53 static uint64_t _next_session_id;
54 static pthread_mutex_t next_session_id_lock = PTHREAD_MUTEX_INITIALIZER;
55
56 /*
57 * Return the incremented value of next_channel_key.
58 */
59 static uint64_t get_next_channel_key(void)
60 {
61 uint64_t ret;
62
63 pthread_mutex_lock(&next_channel_key_lock);
64 ret = ++_next_channel_key;
65 pthread_mutex_unlock(&next_channel_key_lock);
66 return ret;
67 }
68
69 /*
70 * Return the atomically incremented value of next_session_id.
71 */
72 static uint64_t get_next_session_id(void)
73 {
74 uint64_t ret;
75
76 pthread_mutex_lock(&next_session_id_lock);
77 ret = ++_next_session_id;
78 pthread_mutex_unlock(&next_session_id_lock);
79 return ret;
80 }
81
82 static void copy_channel_attr_to_ustctl(
83 struct ustctl_consumer_channel_attr *attr,
84 struct lttng_ust_channel_attr *uattr)
85 {
86 /* Copy event attributes since the layout is different. */
87 attr->subbuf_size = uattr->subbuf_size;
88 attr->num_subbuf = uattr->num_subbuf;
89 attr->overwrite = uattr->overwrite;
90 attr->switch_timer_interval = uattr->switch_timer_interval;
91 attr->read_timer_interval = uattr->read_timer_interval;
92 attr->output = uattr->output;
93 }
94
95 /*
96 * Match function for the hash table lookup.
97 *
98 * It matches an ust app event based on three attributes which are the event
99 * name, the filter bytecode and the loglevel.
100 */
101 static int ht_match_ust_app_event(struct cds_lfht_node *node, const void *_key)
102 {
103 struct ust_app_event *event;
104 const struct ust_app_ht_key *key;
105 int ev_loglevel_value;
106
107 assert(node);
108 assert(_key);
109
110 event = caa_container_of(node, struct ust_app_event, node.node);
111 key = _key;
112 ev_loglevel_value = event->attr.loglevel;
113
114 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
115
116 /* Event name */
117 if (strncmp(event->attr.name, key->name, sizeof(event->attr.name)) != 0) {
118 goto no_match;
119 }
120
121 /* Event loglevel. */
122 if (ev_loglevel_value != key->loglevel_type) {
123 if (event->attr.loglevel_type == LTTNG_UST_LOGLEVEL_ALL
124 && key->loglevel_type == 0 &&
125 ev_loglevel_value == -1) {
126 /*
127 * Match is accepted. This is because on event creation, the
128 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
129 * -1 are accepted for this loglevel type since 0 is the one set by
130 * the API when receiving an enable event.
131 */
132 } else {
133 goto no_match;
134 }
135 }
136
137 /* One of the filters is NULL, fail. */
138 if ((key->filter && !event->filter) || (!key->filter && event->filter)) {
139 goto no_match;
140 }
141
142 if (key->filter && event->filter) {
143 /* Both filters exists, check length followed by the bytecode. */
144 if (event->filter->len != key->filter->len ||
145 memcmp(event->filter->data, key->filter->data,
146 event->filter->len) != 0) {
147 goto no_match;
148 }
149 }
150
151 /* One of the exclusions is NULL, fail. */
152 if ((key->exclusion && !event->exclusion) || (!key->exclusion && event->exclusion)) {
153 goto no_match;
154 }
155
156 if (key->exclusion && event->exclusion) {
157 /* Both exclusions exists, check count followed by the names. */
158 if (event->exclusion->count != key->exclusion->count ||
159 memcmp(event->exclusion->names, key->exclusion->names,
160 event->exclusion->count * LTTNG_UST_SYM_NAME_LEN) != 0) {
161 goto no_match;
162 }
163 }
164
165
166 /* Match. */
167 return 1;
168
169 no_match:
170 return 0;
171 }
172
173 /*
174 * Unique add of an ust app event in the given ht. This uses the custom
175 * ht_match_ust_app_event match function and the event name as hash.
176 */
177 static void add_unique_ust_app_event(struct ust_app_channel *ua_chan,
178 struct ust_app_event *event)
179 {
180 struct cds_lfht_node *node_ptr;
181 struct ust_app_ht_key key;
182 struct lttng_ht *ht;
183
184 assert(ua_chan);
185 assert(ua_chan->events);
186 assert(event);
187
188 ht = ua_chan->events;
189 key.name = event->attr.name;
190 key.filter = event->filter;
191 key.loglevel_type = event->attr.loglevel;
192 key.exclusion = event->exclusion;
193
194 node_ptr = cds_lfht_add_unique(ht->ht,
195 ht->hash_fct(event->node.key, lttng_ht_seed),
196 ht_match_ust_app_event, &key, &event->node.node);
197 assert(node_ptr == &event->node.node);
198 }
199
200 /*
201 * Close the notify socket from the given RCU head object. This MUST be called
202 * through a call_rcu().
203 */
204 static void close_notify_sock_rcu(struct rcu_head *head)
205 {
206 int ret;
207 struct ust_app_notify_sock_obj *obj =
208 caa_container_of(head, struct ust_app_notify_sock_obj, head);
209
210 /* Must have a valid fd here. */
211 assert(obj->fd >= 0);
212
213 ret = close(obj->fd);
214 if (ret) {
215 ERR("close notify sock %d RCU", obj->fd);
216 }
217 lttng_fd_put(LTTNG_FD_APPS, 1);
218
219 free(obj);
220 }
221
222 /*
223 * Return the session registry according to the buffer type of the given
224 * session.
225 *
226 * A registry per UID object MUST exists before calling this function or else
227 * it assert() if not found. RCU read side lock must be acquired.
228 */
229 static struct ust_registry_session *get_session_registry(
230 struct ust_app_session *ua_sess)
231 {
232 struct ust_registry_session *registry = NULL;
233
234 assert(ua_sess);
235
236 switch (ua_sess->buffer_type) {
237 case LTTNG_BUFFER_PER_PID:
238 {
239 struct buffer_reg_pid *reg_pid = buffer_reg_pid_find(ua_sess->id);
240 if (!reg_pid) {
241 goto error;
242 }
243 registry = reg_pid->registry->reg.ust;
244 break;
245 }
246 case LTTNG_BUFFER_PER_UID:
247 {
248 struct buffer_reg_uid *reg_uid = buffer_reg_uid_find(
249 ua_sess->tracing_id, ua_sess->bits_per_long, ua_sess->uid);
250 if (!reg_uid) {
251 goto error;
252 }
253 registry = reg_uid->registry->reg.ust;
254 break;
255 }
256 default:
257 assert(0);
258 };
259
260 error:
261 return registry;
262 }
263
264 /*
265 * Delete ust context safely. RCU read lock must be held before calling
266 * this function.
267 */
268 static
269 void delete_ust_app_ctx(int sock, struct ust_app_ctx *ua_ctx,
270 struct ust_app *app)
271 {
272 int ret;
273
274 assert(ua_ctx);
275
276 if (ua_ctx->obj) {
277 pthread_mutex_lock(&app->sock_lock);
278 ret = ustctl_release_object(sock, ua_ctx->obj);
279 pthread_mutex_unlock(&app->sock_lock);
280 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
281 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
282 sock, ua_ctx->obj->handle, ret);
283 }
284 free(ua_ctx->obj);
285 }
286 free(ua_ctx);
287 }
288
289 /*
290 * Delete ust app event safely. RCU read lock must be held before calling
291 * this function.
292 */
293 static
294 void delete_ust_app_event(int sock, struct ust_app_event *ua_event,
295 struct ust_app *app)
296 {
297 int ret;
298
299 assert(ua_event);
300
301 free(ua_event->filter);
302 if (ua_event->exclusion != NULL)
303 free(ua_event->exclusion);
304 if (ua_event->obj != NULL) {
305 pthread_mutex_lock(&app->sock_lock);
306 ret = ustctl_release_object(sock, ua_event->obj);
307 pthread_mutex_unlock(&app->sock_lock);
308 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
309 ERR("UST app sock %d release event obj failed with ret %d",
310 sock, ret);
311 }
312 free(ua_event->obj);
313 }
314 free(ua_event);
315 }
316
317 /*
318 * Release ust data object of the given stream.
319 *
320 * Return 0 on success or else a negative value.
321 */
322 static int release_ust_app_stream(int sock, struct ust_app_stream *stream,
323 struct ust_app *app)
324 {
325 int ret = 0;
326
327 assert(stream);
328
329 if (stream->obj) {
330 pthread_mutex_lock(&app->sock_lock);
331 ret = ustctl_release_object(sock, stream->obj);
332 pthread_mutex_unlock(&app->sock_lock);
333 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
334 ERR("UST app sock %d release stream obj failed with ret %d",
335 sock, ret);
336 }
337 lttng_fd_put(LTTNG_FD_APPS, 2);
338 free(stream->obj);
339 }
340
341 return ret;
342 }
343
344 /*
345 * Delete ust app stream safely. RCU read lock must be held before calling
346 * this function.
347 */
348 static
349 void delete_ust_app_stream(int sock, struct ust_app_stream *stream,
350 struct ust_app *app)
351 {
352 assert(stream);
353
354 (void) release_ust_app_stream(sock, stream, app);
355 free(stream);
356 }
357
358 /*
359 * We need to execute ht_destroy outside of RCU read-side critical
360 * section and outside of call_rcu thread, so we postpone its execution
361 * using ht_cleanup_push. It is simpler than to change the semantic of
362 * the many callers of delete_ust_app_session().
363 */
364 static
365 void delete_ust_app_channel_rcu(struct rcu_head *head)
366 {
367 struct ust_app_channel *ua_chan =
368 caa_container_of(head, struct ust_app_channel, rcu_head);
369
370 ht_cleanup_push(ua_chan->ctx);
371 ht_cleanup_push(ua_chan->events);
372 free(ua_chan);
373 }
374
375 /*
376 * Extract the lost packet or discarded events counter when the channel is
377 * being deleted and store the value in the parent channel so we can
378 * access it from lttng list and at stop/destroy.
379 *
380 * The session list lock must be held by the caller.
381 */
382 static
383 void save_per_pid_lost_discarded_counters(struct ust_app_channel *ua_chan)
384 {
385 uint64_t discarded = 0, lost = 0;
386 struct ltt_session *session;
387 struct ltt_ust_channel *uchan;
388
389 if (ua_chan->attr.type != LTTNG_UST_CHAN_PER_CPU) {
390 return;
391 }
392
393 rcu_read_lock();
394 session = session_find_by_id(ua_chan->session->tracing_id);
395 if (!session || !session->ust_session) {
396 /*
397 * Not finding the session is not an error because there are
398 * multiple ways the channels can be torn down.
399 *
400 * 1) The session daemon can initiate the destruction of the
401 * ust app session after receiving a destroy command or
402 * during its shutdown/teardown.
403 * 2) The application, since we are in per-pid tracing, is
404 * unregistering and tearing down its ust app session.
405 *
406 * Both paths are protected by the session list lock which
407 * ensures that the accounting of lost packets and discarded
408 * events is done exactly once. The session is then unpublished
409 * from the session list, resulting in this condition.
410 */
411 goto end;
412 }
413
414 if (ua_chan->attr.overwrite) {
415 consumer_get_lost_packets(ua_chan->session->tracing_id,
416 ua_chan->key, session->ust_session->consumer,
417 &lost);
418 } else {
419 consumer_get_discarded_events(ua_chan->session->tracing_id,
420 ua_chan->key, session->ust_session->consumer,
421 &discarded);
422 }
423 uchan = trace_ust_find_channel_by_name(
424 session->ust_session->domain_global.channels,
425 ua_chan->name);
426 if (!uchan) {
427 ERR("Missing UST channel to store discarded counters");
428 goto end;
429 }
430
431 uchan->per_pid_closed_app_discarded += discarded;
432 uchan->per_pid_closed_app_lost += lost;
433
434 end:
435 rcu_read_unlock();
436 }
437
438 /*
439 * Delete ust app channel safely. RCU read lock must be held before calling
440 * this function.
441 *
442 * The session list lock must be held by the caller.
443 */
444 static
445 void delete_ust_app_channel(int sock, struct ust_app_channel *ua_chan,
446 struct ust_app *app)
447 {
448 int ret;
449 struct lttng_ht_iter iter;
450 struct ust_app_event *ua_event;
451 struct ust_app_ctx *ua_ctx;
452 struct ust_app_stream *stream, *stmp;
453 struct ust_registry_session *registry;
454
455 assert(ua_chan);
456
457 DBG3("UST app deleting channel %s", ua_chan->name);
458
459 /* Wipe stream */
460 cds_list_for_each_entry_safe(stream, stmp, &ua_chan->streams.head, list) {
461 cds_list_del(&stream->list);
462 delete_ust_app_stream(sock, stream, app);
463 }
464
465 /* Wipe context */
466 cds_lfht_for_each_entry(ua_chan->ctx->ht, &iter.iter, ua_ctx, node.node) {
467 cds_list_del(&ua_ctx->list);
468 ret = lttng_ht_del(ua_chan->ctx, &iter);
469 assert(!ret);
470 delete_ust_app_ctx(sock, ua_ctx, app);
471 }
472
473 /* Wipe events */
474 cds_lfht_for_each_entry(ua_chan->events->ht, &iter.iter, ua_event,
475 node.node) {
476 ret = lttng_ht_del(ua_chan->events, &iter);
477 assert(!ret);
478 delete_ust_app_event(sock, ua_event, app);
479 }
480
481 if (ua_chan->session->buffer_type == LTTNG_BUFFER_PER_PID) {
482 /* Wipe and free registry from session registry. */
483 registry = get_session_registry(ua_chan->session);
484 if (registry) {
485 ust_registry_channel_del_free(registry, ua_chan->key);
486 }
487 save_per_pid_lost_discarded_counters(ua_chan);
488 }
489
490 if (ua_chan->obj != NULL) {
491 /* Remove channel from application UST object descriptor. */
492 iter.iter.node = &ua_chan->ust_objd_node.node;
493 ret = lttng_ht_del(app->ust_objd, &iter);
494 assert(!ret);
495 pthread_mutex_lock(&app->sock_lock);
496 ret = ustctl_release_object(sock, ua_chan->obj);
497 pthread_mutex_unlock(&app->sock_lock);
498 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
499 ERR("UST app sock %d release channel obj failed with ret %d",
500 sock, ret);
501 }
502 lttng_fd_put(LTTNG_FD_APPS, 1);
503 free(ua_chan->obj);
504 }
505 call_rcu(&ua_chan->rcu_head, delete_ust_app_channel_rcu);
506 }
507
508 int ust_app_register_done(struct ust_app *app)
509 {
510 int ret;
511
512 pthread_mutex_lock(&app->sock_lock);
513 ret = ustctl_register_done(app->sock);
514 pthread_mutex_unlock(&app->sock_lock);
515 return ret;
516 }
517
518 int ust_app_release_object(struct ust_app *app, struct lttng_ust_object_data *data)
519 {
520 int ret, sock;
521
522 if (app) {
523 pthread_mutex_lock(&app->sock_lock);
524 sock = app->sock;
525 } else {
526 sock = -1;
527 }
528 ret = ustctl_release_object(sock, data);
529 if (app) {
530 pthread_mutex_unlock(&app->sock_lock);
531 }
532 return ret;
533 }
534
535 /*
536 * Push metadata to consumer socket.
537 *
538 * RCU read-side lock must be held to guarantee existance of socket.
539 * Must be called with the ust app session lock held.
540 * Must be called with the registry lock held.
541 *
542 * On success, return the len of metadata pushed or else a negative value.
543 * Returning a -EPIPE return value means we could not send the metadata,
544 * but it can be caused by recoverable errors (e.g. the application has
545 * terminated concurrently).
546 */
547 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
548 struct consumer_socket *socket, int send_zero_data)
549 {
550 int ret;
551 char *metadata_str = NULL;
552 size_t len, offset, new_metadata_len_sent;
553 ssize_t ret_val;
554 uint64_t metadata_key, metadata_version;
555
556 assert(registry);
557 assert(socket);
558
559 metadata_key = registry->metadata_key;
560
561 /*
562 * Means that no metadata was assigned to the session. This can
563 * happens if no start has been done previously.
564 */
565 if (!metadata_key) {
566 return 0;
567 }
568
569 offset = registry->metadata_len_sent;
570 len = registry->metadata_len - registry->metadata_len_sent;
571 new_metadata_len_sent = registry->metadata_len;
572 metadata_version = registry->metadata_version;
573 if (len == 0) {
574 DBG3("No metadata to push for metadata key %" PRIu64,
575 registry->metadata_key);
576 ret_val = len;
577 if (send_zero_data) {
578 DBG("No metadata to push");
579 goto push_data;
580 }
581 goto end;
582 }
583
584 /* Allocate only what we have to send. */
585 metadata_str = zmalloc(len);
586 if (!metadata_str) {
587 PERROR("zmalloc ust app metadata string");
588 ret_val = -ENOMEM;
589 goto error;
590 }
591 /* Copy what we haven't sent out. */
592 memcpy(metadata_str, registry->metadata + offset, len);
593
594 push_data:
595 pthread_mutex_unlock(&registry->lock);
596 /*
597 * We need to unlock the registry while we push metadata to
598 * break a circular dependency between the consumerd metadata
599 * lock and the sessiond registry lock. Indeed, pushing metadata
600 * to the consumerd awaits that it gets pushed all the way to
601 * relayd, but doing so requires grabbing the metadata lock. If
602 * a concurrent metadata request is being performed by
603 * consumerd, this can try to grab the registry lock on the
604 * sessiond while holding the metadata lock on the consumer
605 * daemon. Those push and pull schemes are performed on two
606 * different bidirectionnal communication sockets.
607 */
608 ret = consumer_push_metadata(socket, metadata_key,
609 metadata_str, len, offset, metadata_version);
610 pthread_mutex_lock(&registry->lock);
611 if (ret < 0) {
612 /*
613 * There is an acceptable race here between the registry
614 * metadata key assignment and the creation on the
615 * consumer. The session daemon can concurrently push
616 * metadata for this registry while being created on the
617 * consumer since the metadata key of the registry is
618 * assigned *before* it is setup to avoid the consumer
619 * to ask for metadata that could possibly be not found
620 * in the session daemon.
621 *
622 * The metadata will get pushed either by the session
623 * being stopped or the consumer requesting metadata if
624 * that race is triggered.
625 */
626 if (ret == -LTTCOMM_CONSUMERD_CHANNEL_FAIL) {
627 ret = 0;
628 } else {
629 ERR("Error pushing metadata to consumer");
630 }
631 ret_val = ret;
632 goto error_push;
633 } else {
634 /*
635 * Metadata may have been concurrently pushed, since
636 * we're not holding the registry lock while pushing to
637 * consumer. This is handled by the fact that we send
638 * the metadata content, size, and the offset at which
639 * that metadata belongs. This may arrive out of order
640 * on the consumer side, and the consumer is able to
641 * deal with overlapping fragments. The consumer
642 * supports overlapping fragments, which must be
643 * contiguous starting from offset 0. We keep the
644 * largest metadata_len_sent value of the concurrent
645 * send.
646 */
647 registry->metadata_len_sent =
648 max_t(size_t, registry->metadata_len_sent,
649 new_metadata_len_sent);
650 }
651 free(metadata_str);
652 return len;
653
654 end:
655 error:
656 if (ret_val) {
657 /*
658 * On error, flag the registry that the metadata is
659 * closed. We were unable to push anything and this
660 * means that either the consumer is not responding or
661 * the metadata cache has been destroyed on the
662 * consumer.
663 */
664 registry->metadata_closed = 1;
665 }
666 error_push:
667 free(metadata_str);
668 return ret_val;
669 }
670
671 /*
672 * For a given application and session, push metadata to consumer.
673 * Either sock or consumer is required : if sock is NULL, the default
674 * socket to send the metadata is retrieved from consumer, if sock
675 * is not NULL we use it to send the metadata.
676 * RCU read-side lock must be held while calling this function,
677 * therefore ensuring existance of registry. It also ensures existance
678 * of socket throughout this function.
679 *
680 * Return 0 on success else a negative error.
681 * Returning a -EPIPE return value means we could not send the metadata,
682 * but it can be caused by recoverable errors (e.g. the application has
683 * terminated concurrently).
684 */
685 static int push_metadata(struct ust_registry_session *registry,
686 struct consumer_output *consumer)
687 {
688 int ret_val;
689 ssize_t ret;
690 struct consumer_socket *socket;
691
692 assert(registry);
693 assert(consumer);
694
695 pthread_mutex_lock(&registry->lock);
696 if (registry->metadata_closed) {
697 ret_val = -EPIPE;
698 goto error;
699 }
700
701 /* Get consumer socket to use to push the metadata.*/
702 socket = consumer_find_socket_by_bitness(registry->bits_per_long,
703 consumer);
704 if (!socket) {
705 ret_val = -1;
706 goto error;
707 }
708
709 ret = ust_app_push_metadata(registry, socket, 0);
710 if (ret < 0) {
711 ret_val = ret;
712 goto error;
713 }
714 pthread_mutex_unlock(&registry->lock);
715 return 0;
716
717 error:
718 pthread_mutex_unlock(&registry->lock);
719 return ret_val;
720 }
721
722 /*
723 * Send to the consumer a close metadata command for the given session. Once
724 * done, the metadata channel is deleted and the session metadata pointer is
725 * nullified. The session lock MUST be held unless the application is
726 * in the destroy path.
727 *
728 * Return 0 on success else a negative value.
729 */
730 static int close_metadata(struct ust_registry_session *registry,
731 struct consumer_output *consumer)
732 {
733 int ret;
734 struct consumer_socket *socket;
735
736 assert(registry);
737 assert(consumer);
738
739 rcu_read_lock();
740
741 pthread_mutex_lock(&registry->lock);
742
743 if (!registry->metadata_key || registry->metadata_closed) {
744 ret = 0;
745 goto end;
746 }
747
748 /* Get consumer socket to use to push the metadata.*/
749 socket = consumer_find_socket_by_bitness(registry->bits_per_long,
750 consumer);
751 if (!socket) {
752 ret = -1;
753 goto error;
754 }
755
756 ret = consumer_close_metadata(socket, registry->metadata_key);
757 if (ret < 0) {
758 goto error;
759 }
760
761 error:
762 /*
763 * Metadata closed. Even on error this means that the consumer is not
764 * responding or not found so either way a second close should NOT be emit
765 * for this registry.
766 */
767 registry->metadata_closed = 1;
768 end:
769 pthread_mutex_unlock(&registry->lock);
770 rcu_read_unlock();
771 return ret;
772 }
773
774 /*
775 * We need to execute ht_destroy outside of RCU read-side critical
776 * section and outside of call_rcu thread, so we postpone its execution
777 * using ht_cleanup_push. It is simpler than to change the semantic of
778 * the many callers of delete_ust_app_session().
779 */
780 static
781 void delete_ust_app_session_rcu(struct rcu_head *head)
782 {
783 struct ust_app_session *ua_sess =
784 caa_container_of(head, struct ust_app_session, rcu_head);
785
786 ht_cleanup_push(ua_sess->channels);
787 free(ua_sess);
788 }
789
790 /*
791 * Delete ust app session safely. RCU read lock must be held before calling
792 * this function.
793 *
794 * The session list lock must be held by the caller.
795 */
796 static
797 void delete_ust_app_session(int sock, struct ust_app_session *ua_sess,
798 struct ust_app *app)
799 {
800 int ret;
801 struct lttng_ht_iter iter;
802 struct ust_app_channel *ua_chan;
803 struct ust_registry_session *registry;
804
805 assert(ua_sess);
806
807 pthread_mutex_lock(&ua_sess->lock);
808
809 assert(!ua_sess->deleted);
810 ua_sess->deleted = true;
811
812 registry = get_session_registry(ua_sess);
813 /* Registry can be null on error path during initialization. */
814 if (registry) {
815 /* Push metadata for application before freeing the application. */
816 (void) push_metadata(registry, ua_sess->consumer);
817
818 /*
819 * Don't ask to close metadata for global per UID buffers. Close
820 * metadata only on destroy trace session in this case. Also, the
821 * previous push metadata could have flag the metadata registry to
822 * close so don't send a close command if closed.
823 */
824 if (ua_sess->buffer_type != LTTNG_BUFFER_PER_UID) {
825 /* And ask to close it for this session registry. */
826 (void) close_metadata(registry, ua_sess->consumer);
827 }
828 }
829
830 cds_lfht_for_each_entry(ua_sess->channels->ht, &iter.iter, ua_chan,
831 node.node) {
832 ret = lttng_ht_del(ua_sess->channels, &iter);
833 assert(!ret);
834 delete_ust_app_channel(sock, ua_chan, app);
835 }
836
837 /* In case of per PID, the registry is kept in the session. */
838 if (ua_sess->buffer_type == LTTNG_BUFFER_PER_PID) {
839 struct buffer_reg_pid *reg_pid = buffer_reg_pid_find(ua_sess->id);
840 if (reg_pid) {
841 /*
842 * Registry can be null on error path during
843 * initialization.
844 */
845 buffer_reg_pid_remove(reg_pid);
846 buffer_reg_pid_destroy(reg_pid);
847 }
848 }
849
850 if (ua_sess->handle != -1) {
851 pthread_mutex_lock(&app->sock_lock);
852 ret = ustctl_release_handle(sock, ua_sess->handle);
853 pthread_mutex_unlock(&app->sock_lock);
854 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
855 ERR("UST app sock %d release session handle failed with ret %d",
856 sock, ret);
857 }
858 /* Remove session from application UST object descriptor. */
859 iter.iter.node = &ua_sess->ust_objd_node.node;
860 ret = lttng_ht_del(app->ust_sessions_objd, &iter);
861 assert(!ret);
862 }
863
864 pthread_mutex_unlock(&ua_sess->lock);
865
866 consumer_output_put(ua_sess->consumer);
867
868 call_rcu(&ua_sess->rcu_head, delete_ust_app_session_rcu);
869 }
870
871 /*
872 * Delete a traceable application structure from the global list. Never call
873 * this function outside of a call_rcu call.
874 *
875 * RCU read side lock should _NOT_ be held when calling this function.
876 */
877 static
878 void delete_ust_app(struct ust_app *app)
879 {
880 int ret, sock;
881 struct ust_app_session *ua_sess, *tmp_ua_sess;
882
883 /*
884 * The session list lock must be held during this function to guarantee
885 * the existence of ua_sess.
886 */
887 session_lock_list();
888 /* Delete ust app sessions info */
889 sock = app->sock;
890 app->sock = -1;
891
892 /* Wipe sessions */
893 cds_list_for_each_entry_safe(ua_sess, tmp_ua_sess, &app->teardown_head,
894 teardown_node) {
895 /* Free every object in the session and the session. */
896 rcu_read_lock();
897 delete_ust_app_session(sock, ua_sess, app);
898 rcu_read_unlock();
899 }
900
901 ht_cleanup_push(app->sessions);
902 ht_cleanup_push(app->ust_sessions_objd);
903 ht_cleanup_push(app->ust_objd);
904
905 /*
906 * Wait until we have deleted the application from the sock hash table
907 * before closing this socket, otherwise an application could re-use the
908 * socket ID and race with the teardown, using the same hash table entry.
909 *
910 * It's OK to leave the close in call_rcu. We want it to stay unique for
911 * all RCU readers that could run concurrently with unregister app,
912 * therefore we _need_ to only close that socket after a grace period. So
913 * it should stay in this RCU callback.
914 *
915 * This close() is a very important step of the synchronization model so
916 * every modification to this function must be carefully reviewed.
917 */
918 ret = close(sock);
919 if (ret) {
920 PERROR("close");
921 }
922 lttng_fd_put(LTTNG_FD_APPS, 1);
923
924 DBG2("UST app pid %d deleted", app->pid);
925 free(app);
926 session_unlock_list();
927 }
928
929 /*
930 * URCU intermediate call to delete an UST app.
931 */
932 static
933 void delete_ust_app_rcu(struct rcu_head *head)
934 {
935 struct lttng_ht_node_ulong *node =
936 caa_container_of(head, struct lttng_ht_node_ulong, head);
937 struct ust_app *app =
938 caa_container_of(node, struct ust_app, pid_n);
939
940 DBG3("Call RCU deleting app PID %d", app->pid);
941 delete_ust_app(app);
942 }
943
944 /*
945 * Delete the session from the application ht and delete the data structure by
946 * freeing every object inside and releasing them.
947 *
948 * The session list lock must be held by the caller.
949 */
950 static void destroy_app_session(struct ust_app *app,
951 struct ust_app_session *ua_sess)
952 {
953 int ret;
954 struct lttng_ht_iter iter;
955
956 assert(app);
957 assert(ua_sess);
958
959 iter.iter.node = &ua_sess->node.node;
960 ret = lttng_ht_del(app->sessions, &iter);
961 if (ret) {
962 /* Already scheduled for teardown. */
963 goto end;
964 }
965
966 /* Once deleted, free the data structure. */
967 delete_ust_app_session(app->sock, ua_sess, app);
968
969 end:
970 return;
971 }
972
973 /*
974 * Alloc new UST app session.
975 */
976 static
977 struct ust_app_session *alloc_ust_app_session(struct ust_app *app)
978 {
979 struct ust_app_session *ua_sess;
980
981 /* Init most of the default value by allocating and zeroing */
982 ua_sess = zmalloc(sizeof(struct ust_app_session));
983 if (ua_sess == NULL) {
984 PERROR("malloc");
985 goto error_free;
986 }
987
988 ua_sess->handle = -1;
989 ua_sess->channels = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
990 ua_sess->metadata_attr.type = LTTNG_UST_CHAN_METADATA;
991 pthread_mutex_init(&ua_sess->lock, NULL);
992
993 return ua_sess;
994
995 error_free:
996 return NULL;
997 }
998
999 /*
1000 * Alloc new UST app channel.
1001 */
1002 static
1003 struct ust_app_channel *alloc_ust_app_channel(char *name,
1004 struct ust_app_session *ua_sess,
1005 struct lttng_ust_channel_attr *attr)
1006 {
1007 struct ust_app_channel *ua_chan;
1008
1009 /* Init most of the default value by allocating and zeroing */
1010 ua_chan = zmalloc(sizeof(struct ust_app_channel));
1011 if (ua_chan == NULL) {
1012 PERROR("malloc");
1013 goto error;
1014 }
1015
1016 /* Setup channel name */
1017 strncpy(ua_chan->name, name, sizeof(ua_chan->name));
1018 ua_chan->name[sizeof(ua_chan->name) - 1] = '\0';
1019
1020 ua_chan->enabled = 1;
1021 ua_chan->handle = -1;
1022 ua_chan->session = ua_sess;
1023 ua_chan->key = get_next_channel_key();
1024 ua_chan->ctx = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
1025 ua_chan->events = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
1026 lttng_ht_node_init_str(&ua_chan->node, ua_chan->name);
1027
1028 CDS_INIT_LIST_HEAD(&ua_chan->streams.head);
1029 CDS_INIT_LIST_HEAD(&ua_chan->ctx_list);
1030
1031 /* Copy attributes */
1032 if (attr) {
1033 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
1034 ua_chan->attr.subbuf_size = attr->subbuf_size;
1035 ua_chan->attr.num_subbuf = attr->num_subbuf;
1036 ua_chan->attr.overwrite = attr->overwrite;
1037 ua_chan->attr.switch_timer_interval = attr->switch_timer_interval;
1038 ua_chan->attr.read_timer_interval = attr->read_timer_interval;
1039 ua_chan->attr.output = attr->output;
1040 }
1041 /* By default, the channel is a per cpu channel. */
1042 ua_chan->attr.type = LTTNG_UST_CHAN_PER_CPU;
1043
1044 DBG3("UST app channel %s allocated", ua_chan->name);
1045
1046 return ua_chan;
1047
1048 error:
1049 return NULL;
1050 }
1051
1052 /*
1053 * Allocate and initialize a UST app stream.
1054 *
1055 * Return newly allocated stream pointer or NULL on error.
1056 */
1057 struct ust_app_stream *ust_app_alloc_stream(void)
1058 {
1059 struct ust_app_stream *stream = NULL;
1060
1061 stream = zmalloc(sizeof(*stream));
1062 if (stream == NULL) {
1063 PERROR("zmalloc ust app stream");
1064 goto error;
1065 }
1066
1067 /* Zero could be a valid value for a handle so flag it to -1. */
1068 stream->handle = -1;
1069
1070 error:
1071 return stream;
1072 }
1073
1074 /*
1075 * Alloc new UST app event.
1076 */
1077 static
1078 struct ust_app_event *alloc_ust_app_event(char *name,
1079 struct lttng_ust_event *attr)
1080 {
1081 struct ust_app_event *ua_event;
1082
1083 /* Init most of the default value by allocating and zeroing */
1084 ua_event = zmalloc(sizeof(struct ust_app_event));
1085 if (ua_event == NULL) {
1086 PERROR("malloc");
1087 goto error;
1088 }
1089
1090 ua_event->enabled = 1;
1091 strncpy(ua_event->name, name, sizeof(ua_event->name));
1092 ua_event->name[sizeof(ua_event->name) - 1] = '\0';
1093 lttng_ht_node_init_str(&ua_event->node, ua_event->name);
1094
1095 /* Copy attributes */
1096 if (attr) {
1097 memcpy(&ua_event->attr, attr, sizeof(ua_event->attr));
1098 }
1099
1100 DBG3("UST app event %s allocated", ua_event->name);
1101
1102 return ua_event;
1103
1104 error:
1105 return NULL;
1106 }
1107
1108 /*
1109 * Alloc new UST app context.
1110 */
1111 static
1112 struct ust_app_ctx *alloc_ust_app_ctx(struct lttng_ust_context_attr *uctx)
1113 {
1114 struct ust_app_ctx *ua_ctx;
1115
1116 ua_ctx = zmalloc(sizeof(struct ust_app_ctx));
1117 if (ua_ctx == NULL) {
1118 goto error;
1119 }
1120
1121 CDS_INIT_LIST_HEAD(&ua_ctx->list);
1122
1123 if (uctx) {
1124 memcpy(&ua_ctx->ctx, uctx, sizeof(ua_ctx->ctx));
1125 if (uctx->ctx == LTTNG_UST_CONTEXT_APP_CONTEXT) {
1126 char *provider_name = NULL, *ctx_name = NULL;
1127
1128 provider_name = strdup(uctx->u.app_ctx.provider_name);
1129 ctx_name = strdup(uctx->u.app_ctx.ctx_name);
1130 if (!provider_name || !ctx_name) {
1131 free(provider_name);
1132 free(ctx_name);
1133 goto error;
1134 }
1135
1136 ua_ctx->ctx.u.app_ctx.provider_name = provider_name;
1137 ua_ctx->ctx.u.app_ctx.ctx_name = ctx_name;
1138 }
1139 }
1140
1141 DBG3("UST app context %d allocated", ua_ctx->ctx.ctx);
1142 return ua_ctx;
1143 error:
1144 free(ua_ctx);
1145 return NULL;
1146 }
1147
1148 /*
1149 * Allocate a filter and copy the given original filter.
1150 *
1151 * Return allocated filter or NULL on error.
1152 */
1153 static struct lttng_filter_bytecode *copy_filter_bytecode(
1154 struct lttng_filter_bytecode *orig_f)
1155 {
1156 struct lttng_filter_bytecode *filter = NULL;
1157
1158 /* Copy filter bytecode */
1159 filter = zmalloc(sizeof(*filter) + orig_f->len);
1160 if (!filter) {
1161 PERROR("zmalloc alloc filter bytecode");
1162 goto error;
1163 }
1164
1165 memcpy(filter, orig_f, sizeof(*filter) + orig_f->len);
1166
1167 error:
1168 return filter;
1169 }
1170
1171 /*
1172 * Create a liblttng-ust filter bytecode from given bytecode.
1173 *
1174 * Return allocated filter or NULL on error.
1175 */
1176 static struct lttng_ust_filter_bytecode *create_ust_bytecode_from_bytecode(
1177 struct lttng_filter_bytecode *orig_f)
1178 {
1179 struct lttng_ust_filter_bytecode *filter = NULL;
1180
1181 /* Copy filter bytecode */
1182 filter = zmalloc(sizeof(*filter) + orig_f->len);
1183 if (!filter) {
1184 PERROR("zmalloc alloc ust filter bytecode");
1185 goto error;
1186 }
1187
1188 assert(sizeof(struct lttng_filter_bytecode) ==
1189 sizeof(struct lttng_ust_filter_bytecode));
1190 memcpy(filter, orig_f, sizeof(*filter) + orig_f->len);
1191 error:
1192 return filter;
1193 }
1194
1195 /*
1196 * Find an ust_app using the sock and return it. RCU read side lock must be
1197 * held before calling this helper function.
1198 */
1199 struct ust_app *ust_app_find_by_sock(int sock)
1200 {
1201 struct lttng_ht_node_ulong *node;
1202 struct lttng_ht_iter iter;
1203
1204 lttng_ht_lookup(ust_app_ht_by_sock, (void *)((unsigned long) sock), &iter);
1205 node = lttng_ht_iter_get_node_ulong(&iter);
1206 if (node == NULL) {
1207 DBG2("UST app find by sock %d not found", sock);
1208 goto error;
1209 }
1210
1211 return caa_container_of(node, struct ust_app, sock_n);
1212
1213 error:
1214 return NULL;
1215 }
1216
1217 /*
1218 * Find an ust_app using the notify sock and return it. RCU read side lock must
1219 * be held before calling this helper function.
1220 */
1221 static struct ust_app *find_app_by_notify_sock(int sock)
1222 {
1223 struct lttng_ht_node_ulong *node;
1224 struct lttng_ht_iter iter;
1225
1226 lttng_ht_lookup(ust_app_ht_by_notify_sock, (void *)((unsigned long) sock),
1227 &iter);
1228 node = lttng_ht_iter_get_node_ulong(&iter);
1229 if (node == NULL) {
1230 DBG2("UST app find by notify sock %d not found", sock);
1231 goto error;
1232 }
1233
1234 return caa_container_of(node, struct ust_app, notify_sock_n);
1235
1236 error:
1237 return NULL;
1238 }
1239
1240 /*
1241 * Lookup for an ust app event based on event name, filter bytecode and the
1242 * event loglevel.
1243 *
1244 * Return an ust_app_event object or NULL on error.
1245 */
1246 static struct ust_app_event *find_ust_app_event(struct lttng_ht *ht,
1247 char *name, struct lttng_filter_bytecode *filter,
1248 int loglevel_value,
1249 const struct lttng_event_exclusion *exclusion)
1250 {
1251 struct lttng_ht_iter iter;
1252 struct lttng_ht_node_str *node;
1253 struct ust_app_event *event = NULL;
1254 struct ust_app_ht_key key;
1255
1256 assert(name);
1257 assert(ht);
1258
1259 /* Setup key for event lookup. */
1260 key.name = name;
1261 key.filter = filter;
1262 key.loglevel_type = loglevel_value;
1263 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1264 key.exclusion = exclusion;
1265
1266 /* Lookup using the event name as hash and a custom match fct. */
1267 cds_lfht_lookup(ht->ht, ht->hash_fct((void *) name, lttng_ht_seed),
1268 ht_match_ust_app_event, &key, &iter.iter);
1269 node = lttng_ht_iter_get_node_str(&iter);
1270 if (node == NULL) {
1271 goto end;
1272 }
1273
1274 event = caa_container_of(node, struct ust_app_event, node);
1275
1276 end:
1277 return event;
1278 }
1279
1280 /*
1281 * Create the channel context on the tracer.
1282 *
1283 * Called with UST app session lock held.
1284 */
1285 static
1286 int create_ust_channel_context(struct ust_app_channel *ua_chan,
1287 struct ust_app_ctx *ua_ctx, struct ust_app *app)
1288 {
1289 int ret;
1290
1291 health_code_update();
1292
1293 pthread_mutex_lock(&app->sock_lock);
1294 ret = ustctl_add_context(app->sock, &ua_ctx->ctx,
1295 ua_chan->obj, &ua_ctx->obj);
1296 pthread_mutex_unlock(&app->sock_lock);
1297 if (ret < 0) {
1298 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1299 ERR("UST app create channel context failed for app (pid: %d) "
1300 "with ret %d", app->pid, ret);
1301 } else {
1302 /*
1303 * This is normal behavior, an application can die during the
1304 * creation process. Don't report an error so the execution can
1305 * continue normally.
1306 */
1307 ret = 0;
1308 DBG3("UST app disable event failed. Application is dead.");
1309 }
1310 goto error;
1311 }
1312
1313 ua_ctx->handle = ua_ctx->obj->handle;
1314
1315 DBG2("UST app context handle %d created successfully for channel %s",
1316 ua_ctx->handle, ua_chan->name);
1317
1318 error:
1319 health_code_update();
1320 return ret;
1321 }
1322
1323 /*
1324 * Set the filter on the tracer.
1325 */
1326 static
1327 int set_ust_event_filter(struct ust_app_event *ua_event,
1328 struct ust_app *app)
1329 {
1330 int ret;
1331 struct lttng_ust_filter_bytecode *ust_bytecode = NULL;
1332
1333 health_code_update();
1334
1335 if (!ua_event->filter) {
1336 ret = 0;
1337 goto error;
1338 }
1339
1340 ust_bytecode = create_ust_bytecode_from_bytecode(ua_event->filter);
1341 if (!ust_bytecode) {
1342 ret = -LTTNG_ERR_NOMEM;
1343 goto error;
1344 }
1345 pthread_mutex_lock(&app->sock_lock);
1346 ret = ustctl_set_filter(app->sock, ust_bytecode,
1347 ua_event->obj);
1348 pthread_mutex_unlock(&app->sock_lock);
1349 if (ret < 0) {
1350 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1351 ERR("UST app event %s filter failed for app (pid: %d) "
1352 "with ret %d", ua_event->attr.name, app->pid, ret);
1353 } else {
1354 /*
1355 * This is normal behavior, an application can die during the
1356 * creation process. Don't report an error so the execution can
1357 * continue normally.
1358 */
1359 ret = 0;
1360 DBG3("UST app filter event failed. Application is dead.");
1361 }
1362 goto error;
1363 }
1364
1365 DBG2("UST filter set successfully for event %s", ua_event->name);
1366
1367 error:
1368 health_code_update();
1369 free(ust_bytecode);
1370 return ret;
1371 }
1372
1373 static
1374 struct lttng_ust_event_exclusion *create_ust_exclusion_from_exclusion(
1375 struct lttng_event_exclusion *exclusion)
1376 {
1377 struct lttng_ust_event_exclusion *ust_exclusion = NULL;
1378 size_t exclusion_alloc_size = sizeof(struct lttng_ust_event_exclusion) +
1379 LTTNG_UST_SYM_NAME_LEN * exclusion->count;
1380
1381 ust_exclusion = zmalloc(exclusion_alloc_size);
1382 if (!ust_exclusion) {
1383 PERROR("malloc");
1384 goto end;
1385 }
1386
1387 assert(sizeof(struct lttng_event_exclusion) ==
1388 sizeof(struct lttng_ust_event_exclusion));
1389 memcpy(ust_exclusion, exclusion, exclusion_alloc_size);
1390 end:
1391 return ust_exclusion;
1392 }
1393
1394 /*
1395 * Set event exclusions on the tracer.
1396 */
1397 static
1398 int set_ust_event_exclusion(struct ust_app_event *ua_event,
1399 struct ust_app *app)
1400 {
1401 int ret;
1402 struct lttng_ust_event_exclusion *ust_exclusion = NULL;
1403
1404 health_code_update();
1405
1406 if (!ua_event->exclusion || !ua_event->exclusion->count) {
1407 ret = 0;
1408 goto error;
1409 }
1410
1411 ust_exclusion = create_ust_exclusion_from_exclusion(
1412 ua_event->exclusion);
1413 if (!ust_exclusion) {
1414 ret = -LTTNG_ERR_NOMEM;
1415 goto error;
1416 }
1417 pthread_mutex_lock(&app->sock_lock);
1418 ret = ustctl_set_exclusion(app->sock, ust_exclusion, ua_event->obj);
1419 pthread_mutex_unlock(&app->sock_lock);
1420 if (ret < 0) {
1421 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1422 ERR("UST app event %s exclusions failed for app (pid: %d) "
1423 "with ret %d", ua_event->attr.name, app->pid, ret);
1424 } else {
1425 /*
1426 * This is normal behavior, an application can die during the
1427 * creation process. Don't report an error so the execution can
1428 * continue normally.
1429 */
1430 ret = 0;
1431 DBG3("UST app event exclusion failed. Application is dead.");
1432 }
1433 goto error;
1434 }
1435
1436 DBG2("UST exclusion set successfully for event %s", ua_event->name);
1437
1438 error:
1439 health_code_update();
1440 free(ust_exclusion);
1441 return ret;
1442 }
1443
1444 /*
1445 * Disable the specified event on to UST tracer for the UST session.
1446 */
1447 static int disable_ust_event(struct ust_app *app,
1448 struct ust_app_session *ua_sess, struct ust_app_event *ua_event)
1449 {
1450 int ret;
1451
1452 health_code_update();
1453
1454 pthread_mutex_lock(&app->sock_lock);
1455 ret = ustctl_disable(app->sock, ua_event->obj);
1456 pthread_mutex_unlock(&app->sock_lock);
1457 if (ret < 0) {
1458 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1459 ERR("UST app event %s disable failed for app (pid: %d) "
1460 "and session handle %d with ret %d",
1461 ua_event->attr.name, app->pid, ua_sess->handle, ret);
1462 } else {
1463 /*
1464 * This is normal behavior, an application can die during the
1465 * creation process. Don't report an error so the execution can
1466 * continue normally.
1467 */
1468 ret = 0;
1469 DBG3("UST app disable event failed. Application is dead.");
1470 }
1471 goto error;
1472 }
1473
1474 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1475 ua_event->attr.name, app->pid);
1476
1477 error:
1478 health_code_update();
1479 return ret;
1480 }
1481
1482 /*
1483 * Disable the specified channel on to UST tracer for the UST session.
1484 */
1485 static int disable_ust_channel(struct ust_app *app,
1486 struct ust_app_session *ua_sess, struct ust_app_channel *ua_chan)
1487 {
1488 int ret;
1489
1490 health_code_update();
1491
1492 pthread_mutex_lock(&app->sock_lock);
1493 ret = ustctl_disable(app->sock, ua_chan->obj);
1494 pthread_mutex_unlock(&app->sock_lock);
1495 if (ret < 0) {
1496 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1497 ERR("UST app channel %s disable failed for app (pid: %d) "
1498 "and session handle %d with ret %d",
1499 ua_chan->name, app->pid, ua_sess->handle, ret);
1500 } else {
1501 /*
1502 * This is normal behavior, an application can die during the
1503 * creation process. Don't report an error so the execution can
1504 * continue normally.
1505 */
1506 ret = 0;
1507 DBG3("UST app disable channel failed. Application is dead.");
1508 }
1509 goto error;
1510 }
1511
1512 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1513 ua_chan->name, app->pid);
1514
1515 error:
1516 health_code_update();
1517 return ret;
1518 }
1519
1520 /*
1521 * Enable the specified channel on to UST tracer for the UST session.
1522 */
1523 static int enable_ust_channel(struct ust_app *app,
1524 struct ust_app_session *ua_sess, struct ust_app_channel *ua_chan)
1525 {
1526 int ret;
1527
1528 health_code_update();
1529
1530 pthread_mutex_lock(&app->sock_lock);
1531 ret = ustctl_enable(app->sock, ua_chan->obj);
1532 pthread_mutex_unlock(&app->sock_lock);
1533 if (ret < 0) {
1534 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1535 ERR("UST app channel %s enable failed for app (pid: %d) "
1536 "and session handle %d with ret %d",
1537 ua_chan->name, app->pid, ua_sess->handle, ret);
1538 } else {
1539 /*
1540 * This is normal behavior, an application can die during the
1541 * creation process. Don't report an error so the execution can
1542 * continue normally.
1543 */
1544 ret = 0;
1545 DBG3("UST app enable channel failed. Application is dead.");
1546 }
1547 goto error;
1548 }
1549
1550 ua_chan->enabled = 1;
1551
1552 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1553 ua_chan->name, app->pid);
1554
1555 error:
1556 health_code_update();
1557 return ret;
1558 }
1559
1560 /*
1561 * Enable the specified event on to UST tracer for the UST session.
1562 */
1563 static int enable_ust_event(struct ust_app *app,
1564 struct ust_app_session *ua_sess, struct ust_app_event *ua_event)
1565 {
1566 int ret;
1567
1568 health_code_update();
1569
1570 pthread_mutex_lock(&app->sock_lock);
1571 ret = ustctl_enable(app->sock, ua_event->obj);
1572 pthread_mutex_unlock(&app->sock_lock);
1573 if (ret < 0) {
1574 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1575 ERR("UST app event %s enable failed for app (pid: %d) "
1576 "and session handle %d with ret %d",
1577 ua_event->attr.name, app->pid, ua_sess->handle, ret);
1578 } else {
1579 /*
1580 * This is normal behavior, an application can die during the
1581 * creation process. Don't report an error so the execution can
1582 * continue normally.
1583 */
1584 ret = 0;
1585 DBG3("UST app enable event failed. Application is dead.");
1586 }
1587 goto error;
1588 }
1589
1590 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1591 ua_event->attr.name, app->pid);
1592
1593 error:
1594 health_code_update();
1595 return ret;
1596 }
1597
1598 /*
1599 * Send channel and stream buffer to application.
1600 *
1601 * Return 0 on success. On error, a negative value is returned.
1602 */
1603 static int send_channel_pid_to_ust(struct ust_app *app,
1604 struct ust_app_session *ua_sess, struct ust_app_channel *ua_chan)
1605 {
1606 int ret;
1607 struct ust_app_stream *stream, *stmp;
1608
1609 assert(app);
1610 assert(ua_sess);
1611 assert(ua_chan);
1612
1613 health_code_update();
1614
1615 DBG("UST app sending channel %s to UST app sock %d", ua_chan->name,
1616 app->sock);
1617
1618 /* Send channel to the application. */
1619 ret = ust_consumer_send_channel_to_ust(app, ua_sess, ua_chan);
1620 if (ret == -EPIPE || ret == -LTTNG_UST_ERR_EXITING) {
1621 ret = -ENOTCONN; /* Caused by app exiting. */
1622 goto error;
1623 } else if (ret < 0) {
1624 goto error;
1625 }
1626
1627 health_code_update();
1628
1629 /* Send all streams to application. */
1630 cds_list_for_each_entry_safe(stream, stmp, &ua_chan->streams.head, list) {
1631 ret = ust_consumer_send_stream_to_ust(app, ua_chan, stream);
1632 if (ret == -EPIPE || ret == -LTTNG_UST_ERR_EXITING) {
1633 ret = -ENOTCONN; /* Caused by app exiting. */
1634 goto error;
1635 } else if (ret < 0) {
1636 goto error;
1637 }
1638 /* We don't need the stream anymore once sent to the tracer. */
1639 cds_list_del(&stream->list);
1640 delete_ust_app_stream(-1, stream, app);
1641 }
1642 /* Flag the channel that it is sent to the application. */
1643 ua_chan->is_sent = 1;
1644
1645 error:
1646 health_code_update();
1647 return ret;
1648 }
1649
1650 /*
1651 * Create the specified event onto the UST tracer for a UST session.
1652 *
1653 * Should be called with session mutex held.
1654 */
1655 static
1656 int create_ust_event(struct ust_app *app, struct ust_app_session *ua_sess,
1657 struct ust_app_channel *ua_chan, struct ust_app_event *ua_event)
1658 {
1659 int ret = 0;
1660
1661 health_code_update();
1662
1663 /* Create UST event on tracer */
1664 pthread_mutex_lock(&app->sock_lock);
1665 ret = ustctl_create_event(app->sock, &ua_event->attr, ua_chan->obj,
1666 &ua_event->obj);
1667 pthread_mutex_unlock(&app->sock_lock);
1668 if (ret < 0) {
1669 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
1670 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1671 ua_event->attr.name, app->pid, ret);
1672 } else {
1673 /*
1674 * This is normal behavior, an application can die during the
1675 * creation process. Don't report an error so the execution can
1676 * continue normally.
1677 */
1678 ret = 0;
1679 DBG3("UST app create event failed. Application is dead.");
1680 }
1681 goto error;
1682 }
1683
1684 ua_event->handle = ua_event->obj->handle;
1685
1686 DBG2("UST app event %s created successfully for pid:%d",
1687 ua_event->attr.name, app->pid);
1688
1689 health_code_update();
1690
1691 /* Set filter if one is present. */
1692 if (ua_event->filter) {
1693 ret = set_ust_event_filter(ua_event, app);
1694 if (ret < 0) {
1695 goto error;
1696 }
1697 }
1698
1699 /* Set exclusions for the event */
1700 if (ua_event->exclusion) {
1701 ret = set_ust_event_exclusion(ua_event, app);
1702 if (ret < 0) {
1703 goto error;
1704 }
1705 }
1706
1707 /* If event not enabled, disable it on the tracer */
1708 if (ua_event->enabled) {
1709 /*
1710 * We now need to explicitly enable the event, since it
1711 * is now disabled at creation.
1712 */
1713 ret = enable_ust_event(app, ua_sess, ua_event);
1714 if (ret < 0) {
1715 /*
1716 * If we hit an EPERM, something is wrong with our enable call. If
1717 * we get an EEXIST, there is a problem on the tracer side since we
1718 * just created it.
1719 */
1720 switch (ret) {
1721 case -LTTNG_UST_ERR_PERM:
1722 /* Code flow problem */
1723 assert(0);
1724 case -LTTNG_UST_ERR_EXIST:
1725 /* It's OK for our use case. */
1726 ret = 0;
1727 break;
1728 default:
1729 break;
1730 }
1731 goto error;
1732 }
1733 }
1734
1735 error:
1736 health_code_update();
1737 return ret;
1738 }
1739
1740 /*
1741 * Copy data between an UST app event and a LTT event.
1742 */
1743 static void shadow_copy_event(struct ust_app_event *ua_event,
1744 struct ltt_ust_event *uevent)
1745 {
1746 size_t exclusion_alloc_size;
1747
1748 strncpy(ua_event->name, uevent->attr.name, sizeof(ua_event->name));
1749 ua_event->name[sizeof(ua_event->name) - 1] = '\0';
1750
1751 ua_event->enabled = uevent->enabled;
1752
1753 /* Copy event attributes */
1754 memcpy(&ua_event->attr, &uevent->attr, sizeof(ua_event->attr));
1755
1756 /* Copy filter bytecode */
1757 if (uevent->filter) {
1758 ua_event->filter = copy_filter_bytecode(uevent->filter);
1759 /* Filter might be NULL here in case of ENONEM. */
1760 }
1761
1762 /* Copy exclusion data */
1763 if (uevent->exclusion) {
1764 exclusion_alloc_size = sizeof(struct lttng_event_exclusion) +
1765 LTTNG_UST_SYM_NAME_LEN * uevent->exclusion->count;
1766 ua_event->exclusion = zmalloc(exclusion_alloc_size);
1767 if (ua_event->exclusion == NULL) {
1768 PERROR("malloc");
1769 } else {
1770 memcpy(ua_event->exclusion, uevent->exclusion,
1771 exclusion_alloc_size);
1772 }
1773 }
1774 }
1775
1776 /*
1777 * Copy data between an UST app channel and a LTT channel.
1778 */
1779 static void shadow_copy_channel(struct ust_app_channel *ua_chan,
1780 struct ltt_ust_channel *uchan)
1781 {
1782 struct lttng_ht_iter iter;
1783 struct ltt_ust_event *uevent;
1784 struct ltt_ust_context *uctx;
1785 struct ust_app_event *ua_event;
1786
1787 DBG2("UST app shadow copy of channel %s started", ua_chan->name);
1788
1789 strncpy(ua_chan->name, uchan->name, sizeof(ua_chan->name));
1790 ua_chan->name[sizeof(ua_chan->name) - 1] = '\0';
1791
1792 ua_chan->tracefile_size = uchan->tracefile_size;
1793 ua_chan->tracefile_count = uchan->tracefile_count;
1794
1795 /* Copy event attributes since the layout is different. */
1796 ua_chan->attr.subbuf_size = uchan->attr.subbuf_size;
1797 ua_chan->attr.num_subbuf = uchan->attr.num_subbuf;
1798 ua_chan->attr.overwrite = uchan->attr.overwrite;
1799 ua_chan->attr.switch_timer_interval = uchan->attr.switch_timer_interval;
1800 ua_chan->attr.read_timer_interval = uchan->attr.read_timer_interval;
1801 ua_chan->attr.output = uchan->attr.output;
1802 /*
1803 * Note that the attribute channel type is not set since the channel on the
1804 * tracing registry side does not have this information.
1805 */
1806
1807 ua_chan->enabled = uchan->enabled;
1808 ua_chan->tracing_channel_id = uchan->id;
1809
1810 cds_list_for_each_entry(uctx, &uchan->ctx_list, list) {
1811 struct ust_app_ctx *ua_ctx = alloc_ust_app_ctx(&uctx->ctx);
1812
1813 if (ua_ctx == NULL) {
1814 continue;
1815 }
1816 lttng_ht_node_init_ulong(&ua_ctx->node,
1817 (unsigned long) ua_ctx->ctx.ctx);
1818 lttng_ht_add_ulong(ua_chan->ctx, &ua_ctx->node);
1819 cds_list_add_tail(&ua_ctx->list, &ua_chan->ctx_list);
1820 }
1821
1822 /* Copy all events from ltt ust channel to ust app channel */
1823 cds_lfht_for_each_entry(uchan->events->ht, &iter.iter, uevent, node.node) {
1824 ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
1825 uevent->filter, uevent->attr.loglevel, uevent->exclusion);
1826 if (ua_event == NULL) {
1827 DBG2("UST event %s not found on shadow copy channel",
1828 uevent->attr.name);
1829 ua_event = alloc_ust_app_event(uevent->attr.name, &uevent->attr);
1830 if (ua_event == NULL) {
1831 continue;
1832 }
1833 shadow_copy_event(ua_event, uevent);
1834 add_unique_ust_app_event(ua_chan, ua_event);
1835 }
1836 }
1837
1838 DBG3("UST app shadow copy of channel %s done", ua_chan->name);
1839 }
1840
1841 /*
1842 * Copy data between a UST app session and a regular LTT session.
1843 */
1844 static void shadow_copy_session(struct ust_app_session *ua_sess,
1845 struct ltt_ust_session *usess, struct ust_app *app)
1846 {
1847 struct lttng_ht_node_str *ua_chan_node;
1848 struct lttng_ht_iter iter;
1849 struct ltt_ust_channel *uchan;
1850 struct ust_app_channel *ua_chan;
1851 time_t rawtime;
1852 struct tm *timeinfo;
1853 char datetime[16];
1854 int ret;
1855 char tmp_shm_path[PATH_MAX];
1856
1857 /* Get date and time for unique app path */
1858 time(&rawtime);
1859 timeinfo = localtime(&rawtime);
1860 strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);
1861
1862 DBG2("Shadow copy of session handle %d", ua_sess->handle);
1863
1864 ua_sess->tracing_id = usess->id;
1865 ua_sess->id = get_next_session_id();
1866 ua_sess->uid = app->uid;
1867 ua_sess->gid = app->gid;
1868 ua_sess->euid = usess->uid;
1869 ua_sess->egid = usess->gid;
1870 ua_sess->buffer_type = usess->buffer_type;
1871 ua_sess->bits_per_long = app->bits_per_long;
1872
1873 /* There is only one consumer object per session possible. */
1874 consumer_output_get(usess->consumer);
1875 ua_sess->consumer = usess->consumer;
1876
1877 ua_sess->output_traces = usess->output_traces;
1878 ua_sess->live_timer_interval = usess->live_timer_interval;
1879 copy_channel_attr_to_ustctl(&ua_sess->metadata_attr,
1880 &usess->metadata_attr);
1881
1882 switch (ua_sess->buffer_type) {
1883 case LTTNG_BUFFER_PER_PID:
1884 ret = snprintf(ua_sess->path, sizeof(ua_sess->path),
1885 DEFAULT_UST_TRACE_PID_PATH "/%s-%d-%s", app->name, app->pid,
1886 datetime);
1887 break;
1888 case LTTNG_BUFFER_PER_UID:
1889 ret = snprintf(ua_sess->path, sizeof(ua_sess->path),
1890 DEFAULT_UST_TRACE_UID_PATH, ua_sess->uid, app->bits_per_long);
1891 break;
1892 default:
1893 assert(0);
1894 goto error;
1895 }
1896 if (ret < 0) {
1897 PERROR("asprintf UST shadow copy session");
1898 assert(0);
1899 goto error;
1900 }
1901
1902 strncpy(ua_sess->root_shm_path, usess->root_shm_path,
1903 sizeof(ua_sess->root_shm_path));
1904 ua_sess->root_shm_path[sizeof(ua_sess->root_shm_path) - 1] = '\0';
1905 strncpy(ua_sess->shm_path, usess->shm_path,
1906 sizeof(ua_sess->shm_path));
1907 ua_sess->shm_path[sizeof(ua_sess->shm_path) - 1] = '\0';
1908 if (ua_sess->shm_path[0]) {
1909 switch (ua_sess->buffer_type) {
1910 case LTTNG_BUFFER_PER_PID:
1911 ret = snprintf(tmp_shm_path, sizeof(tmp_shm_path),
1912 DEFAULT_UST_TRACE_PID_PATH "/%s-%d-%s",
1913 app->name, app->pid, datetime);
1914 break;
1915 case LTTNG_BUFFER_PER_UID:
1916 ret = snprintf(tmp_shm_path, sizeof(tmp_shm_path),
1917 DEFAULT_UST_TRACE_UID_PATH,
1918 app->uid, app->bits_per_long);
1919 break;
1920 default:
1921 assert(0);
1922 goto error;
1923 }
1924 if (ret < 0) {
1925 PERROR("sprintf UST shadow copy session");
1926 assert(0);
1927 goto error;
1928 }
1929 strncat(ua_sess->shm_path, tmp_shm_path,
1930 sizeof(ua_sess->shm_path) - strlen(ua_sess->shm_path) - 1);
1931 ua_sess->shm_path[sizeof(ua_sess->shm_path) - 1] = '\0';
1932 }
1933
1934 /* Iterate over all channels in global domain. */
1935 cds_lfht_for_each_entry(usess->domain_global.channels->ht, &iter.iter,
1936 uchan, node.node) {
1937 struct lttng_ht_iter uiter;
1938
1939 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
1940 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
1941 if (ua_chan_node != NULL) {
1942 /* Session exist. Contiuing. */
1943 continue;
1944 }
1945
1946 DBG2("Channel %s not found on shadow session copy, creating it",
1947 uchan->name);
1948 ua_chan = alloc_ust_app_channel(uchan->name, ua_sess,
1949 &uchan->attr);
1950 if (ua_chan == NULL) {
1951 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1952 continue;
1953 }
1954 shadow_copy_channel(ua_chan, uchan);
1955 /*
1956 * The concept of metadata channel does not exist on the tracing
1957 * registry side of the session daemon so this can only be a per CPU
1958 * channel and not metadata.
1959 */
1960 ua_chan->attr.type = LTTNG_UST_CHAN_PER_CPU;
1961
1962 lttng_ht_add_unique_str(ua_sess->channels, &ua_chan->node);
1963 }
1964 return;
1965
1966 error:
1967 consumer_output_put(ua_sess->consumer);
1968 }
1969
1970 /*
1971 * Lookup sesison wrapper.
1972 */
1973 static
1974 void __lookup_session_by_app(struct ltt_ust_session *usess,
1975 struct ust_app *app, struct lttng_ht_iter *iter)
1976 {
1977 /* Get right UST app session from app */
1978 lttng_ht_lookup(app->sessions, &usess->id, iter);
1979 }
1980
1981 /*
1982 * Return ust app session from the app session hashtable using the UST session
1983 * id.
1984 */
1985 static struct ust_app_session *lookup_session_by_app(
1986 struct ltt_ust_session *usess, struct ust_app *app)
1987 {
1988 struct lttng_ht_iter iter;
1989 struct lttng_ht_node_u64 *node;
1990
1991 __lookup_session_by_app(usess, app, &iter);
1992 node = lttng_ht_iter_get_node_u64(&iter);
1993 if (node == NULL) {
1994 goto error;
1995 }
1996
1997 return caa_container_of(node, struct ust_app_session, node);
1998
1999 error:
2000 return NULL;
2001 }
2002
2003 /*
2004 * Setup buffer registry per PID for the given session and application. If none
2005 * is found, a new one is created, added to the global registry and
2006 * initialized. If regp is valid, it's set with the newly created object.
2007 *
2008 * Return 0 on success or else a negative value.
2009 */
2010 static int setup_buffer_reg_pid(struct ust_app_session *ua_sess,
2011 struct ust_app *app, struct buffer_reg_pid **regp)
2012 {
2013 int ret = 0;
2014 struct buffer_reg_pid *reg_pid;
2015
2016 assert(ua_sess);
2017 assert(app);
2018
2019 rcu_read_lock();
2020
2021 reg_pid = buffer_reg_pid_find(ua_sess->id);
2022 if (!reg_pid) {
2023 /*
2024 * This is the create channel path meaning that if there is NO
2025 * registry available, we have to create one for this session.
2026 */
2027 ret = buffer_reg_pid_create(ua_sess->id, &reg_pid,
2028 ua_sess->root_shm_path, ua_sess->shm_path);
2029 if (ret < 0) {
2030 goto error;
2031 }
2032 } else {
2033 goto end;
2034 }
2035
2036 /* Initialize registry. */
2037 ret = ust_registry_session_init(&reg_pid->registry->reg.ust, app,
2038 app->bits_per_long, app->uint8_t_alignment,
2039 app->uint16_t_alignment, app->uint32_t_alignment,
2040 app->uint64_t_alignment, app->long_alignment,
2041 app->byte_order, app->version.major,
2042 app->version.minor, reg_pid->root_shm_path,
2043 reg_pid->shm_path,
2044 ua_sess->euid, ua_sess->egid);
2045 if (ret < 0) {
2046 /*
2047 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2048 * destroy the buffer registry, because it is always expected
2049 * that if the buffer registry can be found, its ust registry is
2050 * non-NULL.
2051 */
2052 buffer_reg_pid_destroy(reg_pid);
2053 goto error;
2054 }
2055
2056 buffer_reg_pid_add(reg_pid);
2057
2058 DBG3("UST app buffer registry per PID created successfully");
2059
2060 end:
2061 if (regp) {
2062 *regp = reg_pid;
2063 }
2064 error:
2065 rcu_read_unlock();
2066 return ret;
2067 }
2068
2069 /*
2070 * Setup buffer registry per UID for the given session and application. If none
2071 * is found, a new one is created, added to the global registry and
2072 * initialized. If regp is valid, it's set with the newly created object.
2073 *
2074 * Return 0 on success or else a negative value.
2075 */
2076 static int setup_buffer_reg_uid(struct ltt_ust_session *usess,
2077 struct ust_app_session *ua_sess,
2078 struct ust_app *app, struct buffer_reg_uid **regp)
2079 {
2080 int ret = 0;
2081 struct buffer_reg_uid *reg_uid;
2082
2083 assert(usess);
2084 assert(app);
2085
2086 rcu_read_lock();
2087
2088 reg_uid = buffer_reg_uid_find(usess->id, app->bits_per_long, app->uid);
2089 if (!reg_uid) {
2090 /*
2091 * This is the create channel path meaning that if there is NO
2092 * registry available, we have to create one for this session.
2093 */
2094 ret = buffer_reg_uid_create(usess->id, app->bits_per_long, app->uid,
2095 LTTNG_DOMAIN_UST, &reg_uid,
2096 ua_sess->root_shm_path, ua_sess->shm_path);
2097 if (ret < 0) {
2098 goto error;
2099 }
2100 } else {
2101 goto end;
2102 }
2103
2104 /* Initialize registry. */
2105 ret = ust_registry_session_init(&reg_uid->registry->reg.ust, NULL,
2106 app->bits_per_long, app->uint8_t_alignment,
2107 app->uint16_t_alignment, app->uint32_t_alignment,
2108 app->uint64_t_alignment, app->long_alignment,
2109 app->byte_order, app->version.major,
2110 app->version.minor, reg_uid->root_shm_path,
2111 reg_uid->shm_path, usess->uid, usess->gid);
2112 if (ret < 0) {
2113 /*
2114 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2115 * destroy the buffer registry, because it is always expected
2116 * that if the buffer registry can be found, its ust registry is
2117 * non-NULL.
2118 */
2119 buffer_reg_uid_destroy(reg_uid, NULL);
2120 goto error;
2121 }
2122 /* Add node to teardown list of the session. */
2123 cds_list_add(&reg_uid->lnode, &usess->buffer_reg_uid_list);
2124
2125 buffer_reg_uid_add(reg_uid);
2126
2127 DBG3("UST app buffer registry per UID created successfully");
2128 end:
2129 if (regp) {
2130 *regp = reg_uid;
2131 }
2132 error:
2133 rcu_read_unlock();
2134 return ret;
2135 }
2136
2137 /*
2138 * Create a session on the tracer side for the given app.
2139 *
2140 * On success, ua_sess_ptr is populated with the session pointer or else left
2141 * untouched. If the session was created, is_created is set to 1. On error,
2142 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2143 * be NULL.
2144 *
2145 * Returns 0 on success or else a negative code which is either -ENOMEM or
2146 * -ENOTCONN which is the default code if the ustctl_create_session fails.
2147 */
2148 static int create_ust_app_session(struct ltt_ust_session *usess,
2149 struct ust_app *app, struct ust_app_session **ua_sess_ptr,
2150 int *is_created)
2151 {
2152 int ret, created = 0;
2153 struct ust_app_session *ua_sess;
2154
2155 assert(usess);
2156 assert(app);
2157 assert(ua_sess_ptr);
2158
2159 health_code_update();
2160
2161 ua_sess = lookup_session_by_app(usess, app);
2162 if (ua_sess == NULL) {
2163 DBG2("UST app pid: %d session id %" PRIu64 " not found, creating it",
2164 app->pid, usess->id);
2165 ua_sess = alloc_ust_app_session(app);
2166 if (ua_sess == NULL) {
2167 /* Only malloc can failed so something is really wrong */
2168 ret = -ENOMEM;
2169 goto error;
2170 }
2171 shadow_copy_session(ua_sess, usess, app);
2172 created = 1;
2173 }
2174
2175 switch (usess->buffer_type) {
2176 case LTTNG_BUFFER_PER_PID:
2177 /* Init local registry. */
2178 ret = setup_buffer_reg_pid(ua_sess, app, NULL);
2179 if (ret < 0) {
2180 delete_ust_app_session(-1, ua_sess, app);
2181 goto error;
2182 }
2183 break;
2184 case LTTNG_BUFFER_PER_UID:
2185 /* Look for a global registry. If none exists, create one. */
2186 ret = setup_buffer_reg_uid(usess, ua_sess, app, NULL);
2187 if (ret < 0) {
2188 delete_ust_app_session(-1, ua_sess, app);
2189 goto error;
2190 }
2191 break;
2192 default:
2193 assert(0);
2194 ret = -EINVAL;
2195 goto error;
2196 }
2197
2198 health_code_update();
2199
2200 if (ua_sess->handle == -1) {
2201 pthread_mutex_lock(&app->sock_lock);
2202 ret = ustctl_create_session(app->sock);
2203 pthread_mutex_unlock(&app->sock_lock);
2204 if (ret < 0) {
2205 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
2206 ERR("Creating session for app pid %d with ret %d",
2207 app->pid, ret);
2208 } else {
2209 DBG("UST app creating session failed. Application is dead");
2210 /*
2211 * This is normal behavior, an application can die during the
2212 * creation process. Don't report an error so the execution can
2213 * continue normally. This will get flagged ENOTCONN and the
2214 * caller will handle it.
2215 */
2216 ret = 0;
2217 }
2218 delete_ust_app_session(-1, ua_sess, app);
2219 if (ret != -ENOMEM) {
2220 /*
2221 * Tracer is probably gone or got an internal error so let's
2222 * behave like it will soon unregister or not usable.
2223 */
2224 ret = -ENOTCONN;
2225 }
2226 goto error;
2227 }
2228
2229 ua_sess->handle = ret;
2230
2231 /* Add ust app session to app's HT */
2232 lttng_ht_node_init_u64(&ua_sess->node,
2233 ua_sess->tracing_id);
2234 lttng_ht_add_unique_u64(app->sessions, &ua_sess->node);
2235 lttng_ht_node_init_ulong(&ua_sess->ust_objd_node, ua_sess->handle);
2236 lttng_ht_add_unique_ulong(app->ust_sessions_objd,
2237 &ua_sess->ust_objd_node);
2238
2239 DBG2("UST app session created successfully with handle %d", ret);
2240 }
2241
2242 *ua_sess_ptr = ua_sess;
2243 if (is_created) {
2244 *is_created = created;
2245 }
2246
2247 /* Everything went well. */
2248 ret = 0;
2249
2250 error:
2251 health_code_update();
2252 return ret;
2253 }
2254
2255 /*
2256 * Match function for a hash table lookup of ust_app_ctx.
2257 *
2258 * It matches an ust app context based on the context type and, in the case
2259 * of perf counters, their name.
2260 */
2261 static int ht_match_ust_app_ctx(struct cds_lfht_node *node, const void *_key)
2262 {
2263 struct ust_app_ctx *ctx;
2264 const struct lttng_ust_context_attr *key;
2265
2266 assert(node);
2267 assert(_key);
2268
2269 ctx = caa_container_of(node, struct ust_app_ctx, node.node);
2270 key = _key;
2271
2272 /* Context type */
2273 if (ctx->ctx.ctx != key->ctx) {
2274 goto no_match;
2275 }
2276
2277 switch(key->ctx) {
2278 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER:
2279 if (strncmp(key->u.perf_counter.name,
2280 ctx->ctx.u.perf_counter.name,
2281 sizeof(key->u.perf_counter.name))) {
2282 goto no_match;
2283 }
2284 break;
2285 case LTTNG_UST_CONTEXT_APP_CONTEXT:
2286 if (strcmp(key->u.app_ctx.provider_name,
2287 ctx->ctx.u.app_ctx.provider_name) ||
2288 strcmp(key->u.app_ctx.ctx_name,
2289 ctx->ctx.u.app_ctx.ctx_name)) {
2290 goto no_match;
2291 }
2292 break;
2293 default:
2294 break;
2295 }
2296
2297 /* Match. */
2298 return 1;
2299
2300 no_match:
2301 return 0;
2302 }
2303
2304 /*
2305 * Lookup for an ust app context from an lttng_ust_context.
2306 *
2307 * Must be called while holding RCU read side lock.
2308 * Return an ust_app_ctx object or NULL on error.
2309 */
2310 static
2311 struct ust_app_ctx *find_ust_app_context(struct lttng_ht *ht,
2312 struct lttng_ust_context_attr *uctx)
2313 {
2314 struct lttng_ht_iter iter;
2315 struct lttng_ht_node_ulong *node;
2316 struct ust_app_ctx *app_ctx = NULL;
2317
2318 assert(uctx);
2319 assert(ht);
2320
2321 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2322 cds_lfht_lookup(ht->ht, ht->hash_fct((void *) uctx->ctx, lttng_ht_seed),
2323 ht_match_ust_app_ctx, uctx, &iter.iter);
2324 node = lttng_ht_iter_get_node_ulong(&iter);
2325 if (!node) {
2326 goto end;
2327 }
2328
2329 app_ctx = caa_container_of(node, struct ust_app_ctx, node);
2330
2331 end:
2332 return app_ctx;
2333 }
2334
2335 /*
2336 * Create a context for the channel on the tracer.
2337 *
2338 * Called with UST app session lock held and a RCU read side lock.
2339 */
2340 static
2341 int create_ust_app_channel_context(struct ust_app_session *ua_sess,
2342 struct ust_app_channel *ua_chan,
2343 struct lttng_ust_context_attr *uctx,
2344 struct ust_app *app)
2345 {
2346 int ret = 0;
2347 struct ust_app_ctx *ua_ctx;
2348
2349 DBG2("UST app adding context to channel %s", ua_chan->name);
2350
2351 ua_ctx = find_ust_app_context(ua_chan->ctx, uctx);
2352 if (ua_ctx) {
2353 ret = -EEXIST;
2354 goto error;
2355 }
2356
2357 ua_ctx = alloc_ust_app_ctx(uctx);
2358 if (ua_ctx == NULL) {
2359 /* malloc failed */
2360 ret = -1;
2361 goto error;
2362 }
2363
2364 lttng_ht_node_init_ulong(&ua_ctx->node, (unsigned long) ua_ctx->ctx.ctx);
2365 lttng_ht_add_ulong(ua_chan->ctx, &ua_ctx->node);
2366 cds_list_add_tail(&ua_ctx->list, &ua_chan->ctx_list);
2367
2368 ret = create_ust_channel_context(ua_chan, ua_ctx, app);
2369 if (ret < 0) {
2370 goto error;
2371 }
2372
2373 error:
2374 return ret;
2375 }
2376
2377 /*
2378 * Enable on the tracer side a ust app event for the session and channel.
2379 *
2380 * Called with UST app session lock held.
2381 */
2382 static
2383 int enable_ust_app_event(struct ust_app_session *ua_sess,
2384 struct ust_app_event *ua_event, struct ust_app *app)
2385 {
2386 int ret;
2387
2388 ret = enable_ust_event(app, ua_sess, ua_event);
2389 if (ret < 0) {
2390 goto error;
2391 }
2392
2393 ua_event->enabled = 1;
2394
2395 error:
2396 return ret;
2397 }
2398
2399 /*
2400 * Disable on the tracer side a ust app event for the session and channel.
2401 */
2402 static int disable_ust_app_event(struct ust_app_session *ua_sess,
2403 struct ust_app_event *ua_event, struct ust_app *app)
2404 {
2405 int ret;
2406
2407 ret = disable_ust_event(app, ua_sess, ua_event);
2408 if (ret < 0) {
2409 goto error;
2410 }
2411
2412 ua_event->enabled = 0;
2413
2414 error:
2415 return ret;
2416 }
2417
2418 /*
2419 * Lookup ust app channel for session and disable it on the tracer side.
2420 */
2421 static
2422 int disable_ust_app_channel(struct ust_app_session *ua_sess,
2423 struct ust_app_channel *ua_chan, struct ust_app *app)
2424 {
2425 int ret;
2426
2427 ret = disable_ust_channel(app, ua_sess, ua_chan);
2428 if (ret < 0) {
2429 goto error;
2430 }
2431
2432 ua_chan->enabled = 0;
2433
2434 error:
2435 return ret;
2436 }
2437
2438 /*
2439 * Lookup ust app channel for session and enable it on the tracer side. This
2440 * MUST be called with a RCU read side lock acquired.
2441 */
2442 static int enable_ust_app_channel(struct ust_app_session *ua_sess,
2443 struct ltt_ust_channel *uchan, struct ust_app *app)
2444 {
2445 int ret = 0;
2446 struct lttng_ht_iter iter;
2447 struct lttng_ht_node_str *ua_chan_node;
2448 struct ust_app_channel *ua_chan;
2449
2450 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &iter);
2451 ua_chan_node = lttng_ht_iter_get_node_str(&iter);
2452 if (ua_chan_node == NULL) {
2453 DBG2("Unable to find channel %s in ust session id %" PRIu64,
2454 uchan->name, ua_sess->tracing_id);
2455 goto error;
2456 }
2457
2458 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
2459
2460 ret = enable_ust_channel(app, ua_sess, ua_chan);
2461 if (ret < 0) {
2462 goto error;
2463 }
2464
2465 error:
2466 return ret;
2467 }
2468
2469 /*
2470 * Ask the consumer to create a channel and get it if successful.
2471 *
2472 * Called with UST app session lock held.
2473 *
2474 * Return 0 on success or else a negative value.
2475 */
2476 static int do_consumer_create_channel(struct ltt_ust_session *usess,
2477 struct ust_app_session *ua_sess, struct ust_app_channel *ua_chan,
2478 int bitness, struct ust_registry_session *registry)
2479 {
2480 int ret;
2481 unsigned int nb_fd = 0;
2482 struct consumer_socket *socket;
2483
2484 assert(usess);
2485 assert(ua_sess);
2486 assert(ua_chan);
2487 assert(registry);
2488
2489 rcu_read_lock();
2490 health_code_update();
2491
2492 /* Get the right consumer socket for the application. */
2493 socket = consumer_find_socket_by_bitness(bitness, usess->consumer);
2494 if (!socket) {
2495 ret = -EINVAL;
2496 goto error;
2497 }
2498
2499 health_code_update();
2500
2501 /* Need one fd for the channel. */
2502 ret = lttng_fd_get(LTTNG_FD_APPS, 1);
2503 if (ret < 0) {
2504 ERR("Exhausted number of available FD upon create channel");
2505 goto error;
2506 }
2507
2508 /*
2509 * Ask consumer to create channel. The consumer will return the number of
2510 * stream we have to expect.
2511 */
2512 ret = ust_consumer_ask_channel(ua_sess, ua_chan, usess->consumer, socket,
2513 registry);
2514 if (ret < 0) {
2515 goto error_ask;
2516 }
2517
2518 /*
2519 * Compute the number of fd needed before receiving them. It must be 2 per
2520 * stream (2 being the default value here).
2521 */
2522 nb_fd = DEFAULT_UST_STREAM_FD_NUM * ua_chan->expected_stream_count;
2523
2524 /* Reserve the amount of file descriptor we need. */
2525 ret = lttng_fd_get(LTTNG_FD_APPS, nb_fd);
2526 if (ret < 0) {
2527 ERR("Exhausted number of available FD upon create channel");
2528 goto error_fd_get_stream;
2529 }
2530
2531 health_code_update();
2532
2533 /*
2534 * Now get the channel from the consumer. This call wil populate the stream
2535 * list of that channel and set the ust objects.
2536 */
2537 if (usess->consumer->enabled) {
2538 ret = ust_consumer_get_channel(socket, ua_chan);
2539 if (ret < 0) {
2540 goto error_destroy;
2541 }
2542 }
2543
2544 rcu_read_unlock();
2545 return 0;
2546
2547 error_destroy:
2548 lttng_fd_put(LTTNG_FD_APPS, nb_fd);
2549 error_fd_get_stream:
2550 /*
2551 * Initiate a destroy channel on the consumer since we had an error
2552 * handling it on our side. The return value is of no importance since we
2553 * already have a ret value set by the previous error that we need to
2554 * return.
2555 */
2556 (void) ust_consumer_destroy_channel(socket, ua_chan);
2557 error_ask:
2558 lttng_fd_put(LTTNG_FD_APPS, 1);
2559 error:
2560 health_code_update();
2561 rcu_read_unlock();
2562 return ret;
2563 }
2564
2565 /*
2566 * Duplicate the ust data object of the ust app stream and save it in the
2567 * buffer registry stream.
2568 *
2569 * Return 0 on success or else a negative value.
2570 */
2571 static int duplicate_stream_object(struct buffer_reg_stream *reg_stream,
2572 struct ust_app_stream *stream)
2573 {
2574 int ret;
2575
2576 assert(reg_stream);
2577 assert(stream);
2578
2579 /* Reserve the amount of file descriptor we need. */
2580 ret = lttng_fd_get(LTTNG_FD_APPS, 2);
2581 if (ret < 0) {
2582 ERR("Exhausted number of available FD upon duplicate stream");
2583 goto error;
2584 }
2585
2586 /* Duplicate object for stream once the original is in the registry. */
2587 ret = ustctl_duplicate_ust_object_data(&stream->obj,
2588 reg_stream->obj.ust);
2589 if (ret < 0) {
2590 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2591 reg_stream->obj.ust, stream->obj, ret);
2592 lttng_fd_put(LTTNG_FD_APPS, 2);
2593 goto error;
2594 }
2595 stream->handle = stream->obj->handle;
2596
2597 error:
2598 return ret;
2599 }
2600
2601 /*
2602 * Duplicate the ust data object of the ust app. channel and save it in the
2603 * buffer registry channel.
2604 *
2605 * Return 0 on success or else a negative value.
2606 */
2607 static int duplicate_channel_object(struct buffer_reg_channel *reg_chan,
2608 struct ust_app_channel *ua_chan)
2609 {
2610 int ret;
2611
2612 assert(reg_chan);
2613 assert(ua_chan);
2614
2615 /* Need two fds for the channel. */
2616 ret = lttng_fd_get(LTTNG_FD_APPS, 1);
2617 if (ret < 0) {
2618 ERR("Exhausted number of available FD upon duplicate channel");
2619 goto error_fd_get;
2620 }
2621
2622 /* Duplicate object for stream once the original is in the registry. */
2623 ret = ustctl_duplicate_ust_object_data(&ua_chan->obj, reg_chan->obj.ust);
2624 if (ret < 0) {
2625 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2626 reg_chan->obj.ust, ua_chan->obj, ret);
2627 goto error;
2628 }
2629 ua_chan->handle = ua_chan->obj->handle;
2630
2631 return 0;
2632
2633 error:
2634 lttng_fd_put(LTTNG_FD_APPS, 1);
2635 error_fd_get:
2636 return ret;
2637 }
2638
2639 /*
2640 * For a given channel buffer registry, setup all streams of the given ust
2641 * application channel.
2642 *
2643 * Return 0 on success or else a negative value.
2644 */
2645 static int setup_buffer_reg_streams(struct buffer_reg_channel *reg_chan,
2646 struct ust_app_channel *ua_chan,
2647 struct ust_app *app)
2648 {
2649 int ret = 0;
2650 struct ust_app_stream *stream, *stmp;
2651
2652 assert(reg_chan);
2653 assert(ua_chan);
2654
2655 DBG2("UST app setup buffer registry stream");
2656
2657 /* Send all streams to application. */
2658 cds_list_for_each_entry_safe(stream, stmp, &ua_chan->streams.head, list) {
2659 struct buffer_reg_stream *reg_stream;
2660
2661 ret = buffer_reg_stream_create(&reg_stream);
2662 if (ret < 0) {
2663 goto error;
2664 }
2665
2666 /*
2667 * Keep original pointer and nullify it in the stream so the delete
2668 * stream call does not release the object.
2669 */
2670 reg_stream->obj.ust = stream->obj;
2671 stream->obj = NULL;
2672 buffer_reg_stream_add(reg_stream, reg_chan);
2673
2674 /* We don't need the streams anymore. */
2675 cds_list_del(&stream->list);
2676 delete_ust_app_stream(-1, stream, app);
2677 }
2678
2679 error:
2680 return ret;
2681 }
2682
2683 /*
2684 * Create a buffer registry channel for the given session registry and
2685 * application channel object. If regp pointer is valid, it's set with the
2686 * created object. Important, the created object is NOT added to the session
2687 * registry hash table.
2688 *
2689 * Return 0 on success else a negative value.
2690 */
2691 static int create_buffer_reg_channel(struct buffer_reg_session *reg_sess,
2692 struct ust_app_channel *ua_chan, struct buffer_reg_channel **regp)
2693 {
2694 int ret;
2695 struct buffer_reg_channel *reg_chan = NULL;
2696
2697 assert(reg_sess);
2698 assert(ua_chan);
2699
2700 DBG2("UST app creating buffer registry channel for %s", ua_chan->name);
2701
2702 /* Create buffer registry channel. */
2703 ret = buffer_reg_channel_create(ua_chan->tracing_channel_id, &reg_chan);
2704 if (ret < 0) {
2705 goto error_create;
2706 }
2707 assert(reg_chan);
2708 reg_chan->consumer_key = ua_chan->key;
2709 reg_chan->subbuf_size = ua_chan->attr.subbuf_size;
2710 reg_chan->num_subbuf = ua_chan->attr.num_subbuf;
2711
2712 /* Create and add a channel registry to session. */
2713 ret = ust_registry_channel_add(reg_sess->reg.ust,
2714 ua_chan->tracing_channel_id);
2715 if (ret < 0) {
2716 goto error;
2717 }
2718 buffer_reg_channel_add(reg_sess, reg_chan);
2719
2720 if (regp) {
2721 *regp = reg_chan;
2722 }
2723
2724 return 0;
2725
2726 error:
2727 /* Safe because the registry channel object was not added to any HT. */
2728 buffer_reg_channel_destroy(reg_chan, LTTNG_DOMAIN_UST);
2729 error_create:
2730 return ret;
2731 }
2732
2733 /*
2734 * Setup buffer registry channel for the given session registry and application
2735 * channel object. If regp pointer is valid, it's set with the created object.
2736 *
2737 * Return 0 on success else a negative value.
2738 */
2739 static int setup_buffer_reg_channel(struct buffer_reg_session *reg_sess,
2740 struct ust_app_channel *ua_chan, struct buffer_reg_channel *reg_chan,
2741 struct ust_app *app)
2742 {
2743 int ret;
2744
2745 assert(reg_sess);
2746 assert(reg_chan);
2747 assert(ua_chan);
2748 assert(ua_chan->obj);
2749
2750 DBG2("UST app setup buffer registry channel for %s", ua_chan->name);
2751
2752 /* Setup all streams for the registry. */
2753 ret = setup_buffer_reg_streams(reg_chan, ua_chan, app);
2754 if (ret < 0) {
2755 goto error;
2756 }
2757
2758 reg_chan->obj.ust = ua_chan->obj;
2759 ua_chan->obj = NULL;
2760
2761 return 0;
2762
2763 error:
2764 buffer_reg_channel_remove(reg_sess, reg_chan);
2765 buffer_reg_channel_destroy(reg_chan, LTTNG_DOMAIN_UST);
2766 return ret;
2767 }
2768
2769 /*
2770 * Send buffer registry channel to the application.
2771 *
2772 * Return 0 on success else a negative value.
2773 */
2774 static int send_channel_uid_to_ust(struct buffer_reg_channel *reg_chan,
2775 struct ust_app *app, struct ust_app_session *ua_sess,
2776 struct ust_app_channel *ua_chan)
2777 {
2778 int ret;
2779 struct buffer_reg_stream *reg_stream;
2780
2781 assert(reg_chan);
2782 assert(app);
2783 assert(ua_sess);
2784 assert(ua_chan);
2785
2786 DBG("UST app sending buffer registry channel to ust sock %d", app->sock);
2787
2788 ret = duplicate_channel_object(reg_chan, ua_chan);
2789 if (ret < 0) {
2790 goto error;
2791 }
2792
2793 /* Send channel to the application. */
2794 ret = ust_consumer_send_channel_to_ust(app, ua_sess, ua_chan);
2795 if (ret == -EPIPE || ret == -LTTNG_UST_ERR_EXITING) {
2796 ret = -ENOTCONN; /* Caused by app exiting. */
2797 goto error;
2798 } else if (ret < 0) {
2799 goto error;
2800 }
2801
2802 health_code_update();
2803
2804 /* Send all streams to application. */
2805 pthread_mutex_lock(&reg_chan->stream_list_lock);
2806 cds_list_for_each_entry(reg_stream, &reg_chan->streams, lnode) {
2807 struct ust_app_stream stream;
2808
2809 ret = duplicate_stream_object(reg_stream, &stream);
2810 if (ret < 0) {
2811 goto error_stream_unlock;
2812 }
2813
2814 ret = ust_consumer_send_stream_to_ust(app, ua_chan, &stream);
2815 if (ret < 0) {
2816 (void) release_ust_app_stream(-1, &stream, app);
2817 if (ret == -EPIPE || ret == -LTTNG_UST_ERR_EXITING) {
2818 ret = -ENOTCONN; /* Caused by app exiting. */
2819 }
2820 goto error_stream_unlock;
2821 }
2822
2823 /*
2824 * The return value is not important here. This function will output an
2825 * error if needed.
2826 */
2827 (void) release_ust_app_stream(-1, &stream, app);
2828 }
2829 ua_chan->is_sent = 1;
2830
2831 error_stream_unlock:
2832 pthread_mutex_unlock(&reg_chan->stream_list_lock);
2833 error:
2834 return ret;
2835 }
2836
2837 /*
2838 * Create and send to the application the created buffers with per UID buffers.
2839 *
2840 * Return 0 on success else a negative value.
2841 */
2842 static int create_channel_per_uid(struct ust_app *app,
2843 struct ltt_ust_session *usess, struct ust_app_session *ua_sess,
2844 struct ust_app_channel *ua_chan)
2845 {
2846 int ret;
2847 struct buffer_reg_uid *reg_uid;
2848 struct buffer_reg_channel *reg_chan;
2849
2850 assert(app);
2851 assert(usess);
2852 assert(ua_sess);
2853 assert(ua_chan);
2854
2855 DBG("UST app creating channel %s with per UID buffers", ua_chan->name);
2856
2857 reg_uid = buffer_reg_uid_find(usess->id, app->bits_per_long, app->uid);
2858 /*
2859 * The session creation handles the creation of this global registry
2860 * object. If none can be find, there is a code flow problem or a
2861 * teardown race.
2862 */
2863 assert(reg_uid);
2864
2865 reg_chan = buffer_reg_channel_find(ua_chan->tracing_channel_id,
2866 reg_uid);
2867 if (!reg_chan) {
2868 /* Create the buffer registry channel object. */
2869 ret = create_buffer_reg_channel(reg_uid->registry, ua_chan, &reg_chan);
2870 if (ret < 0) {
2871 ERR("Error creating the UST channel \"%s\" registry instance",
2872 ua_chan->name);
2873 goto error;
2874 }
2875 assert(reg_chan);
2876
2877 /*
2878 * Create the buffers on the consumer side. This call populates the
2879 * ust app channel object with all streams and data object.
2880 */
2881 ret = do_consumer_create_channel(usess, ua_sess, ua_chan,
2882 app->bits_per_long, reg_uid->registry->reg.ust);
2883 if (ret < 0) {
2884 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2885 ua_chan->name);
2886
2887 /*
2888 * Let's remove the previously created buffer registry channel so
2889 * it's not visible anymore in the session registry.
2890 */
2891 ust_registry_channel_del_free(reg_uid->registry->reg.ust,
2892 ua_chan->tracing_channel_id);
2893 buffer_reg_channel_remove(reg_uid->registry, reg_chan);
2894 buffer_reg_channel_destroy(reg_chan, LTTNG_DOMAIN_UST);
2895 goto error;
2896 }
2897
2898 /*
2899 * Setup the streams and add it to the session registry.
2900 */
2901 ret = setup_buffer_reg_channel(reg_uid->registry,
2902 ua_chan, reg_chan, app);
2903 if (ret < 0) {
2904 ERR("Error setting up UST channel \"%s\"",
2905 ua_chan->name);
2906 goto error;
2907 }
2908
2909 }
2910
2911 /* Send buffers to the application. */
2912 ret = send_channel_uid_to_ust(reg_chan, app, ua_sess, ua_chan);
2913 if (ret < 0) {
2914 if (ret != -ENOTCONN) {
2915 ERR("Error sending channel to application");
2916 }
2917 goto error;
2918 }
2919
2920 error:
2921 return ret;
2922 }
2923
2924 /*
2925 * Create and send to the application the created buffers with per PID buffers.
2926 *
2927 * Called with UST app session lock held.
2928 *
2929 * Return 0 on success else a negative value.
2930 */
2931 static int create_channel_per_pid(struct ust_app *app,
2932 struct ltt_ust_session *usess, struct ust_app_session *ua_sess,
2933 struct ust_app_channel *ua_chan)
2934 {
2935 int ret;
2936 struct ust_registry_session *registry;
2937
2938 assert(app);
2939 assert(usess);
2940 assert(ua_sess);
2941 assert(ua_chan);
2942
2943 DBG("UST app creating channel %s with per PID buffers", ua_chan->name);
2944
2945 rcu_read_lock();
2946
2947 registry = get_session_registry(ua_sess);
2948 /* The UST app session lock is held, registry shall not be null. */
2949 assert(registry);
2950
2951 /* Create and add a new channel registry to session. */
2952 ret = ust_registry_channel_add(registry, ua_chan->key);
2953 if (ret < 0) {
2954 ERR("Error creating the UST channel \"%s\" registry instance",
2955 ua_chan->name);
2956 goto error;
2957 }
2958
2959 /* Create and get channel on the consumer side. */
2960 ret = do_consumer_create_channel(usess, ua_sess, ua_chan,
2961 app->bits_per_long, registry);
2962 if (ret < 0) {
2963 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2964 ua_chan->name);
2965 goto error;
2966 }
2967
2968 ret = send_channel_pid_to_ust(app, ua_sess, ua_chan);
2969 if (ret < 0) {
2970 if (ret != -ENOTCONN) {
2971 ERR("Error sending channel to application");
2972 }
2973 goto error;
2974 }
2975
2976 error:
2977 rcu_read_unlock();
2978 return ret;
2979 }
2980
2981 /*
2982 * From an already allocated ust app channel, create the channel buffers if
2983 * need and send it to the application. This MUST be called with a RCU read
2984 * side lock acquired.
2985 *
2986 * Called with UST app session lock held.
2987 *
2988 * Return 0 on success or else a negative value. Returns -ENOTCONN if
2989 * the application exited concurrently.
2990 */
2991 static int do_create_channel(struct ust_app *app,
2992 struct ltt_ust_session *usess, struct ust_app_session *ua_sess,
2993 struct ust_app_channel *ua_chan)
2994 {
2995 int ret;
2996
2997 assert(app);
2998 assert(usess);
2999 assert(ua_sess);
3000 assert(ua_chan);
3001
3002 /* Handle buffer type before sending the channel to the application. */
3003 switch (usess->buffer_type) {
3004 case LTTNG_BUFFER_PER_UID:
3005 {
3006 ret = create_channel_per_uid(app, usess, ua_sess, ua_chan);
3007 if (ret < 0) {
3008 goto error;
3009 }
3010 break;
3011 }
3012 case LTTNG_BUFFER_PER_PID:
3013 {
3014 ret = create_channel_per_pid(app, usess, ua_sess, ua_chan);
3015 if (ret < 0) {
3016 goto error;
3017 }
3018 break;
3019 }
3020 default:
3021 assert(0);
3022 ret = -EINVAL;
3023 goto error;
3024 }
3025
3026 /* Initialize ust objd object using the received handle and add it. */
3027 lttng_ht_node_init_ulong(&ua_chan->ust_objd_node, ua_chan->handle);
3028 lttng_ht_add_unique_ulong(app->ust_objd, &ua_chan->ust_objd_node);
3029
3030 /* If channel is not enabled, disable it on the tracer */
3031 if (!ua_chan->enabled) {
3032 ret = disable_ust_channel(app, ua_sess, ua_chan);
3033 if (ret < 0) {
3034 goto error;
3035 }
3036 }
3037
3038 error:
3039 return ret;
3040 }
3041
3042 /*
3043 * Create UST app channel and create it on the tracer. Set ua_chanp of the
3044 * newly created channel if not NULL.
3045 *
3046 * Called with UST app session lock and RCU read-side lock held.
3047 *
3048 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3049 * the application exited concurrently.
3050 */
3051 static int create_ust_app_channel(struct ust_app_session *ua_sess,
3052 struct ltt_ust_channel *uchan, struct ust_app *app,
3053 enum lttng_ust_chan_type type, struct ltt_ust_session *usess,
3054 struct ust_app_channel **ua_chanp)
3055 {
3056 int ret = 0;
3057 struct lttng_ht_iter iter;
3058 struct lttng_ht_node_str *ua_chan_node;
3059 struct ust_app_channel *ua_chan;
3060
3061 /* Lookup channel in the ust app session */
3062 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &iter);
3063 ua_chan_node = lttng_ht_iter_get_node_str(&iter);
3064 if (ua_chan_node != NULL) {
3065 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
3066 goto end;
3067 }
3068
3069 ua_chan = alloc_ust_app_channel(uchan->name, ua_sess, &uchan->attr);
3070 if (ua_chan == NULL) {
3071 /* Only malloc can fail here */
3072 ret = -ENOMEM;
3073 goto error_alloc;
3074 }
3075 shadow_copy_channel(ua_chan, uchan);
3076
3077 /* Set channel type. */
3078 ua_chan->attr.type = type;
3079
3080 ret = do_create_channel(app, usess, ua_sess, ua_chan);
3081 if (ret < 0) {
3082 goto error;
3083 }
3084
3085 DBG2("UST app create channel %s for PID %d completed", ua_chan->name,
3086 app->pid);
3087
3088 /* Only add the channel if successful on the tracer side. */
3089 lttng_ht_add_unique_str(ua_sess->channels, &ua_chan->node);
3090
3091 end:
3092 if (ua_chanp) {
3093 *ua_chanp = ua_chan;
3094 }
3095
3096 /* Everything went well. */
3097 return 0;
3098
3099 error:
3100 delete_ust_app_channel(ua_chan->is_sent ? app->sock : -1, ua_chan, app);
3101 error_alloc:
3102 return ret;
3103 }
3104
3105 /*
3106 * Create UST app event and create it on the tracer side.
3107 *
3108 * Called with ust app session mutex held.
3109 */
3110 static
3111 int create_ust_app_event(struct ust_app_session *ua_sess,
3112 struct ust_app_channel *ua_chan, struct ltt_ust_event *uevent,
3113 struct ust_app *app)
3114 {
3115 int ret = 0;
3116 struct ust_app_event *ua_event;
3117
3118 /* Get event node */
3119 ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
3120 uevent->filter, uevent->attr.loglevel, uevent->exclusion);
3121 if (ua_event != NULL) {
3122 ret = -EEXIST;
3123 goto end;
3124 }
3125
3126 /* Does not exist so create one */
3127 ua_event = alloc_ust_app_event(uevent->attr.name, &uevent->attr);
3128 if (ua_event == NULL) {
3129 /* Only malloc can failed so something is really wrong */
3130 ret = -ENOMEM;
3131 goto end;
3132 }
3133 shadow_copy_event(ua_event, uevent);
3134
3135 /* Create it on the tracer side */
3136 ret = create_ust_event(app, ua_sess, ua_chan, ua_event);
3137 if (ret < 0) {
3138 /* Not found previously means that it does not exist on the tracer */
3139 assert(ret != -LTTNG_UST_ERR_EXIST);
3140 goto error;
3141 }
3142
3143 add_unique_ust_app_event(ua_chan, ua_event);
3144
3145 DBG2("UST app create event %s for PID %d completed", ua_event->name,
3146 app->pid);
3147
3148 end:
3149 return ret;
3150
3151 error:
3152 /* Valid. Calling here is already in a read side lock */
3153 delete_ust_app_event(-1, ua_event, app);
3154 return ret;
3155 }
3156
3157 /*
3158 * Create UST metadata and open it on the tracer side.
3159 *
3160 * Called with UST app session lock held and RCU read side lock.
3161 */
3162 static int create_ust_app_metadata(struct ust_app_session *ua_sess,
3163 struct ust_app *app, struct consumer_output *consumer)
3164 {
3165 int ret = 0;
3166 struct ust_app_channel *metadata;
3167 struct consumer_socket *socket;
3168 struct ust_registry_session *registry;
3169
3170 assert(ua_sess);
3171 assert(app);
3172 assert(consumer);
3173
3174 registry = get_session_registry(ua_sess);
3175 /* The UST app session is held registry shall not be null. */
3176 assert(registry);
3177
3178 pthread_mutex_lock(&registry->lock);
3179
3180 /* Metadata already exists for this registry or it was closed previously */
3181 if (registry->metadata_key || registry->metadata_closed) {
3182 ret = 0;
3183 goto error;
3184 }
3185
3186 /* Allocate UST metadata */
3187 metadata = alloc_ust_app_channel(DEFAULT_METADATA_NAME, ua_sess, NULL);
3188 if (!metadata) {
3189 /* malloc() failed */
3190 ret = -ENOMEM;
3191 goto error;
3192 }
3193
3194 memcpy(&metadata->attr, &ua_sess->metadata_attr, sizeof(metadata->attr));
3195
3196 /* Need one fd for the channel. */
3197 ret = lttng_fd_get(LTTNG_FD_APPS, 1);
3198 if (ret < 0) {
3199 ERR("Exhausted number of available FD upon create metadata");
3200 goto error;
3201 }
3202
3203 /* Get the right consumer socket for the application. */
3204 socket = consumer_find_socket_by_bitness(app->bits_per_long, consumer);
3205 if (!socket) {
3206 ret = -EINVAL;
3207 goto error_consumer;
3208 }
3209
3210 /*
3211 * Keep metadata key so we can identify it on the consumer side. Assign it
3212 * to the registry *before* we ask the consumer so we avoid the race of the
3213 * consumer requesting the metadata and the ask_channel call on our side
3214 * did not returned yet.
3215 */
3216 registry->metadata_key = metadata->key;
3217
3218 /*
3219 * Ask the metadata channel creation to the consumer. The metadata object
3220 * will be created by the consumer and kept their. However, the stream is
3221 * never added or monitored until we do a first push metadata to the
3222 * consumer.
3223 */
3224 ret = ust_consumer_ask_channel(ua_sess, metadata, consumer, socket,
3225 registry);
3226 if (ret < 0) {
3227 /* Nullify the metadata key so we don't try to close it later on. */
3228 registry->metadata_key = 0;
3229 goto error_consumer;
3230 }
3231
3232 /*
3233 * The setup command will make the metadata stream be sent to the relayd,
3234 * if applicable, and the thread managing the metadatas. This is important
3235 * because after this point, if an error occurs, the only way the stream
3236 * can be deleted is to be monitored in the consumer.
3237 */
3238 ret = consumer_setup_metadata(socket, metadata->key);
3239 if (ret < 0) {
3240 /* Nullify the metadata key so we don't try to close it later on. */
3241 registry->metadata_key = 0;
3242 goto error_consumer;
3243 }
3244
3245 DBG2("UST metadata with key %" PRIu64 " created for app pid %d",
3246 metadata->key, app->pid);
3247
3248 error_consumer:
3249 lttng_fd_put(LTTNG_FD_APPS, 1);
3250 delete_ust_app_channel(-1, metadata, app);
3251 error:
3252 pthread_mutex_unlock(&registry->lock);
3253 return ret;
3254 }
3255
3256 /*
3257 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3258 * acquired before calling this function.
3259 */
3260 struct ust_app *ust_app_find_by_pid(pid_t pid)
3261 {
3262 struct ust_app *app = NULL;
3263 struct lttng_ht_node_ulong *node;
3264 struct lttng_ht_iter iter;
3265
3266 lttng_ht_lookup(ust_app_ht, (void *)((unsigned long) pid), &iter);
3267 node = lttng_ht_iter_get_node_ulong(&iter);
3268 if (node == NULL) {
3269 DBG2("UST app no found with pid %d", pid);
3270 goto error;
3271 }
3272
3273 DBG2("Found UST app by pid %d", pid);
3274
3275 app = caa_container_of(node, struct ust_app, pid_n);
3276
3277 error:
3278 return app;
3279 }
3280
3281 /*
3282 * Allocate and init an UST app object using the registration information and
3283 * the command socket. This is called when the command socket connects to the
3284 * session daemon.
3285 *
3286 * The object is returned on success or else NULL.
3287 */
3288 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
3289 {
3290 struct ust_app *lta = NULL;
3291
3292 assert(msg);
3293 assert(sock >= 0);
3294
3295 DBG3("UST app creating application for socket %d", sock);
3296
3297 if ((msg->bits_per_long == 64 &&
3298 (uatomic_read(&ust_consumerd64_fd) == -EINVAL))
3299 || (msg->bits_per_long == 32 &&
3300 (uatomic_read(&ust_consumerd32_fd) == -EINVAL))) {
3301 ERR("Registration failed: application \"%s\" (pid: %d) has "
3302 "%d-bit long, but no consumerd for this size is available.\n",
3303 msg->name, msg->pid, msg->bits_per_long);
3304 goto error;
3305 }
3306
3307 lta = zmalloc(sizeof(struct ust_app));
3308 if (lta == NULL) {
3309 PERROR("malloc");
3310 goto error;
3311 }
3312
3313 lta->ppid = msg->ppid;
3314 lta->uid = msg->uid;
3315 lta->gid = msg->gid;
3316
3317 lta->bits_per_long = msg->bits_per_long;
3318 lta->uint8_t_alignment = msg->uint8_t_alignment;
3319 lta->uint16_t_alignment = msg->uint16_t_alignment;
3320 lta->uint32_t_alignment = msg->uint32_t_alignment;
3321 lta->uint64_t_alignment = msg->uint64_t_alignment;
3322 lta->long_alignment = msg->long_alignment;
3323 lta->byte_order = msg->byte_order;
3324
3325 lta->v_major = msg->major;
3326 lta->v_minor = msg->minor;
3327 lta->sessions = lttng_ht_new(0, LTTNG_HT_TYPE_U64);
3328 lta->ust_objd = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
3329 lta->ust_sessions_objd = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
3330 lta->notify_sock = -1;
3331
3332 /* Copy name and make sure it's NULL terminated. */
3333 strncpy(lta->name, msg->name, sizeof(lta->name));
3334 lta->name[UST_APP_PROCNAME_LEN] = '\0';
3335
3336 /*
3337 * Before this can be called, when receiving the registration information,
3338 * the application compatibility is checked. So, at this point, the
3339 * application can work with this session daemon.
3340 */
3341 lta->compatible = 1;
3342
3343 lta->pid = msg->pid;
3344 lttng_ht_node_init_ulong(&lta->pid_n, (unsigned long) lta->pid);
3345 lta->sock = sock;
3346 pthread_mutex_init(&lta->sock_lock, NULL);
3347 lttng_ht_node_init_ulong(&lta->sock_n, (unsigned long) lta->sock);
3348
3349 CDS_INIT_LIST_HEAD(&lta->teardown_head);
3350 error:
3351 return lta;
3352 }
3353
3354 /*
3355 * For a given application object, add it to every hash table.
3356 */
3357 void ust_app_add(struct ust_app *app)
3358 {
3359 assert(app);
3360 assert(app->notify_sock >= 0);
3361
3362 rcu_read_lock();
3363
3364 /*
3365 * On a re-registration, we want to kick out the previous registration of
3366 * that pid
3367 */
3368 lttng_ht_add_replace_ulong(ust_app_ht, &app->pid_n);
3369
3370 /*
3371 * The socket _should_ be unique until _we_ call close. So, a add_unique
3372 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3373 * already in the table.
3374 */
3375 lttng_ht_add_unique_ulong(ust_app_ht_by_sock, &app->sock_n);
3376
3377 /* Add application to the notify socket hash table. */
3378 lttng_ht_node_init_ulong(&app->notify_sock_n, app->notify_sock);
3379 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock, &app->notify_sock_n);
3380
3381 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3382 "notify_sock:%d (version %d.%d)", app->pid, app->ppid, app->uid,
3383 app->gid, app->sock, app->name, app->notify_sock, app->v_major,
3384 app->v_minor);
3385
3386 rcu_read_unlock();
3387 }
3388
3389 /*
3390 * Set the application version into the object.
3391 *
3392 * Return 0 on success else a negative value either an errno code or a
3393 * LTTng-UST error code.
3394 */
3395 int ust_app_version(struct ust_app *app)
3396 {
3397 int ret;
3398
3399 assert(app);
3400
3401 pthread_mutex_lock(&app->sock_lock);
3402 ret = ustctl_tracer_version(app->sock, &app->version);
3403 pthread_mutex_unlock(&app->sock_lock);
3404 if (ret < 0) {
3405 if (ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
3406 ERR("UST app %d version failed with ret %d", app->sock, ret);
3407 } else {
3408 DBG3("UST app %d version failed. Application is dead", app->sock);
3409 }
3410 }
3411
3412 return ret;
3413 }
3414
3415 /*
3416 * Unregister app by removing it from the global traceable app list and freeing
3417 * the data struct.
3418 *
3419 * The socket is already closed at this point so no close to sock.
3420 */
3421 void ust_app_unregister(int sock)
3422 {
3423 struct ust_app *lta;
3424 struct lttng_ht_node_ulong *node;
3425 struct lttng_ht_iter ust_app_sock_iter;
3426 struct lttng_ht_iter iter;
3427 struct ust_app_session *ua_sess;
3428 int ret;
3429
3430 rcu_read_lock();
3431
3432 /* Get the node reference for a call_rcu */
3433 lttng_ht_lookup(ust_app_ht_by_sock, (void *)((unsigned long) sock), &ust_app_sock_iter);
3434 node = lttng_ht_iter_get_node_ulong(&ust_app_sock_iter);
3435 assert(node);
3436
3437 lta = caa_container_of(node, struct ust_app, sock_n);
3438 DBG("PID %d unregistering with sock %d", lta->pid, sock);
3439
3440 /*
3441 * For per-PID buffers, perform "push metadata" and flush all
3442 * application streams before removing app from hash tables,
3443 * ensuring proper behavior of data_pending check.
3444 * Remove sessions so they are not visible during deletion.
3445 */
3446 cds_lfht_for_each_entry(lta->sessions->ht, &iter.iter, ua_sess,
3447 node.node) {
3448 struct ust_registry_session *registry;
3449
3450 ret = lttng_ht_del(lta->sessions, &iter);
3451 if (ret) {
3452 /* The session was already removed so scheduled for teardown. */
3453 continue;
3454 }
3455
3456 if (ua_sess->buffer_type == LTTNG_BUFFER_PER_PID) {
3457 (void) ust_app_flush_app_session(lta, ua_sess);
3458 }
3459
3460 /*
3461 * Add session to list for teardown. This is safe since at this point we
3462 * are the only one using this list.
3463 */
3464 pthread_mutex_lock(&ua_sess->lock);
3465
3466 if (ua_sess->deleted) {
3467 pthread_mutex_unlock(&ua_sess->lock);
3468 continue;
3469 }
3470
3471 /*
3472 * Normally, this is done in the delete session process which is
3473 * executed in the call rcu below. However, upon registration we can't
3474 * afford to wait for the grace period before pushing data or else the
3475 * data pending feature can race between the unregistration and stop
3476 * command where the data pending command is sent *before* the grace
3477 * period ended.
3478 *
3479 * The close metadata below nullifies the metadata pointer in the
3480 * session so the delete session will NOT push/close a second time.
3481 */
3482 registry = get_session_registry(ua_sess);
3483 if (registry) {
3484 /* Push metadata for application before freeing the application. */
3485 (void) push_metadata(registry, ua_sess->consumer);
3486
3487 /*
3488 * Don't ask to close metadata for global per UID buffers. Close
3489 * metadata only on destroy trace session in this case. Also, the
3490 * previous push metadata could have flag the metadata registry to
3491 * close so don't send a close command if closed.
3492 */
3493 if (ua_sess->buffer_type != LTTNG_BUFFER_PER_UID) {
3494 /* And ask to close it for this session registry. */
3495 (void) close_metadata(registry, ua_sess->consumer);
3496 }
3497 }
3498 cds_list_add(&ua_sess->teardown_node, &lta->teardown_head);
3499
3500 pthread_mutex_unlock(&ua_sess->lock);
3501 }
3502
3503 /* Remove application from PID hash table */
3504 ret = lttng_ht_del(ust_app_ht_by_sock, &ust_app_sock_iter);
3505 assert(!ret);
3506
3507 /*
3508 * Remove application from notify hash table. The thread handling the
3509 * notify socket could have deleted the node so ignore on error because
3510 * either way it's valid. The close of that socket is handled by the other
3511 * thread.
3512 */
3513 iter.iter.node = &lta->notify_sock_n.node;
3514 (void) lttng_ht_del(ust_app_ht_by_notify_sock, &iter);
3515
3516 /*
3517 * Ignore return value since the node might have been removed before by an
3518 * add replace during app registration because the PID can be reassigned by
3519 * the OS.
3520 */
3521 iter.iter.node = &lta->pid_n.node;
3522 ret = lttng_ht_del(ust_app_ht, &iter);
3523 if (ret) {
3524 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3525 lta->pid);
3526 }
3527
3528 /* Free memory */
3529 call_rcu(&lta->pid_n.head, delete_ust_app_rcu);
3530
3531 rcu_read_unlock();
3532 return;
3533 }
3534
3535 /*
3536 * Fill events array with all events name of all registered apps.
3537 */
3538 int ust_app_list_events(struct lttng_event **events)
3539 {
3540 int ret, handle;
3541 size_t nbmem, count = 0;
3542 struct lttng_ht_iter iter;
3543 struct ust_app *app;
3544 struct lttng_event *tmp_event;
3545
3546 nbmem = UST_APP_EVENT_LIST_SIZE;
3547 tmp_event = zmalloc(nbmem * sizeof(struct lttng_event));
3548 if (tmp_event == NULL) {
3549 PERROR("zmalloc ust app events");
3550 ret = -ENOMEM;
3551 goto error;
3552 }
3553
3554 rcu_read_lock();
3555
3556 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3557 struct lttng_ust_tracepoint_iter uiter;
3558
3559 health_code_update();
3560
3561 if (!app->compatible) {
3562 /*
3563 * TODO: In time, we should notice the caller of this error by
3564 * telling him that this is a version error.
3565 */
3566 continue;
3567 }
3568 pthread_mutex_lock(&app->sock_lock);
3569 handle = ustctl_tracepoint_list(app->sock);
3570 if (handle < 0) {
3571 if (handle != -EPIPE && handle != -LTTNG_UST_ERR_EXITING) {
3572 ERR("UST app list events getting handle failed for app pid %d",
3573 app->pid);
3574 }
3575 pthread_mutex_unlock(&app->sock_lock);
3576 continue;
3577 }
3578
3579 while ((ret = ustctl_tracepoint_list_get(app->sock, handle,
3580 &uiter)) != -LTTNG_UST_ERR_NOENT) {
3581 /* Handle ustctl error. */
3582 if (ret < 0) {
3583 int release_ret;
3584
3585 if (ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
3586 ERR("UST app tp list get failed for app %d with ret %d",
3587 app->sock, ret);
3588 } else {
3589 DBG3("UST app tp list get failed. Application is dead");
3590 /*
3591 * This is normal behavior, an application can die during the
3592 * creation process. Don't report an error so the execution can
3593 * continue normally. Continue normal execution.
3594 */
3595 break;
3596 }
3597 free(tmp_event);
3598 release_ret = ustctl_release_handle(app->sock, handle);
3599 if (release_ret < 0 &&
3600 release_ret != -LTTNG_UST_ERR_EXITING &&
3601 release_ret != -EPIPE) {
3602 ERR("Error releasing app handle for app %d with ret %d", app->sock, release_ret);
3603 }
3604 pthread_mutex_unlock(&app->sock_lock);
3605 goto rcu_error;
3606 }
3607
3608 health_code_update();
3609 if (count >= nbmem) {
3610 /* In case the realloc fails, we free the memory */
3611 struct lttng_event *new_tmp_event;
3612 size_t new_nbmem;
3613
3614 new_nbmem = nbmem << 1;
3615 DBG2("Reallocating event list from %zu to %zu entries",
3616 nbmem, new_nbmem);
3617 new_tmp_event = realloc(tmp_event,
3618 new_nbmem * sizeof(struct lttng_event));
3619 if (new_tmp_event == NULL) {
3620 int release_ret;
3621
3622 PERROR("realloc ust app events");
3623 free(tmp_event);
3624 ret = -ENOMEM;
3625 release_ret = ustctl_release_handle(app->sock, handle);
3626 if (release_ret < 0 &&
3627 release_ret != -LTTNG_UST_ERR_EXITING &&
3628 release_ret != -EPIPE) {
3629 ERR("Error releasing app handle for app %d with ret %d", app->sock, release_ret);
3630 }
3631 pthread_mutex_unlock(&app->sock_lock);
3632 goto rcu_error;
3633 }
3634 /* Zero the new memory */
3635 memset(new_tmp_event + nbmem, 0,
3636 (new_nbmem - nbmem) * sizeof(struct lttng_event));
3637 nbmem = new_nbmem;
3638 tmp_event = new_tmp_event;
3639 }
3640 memcpy(tmp_event[count].name, uiter.name, LTTNG_UST_SYM_NAME_LEN);
3641 tmp_event[count].loglevel = uiter.loglevel;
3642 tmp_event[count].type = (enum lttng_event_type) LTTNG_UST_TRACEPOINT;
3643 tmp_event[count].pid = app->pid;
3644 tmp_event[count].enabled = -1;
3645 count++;
3646 }
3647 ret = ustctl_release_handle(app->sock, handle);
3648 pthread_mutex_unlock(&app->sock_lock);
3649 if (ret < 0 && ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
3650 ERR("Error releasing app handle for app %d with ret %d", app->sock, ret);
3651 }
3652 }
3653
3654 ret = count;
3655 *events = tmp_event;
3656
3657 DBG2("UST app list events done (%zu events)", count);
3658
3659 rcu_error:
3660 rcu_read_unlock();
3661 error:
3662 health_code_update();
3663 return ret;
3664 }
3665
3666 /*
3667 * Fill events array with all events name of all registered apps.
3668 */
3669 int ust_app_list_event_fields(struct lttng_event_field **fields)
3670 {
3671 int ret, handle;
3672 size_t nbmem, count = 0;
3673 struct lttng_ht_iter iter;
3674 struct ust_app *app;
3675 struct lttng_event_field *tmp_event;
3676
3677 nbmem = UST_APP_EVENT_LIST_SIZE;
3678 tmp_event = zmalloc(nbmem * sizeof(struct lttng_event_field));
3679 if (tmp_event == NULL) {
3680 PERROR("zmalloc ust app event fields");
3681 ret = -ENOMEM;
3682 goto error;
3683 }
3684
3685 rcu_read_lock();
3686
3687 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3688 struct lttng_ust_field_iter uiter;
3689
3690 health_code_update();
3691
3692 if (!app->compatible) {
3693 /*
3694 * TODO: In time, we should notice the caller of this error by
3695 * telling him that this is a version error.
3696 */
3697 continue;
3698 }
3699 pthread_mutex_lock(&app->sock_lock);
3700 handle = ustctl_tracepoint_field_list(app->sock);
3701 if (handle < 0) {
3702 if (handle != -EPIPE && handle != -LTTNG_UST_ERR_EXITING) {
3703 ERR("UST app list field getting handle failed for app pid %d",
3704 app->pid);
3705 }
3706 pthread_mutex_unlock(&app->sock_lock);
3707 continue;
3708 }
3709
3710 while ((ret = ustctl_tracepoint_field_list_get(app->sock, handle,
3711 &uiter)) != -LTTNG_UST_ERR_NOENT) {
3712 /* Handle ustctl error. */
3713 if (ret < 0) {
3714 int release_ret;
3715
3716 if (ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
3717 ERR("UST app tp list field failed for app %d with ret %d",
3718 app->sock, ret);
3719 } else {
3720 DBG3("UST app tp list field failed. Application is dead");
3721 /*
3722 * This is normal behavior, an application can die during the
3723 * creation process. Don't report an error so the execution can
3724 * continue normally. Reset list and count for next app.
3725 */
3726 break;
3727 }
3728 free(tmp_event);
3729 release_ret = ustctl_release_handle(app->sock, handle);
3730 pthread_mutex_unlock(&app->sock_lock);
3731 if (release_ret < 0 &&
3732 release_ret != -LTTNG_UST_ERR_EXITING &&
3733 release_ret != -EPIPE) {
3734 ERR("Error releasing app handle for app %d with ret %d", app->sock, release_ret);
3735 }
3736 goto rcu_error;
3737 }
3738
3739 health_code_update();
3740 if (count >= nbmem) {
3741 /* In case the realloc fails, we free the memory */
3742 struct lttng_event_field *new_tmp_event;
3743 size_t new_nbmem;
3744
3745 new_nbmem = nbmem << 1;
3746 DBG2("Reallocating event field list from %zu to %zu entries",
3747 nbmem, new_nbmem);
3748 new_tmp_event = realloc(tmp_event,
3749 new_nbmem * sizeof(struct lttng_event_field));
3750 if (new_tmp_event == NULL) {
3751 int release_ret;
3752
3753 PERROR("realloc ust app event fields");
3754 free(tmp_event);
3755 ret = -ENOMEM;
3756 release_ret = ustctl_release_handle(app->sock, handle);
3757 pthread_mutex_unlock(&app->sock_lock);
3758 if (release_ret &&
3759 release_ret != -LTTNG_UST_ERR_EXITING &&
3760 release_ret != -EPIPE) {
3761 ERR("Error releasing app handle for app %d with ret %d", app->sock, release_ret);
3762 }
3763 goto rcu_error;
3764 }
3765 /* Zero the new memory */
3766 memset(new_tmp_event + nbmem, 0,
3767 (new_nbmem - nbmem) * sizeof(struct lttng_event_field));
3768 nbmem = new_nbmem;
3769 tmp_event = new_tmp_event;
3770 }
3771
3772 memcpy(tmp_event[count].field_name, uiter.field_name, LTTNG_UST_SYM_NAME_LEN);
3773 /* Mapping between these enums matches 1 to 1. */
3774 tmp_event[count].type = (enum lttng_event_field_type) uiter.type;
3775 tmp_event[count].nowrite = uiter.nowrite;
3776
3777 memcpy(tmp_event[count].event.name, uiter.event_name, LTTNG_UST_SYM_NAME_LEN);
3778 tmp_event[count].event.loglevel = uiter.loglevel;
3779 tmp_event[count].event.type = LTTNG_EVENT_TRACEPOINT;
3780 tmp_event[count].event.pid = app->pid;
3781 tmp_event[count].event.enabled = -1;
3782 count++;
3783 }
3784 ret = ustctl_release_handle(app->sock, handle);
3785 pthread_mutex_unlock(&app->sock_lock);
3786 if (ret < 0 &&
3787 ret != -LTTNG_UST_ERR_EXITING &&
3788 ret != -EPIPE) {
3789 ERR("Error releasing app handle for app %d with ret %d", app->sock, ret);
3790 }
3791 }
3792
3793 ret = count;
3794 *fields = tmp_event;
3795
3796 DBG2("UST app list event fields done (%zu events)", count);
3797
3798 rcu_error:
3799 rcu_read_unlock();
3800 error:
3801 health_code_update();
3802 return ret;
3803 }
3804
3805 /*
3806 * Free and clean all traceable apps of the global list.
3807 *
3808 * Should _NOT_ be called with RCU read-side lock held.
3809 */
3810 void ust_app_clean_list(void)
3811 {
3812 int ret;
3813 struct ust_app *app;
3814 struct lttng_ht_iter iter;
3815
3816 DBG2("UST app cleaning registered apps hash table");
3817
3818 rcu_read_lock();
3819
3820 if (ust_app_ht) {
3821 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3822 ret = lttng_ht_del(ust_app_ht, &iter);
3823 assert(!ret);
3824 call_rcu(&app->pid_n.head, delete_ust_app_rcu);
3825 }
3826 }
3827
3828 /* Cleanup socket hash table */
3829 if (ust_app_ht_by_sock) {
3830 cds_lfht_for_each_entry(ust_app_ht_by_sock->ht, &iter.iter, app,
3831 sock_n.node) {
3832 ret = lttng_ht_del(ust_app_ht_by_sock, &iter);
3833 assert(!ret);
3834 }
3835 }
3836
3837 /* Cleanup notify socket hash table */
3838 if (ust_app_ht_by_notify_sock) {
3839 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock->ht, &iter.iter, app,
3840 notify_sock_n.node) {
3841 ret = lttng_ht_del(ust_app_ht_by_notify_sock, &iter);
3842 assert(!ret);
3843 }
3844 }
3845 rcu_read_unlock();
3846
3847 /* Destroy is done only when the ht is empty */
3848 if (ust_app_ht) {
3849 ht_cleanup_push(ust_app_ht);
3850 }
3851 if (ust_app_ht_by_sock) {
3852 ht_cleanup_push(ust_app_ht_by_sock);
3853 }
3854 if (ust_app_ht_by_notify_sock) {
3855 ht_cleanup_push(ust_app_ht_by_notify_sock);
3856 }
3857 }
3858
3859 /*
3860 * Init UST app hash table.
3861 */
3862 int ust_app_ht_alloc(void)
3863 {
3864 ust_app_ht = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
3865 if (!ust_app_ht) {
3866 return -1;
3867 }
3868 ust_app_ht_by_sock = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
3869 if (!ust_app_ht_by_sock) {
3870 return -1;
3871 }
3872 ust_app_ht_by_notify_sock = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
3873 if (!ust_app_ht_by_notify_sock) {
3874 return -1;
3875 }
3876 return 0;
3877 }
3878
3879 /*
3880 * For a specific UST session, disable the channel for all registered apps.
3881 */
3882 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
3883 struct ltt_ust_channel *uchan)
3884 {
3885 int ret = 0;
3886 struct lttng_ht_iter iter;
3887 struct lttng_ht_node_str *ua_chan_node;
3888 struct ust_app *app;
3889 struct ust_app_session *ua_sess;
3890 struct ust_app_channel *ua_chan;
3891
3892 if (usess == NULL || uchan == NULL) {
3893 ERR("Disabling UST global channel with NULL values");
3894 ret = -1;
3895 goto error;
3896 }
3897
3898 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64,
3899 uchan->name, usess->id);
3900
3901 rcu_read_lock();
3902
3903 /* For every registered applications */
3904 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3905 struct lttng_ht_iter uiter;
3906 if (!app->compatible) {
3907 /*
3908 * TODO: In time, we should notice the caller of this error by
3909 * telling him that this is a version error.
3910 */
3911 continue;
3912 }
3913 ua_sess = lookup_session_by_app(usess, app);
3914 if (ua_sess == NULL) {
3915 continue;
3916 }
3917
3918 /* Get channel */
3919 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
3920 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
3921 /* If the session if found for the app, the channel must be there */
3922 assert(ua_chan_node);
3923
3924 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
3925 /* The channel must not be already disabled */
3926 assert(ua_chan->enabled == 1);
3927
3928 /* Disable channel onto application */
3929 ret = disable_ust_app_channel(ua_sess, ua_chan, app);
3930 if (ret < 0) {
3931 /* XXX: We might want to report this error at some point... */
3932 continue;
3933 }
3934 }
3935
3936 rcu_read_unlock();
3937
3938 error:
3939 return ret;
3940 }
3941
3942 /*
3943 * For a specific UST session, enable the channel for all registered apps.
3944 */
3945 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
3946 struct ltt_ust_channel *uchan)
3947 {
3948 int ret = 0;
3949 struct lttng_ht_iter iter;
3950 struct ust_app *app;
3951 struct ust_app_session *ua_sess;
3952
3953 if (usess == NULL || uchan == NULL) {
3954 ERR("Adding UST global channel to NULL values");
3955 ret = -1;
3956 goto error;
3957 }
3958
3959 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64,
3960 uchan->name, usess->id);
3961
3962 rcu_read_lock();
3963
3964 /* For every registered applications */
3965 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3966 if (!app->compatible) {
3967 /*
3968 * TODO: In time, we should notice the caller of this error by
3969 * telling him that this is a version error.
3970 */
3971 continue;
3972 }
3973 ua_sess = lookup_session_by_app(usess, app);
3974 if (ua_sess == NULL) {
3975 continue;
3976 }
3977
3978 /* Enable channel onto application */
3979 ret = enable_ust_app_channel(ua_sess, uchan, app);
3980 if (ret < 0) {
3981 /* XXX: We might want to report this error at some point... */
3982 continue;
3983 }
3984 }
3985
3986 rcu_read_unlock();
3987
3988 error:
3989 return ret;
3990 }
3991
3992 /*
3993 * Disable an event in a channel and for a specific session.
3994 */
3995 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
3996 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
3997 {
3998 int ret = 0;
3999 struct lttng_ht_iter iter, uiter;
4000 struct lttng_ht_node_str *ua_chan_node;
4001 struct ust_app *app;
4002 struct ust_app_session *ua_sess;
4003 struct ust_app_channel *ua_chan;
4004 struct ust_app_event *ua_event;
4005
4006 DBG("UST app disabling event %s for all apps in channel "
4007 "%s for session id %" PRIu64,
4008 uevent->attr.name, uchan->name, usess->id);
4009
4010 rcu_read_lock();
4011
4012 /* For all registered applications */
4013 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4014 if (!app->compatible) {
4015 /*
4016 * TODO: In time, we should notice the caller of this error by
4017 * telling him that this is a version error.
4018 */
4019 continue;
4020 }
4021 ua_sess = lookup_session_by_app(usess, app);
4022 if (ua_sess == NULL) {
4023 /* Next app */
4024 continue;
4025 }
4026
4027 /* Lookup channel in the ust app session */
4028 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
4029 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
4030 if (ua_chan_node == NULL) {
4031 DBG2("Channel %s not found in session id %" PRIu64 " for app pid %d."
4032 "Skipping", uchan->name, usess->id, app->pid);
4033 continue;
4034 }
4035 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
4036
4037 ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
4038 uevent->filter, uevent->attr.loglevel,
4039 uevent->exclusion);
4040 if (ua_event == NULL) {
4041 DBG2("Event %s not found in channel %s for app pid %d."
4042 "Skipping", uevent->attr.name, uchan->name, app->pid);
4043 continue;
4044 }
4045
4046 ret = disable_ust_app_event(ua_sess, ua_event, app);
4047 if (ret < 0) {
4048 /* XXX: Report error someday... */
4049 continue;
4050 }
4051 }
4052
4053 rcu_read_unlock();
4054
4055 return ret;
4056 }
4057
4058 /*
4059 * For a specific UST session, create the channel for all registered apps.
4060 */
4061 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
4062 struct ltt_ust_channel *uchan)
4063 {
4064 int ret = 0, created;
4065 struct lttng_ht_iter iter;
4066 struct ust_app *app;
4067 struct ust_app_session *ua_sess = NULL;
4068
4069 /* Very wrong code flow */
4070 assert(usess);
4071 assert(uchan);
4072
4073 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64,
4074 uchan->name, usess->id);
4075
4076 rcu_read_lock();
4077
4078 /* For every registered applications */
4079 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4080 if (!app->compatible) {
4081 /*
4082 * TODO: In time, we should notice the caller of this error by
4083 * telling him that this is a version error.
4084 */
4085 continue;
4086 }
4087 if (!trace_ust_pid_tracker_lookup(usess, app->pid)) {
4088 /* Skip. */
4089 continue;
4090 }
4091
4092 /*
4093 * Create session on the tracer side and add it to app session HT. Note
4094 * that if session exist, it will simply return a pointer to the ust
4095 * app session.
4096 */
4097 ret = create_ust_app_session(usess, app, &ua_sess, &created);
4098 if (ret < 0) {
4099 switch (ret) {
4100 case -ENOTCONN:
4101 /*
4102 * The application's socket is not valid. Either a bad socket
4103 * or a timeout on it. We can't inform the caller that for a
4104 * specific app, the session failed so lets continue here.
4105 */
4106 ret = 0; /* Not an error. */
4107 continue;
4108 case -ENOMEM:
4109 default:
4110 goto error_rcu_unlock;
4111 }
4112 }
4113 assert(ua_sess);
4114
4115 pthread_mutex_lock(&ua_sess->lock);
4116
4117 if (ua_sess->deleted) {
4118 pthread_mutex_unlock(&ua_sess->lock);
4119 continue;
4120 }
4121
4122 if (!strncmp(uchan->name, DEFAULT_METADATA_NAME,
4123 sizeof(uchan->name))) {
4124 copy_channel_attr_to_ustctl(&ua_sess->metadata_attr, &uchan->attr);
4125 ret = 0;
4126 } else {
4127 /* Create channel onto application. We don't need the chan ref. */
4128 ret = create_ust_app_channel(ua_sess, uchan, app,
4129 LTTNG_UST_CHAN_PER_CPU, usess, NULL);
4130 }
4131 pthread_mutex_unlock(&ua_sess->lock);
4132 if (ret < 0) {
4133 /* Cleanup the created session if it's the case. */
4134 if (created) {
4135 destroy_app_session(app, ua_sess);
4136 }
4137 switch (ret) {
4138 case -ENOTCONN:
4139 /*
4140 * The application's socket is not valid. Either a bad socket
4141 * or a timeout on it. We can't inform the caller that for a
4142 * specific app, the session failed so lets continue here.
4143 */
4144 ret = 0; /* Not an error. */
4145 continue;
4146 case -ENOMEM:
4147 default:
4148 goto error_rcu_unlock;
4149 }
4150 }
4151 }
4152
4153 error_rcu_unlock:
4154 rcu_read_unlock();
4155 return ret;
4156 }
4157
4158 /*
4159 * Enable event for a specific session and channel on the tracer.
4160 */
4161 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
4162 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
4163 {
4164 int ret = 0;
4165 struct lttng_ht_iter iter, uiter;
4166 struct lttng_ht_node_str *ua_chan_node;
4167 struct ust_app *app;
4168 struct ust_app_session *ua_sess;
4169 struct ust_app_channel *ua_chan;
4170 struct ust_app_event *ua_event;
4171
4172 DBG("UST app enabling event %s for all apps for session id %" PRIu64,
4173 uevent->attr.name, usess->id);
4174
4175 /*
4176 * NOTE: At this point, this function is called only if the session and
4177 * channel passed are already created for all apps. and enabled on the
4178 * tracer also.
4179 */
4180
4181 rcu_read_lock();
4182
4183 /* For all registered applications */
4184 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4185 if (!app->compatible) {
4186 /*
4187 * TODO: In time, we should notice the caller of this error by
4188 * telling him that this is a version error.
4189 */
4190 continue;
4191 }
4192 ua_sess = lookup_session_by_app(usess, app);
4193 if (!ua_sess) {
4194 /* The application has problem or is probably dead. */
4195 continue;
4196 }
4197
4198 pthread_mutex_lock(&ua_sess->lock);
4199
4200 if (ua_sess->deleted) {
4201 pthread_mutex_unlock(&ua_sess->lock);
4202 continue;
4203 }
4204
4205 /* Lookup channel in the ust app session */
4206 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
4207 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
4208 /*
4209 * It is possible that the channel cannot be found is
4210 * the channel/event creation occurs concurrently with
4211 * an application exit.
4212 */
4213 if (!ua_chan_node) {
4214 pthread_mutex_unlock(&ua_sess->lock);
4215 continue;
4216 }
4217
4218 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
4219
4220 /* Get event node */
4221 ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
4222 uevent->filter, uevent->attr.loglevel, uevent->exclusion);
4223 if (ua_event == NULL) {
4224 DBG3("UST app enable event %s not found for app PID %d."
4225 "Skipping app", uevent->attr.name, app->pid);
4226 goto next_app;
4227 }
4228
4229 ret = enable_ust_app_event(ua_sess, ua_event, app);
4230 if (ret < 0) {
4231 pthread_mutex_unlock(&ua_sess->lock);
4232 goto error;
4233 }
4234 next_app:
4235 pthread_mutex_unlock(&ua_sess->lock);
4236 }
4237
4238 error:
4239 rcu_read_unlock();
4240 return ret;
4241 }
4242
4243 /*
4244 * For a specific existing UST session and UST channel, creates the event for
4245 * all registered apps.
4246 */
4247 int ust_app_create_event_glb(struct ltt_ust_session *usess,
4248 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
4249 {
4250 int ret = 0;
4251 struct lttng_ht_iter iter, uiter;
4252 struct lttng_ht_node_str *ua_chan_node;
4253 struct ust_app *app;
4254 struct ust_app_session *ua_sess;
4255 struct ust_app_channel *ua_chan;
4256
4257 DBG("UST app creating event %s for all apps for session id %" PRIu64,
4258 uevent->attr.name, usess->id);
4259
4260 rcu_read_lock();
4261
4262 /* For all registered applications */
4263 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4264 if (!app->compatible) {
4265 /*
4266 * TODO: In time, we should notice the caller of this error by
4267 * telling him that this is a version error.
4268 */
4269 continue;
4270 }
4271 ua_sess = lookup_session_by_app(usess, app);
4272 if (!ua_sess) {
4273 /* The application has problem or is probably dead. */
4274 continue;
4275 }
4276
4277 pthread_mutex_lock(&ua_sess->lock);
4278
4279 if (ua_sess->deleted) {
4280 pthread_mutex_unlock(&ua_sess->lock);
4281 continue;
4282 }
4283
4284 /* Lookup channel in the ust app session */
4285 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
4286 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
4287 /* If the channel is not found, there is a code flow error */
4288 assert(ua_chan_node);
4289
4290 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
4291
4292 ret = create_ust_app_event(ua_sess, ua_chan, uevent, app);
4293 pthread_mutex_unlock(&ua_sess->lock);
4294 if (ret < 0) {
4295 if (ret != -LTTNG_UST_ERR_EXIST) {
4296 /* Possible value at this point: -ENOMEM. If so, we stop! */
4297 break;
4298 }
4299 DBG2("UST app event %s already exist on app PID %d",
4300 uevent->attr.name, app->pid);
4301 continue;
4302 }
4303 }
4304
4305 rcu_read_unlock();
4306
4307 return ret;
4308 }
4309
4310 /*
4311 * Start tracing for a specific UST session and app.
4312 *
4313 * Called with UST app session lock held.
4314 *
4315 */
4316 static
4317 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
4318 {
4319 int ret = 0;
4320 struct ust_app_session *ua_sess;
4321
4322 DBG("Starting tracing for ust app pid %d", app->pid);
4323
4324 rcu_read_lock();
4325
4326 if (!app->compatible) {
4327 goto end;
4328 }
4329
4330 ua_sess = lookup_session_by_app(usess, app);
4331 if (ua_sess == NULL) {
4332 /* The session is in teardown process. Ignore and continue. */
4333 goto end;
4334 }
4335
4336 pthread_mutex_lock(&ua_sess->lock);
4337
4338 if (ua_sess->deleted) {
4339 pthread_mutex_unlock(&ua_sess->lock);
4340 goto end;
4341 }
4342
4343 /* Upon restart, we skip the setup, already done */
4344 if (ua_sess->started) {
4345 goto skip_setup;
4346 }
4347
4348 /* Create directories if consumer is LOCAL and has a path defined. */
4349 if (usess->consumer->type == CONSUMER_DST_LOCAL &&
4350 strlen(usess->consumer->dst.trace_path) > 0) {
4351 ret = run_as_mkdir_recursive(usess->consumer->dst.trace_path,
4352 S_IRWXU | S_IRWXG, ua_sess->euid, ua_sess->egid);
4353 if (ret < 0) {
4354 if (errno != EEXIST) {
4355 ERR("Trace directory creation error");
4356 goto error_unlock;
4357 }
4358 }
4359 }
4360
4361 /*
4362 * Create the metadata for the application. This returns gracefully if a
4363 * metadata was already set for the session.
4364 */
4365 ret = create_ust_app_metadata(ua_sess, app, usess->consumer);
4366 if (ret < 0) {
4367 goto error_unlock;
4368 }
4369
4370 health_code_update();
4371
4372 skip_setup:
4373 /* This start the UST tracing */
4374 pthread_mutex_lock(&app->sock_lock);
4375 ret = ustctl_start_session(app->sock, ua_sess->handle);
4376 pthread_mutex_unlock(&app->sock_lock);
4377 if (ret < 0) {
4378 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4379 ERR("Error starting tracing for app pid: %d (ret: %d)",
4380 app->pid, ret);
4381 } else {
4382 DBG("UST app start session failed. Application is dead.");
4383 /*
4384 * This is normal behavior, an application can die during the
4385 * creation process. Don't report an error so the execution can
4386 * continue normally.
4387 */
4388 pthread_mutex_unlock(&ua_sess->lock);
4389 goto end;
4390 }
4391 goto error_unlock;
4392 }
4393
4394 /* Indicate that the session has been started once */
4395 ua_sess->started = 1;
4396
4397 pthread_mutex_unlock(&ua_sess->lock);
4398
4399 health_code_update();
4400
4401 /* Quiescent wait after starting trace */
4402 pthread_mutex_lock(&app->sock_lock);
4403 ret = ustctl_wait_quiescent(app->sock);
4404 pthread_mutex_unlock(&app->sock_lock);
4405 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4406 ERR("UST app wait quiescent failed for app pid %d ret %d",
4407 app->pid, ret);
4408 }
4409
4410 end:
4411 rcu_read_unlock();
4412 health_code_update();
4413 return 0;
4414
4415 error_unlock:
4416 pthread_mutex_unlock(&ua_sess->lock);
4417 rcu_read_unlock();
4418 health_code_update();
4419 return -1;
4420 }
4421
4422 /*
4423 * Stop tracing for a specific UST session and app.
4424 */
4425 static
4426 int ust_app_stop_trace(struct ltt_ust_session *usess, struct ust_app *app)
4427 {
4428 int ret = 0;
4429 struct ust_app_session *ua_sess;
4430 struct ust_registry_session *registry;
4431
4432 DBG("Stopping tracing for ust app pid %d", app->pid);
4433
4434 rcu_read_lock();
4435
4436 if (!app->compatible) {
4437 goto end_no_session;
4438 }
4439
4440 ua_sess = lookup_session_by_app(usess, app);
4441 if (ua_sess == NULL) {
4442 goto end_no_session;
4443 }
4444
4445 pthread_mutex_lock(&ua_sess->lock);
4446
4447 if (ua_sess->deleted) {
4448 pthread_mutex_unlock(&ua_sess->lock);
4449 goto end_no_session;
4450 }
4451
4452 /*
4453 * If started = 0, it means that stop trace has been called for a session
4454 * that was never started. It's possible since we can have a fail start
4455 * from either the application manager thread or the command thread. Simply
4456 * indicate that this is a stop error.
4457 */
4458 if (!ua_sess->started) {
4459 goto error_rcu_unlock;
4460 }
4461
4462 health_code_update();
4463
4464 /* This inhibits UST tracing */
4465 pthread_mutex_lock(&app->sock_lock);
4466 ret = ustctl_stop_session(app->sock, ua_sess->handle);
4467 pthread_mutex_unlock(&app->sock_lock);
4468 if (ret < 0) {
4469 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4470 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4471 app->pid, ret);
4472 } else {
4473 DBG("UST app stop session failed. Application is dead.");
4474 /*
4475 * This is normal behavior, an application can die during the
4476 * creation process. Don't report an error so the execution can
4477 * continue normally.
4478 */
4479 goto end_unlock;
4480 }
4481 goto error_rcu_unlock;
4482 }
4483
4484 health_code_update();
4485
4486 /* Quiescent wait after stopping trace */
4487 pthread_mutex_lock(&app->sock_lock);
4488 ret = ustctl_wait_quiescent(app->sock);
4489 pthread_mutex_unlock(&app->sock_lock);
4490 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4491 ERR("UST app wait quiescent failed for app pid %d ret %d",
4492 app->pid, ret);
4493 }
4494
4495 health_code_update();
4496
4497 registry = get_session_registry(ua_sess);
4498
4499 /* The UST app session is held registry shall not be null. */
4500 assert(registry);
4501
4502 /* Push metadata for application before freeing the application. */
4503 (void) push_metadata(registry, ua_sess->consumer);
4504
4505 end_unlock:
4506 pthread_mutex_unlock(&ua_sess->lock);
4507 end_no_session:
4508 rcu_read_unlock();
4509 health_code_update();
4510 return 0;
4511
4512 error_rcu_unlock:
4513 pthread_mutex_unlock(&ua_sess->lock);
4514 rcu_read_unlock();
4515 health_code_update();
4516 return -1;
4517 }
4518
4519 static
4520 int ust_app_flush_app_session(struct ust_app *app,
4521 struct ust_app_session *ua_sess)
4522 {
4523 int ret, retval = 0;
4524 struct lttng_ht_iter iter;
4525 struct ust_app_channel *ua_chan;
4526 struct consumer_socket *socket;
4527
4528 DBG("Flushing app session buffers for ust app pid %d", app->pid);
4529
4530 rcu_read_lock();
4531
4532 if (!app->compatible) {
4533 goto end_not_compatible;
4534 }
4535
4536 pthread_mutex_lock(&ua_sess->lock);
4537
4538 if (ua_sess->deleted) {
4539 goto end_deleted;
4540 }
4541
4542 health_code_update();
4543
4544 /* Flushing buffers */
4545 socket = consumer_find_socket_by_bitness(app->bits_per_long,
4546 ua_sess->consumer);
4547
4548 /* Flush buffers and push metadata. */
4549 switch (ua_sess->buffer_type) {
4550 case LTTNG_BUFFER_PER_PID:
4551 cds_lfht_for_each_entry(ua_sess->channels->ht, &iter.iter, ua_chan,
4552 node.node) {
4553 health_code_update();
4554 ret = consumer_flush_channel(socket, ua_chan->key);
4555 if (ret) {
4556 ERR("Error flushing consumer channel");
4557 retval = -1;
4558 continue;
4559 }
4560 }
4561 break;
4562 case LTTNG_BUFFER_PER_UID:
4563 default:
4564 assert(0);
4565 break;
4566 }
4567
4568 health_code_update();
4569
4570 end_deleted:
4571 pthread_mutex_unlock(&ua_sess->lock);
4572
4573 end_not_compatible:
4574 rcu_read_unlock();
4575 health_code_update();
4576 return retval;
4577 }
4578
4579 /*
4580 * Flush buffers for all applications for a specific UST session.
4581 * Called with UST session lock held.
4582 */
4583 static
4584 int ust_app_flush_session(struct ltt_ust_session *usess)
4585
4586 {
4587 int ret = 0;
4588
4589 DBG("Flushing session buffers for all ust apps");
4590
4591 rcu_read_lock();
4592
4593 /* Flush buffers and push metadata. */
4594 switch (usess->buffer_type) {
4595 case LTTNG_BUFFER_PER_UID:
4596 {
4597 struct buffer_reg_uid *reg;
4598 struct lttng_ht_iter iter;
4599
4600 /* Flush all per UID buffers associated to that session. */
4601 cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
4602 struct ust_registry_session *ust_session_reg;
4603 struct buffer_reg_channel *reg_chan;
4604 struct consumer_socket *socket;
4605
4606 /* Get consumer socket to use to push the metadata.*/
4607 socket = consumer_find_socket_by_bitness(reg->bits_per_long,
4608 usess->consumer);
4609 if (!socket) {
4610 /* Ignore request if no consumer is found for the session. */
4611 continue;
4612 }
4613
4614 cds_lfht_for_each_entry(reg->registry->channels->ht, &iter.iter,
4615 reg_chan, node.node) {
4616 /*
4617 * The following call will print error values so the return
4618 * code is of little importance because whatever happens, we
4619 * have to try them all.
4620 */
4621 (void) consumer_flush_channel(socket, reg_chan->consumer_key);
4622 }
4623
4624 ust_session_reg = reg->registry->reg.ust;
4625 /* Push metadata. */
4626 (void) push_metadata(ust_session_reg, usess->consumer);
4627 }
4628 break;
4629 }
4630 case LTTNG_BUFFER_PER_PID:
4631 {
4632 struct ust_app_session *ua_sess;
4633 struct lttng_ht_iter iter;
4634 struct ust_app *app;
4635
4636 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4637 ua_sess = lookup_session_by_app(usess, app);
4638 if (ua_sess == NULL) {
4639 continue;
4640 }
4641 (void) ust_app_flush_app_session(app, ua_sess);
4642 }
4643 break;
4644 }
4645 default:
4646 ret = -1;
4647 assert(0);
4648 break;
4649 }
4650
4651 rcu_read_unlock();
4652 health_code_update();
4653 return ret;
4654 }
4655
4656 static
4657 int ust_app_clear_quiescent_app_session(struct ust_app *app,
4658 struct ust_app_session *ua_sess)
4659 {
4660 int ret = 0;
4661 struct lttng_ht_iter iter;
4662 struct ust_app_channel *ua_chan;
4663 struct consumer_socket *socket;
4664
4665 DBG("Clearing stream quiescent state for ust app pid %d", app->pid);
4666
4667 rcu_read_lock();
4668
4669 if (!app->compatible) {
4670 goto end_not_compatible;
4671 }
4672
4673 pthread_mutex_lock(&ua_sess->lock);
4674
4675 if (ua_sess->deleted) {
4676 goto end_unlock;
4677 }
4678
4679 health_code_update();
4680
4681 socket = consumer_find_socket_by_bitness(app->bits_per_long,
4682 ua_sess->consumer);
4683 if (!socket) {
4684 ERR("Failed to find consumer (%" PRIu32 ") socket",
4685 app->bits_per_long);
4686 ret = -1;
4687 goto end_unlock;
4688 }
4689
4690 /* Clear quiescent state. */
4691 switch (ua_sess->buffer_type) {
4692 case LTTNG_BUFFER_PER_PID:
4693 cds_lfht_for_each_entry(ua_sess->channels->ht, &iter.iter,
4694 ua_chan, node.node) {
4695 health_code_update();
4696 ret = consumer_clear_quiescent_channel(socket,
4697 ua_chan->key);
4698 if (ret) {
4699 ERR("Error clearing quiescent state for consumer channel");
4700 ret = -1;
4701 continue;
4702 }
4703 }
4704 break;
4705 case LTTNG_BUFFER_PER_UID:
4706 default:
4707 assert(0);
4708 ret = -1;
4709 break;
4710 }
4711
4712 health_code_update();
4713
4714 end_unlock:
4715 pthread_mutex_unlock(&ua_sess->lock);
4716
4717 end_not_compatible:
4718 rcu_read_unlock();
4719 health_code_update();
4720 return ret;
4721 }
4722
4723 /*
4724 * Clear quiescent state in each stream for all applications for a
4725 * specific UST session.
4726 * Called with UST session lock held.
4727 */
4728 static
4729 int ust_app_clear_quiescent_session(struct ltt_ust_session *usess)
4730
4731 {
4732 int ret = 0;
4733
4734 DBG("Clearing stream quiescent state for all ust apps");
4735
4736 rcu_read_lock();
4737
4738 switch (usess->buffer_type) {
4739 case LTTNG_BUFFER_PER_UID:
4740 {
4741 struct lttng_ht_iter iter;
4742 struct buffer_reg_uid *reg;
4743
4744 /*
4745 * Clear quiescent for all per UID buffers associated to
4746 * that session.
4747 */
4748 cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
4749 struct consumer_socket *socket;
4750 struct buffer_reg_channel *reg_chan;
4751
4752 /* Get associated consumer socket.*/
4753 socket = consumer_find_socket_by_bitness(
4754 reg->bits_per_long, usess->consumer);
4755 if (!socket) {
4756 /*
4757 * Ignore request if no consumer is found for
4758 * the session.
4759 */
4760 continue;
4761 }
4762
4763 cds_lfht_for_each_entry(reg->registry->channels->ht,
4764 &iter.iter, reg_chan, node.node) {
4765 /*
4766 * The following call will print error values so
4767 * the return code is of little importance
4768 * because whatever happens, we have to try them
4769 * all.
4770 */
4771 (void) consumer_clear_quiescent_channel(socket,
4772 reg_chan->consumer_key);
4773 }
4774 }
4775 break;
4776 }
4777 case LTTNG_BUFFER_PER_PID:
4778 {
4779 struct ust_app_session *ua_sess;
4780 struct lttng_ht_iter iter;
4781 struct ust_app *app;
4782
4783 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app,
4784 pid_n.node) {
4785 ua_sess = lookup_session_by_app(usess, app);
4786 if (ua_sess == NULL) {
4787 continue;
4788 }
4789 (void) ust_app_clear_quiescent_app_session(app,
4790 ua_sess);
4791 }
4792 break;
4793 }
4794 default:
4795 ret = -1;
4796 assert(0);
4797 break;
4798 }
4799
4800 rcu_read_unlock();
4801 health_code_update();
4802 return ret;
4803 }
4804
4805 /*
4806 * Destroy a specific UST session in apps.
4807 */
4808 static int destroy_trace(struct ltt_ust_session *usess, struct ust_app *app)
4809 {
4810 int ret;
4811 struct ust_app_session *ua_sess;
4812 struct lttng_ht_iter iter;
4813 struct lttng_ht_node_u64 *node;
4814
4815 DBG("Destroy tracing for ust app pid %d", app->pid);
4816
4817 rcu_read_lock();
4818
4819 if (!app->compatible) {
4820 goto end;
4821 }
4822
4823 __lookup_session_by_app(usess, app, &iter);
4824 node = lttng_ht_iter_get_node_u64(&iter);
4825 if (node == NULL) {
4826 /* Session is being or is deleted. */
4827 goto end;
4828 }
4829 ua_sess = caa_container_of(node, struct ust_app_session, node);
4830
4831 health_code_update();
4832 destroy_app_session(app, ua_sess);
4833
4834 health_code_update();
4835
4836 /* Quiescent wait after stopping trace */
4837 pthread_mutex_lock(&app->sock_lock);
4838 ret = ustctl_wait_quiescent(app->sock);
4839 pthread_mutex_unlock(&app->sock_lock);
4840 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4841 ERR("UST app wait quiescent failed for app pid %d ret %d",
4842 app->pid, ret);
4843 }
4844 end:
4845 rcu_read_unlock();
4846 health_code_update();
4847 return 0;
4848 }
4849
4850 /*
4851 * Start tracing for the UST session.
4852 */
4853 int ust_app_start_trace_all(struct ltt_ust_session *usess)
4854 {
4855 int ret = 0;
4856 struct lttng_ht_iter iter;
4857 struct ust_app *app;
4858
4859 DBG("Starting all UST traces");
4860
4861 rcu_read_lock();
4862
4863 /*
4864 * In a start-stop-start use-case, we need to clear the quiescent state
4865 * of each channel set by the prior stop command, thus ensuring that a
4866 * following stop or destroy is sure to grab a timestamp_end near those
4867 * operations, even if the packet is empty.
4868 */
4869 (void) ust_app_clear_quiescent_session(usess);
4870
4871 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4872 ret = ust_app_start_trace(usess, app);
4873 if (ret < 0) {
4874 /* Continue to next apps even on error */
4875 continue;
4876 }
4877 }
4878
4879 rcu_read_unlock();
4880
4881 return 0;
4882 }
4883
4884 /*
4885 * Start tracing for the UST session.
4886 * Called with UST session lock held.
4887 */
4888 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
4889 {
4890 int ret = 0;
4891 struct lttng_ht_iter iter;
4892 struct ust_app *app;
4893
4894 DBG("Stopping all UST traces");
4895
4896 rcu_read_lock();
4897
4898 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4899 ret = ust_app_stop_trace(usess, app);
4900 if (ret < 0) {
4901 /* Continue to next apps even on error */
4902 continue;
4903 }
4904 }
4905
4906 (void) ust_app_flush_session(usess);
4907
4908 rcu_read_unlock();
4909
4910 return 0;
4911 }
4912
4913 /*
4914 * Destroy app UST session.
4915 */
4916 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
4917 {
4918 int ret = 0;
4919 struct lttng_ht_iter iter;
4920 struct ust_app *app;
4921
4922 DBG("Destroy all UST traces");
4923
4924 rcu_read_lock();
4925
4926 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4927 ret = destroy_trace(usess, app);
4928 if (ret < 0) {
4929 /* Continue to next apps even on error */
4930 continue;
4931 }
4932 }
4933
4934 rcu_read_unlock();
4935
4936 return 0;
4937 }
4938
4939 static
4940 void ust_app_global_create(struct ltt_ust_session *usess, struct ust_app *app)
4941 {
4942 int ret = 0;
4943 struct lttng_ht_iter iter, uiter;
4944 struct ust_app_session *ua_sess = NULL;
4945 struct ust_app_channel *ua_chan;
4946 struct ust_app_event *ua_event;
4947 struct ust_app_ctx *ua_ctx;
4948 int is_created = 0;
4949
4950 ret = create_ust_app_session(usess, app, &ua_sess, &is_created);
4951 if (ret < 0) {
4952 /* Tracer is probably gone or ENOMEM. */
4953 goto error;
4954 }
4955 if (!is_created) {
4956 /* App session already created. */
4957 goto end;
4958 }
4959 assert(ua_sess);
4960
4961 pthread_mutex_lock(&ua_sess->lock);
4962
4963 if (ua_sess->deleted) {
4964 pthread_mutex_unlock(&ua_sess->lock);
4965 goto end;
4966 }
4967
4968 /*
4969 * We can iterate safely here over all UST app session since the create ust
4970 * app session above made a shadow copy of the UST global domain from the
4971 * ltt ust session.
4972 */
4973 cds_lfht_for_each_entry(ua_sess->channels->ht, &iter.iter, ua_chan,
4974 node.node) {
4975 ret = do_create_channel(app, usess, ua_sess, ua_chan);
4976 if (ret < 0 && ret != -ENOTCONN) {
4977 /*
4978 * Stop everything. On error, the application
4979 * failed, no more file descriptor are available
4980 * or ENOMEM so stopping here is the only thing
4981 * we can do for now. The only exception is
4982 * -ENOTCONN, which indicates that the application
4983 * has exit.
4984 */
4985 goto error_unlock;
4986 }
4987
4988 /*
4989 * Add context using the list so they are enabled in the same order the
4990 * user added them.
4991 */
4992 cds_list_for_each_entry(ua_ctx, &ua_chan->ctx_list, list) {
4993 ret = create_ust_channel_context(ua_chan, ua_ctx, app);
4994 if (ret < 0) {
4995 goto error_unlock;
4996 }
4997 }
4998
4999
5000 /* For each events */
5001 cds_lfht_for_each_entry(ua_chan->events->ht, &uiter.iter, ua_event,
5002 node.node) {
5003 ret = create_ust_event(app, ua_sess, ua_chan, ua_event);
5004 if (ret < 0) {
5005 goto error_unlock;
5006 }
5007 }
5008 }
5009
5010 pthread_mutex_unlock(&ua_sess->lock);
5011
5012 if (usess->active) {
5013 ret = ust_app_start_trace(usess, app);
5014 if (ret < 0) {
5015 goto error;
5016 }
5017
5018 DBG2("UST trace started for app pid %d", app->pid);
5019 }
5020 end:
5021 /* Everything went well at this point. */
5022 return;
5023
5024 error_unlock:
5025 pthread_mutex_unlock(&ua_sess->lock);
5026 error:
5027 if (ua_sess) {
5028 destroy_app_session(app, ua_sess);
5029 }
5030 return;
5031 }
5032
5033 static
5034 void ust_app_global_destroy(struct ltt_ust_session *usess, struct ust_app *app)
5035 {
5036 struct ust_app_session *ua_sess;
5037
5038 ua_sess = lookup_session_by_app(usess, app);
5039 if (ua_sess == NULL) {
5040 return;
5041 }
5042 destroy_app_session(app, ua_sess);
5043 }
5044
5045 /*
5046 * Add channels/events from UST global domain to registered apps at sock.
5047 *
5048 * Called with session lock held.
5049 * Called with RCU read-side lock held.
5050 */
5051 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app)
5052 {
5053 assert(usess);
5054
5055 DBG2("UST app global update for app sock %d for session id %" PRIu64,
5056 app->sock, usess->id);
5057
5058 if (!app->compatible) {
5059 return;
5060 }
5061
5062 if (trace_ust_pid_tracker_lookup(usess, app->pid)) {
5063 ust_app_global_create(usess, app);
5064 } else {
5065 ust_app_global_destroy(usess, app);
5066 }
5067 }
5068
5069 /*
5070 * Called with session lock held.
5071 */
5072 void ust_app_global_update_all(struct ltt_ust_session *usess)
5073 {
5074 struct lttng_ht_iter iter;
5075 struct ust_app *app;
5076
5077 rcu_read_lock();
5078 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
5079 ust_app_global_update(usess, app);
5080 }
5081 rcu_read_unlock();
5082 }
5083
5084 /*
5085 * Add context to a specific channel for global UST domain.
5086 */
5087 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
5088 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
5089 {
5090 int ret = 0;
5091 struct lttng_ht_node_str *ua_chan_node;
5092 struct lttng_ht_iter iter, uiter;
5093 struct ust_app_channel *ua_chan = NULL;
5094 struct ust_app_session *ua_sess;
5095 struct ust_app *app;
5096
5097 rcu_read_lock();
5098
5099 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
5100 if (!app->compatible) {
5101 /*
5102 * TODO: In time, we should notice the caller of this error by
5103 * telling him that this is a version error.
5104 */
5105 continue;
5106 }
5107 ua_sess = lookup_session_by_app(usess, app);
5108 if (ua_sess == NULL) {
5109 continue;
5110 }
5111
5112 pthread_mutex_lock(&ua_sess->lock);
5113
5114 if (ua_sess->deleted) {
5115 pthread_mutex_unlock(&ua_sess->lock);
5116 continue;
5117 }
5118
5119 /* Lookup channel in the ust app session */
5120 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
5121 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
5122 if (ua_chan_node == NULL) {
5123 goto next_app;
5124 }
5125 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel,
5126 node);
5127 ret = create_ust_app_channel_context(ua_sess, ua_chan, &uctx->ctx, app);
5128 if (ret < 0) {
5129 goto next_app;
5130 }
5131 next_app:
5132 pthread_mutex_unlock(&ua_sess->lock);
5133 }
5134
5135 rcu_read_unlock();
5136 return ret;
5137 }
5138
5139 /*
5140 * Enable event for a channel from a UST session for a specific PID.
5141 */
5142 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
5143 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent, pid_t pid)
5144 {
5145 int ret = 0;
5146 struct lttng_ht_iter iter;
5147 struct lttng_ht_node_str *ua_chan_node;
5148 struct ust_app *app;
5149 struct ust_app_session *ua_sess;
5150 struct ust_app_channel *ua_chan;
5151 struct ust_app_event *ua_event;
5152
5153 DBG("UST app enabling event %s for PID %d", uevent->attr.name, pid);
5154
5155 rcu_read_lock();
5156
5157 app = ust_app_find_by_pid(pid);
5158 if (app == NULL) {
5159 ERR("UST app enable event per PID %d not found", pid);
5160 ret = -1;
5161 goto end;
5162 }
5163
5164 if (!app->compatible) {
5165 ret = 0;
5166 goto end;
5167 }
5168
5169 ua_sess = lookup_session_by_app(usess, app);
5170 if (!ua_sess) {
5171 /* The application has problem or is probably dead. */
5172 ret = 0;
5173 goto end;
5174 }
5175
5176 pthread_mutex_lock(&ua_sess->lock);
5177
5178 if (ua_sess->deleted) {
5179 ret = 0;
5180 goto end_unlock;
5181 }
5182
5183 /* Lookup channel in the ust app session */
5184 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &iter);
5185 ua_chan_node = lttng_ht_iter_get_node_str(&iter);
5186 /* If the channel is not found, there is a code flow error */
5187 assert(ua_chan_node);
5188
5189 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
5190
5191 ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
5192 uevent->filter, uevent->attr.loglevel, uevent->exclusion);
5193 if (ua_event == NULL) {
5194 ret = create_ust_app_event(ua_sess, ua_chan, uevent, app);
5195 if (ret < 0) {
5196 goto end_unlock;
5197 }
5198 } else {
5199 ret = enable_ust_app_event(ua_sess, ua_event, app);
5200 if (ret < 0) {
5201 goto end_unlock;
5202 }
5203 }
5204
5205 end_unlock:
5206 pthread_mutex_unlock(&ua_sess->lock);
5207 end:
5208 rcu_read_unlock();
5209 return ret;
5210 }
5211
5212 /*
5213 * Receive registration and populate the given msg structure.
5214 *
5215 * On success return 0 else a negative value returned by the ustctl call.
5216 */
5217 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
5218 {
5219 int ret;
5220 uint32_t pid, ppid, uid, gid;
5221
5222 assert(msg);
5223
5224 ret = ustctl_recv_reg_msg(sock, &msg->type, &msg->major, &msg->minor,
5225 &pid, &ppid, &uid, &gid,
5226 &msg->bits_per_long,
5227 &msg->uint8_t_alignment,
5228 &msg->uint16_t_alignment,
5229 &msg->uint32_t_alignment,
5230 &msg->uint64_t_alignment,
5231 &msg->long_alignment,
5232 &msg->byte_order,
5233 msg->name);
5234 if (ret < 0) {
5235 switch (-ret) {
5236 case EPIPE:
5237 case ECONNRESET:
5238 case LTTNG_UST_ERR_EXITING:
5239 DBG3("UST app recv reg message failed. Application died");
5240 break;
5241 case LTTNG_UST_ERR_UNSUP_MAJOR:
5242 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
5243 msg->major, msg->minor, LTTNG_UST_ABI_MAJOR_VERSION,
5244 LTTNG_UST_ABI_MINOR_VERSION);
5245 break;
5246 default:
5247 ERR("UST app recv reg message failed with ret %d", ret);
5248 break;
5249 }
5250 goto error;
5251 }
5252 msg->pid = (pid_t) pid;
5253 msg->ppid = (pid_t) ppid;
5254 msg->uid = (uid_t) uid;
5255 msg->gid = (gid_t) gid;
5256
5257 error:
5258 return ret;
5259 }
5260
5261 /*
5262 * Return a ust app session object using the application object and the
5263 * session object descriptor has a key. If not found, NULL is returned.
5264 * A RCU read side lock MUST be acquired when calling this function.
5265 */
5266 static struct ust_app_session *find_session_by_objd(struct ust_app *app,
5267 int objd)
5268 {
5269 struct lttng_ht_node_ulong *node;
5270 struct lttng_ht_iter iter;
5271 struct ust_app_session *ua_sess = NULL;
5272
5273 assert(app);
5274
5275 lttng_ht_lookup(app->ust_sessions_objd, (void *)((unsigned long) objd), &iter);
5276 node = lttng_ht_iter_get_node_ulong(&iter);
5277 if (node == NULL) {
5278 DBG2("UST app session find by objd %d not found", objd);
5279 goto error;
5280 }
5281
5282 ua_sess = caa_container_of(node, struct ust_app_session, ust_objd_node);
5283
5284 error:
5285 return ua_sess;
5286 }
5287
5288 /*
5289 * Return a ust app channel object using the application object and the channel
5290 * object descriptor has a key. If not found, NULL is returned. A RCU read side
5291 * lock MUST be acquired before calling this function.
5292 */
5293 static struct ust_app_channel *find_channel_by_objd(struct ust_app *app,
5294 int objd)
5295 {
5296 struct lttng_ht_node_ulong *node;
5297 struct lttng_ht_iter iter;
5298 struct ust_app_channel *ua_chan = NULL;
5299
5300 assert(app);
5301
5302 lttng_ht_lookup(app->ust_objd, (void *)((unsigned long) objd), &iter);
5303 node = lttng_ht_iter_get_node_ulong(&iter);
5304 if (node == NULL) {
5305 DBG2("UST app channel find by objd %d not found", objd);
5306 goto error;
5307 }
5308
5309 ua_chan = caa_container_of(node, struct ust_app_channel, ust_objd_node);
5310
5311 error:
5312 return ua_chan;
5313 }
5314
5315 /*
5316 * Reply to a register channel notification from an application on the notify
5317 * socket. The channel metadata is also created.
5318 *
5319 * The session UST registry lock is acquired in this function.
5320 *
5321 * On success 0 is returned else a negative value.
5322 */
5323 static int reply_ust_register_channel(int sock, int sobjd, int cobjd,
5324 size_t nr_fields, struct ustctl_field *fields)
5325 {
5326 int ret, ret_code = 0;
5327 uint32_t chan_id, reg_count;
5328 uint64_t chan_reg_key;
5329 enum ustctl_channel_header type;
5330 struct ust_app *app;
5331 struct ust_app_channel *ua_chan;
5332 struct ust_app_session *ua_sess;
5333 struct ust_registry_session *registry;
5334 struct ust_registry_channel *chan_reg;
5335
5336 rcu_read_lock();
5337
5338 /* Lookup application. If not found, there is a code flow error. */
5339 app = find_app_by_notify_sock(sock);
5340 if (!app) {
5341 DBG("Application socket %d is being torn down. Abort event notify",
5342 sock);
5343 ret = 0;
5344 goto error_rcu_unlock;
5345 }
5346
5347 /* Lookup channel by UST object descriptor. */
5348 ua_chan = find_channel_by_objd(app, cobjd);
5349 if (!ua_chan) {
5350 DBG("Application channel is being torn down. Abort event notify");
5351 ret = 0;
5352 goto error_rcu_unlock;
5353 }
5354
5355 assert(ua_chan->session);
5356 ua_sess = ua_chan->session;
5357
5358 /* Get right session registry depending on the session buffer type. */
5359 registry = get_session_registry(ua_sess);
5360 if (!registry) {
5361 DBG("Application session is being torn down. Abort event notify");
5362 ret = 0;
5363 goto error_rcu_unlock;
5364 };
5365
5366 /* Depending on the buffer type, a different channel key is used. */
5367 if (ua_sess->buffer_type == LTTNG_BUFFER_PER_UID) {
5368 chan_reg_key = ua_chan->tracing_channel_id;
5369 } else {
5370 chan_reg_key = ua_chan->key;
5371 }
5372
5373 pthread_mutex_lock(&registry->lock);
5374
5375 chan_reg = ust_registry_channel_find(registry, chan_reg_key);
5376 assert(chan_reg);
5377
5378 if (!chan_reg->register_done) {
5379 reg_count = ust_registry_get_event_count(chan_reg);
5380 if (reg_count < 31) {
5381 type = USTCTL_CHANNEL_HEADER_COMPACT;
5382 } else {
5383 type = USTCTL_CHANNEL_HEADER_LARGE;
5384 }
5385
5386 chan_reg->nr_ctx_fields = nr_fields;
5387 chan_reg->ctx_fields = fields;
5388 fields = NULL;
5389 chan_reg->header_type = type;
5390 } else {
5391 /* Get current already assigned values. */
5392 type = chan_reg->header_type;
5393 }
5394 /* Channel id is set during the object creation. */
5395 chan_id = chan_reg->chan_id;
5396
5397 /* Append to metadata */
5398 if (!chan_reg->metadata_dumped) {
5399 ret_code = ust_metadata_channel_statedump(registry, chan_reg);
5400 if (ret_code) {
5401 ERR("Error appending channel metadata (errno = %d)", ret_code);
5402 goto reply;
5403 }
5404 }
5405
5406 reply:
5407 DBG3("UST app replying to register channel key %" PRIu64
5408 " with id %u, type: %d, ret: %d", chan_reg_key, chan_id, type,
5409 ret_code);
5410
5411 ret = ustctl_reply_register_channel(sock, chan_id, type, ret_code);
5412 if (ret < 0) {
5413 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
5414 ERR("UST app reply channel failed with ret %d", ret);
5415 } else {
5416 DBG3("UST app reply channel failed. Application died");
5417 }
5418 goto error;
5419 }
5420
5421 /* This channel registry registration is completed. */
5422 chan_reg->register_done = 1;
5423
5424 error:
5425 pthread_mutex_unlock(&registry->lock);
5426 error_rcu_unlock:
5427 rcu_read_unlock();
5428 free(fields);
5429 return ret;
5430 }
5431
5432 /*
5433 * Add event to the UST channel registry. When the event is added to the
5434 * registry, the metadata is also created. Once done, this replies to the
5435 * application with the appropriate error code.
5436 *
5437 * The session UST registry lock is acquired in the function.
5438 *
5439 * On success 0 is returned else a negative value.
5440 */
5441 static int add_event_ust_registry(int sock, int sobjd, int cobjd, char *name,
5442 char *sig, size_t nr_fields, struct ustctl_field *fields,
5443 int loglevel_value, char *model_emf_uri)
5444 {
5445 int ret, ret_code;
5446 uint32_t event_id = 0;
5447 uint64_t chan_reg_key;
5448 struct ust_app *app;
5449 struct ust_app_channel *ua_chan;
5450 struct ust_app_session *ua_sess;
5451 struct ust_registry_session *registry;
5452
5453 rcu_read_lock();
5454
5455 /* Lookup application. If not found, there is a code flow error. */
5456 app = find_app_by_notify_sock(sock);
5457 if (!app) {
5458 DBG("Application socket %d is being torn down. Abort event notify",
5459 sock);
5460 ret = 0;
5461 goto error_rcu_unlock;
5462 }
5463
5464 /* Lookup channel by UST object descriptor. */
5465 ua_chan = find_channel_by_objd(app, cobjd);
5466 if (!ua_chan) {
5467 DBG("Application channel is being torn down. Abort event notify");
5468 ret = 0;
5469 goto error_rcu_unlock;
5470 }
5471
5472 assert(ua_chan->session);
5473 ua_sess = ua_chan->session;
5474
5475 registry = get_session_registry(ua_sess);
5476 if (!registry) {
5477 DBG("Application session is being torn down. Abort event notify");
5478 ret = 0;
5479 goto error_rcu_unlock;
5480 }
5481
5482 if (ua_sess->buffer_type == LTTNG_BUFFER_PER_UID) {
5483 chan_reg_key = ua_chan->tracing_channel_id;
5484 } else {
5485 chan_reg_key = ua_chan->key;
5486 }
5487
5488 pthread_mutex_lock(&registry->lock);
5489
5490 /*
5491 * From this point on, this call acquires the ownership of the sig, fields
5492 * and model_emf_uri meaning any free are done inside it if needed. These
5493 * three variables MUST NOT be read/write after this.
5494 */
5495 ret_code = ust_registry_create_event(registry, chan_reg_key,
5496 sobjd, cobjd, name, sig, nr_fields, fields,
5497 loglevel_value, model_emf_uri, ua_sess->buffer_type,
5498 &event_id, app);
5499 sig = NULL;
5500 fields = NULL;
5501 model_emf_uri = NULL;
5502
5503 /*
5504 * The return value is returned to ustctl so in case of an error, the
5505 * application can be notified. In case of an error, it's important not to
5506 * return a negative error or else the application will get closed.
5507 */
5508 ret = ustctl_reply_register_event(sock, event_id, ret_code);
5509 if (ret < 0) {
5510 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
5511 ERR("UST app reply event failed with ret %d", ret);
5512 } else {
5513 DBG3("UST app reply event failed. Application died");
5514 }
5515 /*
5516 * No need to wipe the create event since the application socket will
5517 * get close on error hence cleaning up everything by itself.
5518 */
5519 goto error;
5520 }
5521
5522 DBG3("UST registry event %s with id %" PRId32 " added successfully",
5523 name, event_id);
5524
5525 error:
5526 pthread_mutex_unlock(&registry->lock);
5527 error_rcu_unlock:
5528 rcu_read_unlock();
5529 free(sig);
5530 free(fields);
5531 free(model_emf_uri);
5532 return ret;
5533 }
5534
5535 /*
5536 * Add enum to the UST session registry. Once done, this replies to the
5537 * application with the appropriate error code.
5538 *
5539 * The session UST registry lock is acquired within this function.
5540 *
5541 * On success 0 is returned else a negative value.
5542 */
5543 static int add_enum_ust_registry(int sock, int sobjd, char *name,
5544 struct ustctl_enum_entry *entries, size_t nr_entries)
5545 {
5546 int ret = 0, ret_code;
5547 struct ust_app *app;
5548 struct ust_app_session *ua_sess;
5549 struct ust_registry_session *registry;
5550 uint64_t enum_id = -1ULL;
5551
5552 rcu_read_lock();
5553
5554 /* Lookup application. If not found, there is a code flow error. */
5555 app = find_app_by_notify_sock(sock);
5556 if (!app) {
5557 /* Return an error since this is not an error */
5558 DBG("Application socket %d is being torn down. Aborting enum registration",
5559 sock);
5560 free(entries);
5561 goto error_rcu_unlock;
5562 }
5563
5564 /* Lookup session by UST object descriptor. */
5565 ua_sess = find_session_by_objd(app, sobjd);
5566 if (!ua_sess) {
5567 /* Return an error since this is not an error */
5568 DBG("Application session is being torn down (session not found). Aborting enum registration.");
5569 free(entries);
5570 goto error_rcu_unlock;
5571 }
5572
5573 registry = get_session_registry(ua_sess);
5574 if (!registry) {
5575 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
5576 free(entries);
5577 goto error_rcu_unlock;
5578 }
5579
5580 pthread_mutex_lock(&registry->lock);
5581
5582 /*
5583 * From this point on, the callee acquires the ownership of
5584 * entries. The variable entries MUST NOT be read/written after
5585 * call.
5586 */
5587 ret_code = ust_registry_create_or_find_enum(registry, sobjd, name,
5588 entries, nr_entries, &enum_id);
5589 entries = NULL;
5590
5591 /*
5592 * The return value is returned to ustctl so in case of an error, the
5593 * application can be notified. In case of an error, it's important not to
5594 * return a negative error or else the application will get closed.
5595 */
5596 ret = ustctl_reply_register_enum(sock, enum_id, ret_code);
5597 if (ret < 0) {
5598 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
5599 ERR("UST app reply enum failed with ret %d", ret);
5600 } else {
5601 DBG3("UST app reply enum failed. Application died");
5602 }
5603 /*
5604 * No need to wipe the create enum since the application socket will
5605 * get close on error hence cleaning up everything by itself.
5606 */
5607 goto error;
5608 }
5609
5610 DBG3("UST registry enum %s added successfully or already found", name);
5611
5612 error:
5613 pthread_mutex_unlock(&registry->lock);
5614 error_rcu_unlock:
5615 rcu_read_unlock();
5616 return ret;
5617 }
5618
5619 /*
5620 * Handle application notification through the given notify socket.
5621 *
5622 * Return 0 on success or else a negative value.
5623 */
5624 int ust_app_recv_notify(int sock)
5625 {
5626 int ret;
5627 enum ustctl_notify_cmd cmd;
5628
5629 DBG3("UST app receiving notify from sock %d", sock);
5630
5631 ret = ustctl_recv_notify(sock, &cmd);
5632 if (ret < 0) {
5633 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
5634 ERR("UST app recv notify failed with ret %d", ret);
5635 } else {
5636 DBG3("UST app recv notify failed. Application died");
5637 }
5638 goto error;
5639 }
5640
5641 switch (cmd) {
5642 case USTCTL_NOTIFY_CMD_EVENT:
5643 {
5644 int sobjd, cobjd, loglevel_value;
5645 char name[LTTNG_UST_SYM_NAME_LEN], *sig, *model_emf_uri;
5646 size_t nr_fields;
5647 struct ustctl_field *fields;
5648
5649 DBG2("UST app ustctl register event received");
5650
5651 ret = ustctl_recv_register_event(sock, &sobjd, &cobjd, name,
5652 &loglevel_value, &sig, &nr_fields, &fields,
5653 &model_emf_uri);
5654 if (ret < 0) {
5655 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
5656 ERR("UST app recv event failed with ret %d", ret);
5657 } else {
5658 DBG3("UST app recv event failed. Application died");
5659 }
5660 goto error;
5661 }
5662
5663 /*
5664 * Add event to the UST registry coming from the notify socket. This
5665 * call will free if needed the sig, fields and model_emf_uri. This
5666 * code path loses the ownsership of these variables and transfer them
5667 * to the this function.
5668 */
5669 ret = add_event_ust_registry(sock, sobjd, cobjd, name, sig, nr_fields,
5670 fields, loglevel_value, model_emf_uri);
5671 if (ret < 0) {
5672 goto error;
5673 }
5674
5675 break;
5676 }
5677 case USTCTL_NOTIFY_CMD_CHANNEL:
5678 {
5679 int sobjd, cobjd;
5680 size_t nr_fields;
5681 struct ustctl_field *fields;
5682
5683 DBG2("UST app ustctl register channel received");
5684
5685 ret = ustctl_recv_register_channel(sock, &sobjd, &cobjd, &nr_fields,
5686 &fields);
5687 if (ret < 0) {
5688 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
5689 ERR("UST app recv channel failed with ret %d", ret);
5690 } else {
5691 DBG3("UST app recv channel failed. Application died");
5692 }
5693 goto error;
5694 }
5695
5696 /*
5697 * The fields ownership are transfered to this function call meaning
5698 * that if needed it will be freed. After this, it's invalid to access
5699 * fields or clean it up.
5700 */
5701 ret = reply_ust_register_channel(sock, sobjd, cobjd, nr_fields,
5702 fields);
5703 if (ret < 0) {
5704 goto error;
5705 }
5706
5707 break;
5708 }
5709 case USTCTL_NOTIFY_CMD_ENUM:
5710 {
5711 int sobjd;
5712 char name[LTTNG_UST_SYM_NAME_LEN];
5713 size_t nr_entries;
5714 struct ustctl_enum_entry *entries;
5715
5716 DBG2("UST app ustctl register enum received");
5717
5718 ret = ustctl_recv_register_enum(sock, &sobjd, name,
5719 &entries, &nr_entries);
5720 if (ret < 0) {
5721 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
5722 ERR("UST app recv enum failed with ret %d", ret);
5723 } else {
5724 DBG3("UST app recv enum failed. Application died");
5725 }
5726 goto error;
5727 }
5728
5729 /* Callee assumes ownership of entries */
5730 ret = add_enum_ust_registry(sock, sobjd, name,
5731 entries, nr_entries);
5732 if (ret < 0) {
5733 goto error;
5734 }
5735
5736 break;
5737 }
5738 default:
5739 /* Should NEVER happen. */
5740 assert(0);
5741 }
5742
5743 error:
5744 return ret;
5745 }
5746
5747 /*
5748 * Once the notify socket hangs up, this is called. First, it tries to find the
5749 * corresponding application. On failure, the call_rcu to close the socket is
5750 * executed. If an application is found, it tries to delete it from the notify
5751 * socket hash table. Whathever the result, it proceeds to the call_rcu.
5752 *
5753 * Note that an object needs to be allocated here so on ENOMEM failure, the
5754 * call RCU is not done but the rest of the cleanup is.
5755 */
5756 void ust_app_notify_sock_unregister(int sock)
5757 {
5758 int err_enomem = 0;
5759 struct lttng_ht_iter iter;
5760 struct ust_app *app;
5761 struct ust_app_notify_sock_obj *obj;
5762
5763 assert(sock >= 0);
5764
5765 rcu_read_lock();
5766
5767 obj = zmalloc(sizeof(*obj));
5768 if (!obj) {
5769 /*
5770 * An ENOMEM is kind of uncool. If this strikes we continue the
5771 * procedure but the call_rcu will not be called. In this case, we
5772 * accept the fd leak rather than possibly creating an unsynchronized
5773 * state between threads.
5774 *
5775 * TODO: The notify object should be created once the notify socket is
5776 * registered and stored independantely from the ust app object. The
5777 * tricky part is to synchronize the teardown of the application and
5778 * this notify object. Let's keep that in mind so we can avoid this
5779 * kind of shenanigans with ENOMEM in the teardown path.
5780 */
5781 err_enomem = 1;
5782 } else {
5783 obj->fd = sock;
5784 }
5785
5786 DBG("UST app notify socket unregister %d", sock);
5787
5788 /*
5789 * Lookup application by notify socket. If this fails, this means that the
5790 * hash table delete has already been done by the application
5791 * unregistration process so we can safely close the notify socket in a
5792 * call RCU.
5793 */
5794 app = find_app_by_notify_sock(sock);
5795 if (!app) {
5796 goto close_socket;
5797 }
5798
5799 iter.iter.node = &app->notify_sock_n.node;
5800
5801 /*
5802 * Whatever happens here either we fail or succeed, in both cases we have
5803 * to close the socket after a grace period to continue to the call RCU
5804 * here. If the deletion is successful, the application is not visible
5805 * anymore by other threads and is it fails it means that it was already
5806 * deleted from the hash table so either way we just have to close the
5807 * socket.
5808 */
5809 (void) lttng_ht_del(ust_app_ht_by_notify_sock, &iter);
5810
5811 close_socket:
5812 rcu_read_unlock();
5813
5814 /*
5815 * Close socket after a grace period to avoid for the socket to be reused
5816 * before the application object is freed creating potential race between
5817 * threads trying to add unique in the global hash table.
5818 */
5819 if (!err_enomem) {
5820 call_rcu(&obj->head, close_notify_sock_rcu);
5821 }
5822 }
5823
5824 /*
5825 * Destroy a ust app data structure and free its memory.
5826 */
5827 void ust_app_destroy(struct ust_app *app)
5828 {
5829 if (!app) {
5830 return;
5831 }
5832
5833 call_rcu(&app->pid_n.head, delete_ust_app_rcu);
5834 }
5835
5836 /*
5837 * Take a snapshot for a given UST session. The snapshot is sent to the given
5838 * output.
5839 *
5840 * Return 0 on success or else a negative value.
5841 */
5842 int ust_app_snapshot_record(struct ltt_ust_session *usess,
5843 struct snapshot_output *output, int wait,
5844 uint64_t nb_packets_per_stream)
5845 {
5846 int ret = 0;
5847 struct lttng_ht_iter iter;
5848 struct ust_app *app;
5849 char pathname[PATH_MAX];
5850
5851 assert(usess);
5852 assert(output);
5853
5854 rcu_read_lock();
5855
5856 switch (usess->buffer_type) {
5857 case LTTNG_BUFFER_PER_UID:
5858 {
5859 struct buffer_reg_uid *reg;
5860
5861 cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
5862 struct buffer_reg_channel *reg_chan;
5863 struct consumer_socket *socket;
5864
5865 /* Get consumer socket to use to push the metadata.*/
5866 socket = consumer_find_socket_by_bitness(reg->bits_per_long,
5867 usess->consumer);
5868 if (!socket) {
5869 ret = -EINVAL;
5870 goto error;
5871 }
5872
5873 memset(pathname, 0, sizeof(pathname));
5874 ret = snprintf(pathname, sizeof(pathname),
5875 DEFAULT_UST_TRACE_DIR "/" DEFAULT_UST_TRACE_UID_PATH,
5876 reg->uid, reg->bits_per_long);
5877 if (ret < 0) {
5878 PERROR("snprintf snapshot path");
5879 goto error;
5880 }
5881
5882 /* Add the UST default trace dir to path. */
5883 cds_lfht_for_each_entry(reg->registry->channels->ht, &iter.iter,
5884 reg_chan, node.node) {
5885 ret = consumer_snapshot_channel(socket, reg_chan->consumer_key,
5886 output, 0, usess->uid, usess->gid, pathname, wait,
5887 nb_packets_per_stream);
5888 if (ret < 0) {
5889 goto error;
5890 }
5891 }
5892 ret = consumer_snapshot_channel(socket,
5893 reg->registry->reg.ust->metadata_key, output, 1,
5894 usess->uid, usess->gid, pathname, wait, 0);
5895 if (ret < 0) {
5896 goto error;
5897 }
5898 }
5899 break;
5900 }
5901 case LTTNG_BUFFER_PER_PID:
5902 {
5903 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
5904 struct consumer_socket *socket;
5905 struct lttng_ht_iter chan_iter;
5906 struct ust_app_channel *ua_chan;
5907 struct ust_app_session *ua_sess;
5908 struct ust_registry_session *registry;
5909
5910 ua_sess = lookup_session_by_app(usess, app);
5911 if (!ua_sess) {
5912 /* Session not associated with this app. */
5913 continue;
5914 }
5915
5916 /* Get the right consumer socket for the application. */
5917 socket = consumer_find_socket_by_bitness(app->bits_per_long,
5918 output->consumer);
5919 if (!socket) {
5920 ret = -EINVAL;
5921 goto error;
5922 }
5923
5924 /* Add the UST default trace dir to path. */
5925 memset(pathname, 0, sizeof(pathname));
5926 ret = snprintf(pathname, sizeof(pathname), DEFAULT_UST_TRACE_DIR "/%s",
5927 ua_sess->path);
5928 if (ret < 0) {
5929 PERROR("snprintf snapshot path");
5930 goto error;
5931 }
5932
5933 cds_lfht_for_each_entry(ua_sess->channels->ht, &chan_iter.iter,
5934 ua_chan, node.node) {
5935 ret = consumer_snapshot_channel(socket, ua_chan->key, output,
5936 0, ua_sess->euid, ua_sess->egid, pathname, wait,
5937 nb_packets_per_stream);
5938 if (ret < 0) {
5939 goto error;
5940 }
5941 }
5942
5943 registry = get_session_registry(ua_sess);
5944 if (!registry) {
5945 DBG("Application session is being torn down. Abort snapshot record.");
5946 ret = -1;
5947 goto error;
5948 }
5949 ret = consumer_snapshot_channel(socket, registry->metadata_key, output,
5950 1, ua_sess->euid, ua_sess->egid, pathname, wait, 0);
5951 if (ret < 0) {
5952 goto error;
5953 }
5954 }
5955 break;
5956 }
5957 default:
5958 assert(0);
5959 break;
5960 }
5961
5962 error:
5963 rcu_read_unlock();
5964 return ret;
5965 }
5966
5967 /*
5968 * Return the size taken by one more packet per stream.
5969 */
5970 uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session *usess,
5971 uint64_t cur_nr_packets)
5972 {
5973 uint64_t tot_size = 0;
5974 struct ust_app *app;
5975 struct lttng_ht_iter iter;
5976
5977 assert(usess);
5978
5979 switch (usess->buffer_type) {
5980 case LTTNG_BUFFER_PER_UID:
5981 {
5982 struct buffer_reg_uid *reg;
5983
5984 cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
5985 struct buffer_reg_channel *reg_chan;
5986
5987 rcu_read_lock();
5988 cds_lfht_for_each_entry(reg->registry->channels->ht, &iter.iter,
5989 reg_chan, node.node) {
5990 if (cur_nr_packets >= reg_chan->num_subbuf) {
5991 /*
5992 * Don't take channel into account if we
5993 * already grab all its packets.
5994 */
5995 continue;
5996 }
5997 tot_size += reg_chan->subbuf_size * reg_chan->stream_count;
5998 }
5999 rcu_read_unlock();
6000 }
6001 break;
6002 }
6003 case LTTNG_BUFFER_PER_PID:
6004 {
6005 rcu_read_lock();
6006 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
6007 struct ust_app_channel *ua_chan;
6008 struct ust_app_session *ua_sess;
6009 struct lttng_ht_iter chan_iter;
6010
6011 ua_sess = lookup_session_by_app(usess, app);
6012 if (!ua_sess) {
6013 /* Session not associated with this app. */
6014 continue;
6015 }
6016
6017 cds_lfht_for_each_entry(ua_sess->channels->ht, &chan_iter.iter,
6018 ua_chan, node.node) {
6019 if (cur_nr_packets >= ua_chan->attr.num_subbuf) {
6020 /*
6021 * Don't take channel into account if we
6022 * already grab all its packets.
6023 */
6024 continue;
6025 }
6026 tot_size += ua_chan->attr.subbuf_size * ua_chan->streams.count;
6027 }
6028 }
6029 rcu_read_unlock();
6030 break;
6031 }
6032 default:
6033 assert(0);
6034 break;
6035 }
6036
6037 return tot_size;
6038 }
6039
6040 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
6041 struct cds_list_head *buffer_reg_uid_list,
6042 struct consumer_output *consumer, uint64_t uchan_id,
6043 int overwrite, uint64_t *discarded, uint64_t *lost)
6044 {
6045 int ret;
6046 uint64_t consumer_chan_key;
6047
6048 *discarded = 0;
6049 *lost = 0;
6050
6051 ret = buffer_reg_uid_consumer_channel_key(
6052 buffer_reg_uid_list, ust_session_id,
6053 uchan_id, &consumer_chan_key);
6054 if (ret < 0) {
6055 /* Not found */
6056 ret = 0;
6057 goto end;
6058 }
6059
6060 if (overwrite) {
6061 ret = consumer_get_lost_packets(ust_session_id,
6062 consumer_chan_key, consumer, lost);
6063 } else {
6064 ret = consumer_get_discarded_events(ust_session_id,
6065 consumer_chan_key, consumer, discarded);
6066 }
6067
6068 end:
6069 return ret;
6070 }
6071
6072 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
6073 struct ltt_ust_channel *uchan,
6074 struct consumer_output *consumer, int overwrite,
6075 uint64_t *discarded, uint64_t *lost)
6076 {
6077 int ret = 0;
6078 struct lttng_ht_iter iter;
6079 struct lttng_ht_node_str *ua_chan_node;
6080 struct ust_app *app;
6081 struct ust_app_session *ua_sess;
6082 struct ust_app_channel *ua_chan;
6083
6084 *discarded = 0;
6085 *lost = 0;
6086
6087 rcu_read_lock();
6088 /*
6089 * Iterate over every registered applications. Sum counters for
6090 * all applications containing requested session and channel.
6091 */
6092 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
6093 struct lttng_ht_iter uiter;
6094
6095 ua_sess = lookup_session_by_app(usess, app);
6096 if (ua_sess == NULL) {
6097 continue;
6098 }
6099
6100 /* Get channel */
6101 lttng_ht_lookup(ua_sess->channels, (void *) uchan->name, &uiter);
6102 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
6103 /* If the session is found for the app, the channel must be there */
6104 assert(ua_chan_node);
6105
6106 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
6107
6108 if (overwrite) {
6109 uint64_t _lost;
6110
6111 ret = consumer_get_lost_packets(usess->id, ua_chan->key,
6112 consumer, &_lost);
6113 if (ret < 0) {
6114 break;
6115 }
6116 (*lost) += _lost;
6117 } else {
6118 uint64_t _discarded;
6119
6120 ret = consumer_get_discarded_events(usess->id,
6121 ua_chan->key, consumer, &_discarded);
6122 if (ret < 0) {
6123 break;
6124 }
6125 (*discarded) += _discarded;
6126 }
6127 }
6128
6129 rcu_read_unlock();
6130 return ret;
6131 }
6132
6133 static
6134 int ust_app_regenerate_statedump(struct ltt_ust_session *usess,
6135 struct ust_app *app)
6136 {
6137 int ret = 0;
6138 struct ust_app_session *ua_sess;
6139
6140 DBG("Regenerating the metadata for ust app pid %d", app->pid);
6141
6142 rcu_read_lock();
6143
6144 ua_sess = lookup_session_by_app(usess, app);
6145 if (ua_sess == NULL) {
6146 /* The session is in teardown process. Ignore and continue. */
6147 goto end;
6148 }
6149
6150 pthread_mutex_lock(&ua_sess->lock);
6151
6152 if (ua_sess->deleted) {
6153 goto end_unlock;
6154 }
6155
6156 pthread_mutex_lock(&app->sock_lock);
6157 ret = ustctl_regenerate_statedump(app->sock, ua_sess->handle);
6158 pthread_mutex_unlock(&app->sock_lock);
6159
6160 end_unlock:
6161 pthread_mutex_unlock(&ua_sess->lock);
6162
6163 end:
6164 rcu_read_unlock();
6165 health_code_update();
6166 return ret;
6167 }
6168
6169 /*
6170 * Regenerate the statedump for each app in the session.
6171 */
6172 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess)
6173 {
6174 int ret = 0;
6175 struct lttng_ht_iter iter;
6176 struct ust_app *app;
6177
6178 DBG("Regenerating the metadata for all UST apps");
6179
6180 rcu_read_lock();
6181
6182 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
6183 if (!app->compatible) {
6184 continue;
6185 }
6186
6187 ret = ust_app_regenerate_statedump(usess, app);
6188 if (ret < 0) {
6189 /* Continue to the next app even on error */
6190 continue;
6191 }
6192 }
6193
6194 rcu_read_unlock();
6195
6196 return 0;
6197 }
This page took 0.182074 seconds and 4 git commands to generate.