Fix: deadlock between UST registry lock and consumer lock
[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 static
44 int ust_app_flush_app_session(struct ust_app *app, struct ust_app_session *ua_sess);
45
46 /* Next available channel key. Access under next_channel_key_lock. */
47 static uint64_t _next_channel_key;
48 static pthread_mutex_t next_channel_key_lock = PTHREAD_MUTEX_INITIALIZER;
49
50 /* Next available session ID. Access under next_session_id_lock. */
51 static uint64_t _next_session_id;
52 static pthread_mutex_t next_session_id_lock = PTHREAD_MUTEX_INITIALIZER;
53
54 /*
55 * Return the incremented value of next_channel_key.
56 */
57 static uint64_t get_next_channel_key(void)
58 {
59 uint64_t ret;
60
61 pthread_mutex_lock(&next_channel_key_lock);
62 ret = ++_next_channel_key;
63 pthread_mutex_unlock(&next_channel_key_lock);
64 return ret;
65 }
66
67 /*
68 * Return the atomically incremented value of next_session_id.
69 */
70 static uint64_t get_next_session_id(void)
71 {
72 uint64_t ret;
73
74 pthread_mutex_lock(&next_session_id_lock);
75 ret = ++_next_session_id;
76 pthread_mutex_unlock(&next_session_id_lock);
77 return ret;
78 }
79
80 static void copy_channel_attr_to_ustctl(
81 struct ustctl_consumer_channel_attr *attr,
82 struct lttng_ust_channel_attr *uattr)
83 {
84 /* Copy event attributes since the layout is different. */
85 attr->subbuf_size = uattr->subbuf_size;
86 attr->num_subbuf = uattr->num_subbuf;
87 attr->overwrite = uattr->overwrite;
88 attr->switch_timer_interval = uattr->switch_timer_interval;
89 attr->read_timer_interval = uattr->read_timer_interval;
90 attr->output = uattr->output;
91 }
92
93 /*
94 * Match function for the hash table lookup.
95 *
96 * It matches an ust app event based on three attributes which are the event
97 * name, the filter bytecode and the loglevel.
98 */
99 static int ht_match_ust_app_event(struct cds_lfht_node *node, const void *_key)
100 {
101 struct ust_app_event *event;
102 const struct ust_app_ht_key *key;
103
104 assert(node);
105 assert(_key);
106
107 event = caa_container_of(node, struct ust_app_event, node.node);
108 key = _key;
109
110 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
111
112 /* Event name */
113 if (strncmp(event->attr.name, key->name, sizeof(event->attr.name)) != 0) {
114 goto no_match;
115 }
116
117 /* Event loglevel. */
118 if (event->attr.loglevel != key->loglevel) {
119 if (event->attr.loglevel_type == LTTNG_UST_LOGLEVEL_ALL
120 && key->loglevel == 0 && event->attr.loglevel == -1) {
121 /*
122 * Match is accepted. This is because on event creation, the
123 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
124 * -1 are accepted for this loglevel type since 0 is the one set by
125 * the API when receiving an enable event.
126 */
127 } else {
128 goto no_match;
129 }
130 }
131
132 /* One of the filters is NULL, fail. */
133 if ((key->filter && !event->filter) || (!key->filter && event->filter)) {
134 goto no_match;
135 }
136
137 if (key->filter && event->filter) {
138 /* Both filters exists, check length followed by the bytecode. */
139 if (event->filter->len != key->filter->len ||
140 memcmp(event->filter->data, key->filter->data,
141 event->filter->len) != 0) {
142 goto no_match;
143 }
144 }
145
146 /* One of the exclusions is NULL, fail. */
147 if ((key->exclusion && !event->exclusion) || (!key->exclusion && event->exclusion)) {
148 goto no_match;
149 }
150
151 if (key->exclusion && event->exclusion) {
152 /* Both exclusions exists, check count followed by the names. */
153 if (event->exclusion->count != key->exclusion->count ||
154 memcmp(event->exclusion->names, key->exclusion->names,
155 event->exclusion->count * LTTNG_UST_SYM_NAME_LEN) != 0) {
156 goto no_match;
157 }
158 }
159
160
161 /* Match. */
162 return 1;
163
164 no_match:
165 return 0;
166 }
167
168 /*
169 * Unique add of an ust app event in the given ht. This uses the custom
170 * ht_match_ust_app_event match function and the event name as hash.
171 */
172 static void add_unique_ust_app_event(struct ust_app_channel *ua_chan,
173 struct ust_app_event *event)
174 {
175 struct cds_lfht_node *node_ptr;
176 struct ust_app_ht_key key;
177 struct lttng_ht *ht;
178
179 assert(ua_chan);
180 assert(ua_chan->events);
181 assert(event);
182
183 ht = ua_chan->events;
184 key.name = event->attr.name;
185 key.filter = event->filter;
186 key.loglevel = event->attr.loglevel;
187 key.exclusion = event->exclusion;
188
189 node_ptr = cds_lfht_add_unique(ht->ht,
190 ht->hash_fct(event->node.key, lttng_ht_seed),
191 ht_match_ust_app_event, &key, &event->node.node);
192 assert(node_ptr == &event->node.node);
193 }
194
195 /*
196 * Close the notify socket from the given RCU head object. This MUST be called
197 * through a call_rcu().
198 */
199 static void close_notify_sock_rcu(struct rcu_head *head)
200 {
201 int ret;
202 struct ust_app_notify_sock_obj *obj =
203 caa_container_of(head, struct ust_app_notify_sock_obj, head);
204
205 /* Must have a valid fd here. */
206 assert(obj->fd >= 0);
207
208 ret = close(obj->fd);
209 if (ret) {
210 ERR("close notify sock %d RCU", obj->fd);
211 }
212 lttng_fd_put(LTTNG_FD_APPS, 1);
213
214 free(obj);
215 }
216
217 /*
218 * Return the session registry according to the buffer type of the given
219 * session.
220 *
221 * A registry per UID object MUST exists before calling this function or else
222 * it assert() if not found. RCU read side lock must be acquired.
223 */
224 static struct ust_registry_session *get_session_registry(
225 struct ust_app_session *ua_sess)
226 {
227 struct ust_registry_session *registry = NULL;
228
229 assert(ua_sess);
230
231 switch (ua_sess->buffer_type) {
232 case LTTNG_BUFFER_PER_PID:
233 {
234 struct buffer_reg_pid *reg_pid = buffer_reg_pid_find(ua_sess->id);
235 if (!reg_pid) {
236 goto error;
237 }
238 registry = reg_pid->registry->reg.ust;
239 break;
240 }
241 case LTTNG_BUFFER_PER_UID:
242 {
243 struct buffer_reg_uid *reg_uid = buffer_reg_uid_find(
244 ua_sess->tracing_id, ua_sess->bits_per_long, ua_sess->uid);
245 if (!reg_uid) {
246 goto error;
247 }
248 registry = reg_uid->registry->reg.ust;
249 break;
250 }
251 default:
252 assert(0);
253 };
254
255 error:
256 return registry;
257 }
258
259 /*
260 * Delete ust context safely. RCU read lock must be held before calling
261 * this function.
262 */
263 static
264 void delete_ust_app_ctx(int sock, struct ust_app_ctx *ua_ctx)
265 {
266 int ret;
267
268 assert(ua_ctx);
269
270 if (ua_ctx->obj) {
271 ret = ustctl_release_object(sock, ua_ctx->obj);
272 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
273 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
274 sock, ua_ctx->obj->handle, ret);
275 }
276 free(ua_ctx->obj);
277 }
278 free(ua_ctx);
279 }
280
281 /*
282 * Delete ust app event safely. RCU read lock must be held before calling
283 * this function.
284 */
285 static
286 void delete_ust_app_event(int sock, struct ust_app_event *ua_event)
287 {
288 int ret;
289
290 assert(ua_event);
291
292 free(ua_event->filter);
293 if (ua_event->exclusion != NULL)
294 free(ua_event->exclusion);
295 if (ua_event->obj != NULL) {
296 ret = ustctl_release_object(sock, ua_event->obj);
297 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
298 ERR("UST app sock %d release event obj failed with ret %d",
299 sock, ret);
300 }
301 free(ua_event->obj);
302 }
303 free(ua_event);
304 }
305
306 /*
307 * Release ust data object of the given stream.
308 *
309 * Return 0 on success or else a negative value.
310 */
311 static int release_ust_app_stream(int sock, struct ust_app_stream *stream)
312 {
313 int ret = 0;
314
315 assert(stream);
316
317 if (stream->obj) {
318 ret = ustctl_release_object(sock, stream->obj);
319 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
320 ERR("UST app sock %d release stream obj failed with ret %d",
321 sock, ret);
322 }
323 lttng_fd_put(LTTNG_FD_APPS, 2);
324 free(stream->obj);
325 }
326
327 return ret;
328 }
329
330 /*
331 * Delete ust app stream safely. RCU read lock must be held before calling
332 * this function.
333 */
334 static
335 void delete_ust_app_stream(int sock, struct ust_app_stream *stream)
336 {
337 assert(stream);
338
339 (void) release_ust_app_stream(sock, stream);
340 free(stream);
341 }
342
343 /*
344 * We need to execute ht_destroy outside of RCU read-side critical
345 * section and outside of call_rcu thread, so we postpone its execution
346 * using ht_cleanup_push. It is simpler than to change the semantic of
347 * the many callers of delete_ust_app_session().
348 */
349 static
350 void delete_ust_app_channel_rcu(struct rcu_head *head)
351 {
352 struct ust_app_channel *ua_chan =
353 caa_container_of(head, struct ust_app_channel, rcu_head);
354
355 ht_cleanup_push(ua_chan->ctx);
356 ht_cleanup_push(ua_chan->events);
357 free(ua_chan);
358 }
359
360 /*
361 * Delete ust app channel safely. RCU read lock must be held before calling
362 * this function.
363 */
364 static
365 void delete_ust_app_channel(int sock, struct ust_app_channel *ua_chan,
366 struct ust_app *app)
367 {
368 int ret;
369 struct lttng_ht_iter iter;
370 struct ust_app_event *ua_event;
371 struct ust_app_ctx *ua_ctx;
372 struct ust_app_stream *stream, *stmp;
373 struct ust_registry_session *registry;
374
375 assert(ua_chan);
376
377 DBG3("UST app deleting channel %s", ua_chan->name);
378
379 /* Wipe stream */
380 cds_list_for_each_entry_safe(stream, stmp, &ua_chan->streams.head, list) {
381 cds_list_del(&stream->list);
382 delete_ust_app_stream(sock, stream);
383 }
384
385 /* Wipe context */
386 cds_lfht_for_each_entry(ua_chan->ctx->ht, &iter.iter, ua_ctx, node.node) {
387 cds_list_del(&ua_ctx->list);
388 ret = lttng_ht_del(ua_chan->ctx, &iter);
389 assert(!ret);
390 delete_ust_app_ctx(sock, ua_ctx);
391 }
392
393 /* Wipe events */
394 cds_lfht_for_each_entry(ua_chan->events->ht, &iter.iter, ua_event,
395 node.node) {
396 ret = lttng_ht_del(ua_chan->events, &iter);
397 assert(!ret);
398 delete_ust_app_event(sock, ua_event);
399 }
400
401 if (ua_chan->session->buffer_type == LTTNG_BUFFER_PER_PID) {
402 /* Wipe and free registry from session registry. */
403 registry = get_session_registry(ua_chan->session);
404 if (registry) {
405 ust_registry_channel_del_free(registry, ua_chan->key);
406 }
407 }
408
409 if (ua_chan->obj != NULL) {
410 /* Remove channel from application UST object descriptor. */
411 iter.iter.node = &ua_chan->ust_objd_node.node;
412 ret = lttng_ht_del(app->ust_objd, &iter);
413 assert(!ret);
414 ret = ustctl_release_object(sock, ua_chan->obj);
415 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
416 ERR("UST app sock %d release channel obj failed with ret %d",
417 sock, ret);
418 }
419 lttng_fd_put(LTTNG_FD_APPS, 1);
420 free(ua_chan->obj);
421 }
422 call_rcu(&ua_chan->rcu_head, delete_ust_app_channel_rcu);
423 }
424
425 /*
426 * Push metadata to consumer socket.
427 *
428 * RCU read-side lock must be held to guarantee existance of socket.
429 * Must be called with the ust app session lock held.
430 * Must be called with the registry lock held.
431 *
432 * On success, return the len of metadata pushed or else a negative value.
433 */
434 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
435 struct consumer_socket *socket, int send_zero_data)
436 {
437 int ret;
438 char *metadata_str = NULL;
439 size_t len, offset;
440 ssize_t ret_val;
441
442 assert(registry);
443 assert(socket);
444
445 /*
446 * Means that no metadata was assigned to the session. This can
447 * happens if no start has been done previously.
448 */
449 if (!registry->metadata_key) {
450 return 0;
451 }
452
453 /*
454 * On a push metadata error either the consumer is dead or the
455 * metadata channel has been destroyed because its endpoint
456 * might have died (e.g: relayd). If so, the metadata closed
457 * flag is set to 1 so we deny pushing metadata again which is
458 * not valid anymore on the consumer side.
459 */
460 if (registry->metadata_closed) {
461 return -EPIPE;
462 }
463
464 offset = registry->metadata_len_sent;
465 len = registry->metadata_len - registry->metadata_len_sent;
466 if (len == 0) {
467 DBG3("No metadata to push for metadata key %" PRIu64,
468 registry->metadata_key);
469 ret_val = len;
470 if (send_zero_data) {
471 DBG("No metadata to push");
472 goto push_data;
473 }
474 goto end;
475 }
476
477 /* Allocate only what we have to send. */
478 metadata_str = zmalloc(len);
479 if (!metadata_str) {
480 PERROR("zmalloc ust app metadata string");
481 ret_val = -ENOMEM;
482 goto error;
483 }
484 /* Copy what we haven't send out. */
485 memcpy(metadata_str, registry->metadata + offset, len);
486 registry->metadata_len_sent += len;
487
488 push_data:
489 ret = consumer_push_metadata(socket, registry->metadata_key,
490 metadata_str, len, offset);
491 if (ret < 0) {
492 /*
493 * There is an acceptable race here between the registry
494 * metadata key assignment and the creation on the
495 * consumer. The session daemon can concurrently push
496 * metadata for this registry while being created on the
497 * consumer since the metadata key of the registry is
498 * assigned *before* it is setup to avoid the consumer
499 * to ask for metadata that could possibly be not found
500 * in the session daemon.
501 *
502 * The metadata will get pushed either by the session
503 * being stopped or the consumer requesting metadata if
504 * that race is triggered.
505 */
506 if (ret == -LTTCOMM_CONSUMERD_CHANNEL_FAIL) {
507 ret = 0;
508 }
509
510 /*
511 * Update back the actual metadata len sent since it
512 * failed here.
513 */
514 registry->metadata_len_sent -= len;
515 ret_val = ret;
516 goto error_push;
517 }
518
519 free(metadata_str);
520 return len;
521
522 end:
523 error:
524 if (ret_val) {
525 /*
526 * On error, flag the registry that the metadata is
527 * closed. We were unable to push anything and this
528 * means that either the consumer is not responding or
529 * the metadata cache has been destroyed on the
530 * consumer.
531 */
532 registry->metadata_closed = 1;
533 }
534 error_push:
535 free(metadata_str);
536 return ret_val;
537 }
538
539 /*
540 * For a given application and session, push metadata to consumer.
541 * Either sock or consumer is required : if sock is NULL, the default
542 * socket to send the metadata is retrieved from consumer, if sock
543 * is not NULL we use it to send the metadata.
544 * RCU read-side lock must be held while calling this function,
545 * therefore ensuring existance of registry. It also ensures existance
546 * of socket throughout this function.
547 *
548 * Return 0 on success else a negative error.
549 */
550 static int push_metadata(struct ust_registry_session *registry,
551 struct consumer_output *consumer)
552 {
553 int ret_val;
554 ssize_t ret;
555 struct consumer_socket *socket;
556
557 assert(registry);
558 assert(consumer);
559
560 pthread_mutex_lock(&registry->lock);
561 if (registry->metadata_closed) {
562 ret_val = -EPIPE;
563 goto error;
564 }
565
566 /* Get consumer socket to use to push the metadata.*/
567 socket = consumer_find_socket_by_bitness(registry->bits_per_long,
568 consumer);
569 if (!socket) {
570 ret_val = -1;
571 goto error;
572 }
573
574 ret = ust_app_push_metadata(registry, socket, 0);
575 if (ret < 0) {
576 ret_val = ret;
577 goto error;
578 }
579 pthread_mutex_unlock(&registry->lock);
580 return 0;
581
582 error:
583 end:
584 pthread_mutex_unlock(&registry->lock);
585 return ret_val;
586 }
587
588 /*
589 * Send to the consumer a close metadata command for the given session. Once
590 * done, the metadata channel is deleted and the session metadata pointer is
591 * nullified. The session lock MUST be held unless the application is
592 * in the destroy path.
593 *
594 * Return 0 on success else a negative value.
595 */
596 static int close_metadata(struct ust_registry_session *registry,
597 struct consumer_output *consumer)
598 {
599 int ret;
600 struct consumer_socket *socket;
601
602 assert(registry);
603 assert(consumer);
604
605 rcu_read_lock();
606
607 pthread_mutex_lock(&registry->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 pthread_mutex_unlock(&registry->lock);
636 rcu_read_unlock();
637 return ret;
638 }
639
640 /*
641 * We need to execute ht_destroy outside of RCU read-side critical
642 * section and outside of call_rcu thread, so we postpone its execution
643 * using ht_cleanup_push. It is simpler than to change the semantic of
644 * the many callers of delete_ust_app_session().
645 */
646 static
647 void delete_ust_app_session_rcu(struct rcu_head *head)
648 {
649 struct ust_app_session *ua_sess =
650 caa_container_of(head, struct ust_app_session, rcu_head);
651
652 ht_cleanup_push(ua_sess->channels);
653 free(ua_sess);
654 }
655
656 /*
657 * Delete ust app session safely. RCU read lock must be held before calling
658 * this function.
659 */
660 static
661 void delete_ust_app_session(int sock, struct ust_app_session *ua_sess,
662 struct ust_app *app)
663 {
664 int ret;
665 struct lttng_ht_iter iter;
666 struct ust_app_channel *ua_chan;
667 struct ust_registry_session *registry;
668
669 assert(ua_sess);
670
671 pthread_mutex_lock(&ua_sess->lock);
672
673 registry = get_session_registry(ua_sess);
674 if (registry) {
675 /* Push metadata for application before freeing the application. */
676 (void) push_metadata(registry, ua_sess->consumer);
677
678 /*
679 * Don't ask to close metadata for global per UID buffers. Close
680 * metadata only on destroy trace session in this case. Also, the
681 * previous push metadata could have flag the metadata registry to
682 * close so don't send a close command if closed.
683 */
684 if (ua_sess->buffer_type != LTTNG_BUFFER_PER_UID) {
685 /* 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 * Must be called while holding RCU read side lock.
1993 * Return an ust_app_ctx object or NULL on error.
1994 */
1995 static
1996 struct ust_app_ctx *find_ust_app_context(struct lttng_ht *ht,
1997 struct lttng_ust_context *uctx)
1998 {
1999 struct lttng_ht_iter iter;
2000 struct lttng_ht_node_ulong *node;
2001 struct ust_app_ctx *app_ctx = NULL;
2002
2003 assert(uctx);
2004 assert(ht);
2005
2006 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2007 cds_lfht_lookup(ht->ht, ht->hash_fct((void *) uctx->ctx, lttng_ht_seed),
2008 ht_match_ust_app_ctx, uctx, &iter.iter);
2009 node = lttng_ht_iter_get_node_ulong(&iter);
2010 if (!node) {
2011 goto end;
2012 }
2013
2014 app_ctx = caa_container_of(node, struct ust_app_ctx, node);
2015
2016 end:
2017 return app_ctx;
2018 }
2019
2020 /*
2021 * Create a context for the channel on the tracer.
2022 *
2023 * Called with UST app session lock held and a RCU read side lock.
2024 */
2025 static
2026 int create_ust_app_channel_context(struct ust_app_session *ua_sess,
2027 struct ust_app_channel *ua_chan, struct lttng_ust_context *uctx,
2028 struct ust_app *app)
2029 {
2030 int ret = 0;
2031 struct ust_app_ctx *ua_ctx;
2032
2033 DBG2("UST app adding context to channel %s", ua_chan->name);
2034
2035 ua_ctx = find_ust_app_context(ua_chan->ctx, uctx);
2036 if (ua_ctx) {
2037 ret = -EEXIST;
2038 goto error;
2039 }
2040
2041 ua_ctx = alloc_ust_app_ctx(uctx);
2042 if (ua_ctx == NULL) {
2043 /* malloc failed */
2044 ret = -1;
2045 goto error;
2046 }
2047
2048 lttng_ht_node_init_ulong(&ua_ctx->node, (unsigned long) ua_ctx->ctx.ctx);
2049 lttng_ht_add_ulong(ua_chan->ctx, &ua_ctx->node);
2050 cds_list_add_tail(&ua_ctx->list, &ua_chan->ctx_list);
2051
2052 ret = create_ust_channel_context(ua_chan, ua_ctx, app);
2053 if (ret < 0) {
2054 goto error;
2055 }
2056
2057 error:
2058 return ret;
2059 }
2060
2061 /*
2062 * Enable on the tracer side a ust app event for the session and channel.
2063 *
2064 * Called with UST app session lock held.
2065 */
2066 static
2067 int enable_ust_app_event(struct ust_app_session *ua_sess,
2068 struct ust_app_event *ua_event, struct ust_app *app)
2069 {
2070 int ret;
2071
2072 ret = enable_ust_event(app, ua_sess, ua_event);
2073 if (ret < 0) {
2074 goto error;
2075 }
2076
2077 ua_event->enabled = 1;
2078
2079 error:
2080 return ret;
2081 }
2082
2083 /*
2084 * Disable on the tracer side a ust app event for the session and channel.
2085 */
2086 static int disable_ust_app_event(struct ust_app_session *ua_sess,
2087 struct ust_app_event *ua_event, struct ust_app *app)
2088 {
2089 int ret;
2090
2091 ret = disable_ust_event(app, ua_sess, ua_event);
2092 if (ret < 0) {
2093 goto error;
2094 }
2095
2096 ua_event->enabled = 0;
2097
2098 error:
2099 return ret;
2100 }
2101
2102 /*
2103 * Lookup ust app channel for session and disable it on the tracer side.
2104 */
2105 static
2106 int disable_ust_app_channel(struct ust_app_session *ua_sess,
2107 struct ust_app_channel *ua_chan, struct ust_app *app)
2108 {
2109 int ret;
2110
2111 ret = disable_ust_channel(app, ua_sess, ua_chan);
2112 if (ret < 0) {
2113 goto error;
2114 }
2115
2116 ua_chan->enabled = 0;
2117
2118 error:
2119 return ret;
2120 }
2121
2122 /*
2123 * Lookup ust app channel for session and enable it on the tracer side. This
2124 * MUST be called with a RCU read side lock acquired.
2125 */
2126 static int enable_ust_app_channel(struct ust_app_session *ua_sess,
2127 struct ltt_ust_channel *uchan, struct ust_app *app)
2128 {
2129 int ret = 0;
2130 struct lttng_ht_iter iter;
2131 struct lttng_ht_node_str *ua_chan_node;
2132 struct ust_app_channel *ua_chan;
2133
2134 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &iter);
2135 ua_chan_node = lttng_ht_iter_get_node_str(&iter);
2136 if (ua_chan_node == NULL) {
2137 DBG2("Unable to find channel %s in ust session id %" PRIu64,
2138 uchan->name, ua_sess->tracing_id);
2139 goto error;
2140 }
2141
2142 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
2143
2144 ret = enable_ust_channel(app, ua_sess, ua_chan);
2145 if (ret < 0) {
2146 goto error;
2147 }
2148
2149 error:
2150 return ret;
2151 }
2152
2153 /*
2154 * Ask the consumer to create a channel and get it if successful.
2155 *
2156 * Return 0 on success or else a negative value.
2157 */
2158 static int do_consumer_create_channel(struct ltt_ust_session *usess,
2159 struct ust_app_session *ua_sess, struct ust_app_channel *ua_chan,
2160 int bitness, struct ust_registry_session *registry)
2161 {
2162 int ret;
2163 unsigned int nb_fd = 0;
2164 struct consumer_socket *socket;
2165
2166 assert(usess);
2167 assert(ua_sess);
2168 assert(ua_chan);
2169 assert(registry);
2170
2171 rcu_read_lock();
2172 health_code_update();
2173
2174 /* Get the right consumer socket for the application. */
2175 socket = consumer_find_socket_by_bitness(bitness, usess->consumer);
2176 if (!socket) {
2177 ret = -EINVAL;
2178 goto error;
2179 }
2180
2181 health_code_update();
2182
2183 /* Need one fd for the channel. */
2184 ret = lttng_fd_get(LTTNG_FD_APPS, 1);
2185 if (ret < 0) {
2186 ERR("Exhausted number of available FD upon create channel");
2187 goto error;
2188 }
2189
2190 /*
2191 * Ask consumer to create channel. The consumer will return the number of
2192 * stream we have to expect.
2193 */
2194 ret = ust_consumer_ask_channel(ua_sess, ua_chan, usess->consumer, socket,
2195 registry);
2196 if (ret < 0) {
2197 goto error_ask;
2198 }
2199
2200 /*
2201 * Compute the number of fd needed before receiving them. It must be 2 per
2202 * stream (2 being the default value here).
2203 */
2204 nb_fd = DEFAULT_UST_STREAM_FD_NUM * ua_chan->expected_stream_count;
2205
2206 /* Reserve the amount of file descriptor we need. */
2207 ret = lttng_fd_get(LTTNG_FD_APPS, nb_fd);
2208 if (ret < 0) {
2209 ERR("Exhausted number of available FD upon create channel");
2210 goto error_fd_get_stream;
2211 }
2212
2213 health_code_update();
2214
2215 /*
2216 * Now get the channel from the consumer. This call wil populate the stream
2217 * list of that channel and set the ust objects.
2218 */
2219 if (usess->consumer->enabled) {
2220 ret = ust_consumer_get_channel(socket, ua_chan);
2221 if (ret < 0) {
2222 goto error_destroy;
2223 }
2224 }
2225
2226 rcu_read_unlock();
2227 return 0;
2228
2229 error_destroy:
2230 lttng_fd_put(LTTNG_FD_APPS, nb_fd);
2231 error_fd_get_stream:
2232 /*
2233 * Initiate a destroy channel on the consumer since we had an error
2234 * handling it on our side. The return value is of no importance since we
2235 * already have a ret value set by the previous error that we need to
2236 * return.
2237 */
2238 (void) ust_consumer_destroy_channel(socket, ua_chan);
2239 error_ask:
2240 lttng_fd_put(LTTNG_FD_APPS, 1);
2241 error:
2242 health_code_update();
2243 rcu_read_unlock();
2244 return ret;
2245 }
2246
2247 /*
2248 * Duplicate the ust data object of the ust app stream and save it in the
2249 * buffer registry stream.
2250 *
2251 * Return 0 on success or else a negative value.
2252 */
2253 static int duplicate_stream_object(struct buffer_reg_stream *reg_stream,
2254 struct ust_app_stream *stream)
2255 {
2256 int ret;
2257
2258 assert(reg_stream);
2259 assert(stream);
2260
2261 /* Reserve the amount of file descriptor we need. */
2262 ret = lttng_fd_get(LTTNG_FD_APPS, 2);
2263 if (ret < 0) {
2264 ERR("Exhausted number of available FD upon duplicate stream");
2265 goto error;
2266 }
2267
2268 /* Duplicate object for stream once the original is in the registry. */
2269 ret = ustctl_duplicate_ust_object_data(&stream->obj,
2270 reg_stream->obj.ust);
2271 if (ret < 0) {
2272 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2273 reg_stream->obj.ust, stream->obj, ret);
2274 lttng_fd_put(LTTNG_FD_APPS, 2);
2275 goto error;
2276 }
2277 stream->handle = stream->obj->handle;
2278
2279 error:
2280 return ret;
2281 }
2282
2283 /*
2284 * Duplicate the ust data object of the ust app. channel and save it in the
2285 * buffer registry channel.
2286 *
2287 * Return 0 on success or else a negative value.
2288 */
2289 static int duplicate_channel_object(struct buffer_reg_channel *reg_chan,
2290 struct ust_app_channel *ua_chan)
2291 {
2292 int ret;
2293
2294 assert(reg_chan);
2295 assert(ua_chan);
2296
2297 /* Need two fds for the channel. */
2298 ret = lttng_fd_get(LTTNG_FD_APPS, 1);
2299 if (ret < 0) {
2300 ERR("Exhausted number of available FD upon duplicate channel");
2301 goto error_fd_get;
2302 }
2303
2304 /* Duplicate object for stream once the original is in the registry. */
2305 ret = ustctl_duplicate_ust_object_data(&ua_chan->obj, reg_chan->obj.ust);
2306 if (ret < 0) {
2307 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2308 reg_chan->obj.ust, ua_chan->obj, ret);
2309 goto error;
2310 }
2311 ua_chan->handle = ua_chan->obj->handle;
2312
2313 return 0;
2314
2315 error:
2316 lttng_fd_put(LTTNG_FD_APPS, 1);
2317 error_fd_get:
2318 return ret;
2319 }
2320
2321 /*
2322 * For a given channel buffer registry, setup all streams of the given ust
2323 * application channel.
2324 *
2325 * Return 0 on success or else a negative value.
2326 */
2327 static int setup_buffer_reg_streams(struct buffer_reg_channel *reg_chan,
2328 struct ust_app_channel *ua_chan)
2329 {
2330 int ret = 0;
2331 struct ust_app_stream *stream, *stmp;
2332
2333 assert(reg_chan);
2334 assert(ua_chan);
2335
2336 DBG2("UST app setup buffer registry stream");
2337
2338 /* Send all streams to application. */
2339 cds_list_for_each_entry_safe(stream, stmp, &ua_chan->streams.head, list) {
2340 struct buffer_reg_stream *reg_stream;
2341
2342 ret = buffer_reg_stream_create(&reg_stream);
2343 if (ret < 0) {
2344 goto error;
2345 }
2346
2347 /*
2348 * Keep original pointer and nullify it in the stream so the delete
2349 * stream call does not release the object.
2350 */
2351 reg_stream->obj.ust = stream->obj;
2352 stream->obj = NULL;
2353 buffer_reg_stream_add(reg_stream, reg_chan);
2354
2355 /* We don't need the streams anymore. */
2356 cds_list_del(&stream->list);
2357 delete_ust_app_stream(-1, stream);
2358 }
2359
2360 error:
2361 return ret;
2362 }
2363
2364 /*
2365 * Create a buffer registry channel for the given session registry and
2366 * application channel object. If regp pointer is valid, it's set with the
2367 * created object. Important, the created object is NOT added to the session
2368 * registry hash table.
2369 *
2370 * Return 0 on success else a negative value.
2371 */
2372 static int create_buffer_reg_channel(struct buffer_reg_session *reg_sess,
2373 struct ust_app_channel *ua_chan, struct buffer_reg_channel **regp)
2374 {
2375 int ret;
2376 struct buffer_reg_channel *reg_chan = NULL;
2377
2378 assert(reg_sess);
2379 assert(ua_chan);
2380
2381 DBG2("UST app creating buffer registry channel for %s", ua_chan->name);
2382
2383 /* Create buffer registry channel. */
2384 ret = buffer_reg_channel_create(ua_chan->tracing_channel_id, &reg_chan);
2385 if (ret < 0) {
2386 goto error_create;
2387 }
2388 assert(reg_chan);
2389 reg_chan->consumer_key = ua_chan->key;
2390 reg_chan->subbuf_size = ua_chan->attr.subbuf_size;
2391 reg_chan->num_subbuf = ua_chan->attr.num_subbuf;
2392
2393 /* Create and add a channel registry to session. */
2394 ret = ust_registry_channel_add(reg_sess->reg.ust,
2395 ua_chan->tracing_channel_id);
2396 if (ret < 0) {
2397 goto error;
2398 }
2399 buffer_reg_channel_add(reg_sess, reg_chan);
2400
2401 if (regp) {
2402 *regp = reg_chan;
2403 }
2404
2405 return 0;
2406
2407 error:
2408 /* Safe because the registry channel object was not added to any HT. */
2409 buffer_reg_channel_destroy(reg_chan, LTTNG_DOMAIN_UST);
2410 error_create:
2411 return ret;
2412 }
2413
2414 /*
2415 * Setup buffer registry channel for the given session registry and application
2416 * channel object. If regp pointer is valid, it's set with the created object.
2417 *
2418 * Return 0 on success else a negative value.
2419 */
2420 static int setup_buffer_reg_channel(struct buffer_reg_session *reg_sess,
2421 struct ust_app_channel *ua_chan, struct buffer_reg_channel *reg_chan)
2422 {
2423 int ret;
2424
2425 assert(reg_sess);
2426 assert(reg_chan);
2427 assert(ua_chan);
2428 assert(ua_chan->obj);
2429
2430 DBG2("UST app setup buffer registry channel for %s", ua_chan->name);
2431
2432 /* Setup all streams for the registry. */
2433 ret = setup_buffer_reg_streams(reg_chan, ua_chan);
2434 if (ret < 0) {
2435 goto error;
2436 }
2437
2438 reg_chan->obj.ust = ua_chan->obj;
2439 ua_chan->obj = NULL;
2440
2441 return 0;
2442
2443 error:
2444 buffer_reg_channel_remove(reg_sess, reg_chan);
2445 buffer_reg_channel_destroy(reg_chan, LTTNG_DOMAIN_UST);
2446 return ret;
2447 }
2448
2449 /*
2450 * Send buffer registry channel to the application.
2451 *
2452 * Return 0 on success else a negative value.
2453 */
2454 static int send_channel_uid_to_ust(struct buffer_reg_channel *reg_chan,
2455 struct ust_app *app, struct ust_app_session *ua_sess,
2456 struct ust_app_channel *ua_chan)
2457 {
2458 int ret;
2459 struct buffer_reg_stream *reg_stream;
2460
2461 assert(reg_chan);
2462 assert(app);
2463 assert(ua_sess);
2464 assert(ua_chan);
2465
2466 DBG("UST app sending buffer registry channel to ust sock %d", app->sock);
2467
2468 ret = duplicate_channel_object(reg_chan, ua_chan);
2469 if (ret < 0) {
2470 goto error;
2471 }
2472
2473 /* Send channel to the application. */
2474 ret = ust_consumer_send_channel_to_ust(app, ua_sess, ua_chan);
2475 if (ret < 0) {
2476 goto error;
2477 }
2478
2479 health_code_update();
2480
2481 /* Send all streams to application. */
2482 pthread_mutex_lock(&reg_chan->stream_list_lock);
2483 cds_list_for_each_entry(reg_stream, &reg_chan->streams, lnode) {
2484 struct ust_app_stream stream;
2485
2486 ret = duplicate_stream_object(reg_stream, &stream);
2487 if (ret < 0) {
2488 goto error_stream_unlock;
2489 }
2490
2491 ret = ust_consumer_send_stream_to_ust(app, ua_chan, &stream);
2492 if (ret < 0) {
2493 (void) release_ust_app_stream(-1, &stream);
2494 goto error_stream_unlock;
2495 }
2496
2497 /*
2498 * The return value is not important here. This function will output an
2499 * error if needed.
2500 */
2501 (void) release_ust_app_stream(-1, &stream);
2502 }
2503 ua_chan->is_sent = 1;
2504
2505 error_stream_unlock:
2506 pthread_mutex_unlock(&reg_chan->stream_list_lock);
2507 error:
2508 return ret;
2509 }
2510
2511 /*
2512 * Create and send to the application the created buffers with per UID buffers.
2513 *
2514 * Return 0 on success else a negative value.
2515 */
2516 static int create_channel_per_uid(struct ust_app *app,
2517 struct ltt_ust_session *usess, struct ust_app_session *ua_sess,
2518 struct ust_app_channel *ua_chan)
2519 {
2520 int ret;
2521 struct buffer_reg_uid *reg_uid;
2522 struct buffer_reg_channel *reg_chan;
2523
2524 assert(app);
2525 assert(usess);
2526 assert(ua_sess);
2527 assert(ua_chan);
2528
2529 DBG("UST app creating channel %s with per UID buffers", ua_chan->name);
2530
2531 reg_uid = buffer_reg_uid_find(usess->id, app->bits_per_long, app->uid);
2532 /*
2533 * The session creation handles the creation of this global registry
2534 * object. If none can be find, there is a code flow problem or a
2535 * teardown race.
2536 */
2537 assert(reg_uid);
2538
2539 reg_chan = buffer_reg_channel_find(ua_chan->tracing_channel_id,
2540 reg_uid);
2541 if (!reg_chan) {
2542 /* Create the buffer registry channel object. */
2543 ret = create_buffer_reg_channel(reg_uid->registry, ua_chan, &reg_chan);
2544 if (ret < 0) {
2545 ERR("Error creating the UST channel \"%s\" registry instance",
2546 ua_chan->name);
2547 goto error;
2548 }
2549 assert(reg_chan);
2550
2551 /*
2552 * Create the buffers on the consumer side. This call populates the
2553 * ust app channel object with all streams and data object.
2554 */
2555 ret = do_consumer_create_channel(usess, ua_sess, ua_chan,
2556 app->bits_per_long, reg_uid->registry->reg.ust);
2557 if (ret < 0) {
2558 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2559 ua_chan->name);
2560
2561 /*
2562 * Let's remove the previously created buffer registry channel so
2563 * it's not visible anymore in the session registry.
2564 */
2565 ust_registry_channel_del_free(reg_uid->registry->reg.ust,
2566 ua_chan->tracing_channel_id);
2567 buffer_reg_channel_remove(reg_uid->registry, reg_chan);
2568 buffer_reg_channel_destroy(reg_chan, LTTNG_DOMAIN_UST);
2569 goto error;
2570 }
2571
2572 /*
2573 * Setup the streams and add it to the session registry.
2574 */
2575 ret = setup_buffer_reg_channel(reg_uid->registry, ua_chan, reg_chan);
2576 if (ret < 0) {
2577 ERR("Error setting up UST channel \"%s\"",
2578 ua_chan->name);
2579 goto error;
2580 }
2581
2582 }
2583
2584 /* Send buffers to the application. */
2585 ret = send_channel_uid_to_ust(reg_chan, app, ua_sess, ua_chan);
2586 if (ret < 0) {
2587 /*
2588 * Don't report error to the console, since it may be
2589 * caused by application concurrently exiting.
2590 */
2591 goto error;
2592 }
2593
2594 error:
2595 return ret;
2596 }
2597
2598 /*
2599 * Create and send to the application the created buffers with per PID buffers.
2600 *
2601 * Return 0 on success else a negative value.
2602 */
2603 static int create_channel_per_pid(struct ust_app *app,
2604 struct ltt_ust_session *usess, struct ust_app_session *ua_sess,
2605 struct ust_app_channel *ua_chan)
2606 {
2607 int ret;
2608 struct ust_registry_session *registry;
2609
2610 assert(app);
2611 assert(usess);
2612 assert(ua_sess);
2613 assert(ua_chan);
2614
2615 DBG("UST app creating channel %s with per PID buffers", ua_chan->name);
2616
2617 rcu_read_lock();
2618
2619 registry = get_session_registry(ua_sess);
2620 assert(registry);
2621
2622 /* Create and add a new channel registry to session. */
2623 ret = ust_registry_channel_add(registry, ua_chan->key);
2624 if (ret < 0) {
2625 ERR("Error creating the UST channel \"%s\" registry instance",
2626 ua_chan->name);
2627 goto error;
2628 }
2629
2630 /* Create and get channel on the consumer side. */
2631 ret = do_consumer_create_channel(usess, ua_sess, ua_chan,
2632 app->bits_per_long, registry);
2633 if (ret < 0) {
2634 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2635 ua_chan->name);
2636 goto error;
2637 }
2638
2639 ret = send_channel_pid_to_ust(app, ua_sess, ua_chan);
2640 if (ret < 0) {
2641 /*
2642 * Don't report error to the console, since it may be
2643 * caused by application concurrently exiting.
2644 */
2645 goto error;
2646 }
2647
2648 error:
2649 rcu_read_unlock();
2650 return ret;
2651 }
2652
2653 /*
2654 * From an already allocated ust app channel, create the channel buffers if
2655 * need and send it to the application. This MUST be called with a RCU read
2656 * side lock acquired.
2657 *
2658 * Return 0 on success or else a negative value.
2659 */
2660 static int do_create_channel(struct ust_app *app,
2661 struct ltt_ust_session *usess, struct ust_app_session *ua_sess,
2662 struct ust_app_channel *ua_chan)
2663 {
2664 int ret;
2665
2666 assert(app);
2667 assert(usess);
2668 assert(ua_sess);
2669 assert(ua_chan);
2670
2671 /* Handle buffer type before sending the channel to the application. */
2672 switch (usess->buffer_type) {
2673 case LTTNG_BUFFER_PER_UID:
2674 {
2675 ret = create_channel_per_uid(app, usess, ua_sess, ua_chan);
2676 if (ret < 0) {
2677 goto error;
2678 }
2679 break;
2680 }
2681 case LTTNG_BUFFER_PER_PID:
2682 {
2683 ret = create_channel_per_pid(app, usess, ua_sess, ua_chan);
2684 if (ret < 0) {
2685 goto error;
2686 }
2687 break;
2688 }
2689 default:
2690 assert(0);
2691 ret = -EINVAL;
2692 goto error;
2693 }
2694
2695 /* Initialize ust objd object using the received handle and add it. */
2696 lttng_ht_node_init_ulong(&ua_chan->ust_objd_node, ua_chan->handle);
2697 lttng_ht_add_unique_ulong(app->ust_objd, &ua_chan->ust_objd_node);
2698
2699 /* If channel is not enabled, disable it on the tracer */
2700 if (!ua_chan->enabled) {
2701 ret = disable_ust_channel(app, ua_sess, ua_chan);
2702 if (ret < 0) {
2703 goto error;
2704 }
2705 }
2706
2707 error:
2708 return ret;
2709 }
2710
2711 /*
2712 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2713 * newly created channel if not NULL.
2714 *
2715 * Called with UST app session lock and RCU read-side lock held.
2716 *
2717 * Return 0 on success or else a negative value.
2718 */
2719 static int create_ust_app_channel(struct ust_app_session *ua_sess,
2720 struct ltt_ust_channel *uchan, struct ust_app *app,
2721 enum lttng_ust_chan_type type, struct ltt_ust_session *usess,
2722 struct ust_app_channel **ua_chanp)
2723 {
2724 int ret = 0;
2725 struct lttng_ht_iter iter;
2726 struct lttng_ht_node_str *ua_chan_node;
2727 struct ust_app_channel *ua_chan;
2728
2729 /* Lookup channel in the ust app session */
2730 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &iter);
2731 ua_chan_node = lttng_ht_iter_get_node_str(&iter);
2732 if (ua_chan_node != NULL) {
2733 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
2734 goto end;
2735 }
2736
2737 ua_chan = alloc_ust_app_channel(uchan->name, ua_sess, &uchan->attr);
2738 if (ua_chan == NULL) {
2739 /* Only malloc can fail here */
2740 ret = -ENOMEM;
2741 goto error_alloc;
2742 }
2743 shadow_copy_channel(ua_chan, uchan);
2744
2745 /* Set channel type. */
2746 ua_chan->attr.type = type;
2747
2748 ret = do_create_channel(app, usess, ua_sess, ua_chan);
2749 if (ret < 0) {
2750 goto error;
2751 }
2752
2753 DBG2("UST app create channel %s for PID %d completed", ua_chan->name,
2754 app->pid);
2755
2756 /* Only add the channel if successful on the tracer side. */
2757 lttng_ht_add_unique_str(ua_sess->channels, &ua_chan->node);
2758
2759 end:
2760 if (ua_chanp) {
2761 *ua_chanp = ua_chan;
2762 }
2763
2764 /* Everything went well. */
2765 return 0;
2766
2767 error:
2768 delete_ust_app_channel(ua_chan->is_sent ? app->sock : -1, ua_chan, app);
2769 error_alloc:
2770 return ret;
2771 }
2772
2773 /*
2774 * Create UST app event and create it on the tracer side.
2775 *
2776 * Called with ust app session mutex held.
2777 */
2778 static
2779 int create_ust_app_event(struct ust_app_session *ua_sess,
2780 struct ust_app_channel *ua_chan, struct ltt_ust_event *uevent,
2781 struct ust_app *app)
2782 {
2783 int ret = 0;
2784 struct ust_app_event *ua_event;
2785
2786 /* Get event node */
2787 ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
2788 uevent->filter, uevent->attr.loglevel, uevent->exclusion);
2789 if (ua_event != NULL) {
2790 ret = -EEXIST;
2791 goto end;
2792 }
2793
2794 /* Does not exist so create one */
2795 ua_event = alloc_ust_app_event(uevent->attr.name, &uevent->attr);
2796 if (ua_event == NULL) {
2797 /* Only malloc can failed so something is really wrong */
2798 ret = -ENOMEM;
2799 goto end;
2800 }
2801 shadow_copy_event(ua_event, uevent);
2802
2803 /* Create it on the tracer side */
2804 ret = create_ust_event(app, ua_sess, ua_chan, ua_event);
2805 if (ret < 0) {
2806 /* Not found previously means that it does not exist on the tracer */
2807 assert(ret != -LTTNG_UST_ERR_EXIST);
2808 goto error;
2809 }
2810
2811 add_unique_ust_app_event(ua_chan, ua_event);
2812
2813 DBG2("UST app create event %s for PID %d completed", ua_event->name,
2814 app->pid);
2815
2816 end:
2817 return ret;
2818
2819 error:
2820 /* Valid. Calling here is already in a read side lock */
2821 delete_ust_app_event(-1, ua_event);
2822 return ret;
2823 }
2824
2825 /*
2826 * Create UST metadata and open it on the tracer side.
2827 *
2828 * Called with UST app session lock held and RCU read side lock.
2829 */
2830 static int create_ust_app_metadata(struct ust_app_session *ua_sess,
2831 struct ust_app *app, struct consumer_output *consumer)
2832 {
2833 int ret = 0;
2834 struct ust_app_channel *metadata;
2835 struct consumer_socket *socket;
2836 struct ust_registry_session *registry;
2837
2838 assert(ua_sess);
2839 assert(app);
2840 assert(consumer);
2841
2842 registry = get_session_registry(ua_sess);
2843 assert(registry);
2844
2845 pthread_mutex_lock(&registry->lock);
2846
2847 /* Metadata already exists for this registry or it was closed previously */
2848 if (registry->metadata_key || registry->metadata_closed) {
2849 ret = 0;
2850 goto error;
2851 }
2852
2853 /* Allocate UST metadata */
2854 metadata = alloc_ust_app_channel(DEFAULT_METADATA_NAME, ua_sess, NULL);
2855 if (!metadata) {
2856 /* malloc() failed */
2857 ret = -ENOMEM;
2858 goto error;
2859 }
2860
2861 memcpy(&metadata->attr, &ua_sess->metadata_attr, sizeof(metadata->attr));
2862
2863 /* Need one fd for the channel. */
2864 ret = lttng_fd_get(LTTNG_FD_APPS, 1);
2865 if (ret < 0) {
2866 ERR("Exhausted number of available FD upon create metadata");
2867 goto error;
2868 }
2869
2870 /* Get the right consumer socket for the application. */
2871 socket = consumer_find_socket_by_bitness(app->bits_per_long, consumer);
2872 if (!socket) {
2873 ret = -EINVAL;
2874 goto error_consumer;
2875 }
2876
2877 /*
2878 * Keep metadata key so we can identify it on the consumer side. Assign it
2879 * to the registry *before* we ask the consumer so we avoid the race of the
2880 * consumer requesting the metadata and the ask_channel call on our side
2881 * did not returned yet.
2882 */
2883 registry->metadata_key = metadata->key;
2884
2885 /*
2886 * Ask the metadata channel creation to the consumer. The metadata object
2887 * will be created by the consumer and kept their. However, the stream is
2888 * never added or monitored until we do a first push metadata to the
2889 * consumer.
2890 */
2891 ret = ust_consumer_ask_channel(ua_sess, metadata, consumer, socket,
2892 registry);
2893 if (ret < 0) {
2894 /* Nullify the metadata key so we don't try to close it later on. */
2895 registry->metadata_key = 0;
2896 goto error_consumer;
2897 }
2898
2899 /*
2900 * The setup command will make the metadata stream be sent to the relayd,
2901 * if applicable, and the thread managing the metadatas. This is important
2902 * because after this point, if an error occurs, the only way the stream
2903 * can be deleted is to be monitored in the consumer.
2904 */
2905 ret = consumer_setup_metadata(socket, metadata->key);
2906 if (ret < 0) {
2907 /* Nullify the metadata key so we don't try to close it later on. */
2908 registry->metadata_key = 0;
2909 goto error_consumer;
2910 }
2911
2912 DBG2("UST metadata with key %" PRIu64 " created for app pid %d",
2913 metadata->key, app->pid);
2914
2915 error_consumer:
2916 lttng_fd_put(LTTNG_FD_APPS, 1);
2917 delete_ust_app_channel(-1, metadata, app);
2918 error:
2919 pthread_mutex_unlock(&registry->lock);
2920 return ret;
2921 }
2922
2923 /*
2924 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2925 * acquired before calling this function.
2926 */
2927 struct ust_app *ust_app_find_by_pid(pid_t pid)
2928 {
2929 struct ust_app *app = NULL;
2930 struct lttng_ht_node_ulong *node;
2931 struct lttng_ht_iter iter;
2932
2933 lttng_ht_lookup(ust_app_ht, (void *)((unsigned long) pid), &iter);
2934 node = lttng_ht_iter_get_node_ulong(&iter);
2935 if (node == NULL) {
2936 DBG2("UST app no found with pid %d", pid);
2937 goto error;
2938 }
2939
2940 DBG2("Found UST app by pid %d", pid);
2941
2942 app = caa_container_of(node, struct ust_app, pid_n);
2943
2944 error:
2945 return app;
2946 }
2947
2948 /*
2949 * Allocate and init an UST app object using the registration information and
2950 * the command socket. This is called when the command socket connects to the
2951 * session daemon.
2952 *
2953 * The object is returned on success or else NULL.
2954 */
2955 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
2956 {
2957 struct ust_app *lta = NULL;
2958
2959 assert(msg);
2960 assert(sock >= 0);
2961
2962 DBG3("UST app creating application for socket %d", sock);
2963
2964 if ((msg->bits_per_long == 64 &&
2965 (uatomic_read(&ust_consumerd64_fd) == -EINVAL))
2966 || (msg->bits_per_long == 32 &&
2967 (uatomic_read(&ust_consumerd32_fd) == -EINVAL))) {
2968 ERR("Registration failed: application \"%s\" (pid: %d) has "
2969 "%d-bit long, but no consumerd for this size is available.\n",
2970 msg->name, msg->pid, msg->bits_per_long);
2971 goto error;
2972 }
2973
2974 lta = zmalloc(sizeof(struct ust_app));
2975 if (lta == NULL) {
2976 PERROR("malloc");
2977 goto error;
2978 }
2979
2980 lta->ppid = msg->ppid;
2981 lta->uid = msg->uid;
2982 lta->gid = msg->gid;
2983
2984 lta->bits_per_long = msg->bits_per_long;
2985 lta->uint8_t_alignment = msg->uint8_t_alignment;
2986 lta->uint16_t_alignment = msg->uint16_t_alignment;
2987 lta->uint32_t_alignment = msg->uint32_t_alignment;
2988 lta->uint64_t_alignment = msg->uint64_t_alignment;
2989 lta->long_alignment = msg->long_alignment;
2990 lta->byte_order = msg->byte_order;
2991
2992 lta->v_major = msg->major;
2993 lta->v_minor = msg->minor;
2994 lta->sessions = lttng_ht_new(0, LTTNG_HT_TYPE_U64);
2995 lta->ust_objd = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
2996 lta->notify_sock = -1;
2997
2998 /* Copy name and make sure it's NULL terminated. */
2999 strncpy(lta->name, msg->name, sizeof(lta->name));
3000 lta->name[UST_APP_PROCNAME_LEN] = '\0';
3001
3002 /*
3003 * Before this can be called, when receiving the registration information,
3004 * the application compatibility is checked. So, at this point, the
3005 * application can work with this session daemon.
3006 */
3007 lta->compatible = 1;
3008
3009 lta->pid = msg->pid;
3010 lttng_ht_node_init_ulong(&lta->pid_n, (unsigned long) lta->pid);
3011 lta->sock = sock;
3012 lttng_ht_node_init_ulong(&lta->sock_n, (unsigned long) lta->sock);
3013
3014 CDS_INIT_LIST_HEAD(&lta->teardown_head);
3015
3016 error:
3017 return lta;
3018 }
3019
3020 /*
3021 * For a given application object, add it to every hash table.
3022 */
3023 void ust_app_add(struct ust_app *app)
3024 {
3025 assert(app);
3026 assert(app->notify_sock >= 0);
3027
3028 rcu_read_lock();
3029
3030 /*
3031 * On a re-registration, we want to kick out the previous registration of
3032 * that pid
3033 */
3034 lttng_ht_add_replace_ulong(ust_app_ht, &app->pid_n);
3035
3036 /*
3037 * The socket _should_ be unique until _we_ call close. So, a add_unique
3038 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3039 * already in the table.
3040 */
3041 lttng_ht_add_unique_ulong(ust_app_ht_by_sock, &app->sock_n);
3042
3043 /* Add application to the notify socket hash table. */
3044 lttng_ht_node_init_ulong(&app->notify_sock_n, app->notify_sock);
3045 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock, &app->notify_sock_n);
3046
3047 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3048 "notify_sock:%d (version %d.%d)", app->pid, app->ppid, app->uid,
3049 app->gid, app->sock, app->name, app->notify_sock, app->v_major,
3050 app->v_minor);
3051
3052 rcu_read_unlock();
3053 }
3054
3055 /*
3056 * Set the application version into the object.
3057 *
3058 * Return 0 on success else a negative value either an errno code or a
3059 * LTTng-UST error code.
3060 */
3061 int ust_app_version(struct ust_app *app)
3062 {
3063 int ret;
3064
3065 assert(app);
3066
3067 ret = ustctl_tracer_version(app->sock, &app->version);
3068 if (ret < 0) {
3069 if (ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
3070 ERR("UST app %d version failed with ret %d", app->sock, ret);
3071 } else {
3072 DBG3("UST app %d version failed. Application is dead", app->sock);
3073 }
3074 }
3075
3076 return ret;
3077 }
3078
3079 /*
3080 * Unregister app by removing it from the global traceable app list and freeing
3081 * the data struct.
3082 *
3083 * The socket is already closed at this point so no close to sock.
3084 */
3085 void ust_app_unregister(int sock)
3086 {
3087 struct ust_app *lta;
3088 struct lttng_ht_node_ulong *node;
3089 struct lttng_ht_iter ust_app_sock_iter;
3090 struct lttng_ht_iter iter;
3091 struct ust_app_session *ua_sess;
3092 int ret;
3093
3094 rcu_read_lock();
3095
3096 /* Get the node reference for a call_rcu */
3097 lttng_ht_lookup(ust_app_ht_by_sock, (void *)((unsigned long) sock), &ust_app_sock_iter);
3098 node = lttng_ht_iter_get_node_ulong(&ust_app_sock_iter);
3099 assert(node);
3100
3101 lta = caa_container_of(node, struct ust_app, sock_n);
3102 DBG("PID %d unregistering with sock %d", lta->pid, sock);
3103
3104 /*
3105 * For per-PID buffers, perform "push metadata" and flush all
3106 * application streams before removing app from hash tables,
3107 * ensuring proper behavior of data_pending check.
3108 * Remove sessions so they are not visible during deletion.
3109 */
3110 cds_lfht_for_each_entry(lta->sessions->ht, &iter.iter, ua_sess,
3111 node.node) {
3112 struct ust_registry_session *registry;
3113
3114 ret = lttng_ht_del(lta->sessions, &iter);
3115 if (ret) {
3116 /* The session was already removed so scheduled for teardown. */
3117 continue;
3118 }
3119
3120 if (ua_sess->buffer_type == LTTNG_BUFFER_PER_PID) {
3121 (void) ust_app_flush_app_session(lta, ua_sess);
3122 }
3123
3124 /*
3125 * Add session to list for teardown. This is safe since at this point we
3126 * are the only one using this list.
3127 */
3128 pthread_mutex_lock(&ua_sess->lock);
3129
3130 /*
3131 * Normally, this is done in the delete session process which is
3132 * executed in the call rcu below. However, upon registration we can't
3133 * afford to wait for the grace period before pushing data or else the
3134 * data pending feature can race between the unregistration and stop
3135 * command where the data pending command is sent *before* the grace
3136 * period ended.
3137 *
3138 * The close metadata below nullifies the metadata pointer in the
3139 * session so the delete session will NOT push/close a second time.
3140 */
3141 registry = get_session_registry(ua_sess);
3142 if (registry) {
3143 /* Push metadata for application before freeing the application. */
3144 (void) push_metadata(registry, ua_sess->consumer);
3145
3146 /*
3147 * Don't ask to close metadata for global per UID buffers. Close
3148 * metadata only on destroy trace session in this case. Also, the
3149 * previous push metadata could have flag the metadata registry to
3150 * close so don't send a close command if closed.
3151 */
3152 if (ua_sess->buffer_type != LTTNG_BUFFER_PER_UID) {
3153 /* And ask to close it for this session registry. */
3154 (void) close_metadata(registry, ua_sess->consumer);
3155 }
3156 }
3157 cds_list_add(&ua_sess->teardown_node, &lta->teardown_head);
3158
3159 pthread_mutex_unlock(&ua_sess->lock);
3160 }
3161
3162 /* Remove application from PID hash table */
3163 ret = lttng_ht_del(ust_app_ht_by_sock, &ust_app_sock_iter);
3164 assert(!ret);
3165
3166 /*
3167 * Remove application from notify hash table. The thread handling the
3168 * notify socket could have deleted the node so ignore on error because
3169 * either way it's valid. The close of that socket is handled by the other
3170 * thread.
3171 */
3172 iter.iter.node = &lta->notify_sock_n.node;
3173 (void) lttng_ht_del(ust_app_ht_by_notify_sock, &iter);
3174
3175 /*
3176 * Ignore return value since the node might have been removed before by an
3177 * add replace during app registration because the PID can be reassigned by
3178 * the OS.
3179 */
3180 iter.iter.node = &lta->pid_n.node;
3181 ret = lttng_ht_del(ust_app_ht, &iter);
3182 if (ret) {
3183 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3184 lta->pid);
3185 }
3186
3187 /* Free memory */
3188 call_rcu(&lta->pid_n.head, delete_ust_app_rcu);
3189
3190 rcu_read_unlock();
3191 return;
3192 }
3193
3194 /*
3195 * Fill events array with all events name of all registered apps.
3196 */
3197 int ust_app_list_events(struct lttng_event **events)
3198 {
3199 int ret, handle;
3200 size_t nbmem, count = 0;
3201 struct lttng_ht_iter iter;
3202 struct ust_app *app;
3203 struct lttng_event *tmp_event;
3204
3205 nbmem = UST_APP_EVENT_LIST_SIZE;
3206 tmp_event = zmalloc(nbmem * sizeof(struct lttng_event));
3207 if (tmp_event == NULL) {
3208 PERROR("zmalloc ust app events");
3209 ret = -ENOMEM;
3210 goto error;
3211 }
3212
3213 rcu_read_lock();
3214
3215 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3216 struct lttng_ust_tracepoint_iter uiter;
3217
3218 health_code_update();
3219
3220 if (!app->compatible) {
3221 /*
3222 * TODO: In time, we should notice the caller of this error by
3223 * telling him that this is a version error.
3224 */
3225 continue;
3226 }
3227 handle = ustctl_tracepoint_list(app->sock);
3228 if (handle < 0) {
3229 if (handle != -EPIPE && handle != -LTTNG_UST_ERR_EXITING) {
3230 ERR("UST app list events getting handle failed for app pid %d",
3231 app->pid);
3232 }
3233 continue;
3234 }
3235
3236 while ((ret = ustctl_tracepoint_list_get(app->sock, handle,
3237 &uiter)) != -LTTNG_UST_ERR_NOENT) {
3238 /* Handle ustctl error. */
3239 if (ret < 0) {
3240 if (ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
3241 ERR("UST app tp list get failed for app %d with ret %d",
3242 app->sock, ret);
3243 } else {
3244 DBG3("UST app tp list get failed. Application is dead");
3245 /*
3246 * This is normal behavior, an application can die during the
3247 * creation process. Don't report an error so the execution can
3248 * continue normally. Continue normal execution.
3249 */
3250 break;
3251 }
3252 free(tmp_event);
3253 goto rcu_error;
3254 }
3255
3256 health_code_update();
3257 if (count >= nbmem) {
3258 /* In case the realloc fails, we free the memory */
3259 struct lttng_event *new_tmp_event;
3260 size_t new_nbmem;
3261
3262 new_nbmem = nbmem << 1;
3263 DBG2("Reallocating event list from %zu to %zu entries",
3264 nbmem, new_nbmem);
3265 new_tmp_event = realloc(tmp_event,
3266 new_nbmem * sizeof(struct lttng_event));
3267 if (new_tmp_event == NULL) {
3268 PERROR("realloc ust app events");
3269 free(tmp_event);
3270 ret = -ENOMEM;
3271 goto rcu_error;
3272 }
3273 /* Zero the new memory */
3274 memset(new_tmp_event + nbmem, 0,
3275 (new_nbmem - nbmem) * sizeof(struct lttng_event));
3276 nbmem = new_nbmem;
3277 tmp_event = new_tmp_event;
3278 }
3279 memcpy(tmp_event[count].name, uiter.name, LTTNG_UST_SYM_NAME_LEN);
3280 tmp_event[count].loglevel = uiter.loglevel;
3281 tmp_event[count].type = (enum lttng_event_type) LTTNG_UST_TRACEPOINT;
3282 tmp_event[count].pid = app->pid;
3283 tmp_event[count].enabled = -1;
3284 count++;
3285 }
3286 }
3287
3288 ret = count;
3289 *events = tmp_event;
3290
3291 DBG2("UST app list events done (%zu events)", count);
3292
3293 rcu_error:
3294 rcu_read_unlock();
3295 error:
3296 health_code_update();
3297 return ret;
3298 }
3299
3300 /*
3301 * Fill events array with all events name of all registered apps.
3302 */
3303 int ust_app_list_event_fields(struct lttng_event_field **fields)
3304 {
3305 int ret, handle;
3306 size_t nbmem, count = 0;
3307 struct lttng_ht_iter iter;
3308 struct ust_app *app;
3309 struct lttng_event_field *tmp_event;
3310
3311 nbmem = UST_APP_EVENT_LIST_SIZE;
3312 tmp_event = zmalloc(nbmem * sizeof(struct lttng_event_field));
3313 if (tmp_event == NULL) {
3314 PERROR("zmalloc ust app event fields");
3315 ret = -ENOMEM;
3316 goto error;
3317 }
3318
3319 rcu_read_lock();
3320
3321 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3322 struct lttng_ust_field_iter uiter;
3323
3324 health_code_update();
3325
3326 if (!app->compatible) {
3327 /*
3328 * TODO: In time, we should notice the caller of this error by
3329 * telling him that this is a version error.
3330 */
3331 continue;
3332 }
3333 handle = ustctl_tracepoint_field_list(app->sock);
3334 if (handle < 0) {
3335 if (handle != -EPIPE && handle != -LTTNG_UST_ERR_EXITING) {
3336 ERR("UST app list field getting handle failed for app pid %d",
3337 app->pid);
3338 }
3339 continue;
3340 }
3341
3342 while ((ret = ustctl_tracepoint_field_list_get(app->sock, handle,
3343 &uiter)) != -LTTNG_UST_ERR_NOENT) {
3344 /* Handle ustctl error. */
3345 if (ret < 0) {
3346 if (ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
3347 ERR("UST app tp list field failed for app %d with ret %d",
3348 app->sock, ret);
3349 } else {
3350 DBG3("UST app tp list field failed. Application is dead");
3351 /*
3352 * This is normal behavior, an application can die during the
3353 * creation process. Don't report an error so the execution can
3354 * continue normally. Reset list and count for next app.
3355 */
3356 break;
3357 }
3358 free(tmp_event);
3359 goto rcu_error;
3360 }
3361
3362 health_code_update();
3363 if (count >= nbmem) {
3364 /* In case the realloc fails, we free the memory */
3365 struct lttng_event_field *new_tmp_event;
3366 size_t new_nbmem;
3367
3368 new_nbmem = nbmem << 1;
3369 DBG2("Reallocating event field list from %zu to %zu entries",
3370 nbmem, new_nbmem);
3371 new_tmp_event = realloc(tmp_event,
3372 new_nbmem * sizeof(struct lttng_event_field));
3373 if (new_tmp_event == NULL) {
3374 PERROR("realloc ust app event fields");
3375 free(tmp_event);
3376 ret = -ENOMEM;
3377 goto rcu_error;
3378 }
3379 /* Zero the new memory */
3380 memset(new_tmp_event + nbmem, 0,
3381 (new_nbmem - nbmem) * sizeof(struct lttng_event_field));
3382 nbmem = new_nbmem;
3383 tmp_event = new_tmp_event;
3384 }
3385
3386 memcpy(tmp_event[count].field_name, uiter.field_name, LTTNG_UST_SYM_NAME_LEN);
3387 /* Mapping between these enums matches 1 to 1. */
3388 tmp_event[count].type = (enum lttng_event_field_type) uiter.type;
3389 tmp_event[count].nowrite = uiter.nowrite;
3390
3391 memcpy(tmp_event[count].event.name, uiter.event_name, LTTNG_UST_SYM_NAME_LEN);
3392 tmp_event[count].event.loglevel = uiter.loglevel;
3393 tmp_event[count].event.type = LTTNG_EVENT_TRACEPOINT;
3394 tmp_event[count].event.pid = app->pid;
3395 tmp_event[count].event.enabled = -1;
3396 count++;
3397 }
3398 }
3399
3400 ret = count;
3401 *fields = tmp_event;
3402
3403 DBG2("UST app list event fields done (%zu events)", count);
3404
3405 rcu_error:
3406 rcu_read_unlock();
3407 error:
3408 health_code_update();
3409 return ret;
3410 }
3411
3412 /*
3413 * Free and clean all traceable apps of the global list.
3414 *
3415 * Should _NOT_ be called with RCU read-side lock held.
3416 */
3417 void ust_app_clean_list(void)
3418 {
3419 int ret;
3420 struct ust_app *app;
3421 struct lttng_ht_iter iter;
3422
3423 DBG2("UST app cleaning registered apps hash table");
3424
3425 rcu_read_lock();
3426
3427 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3428 ret = lttng_ht_del(ust_app_ht, &iter);
3429 assert(!ret);
3430 call_rcu(&app->pid_n.head, delete_ust_app_rcu);
3431 }
3432
3433 /* Cleanup socket hash table */
3434 cds_lfht_for_each_entry(ust_app_ht_by_sock->ht, &iter.iter, app,
3435 sock_n.node) {
3436 ret = lttng_ht_del(ust_app_ht_by_sock, &iter);
3437 assert(!ret);
3438 }
3439
3440 /* Cleanup notify socket hash table */
3441 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock->ht, &iter.iter, app,
3442 notify_sock_n.node) {
3443 ret = lttng_ht_del(ust_app_ht_by_notify_sock, &iter);
3444 assert(!ret);
3445 }
3446 rcu_read_unlock();
3447
3448 /* Destroy is done only when the ht is empty */
3449 ht_cleanup_push(ust_app_ht);
3450 ht_cleanup_push(ust_app_ht_by_sock);
3451 ht_cleanup_push(ust_app_ht_by_notify_sock);
3452 }
3453
3454 /*
3455 * Init UST app hash table.
3456 */
3457 void ust_app_ht_alloc(void)
3458 {
3459 ust_app_ht = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
3460 ust_app_ht_by_sock = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
3461 ust_app_ht_by_notify_sock = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
3462 }
3463
3464 /*
3465 * For a specific UST session, disable the channel for all registered apps.
3466 */
3467 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
3468 struct ltt_ust_channel *uchan)
3469 {
3470 int ret = 0;
3471 struct lttng_ht_iter iter;
3472 struct lttng_ht_node_str *ua_chan_node;
3473 struct ust_app *app;
3474 struct ust_app_session *ua_sess;
3475 struct ust_app_channel *ua_chan;
3476
3477 if (usess == NULL || uchan == NULL) {
3478 ERR("Disabling UST global channel with NULL values");
3479 ret = -1;
3480 goto error;
3481 }
3482
3483 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64,
3484 uchan->name, usess->id);
3485
3486 rcu_read_lock();
3487
3488 /* For every registered applications */
3489 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3490 struct lttng_ht_iter uiter;
3491 if (!app->compatible) {
3492 /*
3493 * TODO: In time, we should notice the caller of this error by
3494 * telling him that this is a version error.
3495 */
3496 continue;
3497 }
3498 ua_sess = lookup_session_by_app(usess, app);
3499 if (ua_sess == NULL) {
3500 continue;
3501 }
3502
3503 /* Get channel */
3504 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
3505 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
3506 /* If the session if found for the app, the channel must be there */
3507 assert(ua_chan_node);
3508
3509 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
3510 /* The channel must not be already disabled */
3511 assert(ua_chan->enabled == 1);
3512
3513 /* Disable channel onto application */
3514 ret = disable_ust_app_channel(ua_sess, ua_chan, app);
3515 if (ret < 0) {
3516 /* XXX: We might want to report this error at some point... */
3517 continue;
3518 }
3519 }
3520
3521 rcu_read_unlock();
3522
3523 error:
3524 return ret;
3525 }
3526
3527 /*
3528 * For a specific UST session, enable the channel for all registered apps.
3529 */
3530 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
3531 struct ltt_ust_channel *uchan)
3532 {
3533 int ret = 0;
3534 struct lttng_ht_iter iter;
3535 struct ust_app *app;
3536 struct ust_app_session *ua_sess;
3537
3538 if (usess == NULL || uchan == NULL) {
3539 ERR("Adding UST global channel to NULL values");
3540 ret = -1;
3541 goto error;
3542 }
3543
3544 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64,
3545 uchan->name, usess->id);
3546
3547 rcu_read_lock();
3548
3549 /* For every registered applications */
3550 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3551 if (!app->compatible) {
3552 /*
3553 * TODO: In time, we should notice the caller of this error by
3554 * telling him that this is a version error.
3555 */
3556 continue;
3557 }
3558 ua_sess = lookup_session_by_app(usess, app);
3559 if (ua_sess == NULL) {
3560 continue;
3561 }
3562
3563 /* Enable channel onto application */
3564 ret = enable_ust_app_channel(ua_sess, uchan, app);
3565 if (ret < 0) {
3566 /* XXX: We might want to report this error at some point... */
3567 continue;
3568 }
3569 }
3570
3571 rcu_read_unlock();
3572
3573 error:
3574 return ret;
3575 }
3576
3577 /*
3578 * Disable an event in a channel and for a specific session.
3579 */
3580 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
3581 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
3582 {
3583 int ret = 0;
3584 struct lttng_ht_iter iter, uiter;
3585 struct lttng_ht_node_str *ua_chan_node, *ua_event_node;
3586 struct ust_app *app;
3587 struct ust_app_session *ua_sess;
3588 struct ust_app_channel *ua_chan;
3589 struct ust_app_event *ua_event;
3590
3591 DBG("UST app disabling event %s for all apps in channel "
3592 "%s for session id %" PRIu64,
3593 uevent->attr.name, uchan->name, usess->id);
3594
3595 rcu_read_lock();
3596
3597 /* For all registered applications */
3598 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3599 if (!app->compatible) {
3600 /*
3601 * TODO: In time, we should notice the caller of this error by
3602 * telling him that this is a version error.
3603 */
3604 continue;
3605 }
3606 ua_sess = lookup_session_by_app(usess, app);
3607 if (ua_sess == NULL) {
3608 /* Next app */
3609 continue;
3610 }
3611
3612 /* Lookup channel in the ust app session */
3613 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
3614 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
3615 if (ua_chan_node == NULL) {
3616 DBG2("Channel %s not found in session id %" PRIu64 " for app pid %d."
3617 "Skipping", uchan->name, usess->id, app->pid);
3618 continue;
3619 }
3620 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
3621
3622 lttng_ht_lookup(ua_chan->events, (void *)uevent->attr.name, &uiter);
3623 ua_event_node = lttng_ht_iter_get_node_str(&uiter);
3624 if (ua_event_node == NULL) {
3625 DBG2("Event %s not found in channel %s for app pid %d."
3626 "Skipping", uevent->attr.name, uchan->name, app->pid);
3627 continue;
3628 }
3629 ua_event = caa_container_of(ua_event_node, struct ust_app_event, node);
3630
3631 ret = disable_ust_app_event(ua_sess, ua_event, app);
3632 if (ret < 0) {
3633 /* XXX: Report error someday... */
3634 continue;
3635 }
3636 }
3637
3638 rcu_read_unlock();
3639
3640 return ret;
3641 }
3642
3643 /*
3644 * For a specific UST session, create the channel for all registered apps.
3645 */
3646 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
3647 struct ltt_ust_channel *uchan)
3648 {
3649 int ret = 0, created;
3650 struct lttng_ht_iter iter;
3651 struct ust_app *app;
3652 struct ust_app_session *ua_sess = NULL;
3653
3654 /* Very wrong code flow */
3655 assert(usess);
3656 assert(uchan);
3657
3658 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64,
3659 uchan->name, usess->id);
3660
3661 rcu_read_lock();
3662
3663 /* For every registered applications */
3664 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3665 if (!app->compatible) {
3666 /*
3667 * TODO: In time, we should notice the caller of this error by
3668 * telling him that this is a version error.
3669 */
3670 continue;
3671 }
3672 /*
3673 * Create session on the tracer side and add it to app session HT. Note
3674 * that if session exist, it will simply return a pointer to the ust
3675 * app session.
3676 */
3677 ret = create_ust_app_session(usess, app, &ua_sess, &created);
3678 if (ret < 0) {
3679 switch (ret) {
3680 case -ENOTCONN:
3681 /*
3682 * The application's socket is not valid. Either a bad socket
3683 * or a timeout on it. We can't inform the caller that for a
3684 * specific app, the session failed so lets continue here.
3685 */
3686 continue;
3687 case -ENOMEM:
3688 default:
3689 goto error_rcu_unlock;
3690 }
3691 }
3692 assert(ua_sess);
3693
3694 pthread_mutex_lock(&ua_sess->lock);
3695 if (!strncmp(uchan->name, DEFAULT_METADATA_NAME,
3696 sizeof(uchan->name))) {
3697 copy_channel_attr_to_ustctl(&ua_sess->metadata_attr, &uchan->attr);
3698 ret = 0;
3699 } else {
3700 /* Create channel onto application. We don't need the chan ref. */
3701 ret = create_ust_app_channel(ua_sess, uchan, app,
3702 LTTNG_UST_CHAN_PER_CPU, usess, NULL);
3703 }
3704 pthread_mutex_unlock(&ua_sess->lock);
3705 if (ret < 0) {
3706 if (ret == -ENOMEM) {
3707 /* No more memory is a fatal error. Stop right now. */
3708 goto error_rcu_unlock;
3709 }
3710 /* Cleanup the created session if it's the case. */
3711 if (created) {
3712 destroy_app_session(app, ua_sess);
3713 }
3714 }
3715 }
3716
3717 error_rcu_unlock:
3718 rcu_read_unlock();
3719 return ret;
3720 }
3721
3722 /*
3723 * Enable event for a specific session and channel on the tracer.
3724 */
3725 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
3726 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
3727 {
3728 int ret = 0;
3729 struct lttng_ht_iter iter, uiter;
3730 struct lttng_ht_node_str *ua_chan_node;
3731 struct ust_app *app;
3732 struct ust_app_session *ua_sess;
3733 struct ust_app_channel *ua_chan;
3734 struct ust_app_event *ua_event;
3735
3736 DBG("UST app enabling event %s for all apps for session id %" PRIu64,
3737 uevent->attr.name, usess->id);
3738
3739 /*
3740 * NOTE: At this point, this function is called only if the session and
3741 * channel passed are already created for all apps. and enabled on the
3742 * tracer also.
3743 */
3744
3745 rcu_read_lock();
3746
3747 /* For all registered applications */
3748 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3749 if (!app->compatible) {
3750 /*
3751 * TODO: In time, we should notice the caller of this error by
3752 * telling him that this is a version error.
3753 */
3754 continue;
3755 }
3756 ua_sess = lookup_session_by_app(usess, app);
3757 if (!ua_sess) {
3758 /* The application has problem or is probably dead. */
3759 continue;
3760 }
3761
3762 pthread_mutex_lock(&ua_sess->lock);
3763
3764 /* Lookup channel in the ust app session */
3765 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
3766 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
3767 /* If the channel is not found, there is a code flow error */
3768 assert(ua_chan_node);
3769
3770 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
3771
3772 /* Get event node */
3773 ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
3774 uevent->filter, uevent->attr.loglevel, uevent->exclusion);
3775 if (ua_event == NULL) {
3776 DBG3("UST app enable event %s not found for app PID %d."
3777 "Skipping app", uevent->attr.name, app->pid);
3778 goto next_app;
3779 }
3780
3781 ret = enable_ust_app_event(ua_sess, ua_event, app);
3782 if (ret < 0) {
3783 pthread_mutex_unlock(&ua_sess->lock);
3784 goto error;
3785 }
3786 next_app:
3787 pthread_mutex_unlock(&ua_sess->lock);
3788 }
3789
3790 error:
3791 rcu_read_unlock();
3792 return ret;
3793 }
3794
3795 /*
3796 * For a specific existing UST session and UST channel, creates the event for
3797 * all registered apps.
3798 */
3799 int ust_app_create_event_glb(struct ltt_ust_session *usess,
3800 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
3801 {
3802 int ret = 0;
3803 struct lttng_ht_iter iter, uiter;
3804 struct lttng_ht_node_str *ua_chan_node;
3805 struct ust_app *app;
3806 struct ust_app_session *ua_sess;
3807 struct ust_app_channel *ua_chan;
3808
3809 DBG("UST app creating event %s for all apps for session id %" PRIu64,
3810 uevent->attr.name, usess->id);
3811
3812 rcu_read_lock();
3813
3814 /* For all registered applications */
3815 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3816 if (!app->compatible) {
3817 /*
3818 * TODO: In time, we should notice the caller of this error by
3819 * telling him that this is a version error.
3820 */
3821 continue;
3822 }
3823 ua_sess = lookup_session_by_app(usess, app);
3824 if (!ua_sess) {
3825 /* The application has problem or is probably dead. */
3826 continue;
3827 }
3828
3829 pthread_mutex_lock(&ua_sess->lock);
3830 /* Lookup channel in the ust app session */
3831 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
3832 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
3833 /* If the channel is not found, there is a code flow error */
3834 assert(ua_chan_node);
3835
3836 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
3837
3838 ret = create_ust_app_event(ua_sess, ua_chan, uevent, app);
3839 pthread_mutex_unlock(&ua_sess->lock);
3840 if (ret < 0) {
3841 if (ret != -LTTNG_UST_ERR_EXIST) {
3842 /* Possible value at this point: -ENOMEM. If so, we stop! */
3843 break;
3844 }
3845 DBG2("UST app event %s already exist on app PID %d",
3846 uevent->attr.name, app->pid);
3847 continue;
3848 }
3849 }
3850
3851 rcu_read_unlock();
3852
3853 return ret;
3854 }
3855
3856 /*
3857 * Start tracing for a specific UST session and app.
3858 */
3859 static
3860 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
3861 {
3862 int ret = 0;
3863 struct ust_app_session *ua_sess;
3864
3865 DBG("Starting tracing for ust app pid %d", app->pid);
3866
3867 rcu_read_lock();
3868
3869 if (!app->compatible) {
3870 goto end;
3871 }
3872
3873 ua_sess = lookup_session_by_app(usess, app);
3874 if (ua_sess == NULL) {
3875 /* The session is in teardown process. Ignore and continue. */
3876 goto end;
3877 }
3878
3879 pthread_mutex_lock(&ua_sess->lock);
3880
3881 /* Upon restart, we skip the setup, already done */
3882 if (ua_sess->started) {
3883 goto skip_setup;
3884 }
3885
3886 /* Create directories if consumer is LOCAL and has a path defined. */
3887 if (usess->consumer->type == CONSUMER_DST_LOCAL &&
3888 strlen(usess->consumer->dst.trace_path) > 0) {
3889 ret = run_as_mkdir_recursive(usess->consumer->dst.trace_path,
3890 S_IRWXU | S_IRWXG, ua_sess->euid, ua_sess->egid);
3891 if (ret < 0) {
3892 if (ret != -EEXIST) {
3893 ERR("Trace directory creation error");
3894 goto error_unlock;
3895 }
3896 }
3897 }
3898
3899 /*
3900 * Create the metadata for the application. This returns gracefully if a
3901 * metadata was already set for the session.
3902 */
3903 ret = create_ust_app_metadata(ua_sess, app, usess->consumer);
3904 if (ret < 0) {
3905 goto error_unlock;
3906 }
3907
3908 health_code_update();
3909
3910 skip_setup:
3911 /* This start the UST tracing */
3912 ret = ustctl_start_session(app->sock, ua_sess->handle);
3913 if (ret < 0) {
3914 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
3915 ERR("Error starting tracing for app pid: %d (ret: %d)",
3916 app->pid, ret);
3917 } else {
3918 DBG("UST app start session failed. Application is dead.");
3919 /*
3920 * This is normal behavior, an application can die during the
3921 * creation process. Don't report an error so the execution can
3922 * continue normally.
3923 */
3924 pthread_mutex_unlock(&ua_sess->lock);
3925 goto end;
3926 }
3927 goto error_unlock;
3928 }
3929
3930 /* Indicate that the session has been started once */
3931 ua_sess->started = 1;
3932
3933 pthread_mutex_unlock(&ua_sess->lock);
3934
3935 health_code_update();
3936
3937 /* Quiescent wait after starting trace */
3938 ret = ustctl_wait_quiescent(app->sock);
3939 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
3940 ERR("UST app wait quiescent failed for app pid %d ret %d",
3941 app->pid, ret);
3942 }
3943
3944 end:
3945 rcu_read_unlock();
3946 health_code_update();
3947 return 0;
3948
3949 error_unlock:
3950 pthread_mutex_unlock(&ua_sess->lock);
3951 rcu_read_unlock();
3952 health_code_update();
3953 return -1;
3954 }
3955
3956 /*
3957 * Stop tracing for a specific UST session and app.
3958 */
3959 static
3960 int ust_app_stop_trace(struct ltt_ust_session *usess, struct ust_app *app)
3961 {
3962 int ret = 0;
3963 struct ust_app_session *ua_sess;
3964 struct ust_registry_session *registry;
3965
3966 DBG("Stopping tracing for ust app pid %d", app->pid);
3967
3968 rcu_read_lock();
3969
3970 if (!app->compatible) {
3971 goto end_no_session;
3972 }
3973
3974 ua_sess = lookup_session_by_app(usess, app);
3975 if (ua_sess == NULL) {
3976 goto end_no_session;
3977 }
3978
3979 pthread_mutex_lock(&ua_sess->lock);
3980
3981 /*
3982 * If started = 0, it means that stop trace has been called for a session
3983 * that was never started. It's possible since we can have a fail start
3984 * from either the application manager thread or the command thread. Simply
3985 * indicate that this is a stop error.
3986 */
3987 if (!ua_sess->started) {
3988 goto error_rcu_unlock;
3989 }
3990
3991 health_code_update();
3992
3993 /* This inhibits UST tracing */
3994 ret = ustctl_stop_session(app->sock, ua_sess->handle);
3995 if (ret < 0) {
3996 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
3997 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3998 app->pid, ret);
3999 } else {
4000 DBG("UST app stop session failed. Application is dead.");
4001 /*
4002 * This is normal behavior, an application can die during the
4003 * creation process. Don't report an error so the execution can
4004 * continue normally.
4005 */
4006 goto end_unlock;
4007 }
4008 goto error_rcu_unlock;
4009 }
4010
4011 health_code_update();
4012
4013 /* Quiescent wait after stopping trace */
4014 ret = ustctl_wait_quiescent(app->sock);
4015 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4016 ERR("UST app wait quiescent failed for app pid %d ret %d",
4017 app->pid, ret);
4018 }
4019
4020 health_code_update();
4021
4022 registry = get_session_registry(ua_sess);
4023 assert(registry);
4024
4025 /* Push metadata for application before freeing the application. */
4026 (void) push_metadata(registry, ua_sess->consumer);
4027
4028 end_unlock:
4029 pthread_mutex_unlock(&ua_sess->lock);
4030 end_no_session:
4031 rcu_read_unlock();
4032 health_code_update();
4033 return 0;
4034
4035 error_rcu_unlock:
4036 pthread_mutex_unlock(&ua_sess->lock);
4037 rcu_read_unlock();
4038 health_code_update();
4039 return -1;
4040 }
4041
4042 static
4043 int ust_app_flush_app_session(struct ust_app *app,
4044 struct ust_app_session *ua_sess)
4045 {
4046 int ret, retval = 0;
4047 struct lttng_ht_iter iter;
4048 struct ust_app_channel *ua_chan;
4049 struct consumer_socket *socket;
4050
4051 DBG("Flushing app session buffers for ust app pid %d", app->pid);
4052
4053 rcu_read_lock();
4054
4055 if (!app->compatible) {
4056 goto end_not_compatible;
4057 }
4058
4059 pthread_mutex_lock(&ua_sess->lock);
4060
4061 health_code_update();
4062
4063 /* Flushing buffers */
4064 socket = consumer_find_socket_by_bitness(app->bits_per_long,
4065 ua_sess->consumer);
4066
4067 /* Flush buffers and push metadata. */
4068 switch (ua_sess->buffer_type) {
4069 case LTTNG_BUFFER_PER_PID:
4070 cds_lfht_for_each_entry(ua_sess->channels->ht, &iter.iter, ua_chan,
4071 node.node) {
4072 health_code_update();
4073 assert(ua_chan->is_sent);
4074 ret = consumer_flush_channel(socket, ua_chan->key);
4075 if (ret) {
4076 ERR("Error flushing consumer channel");
4077 retval = -1;
4078 continue;
4079 }
4080 }
4081 break;
4082 case LTTNG_BUFFER_PER_UID:
4083 default:
4084 assert(0);
4085 break;
4086 }
4087
4088 health_code_update();
4089
4090 pthread_mutex_unlock(&ua_sess->lock);
4091
4092 end_not_compatible:
4093 rcu_read_unlock();
4094 health_code_update();
4095 return retval;
4096 }
4097
4098 /*
4099 * Flush buffers for all applications for a specific UST session.
4100 * Called with UST session lock held.
4101 */
4102 static
4103 int ust_app_flush_session(struct ltt_ust_session *usess)
4104
4105 {
4106 int ret = 0;
4107
4108 DBG("Flushing session buffers for all ust apps");
4109
4110 rcu_read_lock();
4111
4112 /* Flush buffers and push metadata. */
4113 switch (usess->buffer_type) {
4114 case LTTNG_BUFFER_PER_UID:
4115 {
4116 struct buffer_reg_uid *reg;
4117 struct lttng_ht_iter iter;
4118
4119 /* Flush all per UID buffers associated to that session. */
4120 cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
4121 struct ust_registry_session *ust_session_reg;
4122 struct buffer_reg_channel *reg_chan;
4123 struct consumer_socket *socket;
4124
4125 /* Get consumer socket to use to push the metadata.*/
4126 socket = consumer_find_socket_by_bitness(reg->bits_per_long,
4127 usess->consumer);
4128 if (!socket) {
4129 /* Ignore request if no consumer is found for the session. */
4130 continue;
4131 }
4132
4133 cds_lfht_for_each_entry(reg->registry->channels->ht, &iter.iter,
4134 reg_chan, node.node) {
4135 /*
4136 * The following call will print error values so the return
4137 * code is of little importance because whatever happens, we
4138 * have to try them all.
4139 */
4140 (void) consumer_flush_channel(socket, reg_chan->consumer_key);
4141 }
4142
4143 ust_session_reg = reg->registry->reg.ust;
4144 /* Push metadata. */
4145 (void) push_metadata(ust_session_reg, usess->consumer);
4146 }
4147 break;
4148 }
4149 case LTTNG_BUFFER_PER_PID:
4150 {
4151 struct ust_app_session *ua_sess;
4152 struct lttng_ht_iter iter;
4153 struct ust_app *app;
4154
4155 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4156 ua_sess = lookup_session_by_app(usess, app);
4157 if (ua_sess == NULL) {
4158 continue;
4159 }
4160 (void) ust_app_flush_app_session(app, ua_sess);
4161 }
4162 break;
4163 }
4164 default:
4165 ret = -1;
4166 assert(0);
4167 break;
4168 }
4169
4170 end_no_session:
4171 rcu_read_unlock();
4172 health_code_update();
4173 return ret;
4174 }
4175
4176 /*
4177 * Destroy a specific UST session in apps.
4178 */
4179 static int destroy_trace(struct ltt_ust_session *usess, struct ust_app *app)
4180 {
4181 int ret;
4182 struct ust_app_session *ua_sess;
4183 struct lttng_ht_iter iter;
4184 struct lttng_ht_node_u64 *node;
4185
4186 DBG("Destroy tracing for ust app pid %d", app->pid);
4187
4188 rcu_read_lock();
4189
4190 if (!app->compatible) {
4191 goto end;
4192 }
4193
4194 __lookup_session_by_app(usess, app, &iter);
4195 node = lttng_ht_iter_get_node_u64(&iter);
4196 if (node == NULL) {
4197 /* Session is being or is deleted. */
4198 goto end;
4199 }
4200 ua_sess = caa_container_of(node, struct ust_app_session, node);
4201
4202 health_code_update();
4203 destroy_app_session(app, ua_sess);
4204
4205 health_code_update();
4206
4207 /* Quiescent wait after stopping trace */
4208 ret = ustctl_wait_quiescent(app->sock);
4209 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4210 ERR("UST app wait quiescent failed for app pid %d ret %d",
4211 app->pid, ret);
4212 }
4213 end:
4214 rcu_read_unlock();
4215 health_code_update();
4216 return 0;
4217 }
4218
4219 /*
4220 * Start tracing for the UST session.
4221 */
4222 int ust_app_start_trace_all(struct ltt_ust_session *usess)
4223 {
4224 int ret = 0;
4225 struct lttng_ht_iter iter;
4226 struct ust_app *app;
4227
4228 DBG("Starting all UST traces");
4229
4230 rcu_read_lock();
4231
4232 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4233 ret = ust_app_start_trace(usess, app);
4234 if (ret < 0) {
4235 /* Continue to next apps even on error */
4236 continue;
4237 }
4238 }
4239
4240 rcu_read_unlock();
4241
4242 return 0;
4243 }
4244
4245 /*
4246 * Start tracing for the UST session.
4247 * Called with UST session lock held.
4248 */
4249 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
4250 {
4251 int ret = 0;
4252 struct lttng_ht_iter iter;
4253 struct ust_app *app;
4254
4255 DBG("Stopping all UST traces");
4256
4257 rcu_read_lock();
4258
4259 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4260 ret = ust_app_stop_trace(usess, app);
4261 if (ret < 0) {
4262 /* Continue to next apps even on error */
4263 continue;
4264 }
4265 }
4266
4267 (void) ust_app_flush_session(usess);
4268
4269 rcu_read_unlock();
4270
4271 return 0;
4272 }
4273
4274 /*
4275 * Destroy app UST session.
4276 */
4277 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
4278 {
4279 int ret = 0;
4280 struct lttng_ht_iter iter;
4281 struct ust_app *app;
4282
4283 DBG("Destroy all UST traces");
4284
4285 rcu_read_lock();
4286
4287 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4288 ret = destroy_trace(usess, app);
4289 if (ret < 0) {
4290 /* Continue to next apps even on error */
4291 continue;
4292 }
4293 }
4294
4295 rcu_read_unlock();
4296
4297 return 0;
4298 }
4299
4300 /*
4301 * Add channels/events from UST global domain to registered apps at sock.
4302 */
4303 void ust_app_global_update(struct ltt_ust_session *usess, int sock)
4304 {
4305 int ret = 0;
4306 struct lttng_ht_iter iter, uiter;
4307 struct ust_app *app;
4308 struct ust_app_session *ua_sess = NULL;
4309 struct ust_app_channel *ua_chan;
4310 struct ust_app_event *ua_event;
4311 struct ust_app_ctx *ua_ctx;
4312
4313 assert(usess);
4314 assert(sock >= 0);
4315
4316 DBG2("UST app global update for app sock %d for session id %" PRIu64, sock,
4317 usess->id);
4318
4319 rcu_read_lock();
4320
4321 app = ust_app_find_by_sock(sock);
4322 if (app == NULL) {
4323 /*
4324 * Application can be unregistered before so this is possible hence
4325 * simply stopping the update.
4326 */
4327 DBG3("UST app update failed to find app sock %d", sock);
4328 goto error;
4329 }
4330
4331 if (!app->compatible) {
4332 goto error;
4333 }
4334
4335 ret = create_ust_app_session(usess, app, &ua_sess, NULL);
4336 if (ret < 0) {
4337 /* Tracer is probably gone or ENOMEM. */
4338 goto error;
4339 }
4340 assert(ua_sess);
4341
4342 pthread_mutex_lock(&ua_sess->lock);
4343
4344 /*
4345 * We can iterate safely here over all UST app session since the create ust
4346 * app session above made a shadow copy of the UST global domain from the
4347 * ltt ust session.
4348 */
4349 cds_lfht_for_each_entry(ua_sess->channels->ht, &iter.iter, ua_chan,
4350 node.node) {
4351 ret = do_create_channel(app, usess, ua_sess, ua_chan);
4352 if (ret < 0) {
4353 /*
4354 * Stop everything. On error, the application failed, no more
4355 * file descriptor are available or ENOMEM so stopping here is
4356 * the only thing we can do for now.
4357 */
4358 goto error_unlock;
4359 }
4360
4361 /*
4362 * Add context using the list so they are enabled in the same order the
4363 * user added them.
4364 */
4365 cds_list_for_each_entry(ua_ctx, &ua_chan->ctx_list, list) {
4366 ret = create_ust_channel_context(ua_chan, ua_ctx, app);
4367 if (ret < 0) {
4368 goto error_unlock;
4369 }
4370 }
4371
4372
4373 /* For each events */
4374 cds_lfht_for_each_entry(ua_chan->events->ht, &uiter.iter, ua_event,
4375 node.node) {
4376 ret = create_ust_event(app, ua_sess, ua_chan, ua_event);
4377 if (ret < 0) {
4378 goto error_unlock;
4379 }
4380 }
4381 }
4382
4383 pthread_mutex_unlock(&ua_sess->lock);
4384
4385 if (usess->active) {
4386 ret = ust_app_start_trace(usess, app);
4387 if (ret < 0) {
4388 goto error;
4389 }
4390
4391 DBG2("UST trace started for app pid %d", app->pid);
4392 }
4393
4394 /* Everything went well at this point. */
4395 rcu_read_unlock();
4396 return;
4397
4398 error_unlock:
4399 pthread_mutex_unlock(&ua_sess->lock);
4400 error:
4401 if (ua_sess) {
4402 destroy_app_session(app, ua_sess);
4403 }
4404 rcu_read_unlock();
4405 return;
4406 }
4407
4408 /*
4409 * Add context to a specific channel for global UST domain.
4410 */
4411 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
4412 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
4413 {
4414 int ret = 0;
4415 struct lttng_ht_node_str *ua_chan_node;
4416 struct lttng_ht_iter iter, uiter;
4417 struct ust_app_channel *ua_chan = NULL;
4418 struct ust_app_session *ua_sess;
4419 struct ust_app *app;
4420
4421 rcu_read_lock();
4422
4423 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4424 if (!app->compatible) {
4425 /*
4426 * TODO: In time, we should notice the caller of this error by
4427 * telling him that this is a version error.
4428 */
4429 continue;
4430 }
4431 ua_sess = lookup_session_by_app(usess, app);
4432 if (ua_sess == NULL) {
4433 continue;
4434 }
4435
4436 pthread_mutex_lock(&ua_sess->lock);
4437 /* Lookup channel in the ust app session */
4438 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
4439 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
4440 if (ua_chan_node == NULL) {
4441 goto next_app;
4442 }
4443 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel,
4444 node);
4445 ret = create_ust_app_channel_context(ua_sess, ua_chan, &uctx->ctx, app);
4446 if (ret < 0) {
4447 goto next_app;
4448 }
4449 next_app:
4450 pthread_mutex_unlock(&ua_sess->lock);
4451 }
4452
4453 rcu_read_unlock();
4454 return ret;
4455 }
4456
4457 /*
4458 * Enable event for a channel from a UST session for a specific PID.
4459 */
4460 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
4461 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent, pid_t pid)
4462 {
4463 int ret = 0;
4464 struct lttng_ht_iter iter;
4465 struct lttng_ht_node_str *ua_chan_node;
4466 struct ust_app *app;
4467 struct ust_app_session *ua_sess;
4468 struct ust_app_channel *ua_chan;
4469 struct ust_app_event *ua_event;
4470
4471 DBG("UST app enabling event %s for PID %d", uevent->attr.name, pid);
4472
4473 rcu_read_lock();
4474
4475 app = ust_app_find_by_pid(pid);
4476 if (app == NULL) {
4477 ERR("UST app enable event per PID %d not found", pid);
4478 ret = -1;
4479 goto end;
4480 }
4481
4482 if (!app->compatible) {
4483 ret = 0;
4484 goto end;
4485 }
4486
4487 ua_sess = lookup_session_by_app(usess, app);
4488 if (!ua_sess) {
4489 /* The application has problem or is probably dead. */
4490 ret = 0;
4491 goto end;
4492 }
4493
4494 pthread_mutex_lock(&ua_sess->lock);
4495 /* Lookup channel in the ust app session */
4496 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &iter);
4497 ua_chan_node = lttng_ht_iter_get_node_str(&iter);
4498 /* If the channel is not found, there is a code flow error */
4499 assert(ua_chan_node);
4500
4501 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
4502
4503 ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
4504 uevent->filter, uevent->attr.loglevel, uevent->exclusion);
4505 if (ua_event == NULL) {
4506 ret = create_ust_app_event(ua_sess, ua_chan, uevent, app);
4507 if (ret < 0) {
4508 goto end_unlock;
4509 }
4510 } else {
4511 ret = enable_ust_app_event(ua_sess, ua_event, app);
4512 if (ret < 0) {
4513 goto end_unlock;
4514 }
4515 }
4516
4517 end_unlock:
4518 pthread_mutex_unlock(&ua_sess->lock);
4519 end:
4520 rcu_read_unlock();
4521 return ret;
4522 }
4523
4524 /*
4525 * Calibrate registered applications.
4526 */
4527 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
4528 {
4529 int ret = 0;
4530 struct lttng_ht_iter iter;
4531 struct ust_app *app;
4532
4533 rcu_read_lock();
4534
4535 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4536 if (!app->compatible) {
4537 /*
4538 * TODO: In time, we should notice the caller of this error by
4539 * telling him that this is a version error.
4540 */
4541 continue;
4542 }
4543
4544 health_code_update();
4545
4546 ret = ustctl_calibrate(app->sock, calibrate);
4547 if (ret < 0) {
4548 switch (ret) {
4549 case -ENOSYS:
4550 /* Means that it's not implemented on the tracer side. */
4551 ret = 0;
4552 break;
4553 default:
4554 DBG2("Calibrate app PID %d returned with error %d",
4555 app->pid, ret);
4556 break;
4557 }
4558 }
4559 }
4560
4561 DBG("UST app global domain calibration finished");
4562
4563 rcu_read_unlock();
4564
4565 health_code_update();
4566
4567 return ret;
4568 }
4569
4570 /*
4571 * Receive registration and populate the given msg structure.
4572 *
4573 * On success return 0 else a negative value returned by the ustctl call.
4574 */
4575 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
4576 {
4577 int ret;
4578 uint32_t pid, ppid, uid, gid;
4579
4580 assert(msg);
4581
4582 ret = ustctl_recv_reg_msg(sock, &msg->type, &msg->major, &msg->minor,
4583 &pid, &ppid, &uid, &gid,
4584 &msg->bits_per_long,
4585 &msg->uint8_t_alignment,
4586 &msg->uint16_t_alignment,
4587 &msg->uint32_t_alignment,
4588 &msg->uint64_t_alignment,
4589 &msg->long_alignment,
4590 &msg->byte_order,
4591 msg->name);
4592 if (ret < 0) {
4593 switch (-ret) {
4594 case EPIPE:
4595 case ECONNRESET:
4596 case LTTNG_UST_ERR_EXITING:
4597 DBG3("UST app recv reg message failed. Application died");
4598 break;
4599 case LTTNG_UST_ERR_UNSUP_MAJOR:
4600 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4601 msg->major, msg->minor, LTTNG_UST_ABI_MAJOR_VERSION,
4602 LTTNG_UST_ABI_MINOR_VERSION);
4603 break;
4604 default:
4605 ERR("UST app recv reg message failed with ret %d", ret);
4606 break;
4607 }
4608 goto error;
4609 }
4610 msg->pid = (pid_t) pid;
4611 msg->ppid = (pid_t) ppid;
4612 msg->uid = (uid_t) uid;
4613 msg->gid = (gid_t) gid;
4614
4615 error:
4616 return ret;
4617 }
4618
4619 /*
4620 * Return a ust app channel object using the application object and the channel
4621 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4622 * lock MUST be acquired before calling this function.
4623 */
4624 static struct ust_app_channel *find_channel_by_objd(struct ust_app *app,
4625 int objd)
4626 {
4627 struct lttng_ht_node_ulong *node;
4628 struct lttng_ht_iter iter;
4629 struct ust_app_channel *ua_chan = NULL;
4630
4631 assert(app);
4632
4633 lttng_ht_lookup(app->ust_objd, (void *)((unsigned long) objd), &iter);
4634 node = lttng_ht_iter_get_node_ulong(&iter);
4635 if (node == NULL) {
4636 DBG2("UST app channel find by objd %d not found", objd);
4637 goto error;
4638 }
4639
4640 ua_chan = caa_container_of(node, struct ust_app_channel, ust_objd_node);
4641
4642 error:
4643 return ua_chan;
4644 }
4645
4646 /*
4647 * Reply to a register channel notification from an application on the notify
4648 * socket. The channel metadata is also created.
4649 *
4650 * The session UST registry lock is acquired in this function.
4651 *
4652 * On success 0 is returned else a negative value.
4653 */
4654 static int reply_ust_register_channel(int sock, int sobjd, int cobjd,
4655 size_t nr_fields, struct ustctl_field *fields)
4656 {
4657 int ret, ret_code = 0;
4658 uint32_t chan_id, reg_count;
4659 uint64_t chan_reg_key;
4660 enum ustctl_channel_header type;
4661 struct ust_app *app;
4662 struct ust_app_channel *ua_chan;
4663 struct ust_app_session *ua_sess;
4664 struct ust_registry_session *registry;
4665 struct ust_registry_channel *chan_reg;
4666
4667 rcu_read_lock();
4668
4669 /* Lookup application. If not found, there is a code flow error. */
4670 app = find_app_by_notify_sock(sock);
4671 if (!app) {
4672 DBG("Application socket %d is being teardown. Abort event notify",
4673 sock);
4674 ret = 0;
4675 free(fields);
4676 goto error_rcu_unlock;
4677 }
4678
4679 /* Lookup channel by UST object descriptor. */
4680 ua_chan = find_channel_by_objd(app, cobjd);
4681 if (!ua_chan) {
4682 DBG("Application channel is being teardown. Abort event notify");
4683 ret = 0;
4684 free(fields);
4685 goto error_rcu_unlock;
4686 }
4687
4688 assert(ua_chan->session);
4689 ua_sess = ua_chan->session;
4690
4691 /* Get right session registry depending on the session buffer type. */
4692 registry = get_session_registry(ua_sess);
4693 assert(registry);
4694
4695 /* Depending on the buffer type, a different channel key is used. */
4696 if (ua_sess->buffer_type == LTTNG_BUFFER_PER_UID) {
4697 chan_reg_key = ua_chan->tracing_channel_id;
4698 } else {
4699 chan_reg_key = ua_chan->key;
4700 }
4701
4702 pthread_mutex_lock(&registry->lock);
4703
4704 chan_reg = ust_registry_channel_find(registry, chan_reg_key);
4705 assert(chan_reg);
4706
4707 if (!chan_reg->register_done) {
4708 reg_count = ust_registry_get_event_count(chan_reg);
4709 if (reg_count < 31) {
4710 type = USTCTL_CHANNEL_HEADER_COMPACT;
4711 } else {
4712 type = USTCTL_CHANNEL_HEADER_LARGE;
4713 }
4714
4715 chan_reg->nr_ctx_fields = nr_fields;
4716 chan_reg->ctx_fields = fields;
4717 chan_reg->header_type = type;
4718 } else {
4719 /* Get current already assigned values. */
4720 type = chan_reg->header_type;
4721 free(fields);
4722 /* Set to NULL so the error path does not do a double free. */
4723 fields = NULL;
4724 }
4725 /* Channel id is set during the object creation. */
4726 chan_id = chan_reg->chan_id;
4727
4728 /* Append to metadata */
4729 if (!chan_reg->metadata_dumped) {
4730 ret_code = ust_metadata_channel_statedump(registry, chan_reg);
4731 if (ret_code) {
4732 ERR("Error appending channel metadata (errno = %d)", ret_code);
4733 goto reply;
4734 }
4735 }
4736
4737 reply:
4738 DBG3("UST app replying to register channel key %" PRIu64
4739 " with id %u, type: %d, ret: %d", chan_reg_key, chan_id, type,
4740 ret_code);
4741
4742 ret = ustctl_reply_register_channel(sock, chan_id, type, ret_code);
4743 if (ret < 0) {
4744 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4745 ERR("UST app reply channel failed with ret %d", ret);
4746 } else {
4747 DBG3("UST app reply channel failed. Application died");
4748 }
4749 goto error;
4750 }
4751
4752 /* This channel registry registration is completed. */
4753 chan_reg->register_done = 1;
4754
4755 error:
4756 pthread_mutex_unlock(&registry->lock);
4757 error_rcu_unlock:
4758 rcu_read_unlock();
4759 if (ret) {
4760 free(fields);
4761 }
4762 return ret;
4763 }
4764
4765 /*
4766 * Add event to the UST channel registry. When the event is added to the
4767 * registry, the metadata is also created. Once done, this replies to the
4768 * application with the appropriate error code.
4769 *
4770 * The session UST registry lock is acquired in the function.
4771 *
4772 * On success 0 is returned else a negative value.
4773 */
4774 static int add_event_ust_registry(int sock, int sobjd, int cobjd, char *name,
4775 char *sig, size_t nr_fields, struct ustctl_field *fields, int loglevel,
4776 char *model_emf_uri)
4777 {
4778 int ret, ret_code;
4779 uint32_t event_id = 0;
4780 uint64_t chan_reg_key;
4781 struct ust_app *app;
4782 struct ust_app_channel *ua_chan;
4783 struct ust_app_session *ua_sess;
4784 struct ust_registry_session *registry;
4785
4786 rcu_read_lock();
4787
4788 /* Lookup application. If not found, there is a code flow error. */
4789 app = find_app_by_notify_sock(sock);
4790 if (!app) {
4791 DBG("Application socket %d is being teardown. Abort event notify",
4792 sock);
4793 ret = 0;
4794 free(sig);
4795 free(fields);
4796 free(model_emf_uri);
4797 goto error_rcu_unlock;
4798 }
4799
4800 /* Lookup channel by UST object descriptor. */
4801 ua_chan = find_channel_by_objd(app, cobjd);
4802 if (!ua_chan) {
4803 DBG("Application channel is being teardown. Abort event notify");
4804 ret = 0;
4805 free(sig);
4806 free(fields);
4807 free(model_emf_uri);
4808 goto error_rcu_unlock;
4809 }
4810
4811 assert(ua_chan->session);
4812 ua_sess = ua_chan->session;
4813
4814 registry = get_session_registry(ua_sess);
4815 assert(registry);
4816
4817 if (ua_sess->buffer_type == LTTNG_BUFFER_PER_UID) {
4818 chan_reg_key = ua_chan->tracing_channel_id;
4819 } else {
4820 chan_reg_key = ua_chan->key;
4821 }
4822
4823 pthread_mutex_lock(&registry->lock);
4824
4825 /*
4826 * From this point on, this call acquires the ownership of the sig, fields
4827 * and model_emf_uri meaning any free are done inside it if needed. These
4828 * three variables MUST NOT be read/write after this.
4829 */
4830 ret_code = ust_registry_create_event(registry, chan_reg_key,
4831 sobjd, cobjd, name, sig, nr_fields, fields, loglevel,
4832 model_emf_uri, ua_sess->buffer_type, &event_id,
4833 app);
4834
4835 /*
4836 * The return value is returned to ustctl so in case of an error, the
4837 * application can be notified. In case of an error, it's important not to
4838 * return a negative error or else the application will get closed.
4839 */
4840 ret = ustctl_reply_register_event(sock, event_id, ret_code);
4841 if (ret < 0) {
4842 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4843 ERR("UST app reply event failed with ret %d", ret);
4844 } else {
4845 DBG3("UST app reply event failed. Application died");
4846 }
4847 /*
4848 * No need to wipe the create event since the application socket will
4849 * get close on error hence cleaning up everything by itself.
4850 */
4851 goto error;
4852 }
4853
4854 DBG3("UST registry event %s with id %" PRId32 " added successfully",
4855 name, event_id);
4856
4857 error:
4858 pthread_mutex_unlock(&registry->lock);
4859 error_rcu_unlock:
4860 rcu_read_unlock();
4861 return ret;
4862 }
4863
4864 /*
4865 * Handle application notification through the given notify socket.
4866 *
4867 * Return 0 on success or else a negative value.
4868 */
4869 int ust_app_recv_notify(int sock)
4870 {
4871 int ret;
4872 enum ustctl_notify_cmd cmd;
4873
4874 DBG3("UST app receiving notify from sock %d", sock);
4875
4876 ret = ustctl_recv_notify(sock, &cmd);
4877 if (ret < 0) {
4878 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4879 ERR("UST app recv notify failed with ret %d", ret);
4880 } else {
4881 DBG3("UST app recv notify failed. Application died");
4882 }
4883 goto error;
4884 }
4885
4886 switch (cmd) {
4887 case USTCTL_NOTIFY_CMD_EVENT:
4888 {
4889 int sobjd, cobjd, loglevel;
4890 char name[LTTNG_UST_SYM_NAME_LEN], *sig, *model_emf_uri;
4891 size_t nr_fields;
4892 struct ustctl_field *fields;
4893
4894 DBG2("UST app ustctl register event received");
4895
4896 ret = ustctl_recv_register_event(sock, &sobjd, &cobjd, name, &loglevel,
4897 &sig, &nr_fields, &fields, &model_emf_uri);
4898 if (ret < 0) {
4899 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4900 ERR("UST app recv event failed with ret %d", ret);
4901 } else {
4902 DBG3("UST app recv event failed. Application died");
4903 }
4904 goto error;
4905 }
4906
4907 /*
4908 * Add event to the UST registry coming from the notify socket. This
4909 * call will free if needed the sig, fields and model_emf_uri. This
4910 * code path loses the ownsership of these variables and transfer them
4911 * to the this function.
4912 */
4913 ret = add_event_ust_registry(sock, sobjd, cobjd, name, sig, nr_fields,
4914 fields, loglevel, model_emf_uri);
4915 if (ret < 0) {
4916 goto error;
4917 }
4918
4919 break;
4920 }
4921 case USTCTL_NOTIFY_CMD_CHANNEL:
4922 {
4923 int sobjd, cobjd;
4924 size_t nr_fields;
4925 struct ustctl_field *fields;
4926
4927 DBG2("UST app ustctl register channel received");
4928
4929 ret = ustctl_recv_register_channel(sock, &sobjd, &cobjd, &nr_fields,
4930 &fields);
4931 if (ret < 0) {
4932 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4933 ERR("UST app recv channel failed with ret %d", ret);
4934 } else {
4935 DBG3("UST app recv channel failed. Application died");
4936 }
4937 goto error;
4938 }
4939
4940 /*
4941 * The fields ownership are transfered to this function call meaning
4942 * that if needed it will be freed. After this, it's invalid to access
4943 * fields or clean it up.
4944 */
4945 ret = reply_ust_register_channel(sock, sobjd, cobjd, nr_fields,
4946 fields);
4947 if (ret < 0) {
4948 goto error;
4949 }
4950
4951 break;
4952 }
4953 default:
4954 /* Should NEVER happen. */
4955 assert(0);
4956 }
4957
4958 error:
4959 return ret;
4960 }
4961
4962 /*
4963 * Once the notify socket hangs up, this is called. First, it tries to find the
4964 * corresponding application. On failure, the call_rcu to close the socket is
4965 * executed. If an application is found, it tries to delete it from the notify
4966 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4967 *
4968 * Note that an object needs to be allocated here so on ENOMEM failure, the
4969 * call RCU is not done but the rest of the cleanup is.
4970 */
4971 void ust_app_notify_sock_unregister(int sock)
4972 {
4973 int err_enomem = 0;
4974 struct lttng_ht_iter iter;
4975 struct ust_app *app;
4976 struct ust_app_notify_sock_obj *obj;
4977
4978 assert(sock >= 0);
4979
4980 rcu_read_lock();
4981
4982 obj = zmalloc(sizeof(*obj));
4983 if (!obj) {
4984 /*
4985 * An ENOMEM is kind of uncool. If this strikes we continue the
4986 * procedure but the call_rcu will not be called. In this case, we
4987 * accept the fd leak rather than possibly creating an unsynchronized
4988 * state between threads.
4989 *
4990 * TODO: The notify object should be created once the notify socket is
4991 * registered and stored independantely from the ust app object. The
4992 * tricky part is to synchronize the teardown of the application and
4993 * this notify object. Let's keep that in mind so we can avoid this
4994 * kind of shenanigans with ENOMEM in the teardown path.
4995 */
4996 err_enomem = 1;
4997 } else {
4998 obj->fd = sock;
4999 }
5000
5001 DBG("UST app notify socket unregister %d", sock);
5002
5003 /*
5004 * Lookup application by notify socket. If this fails, this means that the
5005 * hash table delete has already been done by the application
5006 * unregistration process so we can safely close the notify socket in a
5007 * call RCU.
5008 */
5009 app = find_app_by_notify_sock(sock);
5010 if (!app) {
5011 goto close_socket;
5012 }
5013
5014 iter.iter.node = &app->notify_sock_n.node;
5015
5016 /*
5017 * Whatever happens here either we fail or succeed, in both cases we have
5018 * to close the socket after a grace period to continue to the call RCU
5019 * here. If the deletion is successful, the application is not visible
5020 * anymore by other threads and is it fails it means that it was already
5021 * deleted from the hash table so either way we just have to close the
5022 * socket.
5023 */
5024 (void) lttng_ht_del(ust_app_ht_by_notify_sock, &iter);
5025
5026 close_socket:
5027 rcu_read_unlock();
5028
5029 /*
5030 * Close socket after a grace period to avoid for the socket to be reused
5031 * before the application object is freed creating potential race between
5032 * threads trying to add unique in the global hash table.
5033 */
5034 if (!err_enomem) {
5035 call_rcu(&obj->head, close_notify_sock_rcu);
5036 }
5037 }
5038
5039 /*
5040 * Destroy a ust app data structure and free its memory.
5041 */
5042 void ust_app_destroy(struct ust_app *app)
5043 {
5044 if (!app) {
5045 return;
5046 }
5047
5048 call_rcu(&app->pid_n.head, delete_ust_app_rcu);
5049 }
5050
5051 /*
5052 * Take a snapshot for a given UST session. The snapshot is sent to the given
5053 * output.
5054 *
5055 * Return 0 on success or else a negative value.
5056 */
5057 int ust_app_snapshot_record(struct ltt_ust_session *usess,
5058 struct snapshot_output *output, int wait,
5059 uint64_t nb_packets_per_stream)
5060 {
5061 int ret = 0;
5062 unsigned int snapshot_done = 0;
5063 struct lttng_ht_iter iter;
5064 struct ust_app *app;
5065 char pathname[PATH_MAX];
5066
5067 assert(usess);
5068 assert(output);
5069
5070 rcu_read_lock();
5071
5072 switch (usess->buffer_type) {
5073 case LTTNG_BUFFER_PER_UID:
5074 {
5075 struct buffer_reg_uid *reg;
5076
5077 cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
5078 struct buffer_reg_channel *reg_chan;
5079 struct consumer_socket *socket;
5080
5081 /* Get consumer socket to use to push the metadata.*/
5082 socket = consumer_find_socket_by_bitness(reg->bits_per_long,
5083 usess->consumer);
5084 if (!socket) {
5085 ret = -EINVAL;
5086 goto error;
5087 }
5088
5089 memset(pathname, 0, sizeof(pathname));
5090 ret = snprintf(pathname, sizeof(pathname),
5091 DEFAULT_UST_TRACE_DIR "/" DEFAULT_UST_TRACE_UID_PATH,
5092 reg->uid, reg->bits_per_long);
5093 if (ret < 0) {
5094 PERROR("snprintf snapshot path");
5095 goto error;
5096 }
5097
5098 /* Add the UST default trace dir to path. */
5099 cds_lfht_for_each_entry(reg->registry->channels->ht, &iter.iter,
5100 reg_chan, node.node) {
5101 ret = consumer_snapshot_channel(socket, reg_chan->consumer_key,
5102 output, 0, usess->uid, usess->gid, pathname, wait,
5103 nb_packets_per_stream);
5104 if (ret < 0) {
5105 goto error;
5106 }
5107 }
5108 ret = consumer_snapshot_channel(socket,
5109 reg->registry->reg.ust->metadata_key, output, 1,
5110 usess->uid, usess->gid, pathname, wait, 0);
5111 if (ret < 0) {
5112 goto error;
5113 }
5114 snapshot_done = 1;
5115 }
5116 break;
5117 }
5118 case LTTNG_BUFFER_PER_PID:
5119 {
5120 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
5121 struct consumer_socket *socket;
5122 struct lttng_ht_iter chan_iter;
5123 struct ust_app_channel *ua_chan;
5124 struct ust_app_session *ua_sess;
5125 struct ust_registry_session *registry;
5126
5127 ua_sess = lookup_session_by_app(usess, app);
5128 if (!ua_sess) {
5129 /* Session not associated with this app. */
5130 continue;
5131 }
5132
5133 /* Get the right consumer socket for the application. */
5134 socket = consumer_find_socket_by_bitness(app->bits_per_long,
5135 output->consumer);
5136 if (!socket) {
5137 ret = -EINVAL;
5138 goto error;
5139 }
5140
5141 /* Add the UST default trace dir to path. */
5142 memset(pathname, 0, sizeof(pathname));
5143 ret = snprintf(pathname, sizeof(pathname), DEFAULT_UST_TRACE_DIR "/%s",
5144 ua_sess->path);
5145 if (ret < 0) {
5146 PERROR("snprintf snapshot path");
5147 goto error;
5148 }
5149
5150 cds_lfht_for_each_entry(ua_sess->channels->ht, &chan_iter.iter,
5151 ua_chan, node.node) {
5152 ret = consumer_snapshot_channel(socket, ua_chan->key, output,
5153 0, ua_sess->euid, ua_sess->egid, pathname, wait,
5154 nb_packets_per_stream);
5155 if (ret < 0) {
5156 goto error;
5157 }
5158 }
5159
5160 registry = get_session_registry(ua_sess);
5161 assert(registry);
5162 ret = consumer_snapshot_channel(socket, registry->metadata_key, output,
5163 1, ua_sess->euid, ua_sess->egid, pathname, wait, 0);
5164 if (ret < 0) {
5165 goto error;
5166 }
5167 snapshot_done = 1;
5168 }
5169 break;
5170 }
5171 default:
5172 assert(0);
5173 break;
5174 }
5175
5176 if (!snapshot_done) {
5177 /*
5178 * If no snapshot was made and we are not in the error path, this means
5179 * that there are no buffers thus no (prior) application to snapshot
5180 * data from so we have simply NO data.
5181 */
5182 ret = -ENODATA;
5183 }
5184
5185 error:
5186 rcu_read_unlock();
5187 return ret;
5188 }
5189
5190 /*
5191 * Return the size taken by one more packet per stream.
5192 */
5193 uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session *usess,
5194 uint64_t cur_nr_packets)
5195 {
5196 uint64_t tot_size = 0;
5197 struct ust_app *app;
5198 struct lttng_ht_iter iter;
5199
5200 assert(usess);
5201
5202 switch (usess->buffer_type) {
5203 case LTTNG_BUFFER_PER_UID:
5204 {
5205 struct buffer_reg_uid *reg;
5206
5207 cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
5208 struct buffer_reg_channel *reg_chan;
5209
5210 rcu_read_lock();
5211 cds_lfht_for_each_entry(reg->registry->channels->ht, &iter.iter,
5212 reg_chan, node.node) {
5213 if (cur_nr_packets >= reg_chan->num_subbuf) {
5214 /*
5215 * Don't take channel into account if we
5216 * already grab all its packets.
5217 */
5218 continue;
5219 }
5220 tot_size += reg_chan->subbuf_size * reg_chan->stream_count;
5221 }
5222 rcu_read_unlock();
5223 }
5224 break;
5225 }
5226 case LTTNG_BUFFER_PER_PID:
5227 {
5228 rcu_read_lock();
5229 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
5230 struct ust_app_channel *ua_chan;
5231 struct ust_app_session *ua_sess;
5232 struct lttng_ht_iter chan_iter;
5233
5234 ua_sess = lookup_session_by_app(usess, app);
5235 if (!ua_sess) {
5236 /* Session not associated with this app. */
5237 continue;
5238 }
5239
5240 cds_lfht_for_each_entry(ua_sess->channels->ht, &chan_iter.iter,
5241 ua_chan, node.node) {
5242 if (cur_nr_packets >= ua_chan->attr.num_subbuf) {
5243 /*
5244 * Don't take channel into account if we
5245 * already grab all its packets.
5246 */
5247 continue;
5248 }
5249 tot_size += ua_chan->attr.subbuf_size * ua_chan->streams.count;
5250 }
5251 }
5252 rcu_read_unlock();
5253 break;
5254 }
5255 default:
5256 assert(0);
5257 break;
5258 }
5259
5260 return tot_size;
5261 }
This page took 0.138648 seconds and 5 git commands to generate.