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