/*
- * 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
#define LTTNG_EVENT_H
+#include <lttng/handle.h>
+#include <lttng/lttng-export.h>
+#include <lttng/userspace-probe.h>
+
#ifdef __cplusplus
extern "C" {
#endif
-#include <lttng/handle.h>
-#include <lttng/userspace-probe.h>
-
/*
* Instrumentation type of tracing event.
*/
LTTNG_EVENT_FUNCTION_ENTRY = 3,
LTTNG_EVENT_NOOP = 4,
LTTNG_EVENT_SYSCALL = 5,
+ LTTNG_EVENT_USERSPACE_PROBE = 6,
};
/*
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 {
* Return the size (number of entries) of the "lttng_event" array. Caller must
* free events. On error a negative LTTng error code is returned.
*/
-extern int lttng_list_events(struct lttng_handle *handle,
+LTTNG_EXPORT extern int lttng_list_events(struct lttng_handle *handle,
const char *channel_name, struct lttng_event **events);
-extern struct lttng_event *lttng_event_create(void);
+/*
+ * 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.
+ */
+LTTNG_EXPORT extern struct lttng_event *lttng_event_create(void);
-extern void lttng_event_destroy(struct lttng_event *event);
+/*
+ * Destroy an lttng_event.
+ *
+ * This destruction function, introduced in LTTng 2.11, should only
+ * be used with events created by lttng_event_create().
+ */
+LTTNG_EXPORT extern void lttng_event_destroy(struct lttng_event *event);
/*
* Get the filter expression of a specific LTTng event.
*
* Returns 0 on success, or a negative LTTng error code on error.
*/
-extern int lttng_event_get_filter_expression(struct lttng_event *event,
+LTTNG_EXPORT extern int lttng_event_get_filter_expression(struct lttng_event *event,
const char **filter_string);
/*
* 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);
+LTTNG_EXPORT extern int lttng_event_get_exclusion_name_count(struct lttng_event *event);
/*
* Get an LTTng event's exclusion name at a given index.
*
* Returns 0 on success, or a negative LTTng error code on error.
*/
-extern int lttng_event_get_exclusion_name(struct lttng_event *event,
+LTTNG_EXPORT 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 struct lttng_userspace_probe_location *
-lttng_event_get_userspace_probe_location(struct lttng_event *event);
+LTTNG_EXPORT 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,
+LTTNG_EXPORT extern int lttng_event_set_userspace_probe_location(struct lttng_event *event,
struct lttng_userspace_probe_location *probe_location);
/*
* Return the size (number of entries) of the "lttng_event" array. Caller must
* free events. On error a negative LTTng error code is returned.
*/
-extern int lttng_list_tracepoints(struct lttng_handle *handle,
+LTTNG_EXPORT extern int lttng_list_tracepoints(struct lttng_handle *handle,
struct lttng_event **events);
/*
* Caller must free fields. On error a negative LTTng error code is
* returned.
*/
-extern int lttng_list_tracepoint_fields(struct lttng_handle *handle,
+LTTNG_EXPORT extern int lttng_list_tracepoint_fields(struct lttng_handle *handle,
struct lttng_event_field **fields);
/*
* All events in will be of type syscall. Caller must free events. On error a
* negative LTTng error code is returned.
*/
-extern int lttng_list_syscalls(struct lttng_event **events);
+LTTNG_EXPORT extern int lttng_list_syscalls(struct lttng_event **events);
/*
* Add context to event(s) for a specific channel (or for all).
*
* Return 0 on success else a negative LTTng error code.
*/
-extern int lttng_add_context(struct lttng_handle *handle,
+LTTNG_EXPORT extern int lttng_add_context(struct lttng_handle *handle,
struct lttng_event_context *ctx, const char *event_name,
const char *channel_name);
*
* Return 0 on success else a negative LTTng error code.
*/
-extern int lttng_enable_event(struct lttng_handle *handle,
+LTTNG_EXPORT extern int lttng_enable_event(struct lttng_handle *handle,
struct lttng_event *ev, const char *channel_name);
/*
*
* Return 0 on success else a negative LTTng error code.
*/
-extern int lttng_enable_event_with_filter(struct lttng_handle *handle,
+LTTNG_EXPORT extern int lttng_enable_event_with_filter(struct lttng_handle *handle,
struct lttng_event *event, const char *channel_name,
const char *filter_expression);
*
* Return 0 on success else a negative LTTng error code.
*/
-extern int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
+LTTNG_EXPORT extern int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
struct lttng_event *event, const char *channel_name,
const char *filter_expression,
int exclusion_count, char **exclusion_names);
*
* Return 0 on success else a negative LTTng error code.
*/
-extern int lttng_disable_event(struct lttng_handle *handle,
+LTTNG_EXPORT extern int lttng_disable_event(struct lttng_handle *handle,
const char *name, const char *channel_name);
/*
*
* Return 0 on success else a negative LTTng error code.
*/
-int lttng_disable_event_ext(struct lttng_handle *handle,
+LTTNG_EXPORT extern int lttng_disable_event_ext(struct lttng_handle *handle,
struct lttng_event *ev, const char *channel_name,
const char *filter_expression);
projects / lttng-tools.git / blobdiff