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