Cleanup: Move lttng-modules instrumentation headers
[lttng-modules.git] / lttng-abi.c
index c14cc82b2baca8aa6e2012a6f46d8079fa58f2ec..01eb4d55addea3ea41b5def0ed79ca9efd91fcf1 100644 (file)
@@ -1,25 +1,11 @@
-/*
+/* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
+ *
  * lttng-abi.c
  *
  * LTTng ABI
  *
  * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; only
- * version 2.1 of the License.
- *
- * This library 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
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
- *
- *
  * Mimic system calls for:
  * - session creation, returns a file descriptor or failure.
  *   - channel creation, returns a file descriptor or failure.
 #include <linux/uaccess.h>
 #include <linux/slab.h>
 #include <linux/err.h>
-#include <wrapper/vmalloc.h>   /* for wrapper_vmalloc_sync_all() */
-#include <wrapper/ringbuffer/vfs.h>
-#include <wrapper/ringbuffer/backend.h>
-#include <wrapper/ringbuffer/frontend.h>
+#include <wrapper/vmalloc.h>   /* for wrapper_vmalloc_sync_mappings() */
+#include <ringbuffer/vfs.h>
+#include <ringbuffer/backend.h>
+#include <ringbuffer/frontend.h>
 #include <wrapper/poll.h>
 #include <wrapper/file.h>
 #include <wrapper/kref.h>
-#include <lttng-abi.h>
-#include <lttng-abi-old.h>
-#include <lttng-events.h>
-#include <lttng-tracer.h>
-#include <lib/ringbuffer/frontend_types.h>
+#include <lttng/string-utils.h>
+#include <lttng/abi.h>
+#include <lttng/abi-old.h>
+#include <lttng/events.h>
+#include <lttng/tracer.h>
+#include <lttng/tp-mempool.h>
+#include <ringbuffer/frontend_types.h>
 
 /*
  * This is LTTng's own personal way to create a system call as an external
  */
 
 static struct proc_dir_entry *lttng_proc_dentry;
-static const struct file_operations lttng_fops;
+
+#if (LINUX_VERSION_CODE >= KERNEL_VERSION(5,6,0))
+static const struct proc_ops lttng_proc_ops;
+#else
+static const struct file_operations lttng_proc_ops;
+#endif
+
 static const struct file_operations lttng_session_fops;
 static const struct file_operations lttng_channel_fops;
 static const struct file_operations lttng_metadata_fops;
@@ -245,6 +239,47 @@ long lttng_abi_add_context(struct file *file,
                return lttng_add_preemptible_to_ctx(ctx);
        case LTTNG_KERNEL_CONTEXT_MIGRATABLE:
                return lttng_add_migratable_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL:
+       case LTTNG_KERNEL_CONTEXT_CALLSTACK_USER:
+               return lttng_add_callstack_to_ctx(ctx, context_param->ctx);
+       case LTTNG_KERNEL_CONTEXT_CGROUP_NS:
+               return lttng_add_cgroup_ns_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_IPC_NS:
+               return lttng_add_ipc_ns_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_MNT_NS:
+               return lttng_add_mnt_ns_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_NET_NS:
+               return lttng_add_net_ns_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_PID_NS:
+               return lttng_add_pid_ns_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_USER_NS:
+               return lttng_add_user_ns_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_UTS_NS:
+               return lttng_add_uts_ns_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_UID:
+               return lttng_add_uid_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_EUID:
+               return lttng_add_euid_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_SUID:
+               return lttng_add_suid_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_GID:
+               return lttng_add_gid_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_EGID:
+               return lttng_add_egid_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_SGID:
+               return lttng_add_sgid_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_VUID:
+               return lttng_add_vuid_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_VEUID:
+               return lttng_add_veuid_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_VSUID:
+               return lttng_add_vsuid_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_VGID:
+               return lttng_add_vgid_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_VEGID:
+               return lttng_add_vegid_to_ctx(ctx);
+       case LTTNG_KERNEL_CONTEXT_VSGID:
+               return lttng_add_vsgid_to_ctx(ctx);
        default:
                return -EINVAL;
        }
@@ -362,13 +397,22 @@ long lttng_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
        }
 }
 
-static const struct file_operations lttng_fops = {
+#if (LINUX_VERSION_CODE >= KERNEL_VERSION(5,6,0))
+static const struct proc_ops lttng_proc_ops = {
+       .proc_ioctl = lttng_ioctl,
+#ifdef CONFIG_COMPAT
+       .proc_compat_ioctl = lttng_ioctl,
+#endif /* CONFIG_COMPAT */
+};
+#else
+static const struct file_operations lttng_proc_ops = {
        .owner = THIS_MODULE,
        .unlocked_ioctl = lttng_ioctl,
 #ifdef CONFIG_COMPAT
        .compat_ioctl = lttng_ioctl,
-#endif
+#endif /* CONFIG_COMPAT */
 };
+#endif
 
 static
 int lttng_abi_create_channel(struct file *session_file,
@@ -396,7 +440,7 @@ int lttng_abi_create_channel(struct file *session_file,
                fops = &lttng_metadata_fops;
                break;
        }
-               
+
        chan_file = anon_inode_getfile("[lttng_channel]",
                                       fops,
                                       NULL, O_RDWR);
@@ -428,8 +472,8 @@ int lttng_abi_create_channel(struct file *session_file,
                transport_name = "<unknown>";
                break;
        }
-       if (atomic_long_add_unless(&session_file->f_count,
-               1, INT_MAX) == INT_MAX) {
+       if (!atomic_long_add_unless(&session_file->f_count, 1, LONG_MAX)) {
+               ret = -EOVERFLOW;
                goto refcount_error;
        }
        /*
@@ -462,6 +506,61 @@ fd_error:
        return ret;
 }
 
+static
+int lttng_abi_session_set_name(struct lttng_session *session,
+               struct lttng_kernel_session_name *name)
+{
+       size_t len;
+
+       len = strnlen(name->name, LTTNG_KERNEL_SESSION_NAME_LEN);
+
+       if (len == LTTNG_KERNEL_SESSION_NAME_LEN) {
+               /* Name is too long/malformed */
+               return -EINVAL;
+       }
+
+       strcpy(session->name, name->name);
+       return 0;
+}
+
+static
+int lttng_abi_session_set_creation_time(struct lttng_session *session,
+               struct lttng_kernel_session_creation_time *time)
+{
+       size_t len;
+
+       len = strnlen(time->iso8601, LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN);
+
+       if (len == LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN) {
+               /* Time is too long/malformed */
+               return -EINVAL;
+       }
+
+       strcpy(session->creation_time, time->iso8601);
+       return 0;
+}
+
+static
+enum tracker_type get_tracker_type(struct lttng_kernel_tracker_args *tracker)
+{
+       switch (tracker->type) {
+       case LTTNG_KERNEL_TRACKER_PID:
+               return TRACKER_PID;
+       case LTTNG_KERNEL_TRACKER_VPID:
+               return TRACKER_VPID;
+       case LTTNG_KERNEL_TRACKER_UID:
+               return TRACKER_UID;
+       case LTTNG_KERNEL_TRACKER_VUID:
+               return TRACKER_VUID;
+       case LTTNG_KERNEL_TRACKER_GID:
+               return TRACKER_GID;
+       case LTTNG_KERNEL_TRACKER_VGID:
+               return TRACKER_VGID;
+       default:
+               return TRACKER_UNKNOWN;
+       }
+}
+
 /**
  *     lttng_session_ioctl - lttng session fd ioctl
  *
@@ -479,9 +578,13 @@ fd_error:
  *     LTTNG_KERNEL_METADATA
  *             Returns a LTTng metadata file descriptor
  *     LTTNG_KERNEL_SESSION_TRACK_PID
- *             Add PID to session tracker
+ *             Add PID to session PID tracker
  *     LTTNG_KERNEL_SESSION_UNTRACK_PID
- *             Remove PID from session tracker
+ *             Remove PID from session PID tracker
+ *     LTTNG_KERNEL_SESSION_TRACK_ID
+ *             Add ID to tracker
+ *     LTTNG_KERNEL_SESSION_UNTRACK_ID
+ *             Remove ID from tracker
  *
  * The returned channel will be deleted when its file descriptor is closed.
  */
@@ -489,13 +592,12 @@ static
 long lttng_session_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 {
        struct lttng_session *session = file->private_data;
+       struct lttng_kernel_channel chan_param;
+       struct lttng_kernel_old_channel old_chan_param;
 
        switch (cmd) {
        case LTTNG_KERNEL_OLD_CHANNEL:
        {
-               struct lttng_kernel_channel chan_param;
-               struct lttng_kernel_old_channel old_chan_param;
-
                if (copy_from_user(&old_chan_param,
                                (struct lttng_kernel_old_channel __user *) arg,
                                sizeof(struct lttng_kernel_old_channel)))
@@ -512,8 +614,6 @@ long lttng_session_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
        }
        case LTTNG_KERNEL_CHANNEL:
        {
-               struct lttng_kernel_channel chan_param;
-
                if (copy_from_user(&chan_param,
                                (struct lttng_kernel_channel __user *) arg,
                                sizeof(struct lttng_kernel_channel)))
@@ -533,9 +633,6 @@ long lttng_session_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
                return lttng_session_disable(session);
        case LTTNG_KERNEL_OLD_METADATA:
        {
-               struct lttng_kernel_channel chan_param;
-               struct lttng_kernel_old_channel old_chan_param;
-
                if (copy_from_user(&old_chan_param,
                                (struct lttng_kernel_old_channel __user *) arg,
                                sizeof(struct lttng_kernel_old_channel)))
@@ -552,8 +649,6 @@ long lttng_session_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
        }
        case LTTNG_KERNEL_METADATA:
        {
-               struct lttng_kernel_channel chan_param;
-
                if (copy_from_user(&chan_param,
                                        (struct lttng_kernel_channel __user *) arg,
                                        sizeof(struct lttng_kernel_channel)))
@@ -562,13 +657,78 @@ long lttng_session_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
                                METADATA_CHANNEL);
        }
        case LTTNG_KERNEL_SESSION_TRACK_PID:
-               return lttng_session_track_pid(session, (int) arg);
+               return lttng_session_track_id(session, TRACKER_PID, (int) arg);
        case LTTNG_KERNEL_SESSION_UNTRACK_PID:
-               return lttng_session_untrack_pid(session, (int) arg);
+               return lttng_session_untrack_id(session, TRACKER_PID, (int) arg);
+       case LTTNG_KERNEL_SESSION_TRACK_ID:
+       {
+               struct lttng_kernel_tracker_args tracker;
+               enum tracker_type tracker_type;
+
+               if (copy_from_user(&tracker,
+                               (struct lttng_kernel_tracker_args __user *) arg,
+                               sizeof(struct lttng_kernel_tracker_args)))
+                       return -EFAULT;
+               tracker_type = get_tracker_type(&tracker);
+               if (tracker_type == TRACKER_UNKNOWN)
+                       return -EINVAL;
+               return lttng_session_track_id(session, tracker_type, tracker.id);
+       }
+       case LTTNG_KERNEL_SESSION_UNTRACK_ID:
+       {
+               struct lttng_kernel_tracker_args tracker;
+               enum tracker_type tracker_type;
+
+               if (copy_from_user(&tracker,
+                               (struct lttng_kernel_tracker_args __user *) arg,
+                               sizeof(struct lttng_kernel_tracker_args)))
+                       return -EFAULT;
+               tracker_type = get_tracker_type(&tracker);
+               if (tracker_type == TRACKER_UNKNOWN)
+                       return -EINVAL;
+               return lttng_session_untrack_id(session, tracker_type,
+                               tracker.id);
+       }
        case LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS:
-               return lttng_session_list_tracker_pids(session);
+               return lttng_session_list_tracker_ids(session, TRACKER_PID);
+       case LTTNG_KERNEL_SESSION_LIST_TRACKER_IDS:
+       {
+               struct lttng_kernel_tracker_args tracker;
+               enum tracker_type tracker_type;
+
+               if (copy_from_user(&tracker,
+                               (struct lttng_kernel_tracker_args __user *) arg,
+                               sizeof(struct lttng_kernel_tracker_args)))
+                       return -EFAULT;
+               tracker_type = get_tracker_type(&tracker);
+               if (tracker_type == TRACKER_UNKNOWN)
+                       return -EINVAL;
+               return lttng_session_list_tracker_ids(session, tracker_type);
+       }
        case LTTNG_KERNEL_SESSION_METADATA_REGEN:
                return lttng_session_metadata_regenerate(session);
+       case LTTNG_KERNEL_SESSION_STATEDUMP:
+               return lttng_session_statedump(session);
+       case LTTNG_KERNEL_SESSION_SET_NAME:
+       {
+               struct lttng_kernel_session_name name;
+
+               if (copy_from_user(&name,
+                               (struct lttng_kernel_session_name __user *) arg,
+                               sizeof(struct lttng_kernel_session_name)))
+                       return -EFAULT;
+               return lttng_abi_session_set_name(session, &name);
+       }
+       case LTTNG_KERNEL_SESSION_SET_CREATION_TIME:
+       {
+               struct lttng_kernel_session_creation_time time;
+
+               if (copy_from_user(&time,
+                               (struct lttng_kernel_session_creation_time __user *) arg,
+                               sizeof(struct lttng_kernel_session_creation_time)))
+                       return -EFAULT;
+               return lttng_abi_session_set_creation_time(session, &time);
+       }
        default:
                return -ENOIOCTLCMD;
        }
@@ -651,6 +811,38 @@ void lttng_metadata_ring_buffer_ioctl_put_next_subbuf(struct file *filp,
        stream->metadata_out = stream->metadata_in;
 }
 
+/*
+ * Reset the counter of how much metadata has been consumed to 0. That way,
+ * the consumer receives the content of the metadata cache unchanged. This is
+ * different from the metadata_regenerate where the offset from epoch is
+ * resampled, here we want the exact same content as the last time the metadata
+ * was generated. This command is only possible if all the metadata written
+ * in the cache has been output to the metadata stream to avoid corrupting the
+ * metadata file.
+ *
+ * Return 0 on success, a negative value on error.
+ */
+static
+int lttng_metadata_cache_dump(struct lttng_metadata_stream *stream)
+{
+       int ret;
+       struct lttng_metadata_cache *cache = stream->metadata_cache;
+
+       mutex_lock(&cache->lock);
+       if (stream->metadata_out != cache->metadata_written) {
+               ret = -EBUSY;
+               goto end;
+       }
+       stream->metadata_out = 0;
+       stream->metadata_in = 0;
+       wake_up_interruptible(&stream->read_wait);
+       ret = 0;
+
+end:
+       mutex_unlock(&cache->lock);
+       return ret;
+}
+
 static
 long lttng_metadata_ring_buffer_ioctl(struct file *filp,
                unsigned int cmd, unsigned long arg)
@@ -681,6 +873,7 @@ long lttng_metadata_ring_buffer_ioctl(struct file *filp,
                 */
                return -ENOSYS;
        }
+       case RING_BUFFER_FLUSH_EMPTY:   /* Fall-through. */
        case RING_BUFFER_FLUSH:
        {
                struct lttng_metadata_stream *stream = filp->private_data;
@@ -702,6 +895,12 @@ long lttng_metadata_ring_buffer_ioctl(struct file *filp,
 
                return put_u64(stream->version, arg);
        }
+       case RING_BUFFER_METADATA_CACHE_DUMP:
+       {
+               struct lttng_metadata_stream *stream = filp->private_data;
+
+               return lttng_metadata_cache_dump(stream);
+       }
        default:
                break;
        }
@@ -757,6 +956,34 @@ long lttng_metadata_ring_buffer_compat_ioctl(struct file *filp,
                 */
                return -ENOSYS;
        }
+       case RING_BUFFER_FLUSH_EMPTY:   /* Fall-through. */
+       case RING_BUFFER_FLUSH:
+       {
+               struct lttng_metadata_stream *stream = filp->private_data;
+               struct lib_ring_buffer *buf = stream->priv;
+               struct channel *chan = buf->backend.chan;
+
+               /*
+                * Before doing the actual ring buffer flush, write up to one
+                * packet of metadata in the ring buffer.
+                */
+               ret = lttng_metadata_output_channel(stream, chan);
+               if (ret < 0)
+                       goto err;
+               break;
+       }
+       case RING_BUFFER_GET_METADATA_VERSION:
+       {
+               struct lttng_metadata_stream *stream = filp->private_data;
+
+               return put_u64(stream->version, arg);
+       }
+       case RING_BUFFER_METADATA_CACHE_DUMP:
+       {
+               struct lttng_metadata_stream *stream = filp->private_data;
+
+               return lttng_metadata_cache_dump(stream);
+       }
        default:
                break;
        }
@@ -774,12 +1001,6 @@ long lttng_metadata_ring_buffer_compat_ioctl(struct file *filp,
                                cmd, arg);
                break;
        }
-       case RING_BUFFER_GET_METADATA_VERSION:
-       {
-               struct lttng_metadata_stream *stream = filp->private_data;
-
-               return put_u64(stream->version, arg);
-       }
        default:
                break;
        }
@@ -957,8 +1178,11 @@ int lttng_abi_open_metadata_stream(struct file *channel_file)
                goto notransport;
        }
 
-       if (!lttng_kref_get(&session->metadata_cache->refcount))
+       if (!lttng_kref_get(&session->metadata_cache->refcount)) {
+               ret = -EOVERFLOW;
                goto kref_error;
+       }
+
        ret = lttng_abi_create_stream_fd(channel_file, stream_priv,
                        &lttng_metadata_ring_buffer_file_operations);
        if (ret < 0)
@@ -997,7 +1221,8 @@ int lttng_abi_create_event(struct file *channel_file,
                event_param->u.kprobe.symbol_name[LTTNG_KERNEL_SYM_NAME_LEN - 1] = '\0';
                break;
        case LTTNG_KERNEL_FUNCTION:
-               event_param->u.ftrace.symbol_name[LTTNG_KERNEL_SYM_NAME_LEN - 1] = '\0';
+               WARN_ON_ONCE(1);
+               /* Not implemented. */
                break;
        default:
                break;
@@ -1015,8 +1240,7 @@ int lttng_abi_create_event(struct file *channel_file,
                goto file_error;
        }
        /* The event holds a reference on the channel */
-       if (atomic_long_add_unless(&channel_file->f_count,
-               1, INT_MAX) == INT_MAX) {
+       if (!atomic_long_add_unless(&channel_file->f_count, 1, LONG_MAX)) {
                ret = -EOVERFLOW;
                goto refcount_error;
        }
@@ -1024,8 +1248,12 @@ int lttng_abi_create_event(struct file *channel_file,
                        || event_param->instrumentation == LTTNG_KERNEL_SYSCALL) {
                struct lttng_enabler *enabler;
 
-               if (event_param->name[strlen(event_param->name) - 1] == '*') {
-                       enabler = lttng_enabler_create(LTTNG_ENABLER_WILDCARD,
+               if (strutils_is_star_glob_pattern(event_param->name)) {
+                       /*
+                        * If the event name is a star globbing pattern,
+                        * we create the special star globbing enabler.
+                        */
+                       enabler = lttng_enabler_create(LTTNG_ENABLER_STAR_GLOB,
                                event_param, channel);
                } else {
                        enabler = lttng_enabler_create(LTTNG_ENABLER_NAME,
@@ -1145,9 +1373,8 @@ long lttng_channel_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
                                sizeof(uevent_param->u.kretprobe.symbol_name));
                        break;
                case LTTNG_KERNEL_FUNCTION:
-                       memcpy(uevent_param->u.ftrace.symbol_name,
-                                       old_uevent_param->u.ftrace.symbol_name,
-                                       sizeof(uevent_param->u.ftrace.symbol_name));
+                       WARN_ON_ONCE(1);
+                       /* Not implemented. */
                        break;
                default:
                        break;
@@ -1245,7 +1472,6 @@ old_ctx_end:
        default:
                return -ENOIOCTLCMD;
        }
-
 }
 
 /**
@@ -1412,7 +1638,21 @@ long lttng_event_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
                        return lttng_enabler_attach_bytecode(enabler,
                                (struct lttng_kernel_filter_bytecode __user *) arg);
                }
-
+               default:
+                       WARN_ON_ONCE(1);
+                       return -ENOSYS;
+               }
+       case LTTNG_KERNEL_ADD_CALLSITE:
+               switch (*evtype) {
+               case LTTNG_TYPE_EVENT:
+                       event = file->private_data;
+                       return lttng_event_add_callsite(event,
+                               (struct lttng_kernel_event_callsite __user *) arg);
+               case LTTNG_TYPE_ENABLER:
+                       return -EINVAL;
+               default:
+                       WARN_ON_ONCE(1);
+                       return -ENOSYS;
                }
        default:
                return -ENOIOCTLCMD;
@@ -1698,11 +1938,17 @@ int __init lttng_abi_init(void)
 {
        int ret = 0;
 
-       wrapper_vmalloc_sync_all();
+       wrapper_vmalloc_sync_mappings();
        lttng_clock_ref();
+
+       ret = lttng_tp_mempool_init();
+       if (ret) {
+               goto error;
+       }
+
        lttng_proc_dentry = proc_create_data("lttng", S_IRUSR | S_IWUSR, NULL,
-                                       &lttng_fops, NULL);
-       
+                                       &lttng_proc_ops, NULL);
+
        if (!lttng_proc_dentry) {
                printk(KERN_ERR "Error creating LTTng control file\n");
                ret = -ENOMEM;
@@ -1712,6 +1958,7 @@ int __init lttng_abi_init(void)
        return 0;
 
 error:
+       lttng_tp_mempool_destroy();
        lttng_clock_unref();
        return ret;
 }
@@ -1719,6 +1966,7 @@ error:
 /* No __exit annotation because used by init error path too. */
 void lttng_abi_exit(void)
 {
+       lttng_tp_mempool_destroy();
        lttng_clock_unref();
        if (lttng_proc_dentry)
                remove_proc_entry("lttng", NULL);
This page took 0.030815 seconds and 4 git commands to generate.