X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fbin%2Flttng-sessiond%2Fust-consumer.c;h=25dc7ed1c6da96c5fa8cfba14e95d78dab0e9ac1;hp=e804f4b5ac74284c1c3b0b9ea23a9317b505649f;hb=a2814ea7573bf5edd5323d6f89c48ff14105db69;hpb=ca03de585e016f441dfe373420545a6fb047531a diff --git a/src/bin/lttng-sessiond/ust-consumer.c b/src/bin/lttng-sessiond/ust-consumer.c index e804f4b5a..25dc7ed1c 100644 --- a/src/bin/lttng-sessiond/ust-consumer.c +++ b/src/bin/lttng-sessiond/ust-consumer.c @@ -1,368 +1,503 @@ /* - * Copyright (C) 2011 - David Goulet + * Copyright (C) 2011 David Goulet * - * 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. + * SPDX-License-Identifier: GPL-2.0-only * - * 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 _GNU_SOURCE +#define _LGPL_SOURCE #include #include #include #include #include +#include #include -#include +#include #include #include "consumer.h" +#include "health-sessiond.h" #include "ust-consumer.h" +#include "lttng-ust-error.h" +#include "buffer-registry.h" +#include "session.h" +#include "lttng-sessiond.h" /* - * Send a single channel to the consumer using command ADD_CHANNEL. + * Send a single channel to the consumer using command ASK_CHANNEL_CREATION. + * + * Consumer socket lock MUST be acquired before calling this. */ -static int send_channel(struct consumer_socket *sock, - struct ust_app_channel *uchan) +static int ask_channel_creation(struct ust_app_session *ua_sess, + struct ust_app_channel *ua_chan, + struct consumer_output *consumer, + struct consumer_socket *socket, + struct ust_registry_session *registry, + struct lttng_trace_chunk *trace_chunk) { - int ret, fd; + int ret, output; + uint32_t chan_id; + uint64_t key, chan_reg_key; + char *pathname = NULL; struct lttcomm_consumer_msg msg; + struct ust_registry_channel *chan_reg; + char shm_path[PATH_MAX] = ""; + char root_shm_path[PATH_MAX] = ""; + bool is_local_trace; + size_t consumer_path_offset = 0; + + assert(ua_sess); + assert(ua_chan); + assert(socket); + assert(consumer); + assert(registry); - /* Safety net */ - assert(uchan); - assert(sock); + DBG2("Asking UST consumer for channel"); - if (sock->fd < 0) { - ret = -EINVAL; + is_local_trace = consumer->net_seq_index == -1ULL; + /* Format the channel's path (relative to the current trace chunk). */ + pathname = setup_channel_trace_path(consumer, ua_sess->path, + &consumer_path_offset); + if (!pathname) { + ret = -1; goto error; } - DBG2("Sending channel %s to UST consumer", uchan->name); + if (is_local_trace && trace_chunk) { + enum lttng_trace_chunk_status chunk_status; + char *pathname_index; + + ret = asprintf(&pathname_index, "%s/" DEFAULT_INDEX_DIR, + pathname); + if (ret < 0) { + ERR("Failed to format channel index directory"); + ret = -1; + goto error; + } + + /* + * Create the index subdirectory which will take care + * of implicitly creating the channel's path. + */ + chunk_status = lttng_trace_chunk_create_subdirectory( + trace_chunk, pathname_index); + free(pathname_index); + if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) { + ret = -1; + goto error; + } + } + + /* 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; + } - consumer_init_channel_comm_msg(&msg, - LTTNG_CONSUMER_ADD_CHANNEL, - uchan->obj->shm_fd, - uchan->attr.subbuf_size, - uchan->obj->memory_map_size, - uchan->name, - uchan->streams.count); + if (ua_chan->attr.type == LTTNG_UST_CHAN_METADATA) { + chan_id = -1U; + /* + * Metadata channels shm_path (buffers) are handled within + * session daemon. Consumer daemon should not try to create + * those buffer files. + */ + } else { + chan_reg = ust_registry_channel_find(registry, chan_reg_key); + assert(chan_reg); + chan_id = chan_reg->chan_id; + if (ua_sess->shm_path[0]) { + strncpy(shm_path, ua_sess->shm_path, sizeof(shm_path)); + shm_path[sizeof(shm_path) - 1] = '\0'; + strncat(shm_path, "/", + sizeof(shm_path) - strlen(shm_path) - 1); + strncat(shm_path, ua_chan->name, + sizeof(shm_path) - strlen(shm_path) - 1); + strncat(shm_path, "_", + sizeof(shm_path) - strlen(shm_path) - 1); + } + strncpy(root_shm_path, ua_sess->root_shm_path, sizeof(root_shm_path)); + root_shm_path[sizeof(root_shm_path) - 1] = '\0'; + } - health_code_update(&health_thread_cmd); + switch (ua_chan->attr.output) { + case LTTNG_UST_MMAP: + default: + output = LTTNG_EVENT_MMAP; + break; + } - ret = consumer_send_channel(sock, &msg); + consumer_init_ask_channel_comm_msg(&msg, + ua_chan->attr.subbuf_size, + ua_chan->attr.num_subbuf, + ua_chan->attr.overwrite, + ua_chan->attr.switch_timer_interval, + ua_chan->attr.read_timer_interval, + ua_sess->live_timer_interval, + ua_sess->live_timer_interval != 0, + ua_chan->monitor_timer_interval, + output, + (int) ua_chan->attr.type, + ua_sess->tracing_id, + &pathname[consumer_path_offset], + ua_chan->name, + consumer->net_seq_index, + ua_chan->key, + registry->uuid, + chan_id, + ua_chan->tracefile_size, + ua_chan->tracefile_count, + ua_sess->id, + ua_sess->output_traces, + ua_sess->real_credentials.uid, + ua_chan->attr.blocking_timeout, + root_shm_path, shm_path, + trace_chunk, + &ua_sess->effective_credentials); + + health_code_update(); + + ret = consumer_socket_send(socket, &msg, sizeof(msg)); if (ret < 0) { goto error; } - health_code_update(&health_thread_cmd); - - fd = uchan->obj->shm_fd; - ret = consumer_send_fds(sock, &fd, 1); + ret = consumer_recv_status_channel(socket, &key, + &ua_chan->expected_stream_count); if (ret < 0) { goto error; } + /* Communication protocol error. */ + assert(key == ua_chan->key); + /* We need at least one where 1 stream for 1 cpu. */ + if (ua_sess->output_traces) { + assert(ua_chan->expected_stream_count > 0); + } - health_code_update(&health_thread_cmd); + DBG2("UST ask channel %" PRIu64 " successfully done with %u stream(s)", key, + ua_chan->expected_stream_count); error: + free(pathname); + health_code_update(); return ret; } /* - * Send a single stream to the consumer using ADD_STREAM command. + * Ask consumer to create a channel for a given session. + * + * Session list and rcu read side locks must be held by the caller. + * + * Returns 0 on success else a negative value. */ -static int send_channel_stream(struct consumer_socket *sock, - struct ust_app_channel *uchan, struct ust_app_session *usess, - struct ltt_ust_stream *stream, struct consumer_output *consumer, - const char *pathname) +int ust_consumer_ask_channel(struct ust_app_session *ua_sess, + struct ust_app_channel *ua_chan, + struct consumer_output *consumer, + struct consumer_socket *socket, + struct ust_registry_session *registry, + struct lttng_trace_chunk * trace_chunk) { - int ret, fds[2]; - struct lttcomm_consumer_msg msg; + int ret; - /* Safety net */ - assert(uchan); - assert(usess); - assert(stream); + assert(ua_sess); + assert(ua_chan); assert(consumer); - assert(sock); - - DBG2("Sending stream %d of channel %s to kernel consumer", - stream->obj->shm_fd, uchan->name); - - consumer_init_stream_comm_msg(&msg, - LTTNG_CONSUMER_ADD_STREAM, - uchan->obj->shm_fd, - stream->obj->shm_fd, - LTTNG_CONSUMER_ACTIVE_STREAM, - DEFAULT_UST_CHANNEL_OUTPUT, - stream->obj->memory_map_size, - usess->uid, - usess->gid, - consumer->net_seq_index, - 0, /* Metadata flag unset */ - stream->name, - pathname, - usess->id); + assert(socket); + assert(registry); - health_code_update(&health_thread_cmd); + if (!consumer->enabled) { + ret = -LTTNG_ERR_NO_CONSUMER; + DBG3("Consumer is disabled"); + goto error; + } - /* Send stream and file descriptor */ - fds[0] = stream->obj->shm_fd; - fds[1] = stream->obj->wait_fd; - ret = consumer_send_stream(sock, consumer, &msg, fds, 2); + pthread_mutex_lock(socket->lock); + ret = ask_channel_creation(ua_sess, ua_chan, consumer, socket, registry, + trace_chunk); + pthread_mutex_unlock(socket->lock); if (ret < 0) { + ERR("ask_channel_creation consumer command failed"); goto error; } - health_code_update(&health_thread_cmd); - error: return ret; } /* - * Send all stream fds of UST channel to the consumer. + * Send a get channel command to consumer using the given channel key. The + * channel object is populated and the stream list. + * + * Return 0 on success else a negative value. */ -static int send_channel_streams(struct consumer_socket *sock, - struct ust_app_channel *uchan, struct ust_app_session *usess, - struct consumer_output *consumer) +int ust_consumer_get_channel(struct consumer_socket *socket, + struct ust_app_channel *ua_chan) { int ret; - char tmp_path[PATH_MAX]; - const char *pathname; - struct ltt_ust_stream *stream, *tmp; + struct lttcomm_consumer_msg msg; - assert(sock); + assert(ua_chan); + assert(socket); - DBG("Sending streams of channel %s to UST consumer", uchan->name); + memset(&msg, 0, sizeof(msg)); + msg.cmd_type = LTTNG_CONSUMER_GET_CHANNEL; + msg.u.get_channel.key = ua_chan->key; - ret = send_channel(sock, uchan); + pthread_mutex_lock(socket->lock); + health_code_update(); + + /* Send command and wait for OK reply. */ + ret = consumer_send_msg(socket, &msg); if (ret < 0) { goto error; } - /* Get the right path name destination */ - if (consumer->type == CONSUMER_DST_LOCAL) { - /* Set application path to the destination path */ - ret = snprintf(tmp_path, sizeof(tmp_path), "%s/%s/%s", - consumer->dst.trace_path, consumer->subdir, usess->path); - if (ret < 0) { - PERROR("snprintf stream path"); - goto error; - } - pathname = tmp_path; - DBG3("UST local consumer tracefile path: %s", pathname); - } else { - ret = snprintf(tmp_path, sizeof(tmp_path), "%s/%s", - consumer->subdir, usess->path); - if (ret < 0) { - PERROR("snprintf stream path"); - goto error; + /* First, get the channel from consumer. */ + ret = ustctl_recv_channel_from_consumer(*socket->fd_ptr, &ua_chan->obj); + if (ret < 0) { + if (ret != -EPIPE) { + ERR("Error recv channel from consumer %d with ret %d", + *socket->fd_ptr, ret); + } else { + DBG3("UST app recv channel from consumer. Consumer is dead."); } - pathname = tmp_path; - DBG3("UST network consumer subdir path: %s", pathname); + goto error; } - cds_list_for_each_entry_safe(stream, tmp, &uchan->streams.head, list) { - if (!stream->obj->shm_fd) { - continue; + /* Next, get all streams. */ + while (1) { + struct ust_app_stream *stream; + + /* Create UST stream */ + stream = ust_app_alloc_stream(); + if (stream == NULL) { + ret = -ENOMEM; + goto error; } - ret = send_channel_stream(sock, uchan, usess, stream, consumer, - pathname); + /* Stream object is populated by this call if successful. */ + ret = ustctl_recv_stream_from_consumer(*socket->fd_ptr, &stream->obj); if (ret < 0) { + free(stream); + if (ret == -LTTNG_UST_ERR_NOENT) { + DBG3("UST app consumer has no more stream available"); + break; + } + if (ret != -EPIPE) { + ERR("Recv stream from consumer %d with ret %d", + *socket->fd_ptr, ret); + } else { + DBG3("UST app recv stream from consumer. Consumer is dead."); + } goto error; } + + /* Order is important this is why a list is used. */ + cds_list_add_tail(&stream->list, &ua_chan->streams.head); + ua_chan->streams.count++; + + DBG2("UST app stream %d received successfully", ua_chan->streams.count); } - DBG("UST consumer channel streams sent"); + /* This MUST match or else we have a synchronization problem. */ + assert(ua_chan->expected_stream_count == ua_chan->streams.count); - return 0; + /* Wait for confirmation that we can proceed with the streams. */ + ret = consumer_recv_status_reply(socket); + if (ret < 0) { + goto error; + } error: + health_code_update(); + pthread_mutex_unlock(socket->lock); return ret; } /* - * Sending metadata to the consumer with command ADD_CHANNEL and ADD_STREAM. + * Send a destroy channel command to consumer using the given channel key. + * + * Note that this command MUST be used prior to a successful + * LTTNG_CONSUMER_GET_CHANNEL because once this command is done successfully, + * the streams are dispatched to the consumer threads and MUST be teardown + * through the hang up process. + * + * Return 0 on success else a negative value. */ -static int send_metadata(struct consumer_socket *sock, - struct ust_app_session *usess, struct consumer_output *consumer) +int ust_consumer_destroy_channel(struct consumer_socket *socket, + struct ust_app_channel *ua_chan) { - int ret, fd, fds[2]; - char tmp_path[PATH_MAX]; - const char *pathname; + int ret; struct lttcomm_consumer_msg msg; - /* Safety net */ - assert(usess); - assert(consumer); - assert(sock); + assert(ua_chan); + assert(socket); - if (sock->fd < 0) { - ERR("Consumer socket is negative (%d)", sock->fd); - return -EINVAL; - } + memset(&msg, 0, sizeof(msg)); + msg.cmd_type = LTTNG_CONSUMER_DESTROY_CHANNEL; + msg.u.destroy_channel.key = ua_chan->key; - if (usess->metadata->obj->shm_fd == 0) { - ERR("Metadata obj shm_fd is 0"); - ret = -1; + pthread_mutex_lock(socket->lock); + health_code_update(); + + ret = consumer_send_msg(socket, &msg); + if (ret < 0) { goto error; } - DBG("UST consumer sending metadata stream fd"); - - consumer_init_channel_comm_msg(&msg, - LTTNG_CONSUMER_ADD_CHANNEL, - usess->metadata->obj->shm_fd, - usess->metadata->attr.subbuf_size, - usess->metadata->obj->memory_map_size, - "metadata", - 1); +error: + health_code_update(); + pthread_mutex_unlock(socket->lock); + return ret; +} - health_code_update(&health_thread_cmd); +/* + * Send a given stream to UST tracer. + * + * On success return 0 else a negative value. + */ +int ust_consumer_send_stream_to_ust(struct ust_app *app, + struct ust_app_channel *channel, struct ust_app_stream *stream) +{ + int ret; - ret = consumer_send_channel(sock, &msg); - if (ret < 0) { - goto error; - } + assert(app); + assert(stream); + assert(channel); - health_code_update(&health_thread_cmd); + DBG2("UST consumer send stream to app %d", app->sock); - /* Sending metadata shared memory fd */ - fd = usess->metadata->obj->shm_fd; - ret = consumer_send_fds(sock, &fd, 1); + /* Relay stream to application. */ + pthread_mutex_lock(&app->sock_lock); + ret = ustctl_send_stream_to_ust(app->sock, channel->obj, stream->obj); + pthread_mutex_unlock(&app->sock_lock); if (ret < 0) { + if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) { + ERR("ustctl send stream handle %d to app pid: %d with ret %d", + stream->obj->handle, app->pid, ret); + } else { + DBG3("UST app send stream to ust failed. Application is dead."); + } goto error; } + channel->handle = channel->obj->handle; - health_code_update(&health_thread_cmd); - - /* Get correct path name destination */ - if (consumer->type == CONSUMER_DST_LOCAL) { - /* Set application path to the destination path */ - ret = snprintf(tmp_path, sizeof(tmp_path), "%s/%s/%s", - consumer->dst.trace_path, consumer->subdir, usess->path); - if (ret < 0) { - PERROR("snprintf stream path"); - goto error; - } - pathname = tmp_path; +error: + return ret; +} - /* Create directory */ - ret = run_as_mkdir_recursive(pathname, S_IRWXU | S_IRWXG, - usess->uid, usess->gid); - if (ret < 0) { - if (ret != -EEXIST) { - ERR("Trace directory creation error"); - goto error; - } - } - } else { - ret = snprintf(tmp_path, sizeof(tmp_path), "%s/%s", - consumer->subdir, usess->path); - if (ret < 0) { - PERROR("snprintf metadata path"); - goto error; - } - pathname = tmp_path; - } +/* + * Send channel previously received from the consumer to the UST tracer. + * + * On success return 0 else a negative value. + */ +int ust_consumer_send_channel_to_ust(struct ust_app *app, + struct ust_app_session *ua_sess, struct ust_app_channel *channel) +{ + int ret; - consumer_init_stream_comm_msg(&msg, - LTTNG_CONSUMER_ADD_STREAM, - usess->metadata->obj->shm_fd, - usess->metadata->stream_obj->shm_fd, - LTTNG_CONSUMER_ACTIVE_STREAM, - DEFAULT_UST_CHANNEL_OUTPUT, - usess->metadata->stream_obj->memory_map_size, - usess->uid, - usess->gid, - consumer->net_seq_index, - 1, /* Flag metadata set */ - "metadata", - pathname, - usess->id); + assert(app); + assert(ua_sess); + assert(channel); + assert(channel->obj); - health_code_update(&health_thread_cmd); + DBG2("UST app send channel to sock %d pid %d (name: %s, key: %" PRIu64 ")", + app->sock, app->pid, channel->name, channel->tracing_channel_id); - /* Send stream and file descriptor */ - fds[0] = usess->metadata->stream_obj->shm_fd; - fds[1] = usess->metadata->stream_obj->wait_fd; - ret = consumer_send_stream(sock, consumer, &msg, fds, 2); + /* Send stream to application. */ + pthread_mutex_lock(&app->sock_lock); + ret = ustctl_send_channel_to_ust(app->sock, ua_sess->handle, channel->obj); + pthread_mutex_unlock(&app->sock_lock); if (ret < 0) { + if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) { + ERR("Error ustctl send channel %s to app pid: %d with ret %d", + channel->name, app->pid, ret); + } else { + DBG3("UST app send channel to ust failed. Application is dead."); + } goto error; } - health_code_update(&health_thread_cmd); - error: return ret; } /* - * Send all stream fds of the UST session to the consumer. + * Handle the metadata requests from the UST consumer + * + * Return 0 on success else a negative value. */ -int ust_consumer_send_session(struct ust_app_session *usess, - struct consumer_output *consumer, struct consumer_socket *sock) +int ust_consumer_metadata_request(struct consumer_socket *socket) { - int ret = 0; - struct lttng_ht_iter iter; - struct ust_app_channel *ua_chan; - - assert(usess); - - if (consumer == NULL || sock == NULL) { - /* There is no consumer so just ignoring the command. */ - DBG("UST consumer does not exist. Not sending streams"); - return 0; - } + int ret; + ssize_t ret_push; + struct lttcomm_metadata_request_msg request; + struct buffer_reg_uid *reg_uid; + struct ust_registry_session *ust_reg; + struct lttcomm_consumer_msg msg; - DBG("Sending metadata stream fd to consumer on %d", sock->fd); + assert(socket); - pthread_mutex_lock(sock->lock); + rcu_read_lock(); + health_code_update(); - /* Sending metadata information to the consumer */ - ret = send_metadata(sock, usess, consumer); + /* Wait for a metadata request */ + pthread_mutex_lock(socket->lock); + ret = consumer_socket_recv(socket, &request, sizeof(request)); + pthread_mutex_unlock(socket->lock); if (ret < 0) { - goto error; + goto end; } - /* Send each channel fd streams of session */ - rcu_read_lock(); - cds_lfht_for_each_entry(usess->channels->ht, &iter.iter, ua_chan, - node.node) { - /* - * Indicate that the channel was not created on the tracer side so skip - * sending unexisting streams. - */ - if (ua_chan->obj == NULL) { - continue; - } + DBG("Metadata request received for session %" PRIu64 ", key %" PRIu64, + request.session_id, request.key); - ret = send_channel_streams(sock, ua_chan, usess, consumer); - if (ret < 0) { - rcu_read_unlock(); - goto error; + reg_uid = buffer_reg_uid_find(request.session_id, + request.bits_per_long, request.uid); + if (reg_uid) { + ust_reg = reg_uid->registry->reg.ust; + } else { + struct buffer_reg_pid *reg_pid = + buffer_reg_pid_find(request.session_id_per_pid); + if (!reg_pid) { + DBG("PID registry not found for session id %" PRIu64, + request.session_id_per_pid); + + memset(&msg, 0, sizeof(msg)); + msg.cmd_type = LTTNG_ERR_UND; + pthread_mutex_lock(socket->lock); + (void) consumer_send_msg(socket, &msg); + pthread_mutex_unlock(socket->lock); + /* + * This is possible since the session might have been destroyed + * during a consumer metadata request. So here, return gracefully + * because the destroy session will push the remaining metadata to + * the consumer. + */ + ret = 0; + goto end; } + ust_reg = reg_pid->registry->reg.ust; + } + assert(ust_reg); + + pthread_mutex_lock(&ust_reg->lock); + ret_push = ust_app_push_metadata(ust_reg, socket, 1); + pthread_mutex_unlock(&ust_reg->lock); + if (ret_push == -EPIPE) { + DBG("Application or relay closed while pushing metadata"); + } else if (ret_push < 0) { + ERR("Pushing metadata"); + ret = -1; + goto end; + } else { + DBG("UST Consumer metadata pushed successfully"); } - rcu_read_unlock(); - - DBG("consumer fds (metadata and channel streams) sent"); - - /* All good! */ ret = 0; -error: - pthread_mutex_unlock(sock->lock); +end: + rcu_read_unlock(); return ret; }