Cleanup: sobjd is never used by reply_ust_register_channel()

[lttng-tools.git] / src / bin / lttng-sessiond / ust-app.c

/*
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#define _LGPL_SOURCE
#include <errno.h>
#include <inttypes.h>
#include <pthread.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include <urcu/compiler.h>
#include <lttng/ust-error.h>
#include <signal.h>

#include <common/common.h>
#include <common/sessiond-comm/sessiond-comm.h>

#include "buffer-registry.h"
#include "fd-limit.h"
#include "health-sessiond.h"
#include "ust-app.h"
#include "ust-consumer.h"
#include "ust-ctl.h"
#include "utils.h"
#include "session.h"
#include "lttng-sessiond.h"
#include "notification-thread-commands.h"
#include "rotate.h"

static
int ust_app_flush_app_session(struct ust_app *app, struct ust_app_session *ua_sess);

/* Next available channel key. Access under next_channel_key_lock. */
static uint64_t _next_channel_key;
static pthread_mutex_t next_channel_key_lock = PTHREAD_MUTEX_INITIALIZER;

/* Next available session ID. Access under next_session_id_lock. */
static uint64_t _next_session_id;
static pthread_mutex_t next_session_id_lock = PTHREAD_MUTEX_INITIALIZER;

/*
 * Return the incremented value of next_channel_key.
 */
static uint64_t get_next_channel_key(void)
{
        uint64_t ret;

        pthread_mutex_lock(&next_channel_key_lock);
        ret = ++_next_channel_key;
        pthread_mutex_unlock(&next_channel_key_lock);
        return ret;
}

/*
 * Return the atomically incremented value of next_session_id.
 */
static uint64_t get_next_session_id(void)
{
        uint64_t ret;

        pthread_mutex_lock(&next_session_id_lock);
        ret = ++_next_session_id;
        pthread_mutex_unlock(&next_session_id_lock);
        return ret;
}

static void copy_channel_attr_to_ustctl(
                struct ustctl_consumer_channel_attr *attr,
                struct lttng_ust_channel_attr *uattr)
{
        /* Copy event attributes since the layout is different. */
        attr->subbuf_size = uattr->subbuf_size;
        attr->num_subbuf = uattr->num_subbuf;
        attr->overwrite = uattr->overwrite;
        attr->switch_timer_interval = uattr->switch_timer_interval;
        attr->read_timer_interval = uattr->read_timer_interval;
        attr->output = uattr->output;
        attr->blocking_timeout = uattr->u.s.blocking_timeout;
}

/*
 * Match function for the hash table lookup.
 *
 * It matches an ust app event based on three attributes which are the event
 * name, the filter bytecode and the loglevel.
 */
static int ht_match_ust_app_event(struct cds_lfht_node *node, const void *_key)
{
        struct ust_app_event *event;
        const struct ust_app_ht_key *key;
        int ev_loglevel_value;

        assert(node);
        assert(_key);

        event = caa_container_of(node, struct ust_app_event, node.node);
        key = _key;
        ev_loglevel_value = event->attr.loglevel;

        /* Match the 4 elements of the key: name, filter, loglevel, exclusions */

        /* Event name */
        if (strncmp(event->attr.name, key->name, sizeof(event->attr.name)) != 0) {
                goto no_match;
        }

        /* Event loglevel. */
        if (ev_loglevel_value != key->loglevel_type) {
                if (event->attr.loglevel_type == LTTNG_UST_LOGLEVEL_ALL
                                && key->loglevel_type == 0 &&
                                ev_loglevel_value == -1) {
                        /*
                         * Match is accepted. This is because on event creation, the
                         * loglevel is set to -1 if the event loglevel type is ALL so 0 and
                         * -1 are accepted for this loglevel type since 0 is the one set by
                         * the API when receiving an enable event.
                         */
                } else {
                        goto no_match;
                }
        }

        /* One of the filters is NULL, fail. */
        if ((key->filter && !event->filter) || (!key->filter && event->filter)) {
                goto no_match;
        }

        if (key->filter && event->filter) {
                /* Both filters exists, check length followed by the bytecode. */
                if (event->filter->len != key->filter->len ||
                                memcmp(event->filter->data, key->filter->data,
                                        event->filter->len) != 0) {
                        goto no_match;
                }
        }

        /* One of the exclusions is NULL, fail. */
        if ((key->exclusion && !event->exclusion) || (!key->exclusion && event->exclusion)) {
                goto no_match;
        }

        if (key->exclusion && event->exclusion) {
                /* Both exclusions exists, check count followed by the names. */
                if (event->exclusion->count != key->exclusion->count ||
                                memcmp(event->exclusion->names, key->exclusion->names,
                                        event->exclusion->count * LTTNG_UST_SYM_NAME_LEN) != 0) {
                        goto no_match;
                }
        }


        /* Match. */
        return 1;

no_match:
        return 0;
}

/*
 * Unique add of an ust app event in the given ht. This uses the custom
 * ht_match_ust_app_event match function and the event name as hash.
 */
static void add_unique_ust_app_event(struct ust_app_channel *ua_chan,
                struct ust_app_event *event)
{
        struct cds_lfht_node *node_ptr;
        struct ust_app_ht_key key;
        struct lttng_ht *ht;

        assert(ua_chan);
        assert(ua_chan->events);
        assert(event);

        ht = ua_chan->events;
        key.name = event->attr.name;
        key.filter = event->filter;
        key.loglevel_type = event->attr.loglevel;
        key.exclusion = event->exclusion;

        node_ptr = cds_lfht_add_unique(ht->ht,
                        ht->hash_fct(event->node.key, lttng_ht_seed),
                        ht_match_ust_app_event, &key, &event->node.node);
        assert(node_ptr == &event->node.node);
}

/*
 * Close the notify socket from the given RCU head object. This MUST be called
 * through a call_rcu().
 */
static void close_notify_sock_rcu(struct rcu_head *head)
{
        int ret;
        struct ust_app_notify_sock_obj *obj =
                caa_container_of(head, struct ust_app_notify_sock_obj, head);

        /* Must have a valid fd here. */
        assert(obj->fd >= 0);

        ret = close(obj->fd);
        if (ret) {
                ERR("close notify sock %d RCU", obj->fd);
        }
        lttng_fd_put(LTTNG_FD_APPS, 1);

        free(obj);
}

/*
 * Return the session registry according to the buffer type of the given
 * session.
 *
 * A registry per UID object MUST exists before calling this function or else
 * it assert() if not found. RCU read side lock must be acquired.
 */
static struct ust_registry_session *get_session_registry(
                struct ust_app_session *ua_sess)
{
        struct ust_registry_session *registry = NULL;

        assert(ua_sess);

        switch (ua_sess->buffer_type) {
        case LTTNG_BUFFER_PER_PID:
        {
                struct buffer_reg_pid *reg_pid = buffer_reg_pid_find(ua_sess->id);
                if (!reg_pid) {
                        goto error;
                }
                registry = reg_pid->registry->reg.ust;
                break;
        }
        case LTTNG_BUFFER_PER_UID:
        {
                struct buffer_reg_uid *reg_uid = buffer_reg_uid_find(
                                ua_sess->tracing_id, ua_sess->bits_per_long, ua_sess->uid);
                if (!reg_uid) {
                        goto error;
                }
                registry = reg_uid->registry->reg.ust;
                break;
        }
        default:
                assert(0);
        };

error:
        return registry;
}

/*
 * Delete ust context safely. RCU read lock must be held before calling
 * this function.
 */
static
void delete_ust_app_ctx(int sock, struct ust_app_ctx *ua_ctx,
                struct ust_app *app)
{
        int ret;

        assert(ua_ctx);

        if (ua_ctx->obj) {
                pthread_mutex_lock(&app->sock_lock);
                ret = ustctl_release_object(sock, ua_ctx->obj);
                pthread_mutex_unlock(&app->sock_lock);
                if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
                                        sock, ua_ctx->obj->handle, ret);
                }
                free(ua_ctx->obj);
        }
        free(ua_ctx);
}

/*
 * Delete ust app event safely. RCU read lock must be held before calling
 * this function.
 */
static
void delete_ust_app_event(int sock, struct ust_app_event *ua_event,
                struct ust_app *app)
{
        int ret;

        assert(ua_event);

        free(ua_event->filter);
        if (ua_event->exclusion != NULL)
                free(ua_event->exclusion);
        if (ua_event->obj != NULL) {
                pthread_mutex_lock(&app->sock_lock);
                ret = ustctl_release_object(sock, ua_event->obj);
                pthread_mutex_unlock(&app->sock_lock);
                if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app sock %d release event obj failed with ret %d",
                                        sock, ret);
                }
                free(ua_event->obj);
        }
        free(ua_event);
}

/*
 * Release ust data object of the given stream.
 *
 * Return 0 on success or else a negative value.
 */
static int release_ust_app_stream(int sock, struct ust_app_stream *stream,
                struct ust_app *app)
{
        int ret = 0;

        assert(stream);

        if (stream->obj) {
                pthread_mutex_lock(&app->sock_lock);
                ret = ustctl_release_object(sock, stream->obj);
                pthread_mutex_unlock(&app->sock_lock);
                if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app sock %d release stream obj failed with ret %d",
                                        sock, ret);
                }
                lttng_fd_put(LTTNG_FD_APPS, 2);
                free(stream->obj);
        }

        return ret;
}

/*
 * Delete ust app stream safely. RCU read lock must be held before calling
 * this function.
 */
static
void delete_ust_app_stream(int sock, struct ust_app_stream *stream,
                struct ust_app *app)
{
        assert(stream);

        (void) release_ust_app_stream(sock, stream, app);
        free(stream);
}

/*
 * We need to execute ht_destroy outside of RCU read-side critical
 * section and outside of call_rcu thread, so we postpone its execution
 * using ht_cleanup_push. It is simpler than to change the semantic of
 * the many callers of delete_ust_app_session().
 */
static
void delete_ust_app_channel_rcu(struct rcu_head *head)
{
        struct ust_app_channel *ua_chan =
                caa_container_of(head, struct ust_app_channel, rcu_head);

        ht_cleanup_push(ua_chan->ctx);
        ht_cleanup_push(ua_chan->events);
        free(ua_chan);
}

/*
 * Extract the lost packet or discarded events counter when the channel is
 * being deleted and store the value in the parent channel so we can
 * access it from lttng list and at stop/destroy.
 *
 * The session list lock must be held by the caller.
 */
static
void save_per_pid_lost_discarded_counters(struct ust_app_channel *ua_chan)
{
        uint64_t discarded = 0, lost = 0;
        struct ltt_session *session;
        struct ltt_ust_channel *uchan;

        if (ua_chan->attr.type != LTTNG_UST_CHAN_PER_CPU) {
                return;
        }

        rcu_read_lock();
        session = session_find_by_id(ua_chan->session->tracing_id);
        if (!session || !session->ust_session) {
                /*
                 * Not finding the session is not an error because there are
                 * multiple ways the channels can be torn down.
                 *
                 * 1) The session daemon can initiate the destruction of the
                 *    ust app session after receiving a destroy command or
                 *    during its shutdown/teardown.
                 * 2) The application, since we are in per-pid tracing, is
                 *    unregistering and tearing down its ust app session.
                 *
                 * Both paths are protected by the session list lock which
                 * ensures that the accounting of lost packets and discarded
                 * events is done exactly once. The session is then unpublished
                 * from the session list, resulting in this condition.
                 */
                goto end;
        }

        if (ua_chan->attr.overwrite) {
                consumer_get_lost_packets(ua_chan->session->tracing_id,
                                ua_chan->key, session->ust_session->consumer,
                                &lost);
        } else {
                consumer_get_discarded_events(ua_chan->session->tracing_id,
                                ua_chan->key, session->ust_session->consumer,
                                &discarded);
        }
        uchan = trace_ust_find_channel_by_name(
                        session->ust_session->domain_global.channels,
                        ua_chan->name);
        if (!uchan) {
                ERR("Missing UST channel to store discarded counters");
                goto end;
        }

        uchan->per_pid_closed_app_discarded += discarded;
        uchan->per_pid_closed_app_lost += lost;

end:
        rcu_read_unlock();
}

/*
 * Delete ust app channel safely. RCU read lock must be held before calling
 * this function.
 *
 * The session list lock must be held by the caller.
 */
static
void delete_ust_app_channel(int sock, struct ust_app_channel *ua_chan,
                struct ust_app *app)
{
        int ret;
        struct lttng_ht_iter iter;
        struct ust_app_event *ua_event;
        struct ust_app_ctx *ua_ctx;
        struct ust_app_stream *stream, *stmp;
        struct ust_registry_session *registry;

        assert(ua_chan);

        DBG3("UST app deleting channel %s", ua_chan->name);

        /* Wipe stream */
        cds_list_for_each_entry_safe(stream, stmp, &ua_chan->streams.head, list) {
                cds_list_del(&stream->list);
                delete_ust_app_stream(sock, stream, app);
        }

        /* Wipe context */
        cds_lfht_for_each_entry(ua_chan->ctx->ht, &iter.iter, ua_ctx, node.node) {
                cds_list_del(&ua_ctx->list);
                ret = lttng_ht_del(ua_chan->ctx, &iter);
                assert(!ret);
                delete_ust_app_ctx(sock, ua_ctx, app);
        }

        /* Wipe events */
        cds_lfht_for_each_entry(ua_chan->events->ht, &iter.iter, ua_event,
                        node.node) {
                ret = lttng_ht_del(ua_chan->events, &iter);
                assert(!ret);
                delete_ust_app_event(sock, ua_event, app);
        }

        if (ua_chan->session->buffer_type == LTTNG_BUFFER_PER_PID) {
                /* Wipe and free registry from session registry. */
                registry = get_session_registry(ua_chan->session);
                if (registry) {
                        ust_registry_channel_del_free(registry, ua_chan->key,
                                true);
                }
                save_per_pid_lost_discarded_counters(ua_chan);
        }

        if (ua_chan->obj != NULL) {
                /* Remove channel from application UST object descriptor. */
                iter.iter.node = &ua_chan->ust_objd_node.node;
                ret = lttng_ht_del(app->ust_objd, &iter);
                assert(!ret);
                pthread_mutex_lock(&app->sock_lock);
                ret = ustctl_release_object(sock, ua_chan->obj);
                pthread_mutex_unlock(&app->sock_lock);
                if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app sock %d release channel obj failed with ret %d",
                                        sock, ret);
                }
                lttng_fd_put(LTTNG_FD_APPS, 1);
                free(ua_chan->obj);
        }
        call_rcu(&ua_chan->rcu_head, delete_ust_app_channel_rcu);
}

int ust_app_register_done(struct ust_app *app)
{
        int ret;

        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_register_done(app->sock);
        pthread_mutex_unlock(&app->sock_lock);
        return ret;
}

int ust_app_release_object(struct ust_app *app, struct lttng_ust_object_data *data)
{
        int ret, sock;

        if (app) {
                pthread_mutex_lock(&app->sock_lock);
                sock = app->sock;
        } else {
                sock = -1;
        }
        ret = ustctl_release_object(sock, data);
        if (app) {
                pthread_mutex_unlock(&app->sock_lock);
        }
        return ret;
}

/*
 * Push metadata to consumer socket.
 *
 * RCU read-side lock must be held to guarantee existance of socket.
 * Must be called with the ust app session lock held.
 * Must be called with the registry lock held.
 *
 * On success, return the len of metadata pushed or else a negative value.
 * Returning a -EPIPE return value means we could not send the metadata,
 * but it can be caused by recoverable errors (e.g. the application has
 * terminated concurrently).
 */
ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
                struct consumer_socket *socket, int send_zero_data)
{
        int ret;
        char *metadata_str = NULL;
        size_t len, offset, new_metadata_len_sent;
        ssize_t ret_val;
        uint64_t metadata_key, metadata_version;

        assert(registry);
        assert(socket);

        metadata_key = registry->metadata_key;

        /*
         * Means that no metadata was assigned to the session. This can
         * happens if no start has been done previously.
         */
        if (!metadata_key) {
                return 0;
        }

        offset = registry->metadata_len_sent;
        len = registry->metadata_len - registry->metadata_len_sent;
        new_metadata_len_sent = registry->metadata_len;
        metadata_version = registry->metadata_version;
        if (len == 0) {
                DBG3("No metadata to push for metadata key %" PRIu64,
                                registry->metadata_key);
                ret_val = len;
                if (send_zero_data) {
                        DBG("No metadata to push");
                        goto push_data;
                }
                goto end;
        }

        /* Allocate only what we have to send. */
        metadata_str = zmalloc(len);
        if (!metadata_str) {
                PERROR("zmalloc ust app metadata string");
                ret_val = -ENOMEM;
                goto error;
        }
        /* Copy what we haven't sent out. */
        memcpy(metadata_str, registry->metadata + offset, len);

push_data:
        pthread_mutex_unlock(&registry->lock);
        /*
         * We need to unlock the registry while we push metadata to
         * break a circular dependency between the consumerd metadata
         * lock and the sessiond registry lock. Indeed, pushing metadata
         * to the consumerd awaits that it gets pushed all the way to
         * relayd, but doing so requires grabbing the metadata lock. If
         * a concurrent metadata request is being performed by
         * consumerd, this can try to grab the registry lock on the
         * sessiond while holding the metadata lock on the consumer
         * daemon. Those push and pull schemes are performed on two
         * different bidirectionnal communication sockets.
         */
        ret = consumer_push_metadata(socket, metadata_key,
                        metadata_str, len, offset, metadata_version);
        pthread_mutex_lock(&registry->lock);
        if (ret < 0) {
                /*
                 * There is an acceptable race here between the registry
                 * metadata key assignment and the creation on the
                 * consumer. The session daemon can concurrently push
                 * metadata for this registry while being created on the
                 * consumer since the metadata key of the registry is
                 * assigned *before* it is setup to avoid the consumer
                 * to ask for metadata that could possibly be not found
                 * in the session daemon.
                 *
                 * The metadata will get pushed either by the session
                 * being stopped or the consumer requesting metadata if
                 * that race is triggered.
                 */
                if (ret == -LTTCOMM_CONSUMERD_CHANNEL_FAIL) {
                        ret = 0;
                } else {
                        ERR("Error pushing metadata to consumer");
                }
                ret_val = ret;
                goto error_push;
        } else {
                /*
                 * Metadata may have been concurrently pushed, since
                 * we're not holding the registry lock while pushing to
                 * consumer.  This is handled by the fact that we send
                 * the metadata content, size, and the offset at which
                 * that metadata belongs. This may arrive out of order
                 * on the consumer side, and the consumer is able to
                 * deal with overlapping fragments. The consumer
                 * supports overlapping fragments, which must be
                 * contiguous starting from offset 0. We keep the
                 * largest metadata_len_sent value of the concurrent
                 * send.
                 */
                registry->metadata_len_sent =
                        max_t(size_t, registry->metadata_len_sent,
                                new_metadata_len_sent);
        }
        free(metadata_str);
        return len;

end:
error:
        if (ret_val) {
                /*
                 * On error, flag the registry that the metadata is
                 * closed. We were unable to push anything and this
                 * means that either the consumer is not responding or
                 * the metadata cache has been destroyed on the
                 * consumer.
                 */
                registry->metadata_closed = 1;
        }
error_push:
        free(metadata_str);
        return ret_val;
}

/*
 * For a given application and session, push metadata to consumer.
 * Either sock or consumer is required : if sock is NULL, the default
 * socket to send the metadata is retrieved from consumer, if sock
 * is not NULL we use it to send the metadata.
 * RCU read-side lock must be held while calling this function,
 * therefore ensuring existance of registry. It also ensures existance
 * of socket throughout this function.
 *
 * Return 0 on success else a negative error.
 * Returning a -EPIPE return value means we could not send the metadata,
 * but it can be caused by recoverable errors (e.g. the application has
 * terminated concurrently).
 */
static int push_metadata(struct ust_registry_session *registry,
                struct consumer_output *consumer)
{
        int ret_val;
        ssize_t ret;
        struct consumer_socket *socket;

        assert(registry);
        assert(consumer);

        pthread_mutex_lock(&registry->lock);
        if (registry->metadata_closed) {
                ret_val = -EPIPE;
                goto error;
        }

        /* Get consumer socket to use to push the metadata.*/
        socket = consumer_find_socket_by_bitness(registry->bits_per_long,
                        consumer);
        if (!socket) {
                ret_val = -1;
                goto error;
        }

        ret = ust_app_push_metadata(registry, socket, 0);
        if (ret < 0) {
                ret_val = ret;
                goto error;
        }
        pthread_mutex_unlock(&registry->lock);
        return 0;

error:
        pthread_mutex_unlock(&registry->lock);
        return ret_val;
}

/*
 * Send to the consumer a close metadata command for the given session. Once
 * done, the metadata channel is deleted and the session metadata pointer is
 * nullified. The session lock MUST be held unless the application is
 * in the destroy path.
 *
 * Return 0 on success else a negative value.
 */
static int close_metadata(struct ust_registry_session *registry,
                struct consumer_output *consumer)
{
        int ret;
        struct consumer_socket *socket;

        assert(registry);
        assert(consumer);

        rcu_read_lock();

        pthread_mutex_lock(&registry->lock);

        if (!registry->metadata_key || registry->metadata_closed) {
                ret = 0;
                goto end;
        }

        /* Get consumer socket to use to push the metadata.*/
        socket = consumer_find_socket_by_bitness(registry->bits_per_long,
                        consumer);
        if (!socket) {
                ret = -1;
                goto error;
        }

        ret = consumer_close_metadata(socket, registry->metadata_key);
        if (ret < 0) {
                goto error;
        }

error:
        /*
         * Metadata closed. Even on error this means that the consumer is not
         * responding or not found so either way a second close should NOT be emit
         * for this registry.
         */
        registry->metadata_closed = 1;
end:
        pthread_mutex_unlock(&registry->lock);
        rcu_read_unlock();
        return ret;
}

/*
 * We need to execute ht_destroy outside of RCU read-side critical
 * section and outside of call_rcu thread, so we postpone its execution
 * using ht_cleanup_push. It is simpler than to change the semantic of
 * the many callers of delete_ust_app_session().
 */
static
void delete_ust_app_session_rcu(struct rcu_head *head)
{
        struct ust_app_session *ua_sess =
                caa_container_of(head, struct ust_app_session, rcu_head);

        ht_cleanup_push(ua_sess->channels);
        free(ua_sess);
}

/*
 * Delete ust app session safely. RCU read lock must be held before calling
 * this function.
 *
 * The session list lock must be held by the caller.
 */
static
void delete_ust_app_session(int sock, struct ust_app_session *ua_sess,
                struct ust_app *app)
{
        int ret;
        struct lttng_ht_iter iter;
        struct ust_app_channel *ua_chan;
        struct ust_registry_session *registry;

        assert(ua_sess);

        pthread_mutex_lock(&ua_sess->lock);

        assert(!ua_sess->deleted);
        ua_sess->deleted = true;

        registry = get_session_registry(ua_sess);
        /* Registry can be null on error path during initialization. */
        if (registry) {
                /* Push metadata for application before freeing the application. */
                (void) push_metadata(registry, ua_sess->consumer);

                /*
                 * Don't ask to close metadata for global per UID buffers. Close
                 * metadata only on destroy trace session in this case. Also, the
                 * previous push metadata could have flag the metadata registry to
                 * close so don't send a close command if closed.
                 */
                if (ua_sess->buffer_type != LTTNG_BUFFER_PER_UID) {
                        /* And ask to close it for this session registry. */
                        (void) close_metadata(registry, ua_sess->consumer);
                }
        }

        cds_lfht_for_each_entry(ua_sess->channels->ht, &iter.iter, ua_chan,
                        node.node) {
                ret = lttng_ht_del(ua_sess->channels, &iter);
                assert(!ret);
                delete_ust_app_channel(sock, ua_chan, app);
        }

        /* In case of per PID, the registry is kept in the session. */
        if (ua_sess->buffer_type == LTTNG_BUFFER_PER_PID) {
                struct buffer_reg_pid *reg_pid = buffer_reg_pid_find(ua_sess->id);
                if (reg_pid) {
                        /*
                         * Registry can be null on error path during
                         * initialization.
                         */
                        buffer_reg_pid_remove(reg_pid);
                        buffer_reg_pid_destroy(reg_pid);
                }
        }

        if (ua_sess->handle != -1) {
                pthread_mutex_lock(&app->sock_lock);
                ret = ustctl_release_handle(sock, ua_sess->handle);
                pthread_mutex_unlock(&app->sock_lock);
                if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app sock %d release session handle failed with ret %d",
                                        sock, ret);
                }
                /* Remove session from application UST object descriptor. */
                iter.iter.node = &ua_sess->ust_objd_node.node;
                ret = lttng_ht_del(app->ust_sessions_objd, &iter);
                assert(!ret);
        }

        pthread_mutex_unlock(&ua_sess->lock);

        consumer_output_put(ua_sess->consumer);

        call_rcu(&ua_sess->rcu_head, delete_ust_app_session_rcu);
}

/*
 * Delete a traceable application structure from the global list. Never call
 * this function outside of a call_rcu call.
 *
 * RCU read side lock should _NOT_ be held when calling this function.
 */
static
void delete_ust_app(struct ust_app *app)
{
        int ret, sock;
        struct ust_app_session *ua_sess, *tmp_ua_sess;

        /*
         * The session list lock must be held during this function to guarantee
         * the existence of ua_sess.
         */
        session_lock_list();
        /* Delete ust app sessions info */
        sock = app->sock;
        app->sock = -1;

        /* Wipe sessions */
        cds_list_for_each_entry_safe(ua_sess, tmp_ua_sess, &app->teardown_head,
                        teardown_node) {
                /* Free every object in the session and the session. */
                rcu_read_lock();
                delete_ust_app_session(sock, ua_sess, app);
                rcu_read_unlock();
        }

        ht_cleanup_push(app->sessions);
        ht_cleanup_push(app->ust_sessions_objd);
        ht_cleanup_push(app->ust_objd);

        /*
         * Wait until we have deleted the application from the sock hash table
         * before closing this socket, otherwise an application could re-use the
         * socket ID and race with the teardown, using the same hash table entry.
         *
         * It's OK to leave the close in call_rcu. We want it to stay unique for
         * all RCU readers that could run concurrently with unregister app,
         * therefore we _need_ to only close that socket after a grace period. So
         * it should stay in this RCU callback.
         *
         * This close() is a very important step of the synchronization model so
         * every modification to this function must be carefully reviewed.
         */
        ret = close(sock);
        if (ret) {
                PERROR("close");
        }
        lttng_fd_put(LTTNG_FD_APPS, 1);

        DBG2("UST app pid %d deleted", app->pid);
        free(app);
        session_unlock_list();
}

/*
 * URCU intermediate call to delete an UST app.
 */
static
void delete_ust_app_rcu(struct rcu_head *head)
{
        struct lttng_ht_node_ulong *node =
                caa_container_of(head, struct lttng_ht_node_ulong, head);
        struct ust_app *app =
                caa_container_of(node, struct ust_app, pid_n);

        DBG3("Call RCU deleting app PID %d", app->pid);
        delete_ust_app(app);
}

/*
 * Delete the session from the application ht and delete the data structure by
 * freeing every object inside and releasing them.
 *
 * The session list lock must be held by the caller.
 */
static void destroy_app_session(struct ust_app *app,
                struct ust_app_session *ua_sess)
{
        int ret;
        struct lttng_ht_iter iter;

        assert(app);
        assert(ua_sess);

        iter.iter.node = &ua_sess->node.node;
        ret = lttng_ht_del(app->sessions, &iter);
        if (ret) {
                /* Already scheduled for teardown. */
                goto end;
        }

        /* Once deleted, free the data structure. */
        delete_ust_app_session(app->sock, ua_sess, app);

end:
        return;
}

/*
 * Alloc new UST app session.
 */
static
struct ust_app_session *alloc_ust_app_session(void)
{
        struct ust_app_session *ua_sess;

        /* Init most of the default value by allocating and zeroing */
        ua_sess = zmalloc(sizeof(struct ust_app_session));
        if (ua_sess == NULL) {
                PERROR("malloc");
                goto error_free;
        }

        ua_sess->handle = -1;
        ua_sess->channels = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
        ua_sess->metadata_attr.type = LTTNG_UST_CHAN_METADATA;
        pthread_mutex_init(&ua_sess->lock, NULL);

        return ua_sess;

error_free:
        return NULL;
}

/*
 * Alloc new UST app channel.
 */
static
struct ust_app_channel *alloc_ust_app_channel(char *name,
                struct ust_app_session *ua_sess,
                struct lttng_ust_channel_attr *attr)
{
        struct ust_app_channel *ua_chan;

        /* Init most of the default value by allocating and zeroing */
        ua_chan = zmalloc(sizeof(struct ust_app_channel));
        if (ua_chan == NULL) {
                PERROR("malloc");
                goto error;
        }

        /* Setup channel name */
        strncpy(ua_chan->name, name, sizeof(ua_chan->name));
        ua_chan->name[sizeof(ua_chan->name) - 1] = '\0';

        ua_chan->enabled = 1;
        ua_chan->handle = -1;
        ua_chan->session = ua_sess;
        ua_chan->key = get_next_channel_key();
        ua_chan->ctx = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
        ua_chan->events = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
        lttng_ht_node_init_str(&ua_chan->node, ua_chan->name);

        CDS_INIT_LIST_HEAD(&ua_chan->streams.head);
        CDS_INIT_LIST_HEAD(&ua_chan->ctx_list);

        /* Copy attributes */
        if (attr) {
                /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
                ua_chan->attr.subbuf_size = attr->subbuf_size;
                ua_chan->attr.num_subbuf = attr->num_subbuf;
                ua_chan->attr.overwrite = attr->overwrite;
                ua_chan->attr.switch_timer_interval = attr->switch_timer_interval;
                ua_chan->attr.read_timer_interval = attr->read_timer_interval;
                ua_chan->attr.output = attr->output;
                ua_chan->attr.blocking_timeout = attr->u.s.blocking_timeout;
        }
        /* By default, the channel is a per cpu channel. */
        ua_chan->attr.type = LTTNG_UST_CHAN_PER_CPU;

        DBG3("UST app channel %s allocated", ua_chan->name);

        return ua_chan;

error:
        return NULL;
}

/*
 * Allocate and initialize a UST app stream.
 *
 * Return newly allocated stream pointer or NULL on error.
 */
struct ust_app_stream *ust_app_alloc_stream(void)
{
        struct ust_app_stream *stream = NULL;

        stream = zmalloc(sizeof(*stream));
        if (stream == NULL) {
                PERROR("zmalloc ust app stream");
                goto error;
        }

        /* Zero could be a valid value for a handle so flag it to -1. */
        stream->handle = -1;

error:
        return stream;
}

/*
 * Alloc new UST app event.
 */
static
struct ust_app_event *alloc_ust_app_event(char *name,
                struct lttng_ust_event *attr)
{
        struct ust_app_event *ua_event;

        /* Init most of the default value by allocating and zeroing */
        ua_event = zmalloc(sizeof(struct ust_app_event));
        if (ua_event == NULL) {
                PERROR("malloc");
                goto error;
        }

        ua_event->enabled = 1;
        strncpy(ua_event->name, name, sizeof(ua_event->name));
        ua_event->name[sizeof(ua_event->name) - 1] = '\0';
        lttng_ht_node_init_str(&ua_event->node, ua_event->name);

        /* Copy attributes */
        if (attr) {
                memcpy(&ua_event->attr, attr, sizeof(ua_event->attr));
        }

        DBG3("UST app event %s allocated", ua_event->name);

        return ua_event;

error:
        return NULL;
}

/*
 * Alloc new UST app context.
 */
static
struct ust_app_ctx *alloc_ust_app_ctx(struct lttng_ust_context_attr *uctx)
{
        struct ust_app_ctx *ua_ctx;

        ua_ctx = zmalloc(sizeof(struct ust_app_ctx));
        if (ua_ctx == NULL) {
                goto error;
        }

        CDS_INIT_LIST_HEAD(&ua_ctx->list);

        if (uctx) {
                memcpy(&ua_ctx->ctx, uctx, sizeof(ua_ctx->ctx));
                if (uctx->ctx == LTTNG_UST_CONTEXT_APP_CONTEXT) {
                        char *provider_name = NULL, *ctx_name = NULL;

                        provider_name = strdup(uctx->u.app_ctx.provider_name);
                        ctx_name = strdup(uctx->u.app_ctx.ctx_name);
                        if (!provider_name || !ctx_name) {
                                free(provider_name);
                                free(ctx_name);
                                goto error;
                        }

                        ua_ctx->ctx.u.app_ctx.provider_name = provider_name;
                        ua_ctx->ctx.u.app_ctx.ctx_name = ctx_name;
                }
        }

        DBG3("UST app context %d allocated", ua_ctx->ctx.ctx);
        return ua_ctx;
error:
        free(ua_ctx);
        return NULL;
}

/*
 * Allocate a filter and copy the given original filter.
 *
 * Return allocated filter or NULL on error.
 */
static struct lttng_filter_bytecode *copy_filter_bytecode(
                struct lttng_filter_bytecode *orig_f)
{
        struct lttng_filter_bytecode *filter = NULL;

        /* Copy filter bytecode */
        filter = zmalloc(sizeof(*filter) + orig_f->len);
        if (!filter) {
                PERROR("zmalloc alloc filter bytecode");
                goto error;
        }

        memcpy(filter, orig_f, sizeof(*filter) + orig_f->len);

error:
        return filter;
}

/*
 * Create a liblttng-ust filter bytecode from given bytecode.
 *
 * Return allocated filter or NULL on error.
 */
static struct lttng_ust_filter_bytecode *create_ust_bytecode_from_bytecode(
                struct lttng_filter_bytecode *orig_f)
{
        struct lttng_ust_filter_bytecode *filter = NULL;

        /* Copy filter bytecode */
        filter = zmalloc(sizeof(*filter) + orig_f->len);
        if (!filter) {
                PERROR("zmalloc alloc ust filter bytecode");
                goto error;
        }

        assert(sizeof(struct lttng_filter_bytecode) ==
                        sizeof(struct lttng_ust_filter_bytecode));
        memcpy(filter, orig_f, sizeof(*filter) + orig_f->len);
error:
        return filter;
}

/*
 * Find an ust_app using the sock and return it. RCU read side lock must be
 * held before calling this helper function.
 */
struct ust_app *ust_app_find_by_sock(int sock)
{
        struct lttng_ht_node_ulong *node;
        struct lttng_ht_iter iter;

        lttng_ht_lookup(ust_app_ht_by_sock, (void *)((unsigned long) sock), &iter);
        node = lttng_ht_iter_get_node_ulong(&iter);
        if (node == NULL) {
                DBG2("UST app find by sock %d not found", sock);
                goto error;
        }

        return caa_container_of(node, struct ust_app, sock_n);

error:
        return NULL;
}

/*
 * Find an ust_app using the notify sock and return it. RCU read side lock must
 * be held before calling this helper function.
 */
static struct ust_app *find_app_by_notify_sock(int sock)
{
        struct lttng_ht_node_ulong *node;
        struct lttng_ht_iter iter;

        lttng_ht_lookup(ust_app_ht_by_notify_sock, (void *)((unsigned long) sock),
                        &iter);
        node = lttng_ht_iter_get_node_ulong(&iter);
        if (node == NULL) {
                DBG2("UST app find by notify sock %d not found", sock);
                goto error;
        }

        return caa_container_of(node, struct ust_app, notify_sock_n);

error:
        return NULL;
}

/*
 * Lookup for an ust app event based on event name, filter bytecode and the
 * event loglevel.
 *
 * Return an ust_app_event object or NULL on error.
 */
static struct ust_app_event *find_ust_app_event(struct lttng_ht *ht,
                char *name, struct lttng_filter_bytecode *filter,
                int loglevel_value,
                const struct lttng_event_exclusion *exclusion)
{
        struct lttng_ht_iter iter;
        struct lttng_ht_node_str *node;
        struct ust_app_event *event = NULL;
        struct ust_app_ht_key key;

        assert(name);
        assert(ht);

        /* Setup key for event lookup. */
        key.name = name;
        key.filter = filter;
        key.loglevel_type = loglevel_value;
        /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
        key.exclusion = exclusion;

        /* Lookup using the event name as hash and a custom match fct. */
        cds_lfht_lookup(ht->ht, ht->hash_fct((void *) name, lttng_ht_seed),
                        ht_match_ust_app_event, &key, &iter.iter);
        node = lttng_ht_iter_get_node_str(&iter);
        if (node == NULL) {
                goto end;
        }

        event = caa_container_of(node, struct ust_app_event, node);

end:
        return event;
}

/*
 * Create the channel context on the tracer.
 *
 * Called with UST app session lock held.
 */
static
int create_ust_channel_context(struct ust_app_channel *ua_chan,
                struct ust_app_ctx *ua_ctx, struct ust_app *app)
{
        int ret;

        health_code_update();

        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_add_context(app->sock, &ua_ctx->ctx,
                        ua_chan->obj, &ua_ctx->obj);
        pthread_mutex_unlock(&app->sock_lock);
        if (ret < 0) {
                if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app create channel context failed for app (pid: %d) "
                                        "with ret %d", app->pid, ret);
                } else {
                        /*
                         * This is normal behavior, an application can die during the
                         * creation process. Don't report an error so the execution can
                         * continue normally.
                         */
                        ret = 0;
                        DBG3("UST app disable event failed. Application is dead.");
                }
                goto error;
        }

        ua_ctx->handle = ua_ctx->obj->handle;

        DBG2("UST app context handle %d created successfully for channel %s",
                        ua_ctx->handle, ua_chan->name);

error:
        health_code_update();
        return ret;
}

/*
 * Set the filter on the tracer.
 */
static
int set_ust_event_filter(struct ust_app_event *ua_event,
                struct ust_app *app)
{
        int ret;
        struct lttng_ust_filter_bytecode *ust_bytecode = NULL;

        health_code_update();

        if (!ua_event->filter) {
                ret = 0;
                goto error;
        }

        ust_bytecode = create_ust_bytecode_from_bytecode(ua_event->filter);
        if (!ust_bytecode) {
                ret = -LTTNG_ERR_NOMEM;
                goto error;
        }
        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_set_filter(app->sock, ust_bytecode,
                        ua_event->obj);
        pthread_mutex_unlock(&app->sock_lock);
        if (ret < 0) {
                if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app event %s filter failed for app (pid: %d) "
                                        "with ret %d", ua_event->attr.name, app->pid, ret);
                } else {
                        /*
                         * This is normal behavior, an application can die during the
                         * creation process. Don't report an error so the execution can
                         * continue normally.
                         */
                        ret = 0;
                        DBG3("UST app filter event failed. Application is dead.");
                }
                goto error;
        }

        DBG2("UST filter set successfully for event %s", ua_event->name);

error:
        health_code_update();
        free(ust_bytecode);
        return ret;
}

static
struct lttng_ust_event_exclusion *create_ust_exclusion_from_exclusion(
                struct lttng_event_exclusion *exclusion)
{
        struct lttng_ust_event_exclusion *ust_exclusion = NULL;
        size_t exclusion_alloc_size = sizeof(struct lttng_ust_event_exclusion) +
                LTTNG_UST_SYM_NAME_LEN * exclusion->count;

        ust_exclusion = zmalloc(exclusion_alloc_size);
        if (!ust_exclusion) {
                PERROR("malloc");
                goto end;
        }

        assert(sizeof(struct lttng_event_exclusion) ==
                        sizeof(struct lttng_ust_event_exclusion));
        memcpy(ust_exclusion, exclusion, exclusion_alloc_size);
end:
        return ust_exclusion;
}

/*
 * Set event exclusions on the tracer.
 */
static
int set_ust_event_exclusion(struct ust_app_event *ua_event,
                struct ust_app *app)
{
        int ret;
        struct lttng_ust_event_exclusion *ust_exclusion = NULL;

        health_code_update();

        if (!ua_event->exclusion || !ua_event->exclusion->count) {
                ret = 0;
                goto error;
        }

        ust_exclusion = create_ust_exclusion_from_exclusion(
                        ua_event->exclusion);
        if (!ust_exclusion) {
                ret = -LTTNG_ERR_NOMEM;
                goto error;
        }
        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_set_exclusion(app->sock, ust_exclusion, ua_event->obj);
        pthread_mutex_unlock(&app->sock_lock);
        if (ret < 0) {
                if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app event %s exclusions failed for app (pid: %d) "
                                        "with ret %d", ua_event->attr.name, app->pid, ret);
                } else {
                        /*
                         * This is normal behavior, an application can die during the
                         * creation process. Don't report an error so the execution can
                         * continue normally.
                         */
                        ret = 0;
                        DBG3("UST app event exclusion failed. Application is dead.");
                }
                goto error;
        }

        DBG2("UST exclusion set successfully for event %s", ua_event->name);

error:
        health_code_update();
        free(ust_exclusion);
        return ret;
}

/*
 * Disable the specified event on to UST tracer for the UST session.
 */
static int disable_ust_event(struct ust_app *app,
                struct ust_app_session *ua_sess, struct ust_app_event *ua_event)
{
        int ret;

        health_code_update();

        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_disable(app->sock, ua_event->obj);
        pthread_mutex_unlock(&app->sock_lock);
        if (ret < 0) {
                if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app event %s disable failed for app (pid: %d) "
                                        "and session handle %d with ret %d",
                                        ua_event->attr.name, app->pid, ua_sess->handle, ret);
                } else {
                        /*
                         * This is normal behavior, an application can die during the
                         * creation process. Don't report an error so the execution can
                         * continue normally.
                         */
                        ret = 0;
                        DBG3("UST app disable event failed. Application is dead.");
                }
                goto error;
        }

        DBG2("UST app event %s disabled successfully for app (pid: %d)",
                        ua_event->attr.name, app->pid);

error:
        health_code_update();
        return ret;
}

/*
 * Disable the specified channel on to UST tracer for the UST session.
 */
static int disable_ust_channel(struct ust_app *app,
                struct ust_app_session *ua_sess, struct ust_app_channel *ua_chan)
{
        int ret;

        health_code_update();

        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_disable(app->sock, ua_chan->obj);
        pthread_mutex_unlock(&app->sock_lock);
        if (ret < 0) {
                if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app channel %s disable failed for app (pid: %d) "
                                        "and session handle %d with ret %d",
                                        ua_chan->name, app->pid, ua_sess->handle, ret);
                } else {
                        /*
                         * This is normal behavior, an application can die during the
                         * creation process. Don't report an error so the execution can
                         * continue normally.
                         */
                        ret = 0;
                        DBG3("UST app disable channel failed. Application is dead.");
                }
                goto error;
        }

        DBG2("UST app channel %s disabled successfully for app (pid: %d)",
                        ua_chan->name, app->pid);

error:
        health_code_update();
        return ret;
}

/*
 * Enable the specified channel on to UST tracer for the UST session.
 */
static int enable_ust_channel(struct ust_app *app,
                struct ust_app_session *ua_sess, struct ust_app_channel *ua_chan)
{
        int ret;

        health_code_update();

        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_enable(app->sock, ua_chan->obj);
        pthread_mutex_unlock(&app->sock_lock);
        if (ret < 0) {
                if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app channel %s enable failed for app (pid: %d) "
                                        "and session handle %d with ret %d",
                                        ua_chan->name, app->pid, ua_sess->handle, ret);
                } else {
                        /*
                         * This is normal behavior, an application can die during the
                         * creation process. Don't report an error so the execution can
                         * continue normally.
                         */
                        ret = 0;
                        DBG3("UST app enable channel failed. Application is dead.");
                }
                goto error;
        }

        ua_chan->enabled = 1;

        DBG2("UST app channel %s enabled successfully for app (pid: %d)",
                        ua_chan->name, app->pid);

error:
        health_code_update();
        return ret;
}

/*
 * Enable the specified event on to UST tracer for the UST session.
 */
static int enable_ust_event(struct ust_app *app,
                struct ust_app_session *ua_sess, struct ust_app_event *ua_event)
{
        int ret;

        health_code_update();

        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_enable(app->sock, ua_event->obj);
        pthread_mutex_unlock(&app->sock_lock);
        if (ret < 0) {
                if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app event %s enable failed for app (pid: %d) "
                                        "and session handle %d with ret %d",
                                        ua_event->attr.name, app->pid, ua_sess->handle, ret);
                } else {
                        /*
                         * This is normal behavior, an application can die during the
                         * creation process. Don't report an error so the execution can
                         * continue normally.
                         */
                        ret = 0;
                        DBG3("UST app enable event failed. Application is dead.");
                }
                goto error;
        }

        DBG2("UST app event %s enabled successfully for app (pid: %d)",
                        ua_event->attr.name, app->pid);

error:
        health_code_update();
        return ret;
}

/*
 * Send channel and stream buffer to application.
 *
 * Return 0 on success. On error, a negative value is returned.
 */
static int send_channel_pid_to_ust(struct ust_app *app,
                struct ust_app_session *ua_sess, struct ust_app_channel *ua_chan)
{
        int ret;
        struct ust_app_stream *stream, *stmp;

        assert(app);
        assert(ua_sess);
        assert(ua_chan);

        health_code_update();

        DBG("UST app sending channel %s to UST app sock %d", ua_chan->name,
                        app->sock);

        /* Send channel to the application. */
        ret = ust_consumer_send_channel_to_ust(app, ua_sess, ua_chan);
        if (ret == -EPIPE || ret == -LTTNG_UST_ERR_EXITING) {
                ret = -ENOTCONN;        /* Caused by app exiting. */
                goto error;
        } else if (ret < 0) {
                goto error;
        }

        health_code_update();

        /* Send all streams to application. */
        cds_list_for_each_entry_safe(stream, stmp, &ua_chan->streams.head, list) {
                ret = ust_consumer_send_stream_to_ust(app, ua_chan, stream);
                if (ret == -EPIPE || ret == -LTTNG_UST_ERR_EXITING) {
                        ret = -ENOTCONN;        /* Caused by app exiting. */
                        goto error;
                } else if (ret < 0) {
                        goto error;
                }
                /* We don't need the stream anymore once sent to the tracer. */
                cds_list_del(&stream->list);
                delete_ust_app_stream(-1, stream, app);
        }
        /* Flag the channel that it is sent to the application. */
        ua_chan->is_sent = 1;

error:
        health_code_update();
        return ret;
}

/*
 * Create the specified event onto the UST tracer for a UST session.
 *
 * Should be called with session mutex held.
 */
static
int create_ust_event(struct ust_app *app, struct ust_app_session *ua_sess,
                struct ust_app_channel *ua_chan, struct ust_app_event *ua_event)
{
        int ret = 0;

        health_code_update();

        /* Create UST event on tracer */
        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_create_event(app->sock, &ua_event->attr, ua_chan->obj,
                        &ua_event->obj);
        pthread_mutex_unlock(&app->sock_lock);
        if (ret < 0) {
                if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("Error ustctl create event %s for app pid: %d with ret %d",
                                        ua_event->attr.name, app->pid, ret);
                } else {
                        /*
                         * This is normal behavior, an application can die during the
                         * creation process. Don't report an error so the execution can
                         * continue normally.
                         */
                        ret = 0;
                        DBG3("UST app create event failed. Application is dead.");
                }
                goto error;
        }

        ua_event->handle = ua_event->obj->handle;

        DBG2("UST app event %s created successfully for pid:%d",
                        ua_event->attr.name, app->pid);

        health_code_update();

        /* Set filter if one is present. */
        if (ua_event->filter) {
                ret = set_ust_event_filter(ua_event, app);
                if (ret < 0) {
                        goto error;
                }
        }

        /* Set exclusions for the event */
        if (ua_event->exclusion) {
                ret = set_ust_event_exclusion(ua_event, app);
                if (ret < 0) {
                        goto error;
                }
        }

        /* If event not enabled, disable it on the tracer */
        if (ua_event->enabled) {
                /*
                 * We now need to explicitly enable the event, since it
                 * is now disabled at creation.
                 */
                ret = enable_ust_event(app, ua_sess, ua_event);
                if (ret < 0) {
                        /*
                         * If we hit an EPERM, something is wrong with our enable call. If
                         * we get an EEXIST, there is a problem on the tracer side since we
                         * just created it.
                         */
                        switch (ret) {
                        case -LTTNG_UST_ERR_PERM:
                                /* Code flow problem */
                                assert(0);
                        case -LTTNG_UST_ERR_EXIST:
                                /* It's OK for our use case. */
                                ret = 0;
                                break;
                        default:
                                break;
                        }
                        goto error;
                }
        }

error:
        health_code_update();
        return ret;
}

/*
 * Copy data between an UST app event and a LTT event.
 */
static void shadow_copy_event(struct ust_app_event *ua_event,
                struct ltt_ust_event *uevent)
{
        size_t exclusion_alloc_size;

        strncpy(ua_event->name, uevent->attr.name, sizeof(ua_event->name));
        ua_event->name[sizeof(ua_event->name) - 1] = '\0';

        ua_event->enabled = uevent->enabled;

        /* Copy event attributes */
        memcpy(&ua_event->attr, &uevent->attr, sizeof(ua_event->attr));

        /* Copy filter bytecode */
        if (uevent->filter) {
                ua_event->filter = copy_filter_bytecode(uevent->filter);
                /* Filter might be NULL here in case of ENONEM. */
        }

        /* Copy exclusion data */
        if (uevent->exclusion) {
                exclusion_alloc_size = sizeof(struct lttng_event_exclusion) +
                                LTTNG_UST_SYM_NAME_LEN * uevent->exclusion->count;
                ua_event->exclusion = zmalloc(exclusion_alloc_size);
                if (ua_event->exclusion == NULL) {
                        PERROR("malloc");
                } else {
                        memcpy(ua_event->exclusion, uevent->exclusion,
                                        exclusion_alloc_size);
                }
        }
}

/*
 * Copy data between an UST app channel and a LTT channel.
 */
static void shadow_copy_channel(struct ust_app_channel *ua_chan,
                struct ltt_ust_channel *uchan)
{
        struct lttng_ht_iter iter;
        struct ltt_ust_event *uevent;
        struct ltt_ust_context *uctx;
        struct ust_app_event *ua_event;

        DBG2("UST app shadow copy of channel %s started", ua_chan->name);

        strncpy(ua_chan->name, uchan->name, sizeof(ua_chan->name));
        ua_chan->name[sizeof(ua_chan->name) - 1] = '\0';

        ua_chan->tracefile_size = uchan->tracefile_size;
        ua_chan->tracefile_count = uchan->tracefile_count;

        /* Copy event attributes since the layout is different. */
        ua_chan->attr.subbuf_size = uchan->attr.subbuf_size;
        ua_chan->attr.num_subbuf = uchan->attr.num_subbuf;
        ua_chan->attr.overwrite = uchan->attr.overwrite;
        ua_chan->attr.switch_timer_interval = uchan->attr.switch_timer_interval;
        ua_chan->attr.read_timer_interval = uchan->attr.read_timer_interval;
        ua_chan->monitor_timer_interval = uchan->monitor_timer_interval;
        ua_chan->attr.output = uchan->attr.output;
        ua_chan->attr.blocking_timeout = uchan->attr.u.s.blocking_timeout;

        /*
         * Note that the attribute channel type is not set since the channel on the
         * tracing registry side does not have this information.
         */

        ua_chan->enabled = uchan->enabled;
        ua_chan->tracing_channel_id = uchan->id;

        cds_list_for_each_entry(uctx, &uchan->ctx_list, list) {
                struct ust_app_ctx *ua_ctx = alloc_ust_app_ctx(&uctx->ctx);

                if (ua_ctx == NULL) {
                        continue;
                }
                lttng_ht_node_init_ulong(&ua_ctx->node,
                                (unsigned long) ua_ctx->ctx.ctx);
                lttng_ht_add_ulong(ua_chan->ctx, &ua_ctx->node);
                cds_list_add_tail(&ua_ctx->list, &ua_chan->ctx_list);
        }

        /* Copy all events from ltt ust channel to ust app channel */
        cds_lfht_for_each_entry(uchan->events->ht, &iter.iter, uevent, node.node) {
                ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
                                uevent->filter, uevent->attr.loglevel, uevent->exclusion);
                if (ua_event == NULL) {
                        DBG2("UST event %s not found on shadow copy channel",
                                        uevent->attr.name);
                        ua_event = alloc_ust_app_event(uevent->attr.name, &uevent->attr);
                        if (ua_event == NULL) {
                                continue;
                        }
                        shadow_copy_event(ua_event, uevent);
                        add_unique_ust_app_event(ua_chan, ua_event);
                }
        }

        DBG3("UST app shadow copy of channel %s done", ua_chan->name);
}

/*
 * Copy data between a UST app session and a regular LTT session.
 */
static void shadow_copy_session(struct ust_app_session *ua_sess,
                struct ltt_ust_session *usess, struct ust_app *app)
{
        struct lttng_ht_node_str *ua_chan_node;
        struct lttng_ht_iter iter;
        struct ltt_ust_channel *uchan;
        struct ust_app_channel *ua_chan;
        time_t rawtime;
        struct tm *timeinfo;
        char datetime[16];
        int ret;
        char tmp_shm_path[PATH_MAX];

        /* Get date and time for unique app path */
        time(&rawtime);
        timeinfo = localtime(&rawtime);
        strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);

        DBG2("Shadow copy of session handle %d", ua_sess->handle);

        ua_sess->tracing_id = usess->id;
        ua_sess->id = get_next_session_id();
        ua_sess->uid = app->uid;
        ua_sess->gid = app->gid;
        ua_sess->euid = usess->uid;
        ua_sess->egid = usess->gid;
        ua_sess->buffer_type = usess->buffer_type;
        ua_sess->bits_per_long = app->bits_per_long;

        /* There is only one consumer object per session possible. */
        consumer_output_get(usess->consumer);
        ua_sess->consumer = usess->consumer;

        ua_sess->output_traces = usess->output_traces;
        ua_sess->live_timer_interval = usess->live_timer_interval;
        copy_channel_attr_to_ustctl(&ua_sess->metadata_attr,
                        &usess->metadata_attr);

        switch (ua_sess->buffer_type) {
        case LTTNG_BUFFER_PER_PID:
                ret = snprintf(ua_sess->path, sizeof(ua_sess->path),
                                DEFAULT_UST_TRACE_PID_PATH "/%s-%d-%s", app->name, app->pid,
                                datetime);
                break;
        case LTTNG_BUFFER_PER_UID:
                ret = snprintf(ua_sess->path, sizeof(ua_sess->path),
                                DEFAULT_UST_TRACE_UID_PATH, ua_sess->uid, app->bits_per_long);
                break;
        default:
                assert(0);
                goto error;
        }
        if (ret < 0) {
                PERROR("asprintf UST shadow copy session");
                assert(0);
                goto error;
        }

        strncpy(ua_sess->root_shm_path, usess->root_shm_path,
                sizeof(ua_sess->root_shm_path));
        ua_sess->root_shm_path[sizeof(ua_sess->root_shm_path) - 1] = '\0';
        strncpy(ua_sess->shm_path, usess->shm_path,
                sizeof(ua_sess->shm_path));
        ua_sess->shm_path[sizeof(ua_sess->shm_path) - 1] = '\0';
        if (ua_sess->shm_path[0]) {
                switch (ua_sess->buffer_type) {
                case LTTNG_BUFFER_PER_PID:
                        ret = snprintf(tmp_shm_path, sizeof(tmp_shm_path),
                                        DEFAULT_UST_TRACE_PID_PATH "/%s-%d-%s",
                                        app->name, app->pid, datetime);
                        break;
                case LTTNG_BUFFER_PER_UID:
                        ret = snprintf(tmp_shm_path, sizeof(tmp_shm_path),
                                        DEFAULT_UST_TRACE_UID_PATH,
                                        app->uid, app->bits_per_long);
                        break;
                default:
                        assert(0);
                        goto error;
                }
                if (ret < 0) {
                        PERROR("sprintf UST shadow copy session");
                        assert(0);
                        goto error;
                }
                strncat(ua_sess->shm_path, tmp_shm_path,
                        sizeof(ua_sess->shm_path) - strlen(ua_sess->shm_path) - 1);
                ua_sess->shm_path[sizeof(ua_sess->shm_path) - 1] = '\0';
        }

        /* Iterate over all channels in global domain. */
        cds_lfht_for_each_entry(usess->domain_global.channels->ht, &iter.iter,
                        uchan, node.node) {
                struct lttng_ht_iter uiter;

                lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
                ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
                if (ua_chan_node != NULL) {
                        /* Session exist. Contiuing. */
                        continue;
                }

                DBG2("Channel %s not found on shadow session copy, creating it",
                                uchan->name);
                ua_chan = alloc_ust_app_channel(uchan->name, ua_sess,
                                &uchan->attr);
                if (ua_chan == NULL) {
                        /* malloc failed FIXME: Might want to do handle ENOMEM .. */
                        continue;
                }
                shadow_copy_channel(ua_chan, uchan);
                /*
                 * The concept of metadata channel does not exist on the tracing
                 * registry side of the session daemon so this can only be a per CPU
                 * channel and not metadata.
                 */
                ua_chan->attr.type = LTTNG_UST_CHAN_PER_CPU;

                lttng_ht_add_unique_str(ua_sess->channels, &ua_chan->node);
        }
        return;

error:
        consumer_output_put(ua_sess->consumer);
}

/*
 * Lookup sesison wrapper.
 */
static
void __lookup_session_by_app(struct ltt_ust_session *usess,
                        struct ust_app *app, struct lttng_ht_iter *iter)
{
        /* Get right UST app session from app */
        lttng_ht_lookup(app->sessions, &usess->id, iter);
}

/*
 * Return ust app session from the app session hashtable using the UST session
 * id.
 */
static struct ust_app_session *lookup_session_by_app(
                struct ltt_ust_session *usess, struct ust_app *app)
{
        struct lttng_ht_iter iter;
        struct lttng_ht_node_u64 *node;

        __lookup_session_by_app(usess, app, &iter);
        node = lttng_ht_iter_get_node_u64(&iter);
        if (node == NULL) {
                goto error;
        }

        return caa_container_of(node, struct ust_app_session, node);

error:
        return NULL;
}

/*
 * Setup buffer registry per PID for the given session and application. If none
 * is found, a new one is created, added to the global registry and
 * initialized. If regp is valid, it's set with the newly created object.
 *
 * Return 0 on success or else a negative value.
 */
static int setup_buffer_reg_pid(struct ust_app_session *ua_sess,
                struct ust_app *app, struct buffer_reg_pid **regp)
{
        int ret = 0;
        struct buffer_reg_pid *reg_pid;

        assert(ua_sess);
        assert(app);

        rcu_read_lock();

        reg_pid = buffer_reg_pid_find(ua_sess->id);
        if (!reg_pid) {
                /*
                 * This is the create channel path meaning that if there is NO
                 * registry available, we have to create one for this session.
                 */
                ret = buffer_reg_pid_create(ua_sess->id, &reg_pid,
                        ua_sess->root_shm_path, ua_sess->shm_path);
                if (ret < 0) {
                        goto error;
                }
        } else {
                goto end;
        }

        /* Initialize registry. */
        ret = ust_registry_session_init(&reg_pid->registry->reg.ust, app,
                        app->bits_per_long, app->uint8_t_alignment,
                        app->uint16_t_alignment, app->uint32_t_alignment,
                        app->uint64_t_alignment, app->long_alignment,
                        app->byte_order, app->version.major,
                        app->version.minor, reg_pid->root_shm_path,
                        reg_pid->shm_path,
                        ua_sess->euid, ua_sess->egid);
        if (ret < 0) {
                /*
                 * reg_pid->registry->reg.ust is NULL upon error, so we need to
                 * destroy the buffer registry, because it is always expected
                 * that if the buffer registry can be found, its ust registry is
                 * non-NULL.
                 */
                buffer_reg_pid_destroy(reg_pid);
                goto error;
        }

        buffer_reg_pid_add(reg_pid);

        DBG3("UST app buffer registry per PID created successfully");

end:
        if (regp) {
                *regp = reg_pid;
        }
error:
        rcu_read_unlock();
        return ret;
}

/*
 * Setup buffer registry per UID for the given session and application. If none
 * is found, a new one is created, added to the global registry and
 * initialized. If regp is valid, it's set with the newly created object.
 *
 * Return 0 on success or else a negative value.
 */
static int setup_buffer_reg_uid(struct ltt_ust_session *usess,
                struct ust_app_session *ua_sess,
                struct ust_app *app, struct buffer_reg_uid **regp)
{
        int ret = 0;
        struct buffer_reg_uid *reg_uid;

        assert(usess);
        assert(app);

        rcu_read_lock();

        reg_uid = buffer_reg_uid_find(usess->id, app->bits_per_long, app->uid);
        if (!reg_uid) {
                /*
                 * This is the create channel path meaning that if there is NO
                 * registry available, we have to create one for this session.
                 */
                ret = buffer_reg_uid_create(usess->id, app->bits_per_long, app->uid,
                                LTTNG_DOMAIN_UST, &reg_uid,
                                ua_sess->root_shm_path, ua_sess->shm_path);
                if (ret < 0) {
                        goto error;
                }
        } else {
                goto end;
        }

        /* Initialize registry. */
        ret = ust_registry_session_init(&reg_uid->registry->reg.ust, NULL,
                        app->bits_per_long, app->uint8_t_alignment,
                        app->uint16_t_alignment, app->uint32_t_alignment,
                        app->uint64_t_alignment, app->long_alignment,
                        app->byte_order, app->version.major,
                        app->version.minor, reg_uid->root_shm_path,
                        reg_uid->shm_path, usess->uid, usess->gid);
        if (ret < 0) {
                /*
                 * reg_uid->registry->reg.ust is NULL upon error, so we need to
                 * destroy the buffer registry, because it is always expected
                 * that if the buffer registry can be found, its ust registry is
                 * non-NULL.
                 */
                buffer_reg_uid_destroy(reg_uid, NULL);
                goto error;
        }
        /* Add node to teardown list of the session. */
        cds_list_add(&reg_uid->lnode, &usess->buffer_reg_uid_list);

        buffer_reg_uid_add(reg_uid);

        DBG3("UST app buffer registry per UID created successfully");
end:
        if (regp) {
                *regp = reg_uid;
        }
error:
        rcu_read_unlock();
        return ret;
}

/*
 * Create a session on the tracer side for the given app.
 *
 * On success, ua_sess_ptr is populated with the session pointer or else left
 * untouched. If the session was created, is_created is set to 1. On error,
 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
 * be NULL.
 *
 * Returns 0 on success or else a negative code which is either -ENOMEM or
 * -ENOTCONN which is the default code if the ustctl_create_session fails.
 */
static int find_or_create_ust_app_session(struct ltt_ust_session *usess,
                struct ust_app *app, struct ust_app_session **ua_sess_ptr,
                int *is_created)
{
        int ret, created = 0;
        struct ust_app_session *ua_sess;

        assert(usess);
        assert(app);
        assert(ua_sess_ptr);

        health_code_update();

        ua_sess = lookup_session_by_app(usess, app);
        if (ua_sess == NULL) {
                DBG2("UST app pid: %d session id %" PRIu64 " not found, creating it",
                                app->pid, usess->id);
                ua_sess = alloc_ust_app_session();
                if (ua_sess == NULL) {
                        /* Only malloc can failed so something is really wrong */
                        ret = -ENOMEM;
                        goto error;
                }
                shadow_copy_session(ua_sess, usess, app);
                created = 1;
        }

        switch (usess->buffer_type) {
        case LTTNG_BUFFER_PER_PID:
                /* Init local registry. */
                ret = setup_buffer_reg_pid(ua_sess, app, NULL);
                if (ret < 0) {
                        delete_ust_app_session(-1, ua_sess, app);
                        goto error;
                }
                break;
        case LTTNG_BUFFER_PER_UID:
                /* Look for a global registry. If none exists, create one. */
                ret = setup_buffer_reg_uid(usess, ua_sess, app, NULL);
                if (ret < 0) {
                        delete_ust_app_session(-1, ua_sess, app);
                        goto error;
                }
                break;
        default:
                assert(0);
                ret = -EINVAL;
                goto error;
        }

        health_code_update();

        if (ua_sess->handle == -1) {
                pthread_mutex_lock(&app->sock_lock);
                ret = ustctl_create_session(app->sock);
                pthread_mutex_unlock(&app->sock_lock);
                if (ret < 0) {
                        if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                                ERR("Creating session for app pid %d with ret %d",
                                                app->pid, ret);
                        } else {
                                DBG("UST app creating session failed. Application is dead");
                                /*
                                 * This is normal behavior, an application can die during the
                                 * creation process. Don't report an error so the execution can
                                 * continue normally. This will get flagged ENOTCONN and the
                                 * caller will handle it.
                                 */
                                ret = 0;
                        }
                        delete_ust_app_session(-1, ua_sess, app);
                        if (ret != -ENOMEM) {
                                /*
                                 * Tracer is probably gone or got an internal error so let's
                                 * behave like it will soon unregister or not usable.
                                 */
                                ret = -ENOTCONN;
                        }
                        goto error;
                }

                ua_sess->handle = ret;

                /* Add ust app session to app's HT */
                lttng_ht_node_init_u64(&ua_sess->node,
                                ua_sess->tracing_id);
                lttng_ht_add_unique_u64(app->sessions, &ua_sess->node);
                lttng_ht_node_init_ulong(&ua_sess->ust_objd_node, ua_sess->handle);
                lttng_ht_add_unique_ulong(app->ust_sessions_objd,
                                &ua_sess->ust_objd_node);

                DBG2("UST app session created successfully with handle %d", ret);
        }

        *ua_sess_ptr = ua_sess;
        if (is_created) {
                *is_created = created;
        }

        /* Everything went well. */
        ret = 0;

error:
        health_code_update();
        return ret;
}

/*
 * Match function for a hash table lookup of ust_app_ctx.
 *
 * It matches an ust app context based on the context type and, in the case
 * of perf counters, their name.
 */
static int ht_match_ust_app_ctx(struct cds_lfht_node *node, const void *_key)
{
        struct ust_app_ctx *ctx;
        const struct lttng_ust_context_attr *key;

        assert(node);
        assert(_key);

        ctx = caa_container_of(node, struct ust_app_ctx, node.node);
        key = _key;

        /* Context type */
        if (ctx->ctx.ctx != key->ctx) {
                goto no_match;
        }

        switch(key->ctx) {
        case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER:
                if (strncmp(key->u.perf_counter.name,
                                ctx->ctx.u.perf_counter.name,
                                sizeof(key->u.perf_counter.name))) {
                        goto no_match;
                }
                break;
        case LTTNG_UST_CONTEXT_APP_CONTEXT:
                if (strcmp(key->u.app_ctx.provider_name,
                                ctx->ctx.u.app_ctx.provider_name) ||
                                strcmp(key->u.app_ctx.ctx_name,
                                ctx->ctx.u.app_ctx.ctx_name)) {
                        goto no_match;
                }
                break;
        default:
                break;
        }

        /* Match. */
        return 1;

no_match:
        return 0;
}

/*
 * Lookup for an ust app context from an lttng_ust_context.
 *
 * Must be called while holding RCU read side lock.
 * Return an ust_app_ctx object or NULL on error.
 */
static
struct ust_app_ctx *find_ust_app_context(struct lttng_ht *ht,
                struct lttng_ust_context_attr *uctx)
{
        struct lttng_ht_iter iter;
        struct lttng_ht_node_ulong *node;
        struct ust_app_ctx *app_ctx = NULL;

        assert(uctx);
        assert(ht);

        /* Lookup using the lttng_ust_context_type and a custom match fct. */
        cds_lfht_lookup(ht->ht, ht->hash_fct((void *) uctx->ctx, lttng_ht_seed),
                        ht_match_ust_app_ctx, uctx, &iter.iter);
        node = lttng_ht_iter_get_node_ulong(&iter);
        if (!node) {
                goto end;
        }

        app_ctx = caa_container_of(node, struct ust_app_ctx, node);

end:
        return app_ctx;
}

/*
 * Create a context for the channel on the tracer.
 *
 * Called with UST app session lock held and a RCU read side lock.
 */
static
int create_ust_app_channel_context(struct ust_app_channel *ua_chan,
                struct lttng_ust_context_attr *uctx,
                struct ust_app *app)
{
        int ret = 0;
        struct ust_app_ctx *ua_ctx;

        DBG2("UST app adding context to channel %s", ua_chan->name);

        ua_ctx = find_ust_app_context(ua_chan->ctx, uctx);
        if (ua_ctx) {
                ret = -EEXIST;
                goto error;
        }

        ua_ctx = alloc_ust_app_ctx(uctx);
        if (ua_ctx == NULL) {
                /* malloc failed */
                ret = -ENOMEM;
                goto error;
        }

        lttng_ht_node_init_ulong(&ua_ctx->node, (unsigned long) ua_ctx->ctx.ctx);
        lttng_ht_add_ulong(ua_chan->ctx, &ua_ctx->node);
        cds_list_add_tail(&ua_ctx->list, &ua_chan->ctx_list);

        ret = create_ust_channel_context(ua_chan, ua_ctx, app);
        if (ret < 0) {
                goto error;
        }

error:
        return ret;
}

/*
 * Enable on the tracer side a ust app event for the session and channel.
 *
 * Called with UST app session lock held.
 */
static
int enable_ust_app_event(struct ust_app_session *ua_sess,
                struct ust_app_event *ua_event, struct ust_app *app)
{
        int ret;

        ret = enable_ust_event(app, ua_sess, ua_event);
        if (ret < 0) {
                goto error;
        }

        ua_event->enabled = 1;

error:
        return ret;
}

/*
 * Disable on the tracer side a ust app event for the session and channel.
 */
static int disable_ust_app_event(struct ust_app_session *ua_sess,
                struct ust_app_event *ua_event, struct ust_app *app)
{
        int ret;

        ret = disable_ust_event(app, ua_sess, ua_event);
        if (ret < 0) {
                goto error;
        }

        ua_event->enabled = 0;

error:
        return ret;
}

/*
 * Lookup ust app channel for session and disable it on the tracer side.
 */
static
int disable_ust_app_channel(struct ust_app_session *ua_sess,
                struct ust_app_channel *ua_chan, struct ust_app *app)
{
        int ret;

        ret = disable_ust_channel(app, ua_sess, ua_chan);
        if (ret < 0) {
                goto error;
        }

        ua_chan->enabled = 0;

error:
        return ret;
}

/*
 * Lookup ust app channel for session and enable it on the tracer side. This
 * MUST be called with a RCU read side lock acquired.
 */
static int enable_ust_app_channel(struct ust_app_session *ua_sess,
                struct ltt_ust_channel *uchan, struct ust_app *app)
{
        int ret = 0;
        struct lttng_ht_iter iter;
        struct lttng_ht_node_str *ua_chan_node;
        struct ust_app_channel *ua_chan;

        lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &iter);
        ua_chan_node = lttng_ht_iter_get_node_str(&iter);
        if (ua_chan_node == NULL) {
                DBG2("Unable to find channel %s in ust session id %" PRIu64,
                                uchan->name, ua_sess->tracing_id);
                goto error;
        }

        ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);

        ret = enable_ust_channel(app, ua_sess, ua_chan);
        if (ret < 0) {
                goto error;
        }

error:
        return ret;
}

/*
 * Ask the consumer to create a channel and get it if successful.
 *
 * Called with UST app session lock held.
 *
 * Return 0 on success or else a negative value.
 */
static int do_consumer_create_channel(struct ltt_ust_session *usess,
                struct ust_app_session *ua_sess, struct ust_app_channel *ua_chan,
                int bitness, struct ust_registry_session *registry)
{
        int ret;
        unsigned int nb_fd = 0;
        struct consumer_socket *socket;

        assert(usess);
        assert(ua_sess);
        assert(ua_chan);
        assert(registry);

        rcu_read_lock();
        health_code_update();

        /* Get the right consumer socket for the application. */
        socket = consumer_find_socket_by_bitness(bitness, usess->consumer);
        if (!socket) {
                ret = -EINVAL;
                goto error;
        }

        health_code_update();

        /* Need one fd for the channel. */
        ret = lttng_fd_get(LTTNG_FD_APPS, 1);
        if (ret < 0) {
                ERR("Exhausted number of available FD upon create channel");
                goto error;
        }

        /*
         * Ask consumer to create channel. The consumer will return the number of
         * stream we have to expect.
         */
        ret = ust_consumer_ask_channel(ua_sess, ua_chan, usess->consumer, socket,
                        registry);
        if (ret < 0) {
                goto error_ask;
        }

        /*
         * Compute the number of fd needed before receiving them. It must be 2 per
         * stream (2 being the default value here).
         */
        nb_fd = DEFAULT_UST_STREAM_FD_NUM * ua_chan->expected_stream_count;

        /* Reserve the amount of file descriptor we need. */
        ret = lttng_fd_get(LTTNG_FD_APPS, nb_fd);
        if (ret < 0) {
                ERR("Exhausted number of available FD upon create channel");
                goto error_fd_get_stream;
        }

        health_code_update();

        /*
         * Now get the channel from the consumer. This call wil populate the stream
         * list of that channel and set the ust objects.
         */
        if (usess->consumer->enabled) {
                ret = ust_consumer_get_channel(socket, ua_chan);
                if (ret < 0) {
                        goto error_destroy;
                }
        }

        rcu_read_unlock();
        return 0;

error_destroy:
        lttng_fd_put(LTTNG_FD_APPS, nb_fd);
error_fd_get_stream:
        /*
         * Initiate a destroy channel on the consumer since we had an error
         * handling it on our side. The return value is of no importance since we
         * already have a ret value set by the previous error that we need to
         * return.
         */
        (void) ust_consumer_destroy_channel(socket, ua_chan);
error_ask:
        lttng_fd_put(LTTNG_FD_APPS, 1);
error:
        health_code_update();
        rcu_read_unlock();
        return ret;
}

/*
 * Duplicate the ust data object of the ust app stream and save it in the
 * buffer registry stream.
 *
 * Return 0 on success or else a negative value.
 */
static int duplicate_stream_object(struct buffer_reg_stream *reg_stream,
                struct ust_app_stream *stream)
{
        int ret;

        assert(reg_stream);
        assert(stream);

        /* Reserve the amount of file descriptor we need. */
        ret = lttng_fd_get(LTTNG_FD_APPS, 2);
        if (ret < 0) {
                ERR("Exhausted number of available FD upon duplicate stream");
                goto error;
        }

        /* Duplicate object for stream once the original is in the registry. */
        ret = ustctl_duplicate_ust_object_data(&stream->obj,
                        reg_stream->obj.ust);
        if (ret < 0) {
                ERR("Duplicate stream obj from %p to %p failed with ret %d",
                                reg_stream->obj.ust, stream->obj, ret);
                lttng_fd_put(LTTNG_FD_APPS, 2);
                goto error;
        }
        stream->handle = stream->obj->handle;

error:
        return ret;
}

/*
 * Duplicate the ust data object of the ust app. channel and save it in the
 * buffer registry channel.
 *
 * Return 0 on success or else a negative value.
 */
static int duplicate_channel_object(struct buffer_reg_channel *reg_chan,
                struct ust_app_channel *ua_chan)
{
        int ret;

        assert(reg_chan);
        assert(ua_chan);

        /* Need two fds for the channel. */
        ret = lttng_fd_get(LTTNG_FD_APPS, 1);
        if (ret < 0) {
                ERR("Exhausted number of available FD upon duplicate channel");
                goto error_fd_get;
        }

        /* Duplicate object for stream once the original is in the registry. */
        ret = ustctl_duplicate_ust_object_data(&ua_chan->obj, reg_chan->obj.ust);
        if (ret < 0) {
                ERR("Duplicate channel obj from %p to %p failed with ret: %d",
                                reg_chan->obj.ust, ua_chan->obj, ret);
                goto error;
        }
        ua_chan->handle = ua_chan->obj->handle;

        return 0;

error:
        lttng_fd_put(LTTNG_FD_APPS, 1);
error_fd_get:
        return ret;
}

/*
 * For a given channel buffer registry, setup all streams of the given ust
 * application channel.
 *
 * Return 0 on success or else a negative value.
 */
static int setup_buffer_reg_streams(struct buffer_reg_channel *reg_chan,
                struct ust_app_channel *ua_chan,
                struct ust_app *app)
{
        int ret = 0;
        struct ust_app_stream *stream, *stmp;

        assert(reg_chan);
        assert(ua_chan);

        DBG2("UST app setup buffer registry stream");

        /* Send all streams to application. */
        cds_list_for_each_entry_safe(stream, stmp, &ua_chan->streams.head, list) {
                struct buffer_reg_stream *reg_stream;

                ret = buffer_reg_stream_create(&reg_stream);
                if (ret < 0) {
                        goto error;
                }

                /*
                 * Keep original pointer and nullify it in the stream so the delete
                 * stream call does not release the object.
                 */
                reg_stream->obj.ust = stream->obj;
                stream->obj = NULL;
                buffer_reg_stream_add(reg_stream, reg_chan);

                /* We don't need the streams anymore. */
                cds_list_del(&stream->list);
                delete_ust_app_stream(-1, stream, app);
        }

error:
        return ret;
}

/*
 * Create a buffer registry channel for the given session registry and
 * application channel object. If regp pointer is valid, it's set with the
 * created object. Important, the created object is NOT added to the session
 * registry hash table.
 *
 * Return 0 on success else a negative value.
 */
static int create_buffer_reg_channel(struct buffer_reg_session *reg_sess,
                struct ust_app_channel *ua_chan, struct buffer_reg_channel **regp)
{
        int ret;
        struct buffer_reg_channel *reg_chan = NULL;

        assert(reg_sess);
        assert(ua_chan);

        DBG2("UST app creating buffer registry channel for %s", ua_chan->name);

        /* Create buffer registry channel. */
        ret = buffer_reg_channel_create(ua_chan->tracing_channel_id, &reg_chan);
        if (ret < 0) {
                goto error_create;
        }
        assert(reg_chan);
        reg_chan->consumer_key = ua_chan->key;
        reg_chan->subbuf_size = ua_chan->attr.subbuf_size;
        reg_chan->num_subbuf = ua_chan->attr.num_subbuf;

        /* Create and add a channel registry to session. */
        ret = ust_registry_channel_add(reg_sess->reg.ust,
                        ua_chan->tracing_channel_id);
        if (ret < 0) {
                goto error;
        }
        buffer_reg_channel_add(reg_sess, reg_chan);

        if (regp) {
                *regp = reg_chan;
        }

        return 0;

error:
        /* Safe because the registry channel object was not added to any HT. */
        buffer_reg_channel_destroy(reg_chan, LTTNG_DOMAIN_UST);
error_create:
        return ret;
}

/*
 * Setup buffer registry channel for the given session registry and application
 * channel object. If regp pointer is valid, it's set with the created object.
 *
 * Return 0 on success else a negative value.
 */
static int setup_buffer_reg_channel(struct buffer_reg_session *reg_sess,
                struct ust_app_channel *ua_chan, struct buffer_reg_channel *reg_chan,
                struct ust_app *app)
{
        int ret;

        assert(reg_sess);
        assert(reg_chan);
        assert(ua_chan);
        assert(ua_chan->obj);

        DBG2("UST app setup buffer registry channel for %s", ua_chan->name);

        /* Setup all streams for the registry. */
        ret = setup_buffer_reg_streams(reg_chan, ua_chan, app);
        if (ret < 0) {
                goto error;
        }

        reg_chan->obj.ust = ua_chan->obj;
        ua_chan->obj = NULL;

        return 0;

error:
        buffer_reg_channel_remove(reg_sess, reg_chan);
        buffer_reg_channel_destroy(reg_chan, LTTNG_DOMAIN_UST);
        return ret;
}

/*
 * Send buffer registry channel to the application.
 *
 * Return 0 on success else a negative value.
 */
static int send_channel_uid_to_ust(struct buffer_reg_channel *reg_chan,
                struct ust_app *app, struct ust_app_session *ua_sess,
                struct ust_app_channel *ua_chan)
{
        int ret;
        struct buffer_reg_stream *reg_stream;

        assert(reg_chan);
        assert(app);
        assert(ua_sess);
        assert(ua_chan);

        DBG("UST app sending buffer registry channel to ust sock %d", app->sock);

        ret = duplicate_channel_object(reg_chan, ua_chan);
        if (ret < 0) {
                goto error;
        }

        /* Send channel to the application. */
        ret = ust_consumer_send_channel_to_ust(app, ua_sess, ua_chan);
        if (ret == -EPIPE || ret == -LTTNG_UST_ERR_EXITING) {
                ret = -ENOTCONN;        /* Caused by app exiting. */
                goto error;
        } else if (ret < 0) {
                goto error;
        }

        health_code_update();

        /* Send all streams to application. */
        pthread_mutex_lock(&reg_chan->stream_list_lock);
        cds_list_for_each_entry(reg_stream, &reg_chan->streams, lnode) {
                struct ust_app_stream stream;

                ret = duplicate_stream_object(reg_stream, &stream);
                if (ret < 0) {
                        goto error_stream_unlock;
                }

                ret = ust_consumer_send_stream_to_ust(app, ua_chan, &stream);
                if (ret < 0) {
                        (void) release_ust_app_stream(-1, &stream, app);
                        if (ret == -EPIPE || ret == -LTTNG_UST_ERR_EXITING) {
                                ret = -ENOTCONN; /* Caused by app exiting. */
                        }
                        goto error_stream_unlock;
                }

                /*
                 * The return value is not important here. This function will output an
                 * error if needed.
                 */
                (void) release_ust_app_stream(-1, &stream, app);
        }
        ua_chan->is_sent = 1;

error_stream_unlock:
        pthread_mutex_unlock(&reg_chan->stream_list_lock);
error:
        return ret;
}

/*
 * Create and send to the application the created buffers with per UID buffers.
 *
 * This MUST be called with a RCU read side lock acquired.
 * The session list lock and the session's lock must be acquired.
 *
 * Return 0 on success else a negative value.
 */
static int create_channel_per_uid(struct ust_app *app,
                struct ltt_ust_session *usess, struct ust_app_session *ua_sess,
                struct ust_app_channel *ua_chan)
{
        int ret;
        struct buffer_reg_uid *reg_uid;
        struct buffer_reg_channel *reg_chan;

        assert(app);
        assert(usess);
        assert(ua_sess);
        assert(ua_chan);

        DBG("UST app creating channel %s with per UID buffers", ua_chan->name);

        reg_uid = buffer_reg_uid_find(usess->id, app->bits_per_long, app->uid);
        /*
         * The session creation handles the creation of this global registry
         * object. If none can be find, there is a code flow problem or a
         * teardown race.
         */
        assert(reg_uid);

        reg_chan = buffer_reg_channel_find(ua_chan->tracing_channel_id,
                        reg_uid);
        if (reg_chan) {
                goto send_channel;
        }

        /* Create the buffer registry channel object. */
        ret = create_buffer_reg_channel(reg_uid->registry, ua_chan, &reg_chan);
        if (ret < 0) {
                ERR("Error creating the UST channel \"%s\" registry instance",
                                ua_chan->name);
                goto error;
        }

        /*
         * Create the buffers on the consumer side. This call populates the
         * ust app channel object with all streams and data object.
         */
        ret = do_consumer_create_channel(usess, ua_sess, ua_chan,
                        app->bits_per_long, reg_uid->registry->reg.ust);
        if (ret < 0) {
                ERR("Error creating UST channel \"%s\" on the consumer daemon",
                                ua_chan->name);

                /*
                 * Let's remove the previously created buffer registry channel so
                 * it's not visible anymore in the session registry.
                 */
                ust_registry_channel_del_free(reg_uid->registry->reg.ust,
                                ua_chan->tracing_channel_id, false);
                buffer_reg_channel_remove(reg_uid->registry, reg_chan);
                buffer_reg_channel_destroy(reg_chan, LTTNG_DOMAIN_UST);
                goto error;
        }

        /*
         * Setup the streams and add it to the session registry.
         */
        ret = setup_buffer_reg_channel(reg_uid->registry,
                        ua_chan, reg_chan, app);
        if (ret < 0) {
                ERR("Error setting up UST channel \"%s\"", ua_chan->name);
                goto error;
        }

        {
                enum lttng_error_code cmd_ret;
                struct ltt_session *session;
                uint64_t chan_reg_key;
                struct ust_registry_channel *chan_reg;

                chan_reg_key = ua_chan->tracing_channel_id;

                pthread_mutex_lock(&reg_uid->registry->reg.ust->lock);
                chan_reg = ust_registry_channel_find(reg_uid->registry->reg.ust,
                                chan_reg_key);
                assert(chan_reg);
                chan_reg->consumer_key = ua_chan->key;
                chan_reg = NULL;
                pthread_mutex_unlock(&reg_uid->registry->reg.ust->lock);

                session = session_find_by_id(ua_sess->tracing_id);
                assert(session);

                assert(pthread_mutex_trylock(&session->lock));
                assert(session_trylock_list());
                cmd_ret = notification_thread_command_add_channel(
                                notification_thread_handle, session->name,
                                ua_sess->euid, ua_sess->egid,
                                ua_chan->name,
                                ua_chan->key,
                                LTTNG_DOMAIN_UST,
                                ua_chan->attr.subbuf_size * ua_chan->attr.num_subbuf);
                if (cmd_ret != LTTNG_OK) {
                        ret = - (int) cmd_ret;
                        ERR("Failed to add channel to notification thread");
                        goto error;
                }
        }

send_channel:
        /* Send buffers to the application. */
        ret = send_channel_uid_to_ust(reg_chan, app, ua_sess, ua_chan);
        if (ret < 0) {
                if (ret != -ENOTCONN) {
                        ERR("Error sending channel to application");
                }
                goto error;
        }

error:
        return ret;
}

/*
 * Create and send to the application the created buffers with per PID buffers.
 *
 * Called with UST app session lock held.
 * The session list lock and the session's lock must be acquired.
 *
 * Return 0 on success else a negative value.
 */
static int create_channel_per_pid(struct ust_app *app,
                struct ltt_ust_session *usess, struct ust_app_session *ua_sess,
                struct ust_app_channel *ua_chan)
{
        int ret;
        struct ust_registry_session *registry;
        enum lttng_error_code cmd_ret;
        struct ltt_session *session;
        uint64_t chan_reg_key;
        struct ust_registry_channel *chan_reg;

        assert(app);
        assert(usess);
        assert(ua_sess);
        assert(ua_chan);

        DBG("UST app creating channel %s with per PID buffers", ua_chan->name);

        rcu_read_lock();

        registry = get_session_registry(ua_sess);
        /* The UST app session lock is held, registry shall not be null. */
        assert(registry);

        /* Create and add a new channel registry to session. */
        ret = ust_registry_channel_add(registry, ua_chan->key);
        if (ret < 0) {
                ERR("Error creating the UST channel \"%s\" registry instance",
                        ua_chan->name);
                goto error;
        }

        /* Create and get channel on the consumer side. */
        ret = do_consumer_create_channel(usess, ua_sess, ua_chan,
                        app->bits_per_long, registry);
        if (ret < 0) {
                ERR("Error creating UST channel \"%s\" on the consumer daemon",
                        ua_chan->name);
                goto error;
        }

        ret = send_channel_pid_to_ust(app, ua_sess, ua_chan);
        if (ret < 0) {
                if (ret != -ENOTCONN) {
                        ERR("Error sending channel to application");
                }
                goto error;
        }

        session = session_find_by_id(ua_sess->tracing_id);
        assert(session);

        chan_reg_key = ua_chan->key;
        pthread_mutex_lock(&registry->lock);
        chan_reg = ust_registry_channel_find(registry, chan_reg_key);
        assert(chan_reg);
        chan_reg->consumer_key = ua_chan->key;
        pthread_mutex_unlock(&registry->lock);

        assert(pthread_mutex_trylock(&session->lock));
        assert(session_trylock_list());

        cmd_ret = notification_thread_command_add_channel(
                        notification_thread_handle, session->name,
                        ua_sess->euid, ua_sess->egid,
                        ua_chan->name,
                        ua_chan->key,
                        LTTNG_DOMAIN_UST,
                        ua_chan->attr.subbuf_size * ua_chan->attr.num_subbuf);
        if (cmd_ret != LTTNG_OK) {
                ret = - (int) cmd_ret;
                ERR("Failed to add channel to notification thread");
                goto error;
        }

error:
        rcu_read_unlock();
        return ret;
}

/*
 * From an already allocated ust app channel, create the channel buffers if
 * need and send it to the application. This MUST be called with a RCU read
 * side lock acquired.
 *
 * Called with UST app session lock held.
 *
 * Return 0 on success or else a negative value. Returns -ENOTCONN if
 * the application exited concurrently.
 */
static int do_create_channel(struct ust_app *app,
                struct ltt_ust_session *usess, struct ust_app_session *ua_sess,
                struct ust_app_channel *ua_chan)
{
        int ret;

        assert(app);
        assert(usess);
        assert(ua_sess);
        assert(ua_chan);

        /* Handle buffer type before sending the channel to the application. */
        switch (usess->buffer_type) {
        case LTTNG_BUFFER_PER_UID:
        {
                ret = create_channel_per_uid(app, usess, ua_sess, ua_chan);
                if (ret < 0) {
                        goto error;
                }
                break;
        }
        case LTTNG_BUFFER_PER_PID:
        {
                ret = create_channel_per_pid(app, usess, ua_sess, ua_chan);
                if (ret < 0) {
                        goto error;
                }
                break;
        }
        default:
                assert(0);
                ret = -EINVAL;
                goto error;
        }

        /* Initialize ust objd object using the received handle and add it. */
        lttng_ht_node_init_ulong(&ua_chan->ust_objd_node, ua_chan->handle);
        lttng_ht_add_unique_ulong(app->ust_objd, &ua_chan->ust_objd_node);

        /* If channel is not enabled, disable it on the tracer */
        if (!ua_chan->enabled) {
                ret = disable_ust_channel(app, ua_sess, ua_chan);
                if (ret < 0) {
                        goto error;
                }
        }

error:
        return ret;
}

/*
 * Create UST app channel and create it on the tracer. Set ua_chanp of the
 * newly created channel if not NULL.
 *
 * Called with UST app session lock and RCU read-side lock held.
 *
 * Return 0 on success or else a negative value. Returns -ENOTCONN if
 * the application exited concurrently.
 */
static int create_ust_app_channel(struct ust_app_session *ua_sess,
                struct ltt_ust_channel *uchan, struct ust_app *app,
                enum lttng_ust_chan_type type, struct ltt_ust_session *usess,
                struct ust_app_channel **ua_chanp)
{
        int ret = 0;
        struct lttng_ht_iter iter;
        struct lttng_ht_node_str *ua_chan_node;
        struct ust_app_channel *ua_chan;

        /* Lookup channel in the ust app session */
        lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &iter);
        ua_chan_node = lttng_ht_iter_get_node_str(&iter);
        if (ua_chan_node != NULL) {
                ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
                goto end;
        }

        ua_chan = alloc_ust_app_channel(uchan->name, ua_sess, &uchan->attr);
        if (ua_chan == NULL) {
                /* Only malloc can fail here */
                ret = -ENOMEM;
                goto error_alloc;
        }
        shadow_copy_channel(ua_chan, uchan);

        /* Set channel type. */
        ua_chan->attr.type = type;

        ret = do_create_channel(app, usess, ua_sess, ua_chan);
        if (ret < 0) {
                goto error;
        }

        DBG2("UST app create channel %s for PID %d completed", ua_chan->name,
                        app->pid);

        /* Only add the channel if successful on the tracer side. */
        lttng_ht_add_unique_str(ua_sess->channels, &ua_chan->node);
end:
        if (ua_chanp) {
                *ua_chanp = ua_chan;
        }

        /* Everything went well. */
        return 0;

error:
        delete_ust_app_channel(ua_chan->is_sent ? app->sock : -1, ua_chan, app);
error_alloc:
        return ret;
}

/*
 * Create UST app event and create it on the tracer side.
 *
 * Called with ust app session mutex held.
 */
static
int create_ust_app_event(struct ust_app_session *ua_sess,
                struct ust_app_channel *ua_chan, struct ltt_ust_event *uevent,
                struct ust_app *app)
{
        int ret = 0;
        struct ust_app_event *ua_event;

        /* Get event node */
        ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
                        uevent->filter, uevent->attr.loglevel, uevent->exclusion);
        if (ua_event != NULL) {
                ret = -EEXIST;
                goto end;
        }

        /* Does not exist so create one */
        ua_event = alloc_ust_app_event(uevent->attr.name, &uevent->attr);
        if (ua_event == NULL) {
                /* Only malloc can failed so something is really wrong */
                ret = -ENOMEM;
                goto end;
        }
        shadow_copy_event(ua_event, uevent);

        /* Create it on the tracer side */
        ret = create_ust_event(app, ua_sess, ua_chan, ua_event);
        if (ret < 0) {
                /* Not found previously means that it does not exist on the tracer */
                assert(ret != -LTTNG_UST_ERR_EXIST);
                goto error;
        }

        add_unique_ust_app_event(ua_chan, ua_event);

        DBG2("UST app create event %s for PID %d completed", ua_event->name,
                        app->pid);

end:
        return ret;

error:
        /* Valid. Calling here is already in a read side lock */
        delete_ust_app_event(-1, ua_event, app);
        return ret;
}

/*
 * Create UST metadata and open it on the tracer side.
 *
 * Called with UST app session lock held and RCU read side lock.
 */
static int create_ust_app_metadata(struct ust_app_session *ua_sess,
                struct ust_app *app, struct consumer_output *consumer)
{
        int ret = 0;
        struct ust_app_channel *metadata;
        struct consumer_socket *socket;
        struct ust_registry_session *registry;

        assert(ua_sess);
        assert(app);
        assert(consumer);

        registry = get_session_registry(ua_sess);
        /* The UST app session is held registry shall not be null. */
        assert(registry);

        pthread_mutex_lock(&registry->lock);

        /* Metadata already exists for this registry or it was closed previously */
        if (registry->metadata_key || registry->metadata_closed) {
                ret = 0;
                goto error;
        }

        /* Allocate UST metadata */
        metadata = alloc_ust_app_channel(DEFAULT_METADATA_NAME, ua_sess, NULL);
        if (!metadata) {
                /* malloc() failed */
                ret = -ENOMEM;
                goto error;
        }

        memcpy(&metadata->attr, &ua_sess->metadata_attr, sizeof(metadata->attr));

        /* Need one fd for the channel. */
        ret = lttng_fd_get(LTTNG_FD_APPS, 1);
        if (ret < 0) {
                ERR("Exhausted number of available FD upon create metadata");
                goto error;
        }

        /* Get the right consumer socket for the application. */
        socket = consumer_find_socket_by_bitness(app->bits_per_long, consumer);
        if (!socket) {
                ret = -EINVAL;
                goto error_consumer;
        }

        /*
         * Keep metadata key so we can identify it on the consumer side. Assign it
         * to the registry *before* we ask the consumer so we avoid the race of the
         * consumer requesting the metadata and the ask_channel call on our side
         * did not returned yet.
         */
        registry->metadata_key = metadata->key;

        /*
         * Ask the metadata channel creation to the consumer. The metadata object
         * will be created by the consumer and kept their. However, the stream is
         * never added or monitored until we do a first push metadata to the
         * consumer.
         */
        ret = ust_consumer_ask_channel(ua_sess, metadata, consumer, socket,
                        registry);
        if (ret < 0) {
                /* Nullify the metadata key so we don't try to close it later on. */
                registry->metadata_key = 0;
                goto error_consumer;
        }

        /*
         * The setup command will make the metadata stream be sent to the relayd,
         * if applicable, and the thread managing the metadatas. This is important
         * because after this point, if an error occurs, the only way the stream
         * can be deleted is to be monitored in the consumer.
         */
        ret = consumer_setup_metadata(socket, metadata->key);
        if (ret < 0) {
                /* Nullify the metadata key so we don't try to close it later on. */
                registry->metadata_key = 0;
                goto error_consumer;
        }

        DBG2("UST metadata with key %" PRIu64 " created for app pid %d",
                        metadata->key, app->pid);

error_consumer:
        lttng_fd_put(LTTNG_FD_APPS, 1);
        delete_ust_app_channel(-1, metadata, app);
error:
        pthread_mutex_unlock(&registry->lock);
        return ret;
}

/*
 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
 * acquired before calling this function.
 */
struct ust_app *ust_app_find_by_pid(pid_t pid)
{
        struct ust_app *app = NULL;
        struct lttng_ht_node_ulong *node;
        struct lttng_ht_iter iter;

        lttng_ht_lookup(ust_app_ht, (void *)((unsigned long) pid), &iter);
        node = lttng_ht_iter_get_node_ulong(&iter);
        if (node == NULL) {
                DBG2("UST app no found with pid %d", pid);
                goto error;
        }

        DBG2("Found UST app by pid %d", pid);

        app = caa_container_of(node, struct ust_app, pid_n);

error:
        return app;
}

/*
 * Allocate and init an UST app object using the registration information and
 * the command socket. This is called when the command socket connects to the
 * session daemon.
 *
 * The object is returned on success or else NULL.
 */
struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
{
        struct ust_app *lta = NULL;

        assert(msg);
        assert(sock >= 0);

        DBG3("UST app creating application for socket %d", sock);

        if ((msg->bits_per_long == 64 &&
                                (uatomic_read(&ust_consumerd64_fd) == -EINVAL))
                        || (msg->bits_per_long == 32 &&
                                (uatomic_read(&ust_consumerd32_fd) == -EINVAL))) {
                ERR("Registration failed: application \"%s\" (pid: %d) has "
                                "%d-bit long, but no consumerd for this size is available.\n",
                                msg->name, msg->pid, msg->bits_per_long);
                goto error;
        }

        lta = zmalloc(sizeof(struct ust_app));
        if (lta == NULL) {
                PERROR("malloc");
                goto error;
        }

        lta->ppid = msg->ppid;
        lta->uid = msg->uid;
        lta->gid = msg->gid;

        lta->bits_per_long = msg->bits_per_long;
        lta->uint8_t_alignment = msg->uint8_t_alignment;
        lta->uint16_t_alignment = msg->uint16_t_alignment;
        lta->uint32_t_alignment = msg->uint32_t_alignment;
        lta->uint64_t_alignment = msg->uint64_t_alignment;
        lta->long_alignment = msg->long_alignment;
        lta->byte_order = msg->byte_order;

        lta->v_major = msg->major;
        lta->v_minor = msg->minor;
        lta->sessions = lttng_ht_new(0, LTTNG_HT_TYPE_U64);
        lta->ust_objd = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
        lta->ust_sessions_objd = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
        lta->notify_sock = -1;

        /* Copy name and make sure it's NULL terminated. */
        strncpy(lta->name, msg->name, sizeof(lta->name));
        lta->name[UST_APP_PROCNAME_LEN] = '\0';

        /*
         * Before this can be called, when receiving the registration information,
         * the application compatibility is checked. So, at this point, the
         * application can work with this session daemon.
         */
        lta->compatible = 1;

        lta->pid = msg->pid;
        lttng_ht_node_init_ulong(&lta->pid_n, (unsigned long) lta->pid);
        lta->sock = sock;
        pthread_mutex_init(&lta->sock_lock, NULL);
        lttng_ht_node_init_ulong(&lta->sock_n, (unsigned long) lta->sock);

        CDS_INIT_LIST_HEAD(&lta->teardown_head);
error:
        return lta;
}

/*
 * For a given application object, add it to every hash table.
 */
void ust_app_add(struct ust_app *app)
{
        assert(app);
        assert(app->notify_sock >= 0);

        rcu_read_lock();

        /*
         * On a re-registration, we want to kick out the previous registration of
         * that pid
         */
        lttng_ht_add_replace_ulong(ust_app_ht, &app->pid_n);

        /*
         * The socket _should_ be unique until _we_ call close. So, a add_unique
         * for the ust_app_ht_by_sock is used which asserts fail if the entry was
         * already in the table.
         */
        lttng_ht_add_unique_ulong(ust_app_ht_by_sock, &app->sock_n);

        /* Add application to the notify socket hash table. */
        lttng_ht_node_init_ulong(&app->notify_sock_n, app->notify_sock);
        lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock, &app->notify_sock_n);

        DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
                        "notify_sock:%d (version %d.%d)", app->pid, app->ppid, app->uid,
                        app->gid, app->sock, app->name, app->notify_sock, app->v_major,
                        app->v_minor);

        rcu_read_unlock();
}

/*
 * Set the application version into the object.
 *
 * Return 0 on success else a negative value either an errno code or a
 * LTTng-UST error code.
 */
int ust_app_version(struct ust_app *app)
{
        int ret;

        assert(app);

        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_tracer_version(app->sock, &app->version);
        pthread_mutex_unlock(&app->sock_lock);
        if (ret < 0) {
                if (ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
                        ERR("UST app %d version failed with ret %d", app->sock, ret);
                } else {
                        DBG3("UST app %d version failed. Application is dead", app->sock);
                }
        }

        return ret;
}

/*
 * Unregister app by removing it from the global traceable app list and freeing
 * the data struct.
 *
 * The socket is already closed at this point so no close to sock.
 */
void ust_app_unregister(int sock)
{
        struct ust_app *lta;
        struct lttng_ht_node_ulong *node;
        struct lttng_ht_iter ust_app_sock_iter;
        struct lttng_ht_iter iter;
        struct ust_app_session *ua_sess;
        int ret;

        rcu_read_lock();

        /* Get the node reference for a call_rcu */
        lttng_ht_lookup(ust_app_ht_by_sock, (void *)((unsigned long) sock), &ust_app_sock_iter);
        node = lttng_ht_iter_get_node_ulong(&ust_app_sock_iter);
        assert(node);

        lta = caa_container_of(node, struct ust_app, sock_n);
        DBG("PID %d unregistering with sock %d", lta->pid, sock);

        /*
         * For per-PID buffers, perform "push metadata" and flush all
         * application streams before removing app from hash tables,
         * ensuring proper behavior of data_pending check.
         * Remove sessions so they are not visible during deletion.
         */
        cds_lfht_for_each_entry(lta->sessions->ht, &iter.iter, ua_sess,
                        node.node) {
                struct ust_registry_session *registry;

                ret = lttng_ht_del(lta->sessions, &iter);
                if (ret) {
                        /* The session was already removed so scheduled for teardown. */
                        continue;
                }

                if (ua_sess->buffer_type == LTTNG_BUFFER_PER_PID) {
                        (void) ust_app_flush_app_session(lta, ua_sess);
                }

                /*
                 * Add session to list for teardown. This is safe since at this point we
                 * are the only one using this list.
                 */
                pthread_mutex_lock(&ua_sess->lock);

                if (ua_sess->deleted) {
                        pthread_mutex_unlock(&ua_sess->lock);
                        continue;
                }

                /*
                 * Normally, this is done in the delete session process which is
                 * executed in the call rcu below. However, upon registration we can't
                 * afford to wait for the grace period before pushing data or else the
                 * data pending feature can race between the unregistration and stop
                 * command where the data pending command is sent *before* the grace
                 * period ended.
                 *
                 * The close metadata below nullifies the metadata pointer in the
                 * session so the delete session will NOT push/close a second time.
                 */
                registry = get_session_registry(ua_sess);
                if (registry) {
                        /* Push metadata for application before freeing the application. */
                        (void) push_metadata(registry, ua_sess->consumer);

                        /*
                         * Don't ask to close metadata for global per UID buffers. Close
                         * metadata only on destroy trace session in this case. Also, the
                         * previous push metadata could have flag the metadata registry to
                         * close so don't send a close command if closed.
                         */
                        if (ua_sess->buffer_type != LTTNG_BUFFER_PER_UID) {
                                /* And ask to close it for this session registry. */
                                (void) close_metadata(registry, ua_sess->consumer);
                        }
                }
                cds_list_add(&ua_sess->teardown_node, &lta->teardown_head);

                pthread_mutex_unlock(&ua_sess->lock);
        }

        /* Remove application from PID hash table */
        ret = lttng_ht_del(ust_app_ht_by_sock, &ust_app_sock_iter);
        assert(!ret);

        /*
         * Remove application from notify hash table. The thread handling the
         * notify socket could have deleted the node so ignore on error because
         * either way it's valid. The close of that socket is handled by the
         * apps_notify_thread.
         */
        iter.iter.node = &lta->notify_sock_n.node;
        (void) lttng_ht_del(ust_app_ht_by_notify_sock, &iter);

        /*
         * Ignore return value since the node might have been removed before by an
         * add replace during app registration because the PID can be reassigned by
         * the OS.
         */
        iter.iter.node = &lta->pid_n.node;
        ret = lttng_ht_del(ust_app_ht, &iter);
        if (ret) {
                DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
                                lta->pid);
        }

        /* Free memory */
        call_rcu(&lta->pid_n.head, delete_ust_app_rcu);

        rcu_read_unlock();
        return;
}

/*
 * Fill events array with all events name of all registered apps.
 */
int ust_app_list_events(struct lttng_event **events)
{
        int ret, handle;
        size_t nbmem, count = 0;
        struct lttng_ht_iter iter;
        struct ust_app *app;
        struct lttng_event *tmp_event;

        nbmem = UST_APP_EVENT_LIST_SIZE;
        tmp_event = zmalloc(nbmem * sizeof(struct lttng_event));
        if (tmp_event == NULL) {
                PERROR("zmalloc ust app events");
                ret = -ENOMEM;
                goto error;
        }

        rcu_read_lock();

        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                struct lttng_ust_tracepoint_iter uiter;

                health_code_update();

                if (!app->compatible) {
                        /*
                         * TODO: In time, we should notice the caller of this error by
                         * telling him that this is a version error.
                         */
                        continue;
                }
                pthread_mutex_lock(&app->sock_lock);
                handle = ustctl_tracepoint_list(app->sock);
                if (handle < 0) {
                        if (handle != -EPIPE && handle != -LTTNG_UST_ERR_EXITING) {
                                ERR("UST app list events getting handle failed for app pid %d",
                                                app->pid);
                        }
                        pthread_mutex_unlock(&app->sock_lock);
                        continue;
                }

                while ((ret = ustctl_tracepoint_list_get(app->sock, handle,
                                        &uiter)) != -LTTNG_UST_ERR_NOENT) {
                        /* Handle ustctl error. */
                        if (ret < 0) {
                                int release_ret;

                                if (ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
                                        ERR("UST app tp list get failed for app %d with ret %d",
                                                        app->sock, ret);
                                } else {
                                        DBG3("UST app tp list get failed. Application is dead");
                                        /*
                                         * This is normal behavior, an application can die during the
                                         * creation process. Don't report an error so the execution can
                                         * continue normally. Continue normal execution.
                                         */
                                        break;
                                }
                                free(tmp_event);
                                release_ret = ustctl_release_handle(app->sock, handle);
                                if (release_ret < 0 &&
                                                release_ret != -LTTNG_UST_ERR_EXITING &&
                                                release_ret != -EPIPE) {
                                        ERR("Error releasing app handle for app %d with ret %d", app->sock, release_ret);
                                }
                                pthread_mutex_unlock(&app->sock_lock);
                                goto rcu_error;
                        }

                        health_code_update();
                        if (count >= nbmem) {
                                /* In case the realloc fails, we free the memory */
                                struct lttng_event *new_tmp_event;
                                size_t new_nbmem;

                                new_nbmem = nbmem << 1;
                                DBG2("Reallocating event list from %zu to %zu entries",
                                                nbmem, new_nbmem);
                                new_tmp_event = realloc(tmp_event,
                                        new_nbmem * sizeof(struct lttng_event));
                                if (new_tmp_event == NULL) {
                                        int release_ret;

                                        PERROR("realloc ust app events");
                                        free(tmp_event);
                                        ret = -ENOMEM;
                                        release_ret = ustctl_release_handle(app->sock, handle);
                                        if (release_ret < 0 &&
                                                        release_ret != -LTTNG_UST_ERR_EXITING &&
                                                        release_ret != -EPIPE) {
                                                ERR("Error releasing app handle for app %d with ret %d", app->sock, release_ret);
                                        }
                                        pthread_mutex_unlock(&app->sock_lock);
                                        goto rcu_error;
                                }
                                /* Zero the new memory */
                                memset(new_tmp_event + nbmem, 0,
                                        (new_nbmem - nbmem) * sizeof(struct lttng_event));
                                nbmem = new_nbmem;
                                tmp_event = new_tmp_event;
                        }
                        memcpy(tmp_event[count].name, uiter.name, LTTNG_UST_SYM_NAME_LEN);
                        tmp_event[count].loglevel = uiter.loglevel;
                        tmp_event[count].type = (enum lttng_event_type) LTTNG_UST_TRACEPOINT;
                        tmp_event[count].pid = app->pid;
                        tmp_event[count].enabled = -1;
                        count++;
                }
                ret = ustctl_release_handle(app->sock, handle);
                pthread_mutex_unlock(&app->sock_lock);
                if (ret < 0 && ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
                        ERR("Error releasing app handle for app %d with ret %d", app->sock, ret);
                }
        }

        ret = count;
        *events = tmp_event;

        DBG2("UST app list events done (%zu events)", count);

rcu_error:
        rcu_read_unlock();
error:
        health_code_update();
        return ret;
}

/*
 * Fill events array with all events name of all registered apps.
 */
int ust_app_list_event_fields(struct lttng_event_field **fields)
{
        int ret, handle;
        size_t nbmem, count = 0;
        struct lttng_ht_iter iter;
        struct ust_app *app;
        struct lttng_event_field *tmp_event;

        nbmem = UST_APP_EVENT_LIST_SIZE;
        tmp_event = zmalloc(nbmem * sizeof(struct lttng_event_field));
        if (tmp_event == NULL) {
                PERROR("zmalloc ust app event fields");
                ret = -ENOMEM;
                goto error;
        }

        rcu_read_lock();

        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                struct lttng_ust_field_iter uiter;

                health_code_update();

                if (!app->compatible) {
                        /*
                         * TODO: In time, we should notice the caller of this error by
                         * telling him that this is a version error.
                         */
                        continue;
                }
                pthread_mutex_lock(&app->sock_lock);
                handle = ustctl_tracepoint_field_list(app->sock);
                if (handle < 0) {
                        if (handle != -EPIPE && handle != -LTTNG_UST_ERR_EXITING) {
                                ERR("UST app list field getting handle failed for app pid %d",
                                                app->pid);
                        }
                        pthread_mutex_unlock(&app->sock_lock);
                        continue;
                }

                while ((ret = ustctl_tracepoint_field_list_get(app->sock, handle,
                                        &uiter)) != -LTTNG_UST_ERR_NOENT) {
                        /* Handle ustctl error. */
                        if (ret < 0) {
                                int release_ret;

                                if (ret != -LTTNG_UST_ERR_EXITING && ret != -EPIPE) {
                                        ERR("UST app tp list field failed for app %d with ret %d",
                                                        app->sock, ret);
                                } else {
                                        DBG3("UST app tp list field failed. Application is dead");
                                        /*
                                         * This is normal behavior, an application can die during the
                                         * creation process. Don't report an error so the execution can
                                         * continue normally. Reset list and count for next app.
                                         */
                                        break;
                                }
                                free(tmp_event);
                                release_ret = ustctl_release_handle(app->sock, handle);
                                pthread_mutex_unlock(&app->sock_lock);
                                if (release_ret < 0 &&
                                                release_ret != -LTTNG_UST_ERR_EXITING &&
                                                release_ret != -EPIPE) {
                                        ERR("Error releasing app handle for app %d with ret %d", app->sock, release_ret);
                                }
                                goto rcu_error;
                        }

                        health_code_update();
                        if (count >= nbmem) {
                                /* In case the realloc fails, we free the memory */
                                struct lttng_event_field *new_tmp_event;
                                size_t new_nbmem;

                                new_nbmem = nbmem << 1;
                                DBG2("Reallocating event field list from %zu to %zu entries",
                                                nbmem, new_nbmem);
                                new_tmp_event = realloc(tmp_event,
                                        new_nbmem * sizeof(struct lttng_event_field));
                                if (new_tmp_event == NULL) {
                                        int release_ret;

                                        PERROR("realloc ust app event fields");
                                        free(tmp_event);
                                        ret = -ENOMEM;
                                        release_ret = ustctl_release_handle(app->sock, handle);
                                        pthread_mutex_unlock(&app->sock_lock);
                                        if (release_ret &&
                                                        release_ret != -LTTNG_UST_ERR_EXITING &&
                                                        release_ret != -EPIPE) {
                                                ERR("Error releasing app handle for app %d with ret %d", app->sock, release_ret);
                                        }
                                        goto rcu_error;
                                }
                                /* Zero the new memory */
                                memset(new_tmp_event + nbmem, 0,
                                        (new_nbmem - nbmem) * sizeof(struct lttng_event_field));
                                nbmem = new_nbmem;
                                tmp_event = new_tmp_event;
                        }

                        memcpy(tmp_event[count].field_name, uiter.field_name, LTTNG_UST_SYM_NAME_LEN);
                        /* Mapping between these enums matches 1 to 1. */
                        tmp_event[count].type = (enum lttng_event_field_type) uiter.type;
                        tmp_event[count].nowrite = uiter.nowrite;

                        memcpy(tmp_event[count].event.name, uiter.event_name, LTTNG_UST_SYM_NAME_LEN);
                        tmp_event[count].event.loglevel = uiter.loglevel;
                        tmp_event[count].event.type = LTTNG_EVENT_TRACEPOINT;
                        tmp_event[count].event.pid = app->pid;
                        tmp_event[count].event.enabled = -1;
                        count++;
                }
                ret = ustctl_release_handle(app->sock, handle);
                pthread_mutex_unlock(&app->sock_lock);
                if (ret < 0 &&
                                ret != -LTTNG_UST_ERR_EXITING &&
                                ret != -EPIPE) {
                        ERR("Error releasing app handle for app %d with ret %d", app->sock, ret);
                }
        }

        ret = count;
        *fields = tmp_event;

        DBG2("UST app list event fields done (%zu events)", count);

rcu_error:
        rcu_read_unlock();
error:
        health_code_update();
        return ret;
}

/*
 * Free and clean all traceable apps of the global list.
 *
 * Should _NOT_ be called with RCU read-side lock held.
 */
void ust_app_clean_list(void)
{
        int ret;
        struct ust_app *app;
        struct lttng_ht_iter iter;

        DBG2("UST app cleaning registered apps hash table");

        rcu_read_lock();

        if (ust_app_ht) {
                cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                        ret = lttng_ht_del(ust_app_ht, &iter);
                        assert(!ret);
                        call_rcu(&app->pid_n.head, delete_ust_app_rcu);
                }
        }

        /* Cleanup socket hash table */
        if (ust_app_ht_by_sock) {
                cds_lfht_for_each_entry(ust_app_ht_by_sock->ht, &iter.iter, app,
                                sock_n.node) {
                        ret = lttng_ht_del(ust_app_ht_by_sock, &iter);
                        assert(!ret);
                }
        }

        /* Cleanup notify socket hash table */
        if (ust_app_ht_by_notify_sock) {
                cds_lfht_for_each_entry(ust_app_ht_by_notify_sock->ht, &iter.iter, app,
                                notify_sock_n.node) {
                        ret = lttng_ht_del(ust_app_ht_by_notify_sock, &iter);
                        assert(!ret);
                }
        }
        rcu_read_unlock();

        /* Destroy is done only when the ht is empty */
        if (ust_app_ht) {
                ht_cleanup_push(ust_app_ht);
        }
        if (ust_app_ht_by_sock) {
                ht_cleanup_push(ust_app_ht_by_sock);
        }
        if (ust_app_ht_by_notify_sock) {
                ht_cleanup_push(ust_app_ht_by_notify_sock);
        }
}

/*
 * Init UST app hash table.
 */
int ust_app_ht_alloc(void)
{
        ust_app_ht = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
        if (!ust_app_ht) {
                return -1;
        }
        ust_app_ht_by_sock = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
        if (!ust_app_ht_by_sock) {
                return -1;
        }
        ust_app_ht_by_notify_sock = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
        if (!ust_app_ht_by_notify_sock) {
                return -1;
        }
        return 0;
}

/*
 * For a specific UST session, disable the channel for all registered apps.
 */
int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan)
{
        int ret = 0;
        struct lttng_ht_iter iter;
        struct lttng_ht_node_str *ua_chan_node;
        struct ust_app *app;
        struct ust_app_session *ua_sess;
        struct ust_app_channel *ua_chan;

        if (usess == NULL || uchan == NULL) {
                ERR("Disabling UST global channel with NULL values");
                ret = -1;
                goto error;
        }

        DBG2("UST app disabling channel %s from global domain for session id %" PRIu64,
                        uchan->name, usess->id);

        rcu_read_lock();

        /* For every registered applications */
        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                struct lttng_ht_iter uiter;
                if (!app->compatible) {
                        /*
                         * TODO: In time, we should notice the caller of this error by
                         * telling him that this is a version error.
                         */
                        continue;
                }
                ua_sess = lookup_session_by_app(usess, app);
                if (ua_sess == NULL) {
                        continue;
                }

                /* Get channel */
                lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
                ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
                /* If the session if found for the app, the channel must be there */
                assert(ua_chan_node);

                ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);
                /* The channel must not be already disabled */
                assert(ua_chan->enabled == 1);

                /* Disable channel onto application */
                ret = disable_ust_app_channel(ua_sess, ua_chan, app);
                if (ret < 0) {
                        /* XXX: We might want to report this error at some point... */
                        continue;
                }
        }

        rcu_read_unlock();

error:
        return ret;
}

/*
 * For a specific UST session, enable the channel for all registered apps.
 */
int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan)
{
        int ret = 0;
        struct lttng_ht_iter iter;
        struct ust_app *app;
        struct ust_app_session *ua_sess;

        if (usess == NULL || uchan == NULL) {
                ERR("Adding UST global channel to NULL values");
                ret = -1;
                goto error;
        }

        DBG2("UST app enabling channel %s to global domain for session id %" PRIu64,
                        uchan->name, usess->id);

        rcu_read_lock();

        /* For every registered applications */
        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                if (!app->compatible) {
                        /*
                         * TODO: In time, we should notice the caller of this error by
                         * telling him that this is a version error.
                         */
                        continue;
                }
                ua_sess = lookup_session_by_app(usess, app);
                if (ua_sess == NULL) {
                        continue;
                }

                /* Enable channel onto application */
                ret = enable_ust_app_channel(ua_sess, uchan, app);
                if (ret < 0) {
                        /* XXX: We might want to report this error at some point... */
                        continue;
                }
        }

        rcu_read_unlock();

error:
        return ret;
}

/*
 * Disable an event in a channel and for a specific session.
 */
int ust_app_disable_event_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
{
        int ret = 0;
        struct lttng_ht_iter iter, uiter;
        struct lttng_ht_node_str *ua_chan_node;
        struct ust_app *app;
        struct ust_app_session *ua_sess;
        struct ust_app_channel *ua_chan;
        struct ust_app_event *ua_event;

        DBG("UST app disabling event %s for all apps in channel "
                        "%s for session id %" PRIu64,
                        uevent->attr.name, uchan->name, usess->id);

        rcu_read_lock();

        /* For all registered applications */
        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                if (!app->compatible) {
                        /*
                         * TODO: In time, we should notice the caller of this error by
                         * telling him that this is a version error.
                         */
                        continue;
                }
                ua_sess = lookup_session_by_app(usess, app);
                if (ua_sess == NULL) {
                        /* Next app */
                        continue;
                }

                /* Lookup channel in the ust app session */
                lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
                ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
                if (ua_chan_node == NULL) {
                        DBG2("Channel %s not found in session id %" PRIu64 " for app pid %d."
                                        "Skipping", uchan->name, usess->id, app->pid);
                        continue;
                }
                ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);

                ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
                                uevent->filter, uevent->attr.loglevel,
                                uevent->exclusion);
                if (ua_event == NULL) {
                        DBG2("Event %s not found in channel %s for app pid %d."
                                        "Skipping", uevent->attr.name, uchan->name, app->pid);
                        continue;
                }

                ret = disable_ust_app_event(ua_sess, ua_event, app);
                if (ret < 0) {
                        /* XXX: Report error someday... */
                        continue;
                }
        }

        rcu_read_unlock();

        return ret;
}

/*
 * For a specific UST session, create the channel for all registered apps.
 */
int ust_app_create_channel_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan)
{
        int ret = 0, created;
        struct lttng_ht_iter iter;
        struct ust_app *app;
        struct ust_app_session *ua_sess = NULL;

        /* Very wrong code flow */
        assert(usess);
        assert(uchan);

        DBG2("UST app adding channel %s to UST domain for session id %" PRIu64,
                        uchan->name, usess->id);

        rcu_read_lock();

        /* For every registered applications */
        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                if (!app->compatible) {
                        /*
                         * TODO: In time, we should notice the caller of this error by
                         * telling him that this is a version error.
                         */
                        continue;
                }
                if (!trace_ust_pid_tracker_lookup(usess, app->pid)) {
                        /* Skip. */
                        continue;
                }

                /*
                 * Create session on the tracer side and add it to app session HT. Note
                 * that if session exist, it will simply return a pointer to the ust
                 * app session.
                 */
                ret = find_or_create_ust_app_session(usess, app, &ua_sess, &created);
                if (ret < 0) {
                        switch (ret) {
                        case -ENOTCONN:
                                /*
                                 * The application's socket is not valid. Either a bad socket
                                 * or a timeout on it. We can't inform the caller that for a
                                 * specific app, the session failed so lets continue here.
                                 */
                                ret = 0;        /* Not an error. */
                                continue;
                        case -ENOMEM:
                        default:
                                goto error_rcu_unlock;
                        }
                }
                assert(ua_sess);

                pthread_mutex_lock(&ua_sess->lock);

                if (ua_sess->deleted) {
                        pthread_mutex_unlock(&ua_sess->lock);
                        continue;
                }

                if (!strncmp(uchan->name, DEFAULT_METADATA_NAME,
                                        sizeof(uchan->name))) {
                        copy_channel_attr_to_ustctl(&ua_sess->metadata_attr, &uchan->attr);
                        ret = 0;
                } else {
                        /* Create channel onto application. We don't need the chan ref. */
                        ret = create_ust_app_channel(ua_sess, uchan, app,
                                        LTTNG_UST_CHAN_PER_CPU, usess, NULL);
                }
                pthread_mutex_unlock(&ua_sess->lock);
                if (ret < 0) {
                        /* Cleanup the created session if it's the case. */
                        if (created) {
                                destroy_app_session(app, ua_sess);
                        }
                        switch (ret) {
                        case -ENOTCONN:
                                /*
                                 * The application's socket is not valid. Either a bad socket
                                 * or a timeout on it. We can't inform the caller that for a
                                 * specific app, the session failed so lets continue here.
                                 */
                                ret = 0;        /* Not an error. */
                                continue;
                        case -ENOMEM:
                        default:
                                goto error_rcu_unlock;
                        }
                }
        }

error_rcu_unlock:
        rcu_read_unlock();
        return ret;
}

/*
 * Enable event for a specific session and channel on the tracer.
 */
int ust_app_enable_event_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
{
        int ret = 0;
        struct lttng_ht_iter iter, uiter;
        struct lttng_ht_node_str *ua_chan_node;
        struct ust_app *app;
        struct ust_app_session *ua_sess;
        struct ust_app_channel *ua_chan;
        struct ust_app_event *ua_event;

        DBG("UST app enabling event %s for all apps for session id %" PRIu64,
                        uevent->attr.name, usess->id);

        /*
         * NOTE: At this point, this function is called only if the session and
         * channel passed are already created for all apps. and enabled on the
         * tracer also.
         */

        rcu_read_lock();

        /* For all registered applications */
        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                if (!app->compatible) {
                        /*
                         * TODO: In time, we should notice the caller of this error by
                         * telling him that this is a version error.
                         */
                        continue;
                }
                ua_sess = lookup_session_by_app(usess, app);
                if (!ua_sess) {
                        /* The application has problem or is probably dead. */
                        continue;
                }

                pthread_mutex_lock(&ua_sess->lock);

                if (ua_sess->deleted) {
                        pthread_mutex_unlock(&ua_sess->lock);
                        continue;
                }

                /* Lookup channel in the ust app session */
                lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
                ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
                /*
                 * It is possible that the channel cannot be found is
                 * the channel/event creation occurs concurrently with
                 * an application exit.
                 */
                if (!ua_chan_node) {
                        pthread_mutex_unlock(&ua_sess->lock);
                        continue;
                }

                ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);

                /* Get event node */
                ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
                                uevent->filter, uevent->attr.loglevel, uevent->exclusion);
                if (ua_event == NULL) {
                        DBG3("UST app enable event %s not found for app PID %d."
                                        "Skipping app", uevent->attr.name, app->pid);
                        goto next_app;
                }

                ret = enable_ust_app_event(ua_sess, ua_event, app);
                if (ret < 0) {
                        pthread_mutex_unlock(&ua_sess->lock);
                        goto error;
                }
        next_app:
                pthread_mutex_unlock(&ua_sess->lock);
        }

error:
        rcu_read_unlock();
        return ret;
}

/*
 * For a specific existing UST session and UST channel, creates the event for
 * all registered apps.
 */
int ust_app_create_event_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
{
        int ret = 0;
        struct lttng_ht_iter iter, uiter;
        struct lttng_ht_node_str *ua_chan_node;
        struct ust_app *app;
        struct ust_app_session *ua_sess;
        struct ust_app_channel *ua_chan;

        DBG("UST app creating event %s for all apps for session id %" PRIu64,
                        uevent->attr.name, usess->id);

        rcu_read_lock();

        /* For all registered applications */
        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                if (!app->compatible) {
                        /*
                         * TODO: In time, we should notice the caller of this error by
                         * telling him that this is a version error.
                         */
                        continue;
                }
                ua_sess = lookup_session_by_app(usess, app);
                if (!ua_sess) {
                        /* The application has problem or is probably dead. */
                        continue;
                }

                pthread_mutex_lock(&ua_sess->lock);

                if (ua_sess->deleted) {
                        pthread_mutex_unlock(&ua_sess->lock);
                        continue;
                }

                /* Lookup channel in the ust app session */
                lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
                ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
                /* If the channel is not found, there is a code flow error */
                assert(ua_chan_node);

                ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);

                ret = create_ust_app_event(ua_sess, ua_chan, uevent, app);
                pthread_mutex_unlock(&ua_sess->lock);
                if (ret < 0) {
                        if (ret != -LTTNG_UST_ERR_EXIST) {
                                /* Possible value at this point: -ENOMEM. If so, we stop! */
                                break;
                        }
                        DBG2("UST app event %s already exist on app PID %d",
                                        uevent->attr.name, app->pid);
                        continue;
                }
        }

        rcu_read_unlock();

        return ret;
}

/*
 * Start tracing for a specific UST session and app.
 *
 * Called with UST app session lock held.
 *
 */
static
int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
{
        int ret = 0;
        struct ust_app_session *ua_sess;

        DBG("Starting tracing for ust app pid %d", app->pid);

        rcu_read_lock();

        if (!app->compatible) {
                goto end;
        }

        ua_sess = lookup_session_by_app(usess, app);
        if (ua_sess == NULL) {
                /* The session is in teardown process. Ignore and continue. */
                goto end;
        }

        pthread_mutex_lock(&ua_sess->lock);

        if (ua_sess->deleted) {
                pthread_mutex_unlock(&ua_sess->lock);
                goto end;
        }

        /* Upon restart, we skip the setup, already done */
        if (ua_sess->started) {
                goto skip_setup;
        }

        /* Create directories if consumer is LOCAL and has a path defined. */
        if (usess->consumer->type == CONSUMER_DST_LOCAL &&
                        usess->consumer->dst.session_root_path[0] != '\0') {
                char *tmp_path;

                tmp_path = zmalloc(LTTNG_PATH_MAX);
                if (!tmp_path) {
                        ERR("Alloc tmp_path");
                        goto error_unlock;
                }
                ret = snprintf(tmp_path, LTTNG_PATH_MAX, "%s%s%s",
                                usess->consumer->dst.session_root_path,
                                usess->consumer->chunk_path,
                                usess->consumer->subdir);
                if (ret >= LTTNG_PATH_MAX) {
                        ERR("Local destination path exceeds the maximal allowed length of %i bytes (needs %i bytes) with path = \"%s%s%s\"",
                                        LTTNG_PATH_MAX, ret,
                                        usess->consumer->dst.session_root_path,
                                        usess->consumer->chunk_path,
                                        usess->consumer->subdir);
                        goto error_unlock;
                }

                DBG("Creating directory path for local tracing: \"%s\"",
                                tmp_path);
                ret = run_as_mkdir_recursive(tmp_path, S_IRWXU | S_IRWXG,
                                ua_sess->euid, ua_sess->egid);
                free(tmp_path);
                if (ret < 0) {
                        if (errno != EEXIST) {
                                ERR("Trace directory creation error");
                                goto error_unlock;
                        }
                }
        }

        /*
         * Create the metadata for the application. This returns gracefully if a
         * metadata was already set for the session.
         */
        ret = create_ust_app_metadata(ua_sess, app, usess->consumer);
        if (ret < 0) {
                goto error_unlock;
        }

        health_code_update();

skip_setup:
        /* This start the UST tracing */
        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_start_session(app->sock, ua_sess->handle);
        pthread_mutex_unlock(&app->sock_lock);
        if (ret < 0) {
                if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("Error starting tracing for app pid: %d (ret: %d)",
                                        app->pid, ret);
                } else {
                        DBG("UST app start session failed. Application is dead.");
                        /*
                         * This is normal behavior, an application can die during the
                         * creation process. Don't report an error so the execution can
                         * continue normally.
                         */
                        pthread_mutex_unlock(&ua_sess->lock);
                        goto end;
                }
                goto error_unlock;
        }

        /* Indicate that the session has been started once */
        ua_sess->started = 1;

        pthread_mutex_unlock(&ua_sess->lock);

        health_code_update();

        /* Quiescent wait after starting trace */
        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_wait_quiescent(app->sock);
        pthread_mutex_unlock(&app->sock_lock);
        if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                ERR("UST app wait quiescent failed for app pid %d ret %d",
                                app->pid, ret);
        }

end:
        rcu_read_unlock();
        health_code_update();
        return 0;

error_unlock:
        pthread_mutex_unlock(&ua_sess->lock);
        rcu_read_unlock();
        health_code_update();
        return -1;
}

/*
 * Stop tracing for a specific UST session and app.
 */
static
int ust_app_stop_trace(struct ltt_ust_session *usess, struct ust_app *app)
{
        int ret = 0;
        struct ust_app_session *ua_sess;
        struct ust_registry_session *registry;

        DBG("Stopping tracing for ust app pid %d", app->pid);

        rcu_read_lock();

        if (!app->compatible) {
                goto end_no_session;
        }

        ua_sess = lookup_session_by_app(usess, app);
        if (ua_sess == NULL) {
                goto end_no_session;
        }

        pthread_mutex_lock(&ua_sess->lock);

        if (ua_sess->deleted) {
                pthread_mutex_unlock(&ua_sess->lock);
                goto end_no_session;
        }

        /*
         * If started = 0, it means that stop trace has been called for a session
         * that was never started. It's possible since we can have a fail start
         * from either the application manager thread or the command thread. Simply
         * indicate that this is a stop error.
         */
        if (!ua_sess->started) {
                goto error_rcu_unlock;
        }

        health_code_update();

        /* This inhibits UST tracing */
        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_stop_session(app->sock, ua_sess->handle);
        pthread_mutex_unlock(&app->sock_lock);
        if (ret < 0) {
                if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("Error stopping tracing for app pid: %d (ret: %d)",
                                        app->pid, ret);
                } else {
                        DBG("UST app stop session failed. Application is dead.");
                        /*
                         * This is normal behavior, an application can die during the
                         * creation process. Don't report an error so the execution can
                         * continue normally.
                         */
                        goto end_unlock;
                }
                goto error_rcu_unlock;
        }

        health_code_update();

        /* Quiescent wait after stopping trace */
        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_wait_quiescent(app->sock);
        pthread_mutex_unlock(&app->sock_lock);
        if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                ERR("UST app wait quiescent failed for app pid %d ret %d",
                                app->pid, ret);
        }

        health_code_update();

        registry = get_session_registry(ua_sess);

        /* The UST app session is held registry shall not be null. */
        assert(registry);

        /* Push metadata for application before freeing the application. */
        (void) push_metadata(registry, ua_sess->consumer);

end_unlock:
        pthread_mutex_unlock(&ua_sess->lock);
end_no_session:
        rcu_read_unlock();
        health_code_update();
        return 0;

error_rcu_unlock:
        pthread_mutex_unlock(&ua_sess->lock);
        rcu_read_unlock();
        health_code_update();
        return -1;
}

static
int ust_app_flush_app_session(struct ust_app *app,
                struct ust_app_session *ua_sess)
{
        int ret, retval = 0;
        struct lttng_ht_iter iter;
        struct ust_app_channel *ua_chan;
        struct consumer_socket *socket;

        DBG("Flushing app session buffers for ust app pid %d", app->pid);

        rcu_read_lock();

        if (!app->compatible) {
                goto end_not_compatible;
        }

        pthread_mutex_lock(&ua_sess->lock);

        if (ua_sess->deleted) {
                goto end_deleted;
        }

        health_code_update();

        /* Flushing buffers */
        socket = consumer_find_socket_by_bitness(app->bits_per_long,
                        ua_sess->consumer);

        /* Flush buffers and push metadata. */
        switch (ua_sess->buffer_type) {
        case LTTNG_BUFFER_PER_PID:
                cds_lfht_for_each_entry(ua_sess->channels->ht, &iter.iter, ua_chan,
                                node.node) {
                        health_code_update();
                        ret = consumer_flush_channel(socket, ua_chan->key);
                        if (ret) {
                                ERR("Error flushing consumer channel");
                                retval = -1;
                                continue;
                        }
                }
                break;
        case LTTNG_BUFFER_PER_UID:
        default:
                assert(0);
                break;
        }

        health_code_update();

end_deleted:
        pthread_mutex_unlock(&ua_sess->lock);

end_not_compatible:
        rcu_read_unlock();
        health_code_update();
        return retval;
}

/*
 * Flush buffers for all applications for a specific UST session.
 * Called with UST session lock held.
 */
static
int ust_app_flush_session(struct ltt_ust_session *usess)

{
        int ret = 0;

        DBG("Flushing session buffers for all ust apps");

        rcu_read_lock();

        /* Flush buffers and push metadata. */
        switch (usess->buffer_type) {
        case LTTNG_BUFFER_PER_UID:
        {
                struct buffer_reg_uid *reg;
                struct lttng_ht_iter iter;

                /* Flush all per UID buffers associated to that session. */
                cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
                        struct ust_registry_session *ust_session_reg;
                        struct buffer_reg_channel *reg_chan;
                        struct consumer_socket *socket;

                        /* Get consumer socket to use to push the metadata.*/
                        socket = consumer_find_socket_by_bitness(reg->bits_per_long,
                                        usess->consumer);
                        if (!socket) {
                                /* Ignore request if no consumer is found for the session. */
                                continue;
                        }

                        cds_lfht_for_each_entry(reg->registry->channels->ht, &iter.iter,
                                        reg_chan, node.node) {
                                /*
                                 * The following call will print error values so the return
                                 * code is of little importance because whatever happens, we
                                 * have to try them all.
                                 */
                                (void) consumer_flush_channel(socket, reg_chan->consumer_key);
                        }

                        ust_session_reg = reg->registry->reg.ust;
                        /* Push metadata. */
                        (void) push_metadata(ust_session_reg, usess->consumer);
                }
                break;
        }
        case LTTNG_BUFFER_PER_PID:
        {
                struct ust_app_session *ua_sess;
                struct lttng_ht_iter iter;
                struct ust_app *app;

                cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                        ua_sess = lookup_session_by_app(usess, app);
                        if (ua_sess == NULL) {
                                continue;
                        }
                        (void) ust_app_flush_app_session(app, ua_sess);
                }
                break;
        }
        default:
                ret = -1;
                assert(0);
                break;
        }

        rcu_read_unlock();
        health_code_update();
        return ret;
}

static
int ust_app_clear_quiescent_app_session(struct ust_app *app,
                struct ust_app_session *ua_sess)
{
        int ret = 0;
        struct lttng_ht_iter iter;
        struct ust_app_channel *ua_chan;
        struct consumer_socket *socket;

        DBG("Clearing stream quiescent state for ust app pid %d", app->pid);

        rcu_read_lock();

        if (!app->compatible) {
                goto end_not_compatible;
        }

        pthread_mutex_lock(&ua_sess->lock);

        if (ua_sess->deleted) {
                goto end_unlock;
        }

        health_code_update();

        socket = consumer_find_socket_by_bitness(app->bits_per_long,
                        ua_sess->consumer);
        if (!socket) {
                ERR("Failed to find consumer (%" PRIu32 ") socket",
                                app->bits_per_long);
                ret = -1;
                goto end_unlock;
        }

        /* Clear quiescent state. */
        switch (ua_sess->buffer_type) {
        case LTTNG_BUFFER_PER_PID:
                cds_lfht_for_each_entry(ua_sess->channels->ht, &iter.iter,
                                ua_chan, node.node) {
                        health_code_update();
                        ret = consumer_clear_quiescent_channel(socket,
                                        ua_chan->key);
                        if (ret) {
                                ERR("Error clearing quiescent state for consumer channel");
                                ret = -1;
                                continue;
                        }
                }
                break;
        case LTTNG_BUFFER_PER_UID:
        default:
                assert(0);
                ret = -1;
                break;
        }

        health_code_update();

end_unlock:
        pthread_mutex_unlock(&ua_sess->lock);

end_not_compatible:
        rcu_read_unlock();
        health_code_update();
        return ret;
}

/*
 * Clear quiescent state in each stream for all applications for a
 * specific UST session.
 * Called with UST session lock held.
 */
static
int ust_app_clear_quiescent_session(struct ltt_ust_session *usess)

{
        int ret = 0;

        DBG("Clearing stream quiescent state for all ust apps");

        rcu_read_lock();

        switch (usess->buffer_type) {
        case LTTNG_BUFFER_PER_UID:
        {
                struct lttng_ht_iter iter;
                struct buffer_reg_uid *reg;

                /*
                 * Clear quiescent for all per UID buffers associated to
                 * that session.
                 */
                cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
                        struct consumer_socket *socket;
                        struct buffer_reg_channel *reg_chan;

                        /* Get associated consumer socket.*/
                        socket = consumer_find_socket_by_bitness(
                                        reg->bits_per_long, usess->consumer);
                        if (!socket) {
                                /*
                                 * Ignore request if no consumer is found for
                                 * the session.
                                 */
                                continue;
                        }

                        cds_lfht_for_each_entry(reg->registry->channels->ht,
                                        &iter.iter, reg_chan, node.node) {
                                /*
                                 * The following call will print error values so
                                 * the return code is of little importance
                                 * because whatever happens, we have to try them
                                 * all.
                                 */
                                (void) consumer_clear_quiescent_channel(socket,
                                                reg_chan->consumer_key);
                        }
                }
                break;
        }
        case LTTNG_BUFFER_PER_PID:
        {
                struct ust_app_session *ua_sess;
                struct lttng_ht_iter iter;
                struct ust_app *app;

                cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app,
                                pid_n.node) {
                        ua_sess = lookup_session_by_app(usess, app);
                        if (ua_sess == NULL) {
                                continue;
                        }
                        (void) ust_app_clear_quiescent_app_session(app,
                                        ua_sess);
                }
                break;
        }
        default:
                ret = -1;
                assert(0);
                break;
        }

        rcu_read_unlock();
        health_code_update();
        return ret;
}

/*
 * Destroy a specific UST session in apps.
 */
static int destroy_trace(struct ltt_ust_session *usess, struct ust_app *app)
{
        int ret;
        struct ust_app_session *ua_sess;
        struct lttng_ht_iter iter;
        struct lttng_ht_node_u64 *node;

        DBG("Destroy tracing for ust app pid %d", app->pid);

        rcu_read_lock();

        if (!app->compatible) {
                goto end;
        }

        __lookup_session_by_app(usess, app, &iter);
        node = lttng_ht_iter_get_node_u64(&iter);
        if (node == NULL) {
                /* Session is being or is deleted. */
                goto end;
        }
        ua_sess = caa_container_of(node, struct ust_app_session, node);

        health_code_update();
        destroy_app_session(app, ua_sess);

        health_code_update();

        /* Quiescent wait after stopping trace */
        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_wait_quiescent(app->sock);
        pthread_mutex_unlock(&app->sock_lock);
        if (ret < 0 && ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                ERR("UST app wait quiescent failed for app pid %d ret %d",
                                app->pid, ret);
        }
end:
        rcu_read_unlock();
        health_code_update();
        return 0;
}

/*
 * Start tracing for the UST session.
 */
int ust_app_start_trace_all(struct ltt_ust_session *usess)
{
        int ret = 0;
        struct lttng_ht_iter iter;
        struct ust_app *app;

        DBG("Starting all UST traces");

        rcu_read_lock();

        /*
         * In a start-stop-start use-case, we need to clear the quiescent state
         * of each channel set by the prior stop command, thus ensuring that a
         * following stop or destroy is sure to grab a timestamp_end near those
         * operations, even if the packet is empty.
         */
        (void) ust_app_clear_quiescent_session(usess);

        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                ret = ust_app_start_trace(usess, app);
                if (ret < 0) {
                        /* Continue to next apps even on error */
                        continue;
                }
        }

        rcu_read_unlock();

        return 0;
}

/*
 * Start tracing for the UST session.
 * Called with UST session lock held.
 */
int ust_app_stop_trace_all(struct ltt_ust_session *usess)
{
        int ret = 0;
        struct lttng_ht_iter iter;
        struct ust_app *app;

        DBG("Stopping all UST traces");

        rcu_read_lock();

        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                ret = ust_app_stop_trace(usess, app);
                if (ret < 0) {
                        /* Continue to next apps even on error */
                        continue;
                }
        }

        (void) ust_app_flush_session(usess);

        rcu_read_unlock();

        return 0;
}

/*
 * Destroy app UST session.
 */
int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
{
        int ret = 0;
        struct lttng_ht_iter iter;
        struct ust_app *app;

        DBG("Destroy all UST traces");

        rcu_read_lock();

        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                ret = destroy_trace(usess, app);
                if (ret < 0) {
                        /* Continue to next apps even on error */
                        continue;
                }
        }

        rcu_read_unlock();

        return 0;
}

static
void ust_app_global_create(struct ltt_ust_session *usess, struct ust_app *app)
{
        int ret = 0;
        struct lttng_ht_iter iter, uiter;
        struct ust_app_session *ua_sess = NULL;
        struct ust_app_channel *ua_chan;
        struct ust_app_event *ua_event;
        struct ust_app_ctx *ua_ctx;
        int is_created = 0;

        ret = find_or_create_ust_app_session(usess, app, &ua_sess, &is_created);
        if (ret < 0) {
                /* Tracer is probably gone or ENOMEM. */
                goto error;
        }
        if (!is_created) {
                /* App session already created. */
                goto end;
        }
        assert(ua_sess);

        pthread_mutex_lock(&ua_sess->lock);

        if (ua_sess->deleted) {
                pthread_mutex_unlock(&ua_sess->lock);
                goto end;
        }

        /*
         * We can iterate safely here over all UST app session since the create ust
         * app session above made a shadow copy of the UST global domain from the
         * ltt ust session.
         */
        cds_lfht_for_each_entry(ua_sess->channels->ht, &iter.iter, ua_chan,
                        node.node) {
                ret = do_create_channel(app, usess, ua_sess, ua_chan);
                if (ret < 0 && ret != -ENOTCONN) {
                        /*
                         * Stop everything. On error, the application
                         * failed, no more file descriptor are available
                         * or ENOMEM so stopping here is the only thing
                         * we can do for now. The only exception is
                         * -ENOTCONN, which indicates that the application
                         * has exit.
                         */
                        goto error_unlock;
                }

                /*
                 * Add context using the list so they are enabled in the same order the
                 * user added them.
                 */
                cds_list_for_each_entry(ua_ctx, &ua_chan->ctx_list, list) {
                        ret = create_ust_channel_context(ua_chan, ua_ctx, app);
                        if (ret < 0) {
                                goto error_unlock;
                        }
                }


                /* For each events */
                cds_lfht_for_each_entry(ua_chan->events->ht, &uiter.iter, ua_event,
                                node.node) {
                        ret = create_ust_event(app, ua_sess, ua_chan, ua_event);
                        if (ret < 0) {
                                goto error_unlock;
                        }
                }
        }

        pthread_mutex_unlock(&ua_sess->lock);

        if (usess->active) {
                ret = ust_app_start_trace(usess, app);
                if (ret < 0) {
                        goto error;
                }

                DBG2("UST trace started for app pid %d", app->pid);
        }
end:
        /* Everything went well at this point. */
        return;

error_unlock:
        pthread_mutex_unlock(&ua_sess->lock);
error:
        if (ua_sess) {
                destroy_app_session(app, ua_sess);
        }
        return;
}

static
void ust_app_global_destroy(struct ltt_ust_session *usess, struct ust_app *app)
{
        struct ust_app_session *ua_sess;

        ua_sess = lookup_session_by_app(usess, app);
        if (ua_sess == NULL) {
                return;
        }
        destroy_app_session(app, ua_sess);
}

/*
 * Add channels/events from UST global domain to registered apps at sock.
 *
 * Called with session lock held.
 * Called with RCU read-side lock held.
 */
void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app)
{
        assert(usess);

        DBG2("UST app global update for app sock %d for session id %" PRIu64,
                        app->sock, usess->id);

        if (!app->compatible) {
                return;
        }

        if (trace_ust_pid_tracker_lookup(usess, app->pid)) {
                ust_app_global_create(usess, app);
        } else {
                ust_app_global_destroy(usess, app);
        }
}

/*
 * Called with session lock held.
 */
void ust_app_global_update_all(struct ltt_ust_session *usess)
{
        struct lttng_ht_iter iter;
        struct ust_app *app;

        rcu_read_lock();
        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                ust_app_global_update(usess, app);
        }
        rcu_read_unlock();
}

/*
 * Add context to a specific channel for global UST domain.
 */
int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
{
        int ret = 0;
        struct lttng_ht_node_str *ua_chan_node;
        struct lttng_ht_iter iter, uiter;
        struct ust_app_channel *ua_chan = NULL;
        struct ust_app_session *ua_sess;
        struct ust_app *app;

        rcu_read_lock();

        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                if (!app->compatible) {
                        /*
                         * TODO: In time, we should notice the caller of this error by
                         * telling him that this is a version error.
                         */
                        continue;
                }
                ua_sess = lookup_session_by_app(usess, app);
                if (ua_sess == NULL) {
                        continue;
                }

                pthread_mutex_lock(&ua_sess->lock);

                if (ua_sess->deleted) {
                        pthread_mutex_unlock(&ua_sess->lock);
                        continue;
                }

                /* Lookup channel in the ust app session */
                lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &uiter);
                ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
                if (ua_chan_node == NULL) {
                        goto next_app;
                }
                ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel,
                                node);
                ret = create_ust_app_channel_context(ua_chan, &uctx->ctx, app);
                if (ret < 0) {
                        goto next_app;
                }
        next_app:
                pthread_mutex_unlock(&ua_sess->lock);
        }

        rcu_read_unlock();
        return ret;
}

/*
 * Enable event for a channel from a UST session for a specific PID.
 */
int ust_app_enable_event_pid(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent, pid_t pid)
{
        int ret = 0;
        struct lttng_ht_iter iter;
        struct lttng_ht_node_str *ua_chan_node;
        struct ust_app *app;
        struct ust_app_session *ua_sess;
        struct ust_app_channel *ua_chan;
        struct ust_app_event *ua_event;

        DBG("UST app enabling event %s for PID %d", uevent->attr.name, pid);

        rcu_read_lock();

        app = ust_app_find_by_pid(pid);
        if (app == NULL) {
                ERR("UST app enable event per PID %d not found", pid);
                ret = -1;
                goto end;
        }

        if (!app->compatible) {
                ret = 0;
                goto end;
        }

        ua_sess = lookup_session_by_app(usess, app);
        if (!ua_sess) {
                /* The application has problem or is probably dead. */
                ret = 0;
                goto end;
        }

        pthread_mutex_lock(&ua_sess->lock);

        if (ua_sess->deleted) {
                ret = 0;
                goto end_unlock;
        }

        /* Lookup channel in the ust app session */
        lttng_ht_lookup(ua_sess->channels, (void *)uchan->name, &iter);
        ua_chan_node = lttng_ht_iter_get_node_str(&iter);
        /* If the channel is not found, there is a code flow error */
        assert(ua_chan_node);

        ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);

        ua_event = find_ust_app_event(ua_chan->events, uevent->attr.name,
                        uevent->filter, uevent->attr.loglevel, uevent->exclusion);
        if (ua_event == NULL) {
                ret = create_ust_app_event(ua_sess, ua_chan, uevent, app);
                if (ret < 0) {
                        goto end_unlock;
                }
        } else {
                ret = enable_ust_app_event(ua_sess, ua_event, app);
                if (ret < 0) {
                        goto end_unlock;
                }
        }

end_unlock:
        pthread_mutex_unlock(&ua_sess->lock);
end:
        rcu_read_unlock();
        return ret;
}

/*
 * Receive registration and populate the given msg structure.
 *
 * On success return 0 else a negative value returned by the ustctl call.
 */
int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
{
        int ret;
        uint32_t pid, ppid, uid, gid;

        assert(msg);

        ret = ustctl_recv_reg_msg(sock, &msg->type, &msg->major, &msg->minor,
                        &pid, &ppid, &uid, &gid,
                        &msg->bits_per_long,
                        &msg->uint8_t_alignment,
                        &msg->uint16_t_alignment,
                        &msg->uint32_t_alignment,
                        &msg->uint64_t_alignment,
                        &msg->long_alignment,
                        &msg->byte_order,
                        msg->name);
        if (ret < 0) {
                switch (-ret) {
                case EPIPE:
                case ECONNRESET:
                case LTTNG_UST_ERR_EXITING:
                        DBG3("UST app recv reg message failed. Application died");
                        break;
                case LTTNG_UST_ERR_UNSUP_MAJOR:
                        ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
                                        msg->major, msg->minor, LTTNG_UST_ABI_MAJOR_VERSION,
                                        LTTNG_UST_ABI_MINOR_VERSION);
                        break;
                default:
                        ERR("UST app recv reg message failed with ret %d", ret);
                        break;
                }
                goto error;
        }
        msg->pid = (pid_t) pid;
        msg->ppid = (pid_t) ppid;
        msg->uid = (uid_t) uid;
        msg->gid = (gid_t) gid;

error:
        return ret;
}

/*
 * Return a ust app session object using the application object and the
 * session object descriptor has a key. If not found, NULL is returned.
 * A RCU read side lock MUST be acquired when calling this function.
*/
static struct ust_app_session *find_session_by_objd(struct ust_app *app,
                int objd)
{
        struct lttng_ht_node_ulong *node;
        struct lttng_ht_iter iter;
        struct ust_app_session *ua_sess = NULL;

        assert(app);

        lttng_ht_lookup(app->ust_sessions_objd, (void *)((unsigned long) objd), &iter);
        node = lttng_ht_iter_get_node_ulong(&iter);
        if (node == NULL) {
                DBG2("UST app session find by objd %d not found", objd);
                goto error;
        }

        ua_sess = caa_container_of(node, struct ust_app_session, ust_objd_node);

error:
        return ua_sess;
}

/*
 * Return a ust app channel object using the application object and the channel
 * object descriptor has a key. If not found, NULL is returned. A RCU read side
 * lock MUST be acquired before calling this function.
 */
static struct ust_app_channel *find_channel_by_objd(struct ust_app *app,
                int objd)
{
        struct lttng_ht_node_ulong *node;
        struct lttng_ht_iter iter;
        struct ust_app_channel *ua_chan = NULL;

        assert(app);

        lttng_ht_lookup(app->ust_objd, (void *)((unsigned long) objd), &iter);
        node = lttng_ht_iter_get_node_ulong(&iter);
        if (node == NULL) {
                DBG2("UST app channel find by objd %d not found", objd);
                goto error;
        }

        ua_chan = caa_container_of(node, struct ust_app_channel, ust_objd_node);

error:
        return ua_chan;
}

/*
 * Reply to a register channel notification from an application on the notify
 * socket. The channel metadata is also created.
 *
 * The session UST registry lock is acquired in this function.
 *
 * On success 0 is returned else a negative value.
 */
static int reply_ust_register_channel(int sock, int cobjd,
                size_t nr_fields, struct ustctl_field *fields)
{
        int ret, ret_code = 0;
        uint32_t chan_id, reg_count;
        uint64_t chan_reg_key;
        enum ustctl_channel_header type;
        struct ust_app *app;
        struct ust_app_channel *ua_chan;
        struct ust_app_session *ua_sess;
        struct ust_registry_session *registry;
        struct ust_registry_channel *chan_reg;

        rcu_read_lock();

        /* Lookup application. If not found, there is a code flow error. */
        app = find_app_by_notify_sock(sock);
        if (!app) {
                DBG("Application socket %d is being torn down. Abort event notify",
                                sock);
                ret = 0;
                goto error_rcu_unlock;
        }

        /* Lookup channel by UST object descriptor. */
        ua_chan = find_channel_by_objd(app, cobjd);
        if (!ua_chan) {
                DBG("Application channel is being torn down. Abort event notify");
                ret = 0;
                goto error_rcu_unlock;
        }

        assert(ua_chan->session);
        ua_sess = ua_chan->session;

        /* Get right session registry depending on the session buffer type. */
        registry = get_session_registry(ua_sess);
        if (!registry) {
                DBG("Application session is being torn down. Abort event notify");
                ret = 0;
                goto error_rcu_unlock;
        };

        /* Depending on the buffer type, a different channel key is used. */
        if (ua_sess->buffer_type == LTTNG_BUFFER_PER_UID) {
                chan_reg_key = ua_chan->tracing_channel_id;
        } else {
                chan_reg_key = ua_chan->key;
        }

        pthread_mutex_lock(&registry->lock);

        chan_reg = ust_registry_channel_find(registry, chan_reg_key);
        assert(chan_reg);

        if (!chan_reg->register_done) {
                reg_count = ust_registry_get_event_count(chan_reg);
                if (reg_count < 31) {
                        type = USTCTL_CHANNEL_HEADER_COMPACT;
                } else {
                        type = USTCTL_CHANNEL_HEADER_LARGE;
                }

                chan_reg->nr_ctx_fields = nr_fields;
                chan_reg->ctx_fields = fields;
                fields = NULL;
                chan_reg->header_type = type;
        } else {
                /* Get current already assigned values. */
                type = chan_reg->header_type;
        }
        /* Channel id is set during the object creation. */
        chan_id = chan_reg->chan_id;

        /* Append to metadata */
        if (!chan_reg->metadata_dumped) {
                ret_code = ust_metadata_channel_statedump(registry, chan_reg);
                if (ret_code) {
                        ERR("Error appending channel metadata (errno = %d)", ret_code);
                        goto reply;
                }
        }

reply:
        DBG3("UST app replying to register channel key %" PRIu64
                        " with id %u, type: %d, ret: %d", chan_reg_key, chan_id, type,
                        ret_code);

        ret = ustctl_reply_register_channel(sock, chan_id, type, ret_code);
        if (ret < 0) {
                if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app reply channel failed with ret %d", ret);
                } else {
                        DBG3("UST app reply channel failed. Application died");
                }
                goto error;
        }

        /* This channel registry registration is completed. */
        chan_reg->register_done = 1;

error:
        pthread_mutex_unlock(&registry->lock);
error_rcu_unlock:
        rcu_read_unlock();
        free(fields);
        return ret;
}

/*
 * Add event to the UST channel registry. When the event is added to the
 * registry, the metadata is also created. Once done, this replies to the
 * application with the appropriate error code.
 *
 * The session UST registry lock is acquired in the function.
 *
 * On success 0 is returned else a negative value.
 */
static int add_event_ust_registry(int sock, int sobjd, int cobjd, char *name,
                char *sig, size_t nr_fields, struct ustctl_field *fields,
                int loglevel_value, char *model_emf_uri)
{
        int ret, ret_code;
        uint32_t event_id = 0;
        uint64_t chan_reg_key;
        struct ust_app *app;
        struct ust_app_channel *ua_chan;
        struct ust_app_session *ua_sess;
        struct ust_registry_session *registry;

        rcu_read_lock();

        /* Lookup application. If not found, there is a code flow error. */
        app = find_app_by_notify_sock(sock);
        if (!app) {
                DBG("Application socket %d is being torn down. Abort event notify",
                                sock);
                ret = 0;
                goto error_rcu_unlock;
        }

        /* Lookup channel by UST object descriptor. */
        ua_chan = find_channel_by_objd(app, cobjd);
        if (!ua_chan) {
                DBG("Application channel is being torn down. Abort event notify");
                ret = 0;
                goto error_rcu_unlock;
        }

        assert(ua_chan->session);
        ua_sess = ua_chan->session;

        registry = get_session_registry(ua_sess);
        if (!registry) {
                DBG("Application session is being torn down. Abort event notify");
                ret = 0;
                goto error_rcu_unlock;
        }

        if (ua_sess->buffer_type == LTTNG_BUFFER_PER_UID) {
                chan_reg_key = ua_chan->tracing_channel_id;
        } else {
                chan_reg_key = ua_chan->key;
        }

        pthread_mutex_lock(&registry->lock);

        /*
         * From this point on, this call acquires the ownership of the sig, fields
         * and model_emf_uri meaning any free are done inside it if needed. These
         * three variables MUST NOT be read/write after this.
         */
        ret_code = ust_registry_create_event(registry, chan_reg_key,
                        sobjd, cobjd, name, sig, nr_fields, fields,
                        loglevel_value, model_emf_uri, ua_sess->buffer_type,
                        &event_id, app);
        sig = NULL;
        fields = NULL;
        model_emf_uri = NULL;

        /*
         * The return value is returned to ustctl so in case of an error, the
         * application can be notified. In case of an error, it's important not to
         * return a negative error or else the application will get closed.
         */
        ret = ustctl_reply_register_event(sock, event_id, ret_code);
        if (ret < 0) {
                if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app reply event failed with ret %d", ret);
                } else {
                        DBG3("UST app reply event failed. Application died");
                }
                /*
                 * No need to wipe the create event since the application socket will
                 * get close on error hence cleaning up everything by itself.
                 */
                goto error;
        }

        DBG3("UST registry event %s with id %" PRId32 " added successfully",
                        name, event_id);

error:
        pthread_mutex_unlock(&registry->lock);
error_rcu_unlock:
        rcu_read_unlock();
        free(sig);
        free(fields);
        free(model_emf_uri);
        return ret;
}

/*
 * Add enum to the UST session registry. Once done, this replies to the
 * application with the appropriate error code.
 *
 * The session UST registry lock is acquired within this function.
 *
 * On success 0 is returned else a negative value.
 */
static int add_enum_ust_registry(int sock, int sobjd, char *name,
                struct ustctl_enum_entry *entries, size_t nr_entries)
{
        int ret = 0, ret_code;
        struct ust_app *app;
        struct ust_app_session *ua_sess;
        struct ust_registry_session *registry;
        uint64_t enum_id = -1ULL;

        rcu_read_lock();

        /* Lookup application. If not found, there is a code flow error. */
        app = find_app_by_notify_sock(sock);
        if (!app) {
                /* Return an error since this is not an error */
                DBG("Application socket %d is being torn down. Aborting enum registration",
                                sock);
                free(entries);
                goto error_rcu_unlock;
        }

        /* Lookup session by UST object descriptor. */
        ua_sess = find_session_by_objd(app, sobjd);
        if (!ua_sess) {
                /* Return an error since this is not an error */
                DBG("Application session is being torn down (session not found). Aborting enum registration.");
                free(entries);
                goto error_rcu_unlock;
        }

        registry = get_session_registry(ua_sess);
        if (!registry) {
                DBG("Application session is being torn down (registry not found). Aborting enum registration.");
                free(entries);
                goto error_rcu_unlock;
        }

        pthread_mutex_lock(&registry->lock);

        /*
         * From this point on, the callee acquires the ownership of
         * entries. The variable entries MUST NOT be read/written after
         * call.
         */
        ret_code = ust_registry_create_or_find_enum(registry, sobjd, name,
                        entries, nr_entries, &enum_id);
        entries = NULL;

        /*
         * The return value is returned to ustctl so in case of an error, the
         * application can be notified. In case of an error, it's important not to
         * return a negative error or else the application will get closed.
         */
        ret = ustctl_reply_register_enum(sock, enum_id, ret_code);
        if (ret < 0) {
                if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app reply enum failed with ret %d", ret);
                } else {
                        DBG3("UST app reply enum failed. Application died");
                }
                /*
                 * No need to wipe the create enum since the application socket will
                 * get close on error hence cleaning up everything by itself.
                 */
                goto error;
        }

        DBG3("UST registry enum %s added successfully or already found", name);

error:
        pthread_mutex_unlock(&registry->lock);
error_rcu_unlock:
        rcu_read_unlock();
        return ret;
}

/*
 * Handle application notification through the given notify socket.
 *
 * Return 0 on success or else a negative value.
 */
int ust_app_recv_notify(int sock)
{
        int ret;
        enum ustctl_notify_cmd cmd;

        DBG3("UST app receiving notify from sock %d", sock);

        ret = ustctl_recv_notify(sock, &cmd);
        if (ret < 0) {
                if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                        ERR("UST app recv notify failed with ret %d", ret);
                } else {
                        DBG3("UST app recv notify failed. Application died");
                }
                goto error;
        }

        switch (cmd) {
        case USTCTL_NOTIFY_CMD_EVENT:
        {
                int sobjd, cobjd, loglevel_value;
                char name[LTTNG_UST_SYM_NAME_LEN], *sig, *model_emf_uri;
                size_t nr_fields;
                struct ustctl_field *fields;

                DBG2("UST app ustctl register event received");

                ret = ustctl_recv_register_event(sock, &sobjd, &cobjd, name,
                                &loglevel_value, &sig, &nr_fields, &fields,
                                &model_emf_uri);
                if (ret < 0) {
                        if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                                ERR("UST app recv event failed with ret %d", ret);
                        } else {
                                DBG3("UST app recv event failed. Application died");
                        }
                        goto error;
                }

                /*
                 * Add event to the UST registry coming from the notify socket. This
                 * call will free if needed the sig, fields and model_emf_uri. This
                 * code path loses the ownsership of these variables and transfer them
                 * to the this function.
                 */
                ret = add_event_ust_registry(sock, sobjd, cobjd, name, sig, nr_fields,
                                fields, loglevel_value, model_emf_uri);
                if (ret < 0) {
                        goto error;
                }

                break;
        }
        case USTCTL_NOTIFY_CMD_CHANNEL:
        {
                int sobjd, cobjd;
                size_t nr_fields;
                struct ustctl_field *fields;

                DBG2("UST app ustctl register channel received");

                ret = ustctl_recv_register_channel(sock, &sobjd, &cobjd, &nr_fields,
                                &fields);
                if (ret < 0) {
                        if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                                ERR("UST app recv channel failed with ret %d", ret);
                        } else {
                                DBG3("UST app recv channel failed. Application died");
                        }
                        goto error;
                }

                /*
                 * The fields ownership are transfered to this function call meaning
                 * that if needed it will be freed. After this, it's invalid to access
                 * fields or clean it up.
                 */
                ret = reply_ust_register_channel(sock, cobjd, nr_fields,
                                fields);
                if (ret < 0) {
                        goto error;
                }

                break;
        }
        case USTCTL_NOTIFY_CMD_ENUM:
        {
                int sobjd;
                char name[LTTNG_UST_SYM_NAME_LEN];
                size_t nr_entries;
                struct ustctl_enum_entry *entries;

                DBG2("UST app ustctl register enum received");

                ret = ustctl_recv_register_enum(sock, &sobjd, name,
                                &entries, &nr_entries);
                if (ret < 0) {
                        if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
                                ERR("UST app recv enum failed with ret %d", ret);
                        } else {
                                DBG3("UST app recv enum failed. Application died");
                        }
                        goto error;
                }

                /* Callee assumes ownership of entries */
                ret = add_enum_ust_registry(sock, sobjd, name,
                                entries, nr_entries);
                if (ret < 0) {
                        goto error;
                }

                break;
        }
        default:
                /* Should NEVER happen. */
                assert(0);
        }

error:
        return ret;
}

/*
 * Once the notify socket hangs up, this is called. First, it tries to find the
 * corresponding application. On failure, the call_rcu to close the socket is
 * executed. If an application is found, it tries to delete it from the notify
 * socket hash table. Whathever the result, it proceeds to the call_rcu.
 *
 * Note that an object needs to be allocated here so on ENOMEM failure, the
 * call RCU is not done but the rest of the cleanup is.
 */
void ust_app_notify_sock_unregister(int sock)
{
        int err_enomem = 0;
        struct lttng_ht_iter iter;
        struct ust_app *app;
        struct ust_app_notify_sock_obj *obj;

        assert(sock >= 0);

        rcu_read_lock();

        obj = zmalloc(sizeof(*obj));
        if (!obj) {
                /*
                 * An ENOMEM is kind of uncool. If this strikes we continue the
                 * procedure but the call_rcu will not be called. In this case, we
                 * accept the fd leak rather than possibly creating an unsynchronized
                 * state between threads.
                 *
                 * TODO: The notify object should be created once the notify socket is
                 * registered and stored independantely from the ust app object. The
                 * tricky part is to synchronize the teardown of the application and
                 * this notify object. Let's keep that in mind so we can avoid this
                 * kind of shenanigans with ENOMEM in the teardown path.
                 */
                err_enomem = 1;
        } else {
                obj->fd = sock;
        }

        DBG("UST app notify socket unregister %d", sock);

        /*
         * Lookup application by notify socket. If this fails, this means that the
         * hash table delete has already been done by the application
         * unregistration process so we can safely close the notify socket in a
         * call RCU.
         */
        app = find_app_by_notify_sock(sock);
        if (!app) {
                goto close_socket;
        }

        iter.iter.node = &app->notify_sock_n.node;

        /*
         * Whatever happens here either we fail or succeed, in both cases we have
         * to close the socket after a grace period to continue to the call RCU
         * here. If the deletion is successful, the application is not visible
         * anymore by other threads and is it fails it means that it was already
         * deleted from the hash table so either way we just have to close the
         * socket.
         */
        (void) lttng_ht_del(ust_app_ht_by_notify_sock, &iter);

close_socket:
        rcu_read_unlock();

        /*
         * Close socket after a grace period to avoid for the socket to be reused
         * before the application object is freed creating potential race between
         * threads trying to add unique in the global hash table.
         */
        if (!err_enomem) {
                call_rcu(&obj->head, close_notify_sock_rcu);
        }
}

/*
 * Destroy a ust app data structure and free its memory.
 */
void ust_app_destroy(struct ust_app *app)
{
        if (!app) {
                return;
        }

        call_rcu(&app->pid_n.head, delete_ust_app_rcu);
}

/*
 * Take a snapshot for a given UST session. The snapshot is sent to the given
 * output.
 *
 * Return 0 on success or else a negative value.
 */
int ust_app_snapshot_record(struct ltt_ust_session *usess,
                struct snapshot_output *output, int wait,
                uint64_t nb_packets_per_stream)
{
        int ret = 0;
        struct lttng_ht_iter iter;
        struct ust_app *app;
        char pathname[PATH_MAX];

        assert(usess);
        assert(output);

        rcu_read_lock();

        switch (usess->buffer_type) {
        case LTTNG_BUFFER_PER_UID:
        {
                struct buffer_reg_uid *reg;

                cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
                        struct buffer_reg_channel *reg_chan;
                        struct consumer_socket *socket;

                        /* Get consumer socket to use to push the metadata.*/
                        socket = consumer_find_socket_by_bitness(reg->bits_per_long,
                                        usess->consumer);
                        if (!socket) {
                                ret = -EINVAL;
                                goto error;
                        }

                        memset(pathname, 0, sizeof(pathname));
                        ret = snprintf(pathname, sizeof(pathname),
                                        DEFAULT_UST_TRACE_DIR "/" DEFAULT_UST_TRACE_UID_PATH,
                                        reg->uid, reg->bits_per_long);
                        if (ret < 0) {
                                PERROR("snprintf snapshot path");
                                goto error;
                        }

                        /* Add the UST default trace dir to path. */
                        cds_lfht_for_each_entry(reg->registry->channels->ht, &iter.iter,
                                        reg_chan, node.node) {
                                ret = consumer_snapshot_channel(socket, reg_chan->consumer_key,
                                                output, 0, usess->uid, usess->gid, pathname, wait,
                                                nb_packets_per_stream);
                                if (ret < 0) {
                                        goto error;
                                }
                        }
                        ret = consumer_snapshot_channel(socket,
                                        reg->registry->reg.ust->metadata_key, output, 1,
                                        usess->uid, usess->gid, pathname, wait, 0);
                        if (ret < 0) {
                                goto error;
                        }
                }
                break;
        }
        case LTTNG_BUFFER_PER_PID:
        {
                cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                        struct consumer_socket *socket;
                        struct lttng_ht_iter chan_iter;
                        struct ust_app_channel *ua_chan;
                        struct ust_app_session *ua_sess;
                        struct ust_registry_session *registry;

                        ua_sess = lookup_session_by_app(usess, app);
                        if (!ua_sess) {
                                /* Session not associated with this app. */
                                continue;
                        }

                        /* Get the right consumer socket for the application. */
                        socket = consumer_find_socket_by_bitness(app->bits_per_long,
                                        output->consumer);
                        if (!socket) {
                                ret = -EINVAL;
                                goto error;
                        }

                        /* Add the UST default trace dir to path. */
                        memset(pathname, 0, sizeof(pathname));
                        ret = snprintf(pathname, sizeof(pathname), DEFAULT_UST_TRACE_DIR "/%s",
                                        ua_sess->path);
                        if (ret < 0) {
                                PERROR("snprintf snapshot path");
                                goto error;
                        }

                        cds_lfht_for_each_entry(ua_sess->channels->ht, &chan_iter.iter,
                                        ua_chan, node.node) {
                                ret = consumer_snapshot_channel(socket, ua_chan->key, output,
                                                0, ua_sess->euid, ua_sess->egid, pathname, wait,
                                                nb_packets_per_stream);
                                if (ret < 0) {
                                        goto error;
                                }
                        }

                        registry = get_session_registry(ua_sess);
                        if (!registry) {
                                DBG("Application session is being torn down. Abort snapshot record.");
                                ret = -1;
                                goto error;
                        }
                        ret = consumer_snapshot_channel(socket, registry->metadata_key, output,
                                        1, ua_sess->euid, ua_sess->egid, pathname, wait, 0);
                        if (ret < 0) {
                                goto error;
                        }
                }
                break;
        }
        default:
                assert(0);
                break;
        }

error:
        rcu_read_unlock();
        return ret;
}

/*
 * Return the size taken by one more packet per stream.
 */
uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session *usess,
                uint64_t cur_nr_packets)
{
        uint64_t tot_size = 0;
        struct ust_app *app;
        struct lttng_ht_iter iter;

        assert(usess);

        switch (usess->buffer_type) {
        case LTTNG_BUFFER_PER_UID:
        {
                struct buffer_reg_uid *reg;

                cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
                        struct buffer_reg_channel *reg_chan;

                        rcu_read_lock();
                        cds_lfht_for_each_entry(reg->registry->channels->ht, &iter.iter,
                                        reg_chan, node.node) {
                                if (cur_nr_packets >= reg_chan->num_subbuf) {
                                        /*
                                         * Don't take channel into account if we
                                         * already grab all its packets.
                                         */
                                        continue;
                                }
                                tot_size += reg_chan->subbuf_size * reg_chan->stream_count;
                        }
                        rcu_read_unlock();
                }
                break;
        }
        case LTTNG_BUFFER_PER_PID:
        {
                rcu_read_lock();
                cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                        struct ust_app_channel *ua_chan;
                        struct ust_app_session *ua_sess;
                        struct lttng_ht_iter chan_iter;

                        ua_sess = lookup_session_by_app(usess, app);
                        if (!ua_sess) {
                                /* Session not associated with this app. */
                                continue;
                        }

                        cds_lfht_for_each_entry(ua_sess->channels->ht, &chan_iter.iter,
                                        ua_chan, node.node) {
                                if (cur_nr_packets >= ua_chan->attr.num_subbuf) {
                                        /*
                                         * Don't take channel into account if we
                                         * already grab all its packets.
                                         */
                                        continue;
                                }
                                tot_size += ua_chan->attr.subbuf_size * ua_chan->streams.count;
                        }
                }
                rcu_read_unlock();
                break;
        }
        default:
                assert(0);
                break;
        }

        return tot_size;
}

int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
                struct cds_list_head *buffer_reg_uid_list,
                struct consumer_output *consumer, uint64_t uchan_id,
                int overwrite, uint64_t *discarded, uint64_t *lost)
{
        int ret;
        uint64_t consumer_chan_key;

        *discarded = 0;
        *lost = 0;

        ret = buffer_reg_uid_consumer_channel_key(
                        buffer_reg_uid_list, uchan_id, &consumer_chan_key);
        if (ret < 0) {
                /* Not found */
                ret = 0;
                goto end;
        }

        if (overwrite) {
                ret = consumer_get_lost_packets(ust_session_id,
                                consumer_chan_key, consumer, lost);
        } else {
                ret = consumer_get_discarded_events(ust_session_id,
                                consumer_chan_key, consumer, discarded);
        }

end:
        return ret;
}

int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
                struct ltt_ust_channel *uchan,
                struct consumer_output *consumer, int overwrite,
                uint64_t *discarded, uint64_t *lost)
{
        int ret = 0;
        struct lttng_ht_iter iter;
        struct lttng_ht_node_str *ua_chan_node;
        struct ust_app *app;
        struct ust_app_session *ua_sess;
        struct ust_app_channel *ua_chan;

        *discarded = 0;
        *lost = 0;

        rcu_read_lock();
        /*
         * Iterate over every registered applications. Sum counters for
         * all applications containing requested session and channel.
         */
        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                struct lttng_ht_iter uiter;

                ua_sess = lookup_session_by_app(usess, app);
                if (ua_sess == NULL) {
                        continue;
                }

                /* Get channel */
                lttng_ht_lookup(ua_sess->channels, (void *) uchan->name, &uiter);
                ua_chan_node = lttng_ht_iter_get_node_str(&uiter);
                /* If the session is found for the app, the channel must be there */
                assert(ua_chan_node);

                ua_chan = caa_container_of(ua_chan_node, struct ust_app_channel, node);

                if (overwrite) {
                        uint64_t _lost;

                        ret = consumer_get_lost_packets(usess->id, ua_chan->key,
                                        consumer, &_lost);
                        if (ret < 0) {
                                break;
                        }
                        (*lost) += _lost;
                } else {
                        uint64_t _discarded;

                        ret = consumer_get_discarded_events(usess->id,
                                        ua_chan->key, consumer, &_discarded);
                        if (ret < 0) {
                                break;
                        }
                        (*discarded) += _discarded;
                }
        }

        rcu_read_unlock();
        return ret;
}

static
int ust_app_regenerate_statedump(struct ltt_ust_session *usess,
                struct ust_app *app)
{
        int ret = 0;
        struct ust_app_session *ua_sess;

        DBG("Regenerating the metadata for ust app pid %d", app->pid);

        rcu_read_lock();

        ua_sess = lookup_session_by_app(usess, app);
        if (ua_sess == NULL) {
                /* The session is in teardown process. Ignore and continue. */
                goto end;
        }

        pthread_mutex_lock(&ua_sess->lock);

        if (ua_sess->deleted) {
                goto end_unlock;
        }

        pthread_mutex_lock(&app->sock_lock);
        ret = ustctl_regenerate_statedump(app->sock, ua_sess->handle);
        pthread_mutex_unlock(&app->sock_lock);

end_unlock:
        pthread_mutex_unlock(&ua_sess->lock);

end:
        rcu_read_unlock();
        health_code_update();
        return ret;
}

/*
 * Regenerate the statedump for each app in the session.
 */
int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess)
{
        int ret = 0;
        struct lttng_ht_iter iter;
        struct ust_app *app;

        DBG("Regenerating the metadata for all UST apps");

        rcu_read_lock();

        cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                if (!app->compatible) {
                        continue;
                }

                ret = ust_app_regenerate_statedump(usess, app);
                if (ret < 0) {
                        /* Continue to the next app even on error */
                        continue;
                }
        }

        rcu_read_unlock();

        return 0;
}

/*
 * Rotate all the channels of a session.
 *
 * Return 0 on success or else a negative value.
 */
int ust_app_rotate_session(struct ltt_session *session, bool *ust_active)
{
        int ret = 0;
        struct lttng_ht_iter iter;
        struct ust_app *app;
        struct ltt_ust_session *usess = session->ust_session;
        char pathname[LTTNG_PATH_MAX];

        assert(usess);

        rcu_read_lock();

        switch (usess->buffer_type) {
        case LTTNG_BUFFER_PER_UID:
        {
                struct buffer_reg_uid *reg;

                cds_list_for_each_entry(reg, &usess->buffer_reg_uid_list, lnode) {
                        struct buffer_reg_channel *reg_chan;
                        struct consumer_socket *socket;

                        /* Get consumer socket to use to push the metadata.*/
                        socket = consumer_find_socket_by_bitness(reg->bits_per_long,
                                        usess->consumer);
                        if (!socket) {
                                ret = -EINVAL;
                                goto error;
                        }

                        /*
                         * Account the metadata channel first to make sure the
                         * number of channels waiting for a rotation cannot
                         * reach 0 before we complete the iteration over all
                         * the channels.
                         */
                        ret = rotate_add_channel_pending(
                                        reg->registry->reg.ust->metadata_key,
                                        LTTNG_DOMAIN_UST, session);
                        if (ret < 0) {
                                ret = reg->bits_per_long == 32 ?
                                                -LTTNG_ERR_UST_CONSUMER32_FAIL :
                                                -LTTNG_ERR_UST_CONSUMER64_FAIL;
                                goto error;
                        }

                        ret = snprintf(pathname, sizeof(pathname),
                                        DEFAULT_UST_TRACE_DIR "/" DEFAULT_UST_TRACE_UID_PATH,
                                        reg->uid, reg->bits_per_long);
                        if (ret < 0 || ret == sizeof(pathname)) {
                                PERROR("Failed to format rotation path");
                                goto error;
                        }

                        /* Rotate the data channels. */
                        cds_lfht_for_each_entry(reg->registry->channels->ht, &iter.iter,
                                        reg_chan, node.node) {
                                ret = rotate_add_channel_pending(
                                                reg_chan->consumer_key,
                                                LTTNG_DOMAIN_UST, session);
                                if (ret < 0) {
                                        ret = reg->bits_per_long == 32 ?
                                                        -LTTNG_ERR_UST_CONSUMER32_FAIL :
                                                        -LTTNG_ERR_UST_CONSUMER64_FAIL;
                                        goto error;
                                }
                                ret = consumer_rotate_channel(socket,
                                                reg_chan->consumer_key,
                                                usess->uid, usess->gid,
                                                usess->consumer, pathname,
                                                /* is_metadata_channel */ false,
                                                session->current_archive_id,
                                                &session->rotate_pending_relay);
                                if (ret < 0) {
                                        goto error;
                                }
                        }

                        (void) push_metadata(reg->registry->reg.ust, usess->consumer);

                        ret = consumer_rotate_channel(socket,
                                        reg->registry->reg.ust->metadata_key,
                                        usess->uid, usess->gid,
                                        usess->consumer, pathname,
                                        /* is_metadata_channel */ true,
                                        session->current_archive_id,
                                        &session->rotate_pending_relay);
                        if (ret < 0) {
                                goto error;
                        }
                        *ust_active = true;
                }
                break;
        }
        case LTTNG_BUFFER_PER_PID:
        {
                cds_lfht_for_each_entry(ust_app_ht->ht, &iter.iter, app, pid_n.node) {
                        struct consumer_socket *socket;
                        struct lttng_ht_iter chan_iter;
                        struct ust_app_channel *ua_chan;
                        struct ust_app_session *ua_sess;
                        struct ust_registry_session *registry;

                        ua_sess = lookup_session_by_app(usess, app);
                        if (!ua_sess) {
                                /* Session not associated with this app. */
                                continue;
                        }
                        ret = snprintf(pathname, sizeof(pathname),
                                        DEFAULT_UST_TRACE_DIR "/%s",
                                        ua_sess->path);
                        if (ret < 0 || ret == sizeof(pathname)) {
                                PERROR("Failed to format rotation path");
                                goto error;
                        }

                        /* Get the right consumer socket for the application. */
                        socket = consumer_find_socket_by_bitness(app->bits_per_long,
                                        usess->consumer);
                        if (!socket) {
                                ret = -EINVAL;
                                goto error;
                        }

                        registry = get_session_registry(ua_sess);
                        if (!registry) {
                                DBG("Application session is being torn down. Abort snapshot record.");
                                ret = -1;
                                goto error;
                        }

                        /*
                         * Account the metadata channel first to make sure the
                         * number of channels waiting for a rotation cannot
                         * reach 0 before we complete the iteration over all
                         * the channels.
                         */
                        ret = rotate_add_channel_pending(registry->metadata_key,
                                        LTTNG_DOMAIN_UST, session);
                        if (ret < 0) {
                                ret = app->bits_per_long == 32 ?
                                                -LTTNG_ERR_UST_CONSUMER32_FAIL :
                                                -LTTNG_ERR_UST_CONSUMER64_FAIL;
                                goto error;
                        }

                        /* Rotate the data channels. */
                        cds_lfht_for_each_entry(ua_sess->channels->ht, &chan_iter.iter,
                                        ua_chan, node.node) {
                                ret = rotate_add_channel_pending(
                                                ua_chan->key, LTTNG_DOMAIN_UST,
                                                session);
                                if (ret < 0) {
                                        ret = app->bits_per_long == 32 ?
                                                        -LTTNG_ERR_UST_CONSUMER32_FAIL :
                                                        -LTTNG_ERR_UST_CONSUMER64_FAIL;
                                        goto error;
                                }
                                ret = consumer_rotate_channel(socket, ua_chan->key,
                                                ua_sess->euid, ua_sess->egid,
                                                ua_sess->consumer, pathname,
                                                /* is_metadata_channel */ false,
                                                session->current_archive_id,
                                                &session->rotate_pending_relay);
                                if (ret < 0) {
                                        goto error;
                                }
                        }

                        /* Rotate the metadata channel. */
                        (void) push_metadata(registry, usess->consumer);
                        ret = consumer_rotate_channel(socket, registry->metadata_key,
                                        ua_sess->euid, ua_sess->egid,
                                        ua_sess->consumer, pathname,
                                        /* is_metadata_channel */ true,
                                        session->current_archive_id,
                                        &session->rotate_pending_relay);
                        if (ret < 0) {
                                goto error;
                        }
                        *ust_active = true;
                }
                break;
        }
        default:
                assert(0);
                break;
        }

        ret = LTTNG_OK;

error:
        rcu_read_unlock();
        return ret;
}