Update ring buffer and pretty print
[lttng-modules.git] / ltt-debugfs-abi.c
index 6bc94838376d4aa3a9a5203bdbdb33ac097483c0..4f283a1835a33475254bb330c79c90a1bda68c46 100644 (file)
 #include <linux/file.h>
 #include <linux/uaccess.h>
 #include <linux/slab.h>
-#include <linux/ringbuffer/vfs.h>
+#include "wrapper/vmalloc.h"   /* for wrapper_vmalloc_sync_all() */
+#include "wrapper/ringbuffer/vfs.h"
 #include "ltt-debugfs-abi.h"
 #include "ltt-events.h"
+#include "ltt-tracer.h"
 
 /*
  * This is LTTng's own personal way to create a system call as an external
@@ -41,8 +43,14 @@ static struct dentry *lttng_dentry;
 static const struct file_operations lttng_fops;
 static const struct file_operations lttng_session_fops;
 static const struct file_operations lttng_channel_fops;
+static const struct file_operations lttng_metadata_fops;
 static const struct file_operations lttng_event_fops;
 
+enum channel_type {
+       PER_CPU_CHANNEL,
+       METADATA_CHANNEL,
+};
+
 static
 int lttng_abi_create_session(void)
 {
@@ -76,6 +84,21 @@ fd_error:
        return ret;
 }
 
+static
+long lttng_abi_tracer_version(struct file *file, 
+       struct lttng_kernel_tracer_version __user *uversion_param)
+{
+       struct lttng_kernel_tracer_version v;
+
+       v.version = LTTNG_VERSION;
+       v.patchlevel = LTTNG_PATCHLEVEL;
+       v.sublevel = LTTNG_SUBLEVEL;
+
+       if (copy_to_user(uversion_param, &v, sizeof(v)))
+               return -EFAULT;
+       return 0;
+}
+
 /**
  *     lttng_ioctl - lttng syscall through ioctl
  *
@@ -84,7 +107,7 @@ fd_error:
  *     @arg: command arg
  *
  *     This ioctl implements lttng commands:
- *     LTTNG_SESSION
+ *     LTTNG_KERNEL_SESSION
  *             Returns a LTTng trace session file descriptor
  *
  * The returned session will be deleted when its file descriptor is closed.
@@ -93,8 +116,11 @@ static
 long lttng_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 {
        switch (cmd) {
-       case LTTNG_SESSION:
+       case LTTNG_KERNEL_SESSION:
                return lttng_abi_create_session();
+       case LTTNG_KERNEL_TRACER_VERSION:
+               return lttng_abi_tracer_version(file,
+                               (struct lttng_kernel_tracer_version __user *) arg);
        default:
                return -ENOIOCTLCMD;
        }
@@ -107,13 +133,49 @@ static const struct file_operations lttng_fops = {
 #endif
 };
 
+/*
+ * We tolerate no failure in this function (if one happens, we print a dmesg
+ * error, but cannot return any error, because the channel information is
+ * invariant.
+ */
+static
+void lttng_metadata_create_events(struct file *channel_file)
+{
+       struct ltt_channel *channel = channel_file->private_data;
+       static struct lttng_kernel_event metadata_params = {
+               .instrumentation = LTTNG_KERNEL_TRACEPOINTS,
+               .name = "lttng_metadata",
+       };
+       struct ltt_event *event;
+       int ret;
+
+       /*
+        * We tolerate no failure path after event creation. It will stay
+        * invariant for the rest of the session.
+        */
+       event = ltt_event_create(channel, &metadata_params, NULL);
+       if (!event) {
+               goto create_error;
+               ret = -EEXIST;
+       }
+       return;
+
+create_error:
+       WARN_ON(1);
+       return;         /* not allowed to return error */
+}
+
+static
 int lttng_abi_create_channel(struct file *session_file,
-                            struct lttng_channel __user *uchan_param)
+                            struct lttng_kernel_channel __user *uchan_param,
+                            enum channel_type channel_type)
 {
        struct ltt_session *session = session_file->private_data;
+       const struct file_operations *fops;
+       const char *transport_name;
        struct ltt_channel *chan;
        struct file *chan_file;
-       struct lttng_channel chan_param;
+       struct lttng_kernel_channel chan_param;
        int chan_fd;
        int ret = 0;
 
@@ -131,22 +193,41 @@ int lttng_abi_create_channel(struct file *session_file,
                ret = PTR_ERR(chan_file);
                goto file_error;
        }
+       switch (channel_type) {
+       case PER_CPU_CHANNEL:
+               transport_name = chan_param.overwrite ?
+                       "relay-overwrite" : "relay-discard";
+               fops = &lttng_channel_fops;
+               break;
+       case METADATA_CHANNEL:
+               transport_name = "relay-metadata";
+               fops = &lttng_metadata_fops;
+               break;
+       default:
+               transport_name = "<unknown>";
+               break;
+       }
        /*
         * We tolerate no failure path after channel creation. It will stay
         * invariant for the rest of the session.
         */
-       chan = ltt_channel_create(session, chan_param.overwrite, NULL,
+       chan = ltt_channel_create(session, transport_name, NULL,
                                  chan_param.subbuf_size,
                                  chan_param.num_subbuf,
                                  chan_param.switch_timer_interval,
                                  chan_param.read_timer_interval);
        if (!chan) {
-               ret = -ENOMEM;
+               ret = -EINVAL;
                goto chan_error;
        }
        chan->file = chan_file;
        chan_file->private_data = chan;
        fd_install(chan_fd, chan_file);
+       if (channel_type == METADATA_CHANNEL) {
+               session->metadata = chan;
+               lttng_metadata_create_events(chan_file);
+       }
+
        /* The channel created holds a reference on the session */
        atomic_long_inc(&session_file->f_count);
 
@@ -168,7 +249,7 @@ fd_error:
  *     @arg: command arg
  *
  *     This ioctl implements lttng commands:
- *     LTTNG_CHANNEL
+ *     LTTNG_KERNEL_CHANNEL
  *             Returns a LTTng channel file descriptor
  *
  * The returned channel will be deleted when its file descriptor is closed.
@@ -179,12 +260,18 @@ long lttng_session_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
        struct ltt_session *session = file->private_data;
 
        switch (cmd) {
-       case LTTNG_CHANNEL:
-               return lttng_abi_create_channel(file, (struct lttng_channel __user *)arg);
-       case LTTNG_SESSION_START:
+       case LTTNG_KERNEL_CHANNEL:
+               return lttng_abi_create_channel(file,
+                               (struct lttng_kernel_channel __user *) arg,
+                               PER_CPU_CHANNEL);
+       case LTTNG_KERNEL_SESSION_START:
                return ltt_session_start(session);
-       case LTTNG_SESSION_STOP:
+       case LTTNG_KERNEL_SESSION_STOP:
                return ltt_session_stop(session);
+       case LTTNG_KERNEL_METADATA:
+               return lttng_abi_create_channel(file,
+                               (struct lttng_kernel_channel __user *) arg,
+                               METADATA_CHANNEL);
        default:
                return -ENOIOCTLCMD;
        }
@@ -202,7 +289,9 @@ static
 int lttng_session_release(struct inode *inode, struct file *file)
 {
        struct ltt_session *session = file->private_data;
-       ltt_session_destroy(session);
+
+       if (session)
+               ltt_session_destroy(session);
        return 0;
 }
 
@@ -238,9 +327,18 @@ int lttng_abi_open_stream(struct file *channel_file)
                ret = PTR_ERR(stream_file);
                goto file_error;
        }
+       /*
+        * OPEN_FMODE, called within anon_inode_getfile/alloc_file, don't honor
+        * FMODE_LSEEK, FMODE_PREAD nor FMODE_PWRITE. We need to read from this
+        * file descriptor, so we set FMODE_PREAD here.
+        */
+       stream_file->f_mode |= FMODE_PREAD;
        fd_install(stream_fd, stream_file);
-       /* The stream holds a reference on the channel */
-       atomic_long_inc(&channel_file->f_count);
+       /*
+        * The stream holds a reference to the channel within the generic ring
+        * buffer library, so no need to hold a refcount on the channel and
+        * session files here.
+        */
        return stream_fd;
 
 file_error:
@@ -252,25 +350,27 @@ fd_error:
 
 static
 int lttng_abi_create_event(struct file *channel_file,
-                          struct lttng_event __user *uevent_param)
+                          struct lttng_kernel_event __user *uevent_param)
 {
        struct ltt_channel *channel = channel_file->private_data;
        struct ltt_event *event;
-       char *event_name;
-       struct lttng_event event_param;
+       struct lttng_kernel_event event_param;
        int event_fd, ret;
        struct file *event_file;
 
        if (copy_from_user(&event_param, uevent_param, sizeof(event_param)))
                return -EFAULT;
-       event_name = kmalloc(PATH_MAX, GFP_KERNEL);
-       if (!event_name)
-               return -ENOMEM;
-       if (strncpy_from_user(event_name, uevent_param->name, PATH_MAX)) {
-               ret = -EFAULT;
-               goto name_error;
+       event_param.name[LTTNG_SYM_NAME_LEN - 1] = '\0';
+       switch (event_param.instrumentation) {
+       case LTTNG_KERNEL_KPROBES:
+               event_param.u.kprobe.symbol_name[LTTNG_SYM_NAME_LEN - 1] = '\0';
+               break;
+       case LTTNG_KERNEL_FUNCTION_TRACER:
+               event_param.u.ftrace.symbol_name[LTTNG_SYM_NAME_LEN - 1] = '\0';
+               break;
+       default:
+               break;
        }
-       event_name[PATH_MAX - 1] = '\0';
        event_fd = get_unused_fd();
        if (event_fd < 0) {
                ret = event_fd;
@@ -287,17 +387,15 @@ int lttng_abi_create_event(struct file *channel_file,
         * We tolerate no failure path after event creation. It will stay
         * invariant for the rest of the session.
         */
-       event = ltt_event_create(channel, event_name, event_param.itype,
-                                NULL, NULL);   /* TODO non-null probe */
+       event = ltt_event_create(channel, &event_param, NULL);
        if (!event) {
-               goto event_error;
                ret = -EEXIST;
+               goto event_error;
        }
        event_file->private_data = event;
        fd_install(event_fd, event_file);
        /* The event holds a reference on the channel */
        atomic_long_inc(&channel_file->f_count);
-       kfree(event_name);
        return event_fd;
 
 event_error:
@@ -305,8 +403,6 @@ event_error:
 file_error:
        put_unused_fd(event_fd);
 fd_error:
-name_error:
-       kfree(event_name);
        return ret;
 }
 
@@ -318,23 +414,46 @@ name_error:
  *     @arg: command arg
  *
  *     This ioctl implements lttng commands:
- *      LTTNG_STREAM
+ *      LTTNG_KERNEL_STREAM
  *              Returns an event stream file descriptor or failure.
  *              (typically, one event stream records events from one CPU)
- *     LTTNG_EVENT
+ *     LTTNG_KERNEL_EVENT
  *             Returns an event file descriptor or failure.
  *
- * The returned session will be deleted when its file descriptor is closed.
  * Channel and event file descriptors also hold a reference on the session.
  */
 static
 long lttng_channel_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 {
        switch (cmd) {
-       case LTTNG_STREAM:
+       case LTTNG_KERNEL_STREAM:
+               return lttng_abi_open_stream(file);
+       case LTTNG_KERNEL_EVENT:
+               return lttng_abi_create_event(file, (struct lttng_kernel_event __user *) arg);
+       default:
+               return -ENOIOCTLCMD;
+       }
+}
+
+/**
+ *     lttng_metadata_ioctl - lttng syscall through ioctl
+ *
+ *     @file: the file
+ *     @cmd: the command
+ *     @arg: command arg
+ *
+ *     This ioctl implements lttng commands:
+ *      LTTNG_KERNEL_STREAM
+ *              Returns an event stream file descriptor or failure.
+ *
+ * Channel and event file descriptors also hold a reference on the session.
+ */
+static
+long lttng_metadata_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
+{
+       switch (cmd) {
+       case LTTNG_KERNEL_STREAM:
                return lttng_abi_open_stream(file);
-       case LTTNG_EVENT:
-               return lttng_abi_create_event(file, (struct lttng_event __user *)arg);
        default:
                return -ENOIOCTLCMD;
        }
@@ -372,7 +491,9 @@ static
 int lttng_channel_release(struct inode *inode, struct file *file)
 {
        struct ltt_channel *channel = file->private_data;
-       fput(channel->session->file);
+
+       if (channel)
+               fput(channel->session->file);
        return 0;
 }
 
@@ -388,11 +509,21 @@ static const struct file_operations lttng_channel_fops = {
 #endif
 };
 
+static const struct file_operations lttng_metadata_fops = {
+       .release = lttng_channel_release,
+       .unlocked_ioctl = lttng_metadata_ioctl,
+#ifdef CONFIG_COMPAT
+       .compat_ioctl = lttng_metadata_ioctl,
+#endif
+};
+
 static
 int lttng_event_release(struct inode *inode, struct file *file)
 {
        struct ltt_event *event = file->private_data;
-       fput(event->chan->file);
+
+       if (event)
+               fput(event->chan->file);
        return 0;
 }
 
@@ -405,8 +536,9 @@ int __init ltt_debugfs_abi_init(void)
 {
        int ret = 0;
 
+       wrapper_vmalloc_sync_all();
        lttng_dentry = debugfs_create_file("lttng", S_IWUSR, NULL, NULL,
-                                          &lttng_session_fops);
+                                          &lttng_fops);
        if (IS_ERR(lttng_dentry) || !lttng_dentry) {
                printk(KERN_ERR "Error creating LTTng control file\n");
                ret = -ENOMEM;
This page took 0.028492 seconds and 4 git commands to generate.