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