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