[lttng-tools.git] / src / common / lttng-kernel.h

/*
 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 */

#ifndef _LTTNG_KERNEL_H
#define _LTTNG_KERNEL_H

#include <stdint.h>
#include <common/macros.h>
#include <lttng/constant.h>
#include <lttng/event.h>

#define LTTNG_KERNEL_SYM_NAME_LEN  256
#define LTTNG_KERNEL_MAX_UPROBE_NUM  32
#define LTTNG_KERNEL_SESSION_NAME_LEN	256
#define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN	26

/*
 * LTTng DebugFS ABI structures.
 *
 * This is the kernel ABI copied from lttng-modules tree.
 */

enum lttng_kernel_instrumentation {
	LTTNG_KERNEL_ALL           = -1,   /* Used within lttng-tools */
	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,
};

enum lttng_kernel_context_type {
	LTTNG_KERNEL_CONTEXT_PID            = 0,
	LTTNG_KERNEL_CONTEXT_PERF_CPU_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,
};

/* Perf counter attributes */
struct lttng_kernel_perf_counter_ctx {
	uint32_t type;
	uint64_t config;
	char name[LTTNG_KERNEL_SYM_NAME_LEN];
} LTTNG_PACKED;

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

	union {
		struct lttng_kernel_perf_counter_ctx perf_counter;
		char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
	} u;
} LTTNG_PACKED;

struct lttng_kernel_kretprobe {
	uint64_t addr;

	uint64_t offset;
	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
} LTTNG_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];
} LTTNG_PACKED;

struct lttng_kernel_uprobe {
	int fd;
} LTTNG_PACKED;

struct lttng_kernel_event_callsite_uprobe {
	uint64_t offset;
} LTTNG_PACKED;

struct lttng_kernel_event_callsite {
	union {
		struct lttng_kernel_event_callsite_uprobe uprobe;
	} u;
} LTTNG_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,
};

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

/* Function tracer */
struct lttng_kernel_function {
	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
} LTTNG_PACKED;

#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];
	enum lttng_kernel_instrumentation instrumentation;
	uint64_t 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 ftrace;
		struct lttng_kernel_uprobe uprobe;
		struct lttng_kernel_syscall syscall;
		char padding[LTTNG_KERNEL_EVENT_PADDING2];
	} u;
} LTTNG_PACKED;

#define LTTNG_KERNEL_EVENT_NOTIFIER_PADDING	40
struct lttng_kernel_event_notifier {
	struct lttng_kernel_event event;
	char padding[LTTNG_KERNEL_EVENT_NOTIFIER_PADDING];
} LTTNG_PACKED;

#define LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING 34
struct lttng_kernel_event_notifier_notification {
	uint64_t token;
	char padding[LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING];
} LTTNG_PACKED;

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

struct lttng_kernel_tracer_abi_version {
	uint32_t major;
	uint32_t minor;
} LTTNG_PACKED;

struct lttng_kernel_syscall_mask {
	uint32_t len;	/* in bits */
	char mask[];
} LTTNG_PACKED;

/*
 * kernel channel
 */
#define LTTNG_KERNEL_CHANNEL_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
struct lttng_kernel_channel {
	uint64_t subbuf_size;               /* bytes */
	uint64_t num_subbuf;                /* power of 2 */
	unsigned int switch_timer_interval; /* usec */
	unsigned int read_timer_interval;   /* usec */
	enum lttng_event_output output;     /* splice, mmap */

	int overwrite;                      /* 1: overwrite, 0: discard */
	char padding[LTTNG_KERNEL_CHANNEL_PADDING1];
} LTTNG_PACKED;

#define KERNEL_FILTER_BYTECODE_MAX_LEN		65536
struct lttng_kernel_filter_bytecode {
	uint32_t len;
	uint32_t reloc_offset;
	uint64_t seqnum;
	char data[0];
} LTTNG_PACKED;

/*
 * kernel session name
 */
struct lttng_kernel_session_name {
	char name[LTTNG_KERNEL_SESSION_NAME_LEN];
} LTTNG_PACKED;

/*
 * kernel session creation datetime
 */
struct lttng_kernel_session_creation_time {
	char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
} LTTNG_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 {
	enum lttng_kernel_tracker_type type;
	int32_t id;
};

#endif /* _LTTNG_KERNEL_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
	3	* Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	4	* Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
	5	*
	6	* SPDX-License-Identifier: GPL-2.0-only
	7	*
	8	*/
	9
	10	#ifndef _LTTNG_KERNEL_H
	11	#define _LTTNG_KERNEL_H
	12
	13	#include <stdint.h>
	14	#include <common/macros.h>
	15	#include <lttng/constant.h>
	16	#include <lttng/event.h>
	17
	18	#define LTTNG_KERNEL_SYM_NAME_LEN 256
	19	#define LTTNG_KERNEL_MAX_UPROBE_NUM 32
	20	#define LTTNG_KERNEL_SESSION_NAME_LEN 256
	21	#define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN 26
	22
	23	/*
	24	* LTTng DebugFS ABI structures.
	25	*
	26	* This is the kernel ABI copied from lttng-modules tree.
	27	*/
	28
	29	enum lttng_kernel_instrumentation {
	30	LTTNG_KERNEL_ALL = -1, /* Used within lttng-tools */
	31	LTTNG_KERNEL_TRACEPOINT = 0,
	32	LTTNG_KERNEL_KPROBE = 1,
	33	LTTNG_KERNEL_FUNCTION = 2,
	34	LTTNG_KERNEL_KRETPROBE = 3,
	35	LTTNG_KERNEL_NOOP = 4, /* not hooked */
	36	LTTNG_KERNEL_SYSCALL = 5,
	37	LTTNG_KERNEL_UPROBE = 6,
	38	};
	39
	40	enum lttng_kernel_context_type {
	41	LTTNG_KERNEL_CONTEXT_PID = 0,
	42	LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER = 1,
	43	LTTNG_KERNEL_CONTEXT_PROCNAME = 2,
	44	LTTNG_KERNEL_CONTEXT_PRIO = 3,
	45	LTTNG_KERNEL_CONTEXT_NICE = 4,
	46	LTTNG_KERNEL_CONTEXT_VPID = 5,
	47	LTTNG_KERNEL_CONTEXT_TID = 6,
	48	LTTNG_KERNEL_CONTEXT_VTID = 7,
	49	LTTNG_KERNEL_CONTEXT_PPID = 8,
	50	LTTNG_KERNEL_CONTEXT_VPPID = 9,
	51	LTTNG_KERNEL_CONTEXT_HOSTNAME = 10,
	52	LTTNG_KERNEL_CONTEXT_CPU_ID = 11,
	53	LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE = 12,
	54	LTTNG_KERNEL_CONTEXT_PREEMPTIBLE = 13,
	55	LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE = 14,
	56	LTTNG_KERNEL_CONTEXT_MIGRATABLE = 15,
	57	LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16,
	58	LTTNG_KERNEL_CONTEXT_CALLSTACK_USER = 17,
	59	LTTNG_KERNEL_CONTEXT_CGROUP_NS = 18,
	60	LTTNG_KERNEL_CONTEXT_IPC_NS = 19,
	61	LTTNG_KERNEL_CONTEXT_MNT_NS = 20,
	62	LTTNG_KERNEL_CONTEXT_NET_NS = 21,
	63	LTTNG_KERNEL_CONTEXT_PID_NS = 22,
	64	LTTNG_KERNEL_CONTEXT_USER_NS = 23,
	65	LTTNG_KERNEL_CONTEXT_UTS_NS = 24,
	66	LTTNG_KERNEL_CONTEXT_UID = 25,
	67	LTTNG_KERNEL_CONTEXT_EUID = 26,
	68	LTTNG_KERNEL_CONTEXT_SUID = 27,
	69	LTTNG_KERNEL_CONTEXT_GID = 28,
	70	LTTNG_KERNEL_CONTEXT_EGID = 29,
	71	LTTNG_KERNEL_CONTEXT_SGID = 30,
	72	LTTNG_KERNEL_CONTEXT_VUID = 31,
	73	LTTNG_KERNEL_CONTEXT_VEUID = 32,
	74	LTTNG_KERNEL_CONTEXT_VSUID = 33,
	75	LTTNG_KERNEL_CONTEXT_VGID = 34,
	76	LTTNG_KERNEL_CONTEXT_VEGID = 35,
	77	LTTNG_KERNEL_CONTEXT_VSGID = 36,
	78	LTTNG_KERNEL_CONTEXT_TIME_NS = 37,
	79	};
	80
	81	/* Perf counter attributes */
	82	struct lttng_kernel_perf_counter_ctx {
	83	uint32_t type;
	84	uint64_t config;
	85	char name[LTTNG_KERNEL_SYM_NAME_LEN];
	86	} LTTNG_PACKED;
	87
	88	/* Event/Channel context */
	89	#define LTTNG_KERNEL_CONTEXT_PADDING1 16
	90	#define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
	91	struct lttng_kernel_context {
	92	enum lttng_kernel_context_type ctx;
	93	char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
	94
	95	union {
	96	struct lttng_kernel_perf_counter_ctx perf_counter;
	97	char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
	98	} u;
	99	} LTTNG_PACKED;
	100
	101	struct lttng_kernel_kretprobe {
	102	uint64_t addr;
	103
	104	uint64_t offset;
	105	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
	106	} LTTNG_PACKED;
	107
	108	/*
	109	* Either addr is used, or symbol_name and offset.
	110	*/
	111	struct lttng_kernel_kprobe {
	112	uint64_t addr;
	113
	114	uint64_t offset;
	115	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
	116	} LTTNG_PACKED;
	117
	118	struct lttng_kernel_uprobe {
	119	int fd;
	120	} LTTNG_PACKED;
	121
	122	struct lttng_kernel_event_callsite_uprobe {
	123	uint64_t offset;
	124	} LTTNG_PACKED;
	125
	126	struct lttng_kernel_event_callsite {
	127	union {
	128	struct lttng_kernel_event_callsite_uprobe uprobe;
	129	} u;
	130	} LTTNG_PACKED;
	131
	132	enum lttng_kernel_syscall_entryexit {
	133	LTTNG_KERNEL_SYSCALL_ENTRYEXIT = 0,
	134	LTTNG_KERNEL_SYSCALL_ENTRY = 1,
	135	LTTNG_KERNEL_SYSCALL_EXIT = 2,
	136	};
	137
	138	enum lttng_kernel_syscall_abi {
	139	LTTNG_KERNEL_SYSCALL_ABI_ALL = 0,
	140	LTTNG_KERNEL_SYSCALL_ABI_NATIVE = 1,
	141	LTTNG_KERNEL_SYSCALL_ABI_COMPAT = 2,
	142	};
	143
	144	enum lttng_kernel_syscall_match {
	145	LTTNG_KERNEL_SYSCALL_MATCH_NAME = 0,
	146	LTTNG_KERNEL_SYSCALL_MATCH_NR = 1,
	147	};
	148
	149	struct lttng_kernel_syscall {
	150	uint8_t entryexit; /* enum lttng_kernel_syscall_entryexit */
	151	uint8_t abi; /* enum lttng_kernel_syscall_abi */
	152	uint8_t match; /* enum lttng_kernel_syscall_match */
	153	uint8_t padding;
	154	uint32_t nr; /* For LTTNG_SYSCALL_MATCH_NR */
	155	} LTTNG_PACKED;
	156
	157	/* Function tracer */
	158	struct lttng_kernel_function {
	159	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
	160	} LTTNG_PACKED;
	161
	162	#define LTTNG_KERNEL_EVENT_PADDING1 8
	163	#define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
	164	struct lttng_kernel_event {
	165	char name[LTTNG_KERNEL_SYM_NAME_LEN];
	166	enum lttng_kernel_instrumentation instrumentation;
	167	uint64_t token;
	168	char padding[LTTNG_KERNEL_EVENT_PADDING1];
	169
	170	/* Per instrumentation type configuration */
	171	union {
	172	struct lttng_kernel_kretprobe kretprobe;
	173	struct lttng_kernel_kprobe kprobe;
	174	struct lttng_kernel_function ftrace;
	175	struct lttng_kernel_uprobe uprobe;
	176	struct lttng_kernel_syscall syscall;
	177	char padding[LTTNG_KERNEL_EVENT_PADDING2];
	178	} u;
	179	} LTTNG_PACKED;
	180
	181	#define LTTNG_KERNEL_EVENT_NOTIFIER_PADDING 40
	182	struct lttng_kernel_event_notifier {
	183	struct lttng_kernel_event event;
	184	char padding[LTTNG_KERNEL_EVENT_NOTIFIER_PADDING];
	185	} LTTNG_PACKED;
	186
	187	#define LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING 34
	188	struct lttng_kernel_event_notifier_notification {
	189	uint64_t token;
	190	char padding[LTTNG_KERNEL_EVENT_NOTIFIER_NOTIFICATION_PADDING];
	191	} LTTNG_PACKED;
	192
	193	struct lttng_kernel_tracer_version {
	194	uint32_t major;
	195	uint32_t minor;
	196	uint32_t patchlevel;
	197	} LTTNG_PACKED;
	198
	199	struct lttng_kernel_tracer_abi_version {
	200	uint32_t major;
	201	uint32_t minor;
	202	} LTTNG_PACKED;
	203
	204	struct lttng_kernel_syscall_mask {
	205	uint32_t len; /* in bits */
	206	char mask[];
	207	} LTTNG_PACKED;
	208
	209	/*
	210	* kernel channel
	211	*/
	212	#define LTTNG_KERNEL_CHANNEL_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
	213	struct lttng_kernel_channel {
	214	uint64_t subbuf_size; /* bytes */
	215	uint64_t num_subbuf; /* power of 2 */
	216	unsigned int switch_timer_interval; /* usec */
	217	unsigned int read_timer_interval; /* usec */
	218	enum lttng_event_output output; /* splice, mmap */
	219
	220	int overwrite; /* 1: overwrite, 0: discard */
	221	char padding[LTTNG_KERNEL_CHANNEL_PADDING1];
	222	} LTTNG_PACKED;
	223
	224	#define KERNEL_FILTER_BYTECODE_MAX_LEN 65536
	225	struct lttng_kernel_filter_bytecode {
	226	uint32_t len;
	227	uint32_t reloc_offset;
	228	uint64_t seqnum;
	229	char data[0];
	230	} LTTNG_PACKED;
	231
	232	/*
	233	* kernel session name
	234	*/
	235	struct lttng_kernel_session_name {
	236	char name[LTTNG_KERNEL_SESSION_NAME_LEN];
	237	} LTTNG_PACKED;
	238
	239	/*
	240	* kernel session creation datetime
	241	*/
	242	struct lttng_kernel_session_creation_time {
	243	char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
	244	} LTTNG_PACKED;
	245
	246	enum lttng_kernel_tracker_type {
	247	LTTNG_KERNEL_TRACKER_UNKNOWN = -1,
	248
	249	LTTNG_KERNEL_TRACKER_PID = 0,
	250	LTTNG_KERNEL_TRACKER_VPID = 1,
	251	LTTNG_KERNEL_TRACKER_UID = 2,
	252	LTTNG_KERNEL_TRACKER_VUID = 3,
	253	LTTNG_KERNEL_TRACKER_GID = 4,
	254	LTTNG_KERNEL_TRACKER_VGID = 5,
	255	};
	256
	257	struct lttng_kernel_tracker_args {
	258	enum lttng_kernel_tracker_type type;
	259	int32_t id;
	260	};
	261
	262	#endif /* _LTTNG_KERNEL_H */