Move LTTng-UST buffer ownership from application to consumer
[lttng-tools.git] / src / bin / lttng-sessiond / ust-consumer.c
index f108e99bd0b1379bd751432bee5276394d97b054..7c1ae402c8ded33c75532d76530ba5ddf195001d 100644 (file)
 #include "ust-consumer.h"
 
 /*
- * Send a single channel to the consumer using command ADD_CHANNEL.
+ * Return allocated full pathname of the session using the consumer trace path
+ * and subdir if available. On a successful allocation, the directory of the
+ * trace is created with the session credentials.
+ *
+ * The caller can safely free(3) the returned value. On error, NULL is
+ * returned.
  */
-static int send_channel(struct consumer_socket *sock,
-               struct ust_app_channel *uchan)
+static char *setup_trace_path(struct consumer_output *consumer,
+               struct ust_app_session *ua_sess)
 {
-       int ret, fd;
-       struct lttcomm_consumer_msg msg;
-
-       /* Safety net */
-       assert(uchan);
-       assert(sock);
-
-       if (sock->fd < 0) {
-               ret = -EINVAL;
-               goto error;
-       }
-
-       DBG2("Sending channel %s to UST consumer", uchan->name);
+       int ret;
+       char *pathname;
 
-       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);
+       assert(consumer);
+       assert(ua_sess);
 
        health_code_update();
 
-       ret = consumer_send_channel(sock, &msg);
-       if (ret < 0) {
+       /* Allocate our self the string to make sure we never exceed PATH_MAX. */
+       pathname = zmalloc(PATH_MAX);
+       if (!pathname) {
                goto error;
        }
 
-       health_code_update();
+       /* Get correct path name destination */
+       if (consumer->type == CONSUMER_DST_LOCAL) {
+               /* Set application path to the destination path */
+               ret = snprintf(pathname, PATH_MAX, "%s/%s/%s",
+                               consumer->dst.trace_path, consumer->subdir, ua_sess->path);
+               if (ret < 0) {
+                       PERROR("snprintf channel path");
+                       goto error;
+               }
 
-       fd = uchan->obj->shm_fd;
-       ret = consumer_send_fds(sock, &fd, 1);
-       if (ret < 0) {
-               goto error;
+               /* Create directory. Ignore if exist. */
+               ret = run_as_mkdir_recursive(pathname, S_IRWXU | S_IRWXG, ua_sess->uid,
+                               ua_sess->gid);
+               if (ret < 0) {
+                       if (ret != -EEXIST) {
+                               ERR("Trace directory creation error");
+                               goto error;
+                       }
+               }
+       } else {
+               ret = snprintf(pathname, PATH_MAX, "%s/%s", consumer->subdir,
+                               ua_sess->path);
+               if (ret < 0) {
+                       PERROR("snprintf channel path");
+                       goto error;
+               }
        }
 
-       health_code_update();
+       return pathname;
 
 error:
-       return ret;
+       free(pathname);
+       return NULL;
 }
 
 /*
- * Send a single stream to the consumer using ADD_STREAM command.
+ * Send a single channel to the consumer using command ADD_CHANNEL.
+ *
+ * Consumer socket MUST be acquired before calling this.
  */
-static int send_channel_stream(struct consumer_socket *sock,
-               struct ust_app_channel *uchan, struct ust_app_session *usess,
-               struct ust_app_stream *stream, struct consumer_output *consumer,
-               const char *pathname)
+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)
 {
-       int ret, fds[2];
+       int ret;
+       unsigned long key;
+       char *pathname = NULL;
        struct lttcomm_consumer_msg msg;
 
-       /* Safety net */
-       assert(uchan);
-       assert(usess);
-       assert(stream);
+       assert(ua_sess);
+       assert(ua_chan);
+       assert(socket);
        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,
+
+       DBG2("Asking UST consumer for channel");
+
+       /* Get and create full trace path of session. */
+       pathname = setup_trace_path(consumer, ua_sess);
+       if (!pathname) {
+               ret = -1;
+               goto error;
+       }
+
+       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,
+                       (int) ua_chan->attr.output,
+                       (int) ua_chan->attr.type,
+                       ua_sess->id,
                        pathname,
-                       usess->id);
+                       ua_chan->name,
+                       ua_sess->uid,
+                       ua_sess->gid,
+                       consumer->net_seq_index,
+                       ua_chan->key,
+                       ua_sess->uuid);
 
        health_code_update();
 
-       /* 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);
+       ret = lttcomm_send_unix_sock(socket->fd, &msg, sizeof(msg));
        if (ret < 0) {
                goto error;
        }
 
-       health_code_update();
+       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. */
+       assert(ua_chan->expected_stream_count > 0);
+
+       DBG2("UST ask channel %lu successfully done with %u stream(s)", key,
+                       ua_chan->expected_stream_count);
 
 error:
+       free(pathname);
+       health_code_update();
        return ret;
 }
 
 /*
- * Send all stream fds of UST channel to the consumer.
+ * Ask consumer to create a channel for a given session.
+ *
+ * Returns 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_ask_channel(struct ust_app_session *ua_sess,
+               struct ust_app_channel *ua_chan, struct consumer_output *consumer,
+               struct consumer_socket *socket)
 {
        int ret;
-       char tmp_path[PATH_MAX];
-       const char *pathname;
-       struct ust_app_stream *stream, *tmp;
 
-       assert(sock);
+       assert(ua_sess);
+       assert(ua_chan);
+       assert(consumer);
+       assert(socket);
+       assert(socket->fd >= 0);
 
-       DBG("Sending streams of channel %s to UST consumer", uchan->name);
+       pthread_mutex_lock(socket->lock);
 
-       ret = send_channel(sock, uchan);
+       ret = ask_channel_creation(ua_sess, ua_chan, consumer, socket);
        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;
-               }
-               pathname = tmp_path;
-               DBG3("UST network consumer subdir path: %s", pathname);
-       }
-
-       cds_list_for_each_entry_safe(stream, tmp, &uchan->streams.head, list) {
-               if (!stream->obj->shm_fd) {
-                       continue;
-               }
-
-               ret = send_channel_stream(sock, uchan, usess, stream, consumer,
-                               pathname);
-               if (ret < 0) {
-                       goto error;
-               }
-       }
-
-       DBG("UST consumer channel streams sent");
-
-       return 0;
-
 error:
+       pthread_mutex_unlock(socket->lock);
        return ret;
 }
 
 /*
- * Sending metadata to the consumer with command ADD_CHANNEL and ADD_STREAM.
+ * 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_metadata(struct consumer_socket *sock,
-               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, 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);
-
-       if (sock->fd < 0) {
-               ERR("Consumer socket is negative (%d)", sock->fd);
-               return -EINVAL;
-       }
-
-       if (usess->metadata->obj->shm_fd == 0) {
-               ERR("Metadata obj shm_fd is 0");
-               ret = -1;
-               goto error;
-       }
+       assert(ua_chan);
+       assert(socket);
+       assert(socket->fd >= 0);
 
-       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,
-                       DEFAULT_METADATA_NAME,
-                       1);
+       msg.cmd_type = LTTNG_CONSUMER_GET_CHANNEL;
+       msg.u.get_channel.key = ua_chan->key;
 
+       pthread_mutex_lock(socket->lock);
        health_code_update();
 
-       ret = consumer_send_channel(sock, &msg);
+       /* Send command and wait for OK reply. */
+       ret = consumer_send_msg(socket, &msg);
        if (ret < 0) {
                goto error;
        }
 
-       health_code_update();
-
-       /* Sending metadata shared memory fd */
-       fd = usess->metadata->obj->shm_fd;
-       ret = consumer_send_fds(sock, &fd, 1);
+       /* First, get the channel from consumer. */
+       ret = ustctl_recv_channel_from_consumer(socket->fd, &ua_chan->obj);
        if (ret < 0) {
+               if (ret != -EPIPE) {
+                       ERR("Error recv channel from consumer %d with ret %d",
+                                       socket->fd, ret);
+               } else {
+                       DBG3("UST app recv channel from consumer. Consumer is dead.");
+               }
                goto error;
        }
+       ua_chan->handle = ua_chan->obj->handle;
 
-       health_code_update();
+       /* Next, get all streams. */
+       while (1) {
+               struct ust_app_stream *stream;
 
-       /* 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");
+               /* Create UST stream */
+               stream = ust_app_alloc_stream();
+               if (stream == NULL) {
+                       ret = -ENOMEM;
                        goto error;
                }
-               pathname = tmp_path;
 
-               /* Create directory */
-               ret = run_as_mkdir_recursive(pathname, S_IRWXU | S_IRWXG,
-                               usess->uid, usess->gid);
+               /* Stream object is populated by this call if successful. */
+               ret = ustctl_recv_stream_from_consumer(socket->fd, &stream->obj);
                if (ret < 0) {
-                       if (ret != -EEXIST) {
-                               ERR("Trace directory creation error");
-                               goto error;
+                       free(stream);
+                       if (ret == -LTTNG_UST_ERR_NOENT) {
+                               DBG3("UST app consumer has no more stream available");
+                               ret = 0;
+                               break;
+                       }
+                       if (ret != -EPIPE) {
+                               ERR("Recv stream from consumer %d with ret %d",
+                                               socket->fd, ret);
+                       } else {
+                               DBG3("UST app recv stream from consumer. Consumer is dead.");
                        }
-               }
-       } 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;
-       }
 
-       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 */
-                       DEFAULT_METADATA_NAME,
-                       pathname,
-                       usess->id);
+               /* Order is important this is why a list is used. */
+               cds_list_add_tail(&stream->list, &ua_chan->streams.head);
+               ua_chan->streams.count++;
 
-       health_code_update();
+               DBG2("UST app stream %d received succesfully", ua_chan->streams.count);
+       }
+
+       /* This MUST match or else we have a synchronization problem. */
+       assert(ua_chan->expected_stream_count == ua_chan->streams.count);
 
-       /* 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);
+       /* Wait for confirmation that we can proceed with the streams. */
+       ret = consumer_recv_status_reply(socket);
        if (ret < 0) {
                goto error;
        }
 
-       health_code_update();
-
 error:
+       health_code_update();
+       pthread_mutex_unlock(socket->lock);
        return ret;
 }
 
 /*
- * Send all stream fds of the UST session to the consumer.
+ * 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.
  */
-int ust_consumer_send_session(struct ust_app_session *usess,
-               struct consumer_output *consumer, struct consumer_socket *sock)
+int ust_consumer_destroy_channel(struct consumer_socket *socket,
+               struct ust_app_channel *ua_chan)
 {
-       int ret = 0;
-       struct lttng_ht_iter iter;
-       struct ust_app_channel *ua_chan;
-
-       assert(usess);
+       int ret;
+       struct lttcomm_consumer_msg msg;
 
-       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;
-       }
+       assert(ua_chan);
+       assert(socket);
+       assert(socket->fd >= 0);
 
-       DBG("Sending metadata stream fd to consumer on %d", sock->fd);
+       msg.cmd_type = LTTNG_CONSUMER_DESTROY_CHANNEL;
+       msg.u.destroy_channel.key = ua_chan->key;
 
-       pthread_mutex_lock(sock->lock);
+       pthread_mutex_lock(socket->lock);
+       health_code_update();
 
-       /* Sending metadata information to the consumer */
-       ret = send_metadata(sock, usess, consumer);
+       ret = consumer_send_msg(socket, &msg);
        if (ret < 0) {
                goto error;
        }
 
-       /* 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;
-               }
+error:
+       health_code_update();
+       pthread_mutex_unlock(socket->lock);
+       return ret;
+}
 
-               ret = send_channel_streams(sock, ua_chan, usess, consumer);
-               if (ret < 0) {
-                       rcu_read_unlock();
-                       goto error;
+/*
+ * 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;
+
+       assert(app);
+       assert(stream);
+       assert(channel);
+
+       DBG2("UST consumer send stream to app %d", app->sock);
+
+       /* Relay stream to application. */
+       ret = ustctl_send_stream_to_ust(app->sock, channel->obj, stream->obj);
+       if (ret < 0) {
+               if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) {
+                       ERR("Error ustctl send stream %s to app pid: %d with ret %d",
+                                       stream->name, app->pid, ret);
+               } else {
+                       DBG3("UST app send stream to ust failed. Application is dead.");
                }
+               goto error;
        }
-       rcu_read_unlock();
 
-       DBG("consumer fds (metadata and channel streams) sent");
+error:
+       return ret;
+}
+
+/*
+ * 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;
+
+       assert(app);
+       assert(ua_sess);
+       assert(channel);
+       assert(channel->obj);
+
+       DBG2("UST app send channel to app sock %d pid %d (name: %s, key: %lu)",
+                       app->sock, app->pid, channel->name, channel->key);
 
-       /* All good! */
-       ret = 0;
+       /* Send stream to application. */
+       ret = ustctl_send_channel_to_ust(app->sock, ua_sess->handle, channel->obj);
+       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;
+       }
 
 error:
-       pthread_mutex_unlock(sock->lock);
        return ret;
 }
This page took 0.030013 seconds and 5 git commands to generate.