* Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; only version 2
- * of the License.
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 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
#include <string.h>
#include <lttng/ust-ctl.h>
#include <lttng/ust-abi.h>
-#include <lttng/usterr-signal-safe.h>
-#include <lttng/ust-comm.h>
#include <lttng/ust-events.h>
+#include <sys/mman.h>
+
+#include <usterr-signal-safe.h>
+#include <ust-comm.h>
#include "../libringbuffer/backend.h"
#include "../libringbuffer/frontend.h"
data->memory_map_size = 0;
}
-void ustctl_release_object(int sock, struct lttng_ust_object_data *data)
+int ustctl_release_handle(int sock, int handle)
{
struct ustcomm_ust_msg lum;
struct ustcomm_ust_reply lur;
int ret;
- if (data->shm_fd >= 0)
- close(data->shm_fd);
- if (data->wait_fd >= 0)
- close(data->wait_fd);
- memset(&lum, 0, sizeof(lum));
- lum.handle = data->handle;
- lum.cmd = LTTNG_UST_RELEASE;
- ret = ustcomm_send_app_cmd(sock, &lum, &lur);
- assert(!ret);
- free(data);
+ if (sock >= 0) {
+ memset(&lum, 0, sizeof(lum));
+ lum.handle = handle;
+ lum.cmd = LTTNG_UST_RELEASE;
+ ret = ustcomm_send_app_cmd(sock, &lum, &lur);
+ if (ret < 0) {
+ return ret;
+ }
+ }
+ return 0;
+}
+/*
+ * If sock is negative, it means we don't have to notify the other side
+ * (e.g. application has already vanished).
+ */
+int ustctl_release_object(int sock, struct lttng_ust_object_data *data)
+{
+ int ret;
+
+ if (!data)
+ return -EINVAL;
+
+ if (data->shm_fd >= 0) {
+ ret = close(data->shm_fd);
+ if (ret < 0) {
+ return ret;
+ }
+ }
+ if (data->wait_fd >= 0) {
+ ret = close(data->wait_fd);
+ if (ret < 0) {
+ return ret;
+ }
+ }
+ return ustctl_release_handle(sock, data->handle);
}
/*
struct ustcomm_ust_msg lum;
struct ustcomm_ust_reply lur;
struct lttng_ust_object_data *metadata_data;
- int ret;
+ int ret, err = 0;
+
+ if (!chops || !_metadata_data)
+ return -EINVAL;
metadata_data = malloc(sizeof(*metadata_data));
if (!metadata_data)
/* get shm fd */
ret = ustcomm_recv_fd(sock);
if (ret < 0)
- goto error;
- metadata_data->shm_fd = ret;
+ err = 1;
+ else
+ metadata_data->shm_fd = ret;
+ /*
+ * We need to get the second FD even if the first fails, because
+ * libust expects us to read the two FDs.
+ */
/* get wait fd */
ret = ustcomm_recv_fd(sock);
if (ret < 0)
+ err = 1;
+ else
+ metadata_data->wait_fd = ret;
+ if (err)
goto error;
- metadata_data->wait_fd = ret;
*_metadata_data = metadata_data;
return 0;
error:
- ustctl_release_object(sock, metadata_data);
+ (void) ustctl_release_object(sock, metadata_data);
+ free(metadata_data);
return -EINVAL;
}
struct ustcomm_ust_msg lum;
struct ustcomm_ust_reply lur;
struct lttng_ust_object_data *channel_data;
- int ret;
+ int ret, err = 0;
+
+ if (!chops || !_channel_data)
+ return -EINVAL;
channel_data = malloc(sizeof(*channel_data));
if (!channel_data)
/* get shm fd */
ret = ustcomm_recv_fd(sock);
if (ret < 0)
- goto error;
- channel_data->shm_fd = ret;
+ err = 1;
+ else
+ channel_data->shm_fd = ret;
+ /*
+ * We need to get the second FD even if the first fails, because
+ * libust expects us to read the two FDs.
+ */
/* get wait fd */
ret = ustcomm_recv_fd(sock);
if (ret < 0)
+ err = 1;
+ else
+ channel_data->wait_fd = ret;
+ if (err)
goto error;
- channel_data->wait_fd = ret;
*_channel_data = channel_data;
return 0;
error:
- ustctl_release_object(sock, channel_data);
+ (void) ustctl_release_object(sock, channel_data);
+ free(channel_data);
return -EINVAL;
}
struct ustcomm_ust_msg lum;
struct ustcomm_ust_reply lur;
struct lttng_ust_object_data *stream_data;
- int ret, fd;
+ int ret, fd, err = 0;
+
+ if (!channel_data || !_stream_data)
+ return -EINVAL;
stream_data = malloc(sizeof(*stream_data));
if (!stream_data)
/* get shm fd */
fd = ustcomm_recv_fd(sock);
if (fd < 0)
- goto error;
- stream_data->shm_fd = fd;
+ err = 1;
+ else
+ stream_data->shm_fd = fd;
+ /*
+ * We need to get the second FD even if the first fails, because
+ * libust expects us to read the two FDs.
+ */
/* get wait fd */
fd = ustcomm_recv_fd(sock);
if (fd < 0)
+ err = 1;
+ else
+ stream_data->wait_fd = fd;
+ if (err)
goto error;
- stream_data->wait_fd = fd;
*_stream_data = stream_data;
return ret;
error:
- ustctl_release_object(sock, stream_data);
+ (void) ustctl_release_object(sock, stream_data);
+ free(stream_data);
return -EINVAL;
}
struct lttng_ust_object_data *event_data;
int ret;
+ if (!channel_data || !_event_data)
+ return -EINVAL;
+
event_data = malloc(sizeof(*event_data));
if (!event_data)
return -ENOMEM;
strncpy(lum.u.event.name, ev->name,
LTTNG_UST_SYM_NAME_LEN);
lum.u.event.instrumentation = ev->instrumentation;
+ lum.u.event.loglevel_type = ev->loglevel_type;
+ lum.u.event.loglevel = ev->loglevel;
ret = ustcomm_send_app_cmd(sock, &lum, &lur);
if (ret) {
free(event_data);
struct lttng_ust_object_data *context_data;
int ret;
+ if (!obj_data || !_context_data)
+ return -EINVAL;
+
context_data = malloc(sizeof(*context_data));
if (!context_data)
return -ENOMEM;
struct ustcomm_ust_reply lur;
int ret;
+ if (!object)
+ return -EINVAL;
+
memset(&lum, 0, sizeof(lum));
lum.handle = object->handle;
lum.cmd = LTTNG_UST_ENABLE;
struct ustcomm_ust_reply lur;
int ret;
+ if (!object)
+ return -EINVAL;
+
memset(&lum, 0, sizeof(lum));
lum.handle = object->handle;
lum.cmd = LTTNG_UST_DISABLE;
return ustctl_disable(sock, &obj);
}
-
int ustctl_tracepoint_list(int sock)
{
- return -ENOSYS; /* not implemented */
+ struct ustcomm_ust_msg lum;
+ struct ustcomm_ust_reply lur;
+ int ret, tp_list_handle;
+
+ memset(&lum, 0, sizeof(lum));
+ lum.handle = LTTNG_UST_ROOT_HANDLE;
+ lum.cmd = LTTNG_UST_TRACEPOINT_LIST;
+ ret = ustcomm_send_app_cmd(sock, &lum, &lur);
+ if (ret)
+ return ret;
+ tp_list_handle = lur.ret_val;
+ DBG("received tracepoint list handle %u", tp_list_handle);
+ return tp_list_handle;
+}
+
+int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
+ struct lttng_ust_tracepoint_iter *iter)
+{
+ struct ustcomm_ust_msg lum;
+ struct ustcomm_ust_reply lur;
+ int ret;
+
+ if (!iter)
+ return -EINVAL;
+
+ memset(&lum, 0, sizeof(lum));
+ lum.handle = tp_list_handle;
+ lum.cmd = LTTNG_UST_TRACEPOINT_LIST_GET;
+ ret = ustcomm_send_app_cmd(sock, &lum, &lur);
+ if (ret)
+ return ret;
+ DBG("received tracepoint list entry name %s loglevel %d",
+ lur.u.tracepoint.name,
+ lur.u.tracepoint.loglevel);
+ memcpy(iter, &lur.u.tracepoint, sizeof(*iter));
+ return 0;
}
int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v)
struct ustcomm_ust_reply lur;
int ret;
+ if (!v)
+ return -EINVAL;
+
memset(&lum, 0, sizeof(lum));
lum.handle = LTTNG_UST_ROOT_HANDLE;
lum.cmd = LTTNG_UST_TRACER_VERSION;
int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate)
{
+ if (!calibrate)
+ return -EINVAL;
+
return -ENOSYS;
}
+int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object)
+{
+ struct ustcomm_ust_msg lum;
+ struct ustcomm_ust_reply lur;
+ int ret;
+
+ if (!object)
+ return -EINVAL;
+
+ memset(&lum, 0, sizeof(lum));
+ lum.handle = object->handle;
+ lum.cmd = LTTNG_UST_FLUSH_BUFFER;
+ ret = ustcomm_send_app_cmd(sock, &lum, &lur);
+ if (ret)
+ return ret;
+ DBG("flushed buffer handle %u", object->handle);
+ return 0;
+}
+
/* Buffer operations */
/* Map channel shm into process memory */
struct channel *chan;
size_t chan_size;
struct lttng_ust_lib_ring_buffer_config *config;
+ int ret;
+
+ if (!chan_data)
+ return NULL;
handle = channel_handle_create(chan_data->shm_fd,
chan_data->wait_fd,
return NULL;
}
/*
- * Set to -1 because the lttng_ust_shm_handle destruction will take care
- * of closing shm_fd and wait_fd.
+ * Set to -1, and then close the shm fd, and set the handle shm
+ * fd to -1 too. We don't need the shm fds after they have been
+ * mapped.
+ * The wait_fd is set to -1 in chan_data because it is now owned
+ * by the handle.
*/
chan_data->shm_fd = -1;
chan_data->wait_fd = -1;
+ /* chan is object 0. This is hardcoded. */
+ if (handle->table->objects[0].shm_fd >= 0) {
+ ret = close(handle->table->objects[0].shm_fd);
+ if (ret) {
+ perror("Error closing shm_fd");
+ }
+ handle->table->objects[0].shm_fd = -1;
+ }
+
/*
* TODO: add consistency checks to be resilient if the
* application try to feed us with incoherent channel structure
channel_destroy(chan, handle, 1);
return NULL;
}
+ /* Replace the object table pointer. */
+ ret = munmap(handle->table->objects[0].memory_map,
+ handle->table->objects[0].memory_map_size);
+ if (ret) {
+ perror("munmap");
+ assert(0);
+ }
+ handle->table->objects[0].memory_map = (char *) handle->shadow_chan;
+ handle->table->objects[0].is_shadow = 1;
return handle;
}
{
int ret;
+ if (!handle || !stream_data)
+ return -EINVAL;
+
if (!stream_data->handle)
return -ENOENT;
/* map stream */
{
struct channel *chan;
+ assert(handle);
chan = shmp(handle, handle->chan);
channel_destroy(chan, handle, 1);
}
+/*
+ * ustctl closes the shm_fd fds after mapping it.
+ */
struct lttng_ust_lib_ring_buffer *ustctl_open_stream_read(struct lttng_ust_shm_handle *handle,
int cpu)
{
- struct channel *chan = handle->shadow_chan;
- int shm_fd, wait_fd;
- uint64_t memory_map_size;
+ struct channel *chan;
+ int *shm_fd, *wait_fd;
+ uint64_t *memory_map_size;
struct lttng_ust_lib_ring_buffer *buf;
int ret;
+ if (!handle)
+ return NULL;
+
+ chan = handle->shadow_chan;
buf = channel_get_ring_buffer(&chan->backend.config,
chan, cpu, handle, &shm_fd, &wait_fd, &memory_map_size);
if (!buf)
ret = lib_ring_buffer_open_read(buf, handle, 1);
if (ret)
return NULL;
+ /*
+ * We can close shm_fd early, right after is has been mapped.
+ */
+ if (*shm_fd >= 0) {
+ ret = close(*shm_fd);
+ if (ret) {
+ perror("Error closing shm_fd");
+ }
+ *shm_fd = -1;
+ }
return buf;
}
void ustctl_close_stream_read(struct lttng_ust_shm_handle *handle,
struct lttng_ust_lib_ring_buffer *buf)
{
+ assert(handle && buf);
lib_ring_buffer_release_read(buf, handle, 1);
}
void *ustctl_get_mmap_base(struct lttng_ust_shm_handle *handle,
struct lttng_ust_lib_ring_buffer *buf)
{
+ if (!handle || !buf)
+ return NULL;
return shmp(handle, buf->backend.memory_map);
}
unsigned long *len)
{
unsigned long mmap_buf_len;
- struct channel *chan = handle->shadow_chan;
+ struct channel *chan;
+ if (!handle || !buf || !len)
+ return -EINVAL;
+
+ chan = handle->shadow_chan;
if (chan->backend.config.output != RING_BUFFER_MMAP)
return -EINVAL;
mmap_buf_len = chan->backend.buf_size;
struct lttng_ust_lib_ring_buffer *buf,
unsigned long *len)
{
- struct channel *chan = handle->shadow_chan;
+ struct channel *chan;
+ if (!handle || !buf || !len)
+ return -EINVAL;
+
+ chan = handle->shadow_chan;
*len = chan->backend.subbuf_size;
return 0;
}
int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle,
struct lttng_ust_lib_ring_buffer *buf, unsigned long *off)
{
- struct channel *chan = handle->shadow_chan;
+ struct channel *chan;
unsigned long sb_bindex;
+ if (!handle || !buf || !off)
+ return -EINVAL;
+
+ chan = handle->shadow_chan;
if (chan->backend.config.output != RING_BUFFER_MMAP)
return -EINVAL;
sb_bindex = subbuffer_id_get_index(&chan->backend.config,
int ustctl_get_subbuf_size(struct lttng_ust_shm_handle *handle,
struct lttng_ust_lib_ring_buffer *buf, unsigned long *len)
{
- struct channel *chan = handle->shadow_chan;
+ struct channel *chan;
+
+ if (!handle || !buf || !len)
+ return -EINVAL;
+ chan = handle->shadow_chan;
*len = lib_ring_buffer_get_read_data_size(&chan->backend.config, buf,
handle);
return 0;
int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle *handle,
struct lttng_ust_lib_ring_buffer *buf, unsigned long *len)
{
- struct channel *chan = handle->shadow_chan;
+ struct channel *chan;
+ if (!handle || !buf || !len)
+ return -EINVAL;
+
+ chan = handle->shadow_chan;
*len = lib_ring_buffer_get_read_data_size(&chan->backend.config, buf,
handle);
*len = PAGE_ALIGN(*len);
int ustctl_get_next_subbuf(struct lttng_ust_shm_handle *handle,
struct lttng_ust_lib_ring_buffer *buf)
{
+ if (!handle || !buf)
+ return -EINVAL;
+
return lib_ring_buffer_get_next_subbuf(buf, handle);
}
int ustctl_put_next_subbuf(struct lttng_ust_shm_handle *handle,
struct lttng_ust_lib_ring_buffer *buf)
{
+ if (!handle || !buf)
+ return -EINVAL;
+
lib_ring_buffer_put_next_subbuf(buf, handle);
return 0;
}
int ustctl_snapshot(struct lttng_ust_shm_handle *handle,
struct lttng_ust_lib_ring_buffer *buf)
{
+ if (!handle || !buf)
+ return -EINVAL;
+
return lib_ring_buffer_snapshot(buf, &buf->cons_snapshot,
&buf->prod_snapshot, handle);
}
int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle *handle,
struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos)
{
+ if (!handle || !buf || !pos)
+ return -EINVAL;
+
*pos = buf->cons_snapshot;
return 0;
}
int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle *handle,
struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos)
{
+ if (!handle || !buf || !pos)
+ return -EINVAL;
+
*pos = buf->prod_snapshot;
return 0;
}
int ustctl_get_subbuf(struct lttng_ust_shm_handle *handle,
struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos)
{
+ if (!handle || !buf || !pos)
+ return -EINVAL;
+
return lib_ring_buffer_get_subbuf(buf, *pos, handle);
}
int ustctl_put_subbuf(struct lttng_ust_shm_handle *handle,
struct lttng_ust_lib_ring_buffer *buf)
{
+ if (!handle || !buf)
+ return -EINVAL;
+
lib_ring_buffer_put_subbuf(buf, handle);
return 0;
}
struct lttng_ust_lib_ring_buffer *buf,
int producer_active)
{
+ assert(handle && buf);
lib_ring_buffer_switch_slow(buf,
producer_active ? SWITCH_ACTIVE : SWITCH_FLUSH,
handle);