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