[lttng-tools.git] / include / lttng / event.h

/*
 * 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.
 *
 * 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

#ifdef __cplusplus
extern "C" {
#endif

#include <lttng/handle.h>
#include <lttng/userspace-probe.h>

/*
 * Instrumentation type of tracing event.
 */
enum lttng_event_type {
	LTTNG_EVENT_ALL                       = -1,
	LTTNG_EVENT_TRACEPOINT                = 0,
	LTTNG_EVENT_PROBE                     = 1,
	LTTNG_EVENT_FUNCTION                  = 2,
	LTTNG_EVENT_FUNCTION_ENTRY            = 3,
	LTTNG_EVENT_NOOP                      = 4,
	LTTNG_EVENT_SYSCALL                   = 5,
	LTTNG_EVENT_USERSPACE_PROBE           = 6,
};

/*
 * Loglevel information.
 */
enum lttng_loglevel_type {
	LTTNG_EVENT_LOGLEVEL_ALL              = 0,
	LTTNG_EVENT_LOGLEVEL_RANGE            = 1,
	LTTNG_EVENT_LOGLEVEL_SINGLE           = 2,
};

/*
 * Available loglevels.
 */
enum lttng_loglevel {
	LTTNG_LOGLEVEL_EMERG                  = 0,
	LTTNG_LOGLEVEL_ALERT                  = 1,
	LTTNG_LOGLEVEL_CRIT                   = 2,
	LTTNG_LOGLEVEL_ERR                    = 3,
	LTTNG_LOGLEVEL_WARNING                = 4,
	LTTNG_LOGLEVEL_NOTICE                 = 5,
	LTTNG_LOGLEVEL_INFO                   = 6,
	LTTNG_LOGLEVEL_DEBUG_SYSTEM           = 7,
	LTTNG_LOGLEVEL_DEBUG_PROGRAM          = 8,
	LTTNG_LOGLEVEL_DEBUG_PROCESS          = 9,
	LTTNG_LOGLEVEL_DEBUG_MODULE           = 10,
	LTTNG_LOGLEVEL_DEBUG_UNIT             = 11,
	LTTNG_LOGLEVEL_DEBUG_FUNCTION         = 12,
	LTTNG_LOGLEVEL_DEBUG_LINE             = 13,
	LTTNG_LOGLEVEL_DEBUG                  = 14,
};

/*
 * Available loglevels for the JUL domain. Those are an exact map from the
 * class java.util.logging.Level.
 */
enum lttng_loglevel_jul {
	LTTNG_LOGLEVEL_JUL_OFF                = INT32_MAX,
	LTTNG_LOGLEVEL_JUL_SEVERE             = 1000,
	LTTNG_LOGLEVEL_JUL_WARNING            = 900,
	LTTNG_LOGLEVEL_JUL_INFO               = 800,
	LTTNG_LOGLEVEL_JUL_CONFIG             = 700,
	LTTNG_LOGLEVEL_JUL_FINE               = 500,
	LTTNG_LOGLEVEL_JUL_FINER              = 400,
	LTTNG_LOGLEVEL_JUL_FINEST             = 300,
	LTTNG_LOGLEVEL_JUL_ALL                = INT32_MIN,
};

/*
 * Available loglevels for the LOG4j domain. Those are an exact map from the
 * class org.apache.log4j.Level.
 */
enum lttng_loglevel_log4j {
	LTTNG_LOGLEVEL_LOG4J_OFF              = INT32_MAX,
	LTTNG_LOGLEVEL_LOG4J_FATAL            = 50000,
	LTTNG_LOGLEVEL_LOG4J_ERROR            = 40000,
	LTTNG_LOGLEVEL_LOG4J_WARN             = 30000,
	LTTNG_LOGLEVEL_LOG4J_INFO             = 20000,
	LTTNG_LOGLEVEL_LOG4J_DEBUG            = 10000,
	LTTNG_LOGLEVEL_LOG4J_TRACE            = 5000,
	LTTNG_LOGLEVEL_LOG4J_ALL              = INT32_MIN,
};

/*
 * Available loglevels for the Python domain. Those are an exact map from the
 * Level class.
 */
enum lttng_loglevel_python {
	LTTNG_LOGLEVEL_PYTHON_CRITICAL        = 50,
	LTTNG_LOGLEVEL_PYTHON_ERROR           = 40,
	LTTNG_LOGLEVEL_PYTHON_WARNING         = 30,
	LTTNG_LOGLEVEL_PYTHON_INFO            = 20,
	LTTNG_LOGLEVEL_PYTHON_DEBUG           = 10,
	LTTNG_LOGLEVEL_PYTHON_NOTSET          = 0,
};

/*
 * LTTng consumer mode
 */
enum lttng_event_output {
	LTTNG_EVENT_SPLICE                    = 0,
	LTTNG_EVENT_MMAP                      = 1,
};

/* Event context possible type */
enum lttng_event_context_type {
	LTTNG_EVENT_CONTEXT_PID			= 0,
	LTTNG_EVENT_CONTEXT_PERF_COUNTER	= 1,	/* Backward compat. */
	LTTNG_EVENT_CONTEXT_PROCNAME		= 2,
	LTTNG_EVENT_CONTEXT_PRIO		= 3,
	LTTNG_EVENT_CONTEXT_NICE		= 4,
	LTTNG_EVENT_CONTEXT_VPID		= 5,
	LTTNG_EVENT_CONTEXT_TID			= 6,
	LTTNG_EVENT_CONTEXT_VTID		= 7,
	LTTNG_EVENT_CONTEXT_PPID		= 8,
	LTTNG_EVENT_CONTEXT_VPPID		= 9,
	LTTNG_EVENT_CONTEXT_PTHREAD_ID		= 10,
	LTTNG_EVENT_CONTEXT_HOSTNAME		= 11,
	LTTNG_EVENT_CONTEXT_IP			= 12,
	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. */
};

enum lttng_event_field_type {
	LTTNG_EVENT_FIELD_OTHER               = 0,
	LTTNG_EVENT_FIELD_INTEGER             = 1,
	LTTNG_EVENT_FIELD_ENUM                = 2,
	LTTNG_EVENT_FIELD_FLOAT               = 3,
	LTTNG_EVENT_FIELD_STRING              = 4,
};

enum lttng_event_flag {
	LTTNG_EVENT_FLAG_SYSCALL_32           = (1U << 0),
	LTTNG_EVENT_FLAG_SYSCALL_64           = (1U << 1),
};

/*
 * Perf counter attributes
 *
 * The structures should be initialized to zero before use.
 */
#define LTTNG_PERF_EVENT_PADDING1          16
struct lttng_event_perf_counter_ctx {
	uint32_t type;
	uint64_t config;
	char name[LTTNG_SYMBOL_NAME_LEN];

	char padding[LTTNG_PERF_EVENT_PADDING1];
};

/*
 * Event/channel context
 *
 * The structures should be initialized to zero before use.
 */
#define LTTNG_EVENT_CONTEXT_PADDING1       16
#define LTTNG_EVENT_CONTEXT_PADDING2       LTTNG_SYMBOL_NAME_LEN + 32
struct lttng_event_context {
	enum lttng_event_context_type ctx;
	char padding[LTTNG_EVENT_CONTEXT_PADDING1];

	union {
		struct lttng_event_perf_counter_ctx perf_counter;
		struct {
			char *provider_name;
			char *ctx_name;
		} app_ctx;
		char padding[LTTNG_EVENT_CONTEXT_PADDING2];
	} u;
};

/*
 * Event probe.
 *
 * Either addr is used or symbol_name and offset.
 *
 * The structures should be initialized to zero before use.
 */
#define LTTNG_EVENT_PROBE_PADDING1         16
struct lttng_event_probe_attr {
	uint64_t addr;

	uint64_t offset;
	char symbol_name[LTTNG_SYMBOL_NAME_LEN];

	char padding[LTTNG_EVENT_PROBE_PADDING1];
};

/*
 * Function tracer
 *
 * The structures should be initialized to zero before use.
 */
#define LTTNG_EVENT_FUNCTION_PADDING1      16
struct lttng_event_function_attr {
	char symbol_name[LTTNG_SYMBOL_NAME_LEN];

	char padding[LTTNG_EVENT_FUNCTION_PADDING1];
};

/*
 * Generic lttng event
 *
 * The structures should be initialized to zero before use.
 */
#define LTTNG_EVENT_PADDING1               12
#define LTTNG_EVENT_PADDING2               LTTNG_SYMBOL_NAME_LEN + 32
struct lttng_event {
	/* Offset 0 */
	enum lttng_event_type type;

	/* Offset 4 */
	char name[LTTNG_SYMBOL_NAME_LEN];

	/* Offset 260 */
	enum lttng_loglevel_type loglevel_type;

	/* Offset 264 */
	int loglevel;

	/* Offset 268 */
	int32_t enabled;	/* Does not apply: -1 */

	/* Offset 272 */
	pid_t pid;

	/* Offset 276 */
	unsigned char filter;	/* filter enabled ? */

	/* Offset 277 */
	unsigned char exclusion; /* exclusions added ? */

	/* Offset 278 */
	char padding2[2];

	/* Offset 280 */
	/* Event flag, from 2.6 and above. */
	enum lttng_event_flag flags;

	/* Offset 284 */
	char padding[4];

	/* Offset 288 */
	union {
		uint64_t padding;
		void *ptr;
	} extended;

	/* Offset 296 */
	/* Per event type configuration */
	union {
		struct lttng_event_probe_attr probe;
		struct lttng_event_function_attr ftrace;

		char padding[LTTNG_EVENT_PADDING2];
	} attr;
};

#define LTTNG_EVENT_FIELD_PADDING	LTTNG_SYMBOL_NAME_LEN + 32
struct lttng_event_field {
	char field_name[LTTNG_SYMBOL_NAME_LEN];
	enum lttng_event_field_type type;
	char padding[LTTNG_EVENT_FIELD_PADDING];
	struct lttng_event event;
	int nowrite;
};

/*
 * List the event(s) of a session channel.
 *
 * Both handle and channel_name CAN NOT be NULL.
 *
 * 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,
		const char *channel_name, struct lttng_event **events);

/*
 * 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.
 *
 * 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_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.
 *
 * The handle CAN NOT be NULL.
 *
 * 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,
		struct lttng_event **events);

/*
 * List the available tracepoints fields of a specific lttng domain.
 *
 * The handle CAN NOT be NULL.
 *
 * Return the size (number of entries) of the "lttng_event_field" array.
 * Caller must free fields. On error a negative LTTng error code is
 * returned.
 */
extern int lttng_list_tracepoint_fields(struct lttng_handle *handle,
		struct lttng_event_field **fields);

/*
 * List the available kernel syscall.
 *
 * Return the size (number of entries) of the allocated "lttng_event" array.
 * 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);

/*
 * Add context to event(s) for a specific channel (or for all).
 *
 * If the channel_name is NULL and they are no channel for the domain, the
 * default channel is created (channel0). The context is then added on ALL
 * channels since no name was specified.
 *
 * The event_name is ignored since adding a context to an event is not possible
 * for now.
 *
 * Return 0 on success else a negative LTTng error code.
 */
extern int lttng_add_context(struct lttng_handle *handle,
		struct lttng_event_context *ctx, const char *event_name,
		const char *channel_name);

/*
 * Create or enable an event (or events) for a channel.
 *
 * If the event you are trying to enable does not exist, it will be created,
 * else it is enabled. If channel_name is NULL, the default channel is used
 * (channel0).
 *
 * The handle and ev params can not be NULL.
 *
 * Return 0 on success else a negative LTTng error code.
 */
extern int lttng_enable_event(struct lttng_handle *handle,
		struct lttng_event *ev, const char *channel_name);

/*
 * Create or enable an event with a specific filter.
 *
 * If the event you are trying to enable does not exist, it will be created,
 * else it is enabled.
 * If ev is NULL, all events are enabled with that filter.
 * If channel_name is NULL, the default channel is used (channel0) and created
 * if not found.
 * If filter_expression is NULL, an event without associated filter is
 * created.
 *
 * Return 0 on success else a negative LTTng error code.
 */
extern int lttng_enable_event_with_filter(struct lttng_handle *handle,
		struct lttng_event *event, const char *channel_name,
		const char *filter_expression);

/*
 * Create or enable an event with a filter and/or exclusions.
 *
 * If the event you are trying to enable does not exist, it will be created,
 * else it is enabled.
 * If ev is NULL, all events are enabled with the filter and exclusion options.
 * If channel_name is NULL, the default channel is used (channel0) and created
 * if not found.
 * If filter_expression is NULL, an event without associated filter is
 * created.
 * If exclusion count is zero, the event will be created without exclusions.
 *
 * Return 0 on success else a negative LTTng error code.
 */
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);

/*
 * Disable event(s) of a channel and domain.
 *
 * If name is NULL, all events are disabled.
 * If channel_name is NULL, the default channel is used (channel0).
 *
 * Return 0 on success else a negative LTTng error code.
 */
extern int lttng_disable_event(struct lttng_handle *handle,
		const char *name, const char *channel_name);

/*
 * Disable event(s) of a channel and domain.
 *
 * Takes a struct lttng_event as parameter.
 * If channel_name is NULL, the default channel is used (channel0).
 *
 * Currently, @filter_expression must be NULL. (disabling specific
 * filter expressions not implemented)
 * Currently, only LTTNG_EVENT_ALL and LTTNG_EVENT_SYSCALL event types
 * are implemented for field @ev.
 *
 * Return 0 on success else a negative LTTng error code.
 */
int lttng_disable_event_ext(struct lttng_handle *handle,
		struct lttng_event *ev, const char *channel_name,
		const char *filter_expression);

#ifdef __cplusplus
}
#endif

#endif /* LTTNG_EVENT_H */
Commit	Line	Data
1239a312 DG	1	/*
1239a312 DG	2	* Copyright (C) 2014 - David Goulet <dgoulet@efficios.com>
2001793c	3	* Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
1239a312 DG	4	*
	5	* This library is free software; you can redistribute it and/or modify it
	6	* under the terms of the GNU Lesser General Public License, version 2.1 only,
	7	* as published by the Free Software Foundation.
	8	*
	9	* This library is distributed in the hope that it will be useful, but WITHOUT
	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
	12	* for more details.
	13	*
	14	* You should have received a copy of the GNU Lesser General Public License
	15	* along with this library; if not, write to the Free Software Foundation,
	16	* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
	17	*/
	18
	19	#ifndef LTTNG_EVENT_H
	20	#define LTTNG_EVENT_H
	21
	22	#ifdef __cplusplus
	23	extern "C" {
	24	#endif
	25
	26	#include <lttng/handle.h>
ef0e06bc	27	#include <lttng/userspace-probe.h>
1239a312 DG	28
	29	/*
	30	* Instrumentation type of tracing event.
	31	*/
	32	enum lttng_event_type {
	33	LTTNG_EVENT_ALL = -1,
	34	LTTNG_EVENT_TRACEPOINT = 0,
	35	LTTNG_EVENT_PROBE = 1,
	36	LTTNG_EVENT_FUNCTION = 2,
	37	LTTNG_EVENT_FUNCTION_ENTRY = 3,
	38	LTTNG_EVENT_NOOP = 4,
	39	LTTNG_EVENT_SYSCALL = 5,
410b78a0	40	LTTNG_EVENT_USERSPACE_PROBE = 6,
1239a312 DG	41	};
	42
	43	/*
	44	* Loglevel information.
	45	*/
	46	enum lttng_loglevel_type {
	47	LTTNG_EVENT_LOGLEVEL_ALL = 0,
	48	LTTNG_EVENT_LOGLEVEL_RANGE = 1,
	49	LTTNG_EVENT_LOGLEVEL_SINGLE = 2,
	50	};
	51
	52	/*
	53	* Available loglevels.
	54	*/
	55	enum lttng_loglevel {
	56	LTTNG_LOGLEVEL_EMERG = 0,
	57	LTTNG_LOGLEVEL_ALERT = 1,
	58	LTTNG_LOGLEVEL_CRIT = 2,
	59	LTTNG_LOGLEVEL_ERR = 3,
	60	LTTNG_LOGLEVEL_WARNING = 4,
	61	LTTNG_LOGLEVEL_NOTICE = 5,
	62	LTTNG_LOGLEVEL_INFO = 6,
	63	LTTNG_LOGLEVEL_DEBUG_SYSTEM = 7,
	64	LTTNG_LOGLEVEL_DEBUG_PROGRAM = 8,
	65	LTTNG_LOGLEVEL_DEBUG_PROCESS = 9,
	66	LTTNG_LOGLEVEL_DEBUG_MODULE = 10,
	67	LTTNG_LOGLEVEL_DEBUG_UNIT = 11,
	68	LTTNG_LOGLEVEL_DEBUG_FUNCTION = 12,
	69	LTTNG_LOGLEVEL_DEBUG_LINE = 13,
	70	LTTNG_LOGLEVEL_DEBUG = 14,
	71	};
	72
	73	/*
	74	* Available loglevels for the JUL domain. Those are an exact map from the
	75	* class java.util.logging.Level.
	76	*/
	77	enum lttng_loglevel_jul {
	78	LTTNG_LOGLEVEL_JUL_OFF = INT32_MAX,
	79	LTTNG_LOGLEVEL_JUL_SEVERE = 1000,
	80	LTTNG_LOGLEVEL_JUL_WARNING = 900,
	81	LTTNG_LOGLEVEL_JUL_INFO = 800,
	82	LTTNG_LOGLEVEL_JUL_CONFIG = 700,
	83	LTTNG_LOGLEVEL_JUL_FINE = 500,
	84	LTTNG_LOGLEVEL_JUL_FINER = 400,
	85	LTTNG_LOGLEVEL_JUL_FINEST = 300,
	86	LTTNG_LOGLEVEL_JUL_ALL = INT32_MIN,
	87	};
	88
5cdb6027 DG	89	/*
	90	* Available loglevels for the LOG4j domain. Those are an exact map from the
	91	* class org.apache.log4j.Level.
	92	*/
	93	enum lttng_loglevel_log4j {
	94	LTTNG_LOGLEVEL_LOG4J_OFF = INT32_MAX,
	95	LTTNG_LOGLEVEL_LOG4J_FATAL = 50000,
	96	LTTNG_LOGLEVEL_LOG4J_ERROR = 40000,
	97	LTTNG_LOGLEVEL_LOG4J_WARN = 30000,
	98	LTTNG_LOGLEVEL_LOG4J_INFO = 20000,
	99	LTTNG_LOGLEVEL_LOG4J_DEBUG = 10000,
	100	LTTNG_LOGLEVEL_LOG4J_TRACE = 5000,
	101	LTTNG_LOGLEVEL_LOG4J_ALL = INT32_MIN,
	102	};
	103
0e115563 DG	104	/*
	105	* Available loglevels for the Python domain. Those are an exact map from the
	106	* Level class.
	107	*/
	108	enum lttng_loglevel_python {
	109	LTTNG_LOGLEVEL_PYTHON_CRITICAL = 50,
	110	LTTNG_LOGLEVEL_PYTHON_ERROR = 40,
	111	LTTNG_LOGLEVEL_PYTHON_WARNING = 30,
	112	LTTNG_LOGLEVEL_PYTHON_INFO = 20,
	113	LTTNG_LOGLEVEL_PYTHON_DEBUG = 10,
	114	LTTNG_LOGLEVEL_PYTHON_NOTSET = 0,
	115	};
	116
1239a312 DG	117	/*
	118	* LTTng consumer mode
	119	*/
	120	enum lttng_event_output {
	121	LTTNG_EVENT_SPLICE = 0,
	122	LTTNG_EVENT_MMAP = 1,
	123	};
	124
	125	/* Event context possible type */
	126	enum lttng_event_context_type {
2001793c JG	127	LTTNG_EVENT_CONTEXT_PID = 0,
	128	LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1, /* Backward compat. */
	129	LTTNG_EVENT_CONTEXT_PROCNAME = 2,
	130	LTTNG_EVENT_CONTEXT_PRIO = 3,
	131	LTTNG_EVENT_CONTEXT_NICE = 4,
	132	LTTNG_EVENT_CONTEXT_VPID = 5,
	133	LTTNG_EVENT_CONTEXT_TID = 6,
	134	LTTNG_EVENT_CONTEXT_VTID = 7,
	135	LTTNG_EVENT_CONTEXT_PPID = 8,
	136	LTTNG_EVENT_CONTEXT_VPPID = 9,
	137	LTTNG_EVENT_CONTEXT_PTHREAD_ID = 10,
	138	LTTNG_EVENT_CONTEXT_HOSTNAME = 11,
	139	LTTNG_EVENT_CONTEXT_IP = 12,
	140	LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER = 13,
1239a312	141	LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER = 14,
2001793c	142	LTTNG_EVENT_CONTEXT_APP_CONTEXT = 15,
1ae5e83e JD	143	LTTNG_EVENT_CONTEXT_INTERRUPTIBLE = 16,
	144	LTTNG_EVENT_CONTEXT_PREEMPTIBLE = 17,
	145	LTTNG_EVENT_CONTEXT_NEED_RESCHEDULE = 18,
	146	LTTNG_EVENT_CONTEXT_MIGRATABLE = 19,
373148e9 FG	147	LTTNG_EVENT_CONTEXT_CALLSTACK_KERNEL = 20,
373148e9 FG	148	LTTNG_EVENT_CONTEXT_CALLSTACK_USER = 21, /* Supported on x86_32 and x86_64 only. */
1239a312 DG	149	};
	150
	151	enum lttng_event_field_type {
	152	LTTNG_EVENT_FIELD_OTHER = 0,
	153	LTTNG_EVENT_FIELD_INTEGER = 1,
	154	LTTNG_EVENT_FIELD_ENUM = 2,
	155	LTTNG_EVENT_FIELD_FLOAT = 3,
	156	LTTNG_EVENT_FIELD_STRING = 4,
	157	};
	158
834978fd DG	159	enum lttng_event_flag {
	160	LTTNG_EVENT_FLAG_SYSCALL_32 = (1U << 0),
	161	LTTNG_EVENT_FLAG_SYSCALL_64 = (1U << 1),
	162	};
	163
1239a312 DG	164	/*
	165	* Perf counter attributes
	166	*
	167	* The structures should be initialized to zero before use.
	168	*/
	169	#define LTTNG_PERF_EVENT_PADDING1 16
	170	struct lttng_event_perf_counter_ctx {
	171	uint32_t type;
	172	uint64_t config;
	173	char name[LTTNG_SYMBOL_NAME_LEN];
	174
	175	char padding[LTTNG_PERF_EVENT_PADDING1];
	176	};
	177
	178	/*
	179	* Event/channel context
	180	*
	181	* The structures should be initialized to zero before use.
	182	*/
	183	#define LTTNG_EVENT_CONTEXT_PADDING1 16
	184	#define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
	185	struct lttng_event_context {
	186	enum lttng_event_context_type ctx;
	187	char padding[LTTNG_EVENT_CONTEXT_PADDING1];
	188
	189	union {
	190	struct lttng_event_perf_counter_ctx perf_counter;
2001793c JG	191	struct {
	192	char *provider_name;
	193	char *ctx_name;
	194	} app_ctx;
1239a312 DG	195	char padding[LTTNG_EVENT_CONTEXT_PADDING2];
	196	} u;
	197	};
	198
	199	/*
	200	* Event probe.
	201	*
	202	* Either addr is used or symbol_name and offset.
	203	*
	204	* The structures should be initialized to zero before use.
	205	*/
	206	#define LTTNG_EVENT_PROBE_PADDING1 16
	207	struct lttng_event_probe_attr {
	208	uint64_t addr;
	209
	210	uint64_t offset;
	211	char symbol_name[LTTNG_SYMBOL_NAME_LEN];
	212
	213	char padding[LTTNG_EVENT_PROBE_PADDING1];
	214	};
	215
	216	/*
	217	* Function tracer
	218	*
	219	* The structures should be initialized to zero before use.
	220	*/
	221	#define LTTNG_EVENT_FUNCTION_PADDING1 16
	222	struct lttng_event_function_attr {
	223	char symbol_name[LTTNG_SYMBOL_NAME_LEN];
	224
	225	char padding[LTTNG_EVENT_FUNCTION_PADDING1];
	226	};
	227
	228	/*
	229	* Generic lttng event
	230	*
	231	* The structures should be initialized to zero before use.
	232	*/
fe9ecacb	233	#define LTTNG_EVENT_PADDING1 12
1239a312 DG	234	#define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
1239a312 DG	235	struct lttng_event {
fe9ecacb	236	/* Offset 0 */
1239a312	237	enum lttng_event_type type;
fe9ecacb PP	238
fe9ecacb PP	239	/* Offset 4 */
1239a312 DG	240	char name[LTTNG_SYMBOL_NAME_LEN];
1239a312 DG	241
fe9ecacb	242	/* Offset 260 */
1239a312	243	enum lttng_loglevel_type loglevel_type;
fe9ecacb PP	244
fe9ecacb PP	245	/* Offset 264 */
1239a312 DG	246	int loglevel;
1239a312 DG	247
fe9ecacb	248	/* Offset 268 */
1239a312	249	int32_t enabled; /* Does not apply: -1 */
fe9ecacb PP	250
fe9ecacb PP	251	/* Offset 272 */
1239a312	252	pid_t pid;
fe9ecacb PP	253
fe9ecacb PP	254	/* Offset 276 */
1239a312	255	unsigned char filter; /* filter enabled ? */
fe9ecacb PP	256
fe9ecacb PP	257	/* Offset 277 */
1239a312 DG	258	unsigned char exclusion; /* exclusions added ? */
1239a312 DG	259
fe9ecacb PP	260	/* Offset 278 */
	261	char padding2[2];
	262
	263	/* Offset 280 */
834978fd DG	264	/* Event flag, from 2.6 and above. */
	265	enum lttng_event_flag flags;
	266
fe9ecacb	267	/* Offset 284 */
b4e3ceb9 PP	268	char padding[4];
	269
	270	/* Offset 288 */
	271	union {
4829ae55	272	uint64_t padding;
b4e3ceb9 PP	273	void *ptr;
b4e3ceb9 PP	274	} extended;
1239a312	275
fe9ecacb	276	/* Offset 296 */
1239a312 DG	277	/* Per event type configuration */
	278	union {
	279	struct lttng_event_probe_attr probe;
	280	struct lttng_event_function_attr ftrace;
	281
	282	char padding[LTTNG_EVENT_PADDING2];
	283	} attr;
	284	};
	285
	286	#define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32
	287	struct lttng_event_field {
	288	char field_name[LTTNG_SYMBOL_NAME_LEN];
	289	enum lttng_event_field_type type;
	290	char padding[LTTNG_EVENT_FIELD_PADDING];
	291	struct lttng_event event;
	292	int nowrite;
	293	};
	294
	295	/*
	296	* List the event(s) of a session channel.
	297	*
	298	* Both handle and channel_name CAN NOT be NULL.
	299	*
	300	* Return the size (number of entries) of the "lttng_event" array. Caller must
	301	* free events. On error a negative LTTng error code is returned.
	302	*/
	303	extern int lttng_list_events(struct lttng_handle *handle,
	304	const char channel_name, struct lttng_event *events);
	305
c8282375 JG	306	/*
	307	* Create an lttng_event.
	308	*
	309	* This creation function, introduced in LTTng 2.11, works around
	310	* the fact that the layout of the 'lttng_event' is publicly exposed.
	311	*
	312	* It allocates a larger object which exposes the same public fields
	313	* as a 'struct lttng_event', but also allows the use of the following extended
	314	* attribute setters:
	315	* - lttng_event_set_userspace_probe_location();
	316	*
	317	* Events created through this function must be destroyed using
	318	* lttng_event_destroy().
	319	*
	320	* Returns a zeroed lttng_event on success, NULL on error.
	321	*/
ef0e06bc JG	322	extern struct lttng_event *lttng_event_create(void);
ef0e06bc JG	323
c8282375 JG	324	/*
	325	* Destroy an lttng_event.
	326	*
	327	* This destruction function, introduced in LTTng 2.11, should only
	328	* be used with events created by lttng_event_create().
	329	*/
ef0e06bc JG	330	extern void lttng_event_destroy(struct lttng_event *event);
ef0e06bc JG	331
d31d3e8c	332	/*
134e72ed	333	* Get the filter expression of a specific LTTng event.
d31d3e8c	334	*
134e72ed JG	335	* If the call is successful, then the filter expression's address is put
	336	* in *filter_expression. If the event has no filter expression,
	337	* *filter_expression is set to NULL. The caller does NOT own
	338	* *filter_expression.
d31d3e8c PP	339	*
	340	* Returns 0 on success, or a negative LTTng error code on error.
	341	*/
134e72ed	342	extern int lttng_event_get_filter_expression(struct lttng_event *event,
d31d3e8c PP	343	const char **filter_string);
d31d3e8c PP	344
f086e50e PP	345	/*
	346	* Get the number of exclusion names of a specific LTTng event.
	347	*
	348	* Returns the number of exclusion names on success, or a negative
	349	* LTTng error code on error.
	350	*/
	351	extern int lttng_event_get_exclusion_name_count(struct lttng_event *event);
	352
	353	/*
	354	* Get an LTTng event's exclusion name at a given index.
	355	*
	356	* If the call is successful, then the exclusion name string's address
	357	* is put in exclusion_name. The caller does NOT own exclusion_name.
	358	*
	359	* Returns 0 on success, or a negative LTTng error code on error.
	360	*/
	361	extern int lttng_event_get_exclusion_name(struct lttng_event *event,
	362	size_t index, const char **exclusion_name);
	363
ef0e06bc JG	364	/*
	365	* Get the userspace probe location of a specific LTTng event.
	366	* If the call is successful, then a pointer to the probe location is returned.
	367	* If the event has no probe location a NULL pointer is returned. The caller
	368	* does not own the returned probe location.
	369	*/
87597c2c JG	370	extern const struct lttng_userspace_probe_location *
87597c2c JG	371	lttng_event_get_userspace_probe_location(const struct lttng_event *event);
ef0e06bc JG	372
	373	/*
	374	* Set an LTTng event's userspace probe location.
c8282375	375	*
ef0e06bc JG	376	* If the call is successful, then the probe location is set to the event. The
	377	* ownership of the probe_location is given to the event.
	378	*
c8282375 JG	379	* Note that the event must have been created using 'lttng_event_create()' in
	380	* order for this call to succeed.
	381	*
ef0e06bc JG	382	* Returns 0 on success, or a negative LTTng error code on error.
	383	*/
	384	extern int lttng_event_set_userspace_probe_location(struct lttng_event *event,
	385	struct lttng_userspace_probe_location *probe_location);
	386
1239a312 DG	387	/*
	388	* List the available tracepoints of a specific lttng domain.
	389	*
	390	* The handle CAN NOT be NULL.
	391	*
	392	* Return the size (number of entries) of the "lttng_event" array. Caller must
	393	* free events. On error a negative LTTng error code is returned.
	394	*/
	395	extern int lttng_list_tracepoints(struct lttng_handle *handle,
	396	struct lttng_event **events);
	397
	398	/*
	399	* List the available tracepoints fields of a specific lttng domain.
	400	*
	401	* The handle CAN NOT be NULL.
	402	*
	403	* Return the size (number of entries) of the "lttng_event_field" array.
	404	* Caller must free fields. On error a negative LTTng error code is
	405	* returned.
	406	*/
	407	extern int lttng_list_tracepoint_fields(struct lttng_handle *handle,
	408	struct lttng_event_field **fields);
	409
834978fd DG	410	/*
	411	* List the available kernel syscall.
	412	*
	413	* Return the size (number of entries) of the allocated "lttng_event" array.
	414	* All events in will be of type syscall. Caller must free events. On error a
	415	* negative LTTng error code is returned.
	416	*/
	417	extern int lttng_list_syscalls(struct lttng_event **events);
	418
1239a312 DG	419	/*
	420	* Add context to event(s) for a specific channel (or for all).
	421	*
	422	* If the channel_name is NULL and they are no channel for the domain, the
	423	* default channel is created (channel0). The context is then added on ALL
	424	* channels since no name was specified.
	425	*
	426	* The event_name is ignored since adding a context to an event is not possible
	427	* for now.
	428	*
	429	* Return 0 on success else a negative LTTng error code.
	430	*/
	431	extern int lttng_add_context(struct lttng_handle *handle,
	432	struct lttng_event_context ctx, const char event_name,
	433	const char *channel_name);
	434
	435	/*
	436	* Create or enable an event (or events) for a channel.
	437	*
	438	* If the event you are trying to enable does not exist, it will be created,
	439	* else it is enabled. If channel_name is NULL, the default channel is used
	440	* (channel0).
	441	*
	442	* The handle and ev params can not be NULL.
	443	*
	444	* Return 0 on success else a negative LTTng error code.
	445	*/
	446	extern int lttng_enable_event(struct lttng_handle *handle,
	447	struct lttng_event ev, const char channel_name);
	448
	449	/*
	450	* Create or enable an event with a specific filter.
	451	*
	452	* If the event you are trying to enable does not exist, it will be created,
	453	* else it is enabled.
	454	* If ev is NULL, all events are enabled with that filter.
	455	* If channel_name is NULL, the default channel is used (channel0) and created
	456	* if not found.
	457	* If filter_expression is NULL, an event without associated filter is
	458	* created.
	459	*
	460	* Return 0 on success else a negative LTTng error code.
	461	*/
	462	extern int lttng_enable_event_with_filter(struct lttng_handle *handle,
	463	struct lttng_event event, const char channel_name,
	464	const char *filter_expression);
	465
	466	/*
	467	* Create or enable an event with a filter and/or exclusions.
	468	*
	469	* If the event you are trying to enable does not exist, it will be created,
	470	* else it is enabled.
	471	* If ev is NULL, all events are enabled with the filter and exclusion options.
	472	* If channel_name is NULL, the default channel is used (channel0) and created
	473	* if not found.
	474	* If filter_expression is NULL, an event without associated filter is
	475	* created.
	476	* If exclusion count is zero, the event will be created without exclusions.
	477	*
	478	* Return 0 on success else a negative LTTng error code.
	479	*/
	480	extern int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
	481	struct lttng_event event, const char channel_name,
	482	const char *filter_expression,
483	int exclusion_count, char **exclusion_names);
484
485	/*
486	* Disable event(s) of a channel and domain.
487	*
488	* If name is NULL, all events are disabled.
489	* If channel_name is NULL, the default channel is used (channel0).
490	*
491	* Return 0 on success else a negative LTTng error code.
492	*/
493	extern int lttng_disable_event(struct lttng_handle *handle,
494	const char name, const char channel_name);
495
6e911cad MD	496	/*
	497	* Disable event(s) of a channel and domain.
	498	*
	499	* Takes a struct lttng_event as parameter.
	500	* If channel_name is NULL, the default channel is used (channel0).
	501	*
	502	* Currently, @filter_expression must be NULL. (disabling specific
	503	* filter expressions not implemented)
	504	* Currently, only LTTNG_EVENT_ALL and LTTNG_EVENT_SYSCALL event types
	505	* are implemented for field @ev.
	506	*
	507	* Return 0 on success else a negative LTTng error code.
	508	*/
	509	int lttng_disable_event_ext(struct lttng_handle *handle,
	510	struct lttng_event ev, const char channel_name,
	511	const char *filter_expression);
	512
1239a312 DG	513	#ifdef __cplusplus
	514	}
	515	#endif
	516
	517	#endif /* LTTNG_EVENT_H */