Add kernel and UST time namespace context
[lttng-tools.git] / include / lttng / event.h
index a85f0f3b569ff002471a2f49af679ae35082177b..bcde9a49e8d0e61a5478610caca1e5d663aeea1c 100644 (file)
@@ -1,19 +1,9 @@
 /*
- * Copyright (C) 2014 David Goulet <dgoulet@efficios.com>
- * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2014 David Goulet <dgoulet@efficios.com>
+ * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@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, version 2.1 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: LGPL-2.1-only
  *
- * 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
  */
 
 #ifndef LTTNG_EVENT_H
@@ -24,6 +14,7 @@ extern "C" {
 #endif
 
 #include <lttng/handle.h>
+#include <lttng/userspace-probe.h>
 
 /*
  * Instrumentation type of tracing event.
@@ -36,6 +27,7 @@ enum lttng_event_type {
        LTTNG_EVENT_FUNCTION_ENTRY            = 3,
        LTTNG_EVENT_NOOP                      = 4,
        LTTNG_EVENT_SYSCALL                   = 5,
+       LTTNG_EVENT_USERSPACE_PROBE           = 6,
 };
 
 /*
@@ -138,6 +130,32 @@ enum lttng_event_context_type {
        LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER    = 13,
        LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER = 14,
        LTTNG_EVENT_CONTEXT_APP_CONTEXT         = 15,
+       LTTNG_EVENT_CONTEXT_INTERRUPTIBLE       = 16,
+       LTTNG_EVENT_CONTEXT_PREEMPTIBLE         = 17,
+       LTTNG_EVENT_CONTEXT_NEED_RESCHEDULE     = 18,
+       LTTNG_EVENT_CONTEXT_MIGRATABLE          = 19,
+       LTTNG_EVENT_CONTEXT_CALLSTACK_KERNEL    = 20,
+       LTTNG_EVENT_CONTEXT_CALLSTACK_USER      = 21, /* Supported on x86_32 and x86_64 only. */
+       LTTNG_EVENT_CONTEXT_CGROUP_NS           = 22,
+       LTTNG_EVENT_CONTEXT_IPC_NS              = 23,
+       LTTNG_EVENT_CONTEXT_MNT_NS              = 24,
+       LTTNG_EVENT_CONTEXT_NET_NS              = 25,
+       LTTNG_EVENT_CONTEXT_PID_NS              = 26,
+       LTTNG_EVENT_CONTEXT_USER_NS             = 27,
+       LTTNG_EVENT_CONTEXT_UTS_NS              = 28,
+       LTTNG_EVENT_CONTEXT_UID                 = 29,
+       LTTNG_EVENT_CONTEXT_EUID                = 30,
+       LTTNG_EVENT_CONTEXT_SUID                = 31,
+       LTTNG_EVENT_CONTEXT_GID                 = 32,
+       LTTNG_EVENT_CONTEXT_EGID                = 33,
+       LTTNG_EVENT_CONTEXT_SGID                = 34,
+       LTTNG_EVENT_CONTEXT_VUID                = 35,
+       LTTNG_EVENT_CONTEXT_VEUID               = 36,
+       LTTNG_EVENT_CONTEXT_VSUID               = 37,
+       LTTNG_EVENT_CONTEXT_VGID                = 38,
+       LTTNG_EVENT_CONTEXT_VEGID               = 39,
+       LTTNG_EVENT_CONTEXT_VSGID               = 40,
+       LTTNG_EVENT_CONTEXT_TIME_NS             = 41,
 };
 
 enum lttng_event_field_type {
@@ -261,7 +279,7 @@ struct lttng_event {
 
        /* Offset 288 */
        union {
-               char padding[8];
+               uint64_t padding;
                void *ptr;
        } extended;
 
@@ -296,17 +314,86 @@ extern int lttng_list_events(struct lttng_handle *handle,
                const char *channel_name, struct lttng_event **events);
 
 /*
- * Get the filter string of a specific LTTng event.
+ * Create an lttng_event.
+ *
+ * This creation function, introduced in LTTng 2.11, works around
+ * the fact that the layout of the 'lttng_event' is publicly exposed.
+ *
+ * It allocates a larger object which exposes the same public fields
+ * as a 'struct lttng_event', but also allows the use of the following extended
+ * attribute setters:
+ *   - lttng_event_set_userspace_probe_location();
+ *
+ * Events created through this function must be destroyed using
+ * lttng_event_destroy().
+ *
+ * Returns a zeroed lttng_event on success, NULL on error.
+ */
+extern struct lttng_event *lttng_event_create(void);
+
+/*
+ * Destroy an lttng_event.
  *
- * If the call is successful, then the filter string's address is put
- * in *filter_string. If the event has no filter string, *filter_string
- * is set to NULL. The caller does NOT own *filter_string.
+ * This destruction function, introduced in LTTng 2.11, should only
+ * be used with events created by lttng_event_create().
+  */
+extern void lttng_event_destroy(struct lttng_event *event);
+
+/*
+ * Get the filter expression of a specific LTTng event.
+ *
+ * If the call is successful, then the filter expression's address is put
+ * in *filter_expression. If the event has no filter expression,
+ * *filter_expression is set to NULL. The caller does NOT own
+ * *filter_expression.
  *
  * Returns 0 on success, or a negative LTTng error code on error.
  */
-extern int lttng_event_get_filter_string(struct lttng_event *event,
+extern int lttng_event_get_filter_expression(struct lttng_event *event,
                const char **filter_string);
 
+/*
+ * Get the number of exclusion names of a specific LTTng event.
+ *
+ * Returns the number of exclusion names on success, or a negative
+ * LTTng error code on error.
+ */
+extern int lttng_event_get_exclusion_name_count(struct lttng_event *event);
+
+/*
+ * Get an LTTng event's exclusion name at a given index.
+ *
+ * If the call is successful, then the exclusion name string's address
+ * is put in *exclusion_name. The caller does NOT own *exclusion_name.
+ *
+ * Returns 0 on success, or a negative LTTng error code on error.
+ */
+extern int lttng_event_get_exclusion_name(struct lttng_event *event,
+               size_t index, const char **exclusion_name);
+
+/*
+ * Get the userspace probe location of a specific LTTng event.
+ * If the call is successful, then a pointer to the probe location is returned.
+ * If the event has no probe location a NULL pointer is returned. The caller
+ * does not own the returned probe location.
+ */
+extern const struct lttng_userspace_probe_location *
+lttng_event_get_userspace_probe_location(const struct lttng_event *event);
+
+/*
+ * Set an LTTng event's userspace probe location.
+ *
+ * If the call is successful, then the probe location is set to the event. The
+ * ownership of the probe_location is given to the event.
+ *
+ * Note that the event must have been created using 'lttng_event_create()' in
+ * order for this call to succeed.
+ *
+ * Returns 0 on success, or a negative LTTng error code on error.
+ */
+extern int lttng_event_set_userspace_probe_location(struct lttng_event *event,
+               struct lttng_userspace_probe_location *probe_location);
+
 /*
  * List the available tracepoints of a specific lttng domain.
  *
This page took 0.02545 seconds and 4 git commands to generate.