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