[lttng-modules.git] / include / lttng / abi.h

/* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
 *
 * lttng/abi.h
 *
 * LTTng ABI header
 *
 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 */

#ifndef _LTTNG_ABI_H
#define _LTTNG_ABI_H

#include <linux/fs.h>

/*
 * Major/minor version of ABI exposed to lttng tools. Major number
 * should be increased when an incompatible ABI change is done.
 */
#define LTTNG_MODULES_ABI_MAJOR_VERSION		2
#define LTTNG_MODULES_ABI_MINOR_VERSION		5

#define LTTNG_KERNEL_SYM_NAME_LEN	256
#define LTTNG_KERNEL_SESSION_NAME_LEN	256
#define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN	26

enum lttng_kernel_instrumentation {
	LTTNG_KERNEL_TRACEPOINT	= 0,
	LTTNG_KERNEL_KPROBE	= 1,
	LTTNG_KERNEL_FUNCTION	= 2,
	LTTNG_KERNEL_KRETPROBE	= 3,
	LTTNG_KERNEL_NOOP	= 4,	/* not hooked */
	LTTNG_KERNEL_SYSCALL	= 5,
	LTTNG_KERNEL_UPROBE	= 6,
};

/*
 * LTTng consumer mode
 */
enum lttng_kernel_output {
	LTTNG_KERNEL_SPLICE	= 0,
	LTTNG_KERNEL_MMAP	= 1,
};

/*
 * LTTng DebugFS ABI structures.
 */
#define LTTNG_KERNEL_CHANNEL_PADDING	LTTNG_KERNEL_SYM_NAME_LEN + 32
struct lttng_kernel_channel {
	uint64_t subbuf_size;			/* in bytes */
	uint64_t num_subbuf;
	unsigned int switch_timer_interval;	/* usecs */
	unsigned int read_timer_interval;	/* usecs */
	uint32_t output;			/* enum lttng_kernel_output (splice, mmap) */
	int overwrite;				/* 1: overwrite, 0: discard */
	char padding[LTTNG_KERNEL_CHANNEL_PADDING];
} __attribute__((packed));

struct lttng_kernel_kretprobe {
	uint64_t addr;

	uint64_t offset;
	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
} __attribute__((packed));

/*
 * Either addr is used, or symbol_name and offset.
 */
struct lttng_kernel_kprobe {
	uint64_t addr;

	uint64_t offset;
	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
} __attribute__((packed));

struct lttng_kernel_function_tracer {
	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
} __attribute__((packed));

struct lttng_kernel_uprobe {
	int fd;
} __attribute__((packed));

struct lttng_kernel_event_callsite_uprobe {
	uint64_t offset;
} __attribute__((packed));

struct lttng_kernel_event_callsite {
	union {
		struct lttng_kernel_event_callsite_uprobe uprobe;
	} u;
} __attribute__((packed));

enum lttng_kernel_syscall_entryexit {
	LTTNG_KERNEL_SYSCALL_ENTRYEXIT	= 0,
	LTTNG_KERNEL_SYSCALL_ENTRY	= 1,
	LTTNG_KERNEL_SYSCALL_EXIT	= 2,
};

enum lttng_kernel_syscall_abi {
	LTTNG_KERNEL_SYSCALL_ABI_ALL = 0,
	LTTNG_KERNEL_SYSCALL_ABI_NATIVE = 1,
	LTTNG_KERNEL_SYSCALL_ABI_COMPAT = 2,
};

enum lttng_kernel_syscall_match {
	LTTNG_KERNEL_SYSCALL_MATCH_NAME = 0,
	LTTNG_KERNEL_SYSCALL_MATCH_NR = 1,		/* Not implemented. */
};

struct lttng_kernel_syscall {
	uint8_t entryexit;	/* enum lttng_kernel_syscall_entryexit */
	uint8_t abi;		/* enum lttng_kernel_syscall_abi */
	uint8_t match;		/* enum lttng_kernel_syscall_match */
	uint8_t padding;
	uint32_t nr;		/* For LTTNG_SYSCALL_MATCH_NR */
} __attribute__((packed));

/*
 * For syscall tracing, name = "*" means "enable all".
 */
#define LTTNG_KERNEL_EVENT_PADDING1	8
#define LTTNG_KERNEL_EVENT_PADDING2	LTTNG_KERNEL_SYM_NAME_LEN + 32
struct lttng_kernel_event {
	char name[LTTNG_KERNEL_SYM_NAME_LEN];	/* event name */
	uint32_t instrumentation;		/* enum lttng_kernel_instrumentation */
	uint64_t token;				/* User-provided token */
	char padding[LTTNG_KERNEL_EVENT_PADDING1];

	/* Per instrumentation type configuration */
	union {
		struct lttng_kernel_kretprobe kretprobe;
		struct lttng_kernel_kprobe kprobe;
		struct lttng_kernel_function_tracer ftrace;
		struct lttng_kernel_uprobe uprobe;
		struct lttng_kernel_syscall syscall;
		char padding[LTTNG_KERNEL_EVENT_PADDING2];
	} u;
} __attribute__((packed));

#define LTTNG_KERNEL_EVENT_NOTIFIER_PADDING1	16
struct lttng_kernel_event_notifier {
	struct lttng_kernel_event event;

	char padding[LTTNG_KERNEL_EVENT_NOTIFIER_PADDING1];
} __attribute__((packed));

#define LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING 32
struct lttng_kernel_event_notifier_notification {
	uint64_t token;
	uint16_t capture_buf_size;
	char padding[LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING];
} __attribute__((packed));

struct lttng_kernel_tracer_version {
	uint32_t major;
	uint32_t minor;
	uint32_t patchlevel;
} __attribute__((packed));

struct lttng_kernel_tracer_abi_version {
	uint32_t major;
	uint32_t minor;
} __attribute__((packed));

struct lttng_kernel_session_name {
	char name[LTTNG_KERNEL_SESSION_NAME_LEN];
} __attribute__((packed));

struct lttng_kernel_session_creation_time {
	char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
} __attribute__((packed));

enum lttng_kernel_calibrate_type {
	LTTNG_KERNEL_CALIBRATE_KRETPROBE,
};

struct lttng_kernel_calibrate {
	uint32_t type;	/* enum lttng_kernel_calibrate_type (input) */
} __attribute__((packed));

struct lttng_kernel_syscall_mask {
	uint32_t len;	/* in bits */
	char mask[];
} __attribute__((packed));

enum lttng_kernel_context_type {
	LTTNG_KERNEL_CONTEXT_PID		= 0,
	LTTNG_KERNEL_CONTEXT_PERF_COUNTER	= 1,
	LTTNG_KERNEL_CONTEXT_PROCNAME		= 2,
	LTTNG_KERNEL_CONTEXT_PRIO		= 3,
	LTTNG_KERNEL_CONTEXT_NICE		= 4,
	LTTNG_KERNEL_CONTEXT_VPID		= 5,
	LTTNG_KERNEL_CONTEXT_TID		= 6,
	LTTNG_KERNEL_CONTEXT_VTID		= 7,
	LTTNG_KERNEL_CONTEXT_PPID		= 8,
	LTTNG_KERNEL_CONTEXT_VPPID		= 9,
	LTTNG_KERNEL_CONTEXT_HOSTNAME		= 10,
	LTTNG_KERNEL_CONTEXT_CPU_ID		= 11,
	LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE	= 12,
	LTTNG_KERNEL_CONTEXT_PREEMPTIBLE	= 13,
	LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE	= 14,
	LTTNG_KERNEL_CONTEXT_MIGRATABLE		= 15,
	LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL	= 16,
	LTTNG_KERNEL_CONTEXT_CALLSTACK_USER	= 17,
	LTTNG_KERNEL_CONTEXT_CGROUP_NS		= 18,
	LTTNG_KERNEL_CONTEXT_IPC_NS		= 19,
	LTTNG_KERNEL_CONTEXT_MNT_NS		= 20,
	LTTNG_KERNEL_CONTEXT_NET_NS		= 21,
	LTTNG_KERNEL_CONTEXT_PID_NS		= 22,
	LTTNG_KERNEL_CONTEXT_USER_NS		= 23,
	LTTNG_KERNEL_CONTEXT_UTS_NS		= 24,
	LTTNG_KERNEL_CONTEXT_UID		= 25,
	LTTNG_KERNEL_CONTEXT_EUID		= 26,
	LTTNG_KERNEL_CONTEXT_SUID		= 27,
	LTTNG_KERNEL_CONTEXT_GID		= 28,
	LTTNG_KERNEL_CONTEXT_EGID		= 29,
	LTTNG_KERNEL_CONTEXT_SGID		= 30,
	LTTNG_KERNEL_CONTEXT_VUID		= 31,
	LTTNG_KERNEL_CONTEXT_VEUID		= 32,
	LTTNG_KERNEL_CONTEXT_VSUID		= 33,
	LTTNG_KERNEL_CONTEXT_VGID		= 34,
	LTTNG_KERNEL_CONTEXT_VEGID		= 35,
	LTTNG_KERNEL_CONTEXT_VSGID		= 36,
	LTTNG_KERNEL_CONTEXT_TIME_NS		= 37,
};

struct lttng_kernel_perf_counter_ctx {
	uint32_t type;
	uint64_t config;
	char name[LTTNG_KERNEL_SYM_NAME_LEN];
} __attribute__((packed));

#define LTTNG_KERNEL_CONTEXT_PADDING1	16
#define LTTNG_KERNEL_CONTEXT_PADDING2	LTTNG_KERNEL_SYM_NAME_LEN + 32
struct lttng_kernel_context {
	uint32_t ctx;	/*enum lttng_kernel_context_type */
	char padding[LTTNG_KERNEL_CONTEXT_PADDING1];

	union {
		struct lttng_kernel_perf_counter_ctx perf_counter;
		char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
	} u;
} __attribute__((packed));

#define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN		65536
struct lttng_kernel_filter_bytecode {
	uint32_t len;
	uint32_t reloc_offset;
	uint64_t seqnum;
	char data[0];
} __attribute__((packed));

#define LTTNG_KERNEL_CAPTURE_BYTECODE_MAX_LEN		65536
struct lttng_kernel_capture_bytecode {
	uint32_t len;
	uint32_t reloc_offset;
	uint64_t seqnum;
	char data[0];
} __attribute__((packed));

enum lttng_kernel_tracker_type {
	LTTNG_KERNEL_TRACKER_UNKNOWN		= -1,

	LTTNG_KERNEL_TRACKER_PID		= 0,
	LTTNG_KERNEL_TRACKER_VPID		= 1,
	LTTNG_KERNEL_TRACKER_UID		= 2,
	LTTNG_KERNEL_TRACKER_VUID		= 3,
	LTTNG_KERNEL_TRACKER_GID		= 4,
	LTTNG_KERNEL_TRACKER_VGID		= 5,
};

struct lttng_kernel_tracker_args {
	uint32_t type;	/* enum lttng_kernel_tracker_type */
	int32_t id;
};

/* LTTng file descriptor ioctl */
/* lttng/abi-old.h reserve 0x40, 0x41, 0x42, 0x43, and 0x44. */
#define LTTNG_KERNEL_SESSION			_IO(0xF6, 0x45)
#define LTTNG_KERNEL_TRACER_VERSION		\
	_IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
#define LTTNG_KERNEL_TRACEPOINT_LIST		_IO(0xF6, 0x47)
#define LTTNG_KERNEL_WAIT_QUIESCENT		_IO(0xF6, 0x48)
#define LTTNG_KERNEL_CALIBRATE			\
	_IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
#define LTTNG_KERNEL_SYSCALL_LIST		_IO(0xF6, 0x4A)
#define LTTNG_KERNEL_TRACER_ABI_VERSION		\
	_IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
#define LTTNG_KERNEL_EVENT_NOTIFIER_GROUP_CREATE    _IO(0xF6, 0x4C)

/* Session FD ioctl */
/* lttng/abi-old.h reserve 0x50, 0x51, 0x52, and 0x53. */
#define LTTNG_KERNEL_METADATA			\
	_IOW(0xF6, 0x54, struct lttng_kernel_channel)
#define LTTNG_KERNEL_CHANNEL			\
	_IOW(0xF6, 0x55, struct lttng_kernel_channel)
#define LTTNG_KERNEL_SESSION_START		_IO(0xF6, 0x56)
#define LTTNG_KERNEL_SESSION_STOP		_IO(0xF6, 0x57)
#define LTTNG_KERNEL_SESSION_TRACK_PID		\
	_IOR(0xF6, 0x58, int32_t)
#define LTTNG_KERNEL_SESSION_UNTRACK_PID	\
	_IOR(0xF6, 0x59, int32_t)

/*
 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
 * are generating two different ioctl numbers, but this was not done on
 * purpose. We should generally try to avoid those duplications.
 */
#define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS	_IO(0xF6, 0x58)
#define LTTNG_KERNEL_SESSION_METADATA_REGEN	_IO(0xF6, 0x59)

/* lttng/abi-old.h reserve 0x5A and 0x5B. */
#define LTTNG_KERNEL_SESSION_STATEDUMP		_IO(0xF6, 0x5C)
#define LTTNG_KERNEL_SESSION_SET_NAME		\
	_IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
#define LTTNG_KERNEL_SESSION_SET_CREATION_TIME		\
	_IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time)

/* Channel FD ioctl */
/* lttng/abi-old.h reserve 0x60 and 0x61. */
#define LTTNG_KERNEL_STREAM			_IO(0xF6, 0x62)
#define LTTNG_KERNEL_EVENT			\
	_IOW(0xF6, 0x63, struct lttng_kernel_event)
#define LTTNG_KERNEL_SYSCALL_MASK		\
	_IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)

/* Event and Channel FD ioctl */
/* lttng/abi-old.h reserve 0x70. */
#define LTTNG_KERNEL_CONTEXT			\
	_IOW(0xF6, 0x71, struct lttng_kernel_context)

/* Event, Event notifier, Channel and Session ioctl */
/* lttng/abi-old.h reserve 0x80 and 0x81. */
#define LTTNG_KERNEL_ENABLE			_IO(0xF6, 0x82)
#define LTTNG_KERNEL_DISABLE			_IO(0xF6, 0x83)

/* Event and Event notifier FD ioctl */
#define LTTNG_KERNEL_FILTER			_IO(0xF6, 0x90)
#define LTTNG_KERNEL_ADD_CALLSITE		_IO(0xF6, 0x91)

/* Session FD ioctl (continued) */
#define LTTNG_KERNEL_SESSION_LIST_TRACKER_IDS	\
	_IOR(0xF6, 0xA0, struct lttng_kernel_tracker_args)
#define LTTNG_KERNEL_SESSION_TRACK_ID		\
	_IOR(0xF6, 0xA1, struct lttng_kernel_tracker_args)
#define LTTNG_KERNEL_SESSION_UNTRACK_ID		\
	_IOR(0xF6, 0xA2, struct lttng_kernel_tracker_args)

/* Event notifier group file descriptor ioctl */
#define LTTNG_KERNEL_EVENT_NOTIFIER_CREATE \
	_IOW(0xF6, 0xB0, struct lttng_kernel_event_notifier)
#define LTTNG_KERNEL_EVENT_NOTIFIER_GROUP_NOTIFICATION_FD \
	_IO(0xF6, 0xB1)

/* Event notifier file descriptor ioctl */
#define LTTNG_KERNEL_CAPTURE			_IO(0xF6, 0xB8)

/*
 * LTTng-specific ioctls for the lib ringbuffer.
 *
 * Operations applying to the current sub-buffer need to occur between
 * a get/put or get_next/put_next ioctl pair.
 */

/* returns the timestamp begin of the current sub-buffer */
#define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN	_IOR(0xF6, 0x20, uint64_t)
/* returns the timestamp end of the current sub-buffer */
#define LTTNG_RING_BUFFER_GET_TIMESTAMP_END	_IOR(0xF6, 0x21, uint64_t)
/* returns the number of events discarded of the current sub-buffer */
#define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED	_IOR(0xF6, 0x22, uint64_t)
/* returns the packet payload size of the current sub-buffer */
#define LTTNG_RING_BUFFER_GET_CONTENT_SIZE	_IOR(0xF6, 0x23, uint64_t)
/* returns the packet size of the current sub-buffer*/
#define LTTNG_RING_BUFFER_GET_PACKET_SIZE	_IOR(0xF6, 0x24, uint64_t)
/* returns the stream id (invariant for the stream) */
#define LTTNG_RING_BUFFER_GET_STREAM_ID		_IOR(0xF6, 0x25, uint64_t)
/* returns the current timestamp as perceived from the tracer */
#define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP	_IOR(0xF6, 0x26, uint64_t)
/* returns the packet sequence number of the current sub-buffer */
#define LTTNG_RING_BUFFER_GET_SEQ_NUM		_IOR(0xF6, 0x27, uint64_t)
/* returns the stream instance id (invariant for the stream) */
#define LTTNG_RING_BUFFER_INSTANCE_ID		_IOR(0xF6, 0x28, uint64_t)

#ifdef CONFIG_COMPAT
/* returns the timestamp begin of the current sub-buffer */
#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
	LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
/* returns the timestamp end of the current sub-buffer */
#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
	LTTNG_RING_BUFFER_GET_TIMESTAMP_END
/* returns the number of events discarded of the current sub-buffer */
#define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
	LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
/* returns the packet payload size of the current sub-buffer */
#define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
	LTTNG_RING_BUFFER_GET_CONTENT_SIZE
/* returns the packet size of the current sub-buffer */
#define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
	LTTNG_RING_BUFFER_GET_PACKET_SIZE
/* returns the stream id (invariant for the stream) */
#define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
	LTTNG_RING_BUFFER_GET_STREAM_ID
/* returns the current timestamp as perceived from the tracer */
#define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
	LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
/* returns the packet sequence number of the current sub-buffer */
#define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM	\
	LTTNG_RING_BUFFER_GET_SEQ_NUM
/* returns the stream instance id (invariant for the stream) */
#define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID	\
	LTTNG_RING_BUFFER_INSTANCE_ID
#endif /* CONFIG_COMPAT */

#endif /* _LTTNG_ABI_H */
Commit	Line	Data
b7cdc182	1	/* SPDX-License-Identifier: (GPL-2.0-only or LGPL-2.1-only)
9f36eaed	2	*
2df37e95	3	* lttng/abi.h
57a13317	4	*
80996790	5	* LTTng ABI header
17baffe2	6	*
886d51a3	7	* Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
57a13317 MD	8	*/
57a13317 MD	9
9f36eaed MJ	10	#ifndef _LTTNG_ABI_H
	11	#define _LTTNG_ABI_H
	12
57a13317 MD	13	#include <linux/fs.h>
57a13317 MD	14
42cabb80 MD	15	/*
	16	* Major/minor version of ABI exposed to lttng tools. Major number
	17	* should be increased when an incompatible ABI change is done.
	18	*/
3c997079	19	#define LTTNG_MODULES_ABI_MAJOR_VERSION 2
911ae48d	20	#define LTTNG_MODULES_ABI_MINOR_VERSION 5
42cabb80	21
f8695253	22	#define LTTNG_KERNEL_SYM_NAME_LEN 256
7f859fbf	23	#define LTTNG_KERNEL_SESSION_NAME_LEN 256
1c88f269	24	#define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN 26
d6d808f3	25
38d024ae	26	enum lttng_kernel_instrumentation {
4c183524 MD	27	LTTNG_KERNEL_TRACEPOINT = 0,
	28	LTTNG_KERNEL_KPROBE = 1,
	29	LTTNG_KERNEL_FUNCTION = 2,
7371f44c	30	LTTNG_KERNEL_KRETPROBE = 3,
1ec65de1	31	LTTNG_KERNEL_NOOP = 4, /* not hooked */
43880ee8	32	LTTNG_KERNEL_SYSCALL = 5,
149b9a9d	33	LTTNG_KERNEL_UPROBE = 6,
57a13317 MD	34	};
57a13317 MD	35
96ba7208 JD	36	/*
	37	* LTTng consumer mode
	38	*/
	39	enum lttng_kernel_output {
	40	LTTNG_KERNEL_SPLICE = 0,
	41	LTTNG_KERNEL_MMAP = 1,
	42	};
	43
57a13317 MD	44	/*
	45	* LTTng DebugFS ABI structures.
	46	*/
8e099bae	47	#define LTTNG_KERNEL_CHANNEL_PADDING LTTNG_KERNEL_SYM_NAME_LEN + 32
38d024ae	48	struct lttng_kernel_channel {
9e245ead	49	uint64_t subbuf_size; /* in bytes */
80c16bcf	50	uint64_t num_subbuf;
9e245ead MD	51	unsigned int switch_timer_interval; /* usecs */
9e245ead MD	52	unsigned int read_timer_interval; /* usecs */
b6c846f1	53	uint32_t output; /* enum lttng_kernel_output (splice, mmap) */
6dccd6c1	54	int overwrite; /* 1: overwrite, 0: discard */
8e099bae	55	char padding[LTTNG_KERNEL_CHANNEL_PADDING];
1a598612	56	} __attribute__((packed));
57a13317	57
7371f44c MD	58	struct lttng_kernel_kretprobe {
	59	uint64_t addr;
	60
	61	uint64_t offset;
f8695253	62	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
1a598612	63	} __attribute__((packed));
7371f44c	64
38d024ae MD	65	/*
	66	* Either addr is used, or symbol_name and offset.
	67	*/
	68	struct lttng_kernel_kprobe {
80c16bcf	69	uint64_t addr;
38d024ae	70
80c16bcf	71	uint64_t offset;
f8695253	72	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
1a598612	73	} __attribute__((packed));
d6d808f3	74
f17701fb	75	struct lttng_kernel_function_tracer {
f8695253	76	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
1a598612	77	} __attribute__((packed));
f17701fb	78
149b9a9d	79	struct lttng_kernel_uprobe {
56377c91	80	int fd;
3aed4dca FD	81	} __attribute__((packed));
	82
	83	struct lttng_kernel_event_callsite_uprobe {
149b9a9d YB	84	uint64_t offset;
	85	} __attribute__((packed));
	86
3aed4dca FD	87	struct lttng_kernel_event_callsite {
	88	union {
	89	struct lttng_kernel_event_callsite_uprobe uprobe;
	90	} u;
	91	} __attribute__((packed));
	92
badfe9f5	93	enum lttng_kernel_syscall_entryexit {
c5d12b5b FD	94	LTTNG_KERNEL_SYSCALL_ENTRYEXIT = 0,
	95	LTTNG_KERNEL_SYSCALL_ENTRY = 1,
	96	LTTNG_KERNEL_SYSCALL_EXIT = 2,
badfe9f5 MD	97	};
	98
	99	enum lttng_kernel_syscall_abi {
	100	LTTNG_KERNEL_SYSCALL_ABI_ALL = 0,
8a8ac9a8 FD	101	LTTNG_KERNEL_SYSCALL_ABI_NATIVE = 1,
8a8ac9a8 FD	102	LTTNG_KERNEL_SYSCALL_ABI_COMPAT = 2,
badfe9f5 MD	103	};
	104
	105	enum lttng_kernel_syscall_match {
cff6938b FD	106	LTTNG_KERNEL_SYSCALL_MATCH_NAME = 0,
cff6938b FD	107	LTTNG_KERNEL_SYSCALL_MATCH_NR = 1, /* Not implemented. */
badfe9f5 MD	108	};
	109
	110	struct lttng_kernel_syscall {
	111	uint8_t entryexit; /* enum lttng_kernel_syscall_entryexit */
	112	uint8_t abi; /* enum lttng_kernel_syscall_abi */
	113	uint8_t match; /* enum lttng_kernel_syscall_match */
	114	uint8_t padding;
	115	uint32_t nr; /* For LTTNG_SYSCALL_MATCH_NR */
	116	} __attribute__((packed));
	117
43880ee8	118	/*
3c997079	119	* For syscall tracing, name = "*" means "enable all".
43880ee8	120	*/
d4f52727	121	#define LTTNG_KERNEL_EVENT_PADDING1 8
8e099bae	122	#define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
d6d808f3	123	struct lttng_kernel_event {
f8695253	124	char name[LTTNG_KERNEL_SYM_NAME_LEN]; /* event name */
b6c846f1	125	uint32_t instrumentation; /* enum lttng_kernel_instrumentation */
d4f52727	126	uint64_t token; /* User-provided token */
8e099bae MD	127	char padding[LTTNG_KERNEL_EVENT_PADDING1];
8e099bae MD	128
d6d808f3 MD	129	/* Per instrumentation type configuration */
d6d808f3 MD	130	union {
7371f44c	131	struct lttng_kernel_kretprobe kretprobe;
d6d808f3	132	struct lttng_kernel_kprobe kprobe;
f17701fb	133	struct lttng_kernel_function_tracer ftrace;
149b9a9d	134	struct lttng_kernel_uprobe uprobe;
badfe9f5	135	struct lttng_kernel_syscall syscall;
8e099bae	136	char padding[LTTNG_KERNEL_EVENT_PADDING2];
d6d808f3	137	} u;
1a598612	138	} __attribute__((packed));
c099397a	139
dffef45d FD	140	#define LTTNG_KERNEL_EVENT_NOTIFIER_PADDING1 16
	141	struct lttng_kernel_event_notifier {
	142	struct lttng_kernel_event event;
	143
	144	char padding[LTTNG_KERNEL_EVENT_NOTIFIER_PADDING1];
	145	} __attribute__((packed));
	146
99d223ad FD	147	#define LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING 32
	148	struct lttng_kernel_event_notifier_notification {
	149	uint64_t token;
	150	uint16_t capture_buf_size;
	151	char padding[LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING];
	152	} __attribute__((packed));
	153
80c16bcf	154	struct lttng_kernel_tracer_version {
c6c9e10f MD	155	uint32_t major;
c6c9e10f MD	156	uint32_t minor;
80c16bcf	157	uint32_t patchlevel;
1a598612	158	} __attribute__((packed));
80c16bcf	159
42cabb80 MD	160	struct lttng_kernel_tracer_abi_version {
	161	uint32_t major;
	162	uint32_t minor;
	163	} __attribute__((packed));
	164
7f859fbf JR	165	struct lttng_kernel_session_name {
	166	char name[LTTNG_KERNEL_SESSION_NAME_LEN];
	167	} __attribute__((packed));
	168
1c88f269 JR	169	struct lttng_kernel_session_creation_time {
	170	char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
	171	} __attribute__((packed));
	172
3db41b2c MD	173	enum lttng_kernel_calibrate_type {
3db41b2c MD	174	LTTNG_KERNEL_CALIBRATE_KRETPROBE,
57105fc2 MD	175	};
57105fc2 MD	176
3db41b2c	177	struct lttng_kernel_calibrate {
b6c846f1	178	uint32_t type; /* enum lttng_kernel_calibrate_type (input) */
1a598612	179	} __attribute__((packed));
57105fc2	180
12e579db MD	181	struct lttng_kernel_syscall_mask {
	182	uint32_t len; /* in bits */
	183	char mask[];
	184	} __attribute__((packed));
	185
12a313a5	186	enum lttng_kernel_context_type {
4c183524 MD	187	LTTNG_KERNEL_CONTEXT_PID = 0,
4c183524 MD	188	LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1,
a2563e83	189	LTTNG_KERNEL_CONTEXT_PROCNAME = 2,
4c183524 MD	190	LTTNG_KERNEL_CONTEXT_PRIO = 3,
	191	LTTNG_KERNEL_CONTEXT_NICE = 4,
	192	LTTNG_KERNEL_CONTEXT_VPID = 5,
	193	LTTNG_KERNEL_CONTEXT_TID = 6,
	194	LTTNG_KERNEL_CONTEXT_VTID = 7,
	195	LTTNG_KERNEL_CONTEXT_PPID = 8,
	196	LTTNG_KERNEL_CONTEXT_VPPID = 9,
975da2c0	197	LTTNG_KERNEL_CONTEXT_HOSTNAME = 10,
b3699d90	198	LTTNG_KERNEL_CONTEXT_CPU_ID = 11,
79150a49 JD	199	LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE = 12,
	200	LTTNG_KERNEL_CONTEXT_PREEMPTIBLE = 13,
	201	LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE = 14,
	202	LTTNG_KERNEL_CONTEXT_MIGRATABLE = 15,
2fa2d39a FG	203	LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16,
2fa2d39a FG	204	LTTNG_KERNEL_CONTEXT_CALLSTACK_USER = 17,
a6cf40a4 MJ	205	LTTNG_KERNEL_CONTEXT_CGROUP_NS = 18,
	206	LTTNG_KERNEL_CONTEXT_IPC_NS = 19,
	207	LTTNG_KERNEL_CONTEXT_MNT_NS = 20,
	208	LTTNG_KERNEL_CONTEXT_NET_NS = 21,
	209	LTTNG_KERNEL_CONTEXT_PID_NS = 22,
	210	LTTNG_KERNEL_CONTEXT_USER_NS = 23,
	211	LTTNG_KERNEL_CONTEXT_UTS_NS = 24,
dc923e75 MJ	212	LTTNG_KERNEL_CONTEXT_UID = 25,
	213	LTTNG_KERNEL_CONTEXT_EUID = 26,
	214	LTTNG_KERNEL_CONTEXT_SUID = 27,
	215	LTTNG_KERNEL_CONTEXT_GID = 28,
	216	LTTNG_KERNEL_CONTEXT_EGID = 29,
	217	LTTNG_KERNEL_CONTEXT_SGID = 30,
	218	LTTNG_KERNEL_CONTEXT_VUID = 31,
	219	LTTNG_KERNEL_CONTEXT_VEUID = 32,
	220	LTTNG_KERNEL_CONTEXT_VSUID = 33,
	221	LTTNG_KERNEL_CONTEXT_VGID = 34,
	222	LTTNG_KERNEL_CONTEXT_VEGID = 35,
	223	LTTNG_KERNEL_CONTEXT_VSGID = 36,
876e2e92	224	LTTNG_KERNEL_CONTEXT_TIME_NS = 37,
8070f5c0 MD	225	};
	226
	227	struct lttng_kernel_perf_counter_ctx {
	228	uint32_t type;
	229	uint64_t config;
f8695253	230	char name[LTTNG_KERNEL_SYM_NAME_LEN];
1a598612	231	} __attribute__((packed));
8070f5c0	232
8e099bae MD	233	#define LTTNG_KERNEL_CONTEXT_PADDING1 16
8e099bae MD	234	#define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
8070f5c0	235	struct lttng_kernel_context {
b6c846f1	236	uint32_t ctx; /enum lttng_kernel_context_type /
8e099bae MD	237	char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
8e099bae MD	238
8070f5c0	239	union {
8070f5c0	240	struct lttng_kernel_perf_counter_ctx perf_counter;
8e099bae	241	char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
8070f5c0	242	} u;
1a598612	243	} __attribute__((packed));
8070f5c0	244
f127e61e	245	#define LTTNG_KERNEL_FILTER_BYTECODE_MAX_LEN 65536
07dfc1d0 MD	246	struct lttng_kernel_filter_bytecode {
	247	uint32_t len;
	248	uint32_t reloc_offset;
	249	uint64_t seqnum;
	250	char data[0];
	251	} __attribute__((packed));
	252
99d223ad FD	253	#define LTTNG_KERNEL_CAPTURE_BYTECODE_MAX_LEN 65536
	254	struct lttng_kernel_capture_bytecode {
	255	uint32_t len;
	256	uint32_t reloc_offset;
	257	uint64_t seqnum;
	258	char data[0];
	259	} __attribute__((packed));
	260
d1f652f8 MD	261	enum lttng_kernel_tracker_type {
	262	LTTNG_KERNEL_TRACKER_UNKNOWN = -1,
	263
	264	LTTNG_KERNEL_TRACKER_PID = 0,
	265	LTTNG_KERNEL_TRACKER_VPID = 1,
	266	LTTNG_KERNEL_TRACKER_UID = 2,
	267	LTTNG_KERNEL_TRACKER_VUID = 3,
	268	LTTNG_KERNEL_TRACKER_GID = 4,
	269	LTTNG_KERNEL_TRACKER_VGID = 5,
	270	};
	271
	272	struct lttng_kernel_tracker_args {
b6c846f1	273	uint32_t type; /* enum lttng_kernel_tracker_type */
d1f652f8 MD	274	int32_t id;
	275	};
	276
33749530	277	/* LTTng file descriptor ioctl */
2df37e95	278	/* lttng/abi-old.h reserve 0x40, 0x41, 0x42, 0x43, and 0x44. */
6dccd6c1	279	#define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
33749530	280	#define LTTNG_KERNEL_TRACER_VERSION \
6dccd6c1 JD	281	_IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
	282	#define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
	283	#define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
57105fc2	284	#define LTTNG_KERNEL_CALIBRATE \
6dccd6c1	285	_IOWR(0xF6, 0x49, struct lttng_kernel_calibrate)
29c956bb	286	#define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
42cabb80 MD	287	#define LTTNG_KERNEL_TRACER_ABI_VERSION \
42cabb80 MD	288	_IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
750b05f2	289	#define LTTNG_KERNEL_EVENT_NOTIFIER_GROUP_CREATE _IO(0xF6, 0x4C)
33749530 MD	290
33749530 MD	291	/* Session FD ioctl */
2df37e95	292	/* lttng/abi-old.h reserve 0x50, 0x51, 0x52, and 0x53. */
33749530	293	#define LTTNG_KERNEL_METADATA \
6dccd6c1	294	_IOW(0xF6, 0x54, struct lttng_kernel_channel)
ab2277d6	295	#define LTTNG_KERNEL_CHANNEL \
6dccd6c1 JD	296	_IOW(0xF6, 0x55, struct lttng_kernel_channel)
	297	#define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
	298	#define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
e0130fab MD	299	#define LTTNG_KERNEL_SESSION_TRACK_PID \
	300	_IOR(0xF6, 0x58, int32_t)
	301	#define LTTNG_KERNEL_SESSION_UNTRACK_PID \
	302	_IOR(0xF6, 0x59, int32_t)
d1f652f8	303
fe40f016 MD	304	/*
	305	* ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
	306	* are generating two different ioctl numbers, but this was not done on
	307	* purpose. We should generally try to avoid those duplications.
	308	*/
7e6f9ef6	309	#define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
9616f0bf	310	#define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
7f859fbf	311
2df37e95	312	/* lttng/abi-old.h reserve 0x5A and 0x5B. */
601252cf	313	#define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
7f859fbf JR	314	#define LTTNG_KERNEL_SESSION_SET_NAME \
7f859fbf JR	315	_IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
1c88f269 JR	316	#define LTTNG_KERNEL_SESSION_SET_CREATION_TIME \
1c88f269 JR	317	_IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time)
33749530 MD	318
33749530 MD	319	/* Channel FD ioctl */
2df37e95	320	/* lttng/abi-old.h reserve 0x60 and 0x61. */
6dccd6c1	321	#define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
ab2277d6	322	#define LTTNG_KERNEL_EVENT \
6dccd6c1	323	_IOW(0xF6, 0x63, struct lttng_kernel_event)
12e579db MD	324	#define LTTNG_KERNEL_SYSCALL_MASK \
12e579db MD	325	_IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
57a13317	326
8070f5c0	327	/* Event and Channel FD ioctl */
2df37e95	328	/* lttng/abi-old.h reserve 0x70. */
8070f5c0	329	#define LTTNG_KERNEL_CONTEXT \
6dccd6c1	330	_IOW(0xF6, 0x71, struct lttng_kernel_context)
8070f5c0	331
dffef45d	332	/* Event, Event notifier, Channel and Session ioctl */
2df37e95	333	/* lttng/abi-old.h reserve 0x80 and 0x81. */
6dccd6c1 JD	334	#define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
6dccd6c1 JD	335	#define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
e64957da	336
dffef45d	337	/* Event and Event notifier FD ioctl */
07dfc1d0	338	#define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
3aed4dca	339	#define LTTNG_KERNEL_ADD_CALLSITE _IO(0xF6, 0x91)
07dfc1d0	340
d1f652f8 MD	341	/* Session FD ioctl (continued) */
	342	#define LTTNG_KERNEL_SESSION_LIST_TRACKER_IDS \
	343	_IOR(0xF6, 0xA0, struct lttng_kernel_tracker_args)
	344	#define LTTNG_KERNEL_SESSION_TRACK_ID \
	345	_IOR(0xF6, 0xA1, struct lttng_kernel_tracker_args)
	346	#define LTTNG_KERNEL_SESSION_UNTRACK_ID \
	347	_IOR(0xF6, 0xA2, struct lttng_kernel_tracker_args)
	348
dffef45d FD	349	/* Event notifier group file descriptor ioctl */
	350	#define LTTNG_KERNEL_EVENT_NOTIFIER_CREATE \
	351	_IOW(0xF6, 0xB0, struct lttng_kernel_event_notifier)
21f58fb7 FD	352	#define LTTNG_KERNEL_EVENT_NOTIFIER_GROUP_NOTIFICATION_FD \
21f58fb7 FD	353	_IO(0xF6, 0xB1)
dffef45d	354
99d223ad FD	355	/* Event notifier file descriptor ioctl */
	356	#define LTTNG_KERNEL_CAPTURE _IO(0xF6, 0xB8)
	357
1aca53e1 MD	358	/*
	359	* LTTng-specific ioctls for the lib ringbuffer.
	360	*
	361	* Operations applying to the current sub-buffer need to occur between
	362	* a get/put or get_next/put_next ioctl pair.
	363	*/
	364
3b731ab1 JD	365	/* returns the timestamp begin of the current sub-buffer */
	366	#define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
	367	/* returns the timestamp end of the current sub-buffer */
	368	#define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
1aca53e1	369	/* returns the number of events discarded of the current sub-buffer */
3b731ab1	370	#define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
1aca53e1	371	/* returns the packet payload size of the current sub-buffer */
3b731ab1	372	#define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
1aca53e1	373	/* returns the packet size of the current sub-buffer*/
3b731ab1	374	#define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
1aca53e1	375	/* returns the stream id (invariant for the stream) */
3b731ab1	376	#define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
1aca53e1	377	/* returns the current timestamp as perceived from the tracer */
2348ca17	378	#define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
1aca53e1	379	/* returns the packet sequence number of the current sub-buffer */
5b3cf4f9	380	#define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
1aca53e1	381	/* returns the stream instance id (invariant for the stream) */
5594698f	382	#define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
3b731ab1 JD	383
	384	#ifdef CONFIG_COMPAT
	385	/* returns the timestamp begin of the current sub-buffer */
	386	#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_BEGIN \
	387	LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN
	388	/* returns the timestamp end of the current sub-buffer */
	389	#define LTTNG_RING_BUFFER_COMPAT_GET_TIMESTAMP_END \
	390	LTTNG_RING_BUFFER_GET_TIMESTAMP_END
1aca53e1	391	/* returns the number of events discarded of the current sub-buffer */
3b731ab1 JD	392	#define LTTNG_RING_BUFFER_COMPAT_GET_EVENTS_DISCARDED \
3b731ab1 JD	393	LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED
1aca53e1	394	/* returns the packet payload size of the current sub-buffer */
3b731ab1 JD	395	#define LTTNG_RING_BUFFER_COMPAT_GET_CONTENT_SIZE \
3b731ab1 JD	396	LTTNG_RING_BUFFER_GET_CONTENT_SIZE
1aca53e1	397	/* returns the packet size of the current sub-buffer */
3b731ab1 JD	398	#define LTTNG_RING_BUFFER_COMPAT_GET_PACKET_SIZE \
3b731ab1 JD	399	LTTNG_RING_BUFFER_GET_PACKET_SIZE
1aca53e1	400	/* returns the stream id (invariant for the stream) */
3b731ab1 JD	401	#define LTTNG_RING_BUFFER_COMPAT_GET_STREAM_ID \
3b731ab1 JD	402	LTTNG_RING_BUFFER_GET_STREAM_ID
1aca53e1	403	/* returns the current timestamp as perceived from the tracer */
2348ca17 JD	404	#define LTTNG_RING_BUFFER_COMPAT_GET_CURRENT_TIMESTAMP \
2348ca17 JD	405	LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP
1aca53e1	406	/* returns the packet sequence number of the current sub-buffer */
5b3cf4f9 JD	407	#define LTTNG_RING_BUFFER_COMPAT_GET_SEQ_NUM \
5b3cf4f9 JD	408	LTTNG_RING_BUFFER_GET_SEQ_NUM
1aca53e1	409	/* returns the stream instance id (invariant for the stream) */
5594698f JD	410	#define LTTNG_RING_BUFFER_COMPAT_INSTANCE_ID \
5594698f JD	411	LTTNG_RING_BUFFER_INSTANCE_ID
3b731ab1 JD	412	#endif /* CONFIG_COMPAT */
3b731ab1 JD	413
e8951e63	414	#endif /* _LTTNG_ABI_H */