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 goto error;
2546 }
2547 assert(reg_chan);
2548
2549 /*
2550 * Create the buffers on the consumer side. This call populates the
2551 * ust app channel object with all streams and data object.
2552 */
2553 ret = do_consumer_create_channel(usess, ua_sess, ua_chan,
2554 app->bits_per_long, reg_uid->registry->reg.ust);
2555 if (ret < 0) {
2556 /*
2557 * Let's remove the previously created buffer registry channel so
2558 * it's not visible anymore in the session registry.
2559 */
2560 ust_registry_channel_del_free(reg_uid->registry->reg.ust,
2561 ua_chan->tracing_channel_id);
2562 buffer_reg_channel_remove(reg_uid->registry, reg_chan);
2563 buffer_reg_channel_destroy(reg_chan, LTTNG_DOMAIN_UST);
2564 goto error;
2565 }
2566
2567 /*
2568 * Setup the streams and add it to the session registry.
2569 */
2570 ret = setup_buffer_reg_channel(reg_uid->registry, ua_chan, reg_chan);
2571 if (ret < 0) {
2572 goto error;
2573 }
2574
2575 }
2576
2577 /* Send buffers to the application. */
2578 ret = send_channel_uid_to_ust(reg_chan, app, ua_sess, ua_chan);
2579 if (ret < 0) {
2580 goto error;
2581 }
2582
2583 error:
2584 return ret;
2585 }
2586
2587 /*
2588 * Create and send to the application the created buffers with per PID buffers.
2589 *
2590 * Return 0 on success else a negative value.
2591 */
2592 static int create_channel_per_pid(struct ust_app *app,
2593 struct ltt_ust_session *usess, struct ust_app_session *ua_sess,
2594 struct ust_app_channel *ua_chan)
2595 {
2596 int ret;
2597 struct ust_registry_session *registry;
2598
2599 assert(app);
2600 assert(usess);
2601 assert(ua_sess);
2602 assert(ua_chan);
2603
2604 DBG("UST app creating channel %s with per PID buffers", ua_chan->name);
2605
2606 rcu_read_lock();
2607
2608 registry = get_session_registry(ua_sess);
2609 assert(registry);
2610
2611 /* Create and add a new channel registry to session. */
2612 ret = ust_registry_channel_add(registry, ua_chan->key);
2613 if (ret < 0) {
2614 goto error;
2615 }
2616
2617 /* Create and get channel on the consumer side. */
2618 ret = do_consumer_create_channel(usess, ua_sess, ua_chan,
2619 app->bits_per_long, registry);
2620 if (ret < 0) {
2621 goto error;
2622 }
2623
2624 ret = send_channel_pid_to_ust(app, ua_sess, ua_chan);
2625 if (ret < 0) {
2626 goto error;
2627 }
2628
2629 error:
2630 rcu_read_unlock();
2631 return ret;
2632 }
2633
2634 /*
2635 * From an already allocated ust app channel, create the channel buffers if
2636 * need and send it to the application. This MUST be called with a RCU read
2637 * side lock acquired.
2638 *
2639 * Return 0 on success or else a negative value.
2640 */
2641 static int do_create_channel(struct ust_app *app,
2642 struct ltt_ust_session *usess, struct ust_app_session *ua_sess,
2643 struct ust_app_channel *ua_chan)
2644 {
2645 int ret;
2646
2647 assert(app);
2648 assert(usess);
2649 assert(ua_sess);
2650 assert(ua_chan);
2651
2652 /* Handle buffer type before sending the channel to the application. */
2653 switch (usess->buffer_type) {
2654 case LTTNG_BUFFER_PER_UID:
2655 {
2656 ret = create_channel_per_uid(app, usess, ua_sess, ua_chan);
2657 if (ret < 0) {
2658 goto error;
2659 }
2660 break;
2661 }
2662 case LTTNG_BUFFER_PER_PID:
2663 {
2664 ret = create_channel_per_pid(app, usess, ua_sess, ua_chan);
2665 if (ret < 0) {
2666 goto error;
2667 }
2668 break;
2669 }
2670 default:
2671 assert(0);
2672 ret = -EINVAL;
2673 goto error;
2674 }
2675
2676 /* Initialize ust objd object using the received handle and add it. */
2677 lttng_ht_node_init_ulong(&ua_chan->ust_objd_node, ua_chan->handle);
2678 lttng_ht_add_unique_ulong(app->ust_objd, &ua_chan->ust_objd_node);
2679
2680 /* If channel is not enabled, disable it on the tracer */
2681 if (!ua_chan->enabled) {
2682 ret = disable_ust_channel(app, ua_sess, ua_chan);
2683 if (ret < 0) {
2684 goto error;
2685 }
2686 }
2687
2688 error:
2689 return ret;
2690 }
2691
2692 /*
2693 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2694 * newly created channel if not NULL.
2695 *
2696 * Called with UST app session lock and RCU read-side lock held.
2697 *
2698 * Return 0 on success or else a negative value.
2699 */
2700 static int create_ust_app_channel(struct ust_app_session *ua_sess,
2701 struct ltt_ust_channel *uchan, struct ust_app *app,
2702 enum lttng_ust_chan_type type, struct ltt_ust_session *usess,
2703 struct ust_app_channel **ua_chanp)
2704 {
2705 int ret = 0;
2706 struct lttng_ht_iter iter;
2707 struct lttng_ht_node_str *ua_chan_node;
2708 struct ust_app_channel *ua_chan;
2709
2710 /* Lookup channel in the ust app session */
2711 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &iter);
2712 ua_chan_node = lttng_ht_iter_get_node_str(&iter);
2713 if (ua_chan_node != NULL) {
2714 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
2715 goto end;
2716 }
2717
2718 ua_chan = alloc_ust_app_channel(uchan->name, ua_sess, &uchan->attr);
2719 if (ua_chan == NULL) {
2720 /* Only malloc can fail here */
2721 ret = -ENOMEM;
2722 goto error_alloc;
2723 }
2724 shadow_copy_channel(ua_chan, uchan);
2725
2726 /* Set channel type. */
2727 ua_chan->attr.type = type;
2728
2729 ret = do_create_channel(app, usess, ua_sess, ua_chan);
2730 if (ret < 0) {
2731 goto error;
2732 }
2733
2734 DBG2("UST app create channel %s for PID %d completed", ua_chan->name,
2735 app->pid);
2736
2737 /* Only add the channel if successful on the tracer side. */
2738 lttng_ht_add_unique_str(ua_sess->channels, &ua_chan->node);
2739
2740 end:
2741 if (ua_chanp) {
2742 *ua_chanp = ua_chan;
2743 }
2744
2745 /* Everything went well. */
2746 return 0;
2747
2748 error:
2749 delete_ust_app_channel(ua_chan->is_sent ? app->sock : -1, ua_chan, app);
2750 error_alloc:
2751 return ret;
2752 }
2753
2754 /*
2755 * Create UST app event and create it on the tracer side.
2756 *
2757 * Called with ust app session mutex held.
2758 */
2759 static
2760 int create_ust_app_event(struct ust_app_session *ua_sess,
2761 struct ust_app_channel *ua_chan, struct ltt_ust_event *uevent,
2762 struct ust_app *app)
2763 {
2764 int ret = 0;
2765 struct ust_app_event *ua_event;
2766
2767 /* Get event node */
2768 ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
2769 uevent->filter, uevent->attr.loglevel, uevent->exclusion);
2770 if (ua_event != NULL) {
2771 ret = -EEXIST;
2772 goto end;
2773 }
2774
2775 /* Does not exist so create one */
2776 ua_event = alloc_ust_app_event(uevent->attr.name, &uevent->attr);
2777 if (ua_event == NULL) {
2778 /* Only malloc can failed so something is really wrong */
2779 ret = -ENOMEM;
2780 goto end;
2781 }
2782 shadow_copy_event(ua_event, uevent);
2783
2784 /* Create it on the tracer side */
2785 ret = create_ust_event(app, ua_sess, ua_chan, ua_event);
2786 if (ret < 0) {
2787 /* Not found previously means that it does not exist on the tracer */
2788 assert(ret != -LTTNG_UST_ERR_EXIST);
2789 goto error;
2790 }
2791
2792 add_unique_ust_app_event(ua_chan, ua_event);
2793
2794 DBG2("UST app create event %s for PID %d completed", ua_event->name,
2795 app->pid);
2796
2797 end:
2798 return ret;
2799
2800 error:
2801 /* Valid. Calling here is already in a read side lock */
2802 delete_ust_app_event(-1, ua_event);
2803 return ret;
2804 }
2805
2806 /*
2807 * Create UST metadata and open it on the tracer side.
2808 *
2809 * Called with UST app session lock held and RCU read side lock.
2810 */
2811 static int create_ust_app_metadata(struct ust_app_session *ua_sess,
2812 struct ust_app *app, struct consumer_output *consumer)
2813 {
2814 int ret = 0;
2815 struct ust_app_channel *metadata;
2816 struct consumer_socket *socket;
2817 struct ust_registry_session *registry;
2818
2819 assert(ua_sess);
2820 assert(app);
2821 assert(consumer);
2822
2823 registry = get_session_registry(ua_sess);
2824 assert(registry);
2825
2826 pthread_mutex_lock(&registry->lock);
2827
2828 /* Metadata already exists for this registry or it was closed previously */
2829 if (registry->metadata_key || registry->metadata_closed) {
2830 ret = 0;
2831 goto error;
2832 }
2833
2834 /* Allocate UST metadata */
2835 metadata = alloc_ust_app_channel(DEFAULT_METADATA_NAME, ua_sess, NULL);
2836 if (!metadata) {
2837 /* malloc() failed */
2838 ret = -ENOMEM;
2839 goto error;
2840 }
2841
2842 memcpy(&metadata->attr, &ua_sess->metadata_attr, sizeof(metadata->attr));
2843
2844 /* Need one fd for the channel. */
2845 ret = lttng_fd_get(LTTNG_FD_APPS, 1);
2846 if (ret < 0) {
2847 ERR("Exhausted number of available FD upon create metadata");
2848 goto error;
2849 }
2850
2851 /* Get the right consumer socket for the application. */
2852 socket = consumer_find_socket_by_bitness(app->bits_per_long, consumer);
2853 if (!socket) {
2854 ret = -EINVAL;
2855 goto error_consumer;
2856 }
2857
2858 /*
2859 * Keep metadata key so we can identify it on the consumer side. Assign it
2860 * to the registry *before* we ask the consumer so we avoid the race of the
2861 * consumer requesting the metadata and the ask_channel call on our side
2862 * did not returned yet.
2863 */
2864 registry->metadata_key = metadata->key;
2865
2866 /*
2867 * Ask the metadata channel creation to the consumer. The metadata object
2868 * will be created by the consumer and kept their. However, the stream is
2869 * never added or monitored until we do a first push metadata to the
2870 * consumer.
2871 */
2872 ret = ust_consumer_ask_channel(ua_sess, metadata, consumer, socket,
2873 registry);
2874 if (ret < 0) {
2875 /* Nullify the metadata key so we don't try to close it later on. */
2876 registry->metadata_key = 0;
2877 goto error_consumer;
2878 }
2879
2880 /*
2881 * The setup command will make the metadata stream be sent to the relayd,
2882 * if applicable, and the thread managing the metadatas. This is important
2883 * because after this point, if an error occurs, the only way the stream
2884 * can be deleted is to be monitored in the consumer.
2885 */
2886 ret = consumer_setup_metadata(socket, metadata->key);
2887 if (ret < 0) {
2888 /* Nullify the metadata key so we don't try to close it later on. */
2889 registry->metadata_key = 0;
2890 goto error_consumer;
2891 }
2892
2893 DBG2("UST metadata with key %" PRIu64 " created for app pid %d",
2894 metadata->key, app->pid);
2895
2896 error_consumer:
2897 lttng_fd_put(LTTNG_FD_APPS, 1);
2898 delete_ust_app_channel(-1, metadata, app);
2899 error:
2900 pthread_mutex_unlock(&registry->lock);
2901 return ret;
2902 }
2903
2904 /*
2905 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2906 * acquired before calling this function.
2907 */
2908 struct ust_app *ust_app_find_by_pid(pid_t pid)
2909 {
2910 struct ust_app *app = NULL;
2911 struct lttng_ht_node_ulong *node;
2912 struct lttng_ht_iter iter;
2913
2914 lttng_ht_lookup(ust_app_ht, (void *)((unsigned long) pid), &iter);
2915 node = lttng_ht_iter_get_node_ulong(&iter);
2916 if (node == NULL) {
2917 DBG2("UST app no found with pid %d", pid);
2918 goto error;
2919 }
2920
2921 DBG2("Found UST app by pid %d", pid);
2922
2923 app = caa_container_of(node, struct ust_app, pid_n);
2924
2925 error:
2926 return app;
2927 }
2928
2929 /*
2930 * Allocate and init an UST app object using the registration information and
2931 * the command socket. This is called when the command socket connects to the
2932 * session daemon.
2933 *
2934 * The object is returned on success or else NULL.
2935 */
2936 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
2937 {
2938 struct ust_app *lta = NULL;
2939
2940 assert(msg);
2941 assert(sock >= 0);
2942
2943 DBG3("UST app creating application for socket %d", sock);
2944
2945 if ((msg->bits_per_long == 64 &&
2946 (uatomic_read(&ust_consumerd64_fd) == -EINVAL))
2947 || (msg->bits_per_long == 32 &&
2948 (uatomic_read(&ust_consumerd32_fd) == -EINVAL))) {
2949 ERR("Registration failed: application \"%s\" (pid: %d) has "
2950 "%d-bit long, but no consumerd for this size is available.\n",
2951 msg->name, msg->pid, msg->bits_per_long);
2952 goto error;
2953 }
2954
2955 lta = zmalloc(sizeof(struct ust_app));
2956 if (lta == NULL) {
2957 PERROR("malloc");
2958 goto error;
2959 }
2960
2961 lta->ppid = msg->ppid;
2962 lta->uid = msg->uid;
2963 lta->gid = msg->gid;
2964
2965 lta->bits_per_long = msg->bits_per_long;
2966 lta->uint8_t_alignment = msg->uint8_t_alignment;
2967 lta->uint16_t_alignment = msg->uint16_t_alignment;
2968 lta->uint32_t_alignment = msg->uint32_t_alignment;
2969 lta->uint64_t_alignment = msg->uint64_t_alignment;
2970 lta->long_alignment = msg->long_alignment;
2971 lta->byte_order = msg->byte_order;
2972
2973 lta->v_major = msg->major;
2974 lta->v_minor = msg->minor;
2975 lta->sessions = lttng_ht_new(0, LTTNG_HT_TYPE_U64);
2976 lta->ust_objd = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
2977 lta->notify_sock = -1;
2978
2979 /* Copy name and make sure it's NULL terminated. */
2980 strncpy(lta->name, msg->name, sizeof(lta->name));
2981 lta->name[UST_APP_PROCNAME_LEN] = '\0';
2982
2983 /*
2984 * Before this can be called, when receiving the registration information,
2985 * the application compatibility is checked. So, at this point, the
2986 * application can work with this session daemon.
2987 */
2988 lta->compatible = 1;
2989
2990 lta->pid = msg->pid;
2991 lttng_ht_node_init_ulong(&lta->pid_n, (unsigned long) lta->pid);
2992 lta->sock = sock;
2993 lttng_ht_node_init_ulong(&lta->sock_n, (unsigned long) lta->sock);
2994
2995 CDS_INIT_LIST_HEAD(&lta->teardown_head);
2996
2997 error:
2998 return lta;
2999 }
3000
3001 /*
3002 * For a given application object, add it to every hash table.
3003 */
3004 void ust_app_add(struct ust_app *app)
3005 {
3006 assert(app);
3007 assert(app->notify_sock >= 0);
3008
3009 rcu_read_lock();
3010
3011 /*
3012 * On a re-registration, we want to kick out the previous registration of
3013 * that pid
3014 */
3015 lttng_ht_add_replace_ulong(ust_app_ht, &app->pid_n);
3016
3017 /*
3018 * The socket _should_ be unique until _we_ call close. So, a add_unique
3019 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3020 * already in the table.
3021 */
3022 lttng_ht_add_unique_ulong(ust_app_ht_by_sock, &app->sock_n);
3023
3024 /* Add application to the notify socket hash table. */
3025 lttng_ht_node_init_ulong(&app->notify_sock_n, app->notify_sock);
3026 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock, &app->notify_sock_n);
3027
3028 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3029 "notify_sock:%d (version %d.%d)", app->pid, app->ppid, app->uid,
3030 app->gid, app->sock, app->name, app->notify_sock, app->v_major,
3031 app->v_minor);
3032
3033 rcu_read_unlock();
3034 }
3035
3036 /*
3037 * Set the application version into the object.
3038 *
3039 * Return 0 on success else a negative value either an errno code or a
3040 * LTTng-UST error code.
3041 */
3042 int ust_app_version(struct ust_app *app)
3043 {
3044 int ret;
3045
3046 assert(app);
3047
3048 ret = ustctl_tracer_version(app->sock, &app->version);
3049 if (ret < 0) {
3050 if (ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
3051 ERR("UST app %d version failed with ret %d", app->sock, ret);
3052 } else {
3053 DBG3("UST app %d version failed. Application is dead", app->sock);
3054 }
3055 }
3056
3057 return ret;
3058 }
3059
3060 /*
3061 * Unregister app by removing it from the global traceable app list and freeing
3062 * the data struct.
3063 *
3064 * The socket is already closed at this point so no close to sock.
3065 */
3066 void ust_app_unregister(int sock)
3067 {
3068 struct ust_app *lta;
3069 struct lttng_ht_node_ulong *node;
3070 struct lttng_ht_iter ust_app_sock_iter;
3071 struct lttng_ht_iter iter;
3072 struct ust_app_session *ua_sess;
3073 int ret;
3074
3075 rcu_read_lock();
3076
3077 /* Get the node reference for a call_rcu */
3078 lttng_ht_lookup(ust_app_ht_by_sock, (void *)((unsigned long) sock), &ust_app_sock_iter);
3079 node = lttng_ht_iter_get_node_ulong(&ust_app_sock_iter);
3080 assert(node);
3081
3082 lta = caa_container_of(node, struct ust_app, sock_n);
3083 DBG("PID %d unregistering with sock %d", lta->pid, sock);
3084
3085 /*
3086 * For per-PID buffers, perform "push metadata" and flush all
3087 * application streams before removing app from hash tables,
3088 * ensuring proper behavior of data_pending check.
3089 * Remove sessions so they are not visible during deletion.
3090 */
3091 cds_lfht_for_each_entry(lta->sessions->ht, &iter.iter, ua_sess,
3092 node.node) {
3093 struct ust_registry_session *registry;
3094
3095 ret = lttng_ht_del(lta->sessions, &iter);
3096 if (ret) {
3097 /* The session was already removed so scheduled for teardown. */
3098 continue;
3099 }
3100
3101 if (ua_sess->buffer_type == LTTNG_BUFFER_PER_PID) {
3102 (void) ust_app_flush_app_session(lta, ua_sess);
3103 }
3104
3105 /*
3106 * Add session to list for teardown. This is safe since at this point we
3107 * are the only one using this list.
3108 */
3109 pthread_mutex_lock(&ua_sess->lock);
3110
3111 /*
3112 * Normally, this is done in the delete session process which is
3113 * executed in the call rcu below. However, upon registration we can't
3114 * afford to wait for the grace period before pushing data or else the
3115 * data pending feature can race between the unregistration and stop
3116 * command where the data pending command is sent *before* the grace
3117 * period ended.
3118 *
3119 * The close metadata below nullifies the metadata pointer in the
3120 * session so the delete session will NOT push/close a second time.
3121 */
3122 registry = get_session_registry(ua_sess);
3123 if (registry) {
3124 /* Push metadata for application before freeing the application. */
3125 (void) push_metadata(registry, ua_sess->consumer);
3126
3127 /*
3128 * Don't ask to close metadata for global per UID buffers. Close
3129 * metadata only on destroy trace session in this case. Also, the
3130 * previous push metadata could have flag the metadata registry to
3131 * close so don't send a close command if closed.
3132 */
3133 if (ua_sess->buffer_type != LTTNG_BUFFER_PER_UID) {
3134 /* And ask to close it for this session registry. */
3135 (void) close_metadata(registry, ua_sess->consumer);
3136 }
3137 }
3138 cds_list_add(&ua_sess->teardown_node, &lta->teardown_head);
3139
3140 pthread_mutex_unlock(&ua_sess->lock);
3141 }
3142
3143 /* Remove application from PID hash table */
3144 ret = lttng_ht_del(ust_app_ht_by_sock, &ust_app_sock_iter);
3145 assert(!ret);
3146
3147 /*
3148 * Remove application from notify hash table. The thread handling the
3149 * notify socket could have deleted the node so ignore on error because
3150 * either way it's valid. The close of that socket is handled by the other
3151 * thread.
3152 */
3153 iter.iter.node = &lta->notify_sock_n.node;
3154 (void) lttng_ht_del(ust_app_ht_by_notify_sock, &iter);
3155
3156 /*
3157 * Ignore return value since the node might have been removed before by an
3158 * add replace during app registration because the PID can be reassigned by
3159 * the OS.
3160 */
3161 iter.iter.node = &lta->pid_n.node;
3162 ret = lttng_ht_del(ust_app_ht, &iter);
3163 if (ret) {
3164 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3165 lta->pid);
3166 }
3167
3168 /* Free memory */
3169 call_rcu(&lta->pid_n.head, delete_ust_app_rcu);
3170
3171 rcu_read_unlock();
3172 return;
3173 }
3174
3175 /*
3176 * Fill events array with all events name of all registered apps.
3177 */
3178 int ust_app_list_events(struct lttng_event **events)
3179 {
3180 int ret, handle;
3181 size_t nbmem, count = 0;
3182 struct lttng_ht_iter iter;
3183 struct ust_app *app;
3184 struct lttng_event *tmp_event;
3185
3186 nbmem = UST_APP_EVENT_LIST_SIZE;
3187 tmp_event = zmalloc(nbmem * sizeof(struct lttng_event));
3188 if (tmp_event == NULL) {
3189 PERROR("zmalloc ust app events");
3190 ret = -ENOMEM;
3191 goto error;
3192 }
3193
3194 rcu_read_lock();
3195
3196 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3197 struct lttng_ust_tracepoint_iter uiter;
3198
3199 health_code_update();
3200
3201 if (!app->compatible) {
3202 /*
3203 * TODO: In time, we should notice the caller of this error by
3204 * telling him that this is a version error.
3205 */
3206 continue;
3207 }
3208 handle = ustctl_tracepoint_list(app->sock);
3209 if (handle < 0) {
3210 if (handle != -EPIPE && handle != -LTTNG_UST_ERR_EXITING) {
3211 ERR("UST app list events getting handle failed for app pid %d",
3212 app->pid);
3213 }
3214 continue;
3215 }
3216
3217 while ((ret = ustctl_tracepoint_list_get(app->sock, handle,
3218 &uiter)) != -LTTNG_UST_ERR_NOENT) {
3219 /* Handle ustctl error. */
3220 if (ret < 0) {
3221 if (ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
3222 ERR("UST app tp list get failed for app %d with ret %d",
3223 app->sock, ret);
3224 } else {
3225 DBG3("UST app tp list get failed. Application is dead");
3226 /*
3227 * This is normal behavior, an application can die during the
3228 * creation process. Don't report an error so the execution can
3229 * continue normally. Continue normal execution.
3230 */
3231 break;
3232 }
3233 free(tmp_event);
3234 goto rcu_error;
3235 }
3236
3237 health_code_update();
3238 if (count >= nbmem) {
3239 /* In case the realloc fails, we free the memory */
3240 struct lttng_event *new_tmp_event;
3241 size_t new_nbmem;
3242
3243 new_nbmem = nbmem << 1;
3244 DBG2("Reallocating event list from %zu to %zu entries",
3245 nbmem, new_nbmem);
3246 new_tmp_event = realloc(tmp_event,
3247 new_nbmem * sizeof(struct lttng_event));
3248 if (new_tmp_event == NULL) {
3249 PERROR("realloc ust app events");
3250 free(tmp_event);
3251 ret = -ENOMEM;
3252 goto rcu_error;
3253 }
3254 /* Zero the new memory */
3255 memset(new_tmp_event + nbmem, 0,
3256 (new_nbmem - nbmem) * sizeof(struct lttng_event));
3257 nbmem = new_nbmem;
3258 tmp_event = new_tmp_event;
3259 }
3260 memcpy(tmp_event[count].name, uiter.name, LTTNG_UST_SYM_NAME_LEN);
3261 tmp_event[count].loglevel = uiter.loglevel;
3262 tmp_event[count].type = (enum lttng_event_type) LTTNG_UST_TRACEPOINT;
3263 tmp_event[count].pid = app->pid;
3264 tmp_event[count].enabled = -1;
3265 count++;
3266 }
3267 }
3268
3269 ret = count;
3270 *events = tmp_event;
3271
3272 DBG2("UST app list events done (%zu events)", count);
3273
3274 rcu_error:
3275 rcu_read_unlock();
3276 error:
3277 health_code_update();
3278 return ret;
3279 }
3280
3281 /*
3282 * Fill events array with all events name of all registered apps.
3283 */
3284 int ust_app_list_event_fields(struct lttng_event_field **fields)
3285 {
3286 int ret, handle;
3287 size_t nbmem, count = 0;
3288 struct lttng_ht_iter iter;
3289 struct ust_app *app;
3290 struct lttng_event_field *tmp_event;
3291
3292 nbmem = UST_APP_EVENT_LIST_SIZE;
3293 tmp_event = zmalloc(nbmem * sizeof(struct lttng_event_field));
3294 if (tmp_event == NULL) {
3295 PERROR("zmalloc ust app event fields");
3296 ret = -ENOMEM;
3297 goto error;
3298 }
3299
3300 rcu_read_lock();
3301
3302 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3303 struct lttng_ust_field_iter uiter;
3304
3305 health_code_update();
3306
3307 if (!app->compatible) {
3308 /*
3309 * TODO: In time, we should notice the caller of this error by
3310 * telling him that this is a version error.
3311 */
3312 continue;
3313 }
3314 handle = ustctl_tracepoint_field_list(app->sock);
3315 if (handle < 0) {
3316 if (handle != -EPIPE && handle != -LTTNG_UST_ERR_EXITING) {
3317 ERR("UST app list field getting handle failed for app pid %d",
3318 app->pid);
3319 }
3320 continue;
3321 }
3322
3323 while ((ret = ustctl_tracepoint_field_list_get(app->sock, handle,
3324 &uiter)) != -LTTNG_UST_ERR_NOENT) {
3325 /* Handle ustctl error. */
3326 if (ret < 0) {
3327 if (ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
3328 ERR("UST app tp list field failed for app %d with ret %d",
3329 app->sock, ret);
3330 } else {
3331 DBG3("UST app tp list field failed. Application is dead");
3332 /*
3333 * This is normal behavior, an application can die during the
3334 * creation process. Don't report an error so the execution can
3335 * continue normally. Reset list and count for next app.
3336 */
3337 break;
3338 }
3339 free(tmp_event);
3340 goto rcu_error;
3341 }
3342
3343 health_code_update();
3344 if (count >= nbmem) {
3345 /* In case the realloc fails, we free the memory */
3346 struct lttng_event_field *new_tmp_event;
3347 size_t new_nbmem;
3348
3349 new_nbmem = nbmem << 1;
3350 DBG2("Reallocating event field list from %zu to %zu entries",
3351 nbmem, new_nbmem);
3352 new_tmp_event = realloc(tmp_event,
3353 new_nbmem * sizeof(struct lttng_event_field));
3354 if (new_tmp_event == NULL) {
3355 PERROR("realloc ust app event fields");
3356 free(tmp_event);
3357 ret = -ENOMEM;
3358 goto rcu_error;
3359 }
3360 /* Zero the new memory */
3361 memset(new_tmp_event + nbmem, 0,
3362 (new_nbmem - nbmem) * sizeof(struct lttng_event_field));
3363 nbmem = new_nbmem;
3364 tmp_event = new_tmp_event;
3365 }
3366
3367 memcpy(tmp_event[count].field_name, uiter.field_name, LTTNG_UST_SYM_NAME_LEN);
3368 /* Mapping between these enums matches 1 to 1. */
3369 tmp_event[count].type = (enum lttng_event_field_type) uiter.type;
3370 tmp_event[count].nowrite = uiter.nowrite;
3371
3372 memcpy(tmp_event[count].event.name, uiter.event_name, LTTNG_UST_SYM_NAME_LEN);
3373 tmp_event[count].event.loglevel = uiter.loglevel;
3374 tmp_event[count].event.type = LTTNG_EVENT_TRACEPOINT;
3375 tmp_event[count].event.pid = app->pid;
3376 tmp_event[count].event.enabled = -1;
3377 count++;
3378 }
3379 }
3380
3381 ret = count;
3382 *fields = tmp_event;
3383
3384 DBG2("UST app list event fields done (%zu events)", count);
3385
3386 rcu_error:
3387 rcu_read_unlock();
3388 error:
3389 health_code_update();
3390 return ret;
3391 }
3392
3393 /*
3394 * Free and clean all traceable apps of the global list.
3395 *
3396 * Should _NOT_ be called with RCU read-side lock held.
3397 */
3398 void ust_app_clean_list(void)
3399 {
3400 int ret;
3401 struct ust_app *app;
3402 struct lttng_ht_iter iter;
3403
3404 DBG2("UST app cleaning registered apps hash table");
3405
3406 rcu_read_lock();
3407
3408 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3409 ret = lttng_ht_del(ust_app_ht, &iter);
3410 assert(!ret);
3411 call_rcu(&app->pid_n.head, delete_ust_app_rcu);
3412 }
3413
3414 /* Cleanup socket hash table */
3415 cds_lfht_for_each_entry(ust_app_ht_by_sock->ht, &iter.iter, app,
3416 sock_n.node) {
3417 ret = lttng_ht_del(ust_app_ht_by_sock, &iter);
3418 assert(!ret);
3419 }
3420
3421 /* Cleanup notify socket hash table */
3422 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock->ht, &iter.iter, app,
3423 notify_sock_n.node) {
3424 ret = lttng_ht_del(ust_app_ht_by_notify_sock, &iter);
3425 assert(!ret);
3426 }
3427 rcu_read_unlock();
3428
3429 /* Destroy is done only when the ht is empty */
3430 ht_cleanup_push(ust_app_ht);
3431 ht_cleanup_push(ust_app_ht_by_sock);
3432 ht_cleanup_push(ust_app_ht_by_notify_sock);
3433 }
3434
3435 /*
3436 * Init UST app hash table.
3437 */
3438 void ust_app_ht_alloc(void)
3439 {
3440 ust_app_ht = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
3441 ust_app_ht_by_sock = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
3442 ust_app_ht_by_notify_sock = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
3443 }
3444
3445 /*
3446 * For a specific UST session, disable the channel for all registered apps.
3447 */
3448 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
3449 struct ltt_ust_channel *uchan)
3450 {
3451 int ret = 0;
3452 struct lttng_ht_iter iter;
3453 struct lttng_ht_node_str *ua_chan_node;
3454 struct ust_app *app;
3455 struct ust_app_session *ua_sess;
3456 struct ust_app_channel *ua_chan;
3457
3458 if (usess == NULL || uchan == NULL) {
3459 ERR("Disabling UST global channel with NULL values");
3460 ret = -1;
3461 goto error;
3462 }
3463
3464 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64,
3465 uchan->name, usess->id);
3466
3467 rcu_read_lock();
3468
3469 /* For every registered applications */
3470 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3471 struct lttng_ht_iter uiter;
3472 if (!app->compatible) {
3473 /*
3474 * TODO: In time, we should notice the caller of this error by
3475 * telling him that this is a version error.
3476 */
3477 continue;
3478 }
3479 ua_sess = lookup_session_by_app(usess, app);
3480 if (ua_sess == NULL) {
3481 continue;
3482 }
3483
3484 /* Get channel */
3485 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
3486 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
3487 /* If the session if found for the app, the channel must be there */
3488 assert(ua_chan_node);
3489
3490 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
3491 /* The channel must not be already disabled */
3492 assert(ua_chan->enabled == 1);
3493
3494 /* Disable channel onto application */
3495 ret = disable_ust_app_channel(ua_sess, ua_chan, app);
3496 if (ret < 0) {
3497 /* XXX: We might want to report this error at some point... */
3498 continue;
3499 }
3500 }
3501
3502 rcu_read_unlock();
3503
3504 error:
3505 return ret;
3506 }
3507
3508 /*
3509 * For a specific UST session, enable the channel for all registered apps.
3510 */
3511 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
3512 struct ltt_ust_channel *uchan)
3513 {
3514 int ret = 0;
3515 struct lttng_ht_iter iter;
3516 struct ust_app *app;
3517 struct ust_app_session *ua_sess;
3518
3519 if (usess == NULL || uchan == NULL) {
3520 ERR("Adding UST global channel to NULL values");
3521 ret = -1;
3522 goto error;
3523 }
3524
3525 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64,
3526 uchan->name, usess->id);
3527
3528 rcu_read_lock();
3529
3530 /* For every registered applications */
3531 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3532 if (!app->compatible) {
3533 /*
3534 * TODO: In time, we should notice the caller of this error by
3535 * telling him that this is a version error.
3536 */
3537 continue;
3538 }
3539 ua_sess = lookup_session_by_app(usess, app);
3540 if (ua_sess == NULL) {
3541 continue;
3542 }
3543
3544 /* Enable channel onto application */
3545 ret = enable_ust_app_channel(ua_sess, uchan, app);
3546 if (ret < 0) {
3547 /* XXX: We might want to report this error at some point... */
3548 continue;
3549 }
3550 }
3551
3552 rcu_read_unlock();
3553
3554 error:
3555 return ret;
3556 }
3557
3558 /*
3559 * Disable an event in a channel and for a specific session.
3560 */
3561 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
3562 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
3563 {
3564 int ret = 0;
3565 struct lttng_ht_iter iter, uiter;
3566 struct lttng_ht_node_str *ua_chan_node, *ua_event_node;
3567 struct ust_app *app;
3568 struct ust_app_session *ua_sess;
3569 struct ust_app_channel *ua_chan;
3570 struct ust_app_event *ua_event;
3571
3572 DBG("UST app disabling event %s for all apps in channel "
3573 "%s for session id %" PRIu64,
3574 uevent->attr.name, uchan->name, usess->id);
3575
3576 rcu_read_lock();
3577
3578 /* For all registered applications */
3579 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3580 if (!app->compatible) {
3581 /*
3582 * TODO: In time, we should notice the caller of this error by
3583 * telling him that this is a version error.
3584 */
3585 continue;
3586 }
3587 ua_sess = lookup_session_by_app(usess, app);
3588 if (ua_sess == NULL) {
3589 /* Next app */
3590 continue;
3591 }
3592
3593 /* Lookup channel in the ust app session */
3594 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
3595 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
3596 if (ua_chan_node == NULL) {
3597 DBG2("Channel %s not found in session id %" PRIu64 " for app pid %d."
3598 "Skipping", uchan->name, usess->id, app->pid);
3599 continue;
3600 }
3601 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
3602
3603 lttng_ht_lookup(ua_chan->events, (void *)uevent->attr.name, &uiter);
3604 ua_event_node = lttng_ht_iter_get_node_str(&uiter);
3605 if (ua_event_node == NULL) {
3606 DBG2("Event %s not found in channel %s for app pid %d."
3607 "Skipping", uevent->attr.name, uchan->name, app->pid);
3608 continue;
3609 }
3610 ua_event = caa_container_of(ua_event_node, struct ust_app_event, node);
3611
3612 ret = disable_ust_app_event(ua_sess, ua_event, app);
3613 if (ret < 0) {
3614 /* XXX: Report error someday... */
3615 continue;
3616 }
3617 }
3618
3619 rcu_read_unlock();
3620
3621 return ret;
3622 }
3623
3624 /*
3625 * For a specific UST session, create the channel for all registered apps.
3626 */
3627 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
3628 struct ltt_ust_channel *uchan)
3629 {
3630 int ret = 0, created;
3631 struct lttng_ht_iter iter;
3632 struct ust_app *app;
3633 struct ust_app_session *ua_sess = NULL;
3634
3635 /* Very wrong code flow */
3636 assert(usess);
3637 assert(uchan);
3638
3639 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64,
3640 uchan->name, usess->id);
3641
3642 rcu_read_lock();
3643
3644 /* For every registered applications */
3645 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3646 if (!app->compatible) {
3647 /*
3648 * TODO: In time, we should notice the caller of this error by
3649 * telling him that this is a version error.
3650 */
3651 continue;
3652 }
3653 /*
3654 * Create session on the tracer side and add it to app session HT. Note
3655 * that if session exist, it will simply return a pointer to the ust
3656 * app session.
3657 */
3658 ret = create_ust_app_session(usess, app, &ua_sess, &created);
3659 if (ret < 0) {
3660 switch (ret) {
3661 case -ENOTCONN:
3662 /*
3663 * The application's socket is not valid. Either a bad socket
3664 * or a timeout on it. We can't inform the caller that for a
3665 * specific app, the session failed so lets continue here.
3666 */
3667 continue;
3668 case -ENOMEM:
3669 default:
3670 goto error_rcu_unlock;
3671 }
3672 }
3673 assert(ua_sess);
3674
3675 pthread_mutex_lock(&ua_sess->lock);
3676 if (!strncmp(uchan->name, DEFAULT_METADATA_NAME,
3677 sizeof(uchan->name))) {
3678 copy_channel_attr_to_ustctl(&ua_sess->metadata_attr, &uchan->attr);
3679 ret = 0;
3680 } else {
3681 /* Create channel onto application. We don't need the chan ref. */
3682 ret = create_ust_app_channel(ua_sess, uchan, app,
3683 LTTNG_UST_CHAN_PER_CPU, usess, NULL);
3684 }
3685 pthread_mutex_unlock(&ua_sess->lock);
3686 if (ret < 0) {
3687 if (ret == -ENOMEM) {
3688 /* No more memory is a fatal error. Stop right now. */
3689 goto error_rcu_unlock;
3690 }
3691 /* Cleanup the created session if it's the case. */
3692 if (created) {
3693 destroy_app_session(app, ua_sess);
3694 }
3695 }
3696 }
3697
3698 error_rcu_unlock:
3699 rcu_read_unlock();
3700 return ret;
3701 }
3702
3703 /*
3704 * Enable event for a specific session and channel on the tracer.
3705 */
3706 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
3707 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
3708 {
3709 int ret = 0;
3710 struct lttng_ht_iter iter, uiter;
3711 struct lttng_ht_node_str *ua_chan_node;
3712 struct ust_app *app;
3713 struct ust_app_session *ua_sess;
3714 struct ust_app_channel *ua_chan;
3715 struct ust_app_event *ua_event;
3716
3717 DBG("UST app enabling event %s for all apps for session id %" PRIu64,
3718 uevent->attr.name, usess->id);
3719
3720 /*
3721 * NOTE: At this point, this function is called only if the session and
3722 * channel passed are already created for all apps. and enabled on the
3723 * tracer also.
3724 */
3725
3726 rcu_read_lock();
3727
3728 /* For all registered applications */
3729 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3730 if (!app->compatible) {
3731 /*
3732 * TODO: In time, we should notice the caller of this error by
3733 * telling him that this is a version error.
3734 */
3735 continue;
3736 }
3737 ua_sess = lookup_session_by_app(usess, app);
3738 if (!ua_sess) {
3739 /* The application has problem or is probably dead. */
3740 continue;
3741 }
3742
3743 pthread_mutex_lock(&ua_sess->lock);
3744
3745 /* Lookup channel in the ust app session */
3746 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
3747 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
3748 /* If the channel is not found, there is a code flow error */
3749 assert(ua_chan_node);
3750
3751 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
3752
3753 /* Get event node */
3754 ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
3755 uevent->filter, uevent->attr.loglevel, uevent->exclusion);
3756 if (ua_event == NULL) {
3757 DBG3("UST app enable event %s not found for app PID %d."
3758 "Skipping app", uevent->attr.name, app->pid);
3759 goto next_app;
3760 }
3761
3762 ret = enable_ust_app_event(ua_sess, ua_event, app);
3763 if (ret < 0) {
3764 pthread_mutex_unlock(&ua_sess->lock);
3765 goto error;
3766 }
3767 next_app:
3768 pthread_mutex_unlock(&ua_sess->lock);
3769 }
3770
3771 error:
3772 rcu_read_unlock();
3773 return ret;
3774 }
3775
3776 /*
3777 * For a specific existing UST session and UST channel, creates the event for
3778 * all registered apps.
3779 */
3780 int ust_app_create_event_glb(struct ltt_ust_session *usess,
3781 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
3782 {
3783 int ret = 0;
3784 struct lttng_ht_iter iter, uiter;
3785 struct lttng_ht_node_str *ua_chan_node;
3786 struct ust_app *app;
3787 struct ust_app_session *ua_sess;
3788 struct ust_app_channel *ua_chan;
3789
3790 DBG("UST app creating event %s for all apps for session id %" PRIu64,
3791 uevent->attr.name, usess->id);
3792
3793 rcu_read_lock();
3794
3795 /* For all registered applications */
3796 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
3797 if (!app->compatible) {
3798 /*
3799 * TODO: In time, we should notice the caller of this error by
3800 * telling him that this is a version error.
3801 */
3802 continue;
3803 }
3804 ua_sess = lookup_session_by_app(usess, app);
3805 if (!ua_sess) {
3806 /* The application has problem or is probably dead. */
3807 continue;
3808 }
3809
3810 pthread_mutex_lock(&ua_sess->lock);
3811 /* Lookup channel in the ust app session */
3812 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
3813 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
3814 /* If the channel is not found, there is a code flow error */
3815 assert(ua_chan_node);
3816
3817 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
3818
3819 ret = create_ust_app_event(ua_sess, ua_chan, uevent, app);
3820 pthread_mutex_unlock(&ua_sess->lock);
3821 if (ret < 0) {
3822 if (ret != -LTTNG_UST_ERR_EXIST) {
3823 /* Possible value at this point: -ENOMEM. If so, we stop! */
3824 break;
3825 }
3826 DBG2("UST app event %s already exist on app PID %d",
3827 uevent->attr.name, app->pid);
3828 continue;
3829 }
3830 }
3831
3832 rcu_read_unlock();
3833
3834 return ret;
3835 }
3836
3837 /*
3838 * Start tracing for a specific UST session and app.
3839 */
3840 static
3841 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
3842 {
3843 int ret = 0;
3844 struct ust_app_session *ua_sess;
3845
3846 DBG("Starting tracing for ust app pid %d", app->pid);
3847
3848 rcu_read_lock();
3849
3850 if (!app->compatible) {
3851 goto end;
3852 }
3853
3854 ua_sess = lookup_session_by_app(usess, app);
3855 if (ua_sess == NULL) {
3856 /* The session is in teardown process. Ignore and continue. */
3857 goto end;
3858 }
3859
3860 pthread_mutex_lock(&ua_sess->lock);
3861
3862 /* Upon restart, we skip the setup, already done */
3863 if (ua_sess->started) {
3864 goto skip_setup;
3865 }
3866
3867 /* Create directories if consumer is LOCAL and has a path defined. */
3868 if (usess->consumer->type == CONSUMER_DST_LOCAL &&
3869 strlen(usess->consumer->dst.trace_path) > 0) {
3870 ret = run_as_mkdir_recursive(usess->consumer->dst.trace_path,
3871 S_IRWXU | S_IRWXG, ua_sess->euid, ua_sess->egid);
3872 if (ret < 0) {
3873 if (ret != -EEXIST) {
3874 ERR("Trace directory creation error");
3875 goto error_unlock;
3876 }
3877 }
3878 }
3879
3880 /*
3881 * Create the metadata for the application. This returns gracefully if a
3882 * metadata was already set for the session.
3883 */
3884 ret = create_ust_app_metadata(ua_sess, app, usess->consumer);
3885 if (ret < 0) {
3886 goto error_unlock;
3887 }
3888
3889 health_code_update();
3890
3891 skip_setup:
3892 /* This start the UST tracing */
3893 ret = ustctl_start_session(app->sock, ua_sess->handle);
3894 if (ret < 0) {
3895 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
3896 ERR("Error starting tracing for app pid: %d (ret: %d)",
3897 app->pid, ret);
3898 } else {
3899 DBG("UST app start session failed. Application is dead.");
3900 /*
3901 * This is normal behavior, an application can die during the
3902 * creation process. Don't report an error so the execution can
3903 * continue normally.
3904 */
3905 pthread_mutex_unlock(&ua_sess->lock);
3906 goto end;
3907 }
3908 goto error_unlock;
3909 }
3910
3911 /* Indicate that the session has been started once */
3912 ua_sess->started = 1;
3913
3914 pthread_mutex_unlock(&ua_sess->lock);
3915
3916 health_code_update();
3917
3918 /* Quiescent wait after starting trace */
3919 ret = ustctl_wait_quiescent(app->sock);
3920 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
3921 ERR("UST app wait quiescent failed for app pid %d ret %d",
3922 app->pid, ret);
3923 }
3924
3925 end:
3926 rcu_read_unlock();
3927 health_code_update();
3928 return 0;
3929
3930 error_unlock:
3931 pthread_mutex_unlock(&ua_sess->lock);
3932 rcu_read_unlock();
3933 health_code_update();
3934 return -1;
3935 }
3936
3937 /*
3938 * Stop tracing for a specific UST session and app.
3939 */
3940 static
3941 int ust_app_stop_trace(struct ltt_ust_session *usess, struct ust_app *app)
3942 {
3943 int ret = 0;
3944 struct ust_app_session *ua_sess;
3945 struct ust_registry_session *registry;
3946
3947 DBG("Stopping tracing for ust app pid %d", app->pid);
3948
3949 rcu_read_lock();
3950
3951 if (!app->compatible) {
3952 goto end_no_session;
3953 }
3954
3955 ua_sess = lookup_session_by_app(usess, app);
3956 if (ua_sess == NULL) {
3957 goto end_no_session;
3958 }
3959
3960 pthread_mutex_lock(&ua_sess->lock);
3961
3962 /*
3963 * If started = 0, it means that stop trace has been called for a session
3964 * that was never started. It's possible since we can have a fail start
3965 * from either the application manager thread or the command thread. Simply
3966 * indicate that this is a stop error.
3967 */
3968 if (!ua_sess->started) {
3969 goto error_rcu_unlock;
3970 }
3971
3972 health_code_update();
3973
3974 /* This inhibits UST tracing */
3975 ret = ustctl_stop_session(app->sock, ua_sess->handle);
3976 if (ret < 0) {
3977 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
3978 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3979 app->pid, ret);
3980 } else {
3981 DBG("UST app stop session failed. Application is dead.");
3982 /*
3983 * This is normal behavior, an application can die during the
3984 * creation process. Don't report an error so the execution can
3985 * continue normally.
3986 */
3987 goto end_unlock;
3988 }
3989 goto error_rcu_unlock;
3990 }
3991
3992 health_code_update();
3993
3994 /* Quiescent wait after stopping trace */
3995 ret = ustctl_wait_quiescent(app->sock);
3996 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
3997 ERR("UST app wait quiescent failed for app pid %d ret %d",
3998 app->pid, ret);
3999 }
4000
4001 health_code_update();
4002
4003 registry = get_session_registry(ua_sess);
4004 assert(registry);
4005
4006 /* Push metadata for application before freeing the application. */
4007 (void) push_metadata(registry, ua_sess->consumer);
4008
4009 end_unlock:
4010 pthread_mutex_unlock(&ua_sess->lock);
4011 end_no_session:
4012 rcu_read_unlock();
4013 health_code_update();
4014 return 0;
4015
4016 error_rcu_unlock:
4017 pthread_mutex_unlock(&ua_sess->lock);
4018 rcu_read_unlock();
4019 health_code_update();
4020 return -1;
4021 }
4022
4023 static
4024 int ust_app_flush_app_session(struct ust_app *app,
4025 struct ust_app_session *ua_sess)
4026 {
4027 int ret, retval = 0;
4028 struct lttng_ht_iter iter;
4029 struct ust_app_channel *ua_chan;
4030 struct consumer_socket *socket;
4031
4032 DBG("Flushing app session buffers for ust app pid %d", app->pid);
4033
4034 rcu_read_lock();
4035
4036 if (!app->compatible) {
4037 goto end_not_compatible;
4038 }
4039
4040 pthread_mutex_lock(&ua_sess->lock);
4041
4042 health_code_update();
4043
4044 /* Flushing buffers */
4045 socket = consumer_find_socket_by_bitness(app->bits_per_long,
4046 ua_sess->consumer);
4047
4048 /* Flush buffers and push metadata. */
4049 switch (ua_sess->buffer_type) {
4050 case LTTNG_BUFFER_PER_PID:
4051 cds_lfht_for_each_entry(ua_sess->channels->ht, &iter.iter, ua_chan,
4052 node.node) {
4053 health_code_update();
4054 assert(ua_chan->is_sent);
4055 ret = consumer_flush_channel(socket, ua_chan->key);
4056 if (ret) {
4057 ERR("Error flushing consumer channel");
4058 retval = -1;
4059 continue;
4060 }
4061 }
4062 break;
4063 case LTTNG_BUFFER_PER_UID:
4064 default:
4065 assert(0);
4066 break;
4067 }
4068
4069 health_code_update();
4070
4071 pthread_mutex_unlock(&ua_sess->lock);
4072
4073 end_not_compatible:
4074 rcu_read_unlock();
4075 health_code_update();
4076 return retval;
4077 }
4078
4079 /*
4080 * Flush buffers for all applications for a specific UST session.
4081 * Called with UST session lock held.
4082 */
4083 static
4084 int ust_app_flush_session(struct ltt_ust_session *usess)
4085
4086 {
4087 int ret = 0;
4088
4089 DBG("Flushing session buffers for all ust apps");
4090
4091 rcu_read_lock();
4092
4093 /* Flush buffers and push metadata. */
4094 switch (usess->buffer_type) {
4095 case LTTNG_BUFFER_PER_UID:
4096 {
4097 struct buffer_reg_uid *reg;
4098 struct lttng_ht_iter iter;
4099
4100 /* Flush all per UID buffers associated to that session. */
4101 cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
4102 struct ust_registry_session *ust_session_reg;
4103 struct buffer_reg_channel *reg_chan;
4104 struct consumer_socket *socket;
4105
4106 /* Get consumer socket to use to push the metadata.*/
4107 socket = consumer_find_socket_by_bitness(reg->bits_per_long,
4108 usess->consumer);
4109 if (!socket) {
4110 /* Ignore request if no consumer is found for the session. */
4111 continue;
4112 }
4113
4114 cds_lfht_for_each_entry(reg->registry->channels->ht, &iter.iter,
4115 reg_chan, node.node) {
4116 /*
4117 * The following call will print error values so the return
4118 * code is of little importance because whatever happens, we
4119 * have to try them all.
4120 */
4121 (void) consumer_flush_channel(socket, reg_chan->consumer_key);
4122 }
4123
4124 ust_session_reg = reg->registry->reg.ust;
4125 /* Push metadata. */
4126 (void) push_metadata(ust_session_reg, usess->consumer);
4127 }
4128 break;
4129 }
4130 case LTTNG_BUFFER_PER_PID:
4131 {
4132 struct ust_app_session *ua_sess;
4133 struct lttng_ht_iter iter;
4134 struct ust_app *app;
4135
4136 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4137 ua_sess = lookup_session_by_app(usess, app);
4138 if (ua_sess == NULL) {
4139 continue;
4140 }
4141 (void) ust_app_flush_app_session(app, ua_sess);
4142 }
4143 break;
4144 }
4145 default:
4146 ret = -1;
4147 assert(0);
4148 break;
4149 }
4150
4151 rcu_read_unlock();
4152 health_code_update();
4153 return ret;
4154 }
4155
4156 /*
4157 * Destroy a specific UST session in apps.
4158 */
4159 static int destroy_trace(struct ltt_ust_session *usess, struct ust_app *app)
4160 {
4161 int ret;
4162 struct ust_app_session *ua_sess;
4163 struct lttng_ht_iter iter;
4164 struct lttng_ht_node_u64 *node;
4165
4166 DBG("Destroy tracing for ust app pid %d", app->pid);
4167
4168 rcu_read_lock();
4169
4170 if (!app->compatible) {
4171 goto end;
4172 }
4173
4174 __lookup_session_by_app(usess, app, &iter);
4175 node = lttng_ht_iter_get_node_u64(&iter);
4176 if (node == NULL) {
4177 /* Session is being or is deleted. */
4178 goto end;
4179 }
4180 ua_sess = caa_container_of(node, struct ust_app_session, node);
4181
4182 health_code_update();
4183 destroy_app_session(app, ua_sess);
4184
4185 health_code_update();
4186
4187 /* Quiescent wait after stopping trace */
4188 ret = ustctl_wait_quiescent(app->sock);
4189 if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4190 ERR("UST app wait quiescent failed for app pid %d ret %d",
4191 app->pid, ret);
4192 }
4193 end:
4194 rcu_read_unlock();
4195 health_code_update();
4196 return 0;
4197 }
4198
4199 /*
4200 * Start tracing for the UST session.
4201 */
4202 int ust_app_start_trace_all(struct ltt_ust_session *usess)
4203 {
4204 int ret = 0;
4205 struct lttng_ht_iter iter;
4206 struct ust_app *app;
4207
4208 DBG("Starting all UST traces");
4209
4210 rcu_read_lock();
4211
4212 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4213 ret = ust_app_start_trace(usess, app);
4214 if (ret < 0) {
4215 /* Continue to next apps even on error */
4216 continue;
4217 }
4218 }
4219
4220 rcu_read_unlock();
4221
4222 return 0;
4223 }
4224
4225 /*
4226 * Start tracing for the UST session.
4227 * Called with UST session lock held.
4228 */
4229 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
4230 {
4231 int ret = 0;
4232 struct lttng_ht_iter iter;
4233 struct ust_app *app;
4234
4235 DBG("Stopping all UST traces");
4236
4237 rcu_read_lock();
4238
4239 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4240 ret = ust_app_stop_trace(usess, app);
4241 if (ret < 0) {
4242 /* Continue to next apps even on error */
4243 continue;
4244 }
4245 }
4246
4247 (void) ust_app_flush_session(usess);
4248
4249 rcu_read_unlock();
4250
4251 return 0;
4252 }
4253
4254 /*
4255 * Destroy app UST session.
4256 */
4257 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
4258 {
4259 int ret = 0;
4260 struct lttng_ht_iter iter;
4261 struct ust_app *app;
4262
4263 DBG("Destroy all UST traces");
4264
4265 rcu_read_lock();
4266
4267 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4268 ret = destroy_trace(usess, app);
4269 if (ret < 0) {
4270 /* Continue to next apps even on error */
4271 continue;
4272 }
4273 }
4274
4275 rcu_read_unlock();
4276
4277 return 0;
4278 }
4279
4280 /*
4281 * Add channels/events from UST global domain to registered apps at sock.
4282 */
4283 void ust_app_global_update(struct ltt_ust_session *usess, int sock)
4284 {
4285 int ret = 0;
4286 struct lttng_ht_iter iter, uiter;
4287 struct ust_app *app;
4288 struct ust_app_session *ua_sess = NULL;
4289 struct ust_app_channel *ua_chan;
4290 struct ust_app_event *ua_event;
4291 struct ust_app_ctx *ua_ctx;
4292
4293 assert(usess);
4294 assert(sock >= 0);
4295
4296 DBG2("UST app global update for app sock %d for session id %" PRIu64, sock,
4297 usess->id);
4298
4299 rcu_read_lock();
4300
4301 app = ust_app_find_by_sock(sock);
4302 if (app == NULL) {
4303 /*
4304 * Application can be unregistered before so this is possible hence
4305 * simply stopping the update.
4306 */
4307 DBG3("UST app update failed to find app sock %d", sock);
4308 goto error;
4309 }
4310
4311 if (!app->compatible) {
4312 goto error;
4313 }
4314
4315 ret = create_ust_app_session(usess, app, &ua_sess, NULL);
4316 if (ret < 0) {
4317 /* Tracer is probably gone or ENOMEM. */
4318 goto error;
4319 }
4320 assert(ua_sess);
4321
4322 pthread_mutex_lock(&ua_sess->lock);
4323
4324 /*
4325 * We can iterate safely here over all UST app session since the create ust
4326 * app session above made a shadow copy of the UST global domain from the
4327 * ltt ust session.
4328 */
4329 cds_lfht_for_each_entry(ua_sess->channels->ht, &iter.iter, ua_chan,
4330 node.node) {
4331 ret = do_create_channel(app, usess, ua_sess, ua_chan);
4332 if (ret < 0) {
4333 /*
4334 * Stop everything. On error, the application failed, no more
4335 * file descriptor are available or ENOMEM so stopping here is
4336 * the only thing we can do for now.
4337 */
4338 goto error_unlock;
4339 }
4340
4341 /*
4342 * Add context using the list so they are enabled in the same order the
4343 * user added them.
4344 */
4345 cds_list_for_each_entry(ua_ctx, &ua_chan->ctx_list, list) {
4346 ret = create_ust_channel_context(ua_chan, ua_ctx, app);
4347 if (ret < 0) {
4348 goto error_unlock;
4349 }
4350 }
4351
4352
4353 /* For each events */
4354 cds_lfht_for_each_entry(ua_chan->events->ht, &uiter.iter, ua_event,
4355 node.node) {
4356 ret = create_ust_event(app, ua_sess, ua_chan, ua_event);
4357 if (ret < 0) {
4358 goto error_unlock;
4359 }
4360 }
4361 }
4362
4363 pthread_mutex_unlock(&ua_sess->lock);
4364
4365 if (usess->active) {
4366 ret = ust_app_start_trace(usess, app);
4367 if (ret < 0) {
4368 goto error;
4369 }
4370
4371 DBG2("UST trace started for app pid %d", app->pid);
4372 }
4373
4374 /* Everything went well at this point. */
4375 rcu_read_unlock();
4376 return;
4377
4378 error_unlock:
4379 pthread_mutex_unlock(&ua_sess->lock);
4380 error:
4381 if (ua_sess) {
4382 destroy_app_session(app, ua_sess);
4383 }
4384 rcu_read_unlock();
4385 return;
4386 }
4387
4388 /*
4389 * Add context to a specific channel for global UST domain.
4390 */
4391 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
4392 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
4393 {
4394 int ret = 0;
4395 struct lttng_ht_node_str *ua_chan_node;
4396 struct lttng_ht_iter iter, uiter;
4397 struct ust_app_channel *ua_chan = NULL;
4398 struct ust_app_session *ua_sess;
4399 struct ust_app *app;
4400
4401 rcu_read_lock();
4402
4403 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4404 if (!app->compatible) {
4405 /*
4406 * TODO: In time, we should notice the caller of this error by
4407 * telling him that this is a version error.
4408 */
4409 continue;
4410 }
4411 ua_sess = lookup_session_by_app(usess, app);
4412 if (ua_sess == NULL) {
4413 continue;
4414 }
4415
4416 pthread_mutex_lock(&ua_sess->lock);
4417 /* Lookup channel in the ust app session */
4418 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
4419 ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
4420 if (ua_chan_node == NULL) {
4421 goto next_app;
4422 }
4423 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel,
4424 node);
4425 ret = create_ust_app_channel_context(ua_sess, ua_chan, &uctx->ctx, app);
4426 if (ret < 0) {
4427 goto next_app;
4428 }
4429 next_app:
4430 pthread_mutex_unlock(&ua_sess->lock);
4431 }
4432
4433 rcu_read_unlock();
4434 return ret;
4435 }
4436
4437 /*
4438 * Enable event for a channel from a UST session for a specific PID.
4439 */
4440 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
4441 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent, pid_t pid)
4442 {
4443 int ret = 0;
4444 struct lttng_ht_iter iter;
4445 struct lttng_ht_node_str *ua_chan_node;
4446 struct ust_app *app;
4447 struct ust_app_session *ua_sess;
4448 struct ust_app_channel *ua_chan;
4449 struct ust_app_event *ua_event;
4450
4451 DBG("UST app enabling event %s for PID %d", uevent->attr.name, pid);
4452
4453 rcu_read_lock();
4454
4455 app = ust_app_find_by_pid(pid);
4456 if (app == NULL) {
4457 ERR("UST app enable event per PID %d not found", pid);
4458 ret = -1;
4459 goto end;
4460 }
4461
4462 if (!app->compatible) {
4463 ret = 0;
4464 goto end;
4465 }
4466
4467 ua_sess = lookup_session_by_app(usess, app);
4468 if (!ua_sess) {
4469 /* The application has problem or is probably dead. */
4470 ret = 0;
4471 goto end;
4472 }
4473
4474 pthread_mutex_lock(&ua_sess->lock);
4475 /* Lookup channel in the ust app session */
4476 lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &iter);
4477 ua_chan_node = lttng_ht_iter_get_node_str(&iter);
4478 /* If the channel is not found, there is a code flow error */
4479 assert(ua_chan_node);
4480
4481 ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
4482
4483 ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
4484 uevent->filter, uevent->attr.loglevel, uevent->exclusion);
4485 if (ua_event == NULL) {
4486 ret = create_ust_app_event(ua_sess, ua_chan, uevent, app);
4487 if (ret < 0) {
4488 goto end_unlock;
4489 }
4490 } else {
4491 ret = enable_ust_app_event(ua_sess, ua_event, app);
4492 if (ret < 0) {
4493 goto end_unlock;
4494 }
4495 }
4496
4497 end_unlock:
4498 pthread_mutex_unlock(&ua_sess->lock);
4499 end:
4500 rcu_read_unlock();
4501 return ret;
4502 }
4503
4504 /*
4505 * Calibrate registered applications.
4506 */
4507 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
4508 {
4509 int ret = 0;
4510 struct lttng_ht_iter iter;
4511 struct ust_app *app;
4512
4513 rcu_read_lock();
4514
4515 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
4516 if (!app->compatible) {
4517 /*
4518 * TODO: In time, we should notice the caller of this error by
4519 * telling him that this is a version error.
4520 */
4521 continue;
4522 }
4523
4524 health_code_update();
4525
4526 ret = ustctl_calibrate(app->sock, calibrate);
4527 if (ret < 0) {
4528 switch (ret) {
4529 case -ENOSYS:
4530 /* Means that it's not implemented on the tracer side. */
4531 ret = 0;
4532 break;
4533 default:
4534 DBG2("Calibrate app PID %d returned with error %d",
4535 app->pid, ret);
4536 break;
4537 }
4538 }
4539 }
4540
4541 DBG("UST app global domain calibration finished");
4542
4543 rcu_read_unlock();
4544
4545 health_code_update();
4546
4547 return ret;
4548 }
4549
4550 /*
4551 * Receive registration and populate the given msg structure.
4552 *
4553 * On success return 0 else a negative value returned by the ustctl call.
4554 */
4555 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
4556 {
4557 int ret;
4558 uint32_t pid, ppid, uid, gid;
4559
4560 assert(msg);
4561
4562 ret = ustctl_recv_reg_msg(sock, &msg->type, &msg->major, &msg->minor,
4563 &pid, &ppid, &uid, &gid,
4564 &msg->bits_per_long,
4565 &msg->uint8_t_alignment,
4566 &msg->uint16_t_alignment,
4567 &msg->uint32_t_alignment,
4568 &msg->uint64_t_alignment,
4569 &msg->long_alignment,
4570 &msg->byte_order,
4571 msg->name);
4572 if (ret < 0) {
4573 switch (-ret) {
4574 case EPIPE:
4575 case ECONNRESET:
4576 case LTTNG_UST_ERR_EXITING:
4577 DBG3("UST app recv reg message failed. Application died");
4578 break;
4579 case LTTNG_UST_ERR_UNSUP_MAJOR:
4580 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4581 msg->major, msg->minor, LTTNG_UST_ABI_MAJOR_VERSION,
4582 LTTNG_UST_ABI_MINOR_VERSION);
4583 break;
4584 default:
4585 ERR("UST app recv reg message failed with ret %d", ret);
4586 break;
4587 }
4588 goto error;
4589 }
4590 msg->pid = (pid_t) pid;
4591 msg->ppid = (pid_t) ppid;
4592 msg->uid = (uid_t) uid;
4593 msg->gid = (gid_t) gid;
4594
4595 error:
4596 return ret;
4597 }
4598
4599 /*
4600 * Return a ust app channel object using the application object and the channel
4601 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4602 * lock MUST be acquired before calling this function.
4603 */
4604 static struct ust_app_channel *find_channel_by_objd(struct ust_app *app,
4605 int objd)
4606 {
4607 struct lttng_ht_node_ulong *node;
4608 struct lttng_ht_iter iter;
4609 struct ust_app_channel *ua_chan = NULL;
4610
4611 assert(app);
4612
4613 lttng_ht_lookup(app->ust_objd, (void *)((unsigned long) objd), &iter);
4614 node = lttng_ht_iter_get_node_ulong(&iter);
4615 if (node == NULL) {
4616 DBG2("UST app channel find by objd %d not found", objd);
4617 goto error;
4618 }
4619
4620 ua_chan = caa_container_of(node, struct ust_app_channel, ust_objd_node);
4621
4622 error:
4623 return ua_chan;
4624 }
4625
4626 /*
4627 * Reply to a register channel notification from an application on the notify
4628 * socket. The channel metadata is also created.
4629 *
4630 * The session UST registry lock is acquired in this function.
4631 *
4632 * On success 0 is returned else a negative value.
4633 */
4634 static int reply_ust_register_channel(int sock, int sobjd, int cobjd,
4635 size_t nr_fields, struct ustctl_field *fields)
4636 {
4637 int ret, ret_code = 0;
4638 uint32_t chan_id, reg_count;
4639 uint64_t chan_reg_key;
4640 enum ustctl_channel_header type;
4641 struct ust_app *app;
4642 struct ust_app_channel *ua_chan;
4643 struct ust_app_session *ua_sess;
4644 struct ust_registry_session *registry;
4645 struct ust_registry_channel *chan_reg;
4646
4647 rcu_read_lock();
4648
4649 /* Lookup application. If not found, there is a code flow error. */
4650 app = find_app_by_notify_sock(sock);
4651 if (!app) {
4652 DBG("Application socket %d is being teardown. Abort event notify",
4653 sock);
4654 ret = 0;
4655 free(fields);
4656 goto error_rcu_unlock;
4657 }
4658
4659 /* Lookup channel by UST object descriptor. */
4660 ua_chan = find_channel_by_objd(app, cobjd);
4661 if (!ua_chan) {
4662 DBG("Application channel is being teardown. Abort event notify");
4663 ret = 0;
4664 free(fields);
4665 goto error_rcu_unlock;
4666 }
4667
4668 assert(ua_chan->session);
4669 ua_sess = ua_chan->session;
4670
4671 /* Get right session registry depending on the session buffer type. */
4672 registry = get_session_registry(ua_sess);
4673 assert(registry);
4674
4675 /* Depending on the buffer type, a different channel key is used. */
4676 if (ua_sess->buffer_type == LTTNG_BUFFER_PER_UID) {
4677 chan_reg_key = ua_chan->tracing_channel_id;
4678 } else {
4679 chan_reg_key = ua_chan->key;
4680 }
4681
4682 pthread_mutex_lock(&registry->lock);
4683
4684 chan_reg = ust_registry_channel_find(registry, chan_reg_key);
4685 assert(chan_reg);
4686
4687 if (!chan_reg->register_done) {
4688 reg_count = ust_registry_get_event_count(chan_reg);
4689 if (reg_count < 31) {
4690 type = USTCTL_CHANNEL_HEADER_COMPACT;
4691 } else {
4692 type = USTCTL_CHANNEL_HEADER_LARGE;
4693 }
4694
4695 chan_reg->nr_ctx_fields = nr_fields;
4696 chan_reg->ctx_fields = fields;
4697 chan_reg->header_type = type;
4698 } else {
4699 /* Get current already assigned values. */
4700 type = chan_reg->header_type;
4701 free(fields);
4702 /* Set to NULL so the error path does not do a double free. */
4703 fields = NULL;
4704 }
4705 /* Channel id is set during the object creation. */
4706 chan_id = chan_reg->chan_id;
4707
4708 /* Append to metadata */
4709 if (!chan_reg->metadata_dumped) {
4710 ret_code = ust_metadata_channel_statedump(registry, chan_reg);
4711 if (ret_code) {
4712 ERR("Error appending channel metadata (errno = %d)", ret_code);
4713 goto reply;
4714 }
4715 }
4716
4717 reply:
4718 DBG3("UST app replying to register channel key %" PRIu64
4719 " with id %u, type: %d, ret: %d", chan_reg_key, chan_id, type,
4720 ret_code);
4721
4722 ret = ustctl_reply_register_channel(sock, chan_id, type, ret_code);
4723 if (ret < 0) {
4724 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4725 ERR("UST app reply channel failed with ret %d", ret);
4726 } else {
4727 DBG3("UST app reply channel failed. Application died");
4728 }
4729 goto error;
4730 }
4731
4732 /* This channel registry registration is completed. */
4733 chan_reg->register_done = 1;
4734
4735 error:
4736 pthread_mutex_unlock(&registry->lock);
4737 error_rcu_unlock:
4738 rcu_read_unlock();
4739 if (ret) {
4740 free(fields);
4741 }
4742 return ret;
4743 }
4744
4745 /*
4746 * Add event to the UST channel registry. When the event is added to the
4747 * registry, the metadata is also created. Once done, this replies to the
4748 * application with the appropriate error code.
4749 *
4750 * The session UST registry lock is acquired in the function.
4751 *
4752 * On success 0 is returned else a negative value.
4753 */
4754 static int add_event_ust_registry(int sock, int sobjd, int cobjd, char *name,
4755 char *sig, size_t nr_fields, struct ustctl_field *fields, int loglevel,
4756 char *model_emf_uri)
4757 {
4758 int ret, ret_code;
4759 uint32_t event_id = 0;
4760 uint64_t chan_reg_key;
4761 struct ust_app *app;
4762 struct ust_app_channel *ua_chan;
4763 struct ust_app_session *ua_sess;
4764 struct ust_registry_session *registry;
4765
4766 rcu_read_lock();
4767
4768 /* Lookup application. If not found, there is a code flow error. */
4769 app = find_app_by_notify_sock(sock);
4770 if (!app) {
4771 DBG("Application socket %d is being teardown. Abort event notify",
4772 sock);
4773 ret = 0;
4774 free(sig);
4775 free(fields);
4776 free(model_emf_uri);
4777 goto error_rcu_unlock;
4778 }
4779
4780 /* Lookup channel by UST object descriptor. */
4781 ua_chan = find_channel_by_objd(app, cobjd);
4782 if (!ua_chan) {
4783 DBG("Application channel is being teardown. Abort event notify");
4784 ret = 0;
4785 free(sig);
4786 free(fields);
4787 free(model_emf_uri);
4788 goto error_rcu_unlock;
4789 }
4790
4791 assert(ua_chan->session);
4792 ua_sess = ua_chan->session;
4793
4794 registry = get_session_registry(ua_sess);
4795 assert(registry);
4796
4797 if (ua_sess->buffer_type == LTTNG_BUFFER_PER_UID) {
4798 chan_reg_key = ua_chan->tracing_channel_id;
4799 } else {
4800 chan_reg_key = ua_chan->key;
4801 }
4802
4803 pthread_mutex_lock(&registry->lock);
4804
4805 /*
4806 * From this point on, this call acquires the ownership of the sig, fields
4807 * and model_emf_uri meaning any free are done inside it if needed. These
4808 * three variables MUST NOT be read/write after this.
4809 */
4810 ret_code = ust_registry_create_event(registry, chan_reg_key,
4811 sobjd, cobjd, name, sig, nr_fields, fields, loglevel,
4812 model_emf_uri, ua_sess->buffer_type, &event_id,
4813 app);
4814
4815 /*
4816 * The return value is returned to ustctl so in case of an error, the
4817 * application can be notified. In case of an error, it's important not to
4818 * return a negative error or else the application will get closed.
4819 */
4820 ret = ustctl_reply_register_event(sock, event_id, ret_code);
4821 if (ret < 0) {
4822 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4823 ERR("UST app reply event failed with ret %d", ret);
4824 } else {
4825 DBG3("UST app reply event failed. Application died");
4826 }
4827 /*
4828 * No need to wipe the create event since the application socket will
4829 * get close on error hence cleaning up everything by itself.
4830 */
4831 goto error;
4832 }
4833
4834 DBG3("UST registry event %s with id %" PRId32 " added successfully",
4835 name, event_id);
4836
4837 error:
4838 pthread_mutex_unlock(&registry->lock);
4839 error_rcu_unlock:
4840 rcu_read_unlock();
4841 return ret;
4842 }
4843
4844 /*
4845 * Handle application notification through the given notify socket.
4846 *
4847 * Return 0 on success or else a negative value.
4848 */
4849 int ust_app_recv_notify(int sock)
4850 {
4851 int ret;
4852 enum ustctl_notify_cmd cmd;
4853
4854 DBG3("UST app receiving notify from sock %d", sock);
4855
4856 ret = ustctl_recv_notify(sock, &cmd);
4857 if (ret < 0) {
4858 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4859 ERR("UST app recv notify failed with ret %d", ret);
4860 } else {
4861 DBG3("UST app recv notify failed. Application died");
4862 }
4863 goto error;
4864 }
4865
4866 switch (cmd) {
4867 case USTCTL_NOTIFY_CMD_EVENT:
4868 {
4869 int sobjd, cobjd, loglevel;
4870 char name[LTTNG_UST_SYM_NAME_LEN], *sig, *model_emf_uri;
4871 size_t nr_fields;
4872 struct ustctl_field *fields;
4873
4874 DBG2("UST app ustctl register event received");
4875
4876 ret = ustctl_recv_register_event(sock, &sobjd, &cobjd, name, &loglevel,
4877 &sig, &nr_fields, &fields, &model_emf_uri);
4878 if (ret < 0) {
4879 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4880 ERR("UST app recv event failed with ret %d", ret);
4881 } else {
4882 DBG3("UST app recv event failed. Application died");
4883 }
4884 goto error;
4885 }
4886
4887 /*
4888 * Add event to the UST registry coming from the notify socket. This
4889 * call will free if needed the sig, fields and model_emf_uri. This
4890 * code path loses the ownsership of these variables and transfer them
4891 * to the this function.
4892 */
4893 ret = add_event_ust_registry(sock, sobjd, cobjd, name, sig, nr_fields,
4894 fields, loglevel, model_emf_uri);
4895 if (ret < 0) {
4896 goto error;
4897 }
4898
4899 break;
4900 }
4901 case USTCTL_NOTIFY_CMD_CHANNEL:
4902 {
4903 int sobjd, cobjd;
4904 size_t nr_fields;
4905 struct ustctl_field *fields;
4906
4907 DBG2("UST app ustctl register channel received");
4908
4909 ret = ustctl_recv_register_channel(sock, &sobjd, &cobjd, &nr_fields,
4910 &fields);
4911 if (ret < 0) {
4912 if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
4913 ERR("UST app recv channel failed with ret %d", ret);
4914 } else {
4915 DBG3("UST app recv channel failed. Application died");
4916 }
4917 goto error;
4918 }
4919
4920 /*
4921 * The fields ownership are transfered to this function call meaning
4922 * that if needed it will be freed. After this, it's invalid to access
4923 * fields or clean it up.
4924 */
4925 ret = reply_ust_register_channel(sock, sobjd, cobjd, nr_fields,
4926 fields);
4927 if (ret < 0) {
4928 goto error;
4929 }
4930
4931 break;
4932 }
4933 default:
4934 /* Should NEVER happen. */
4935 assert(0);
4936 }
4937
4938 error:
4939 return ret;
4940 }
4941
4942 /*
4943 * Once the notify socket hangs up, this is called. First, it tries to find the
4944 * corresponding application. On failure, the call_rcu to close the socket is
4945 * executed. If an application is found, it tries to delete it from the notify
4946 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4947 *
4948 * Note that an object needs to be allocated here so on ENOMEM failure, the
4949 * call RCU is not done but the rest of the cleanup is.
4950 */
4951 void ust_app_notify_sock_unregister(int sock)
4952 {
4953 int err_enomem = 0;
4954 struct lttng_ht_iter iter;
4955 struct ust_app *app;
4956 struct ust_app_notify_sock_obj *obj;
4957
4958 assert(sock >= 0);
4959
4960 rcu_read_lock();
4961
4962 obj = zmalloc(sizeof(*obj));
4963 if (!obj) {
4964 /*
4965 * An ENOMEM is kind of uncool. If this strikes we continue the
4966 * procedure but the call_rcu will not be called. In this case, we
4967 * accept the fd leak rather than possibly creating an unsynchronized
4968 * state between threads.
4969 *
4970 * TODO: The notify object should be created once the notify socket is
4971 * registered and stored independantely from the ust app object. The
4972 * tricky part is to synchronize the teardown of the application and
4973 * this notify object. Let's keep that in mind so we can avoid this
4974 * kind of shenanigans with ENOMEM in the teardown path.
4975 */
4976 err_enomem = 1;
4977 } else {
4978 obj->fd = sock;
4979 }
4980
4981 DBG("UST app notify socket unregister %d", sock);
4982
4983 /*
4984 * Lookup application by notify socket. If this fails, this means that the
4985 * hash table delete has already been done by the application
4986 * unregistration process so we can safely close the notify socket in a
4987 * call RCU.
4988 */
4989 app = find_app_by_notify_sock(sock);
4990 if (!app) {
4991 goto close_socket;
4992 }
4993
4994 iter.iter.node = &app->notify_sock_n.node;
4995
4996 /*
4997 * Whatever happens here either we fail or succeed, in both cases we have
4998 * to close the socket after a grace period to continue to the call RCU
4999 * here. If the deletion is successful, the application is not visible
5000 * anymore by other threads and is it fails it means that it was already
5001 * deleted from the hash table so either way we just have to close the
5002 * socket.
5003 */
5004 (void) lttng_ht_del(ust_app_ht_by_notify_sock, &iter);
5005
5006 close_socket:
5007 rcu_read_unlock();
5008
5009 /*
5010 * Close socket after a grace period to avoid for the socket to be reused
5011 * before the application object is freed creating potential race between
5012 * threads trying to add unique in the global hash table.
5013 */
5014 if (!err_enomem) {
5015 call_rcu(&obj->head, close_notify_sock_rcu);
5016 }
5017 }
5018
5019 /*
5020 * Destroy a ust app data structure and free its memory.
5021 */
5022 void ust_app_destroy(struct ust_app *app)
5023 {
5024 if (!app) {
5025 return;
5026 }
5027
5028 call_rcu(&app->pid_n.head, delete_ust_app_rcu);
5029 }
5030
5031 /*
5032 * Take a snapshot for a given UST session. The snapshot is sent to the given
5033 * output.
5034 *
5035 * Return 0 on success or else a negative value.
5036 */
5037 int ust_app_snapshot_record(struct ltt_ust_session *usess,
5038 struct snapshot_output *output, int wait,
5039 uint64_t nb_packets_per_stream)
5040 {
5041 int ret = 0;
5042 unsigned int snapshot_done = 0;
5043 struct lttng_ht_iter iter;
5044 struct ust_app *app;
5045 char pathname[PATH_MAX];
5046
5047 assert(usess);
5048 assert(output);
5049
5050 rcu_read_lock();
5051
5052 switch (usess->buffer_type) {
5053 case LTTNG_BUFFER_PER_UID:
5054 {
5055 struct buffer_reg_uid *reg;
5056
5057 cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
5058 struct buffer_reg_channel *reg_chan;
5059 struct consumer_socket *socket;
5060
5061 /* Get consumer socket to use to push the metadata.*/
5062 socket = consumer_find_socket_by_bitness(reg->bits_per_long,
5063 usess->consumer);
5064 if (!socket) {
5065 ret = -EINVAL;
5066 goto error;
5067 }
5068
5069 memset(pathname, 0, sizeof(pathname));
5070 ret = snprintf(pathname, sizeof(pathname),
5071 DEFAULT_UST_TRACE_DIR "/" DEFAULT_UST_TRACE_UID_PATH,
5072 reg->uid, reg->bits_per_long);
5073 if (ret < 0) {
5074 PERROR("snprintf snapshot path");
5075 goto error;
5076 }
5077
5078 /* Add the UST default trace dir to path. */
5079 cds_lfht_for_each_entry(reg->registry->channels->ht, &iter.iter,
5080 reg_chan, node.node) {
5081 ret = consumer_snapshot_channel(socket, reg_chan->consumer_key,
5082 output, 0, usess->uid, usess->gid, pathname, wait,
5083 nb_packets_per_stream);
5084 if (ret < 0) {
5085 goto error;
5086 }
5087 }
5088 ret = consumer_snapshot_channel(socket,
5089 reg->registry->reg.ust->metadata_key, output, 1,
5090 usess->uid, usess->gid, pathname, wait, 0);
5091 if (ret < 0) {
5092 goto error;
5093 }
5094 snapshot_done = 1;
5095 }
5096 break;
5097 }
5098 case LTTNG_BUFFER_PER_PID:
5099 {
5100 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
5101 struct consumer_socket *socket;
5102 struct lttng_ht_iter chan_iter;
5103 struct ust_app_channel *ua_chan;
5104 struct ust_app_session *ua_sess;
5105 struct ust_registry_session *registry;
5106
5107 ua_sess = lookup_session_by_app(usess, app);
5108 if (!ua_sess) {
5109 /* Session not associated with this app. */
5110 continue;
5111 }
5112
5113 /* Get the right consumer socket for the application. */
5114 socket = consumer_find_socket_by_bitness(app->bits_per_long,
5115 output->consumer);
5116 if (!socket) {
5117 ret = -EINVAL;
5118 goto error;
5119 }
5120
5121 /* Add the UST default trace dir to path. */
5122 memset(pathname, 0, sizeof(pathname));
5123 ret = snprintf(pathname, sizeof(pathname), DEFAULT_UST_TRACE_DIR "/%s",
5124 ua_sess->path);
5125 if (ret < 0) {
5126 PERROR("snprintf snapshot path");
5127 goto error;
5128 }
5129
5130 cds_lfht_for_each_entry(ua_sess->channels->ht, &chan_iter.iter,
5131 ua_chan, node.node) {
5132 ret = consumer_snapshot_channel(socket, ua_chan->key, output,
5133 0, ua_sess->euid, ua_sess->egid, pathname, wait,
5134 nb_packets_per_stream);
5135 if (ret < 0) {
5136 goto error;
5137 }
5138 }
5139
5140 registry = get_session_registry(ua_sess);
5141 assert(registry);
5142 ret = consumer_snapshot_channel(socket, registry->metadata_key, output,
5143 1, ua_sess->euid, ua_sess->egid, pathname, wait, 0);
5144 if (ret < 0) {
5145 goto error;
5146 }
5147 snapshot_done = 1;
5148 }
5149 break;
5150 }
5151 default:
5152 assert(0);
5153 break;
5154 }
5155
5156 if (!snapshot_done) {
5157 /*
5158 * If no snapshot was made and we are not in the error path, this means
5159 * that there are no buffers thus no (prior) application to snapshot
5160 * data from so we have simply NO data.
5161 */
5162 ret = -ENODATA;
5163 }
5164
5165 error:
5166 rcu_read_unlock();
5167 return ret;
5168 }
5169
5170 /*
5171 * Return the size taken by one more packet per stream.
5172 */
5173 uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session *usess,
5174 uint64_t cur_nr_packets)
5175 {
5176 uint64_t tot_size = 0;
5177 struct ust_app *app;
5178 struct lttng_ht_iter iter;
5179
5180 assert(usess);
5181
5182 switch (usess->buffer_type) {
5183 case LTTNG_BUFFER_PER_UID:
5184 {
5185 struct buffer_reg_uid *reg;
5186
5187 cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
5188 struct buffer_reg_channel *reg_chan;
5189
5190 rcu_read_lock();
5191 cds_lfht_for_each_entry(reg->registry->channels->ht, &iter.iter,
5192 reg_chan, node.node) {
5193 if (cur_nr_packets >= reg_chan->num_subbuf) {
5194 /*
5195 * Don't take channel into account if we
5196 * already grab all its packets.
5197 */
5198 continue;
5199 }
5200 tot_size += reg_chan->subbuf_size * reg_chan->stream_count;
5201 }
5202 rcu_read_unlock();
5203 }
5204 break;
5205 }
5206 case LTTNG_BUFFER_PER_PID:
5207 {
5208 rcu_read_lock();
5209 cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
5210 struct ust_app_channel *ua_chan;
5211 struct ust_app_session *ua_sess;
5212 struct lttng_ht_iter chan_iter;
5213
5214 ua_sess = lookup_session_by_app(usess, app);
5215 if (!ua_sess) {
5216 /* Session not associated with this app. */
5217 continue;
5218 }
5219
5220 cds_lfht_for_each_entry(ua_sess->channels->ht, &chan_iter.iter,
5221 ua_chan, node.node) {
5222 if (cur_nr_packets >= ua_chan->attr.num_subbuf) {
5223 /*
5224 * Don't take channel into account if we
5225 * already grab all its packets.
5226 */
5227 continue;
5228 }
5229 tot_size += ua_chan->attr.subbuf_size * ua_chan->streams.count;
5230 }
5231 }
5232 rcu_read_unlock();
5233 break;
5234 }
5235 default:
5236 assert(0);
5237 break;
5238 }
5239
5240 return tot_size;
5241 }
This page took 0.144513 seconds and 4 git commands to generate.