[deliverable/lttng-ust.git] / include / lttng / ust-abi.h

#ifndef _LTTNG_UST_ABI_H
#define _LTTNG_UST_ABI_H

/*
 * lttng/ust-abi.h
 *
 * LTTng-UST ABI header
 *
 * Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include <stdint.h>
#include <lttng/ust-compiler.h>

#ifndef LTTNG_PACKED
#error "LTTNG_PACKED should be defined"
#endif

#ifndef __ust_stringify
#define __ust_stringify1(x)	#x
#define __ust_stringify(x)	__ust_stringify1(x)
#endif /* __ust_stringify */

#define LTTNG_UST_SYM_NAME_LEN			256
#define LTTNG_UST_ABI_PROCNAME_LEN		16

/* UST comm magic number, used to validate protocol and endianness. */
#define LTTNG_UST_COMM_MAGIC			0xC57C57C5

/* Version for ABI between liblttng-ust, sessiond, consumerd */
#define LTTNG_UST_ABI_MAJOR_VERSION			9
#define LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE	8
#define LTTNG_UST_ABI_MINOR_VERSION		0

enum lttng_ust_instrumentation {
	LTTNG_UST_TRACEPOINT		= 0,
	LTTNG_UST_PROBE			= 1,
	LTTNG_UST_FUNCTION		= 2,
};

enum lttng_ust_loglevel_type {
	LTTNG_UST_LOGLEVEL_ALL		= 0,
	LTTNG_UST_LOGLEVEL_RANGE	= 1,
	LTTNG_UST_LOGLEVEL_SINGLE	= 2,
};

enum lttng_ust_output {
	LTTNG_UST_MMAP		= 0,
};

enum lttng_ust_chan_type {
	LTTNG_UST_CHAN_PER_CPU = 0,
	LTTNG_UST_CHAN_METADATA = 1,
};

struct lttng_ust_tracer_version {
	uint32_t major;
	uint32_t minor;
	uint32_t patchlevel;
} LTTNG_PACKED;

#define LTTNG_UST_CHANNEL_PADDING	(LTTNG_UST_SYM_NAME_LEN + 32)
/*
 * Given that the consumerd is limited to 64k file descriptors, we
 * cannot expect much more than 1MB channel structure size. This size is
 * depends on the number of streams within a channel, which depends on
 * the number of possible CPUs on the system.
 */
#define LTTNG_UST_CHANNEL_DATA_MAX_LEN	1048576U
struct lttng_ust_channel {
	uint64_t len;
	enum lttng_ust_chan_type type;
	char padding[LTTNG_UST_CHANNEL_PADDING];
	char data[];	/* variable sized data */
} LTTNG_PACKED;

#define LTTNG_UST_STREAM_PADDING1	(LTTNG_UST_SYM_NAME_LEN + 32)
struct lttng_ust_stream {
	uint64_t len;		/* shm len */
	uint32_t stream_nr;	/* stream number */
	char padding[LTTNG_UST_STREAM_PADDING1];
	/*
	 * shm_fd and wakeup_fd are send over unix socket as file
	 * descriptors after this structure.
	 */
} LTTNG_PACKED;

#define LTTNG_UST_TRIGGER_PADDING1	16
#define LTTNG_UST_TRIGGER_PADDING2	(LTTNG_UST_SYM_NAME_LEN + 32)
struct lttng_ust_trigger {
	uint64_t id;
	uint64_t error_counter_index;
	enum lttng_ust_instrumentation instrumentation;
	char name[LTTNG_UST_SYM_NAME_LEN];	/* event name */

	enum lttng_ust_loglevel_type loglevel_type;
	int loglevel;	/* value, -1: all */
	char padding[LTTNG_UST_TRIGGER_PADDING1];

	/* Per instrumentation type configuration */
	union {
		char padding[LTTNG_UST_TRIGGER_PADDING2];
	} u;
} LTTNG_PACKED;

enum lttng_ust_counter_arithmetic {
    LTTNG_UST_COUNTER_ARITHMETIC_MODULAR    = 0,
    LTTNG_UST_COUNTER_ARITHMETIC_SATURATION = 1,
};

enum lttng_ust_counter_bitness {
    LTTNG_UST_COUNTER_BITNESS_32BITS = 4,
    LTTNG_UST_COUNTER_BITNESS_64BITS = 8,
};

struct lttng_ust_counter_dimension {
	uint64_t size;
	uint64_t underflow_index;
	uint64_t overflow_index;
	uint8_t has_underflow;
	uint8_t has_overflow;
} LTTNG_PACKED;

#define LTTNG_UST_COUNTER_DIMENSION_MAX 8
struct lttng_ust_counter_conf {
	uint32_t arithmetic;	/* enum lttng_ust_counter_arithmetic */
	uint32_t bitness;	/* enum lttng_ust_counter_bitness */
	uint32_t number_dimensions;
	int64_t global_sum_step;
	struct lttng_ust_counter_dimension dimensions[LTTNG_UST_COUNTER_DIMENSION_MAX];
} LTTNG_PACKED;

struct lttng_ust_counter_value {
	uint32_t number_dimensions;
	uint64_t dimension_indexes[LTTNG_UST_COUNTER_DIMENSION_MAX];
	int64_t value;
} LTTNG_PACKED;

#define LTTNG_TRIGGER_NOTIFICATION_PADDING 32
struct lttng_ust_trigger_notification {
	uint64_t id;
	uint16_t capture_buf_size;
	char padding[LTTNG_TRIGGER_NOTIFICATION_PADDING];
} LTTNG_PACKED;

#define LTTNG_UST_EVENT_PADDING1	16
#define LTTNG_UST_EVENT_PADDING2	(LTTNG_UST_SYM_NAME_LEN + 32)
struct lttng_ust_event {
	enum lttng_ust_instrumentation instrumentation;
	char name[LTTNG_UST_SYM_NAME_LEN];	/* event name */

	enum lttng_ust_loglevel_type loglevel_type;
	int loglevel;	/* value, -1: all */
	char padding[LTTNG_UST_EVENT_PADDING1];

	/* Per instrumentation type configuration */
	union {
		char padding[LTTNG_UST_EVENT_PADDING2];
	} u;
} LTTNG_PACKED;

#define LTTNG_UST_COUNTER_PADDING1	(LTTNG_UST_SYM_NAME_LEN + 32)
#define LTTNG_UST_COUNTER_DATA_MAX_LEN	4096U
struct lttng_ust_counter {
	uint64_t len;
	char padding[LTTNG_UST_COUNTER_PADDING1];
	char data[];	/* variable sized data */
} LTTNG_PACKED;

#define LTTNG_UST_COUNTER_GLOBAL_PADDING1	(LTTNG_UST_SYM_NAME_LEN + 32)
struct lttng_ust_counter_global {
	uint64_t len;		/* shm len */
	char padding[LTTNG_UST_COUNTER_GLOBAL_PADDING1];
} LTTNG_PACKED;

#define LTTNG_UST_COUNTER_CPU_PADDING1	(LTTNG_UST_SYM_NAME_LEN + 32)
struct lttng_ust_counter_cpu {
	uint64_t len;		/* shm len */
	uint32_t cpu_nr;
	char padding[LTTNG_UST_COUNTER_CPU_PADDING1];
} LTTNG_PACKED;

enum lttng_ust_field_type {
	LTTNG_UST_FIELD_OTHER			= 0,
	LTTNG_UST_FIELD_INTEGER			= 1,
	LTTNG_UST_FIELD_ENUM			= 2,
	LTTNG_UST_FIELD_FLOAT			= 3,
	LTTNG_UST_FIELD_STRING			= 4,
};

#define LTTNG_UST_FIELD_ITER_PADDING	(LTTNG_UST_SYM_NAME_LEN + 28)
struct lttng_ust_field_iter {
	char event_name[LTTNG_UST_SYM_NAME_LEN];
	char field_name[LTTNG_UST_SYM_NAME_LEN];
	enum lttng_ust_field_type type;
	int loglevel;				/* event loglevel */
	int nowrite;
	char padding[LTTNG_UST_FIELD_ITER_PADDING];
} LTTNG_PACKED;

enum lttng_ust_context_type {
	LTTNG_UST_CONTEXT_VTID			= 0,
	LTTNG_UST_CONTEXT_VPID			= 1,
	LTTNG_UST_CONTEXT_PTHREAD_ID		= 2,
	LTTNG_UST_CONTEXT_PROCNAME		= 3,
	LTTNG_UST_CONTEXT_IP			= 4,
	LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER	= 5,
	LTTNG_UST_CONTEXT_CPU_ID		= 6,
	LTTNG_UST_CONTEXT_APP_CONTEXT		= 7,
	LTTNG_UST_CONTEXT_CGROUP_NS		= 8,
	LTTNG_UST_CONTEXT_IPC_NS		= 9,
	LTTNG_UST_CONTEXT_MNT_NS		= 10,
	LTTNG_UST_CONTEXT_NET_NS		= 11,
	LTTNG_UST_CONTEXT_PID_NS		= 12,
	LTTNG_UST_CONTEXT_USER_NS		= 13,
	LTTNG_UST_CONTEXT_UTS_NS		= 14,
	LTTNG_UST_CONTEXT_VUID			= 15,
	LTTNG_UST_CONTEXT_VEUID			= 16,
	LTTNG_UST_CONTEXT_VSUID			= 17,
	LTTNG_UST_CONTEXT_VGID			= 18,
	LTTNG_UST_CONTEXT_VEGID			= 19,
	LTTNG_UST_CONTEXT_VSGID			= 20,
	LTTNG_UST_CONTEXT_TIME_NS		= 21,
};

struct lttng_ust_perf_counter_ctx {
	uint32_t type;
	uint64_t config;
	char name[LTTNG_UST_SYM_NAME_LEN];
} LTTNG_PACKED;

#define LTTNG_UST_CONTEXT_PADDING1	16
#define LTTNG_UST_CONTEXT_PADDING2	(LTTNG_UST_SYM_NAME_LEN + 32)
struct lttng_ust_context {
	enum lttng_ust_context_type ctx;
	char padding[LTTNG_UST_CONTEXT_PADDING1];

	union {
		struct lttng_ust_perf_counter_ctx perf_counter;
		struct {
			/* Includes trailing '\0'. */
			uint32_t provider_name_len;
			uint32_t ctx_name_len;
		} app_ctx;
		char padding[LTTNG_UST_CONTEXT_PADDING2];
	} u;
} LTTNG_PACKED;

/*
 * Tracer channel attributes.
 */
#define LTTNG_UST_CHANNEL_ATTR_PADDING	(LTTNG_UST_SYM_NAME_LEN + 32)
struct lttng_ust_channel_attr {
	uint64_t subbuf_size;			/* bytes */
	uint64_t num_subbuf;			/* power of 2 */
	int overwrite;				/* 1: overwrite, 0: discard */
	unsigned int switch_timer_interval;	/* usec */
	unsigned int read_timer_interval;	/* usec */
	enum lttng_ust_output output;		/* splice, mmap */
	union {
		struct {
			int64_t blocking_timeout;	/* Blocking timeout (usec) */
		} s;
		char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
	} u;
} LTTNG_PACKED;

#define LTTNG_UST_TRACEPOINT_ITER_PADDING	16
struct lttng_ust_tracepoint_iter {
	char name[LTTNG_UST_SYM_NAME_LEN];	/* provider:name */
	int loglevel;
	char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
} LTTNG_PACKED;

enum lttng_ust_object_type {
	LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
	LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
	LTTNG_UST_OBJECT_TYPE_STREAM = 1,
	LTTNG_UST_OBJECT_TYPE_EVENT = 2,
	LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
	LTTNG_UST_OBJECT_TYPE_TRIGGER_GROUP = 4,
	LTTNG_UST_OBJECT_TYPE_TRIGGER = 5,
	LTTNG_UST_OBJECT_TYPE_COUNTER = 6,
	LTTNG_UST_OBJECT_TYPE_COUNTER_GLOBAL = 7,
	LTTNG_UST_OBJECT_TYPE_COUNTER_CPU = 8,
};

#define LTTNG_UST_OBJECT_DATA_PADDING1	32
#define LTTNG_UST_OBJECT_DATA_PADDING2	(LTTNG_UST_SYM_NAME_LEN + 32)

struct lttng_ust_object_data {
	enum lttng_ust_object_type type;
	int handle;
	uint64_t size;
	char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
	union {
		struct {
			void *data;
			enum lttng_ust_chan_type type;
			int wakeup_fd;
		} channel;
		struct {
			int shm_fd;
			int wakeup_fd;
			uint32_t stream_nr;
		} stream;
		struct {
			void *data;
		} counter;
		struct {
			int shm_fd;
		} counter_global;
		struct {
			int shm_fd;
			uint32_t cpu_nr;
		} counter_cpu;
		char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
	} u;
} LTTNG_PACKED;

enum lttng_ust_calibrate_type {
	LTTNG_UST_CALIBRATE_TRACEPOINT,
};

#define LTTNG_UST_CALIBRATE_PADDING1	16
#define LTTNG_UST_CALIBRATE_PADDING2	(LTTNG_UST_SYM_NAME_LEN + 32)
struct lttng_ust_calibrate {
	enum lttng_ust_calibrate_type type;	/* type (input) */
	char padding[LTTNG_UST_CALIBRATE_PADDING1];

	union {
		char padding[LTTNG_UST_CALIBRATE_PADDING2];
	} u;
} LTTNG_PACKED;

#define FILTER_BYTECODE_MAX_LEN		65536
#define LTTNG_UST_FILTER_PADDING	32
struct lttng_ust_filter_bytecode {
	uint32_t len;
	uint32_t reloc_offset;
	uint64_t seqnum;
	char padding[LTTNG_UST_FILTER_PADDING];
	char data[0];
} LTTNG_PACKED;

#define CAPTURE_BYTECODE_MAX_LEN	65536
#define LTTNG_UST_CAPTURE_PADDING	32
struct lttng_ust_capture_bytecode {
	uint32_t len;
	uint32_t reloc_offset;
	uint64_t seqnum;
	char padding[LTTNG_UST_CAPTURE_PADDING];
	char data[0];
} LTTNG_PACKED;

#define LTTNG_UST_EXCLUSION_PADDING	32
struct lttng_ust_event_exclusion {
	uint32_t count;
	char padding[LTTNG_UST_EXCLUSION_PADDING];
	char names[LTTNG_UST_SYM_NAME_LEN][0];
} LTTNG_PACKED;

#define _UST_CMD(minor)				(minor)
#define _UST_CMDR(minor, type)			(minor)
#define _UST_CMDW(minor, type)			(minor)

/* Handled by object descriptor */
#define LTTNG_UST_RELEASE			_UST_CMD(0x1)

/* Handled by object cmd */

/* LTTng-UST commands */
#define LTTNG_UST_SESSION			_UST_CMD(0x40)
#define LTTNG_UST_TRACER_VERSION		\
	_UST_CMDR(0x41, struct lttng_ust_tracer_version)
#define LTTNG_UST_TRACEPOINT_LIST		_UST_CMD(0x42)
#define LTTNG_UST_WAIT_QUIESCENT		_UST_CMD(0x43)
#define LTTNG_UST_REGISTER_DONE			_UST_CMD(0x44)
#define LTTNG_UST_TRACEPOINT_FIELD_LIST		_UST_CMD(0x45)

/* Session FD commands */
#define LTTNG_UST_CHANNEL			\
	_UST_CMDW(0x51, struct lttng_ust_channel)
#define LTTNG_UST_SESSION_START			_UST_CMD(0x52)
#define LTTNG_UST_SESSION_STOP			_UST_CMD(0x53)
#define LTTNG_UST_SESSION_STATEDUMP		_UST_CMD(0x54)

/* Channel FD commands */
#define LTTNG_UST_STREAM			_UST_CMD(0x60)
#define LTTNG_UST_EVENT			\
	_UST_CMDW(0x61, struct lttng_ust_event)

/* Event and Channel FD commands */
#define LTTNG_UST_CONTEXT			\
	_UST_CMDW(0x70, struct lttng_ust_context)
#define LTTNG_UST_FLUSH_BUFFER			\
	_UST_CMD(0x71)

/* Event, Channel and Session commands */
#define LTTNG_UST_ENABLE			_UST_CMD(0x80)
#define LTTNG_UST_DISABLE			_UST_CMD(0x81)

/* Tracepoint list commands */
#define LTTNG_UST_TRACEPOINT_LIST_GET		_UST_CMD(0x90)
#define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET	_UST_CMD(0x91)

/* Event FD commands */
#define LTTNG_UST_FILTER			_UST_CMD(0xA0)
#define LTTNG_UST_EXCLUSION			_UST_CMD(0xA1)

/* Trigger commands */
#define LTTNG_UST_TRIGGER_GROUP_CREATE		_UST_CMD(0xB0)
#define LTTNG_UST_TRIGGER_CREATE		\
	_UST_CMDW(0xB1, struct lttng_ust_trigger)
#define LTTNG_UST_CAPTURE			_UST_CMD(0xB2)

/* Session and Trigger group FD commands */
#define LTTNG_UST_COUNTER			\
	_UST_CMDW(0xB3, struct lttng_ust_counter)
#define LTTNG_UST_COUNTER_GLOBAL		\
	_UST_CMDW(0xB4, struct lttng_ust_counter_global)
#define LTTNG_UST_COUNTER_CPU			\
	_UST_CMDW(0xB5, struct lttng_ust_counter_cpu)

#define LTTNG_UST_ROOT_HANDLE	0

struct lttng_ust_obj;

union ust_args {
	struct {
		void *chan_data;
		int wakeup_fd;
	} channel;
	struct {
		int shm_fd;
		int wakeup_fd;
	} stream;
	struct {
		struct lttng_ust_field_iter entry;
	} field_list;
	struct {
		char *ctxname;
	} app_context;
	struct {
		int trigger_notif_fd;
	} trigger_handle;
	struct {
		void *counter_data;
	} counter;
	struct {
		int shm_fd;
	} counter_shm;
};

struct lttng_ust_objd_ops {
	long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
		union ust_args *args, void *owner);
	int (*release)(int objd);
};

/* Create root handle. Always ID 0. */
int lttng_abi_create_root_handle(void);

const struct lttng_ust_objd_ops *objd_ops(int id);
int lttng_ust_objd_unref(int id, int is_owner);

void lttng_ust_abi_exit(void);
void lttng_ust_events_exit(void);
void lttng_ust_objd_table_owner_cleanup(void *owner);

#endif /* _LTTNG_UST_ABI_H */
Commit	Line	Data
9f3fdbc6 MD	1	#ifndef _LTTNG_UST_ABI_H
	2	#define _LTTNG_UST_ABI_H
	3
	4	/*
4318ae1b	5	* lttng/ust-abi.h
9f3fdbc6	6	*
9f3fdbc6 MD	7	* LTTng-UST ABI header
9f3fdbc6 MD	8	*
e92f3e28 MD	9	* Copyright 2010-2012 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	10	*
	11	* Permission is hereby granted, free of charge, to any person obtaining a copy
	12	* of this software and associated documentation files (the "Software"), to deal
	13	* in the Software without restriction, including without limitation the rights
	14	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	15	* copies of the Software, and to permit persons to whom the Software is
	16	* furnished to do so, subject to the following conditions:
a60d70e6	17	*
e92f3e28 MD	18	* The above copyright notice and this permission notice shall be included in
e92f3e28 MD	19	* all copies or substantial portions of the Software.
d2428e87 MD	20	*
	21	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	22	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	23	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	24	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	25	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	26	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	27	* SOFTWARE.
9f3fdbc6 MD	28	*/
9f3fdbc6 MD	29
0a42beb6	30	#include <stdint.h>
b3f60bbf	31	#include <lttng/ust-compiler.h>
0a42beb6	32
db56acaf MD	33	#ifndef LTTNG_PACKED
	34	#error "LTTNG_PACKED should be defined"
	35	#endif
	36
32ce8569 MD	37	#ifndef __ust_stringify
	38	#define __ust_stringify1(x) #x
	39	#define __ust_stringify(x) __ust_stringify1(x)
	40	#endif /* __ust_stringify */
9f3fdbc6	41
32ce8569 MD	42	#define LTTNG_UST_SYM_NAME_LEN 256
	43	#define LTTNG_UST_ABI_PROCNAME_LEN 16
	44
	45	/* UST comm magic number, used to validate protocol and endianness. */
	46	#define LTTNG_UST_COMM_MAGIC 0xC57C57C5
b35d179d	47
0f4eaec3	48	/* Version for ABI between liblttng-ust, sessiond, consumerd */
6a359b8a MD	49	#define LTTNG_UST_ABI_MAJOR_VERSION 9
	50	#define LTTNG_UST_ABI_MAJOR_VERSION_OLDEST_COMPATIBLE 8
	51	#define LTTNG_UST_ABI_MINOR_VERSION 0
0f4eaec3	52
9f3fdbc6	53	enum lttng_ust_instrumentation {
df854e41 MD	54	LTTNG_UST_TRACEPOINT = 0,
	55	LTTNG_UST_PROBE = 1,
	56	LTTNG_UST_FUNCTION = 2,
6b0e60f1 MD	57	};
	58
	59	enum lttng_ust_loglevel_type {
882a56d7 MD	60	LTTNG_UST_LOGLEVEL_ALL = 0,
	61	LTTNG_UST_LOGLEVEL_RANGE = 1,
	62	LTTNG_UST_LOGLEVEL_SINGLE = 2,
9f3fdbc6 MD	63	};
9f3fdbc6 MD	64
9f3fdbc6	65	enum lttng_ust_output {
b35d179d	66	LTTNG_UST_MMAP = 0,
9f3fdbc6 MD	67	};
9f3fdbc6 MD	68
74d81a6c MD	69	enum lttng_ust_chan_type {
	70	LTTNG_UST_CHAN_PER_CPU = 0,
	71	LTTNG_UST_CHAN_METADATA = 1,
	72	};
	73
b35d179d	74	struct lttng_ust_tracer_version {
b728d87e MD	75	uint32_t major;
b728d87e MD	76	uint32_t minor;
b35d179d	77	uint32_t patchlevel;
b3f60bbf	78	} LTTNG_PACKED;
9f3fdbc6	79
74d81a6c MD	80	#define LTTNG_UST_CHANNEL_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
	81	/*
	82	* Given that the consumerd is limited to 64k file descriptors, we
	83	* cannot expect much more than 1MB channel structure size. This size is
	84	* depends on the number of streams within a channel, which depends on
	85	* the number of possible CPUs on the system.
	86	*/
	87	#define LTTNG_UST_CHANNEL_DATA_MAX_LEN 1048576U
9f3fdbc6	88	struct lttng_ust_channel {
74d81a6c MD	89	uint64_t len;
74d81a6c MD	90	enum lttng_ust_chan_type type;
1332bb04	91	char padding[LTTNG_UST_CHANNEL_PADDING];
74d81a6c	92	char data[]; /* variable sized data */
b3f60bbf	93	} LTTNG_PACKED;
9f3fdbc6	94
74d81a6c	95	#define LTTNG_UST_STREAM_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
381c0f1e	96	struct lttng_ust_stream {
74d81a6c MD	97	uint64_t len; /* shm len */
74d81a6c MD	98	uint32_t stream_nr; /* stream number */
1332bb04	99	char padding[LTTNG_UST_STREAM_PADDING1];
74d81a6c MD	100	/*
	101	* shm_fd and wakeup_fd are send over unix socket as file
	102	* descriptors after this structure.
	103	*/
b3f60bbf	104	} LTTNG_PACKED;
381c0f1e	105
4e3b3630 JR	106	#define LTTNG_UST_TRIGGER_PADDING1 16
	107	#define LTTNG_UST_TRIGGER_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
	108	struct lttng_ust_trigger {
	109	uint64_t id;
	110	uint64_t error_counter_index;
	111	enum lttng_ust_instrumentation instrumentation;
	112	char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
	113
	114	enum lttng_ust_loglevel_type loglevel_type;
	115	int loglevel; /* value, -1: all */
	116	char padding[LTTNG_UST_TRIGGER_PADDING1];
	117
	118	/* Per instrumentation type configuration */
	119	union {
	120	char padding[LTTNG_UST_TRIGGER_PADDING2];
	121	} u;
	122	} LTTNG_PACKED;
	123
	124	enum lttng_ust_counter_arithmetic {
	125	LTTNG_UST_COUNTER_ARITHMETIC_MODULAR = 0,
	126	LTTNG_UST_COUNTER_ARITHMETIC_SATURATION = 1,
	127	};
	128
	129	enum lttng_ust_counter_bitness {
	130	LTTNG_UST_COUNTER_BITNESS_32BITS = 4,
	131	LTTNG_UST_COUNTER_BITNESS_64BITS = 8,
	132	};
	133
	134	struct lttng_ust_counter_dimension {
	135	uint64_t size;
	136	uint64_t underflow_index;
	137	uint64_t overflow_index;
	138	uint8_t has_underflow;
	139	uint8_t has_overflow;
	140	} LTTNG_PACKED;
	141
	142	#define LTTNG_UST_COUNTER_DIMENSION_MAX 8
	143	struct lttng_ust_counter_conf {
	144	uint32_t arithmetic; /* enum lttng_ust_counter_arithmetic */
	145	uint32_t bitness; /* enum lttng_ust_counter_bitness */
	146	uint32_t number_dimensions;
	147	int64_t global_sum_step;
	148	struct lttng_ust_counter_dimension dimensions[LTTNG_UST_COUNTER_DIMENSION_MAX];
	149	} LTTNG_PACKED;
	150
	151	struct lttng_ust_counter_value {
	152	uint32_t number_dimensions;
	153	uint64_t dimension_indexes[LTTNG_UST_COUNTER_DIMENSION_MAX];
	154	int64_t value;
	155	} LTTNG_PACKED;
	156
	157	#define LTTNG_TRIGGER_NOTIFICATION_PADDING 32
	158	struct lttng_ust_trigger_notification {
	159	uint64_t id;
	160	uint16_t capture_buf_size;
	161	char padding[LTTNG_TRIGGER_NOTIFICATION_PADDING];
	162	} LTTNG_PACKED;
	163
89f26d57	164	#define LTTNG_UST_EVENT_PADDING1 16
74d81a6c	165	#define LTTNG_UST_EVENT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
9f3fdbc6	166	struct lttng_ust_event {
9f3fdbc6	167	enum lttng_ust_instrumentation instrumentation;
6b0e60f1 MD	168	char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
	169
	170	enum lttng_ust_loglevel_type loglevel_type;
882a56d7	171	int loglevel; /* value, -1: all */
1332bb04	172	char padding[LTTNG_UST_EVENT_PADDING1];
6b0e60f1	173
9f3fdbc6 MD	174	/* Per instrumentation type configuration */
9f3fdbc6 MD	175	union {
1332bb04	176	char padding[LTTNG_UST_EVENT_PADDING2];
9f3fdbc6	177	} u;
b3f60bbf	178	} LTTNG_PACKED;
9f3fdbc6	179
4e3b3630 JR	180	#define LTTNG_UST_COUNTER_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
	181	#define LTTNG_UST_COUNTER_DATA_MAX_LEN 4096U
	182	struct lttng_ust_counter {
	183	uint64_t len;
	184	char padding[LTTNG_UST_COUNTER_PADDING1];
	185	char data[]; /* variable sized data */
	186	} LTTNG_PACKED;
	187
	188	#define LTTNG_UST_COUNTER_GLOBAL_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
	189	struct lttng_ust_counter_global {
	190	uint64_t len; /* shm len */
	191	char padding[LTTNG_UST_COUNTER_GLOBAL_PADDING1];
	192	} LTTNG_PACKED;
	193
	194	#define LTTNG_UST_COUNTER_CPU_PADDING1 (LTTNG_UST_SYM_NAME_LEN + 32)
	195	struct lttng_ust_counter_cpu {
	196	uint64_t len; /* shm len */
	197	uint32_t cpu_nr;
	198	char padding[LTTNG_UST_COUNTER_CPU_PADDING1];
	199	} LTTNG_PACKED;
	200
06d4f27e MD	201	enum lttng_ust_field_type {
	202	LTTNG_UST_FIELD_OTHER = 0,
	203	LTTNG_UST_FIELD_INTEGER = 1,
	204	LTTNG_UST_FIELD_ENUM = 2,
	205	LTTNG_UST_FIELD_FLOAT = 3,
	206	LTTNG_UST_FIELD_STRING = 4,
	207	};
	208
74d81a6c	209	#define LTTNG_UST_FIELD_ITER_PADDING (LTTNG_UST_SYM_NAME_LEN + 28)
06d4f27e MD	210	struct lttng_ust_field_iter {
	211	char event_name[LTTNG_UST_SYM_NAME_LEN];
	212	char field_name[LTTNG_UST_SYM_NAME_LEN];
	213	enum lttng_ust_field_type type;
	214	int loglevel; /* event loglevel */
180901e6	215	int nowrite;
06d4f27e	216	char padding[LTTNG_UST_FIELD_ITER_PADDING];
b3f60bbf	217	} LTTNG_PACKED;
06d4f27e	218
9f3fdbc6	219	enum lttng_ust_context_type {
3b402b40	220	LTTNG_UST_CONTEXT_VTID = 0,
c1ef86f0 MD	221	LTTNG_UST_CONTEXT_VPID = 1,
c1ef86f0 MD	222	LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
4847e9bb	223	LTTNG_UST_CONTEXT_PROCNAME = 3,
96f85541	224	LTTNG_UST_CONTEXT_IP = 4,
d58d1454	225	LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER = 5,
c7ea8487	226	LTTNG_UST_CONTEXT_CPU_ID = 6,
53f0df51	227	LTTNG_UST_CONTEXT_APP_CONTEXT = 7,
735bef47 MJ	228	LTTNG_UST_CONTEXT_CGROUP_NS = 8,
	229	LTTNG_UST_CONTEXT_IPC_NS = 9,
	230	LTTNG_UST_CONTEXT_MNT_NS = 10,
	231	LTTNG_UST_CONTEXT_NET_NS = 11,
	232	LTTNG_UST_CONTEXT_PID_NS = 12,
	233	LTTNG_UST_CONTEXT_USER_NS = 13,
	234	LTTNG_UST_CONTEXT_UTS_NS = 14,
fca2f191 MJ	235	LTTNG_UST_CONTEXT_VUID = 15,
	236	LTTNG_UST_CONTEXT_VEUID = 16,
	237	LTTNG_UST_CONTEXT_VSUID = 17,
	238	LTTNG_UST_CONTEXT_VGID = 18,
	239	LTTNG_UST_CONTEXT_VEGID = 19,
	240	LTTNG_UST_CONTEXT_VSGID = 20,
cefef7a7	241	LTTNG_UST_CONTEXT_TIME_NS = 21,
9f3fdbc6 MD	242	};
9f3fdbc6 MD	243
d58d1454 MD	244	struct lttng_ust_perf_counter_ctx {
	245	uint32_t type;
	246	uint64_t config;
	247	char name[LTTNG_UST_SYM_NAME_LEN];
	248	} LTTNG_PACKED;
	249
1332bb04	250	#define LTTNG_UST_CONTEXT_PADDING1 16
74d81a6c	251	#define LTTNG_UST_CONTEXT_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
9f3fdbc6 MD	252	struct lttng_ust_context {
9f3fdbc6 MD	253	enum lttng_ust_context_type ctx;
1332bb04 MD	254	char padding[LTTNG_UST_CONTEXT_PADDING1];
1332bb04 MD	255
9f3fdbc6	256	union {
d58d1454	257	struct lttng_ust_perf_counter_ctx perf_counter;
53f0df51 JG	258	struct {
	259	/* Includes trailing '\0'. */
	260	uint32_t provider_name_len;
	261	uint32_t ctx_name_len;
	262	} app_ctx;
1332bb04	263	char padding[LTTNG_UST_CONTEXT_PADDING2];
9f3fdbc6	264	} u;
b3f60bbf	265	} LTTNG_PACKED;
9f3fdbc6	266
92462b01 MD	267	/*
	268	* Tracer channel attributes.
	269	*/
74d81a6c	270	#define LTTNG_UST_CHANNEL_ATTR_PADDING (LTTNG_UST_SYM_NAME_LEN + 32)
92462b01	271	struct lttng_ust_channel_attr {
92462b01 MD	272	uint64_t subbuf_size; /* bytes */
92462b01 MD	273	uint64_t num_subbuf; /* power of 2 */
b3f60bbf	274	int overwrite; /* 1: overwrite, 0: discard */
92462b01 MD	275	unsigned int switch_timer_interval; /* usec */
	276	unsigned int read_timer_interval; /* usec */
	277	enum lttng_ust_output output; /* splice, mmap */
b2c5f61a MD	278	union {
	279	struct {
	280	int64_t blocking_timeout; /* Blocking timeout (usec) */
	281	} s;
	282	char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
	283	} u;
b3f60bbf	284	} LTTNG_PACKED;
92462b01	285
1332bb04	286	#define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
cbef6901 MD	287	struct lttng_ust_tracepoint_iter {
cbef6901 MD	288	char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */
882a56d7	289	int loglevel;
1332bb04	290	char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
b3f60bbf	291	} LTTNG_PACKED;
cbef6901	292
74d81a6c MD	293	enum lttng_ust_object_type {
	294	LTTNG_UST_OBJECT_TYPE_UNKNOWN = -1,
	295	LTTNG_UST_OBJECT_TYPE_CHANNEL = 0,
	296	LTTNG_UST_OBJECT_TYPE_STREAM = 1,
32ce8569 MD	297	LTTNG_UST_OBJECT_TYPE_EVENT = 2,
32ce8569 MD	298	LTTNG_UST_OBJECT_TYPE_CONTEXT = 3,
4e3b3630 JR	299	LTTNG_UST_OBJECT_TYPE_TRIGGER_GROUP = 4,
	300	LTTNG_UST_OBJECT_TYPE_TRIGGER = 5,
	301	LTTNG_UST_OBJECT_TYPE_COUNTER = 6,
	302	LTTNG_UST_OBJECT_TYPE_COUNTER_GLOBAL = 7,
	303	LTTNG_UST_OBJECT_TYPE_COUNTER_CPU = 8,
74d81a6c MD	304	};
	305
	306	#define LTTNG_UST_OBJECT_DATA_PADDING1 32
	307	#define LTTNG_UST_OBJECT_DATA_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
	308
92462b01	309	struct lttng_ust_object_data {
74d81a6c	310	enum lttng_ust_object_type type;
92462b01	311	int handle;
74d81a6c MD	312	uint64_t size;
	313	char padding1[LTTNG_UST_OBJECT_DATA_PADDING1];
	314	union {
	315	struct {
	316	void *data;
	317	enum lttng_ust_chan_type type;
ff0f5728	318	int wakeup_fd;
74d81a6c MD	319	} channel;
	320	struct {
	321	int shm_fd;
	322	int wakeup_fd;
	323	uint32_t stream_nr;
	324	} stream;
4e3b3630 JR	325	struct {
	326	void *data;
	327	} counter;
	328	struct {
	329	int shm_fd;
	330	} counter_global;
	331	struct {
	332	int shm_fd;
	333	uint32_t cpu_nr;
	334	} counter_cpu;
74d81a6c MD	335	char padding2[LTTNG_UST_OBJECT_DATA_PADDING2];
74d81a6c MD	336	} u;
b3f60bbf	337	} LTTNG_PACKED;
92462b01	338
d9a9a33b MD	339	enum lttng_ust_calibrate_type {
	340	LTTNG_UST_CALIBRATE_TRACEPOINT,
	341	};
	342
1332bb04	343	#define LTTNG_UST_CALIBRATE_PADDING1 16
74d81a6c	344	#define LTTNG_UST_CALIBRATE_PADDING2 (LTTNG_UST_SYM_NAME_LEN + 32)
d9a9a33b MD	345	struct lttng_ust_calibrate {
d9a9a33b MD	346	enum lttng_ust_calibrate_type type; /* type (input) */
1332bb04 MD	347	char padding[LTTNG_UST_CALIBRATE_PADDING1];
	348
	349	union {
	350	char padding[LTTNG_UST_CALIBRATE_PADDING2];
	351	} u;
b3f60bbf	352	} LTTNG_PACKED;
d9a9a33b	353
5b4839a8	354	#define FILTER_BYTECODE_MAX_LEN 65536
a5930599	355	#define LTTNG_UST_FILTER_PADDING 32
2d78951a	356	struct lttng_ust_filter_bytecode {
2734ca65 CB	357	uint32_t len;
2734ca65 CB	358	uint32_t reloc_offset;
3f6fd224	359	uint64_t seqnum;
a5930599	360	char padding[LTTNG_UST_FILTER_PADDING];
2d78951a	361	char data[0];
b3f60bbf	362	} LTTNG_PACKED;
2d78951a	363
4e3b3630 JR	364	#define CAPTURE_BYTECODE_MAX_LEN 65536
	365	#define LTTNG_UST_CAPTURE_PADDING 32
	366	struct lttng_ust_capture_bytecode {
	367	uint32_t len;
	368	uint32_t reloc_offset;
	369	uint64_t seqnum;
	370	char padding[LTTNG_UST_CAPTURE_PADDING];
	371	char data[0];
	372	} LTTNG_PACKED;
	373
86e0c24e JI	374	#define LTTNG_UST_EXCLUSION_PADDING 32
	375	struct lttng_ust_event_exclusion {
	376	uint32_t count;
	377	char padding[LTTNG_UST_EXCLUSION_PADDING];
	378	char names[LTTNG_UST_SYM_NAME_LEN][0];
	379	} LTTNG_PACKED;
	380
9f3fdbc6 MD	381	#define _UST_CMD(minor) (minor)
	382	#define _UST_CMDR(minor, type) (minor)
	383	#define _UST_CMDW(minor, type) (minor)
	384
46050b1a MD	385	/* Handled by object descriptor */
	386	#define LTTNG_UST_RELEASE _UST_CMD(0x1)
	387
	388	/* Handled by object cmd */
	389
9f3fdbc6 MD	390	/* LTTng-UST commands */
	391	#define LTTNG_UST_SESSION _UST_CMD(0x40)
	392	#define LTTNG_UST_TRACER_VERSION \
	393	_UST_CMDR(0x41, struct lttng_ust_tracer_version)
	394	#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
	395	#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
11ff9c7d	396	#define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
06d4f27e	397	#define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
9f3fdbc6	398
46050b1a	399	/* Session FD commands */
9f3fdbc6 MD	400	#define LTTNG_UST_CHANNEL \
	401	_UST_CMDW(0x51, struct lttng_ust_channel)
	402	#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
	403	#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
710b8ee3	404	#define LTTNG_UST_SESSION_STATEDUMP _UST_CMD(0x54)
9f3fdbc6	405
46050b1a	406	/* Channel FD commands */
9f3fdbc6 MD	407	#define LTTNG_UST_STREAM _UST_CMD(0x60)
	408	#define LTTNG_UST_EVENT \
	409	_UST_CMDW(0x61, struct lttng_ust_event)
	410
46050b1a	411	/* Event and Channel FD commands */
9f3fdbc6 MD	412	#define LTTNG_UST_CONTEXT \
9f3fdbc6 MD	413	_UST_CMDW(0x70, struct lttng_ust_context)
43d330a4	414	#define LTTNG_UST_FLUSH_BUFFER \
43861eab	415	_UST_CMD(0x71)
9f3fdbc6	416
46050b1a	417	/* Event, Channel and Session commands */
9f3fdbc6 MD	418	#define LTTNG_UST_ENABLE _UST_CMD(0x80)
	419	#define LTTNG_UST_DISABLE _UST_CMD(0x81)
	420
51489cad MD	421	/* Tracepoint list commands */
51489cad MD	422	#define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
06d4f27e	423	#define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
51489cad	424
2d78951a MD	425	/* Event FD commands */
2d78951a MD	426	#define LTTNG_UST_FILTER _UST_CMD(0xA0)
75582b3a	427	#define LTTNG_UST_EXCLUSION _UST_CMD(0xA1)
2d78951a	428
4e3b3630 JR	429	/* Trigger commands */
	430	#define LTTNG_UST_TRIGGER_GROUP_CREATE _UST_CMD(0xB0)
	431	#define LTTNG_UST_TRIGGER_CREATE \
	432	_UST_CMDW(0xB1, struct lttng_ust_trigger)
	433	#define LTTNG_UST_CAPTURE _UST_CMD(0xB2)
	434
	435	/* Session and Trigger group FD commands */
	436	#define LTTNG_UST_COUNTER \
	437	_UST_CMDW(0xB3, struct lttng_ust_counter)
	438	#define LTTNG_UST_COUNTER_GLOBAL \
	439	_UST_CMDW(0xB4, struct lttng_ust_counter_global)
	440	#define LTTNG_UST_COUNTER_CPU \
	441	_UST_CMDW(0xB5, struct lttng_ust_counter_cpu)
	442
46050b1a MD	443	#define LTTNG_UST_ROOT_HANDLE 0
46050b1a MD	444
b61ce3b2	445	struct lttng_ust_obj;
46050b1a	446
ef9ff354 MD	447	union ust_args {
ef9ff354 MD	448	struct {
74d81a6c	449	void *chan_data;
ff0f5728	450	int wakeup_fd;
ef9ff354 MD	451	} channel;
ef9ff354 MD	452	struct {
74d81a6c MD	453	int shm_fd;
74d81a6c MD	454	int wakeup_fd;
ef9ff354	455	} stream;
40003310 MD	456	struct {
	457	struct lttng_ust_field_iter entry;
	458	} field_list;
8e696cfa MD	459	struct {
	460	char *ctxname;
	461	} app_context;
4e3b3630 JR	462	struct {
	463	int trigger_notif_fd;
	464	} trigger_handle;
	465	struct {
	466	void *counter_data;
	467	} counter;
	468	struct {
	469	int shm_fd;
	470	} counter_shm;
ef9ff354 MD	471	};
ef9ff354 MD	472
b61ce3b2	473	struct lttng_ust_objd_ops {
ef9ff354	474	long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
f59ed768	475	union ust_args args, void owner);
46050b1a MD	476	int (*release)(int objd);
	477	};
	478
	479	/* Create root handle. Always ID 0. */
	480	int lttng_abi_create_root_handle(void);
	481
b61ce3b2	482	const struct lttng_ust_objd_ops *objd_ops(int id);
1849ef7c	483	int lttng_ust_objd_unref(int id, int is_owner);
46050b1a MD	484
46050b1a MD	485	void lttng_ust_abi_exit(void);
003fedf4	486	void lttng_ust_events_exit(void);
f59ed768	487	void lttng_ust_objd_table_owner_cleanup(void *owner);
b35d179d	488
9f3fdbc6	489	#endif /* _LTTNG_UST_ABI_H */