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

/*
 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 * Copyright (C) 2011 EfficiOS Inc.
 *
 * 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,
};

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

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

#define LTTNG_KERNEL_EVENT_PADDING1    16
#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;
	char padding[LTTNG_KERNEL_EVENT_PADDING1];

	/* Per instrumentation type configuration */
	union {
		struct lttng_kernel_kretprobe kretprobe;
		struct lttng_kernel_kprobe kprobe;
		struct lttng_kernel_uprobe uprobe;
		struct lttng_kernel_function ftrace;
		char padding[LTTNG_KERNEL_EVENT_PADDING2];
	} u;
} 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
93128a92	1	/*
ab5be9fa	2	* Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
a4eb26f0	3	* Copyright (C) 2011 EfficiOS Inc.
93128a92	4	*
ab5be9fa	5	* SPDX-License-Identifier: GPL-2.0-only
93128a92	6	*
93128a92 DG	7	*/
	8
	9	#ifndef _LTTNG_KERNEL_H
	10	#define _LTTNG_KERNEL_H
	11
e848fc76	12	#include <stdint.h>
113373e4	13	#include <common/macros.h>
0ef03255 FD	14	#include <lttng/constant.h>
0ef03255 FD	15	#include <lttng/event.h>
e848fc76	16
dbbb3ec5	17	#define LTTNG_KERNEL_SYM_NAME_LEN 256
0ef03255	18	#define LTTNG_KERNEL_MAX_UPROBE_NUM 32
8ff4109e	19	#define LTTNG_KERNEL_SESSION_NAME_LEN 256
e04b2181	20	#define LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN 26
9cb98350	21
7d29a247 DG	22	/*
	23	* LTTng DebugFS ABI structures.
	24	*
	25	* This is the kernel ABI copied from lttng-modules tree.
	26	*/
	27
9cb98350	28	enum lttng_kernel_instrumentation {
5f822d0a	29	LTTNG_KERNEL_ALL = -1, /* Used within lttng-tools */
e6ddca71 DG	30	LTTNG_KERNEL_TRACEPOINT = 0,
	31	LTTNG_KERNEL_KPROBE = 1,
	32	LTTNG_KERNEL_FUNCTION = 2,
8f0d098b	33	LTTNG_KERNEL_KRETPROBE = 3,
0133c199	34	LTTNG_KERNEL_NOOP = 4, /* not hooked */
a54bd42d	35	LTTNG_KERNEL_SYSCALL = 5,
1ab8c2ad	36	LTTNG_KERNEL_UPROBE = 6,
e6ddca71 DG	37	};
e6ddca71 DG	38
7d29a247 DG	39	enum lttng_kernel_context_type {
7d29a247 DG	40	LTTNG_KERNEL_CONTEXT_PID = 0,
aa3514e9	41	LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER = 1,
9197c5c4	42	LTTNG_KERNEL_CONTEXT_PROCNAME = 2,
7d29a247 DG	43	LTTNG_KERNEL_CONTEXT_PRIO = 3,
	44	LTTNG_KERNEL_CONTEXT_NICE = 4,
	45	LTTNG_KERNEL_CONTEXT_VPID = 5,
	46	LTTNG_KERNEL_CONTEXT_TID = 6,
	47	LTTNG_KERNEL_CONTEXT_VTID = 7,
	48	LTTNG_KERNEL_CONTEXT_PPID = 8,
	49	LTTNG_KERNEL_CONTEXT_VPPID = 9,
54773d68	50	LTTNG_KERNEL_CONTEXT_HOSTNAME = 10,
33e801a9	51	LTTNG_KERNEL_CONTEXT_CPU_ID = 11,
1ae5e83e JD	52	LTTNG_KERNEL_CONTEXT_INTERRUPTIBLE = 12,
	53	LTTNG_KERNEL_CONTEXT_PREEMPTIBLE = 13,
	54	LTTNG_KERNEL_CONTEXT_NEED_RESCHEDULE = 14,
	55	LTTNG_KERNEL_CONTEXT_MIGRATABLE = 15,
373148e9 FG	56	LTTNG_KERNEL_CONTEXT_CALLSTACK_KERNEL = 16,
373148e9 FG	57	LTTNG_KERNEL_CONTEXT_CALLSTACK_USER = 17,
40e14884 MJ	58	LTTNG_KERNEL_CONTEXT_CGROUP_NS = 18,
	59	LTTNG_KERNEL_CONTEXT_IPC_NS = 19,
	60	LTTNG_KERNEL_CONTEXT_MNT_NS = 20,
	61	LTTNG_KERNEL_CONTEXT_NET_NS = 21,
	62	LTTNG_KERNEL_CONTEXT_PID_NS = 22,
	63	LTTNG_KERNEL_CONTEXT_USER_NS = 23,
	64	LTTNG_KERNEL_CONTEXT_UTS_NS = 24,
499cbfa1 MJ	65	LTTNG_KERNEL_CONTEXT_UID = 25,
	66	LTTNG_KERNEL_CONTEXT_EUID = 26,
	67	LTTNG_KERNEL_CONTEXT_SUID = 27,
	68	LTTNG_KERNEL_CONTEXT_GID = 28,
	69	LTTNG_KERNEL_CONTEXT_EGID = 29,
	70	LTTNG_KERNEL_CONTEXT_SGID = 30,
	71	LTTNG_KERNEL_CONTEXT_VUID = 31,
	72	LTTNG_KERNEL_CONTEXT_VEUID = 32,
	73	LTTNG_KERNEL_CONTEXT_VSUID = 33,
	74	LTTNG_KERNEL_CONTEXT_VGID = 34,
	75	LTTNG_KERNEL_CONTEXT_VEGID = 35,
	76	LTTNG_KERNEL_CONTEXT_VSGID = 36,
7d29a247 DG	77	};
	78
	79	/* Perf counter attributes */
	80	struct lttng_kernel_perf_counter_ctx {
	81	uint32_t type;
	82	uint64_t config;
dbbb3ec5	83	char name[LTTNG_KERNEL_SYM_NAME_LEN];
113373e4	84	} LTTNG_PACKED;
7d29a247 DG	85
7d29a247 DG	86	/* Event/Channel context */
dbbb3ec5 DG	87	#define LTTNG_KERNEL_CONTEXT_PADDING1 16
dbbb3ec5 DG	88	#define LTTNG_KERNEL_CONTEXT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
7d29a247 DG	89	struct lttng_kernel_context {
7d29a247 DG	90	enum lttng_kernel_context_type ctx;
dbbb3ec5 DG	91	char padding[LTTNG_KERNEL_CONTEXT_PADDING1];
dbbb3ec5 DG	92
7d29a247 DG	93	union {
7d29a247 DG	94	struct lttng_kernel_perf_counter_ctx perf_counter;
dbbb3ec5	95	char padding[LTTNG_KERNEL_CONTEXT_PADDING2];
7d29a247	96	} u;
113373e4	97	} LTTNG_PACKED;
9cb98350	98
8f0d098b MD	99	struct lttng_kernel_kretprobe {
	100	uint64_t addr;
	101
	102	uint64_t offset;
dbbb3ec5	103	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
113373e4	104	} LTTNG_PACKED;
8f0d098b	105
93128a92	106	/*
7d29a247	107	* Either addr is used, or symbol_name and offset.
93128a92	108	*/
7d29a247 DG	109	struct lttng_kernel_kprobe {
	110	uint64_t addr;
	111
	112	uint64_t offset;
dbbb3ec5	113	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
113373e4	114	} LTTNG_PACKED;
9cb98350	115
1ab8c2ad FD	116	struct lttng_kernel_uprobe {
	117	int fd;
	118	} LTTNG_PACKED;
	119
	120	struct lttng_kernel_event_callsite_uprobe {
	121	uint64_t offset;
	122	} LTTNG_PACKED;
	123
	124	struct lttng_kernel_event_callsite {
	125	union {
	126	struct lttng_kernel_event_callsite_uprobe uprobe;
	127	} u;
	128	} LTTNG_PACKED;
	129
f05b5f07	130	/* Function tracer */
7d29a247	131	struct lttng_kernel_function {
dbbb3ec5	132	char symbol_name[LTTNG_KERNEL_SYM_NAME_LEN];
113373e4	133	} LTTNG_PACKED;
93128a92	134
dbbb3ec5 DG	135	#define LTTNG_KERNEL_EVENT_PADDING1 16
dbbb3ec5 DG	136	#define LTTNG_KERNEL_EVENT_PADDING2 LTTNG_KERNEL_SYM_NAME_LEN + 32
9cb98350	137	struct lttng_kernel_event {
dbbb3ec5	138	char name[LTTNG_KERNEL_SYM_NAME_LEN];
9cb98350	139	enum lttng_kernel_instrumentation instrumentation;
dbbb3ec5 DG	140	char padding[LTTNG_KERNEL_EVENT_PADDING1];
dbbb3ec5 DG	141
9cb98350 JD	142	/* Per instrumentation type configuration */
9cb98350 JD	143	union {
8f0d098b	144	struct lttng_kernel_kretprobe kretprobe;
7d29a247	145	struct lttng_kernel_kprobe kprobe;
1ab8c2ad	146	struct lttng_kernel_uprobe uprobe;
7d29a247	147	struct lttng_kernel_function ftrace;
dbbb3ec5	148	char padding[LTTNG_KERNEL_EVENT_PADDING2];
9cb98350	149	} u;
113373e4	150	} LTTNG_PACKED;
93128a92	151
9cb98350	152	struct lttng_kernel_tracer_version {
a62a6556 MD	153	uint32_t major;
a62a6556 MD	154	uint32_t minor;
9cb98350	155	uint32_t patchlevel;
113373e4	156	} LTTNG_PACKED;
93128a92	157
c052142c MD	158	struct lttng_kernel_tracer_abi_version {
	159	uint32_t major;
	160	uint32_t minor;
	161	} LTTNG_PACKED;
	162
e80c3634	163	struct lttng_kernel_syscall_mask {
46820c8b	164	uint32_t len; /* in bits */
e80c3634 MD	165	char mask[];
	166	} LTTNG_PACKED;
	167
4dbc372b JD	168	/*
	169	* kernel channel
	170	*/
	171	#define LTTNG_KERNEL_CHANNEL_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
	172	struct lttng_kernel_channel {
	173	uint64_t subbuf_size; /* bytes */
	174	uint64_t num_subbuf; /* power of 2 */
	175	unsigned int switch_timer_interval; /* usec */
	176	unsigned int read_timer_interval; /* usec */
	177	enum lttng_event_output output; /* splice, mmap */
	178
	179	int overwrite; /* 1: overwrite, 0: discard */
	180	char padding[LTTNG_KERNEL_CHANNEL_PADDING1];
113373e4	181	} LTTNG_PACKED;
d0254c7c	182
00a62084 MD	183	#define KERNEL_FILTER_BYTECODE_MAX_LEN 65536
	184	struct lttng_kernel_filter_bytecode {
	185	uint32_t len;
	186	uint32_t reloc_offset;
	187	uint64_t seqnum;
	188	char data[0];
	189	} LTTNG_PACKED;
	190
8ff4109e JR	191	/*
	192	* kernel session name
	193	*/
	194	struct lttng_kernel_session_name {
	195	char name[LTTNG_KERNEL_SESSION_NAME_LEN];
	196	} LTTNG_PACKED;
	197
e04b2181 JR	198	/*
	199	* kernel session creation datetime
	200	*/
	201	struct lttng_kernel_session_creation_time {
	202	char iso8601[LTTNG_KERNEL_SESSION_CREATION_TIME_ISO8601_LEN];
	203	} LTTNG_PACKED;
	204
d01c0e56 MD	205	enum lttng_kernel_tracker_type {
	206	LTTNG_KERNEL_TRACKER_UNKNOWN = -1,
	207
	208	LTTNG_KERNEL_TRACKER_PID = 0,
	209	LTTNG_KERNEL_TRACKER_VPID = 1,
	210	LTTNG_KERNEL_TRACKER_UID = 2,
	211	LTTNG_KERNEL_TRACKER_VUID = 3,
	212	LTTNG_KERNEL_TRACKER_GID = 4,
	213	LTTNG_KERNEL_TRACKER_VGID = 5,
	214	};
	215
	216	struct lttng_kernel_tracker_args {
	217	enum lttng_kernel_tracker_type type;
	218	int32_t id;
	219	};
	220
93128a92	221	#endif /* _LTTNG_KERNEL_H */