[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>

/*
 * 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,
};

/*
 * 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,
};

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 {
		char padding[8];
		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);

/*
 * Get the filter string of a specific 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.
 *
 * Returns 0 on success, or a negative LTTng error code on error.
 */
extern int lttng_event_get_filter_string(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);

/*
 * 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>
	27
	28	/*
	29	* Instrumentation type of tracing event.
	30	*/
	31	enum lttng_event_type {
	32	LTTNG_EVENT_ALL = -1,
	33	LTTNG_EVENT_TRACEPOINT = 0,
	34	LTTNG_EVENT_PROBE = 1,
	35	LTTNG_EVENT_FUNCTION = 2,
	36	LTTNG_EVENT_FUNCTION_ENTRY = 3,
	37	LTTNG_EVENT_NOOP = 4,
	38	LTTNG_EVENT_SYSCALL = 5,
	39	};
	40
	41	/*
	42	* Loglevel information.
	43	*/
	44	enum lttng_loglevel_type {
	45	LTTNG_EVENT_LOGLEVEL_ALL = 0,
	46	LTTNG_EVENT_LOGLEVEL_RANGE = 1,
	47	LTTNG_EVENT_LOGLEVEL_SINGLE = 2,
	48	};
	49
	50	/*
	51	* Available loglevels.
	52	*/
	53	enum lttng_loglevel {
	54	LTTNG_LOGLEVEL_EMERG = 0,
	55	LTTNG_LOGLEVEL_ALERT = 1,
	56	LTTNG_LOGLEVEL_CRIT = 2,
	57	LTTNG_LOGLEVEL_ERR = 3,
	58	LTTNG_LOGLEVEL_WARNING = 4,
	59	LTTNG_LOGLEVEL_NOTICE = 5,
	60	LTTNG_LOGLEVEL_INFO = 6,
	61	LTTNG_LOGLEVEL_DEBUG_SYSTEM = 7,
	62	LTTNG_LOGLEVEL_DEBUG_PROGRAM = 8,
	63	LTTNG_LOGLEVEL_DEBUG_PROCESS = 9,
	64	LTTNG_LOGLEVEL_DEBUG_MODULE = 10,
	65	LTTNG_LOGLEVEL_DEBUG_UNIT = 11,
	66	LTTNG_LOGLEVEL_DEBUG_FUNCTION = 12,
	67	LTTNG_LOGLEVEL_DEBUG_LINE = 13,
68	LTTNG_LOGLEVEL_DEBUG = 14,
69	};
70
71	/*
72	* Available loglevels for the JUL domain. Those are an exact map from the
73	* class java.util.logging.Level.
74	*/
75	enum lttng_loglevel_jul {
76	LTTNG_LOGLEVEL_JUL_OFF = INT32_MAX,
77	LTTNG_LOGLEVEL_JUL_SEVERE = 1000,
78	LTTNG_LOGLEVEL_JUL_WARNING = 900,
79	LTTNG_LOGLEVEL_JUL_INFO = 800,
80	LTTNG_LOGLEVEL_JUL_CONFIG = 700,
81	LTTNG_LOGLEVEL_JUL_FINE = 500,
82	LTTNG_LOGLEVEL_JUL_FINER = 400,
83	LTTNG_LOGLEVEL_JUL_FINEST = 300,
84	LTTNG_LOGLEVEL_JUL_ALL = INT32_MIN,
85	};
86
5cdb6027 DG	87	/*
	88	* Available loglevels for the LOG4j domain. Those are an exact map from the
	89	* class org.apache.log4j.Level.
	90	*/
	91	enum lttng_loglevel_log4j {
	92	LTTNG_LOGLEVEL_LOG4J_OFF = INT32_MAX,
	93	LTTNG_LOGLEVEL_LOG4J_FATAL = 50000,
	94	LTTNG_LOGLEVEL_LOG4J_ERROR = 40000,
	95	LTTNG_LOGLEVEL_LOG4J_WARN = 30000,
	96	LTTNG_LOGLEVEL_LOG4J_INFO = 20000,
	97	LTTNG_LOGLEVEL_LOG4J_DEBUG = 10000,
	98	LTTNG_LOGLEVEL_LOG4J_TRACE = 5000,
	99	LTTNG_LOGLEVEL_LOG4J_ALL = INT32_MIN,
	100	};
	101
0e115563 DG	102	/*
	103	* Available loglevels for the Python domain. Those are an exact map from the
	104	* Level class.
	105	*/
	106	enum lttng_loglevel_python {
	107	LTTNG_LOGLEVEL_PYTHON_CRITICAL = 50,
	108	LTTNG_LOGLEVEL_PYTHON_ERROR = 40,
	109	LTTNG_LOGLEVEL_PYTHON_WARNING = 30,
	110	LTTNG_LOGLEVEL_PYTHON_INFO = 20,
	111	LTTNG_LOGLEVEL_PYTHON_DEBUG = 10,
	112	LTTNG_LOGLEVEL_PYTHON_NOTSET = 0,
	113	};
	114
1239a312 DG	115	/*
	116	* LTTng consumer mode
	117	*/
	118	enum lttng_event_output {
	119	LTTNG_EVENT_SPLICE = 0,
	120	LTTNG_EVENT_MMAP = 1,
	121	};
	122
	123	/* Event context possible type */
	124	enum lttng_event_context_type {
2001793c JG	125	LTTNG_EVENT_CONTEXT_PID = 0,
	126	LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1, /* Backward compat. */
	127	LTTNG_EVENT_CONTEXT_PROCNAME = 2,
	128	LTTNG_EVENT_CONTEXT_PRIO = 3,
	129	LTTNG_EVENT_CONTEXT_NICE = 4,
	130	LTTNG_EVENT_CONTEXT_VPID = 5,
	131	LTTNG_EVENT_CONTEXT_TID = 6,
	132	LTTNG_EVENT_CONTEXT_VTID = 7,
	133	LTTNG_EVENT_CONTEXT_PPID = 8,
	134	LTTNG_EVENT_CONTEXT_VPPID = 9,
	135	LTTNG_EVENT_CONTEXT_PTHREAD_ID = 10,
	136	LTTNG_EVENT_CONTEXT_HOSTNAME = 11,
	137	LTTNG_EVENT_CONTEXT_IP = 12,
	138	LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER = 13,
1239a312	139	LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER = 14,
2001793c	140	LTTNG_EVENT_CONTEXT_APP_CONTEXT = 15,
1239a312 DG	141	};
	142
	143	enum lttng_event_field_type {
	144	LTTNG_EVENT_FIELD_OTHER = 0,
	145	LTTNG_EVENT_FIELD_INTEGER = 1,
	146	LTTNG_EVENT_FIELD_ENUM = 2,
	147	LTTNG_EVENT_FIELD_FLOAT = 3,
	148	LTTNG_EVENT_FIELD_STRING = 4,
	149	};
	150
834978fd DG	151	enum lttng_event_flag {
	152	LTTNG_EVENT_FLAG_SYSCALL_32 = (1U << 0),
	153	LTTNG_EVENT_FLAG_SYSCALL_64 = (1U << 1),
	154	};
	155
1239a312 DG	156	/*
	157	* Perf counter attributes
	158	*
	159	* The structures should be initialized to zero before use.
	160	*/
	161	#define LTTNG_PERF_EVENT_PADDING1 16
	162	struct lttng_event_perf_counter_ctx {
	163	uint32_t type;
	164	uint64_t config;
	165	char name[LTTNG_SYMBOL_NAME_LEN];
	166
	167	char padding[LTTNG_PERF_EVENT_PADDING1];
	168	};
	169
	170	/*
	171	* Event/channel context
	172	*
	173	* The structures should be initialized to zero before use.
	174	*/
	175	#define LTTNG_EVENT_CONTEXT_PADDING1 16
	176	#define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
	177	struct lttng_event_context {
	178	enum lttng_event_context_type ctx;
	179	char padding[LTTNG_EVENT_CONTEXT_PADDING1];
	180
	181	union {
	182	struct lttng_event_perf_counter_ctx perf_counter;
2001793c JG	183	struct {
	184	char *provider_name;
	185	char *ctx_name;
	186	} app_ctx;
1239a312 DG	187	char padding[LTTNG_EVENT_CONTEXT_PADDING2];
	188	} u;
	189	};
	190
	191	/*
	192	* Event probe.
	193	*
	194	* Either addr is used or symbol_name and offset.
	195	*
	196	* The structures should be initialized to zero before use.
	197	*/
	198	#define LTTNG_EVENT_PROBE_PADDING1 16
	199	struct lttng_event_probe_attr {
	200	uint64_t addr;
	201
	202	uint64_t offset;
	203	char symbol_name[LTTNG_SYMBOL_NAME_LEN];
	204
	205	char padding[LTTNG_EVENT_PROBE_PADDING1];
	206	};
	207
	208	/*
	209	* Function tracer
	210	*
	211	* The structures should be initialized to zero before use.
	212	*/
	213	#define LTTNG_EVENT_FUNCTION_PADDING1 16
	214	struct lttng_event_function_attr {
	215	char symbol_name[LTTNG_SYMBOL_NAME_LEN];
	216
	217	char padding[LTTNG_EVENT_FUNCTION_PADDING1];
	218	};
	219
	220	/*
	221	* Generic lttng event
	222	*
	223	* The structures should be initialized to zero before use.
	224	*/
fe9ecacb	225	#define LTTNG_EVENT_PADDING1 12
1239a312 DG	226	#define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
1239a312 DG	227	struct lttng_event {
fe9ecacb	228	/* Offset 0 */
1239a312	229	enum lttng_event_type type;
fe9ecacb PP	230
fe9ecacb PP	231	/* Offset 4 */
1239a312 DG	232	char name[LTTNG_SYMBOL_NAME_LEN];
1239a312 DG	233
fe9ecacb	234	/* Offset 260 */
1239a312	235	enum lttng_loglevel_type loglevel_type;
fe9ecacb PP	236
fe9ecacb PP	237	/* Offset 264 */
1239a312 DG	238	int loglevel;
1239a312 DG	239
fe9ecacb	240	/* Offset 268 */
1239a312	241	int32_t enabled; /* Does not apply: -1 */
fe9ecacb PP	242
fe9ecacb PP	243	/* Offset 272 */
1239a312	244	pid_t pid;
fe9ecacb PP	245
fe9ecacb PP	246	/* Offset 276 */
1239a312	247	unsigned char filter; /* filter enabled ? */
fe9ecacb PP	248
fe9ecacb PP	249	/* Offset 277 */
1239a312 DG	250	unsigned char exclusion; /* exclusions added ? */
1239a312 DG	251
fe9ecacb PP	252	/* Offset 278 */
	253	char padding2[2];
	254
	255	/* Offset 280 */
834978fd DG	256	/* Event flag, from 2.6 and above. */
	257	enum lttng_event_flag flags;
	258
fe9ecacb	259	/* Offset 284 */
b4e3ceb9 PP	260	char padding[4];
	261
	262	/* Offset 288 */
	263	union {
	264	char padding[8];
	265	void *ptr;
	266	} extended;
1239a312	267
fe9ecacb	268	/* Offset 296 */
1239a312 DG	269	/* Per event type configuration */
	270	union {
	271	struct lttng_event_probe_attr probe;
	272	struct lttng_event_function_attr ftrace;
	273
	274	char padding[LTTNG_EVENT_PADDING2];
	275	} attr;
	276	};
	277
	278	#define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32
	279	struct lttng_event_field {
	280	char field_name[LTTNG_SYMBOL_NAME_LEN];
	281	enum lttng_event_field_type type;
	282	char padding[LTTNG_EVENT_FIELD_PADDING];
	283	struct lttng_event event;
	284	int nowrite;
	285	};
	286
	287	/*
	288	* List the event(s) of a session channel.
	289	*
	290	* Both handle and channel_name CAN NOT be NULL.
	291	*
	292	* Return the size (number of entries) of the "lttng_event" array. Caller must
	293	* free events. On error a negative LTTng error code is returned.
	294	*/
	295	extern int lttng_list_events(struct lttng_handle *handle,
	296	const char channel_name, struct lttng_event *events);
	297
d31d3e8c PP	298	/*
	299	* Get the filter string of a specific LTTng event.
	300	*
	301	* If the call is successful, then the filter string's address is put
	302	* in filter_string. If the event has no filter string, filter_string
	303	* is set to NULL. The caller does NOT own *filter_string.
	304	*
	305	* Returns 0 on success, or a negative LTTng error code on error.
	306	*/
	307	extern int lttng_event_get_filter_string(struct lttng_event *event,
	308	const char **filter_string);
	309
f086e50e PP	310	/*
	311	* Get the number of exclusion names of a specific LTTng event.
	312	*
	313	* Returns the number of exclusion names on success, or a negative
	314	* LTTng error code on error.
	315	*/
	316	extern int lttng_event_get_exclusion_name_count(struct lttng_event *event);
	317
	318	/*
	319	* Get an LTTng event's exclusion name at a given index.
	320	*
	321	* If the call is successful, then the exclusion name string's address
	322	* is put in exclusion_name. The caller does NOT own exclusion_name.
	323	*
	324	* Returns 0 on success, or a negative LTTng error code on error.
	325	*/
	326	extern int lttng_event_get_exclusion_name(struct lttng_event *event,
	327	size_t index, const char **exclusion_name);
	328
1239a312 DG	329	/*
	330	* List the available tracepoints of a specific lttng domain.
	331	*
	332	* The handle CAN NOT be NULL.
	333	*
	334	* Return the size (number of entries) of the "lttng_event" array. Caller must
	335	* free events. On error a negative LTTng error code is returned.
	336	*/
	337	extern int lttng_list_tracepoints(struct lttng_handle *handle,
	338	struct lttng_event **events);
	339
	340	/*
	341	* List the available tracepoints fields of a specific lttng domain.
	342	*
	343	* The handle CAN NOT be NULL.
	344	*
	345	* Return the size (number of entries) of the "lttng_event_field" array.
	346	* Caller must free fields. On error a negative LTTng error code is
	347	* returned.
	348	*/
	349	extern int lttng_list_tracepoint_fields(struct lttng_handle *handle,
	350	struct lttng_event_field **fields);
	351
834978fd DG	352	/*
	353	* List the available kernel syscall.
	354	*
	355	* Return the size (number of entries) of the allocated "lttng_event" array.
	356	* All events in will be of type syscall. Caller must free events. On error a
	357	* negative LTTng error code is returned.
	358	*/
	359	extern int lttng_list_syscalls(struct lttng_event **events);
	360
1239a312 DG	361	/*
	362	* Add context to event(s) for a specific channel (or for all).
	363	*
	364	* If the channel_name is NULL and they are no channel for the domain, the
	365	* default channel is created (channel0). The context is then added on ALL
	366	* channels since no name was specified.
	367	*
	368	* The event_name is ignored since adding a context to an event is not possible
	369	* for now.
	370	*
	371	* Return 0 on success else a negative LTTng error code.
	372	*/
	373	extern int lttng_add_context(struct lttng_handle *handle,
	374	struct lttng_event_context ctx, const char event_name,
	375	const char *channel_name);
	376
	377	/*
	378	* Create or enable an event (or events) for a channel.
	379	*
	380	* If the event you are trying to enable does not exist, it will be created,
	381	* else it is enabled. If channel_name is NULL, the default channel is used
	382	* (channel0).
	383	*
	384	* The handle and ev params can not be NULL.
	385	*
	386	* Return 0 on success else a negative LTTng error code.
	387	*/
	388	extern int lttng_enable_event(struct lttng_handle *handle,
	389	struct lttng_event ev, const char channel_name);
	390
	391	/*
	392	* Create or enable an event with a specific filter.
	393	*
	394	* If the event you are trying to enable does not exist, it will be created,
	395	* else it is enabled.
	396	* If ev is NULL, all events are enabled with that filter.
	397	* If channel_name is NULL, the default channel is used (channel0) and created
	398	* if not found.
	399	* If filter_expression is NULL, an event without associated filter is
	400	* created.
	401	*
	402	* Return 0 on success else a negative LTTng error code.
	403	*/
	404	extern int lttng_enable_event_with_filter(struct lttng_handle *handle,
	405	struct lttng_event event, const char channel_name,
	406	const char *filter_expression);
	407
	408	/*
	409	* Create or enable an event with a filter and/or exclusions.
	410	*
	411	* If the event you are trying to enable does not exist, it will be created,
	412	* else it is enabled.
	413	* If ev is NULL, all events are enabled with the filter and exclusion options.
	414	* If channel_name is NULL, the default channel is used (channel0) and created
	415	* if not found.
	416	* If filter_expression is NULL, an event without associated filter is
	417	* created.
	418	* If exclusion count is zero, the event will be created without exclusions.
	419	*
	420	* Return 0 on success else a negative LTTng error code.
	421	*/
	422	extern int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
	423	struct lttng_event event, const char channel_name,
	424	const char *filter_expression,
425	int exclusion_count, char **exclusion_names);
426
427	/*
428	* Disable event(s) of a channel and domain.
429	*
430	* If name is NULL, all events are disabled.
431	* If channel_name is NULL, the default channel is used (channel0).
432	*
433	* Return 0 on success else a negative LTTng error code.
434	*/
435	extern int lttng_disable_event(struct lttng_handle *handle,
436	const char name, const char channel_name);
437
6e911cad MD	438	/*
	439	* Disable event(s) of a channel and domain.
	440	*
	441	* Takes a struct lttng_event as parameter.
	442	* If channel_name is NULL, the default channel is used (channel0).
	443	*
	444	* Currently, @filter_expression must be NULL. (disabling specific
	445	* filter expressions not implemented)
	446	* Currently, only LTTNG_EVENT_ALL and LTTNG_EVENT_SYSCALL event types
	447	* are implemented for field @ev.
	448	*
	449	* Return 0 on success else a negative LTTng error code.
	450	*/
	451	int lttng_disable_event_ext(struct lttng_handle *handle,
	452	struct lttng_event ev, const char channel_name,
	453	const char *filter_expression);
	454
1239a312 DG	455	#ifdef __cplusplus
	456	}
	457	#endif
	458
	459	#endif /* LTTNG_EVENT_H */