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

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