[linux-block.git] / kernel / trace / trace_probe.h

// SPDX-License-Identifier: GPL-2.0
/*
 * Common header file for probe-based Dynamic events.
 *
 * This code was copied from kernel/trace/trace_kprobe.h written by
 * Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
 *
 * Updates to make this generic:
 * Copyright (C) IBM Corporation, 2010-2011
 * Author:     Srikar Dronamraju
 */

#include <linux/seq_file.h>
#include <linux/slab.h>
#include <linux/smp.h>
#include <linux/tracefs.h>
#include <linux/types.h>
#include <linux/string.h>
#include <linux/ptrace.h>
#include <linux/perf_event.h>
#include <linux/kprobes.h>
#include <linux/stringify.h>
#include <linux/limits.h>
#include <linux/uaccess.h>
#include <linux/bitops.h>
#include <asm/bitsperlong.h>

#include "trace.h"
#include "trace_output.h"

#define MAX_TRACE_ARGS		128
#define MAX_ARGSTR_LEN		63
#define MAX_ARRAY_LEN		64
#define MAX_ARG_NAME_LEN	32
#define MAX_STRING_SIZE		PATH_MAX

/* Reserved field names */
#define FIELD_STRING_IP		"__probe_ip"
#define FIELD_STRING_RETIP	"__probe_ret_ip"
#define FIELD_STRING_FUNC	"__probe_func"

#undef DEFINE_FIELD
#define DEFINE_FIELD(type, item, name, is_signed)			\
	do {								\
		ret = trace_define_field(event_call, #type, name,	\
					 offsetof(typeof(field), item),	\
					 sizeof(field.item), is_signed, \
					 FILTER_OTHER);			\
		if (ret)						\
			return ret;					\
	} while (0)


/* Flags for trace_probe */
#define TP_FLAG_TRACE		1
#define TP_FLAG_PROFILE		2

/* data_loc: data location, compatible with u32 */
#define make_data_loc(len, offs)	\
	(((u32)(len) << 16) | ((u32)(offs) & 0xffff))
#define get_loc_len(dl)		((u32)(dl) >> 16)
#define get_loc_offs(dl)	((u32)(dl) & 0xffff)

static nokprobe_inline void *get_loc_data(u32 *dl, void *ent)
{
	return (u8 *)ent + get_loc_offs(*dl);
}

static nokprobe_inline u32 update_data_loc(u32 loc, int consumed)
{
	u32 maxlen = get_loc_len(loc);
	u32 offset = get_loc_offs(loc);

	return make_data_loc(maxlen - consumed, offset + consumed);
}

/* Printing function type */
typedef int (*print_type_func_t)(struct trace_seq *, void *, void *);

enum fetch_op {
	FETCH_OP_NOP = 0,
	// Stage 1 (load) ops
	FETCH_OP_REG,		/* Register : .param = offset */
	FETCH_OP_STACK,		/* Stack : .param = index */
	FETCH_OP_STACKP,	/* Stack pointer */
	FETCH_OP_RETVAL,	/* Return value */
	FETCH_OP_IMM,		/* Immediate : .immediate */
	FETCH_OP_COMM,		/* Current comm */
	FETCH_OP_ARG,		/* Function argument : .param */
	FETCH_OP_FOFFS,		/* File offset: .immediate */
	FETCH_OP_DATA,		/* Allocated data: .data */
	// Stage 2 (dereference) op
	FETCH_OP_DEREF,		/* Dereference: .offset */
	FETCH_OP_UDEREF,	/* User-space Dereference: .offset */
	// Stage 3 (store) ops
	FETCH_OP_ST_RAW,	/* Raw: .size */
	FETCH_OP_ST_MEM,	/* Mem: .offset, .size */
	FETCH_OP_ST_UMEM,	/* Mem: .offset, .size */
	FETCH_OP_ST_STRING,	/* String: .offset, .size */
	FETCH_OP_ST_USTRING,	/* User String: .offset, .size */
	FETCH_OP_ST_SYMSTR,	/* Kernel Symbol String: .offset, .size */
	// Stage 4 (modify) op
	FETCH_OP_MOD_BF,	/* Bitfield: .basesize, .lshift, .rshift */
	// Stage 5 (loop) op
	FETCH_OP_LP_ARRAY,	/* Array: .param = loop count */
	FETCH_OP_TP_ARG,	/* Trace Point argument */
	FETCH_OP_END,
	FETCH_NOP_SYMBOL,	/* Unresolved Symbol holder */
};

struct fetch_insn {
	enum fetch_op op;
	union {
		unsigned int param;
		struct {
			unsigned int size;
			int offset;
		};
		struct {
			unsigned char basesize;
			unsigned char lshift;
			unsigned char rshift;
		};
		unsigned long immediate;
		void *data;
	};
};

/* fetch + deref*N + store + mod + end <= 16, this allows N=12, enough */
#define FETCH_INSN_MAX	16
#define FETCH_TOKEN_COMM	(-ECOMM)

/* Fetch type information table */
struct fetch_type {
	const char		*name;		/* Name of type */
	size_t			size;		/* Byte size of type */
	bool			is_signed;	/* Signed flag */
	bool			is_string;	/* String flag */
	print_type_func_t	print;		/* Print functions */
	const char		*fmt;		/* Format string */
	const char		*fmttype;	/* Name in format file */
};

/* For defining macros, define string/string_size types */
typedef u32 string;
typedef u32 string_size;

#define PRINT_TYPE_FUNC_NAME(type)	print_type_##type
#define PRINT_TYPE_FMT_NAME(type)	print_type_format_##type

/* Printing  in basic type function template */
#define DECLARE_BASIC_PRINT_TYPE_FUNC(type)				\
int PRINT_TYPE_FUNC_NAME(type)(struct trace_seq *s, void *data, void *ent);\
extern const char PRINT_TYPE_FMT_NAME(type)[]

DECLARE_BASIC_PRINT_TYPE_FUNC(u8);
DECLARE_BASIC_PRINT_TYPE_FUNC(u16);
DECLARE_BASIC_PRINT_TYPE_FUNC(u32);
DECLARE_BASIC_PRINT_TYPE_FUNC(u64);
DECLARE_BASIC_PRINT_TYPE_FUNC(s8);
DECLARE_BASIC_PRINT_TYPE_FUNC(s16);
DECLARE_BASIC_PRINT_TYPE_FUNC(s32);
DECLARE_BASIC_PRINT_TYPE_FUNC(s64);
DECLARE_BASIC_PRINT_TYPE_FUNC(x8);
DECLARE_BASIC_PRINT_TYPE_FUNC(x16);
DECLARE_BASIC_PRINT_TYPE_FUNC(x32);
DECLARE_BASIC_PRINT_TYPE_FUNC(x64);

DECLARE_BASIC_PRINT_TYPE_FUNC(char);
DECLARE_BASIC_PRINT_TYPE_FUNC(string);
DECLARE_BASIC_PRINT_TYPE_FUNC(symbol);

/* Default (unsigned long) fetch type */
#define __DEFAULT_FETCH_TYPE(t) x##t
#define _DEFAULT_FETCH_TYPE(t) __DEFAULT_FETCH_TYPE(t)
#define DEFAULT_FETCH_TYPE _DEFAULT_FETCH_TYPE(BITS_PER_LONG)
#define DEFAULT_FETCH_TYPE_STR __stringify(DEFAULT_FETCH_TYPE)

#define __ADDR_FETCH_TYPE(t) u##t
#define _ADDR_FETCH_TYPE(t) __ADDR_FETCH_TYPE(t)
#define ADDR_FETCH_TYPE _ADDR_FETCH_TYPE(BITS_PER_LONG)

#define __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, str, _fmttype)	\
	{.name = _name,					\
	 .size = _size,					\
	 .is_signed = (bool)sign,			\
	 .is_string = (bool)str,			\
	 .print = PRINT_TYPE_FUNC_NAME(ptype),		\
	 .fmt = PRINT_TYPE_FMT_NAME(ptype),		\
	 .fmttype = _fmttype,				\
	}

/* Non string types can use these macros */
#define _ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, _fmttype)	\
	__ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, 0, #_fmttype)
#define ASSIGN_FETCH_TYPE(ptype, ftype, sign)			\
	_ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, ptype)

/* If ptype is an alias of atype, use this macro (show atype in format) */
#define ASSIGN_FETCH_TYPE_ALIAS(ptype, atype, ftype, sign)		\
	_ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, atype)

#define ASSIGN_FETCH_TYPE_END {}
#define MAX_ARRAY_LEN	64

#ifdef CONFIG_KPROBE_EVENTS
bool trace_kprobe_on_func_entry(struct trace_event_call *call);
bool trace_kprobe_error_injectable(struct trace_event_call *call);
#else
static inline bool trace_kprobe_on_func_entry(struct trace_event_call *call)
{
	return false;
}

static inline bool trace_kprobe_error_injectable(struct trace_event_call *call)
{
	return false;
}
#endif /* CONFIG_KPROBE_EVENTS */

struct probe_arg {
	struct fetch_insn	*code;
	bool			dynamic;/* Dynamic array (string) is used */
	unsigned int		offset;	/* Offset from argument entry */
	unsigned int		count;	/* Array count */
	const char		*name;	/* Name of this argument */
	const char		*comm;	/* Command of this argument */
	char			*fmt;	/* Format string if needed */
	const struct fetch_type	*type;	/* Type of this argument */
};

struct trace_uprobe_filter {
	rwlock_t		rwlock;
	int			nr_systemwide;
	struct list_head	perf_events;
};

/* Event call and class holder */
struct trace_probe_event {
	unsigned int			flags;	/* For TP_FLAG_* */
	struct trace_event_class	class;
	struct trace_event_call		call;
	struct list_head 		files;
	struct list_head		probes;
	struct trace_uprobe_filter	filter[];
};

struct trace_probe {
	struct list_head		list;
	struct trace_probe_event	*event;
	ssize_t				size;	/* trace entry size */
	unsigned int			nr_args;
	struct probe_arg		args[];
};

struct event_file_link {
	struct trace_event_file		*file;
	struct list_head		list;
};

static inline bool trace_probe_test_flag(struct trace_probe *tp,
					 unsigned int flag)
{
	return !!(tp->event->flags & flag);
}

static inline void trace_probe_set_flag(struct trace_probe *tp,
					unsigned int flag)
{
	tp->event->flags |= flag;
}

static inline void trace_probe_clear_flag(struct trace_probe *tp,
					  unsigned int flag)
{
	tp->event->flags &= ~flag;
}

static inline bool trace_probe_is_enabled(struct trace_probe *tp)
{
	return trace_probe_test_flag(tp, TP_FLAG_TRACE | TP_FLAG_PROFILE);
}

static inline const char *trace_probe_name(struct trace_probe *tp)
{
	return trace_event_name(&tp->event->call);
}

static inline const char *trace_probe_group_name(struct trace_probe *tp)
{
	return tp->event->call.class->system;
}

static inline struct trace_event_call *
	trace_probe_event_call(struct trace_probe *tp)
{
	return &tp->event->call;
}

static inline struct trace_probe_event *
trace_probe_event_from_call(struct trace_event_call *event_call)
{
	return container_of(event_call, struct trace_probe_event, call);
}

static inline struct trace_probe *
trace_probe_primary_from_call(struct trace_event_call *call)
{
	struct trace_probe_event *tpe = trace_probe_event_from_call(call);

	return list_first_entry(&tpe->probes, struct trace_probe, list);
}

static inline struct list_head *trace_probe_probe_list(struct trace_probe *tp)
{
	return &tp->event->probes;
}

static inline bool trace_probe_has_sibling(struct trace_probe *tp)
{
	struct list_head *list = trace_probe_probe_list(tp);

	return !list_empty(list) && !list_is_singular(list);
}

static inline int trace_probe_unregister_event_call(struct trace_probe *tp)
{
	/* tp->event is unregistered in trace_remove_event_call() */
	return trace_remove_event_call(&tp->event->call);
}

static inline bool trace_probe_has_single_file(struct trace_probe *tp)
{
	return !!list_is_singular(&tp->event->files);
}

int trace_probe_init(struct trace_probe *tp, const char *event,
		     const char *group, bool alloc_filter);
void trace_probe_cleanup(struct trace_probe *tp);
int trace_probe_append(struct trace_probe *tp, struct trace_probe *to);
void trace_probe_unlink(struct trace_probe *tp);
int trace_probe_register_event_call(struct trace_probe *tp);
int trace_probe_add_file(struct trace_probe *tp, struct trace_event_file *file);
int trace_probe_remove_file(struct trace_probe *tp,
			    struct trace_event_file *file);
struct event_file_link *trace_probe_get_file_link(struct trace_probe *tp,
						struct trace_event_file *file);
int trace_probe_compare_arg_type(struct trace_probe *a, struct trace_probe *b);
bool trace_probe_match_command_args(struct trace_probe *tp,
				    int argc, const char **argv);
int trace_probe_create(const char *raw_command, int (*createfn)(int, const char **));
int trace_probe_print_args(struct trace_seq *s, struct probe_arg *args, int nr_args,
		 u8 *data, void *field);

#define trace_probe_for_each_link(pos, tp)	\
	list_for_each_entry(pos, &(tp)->event->files, list)
#define trace_probe_for_each_link_rcu(pos, tp)	\
	list_for_each_entry_rcu(pos, &(tp)->event->files, list)

#define TPARG_FL_RETURN BIT(0)
#define TPARG_FL_KERNEL BIT(1)
#define TPARG_FL_FENTRY BIT(2)
#define TPARG_FL_TPOINT BIT(3)
#define TPARG_FL_USER   BIT(4)
#define TPARG_FL_MASK	GENMASK(4, 0)

extern int traceprobe_parse_probe_arg(struct trace_probe *tp, int i,
				const char *argv, unsigned int flags);

extern int traceprobe_update_arg(struct probe_arg *arg);
extern void traceprobe_free_probe_arg(struct probe_arg *arg);

extern int traceprobe_split_symbol_offset(char *symbol, long *offset);
int traceprobe_parse_event_name(const char **pevent, const char **pgroup,
				char *buf, int offset);

enum probe_print_type {
	PROBE_PRINT_NORMAL,
	PROBE_PRINT_RETURN,
	PROBE_PRINT_EVENT,
};

extern int traceprobe_set_print_fmt(struct trace_probe *tp, enum probe_print_type ptype);

#ifdef CONFIG_PERF_EVENTS
extern struct trace_event_call *
create_local_trace_kprobe(char *func, void *addr, unsigned long offs,
			  bool is_return);
extern void destroy_local_trace_kprobe(struct trace_event_call *event_call);

extern struct trace_event_call *
create_local_trace_uprobe(char *name, unsigned long offs,
			  unsigned long ref_ctr_offset, bool is_return);
extern void destroy_local_trace_uprobe(struct trace_event_call *event_call);
#endif
extern int traceprobe_define_arg_fields(struct trace_event_call *event_call,
					size_t offset, struct trace_probe *tp);

#undef ERRORS
#define ERRORS	\
	C(FILE_NOT_FOUND,	"Failed to find the given file"),	\
	C(NO_REGULAR_FILE,	"Not a regular file"),			\
	C(BAD_REFCNT,		"Invalid reference counter offset"),	\
	C(REFCNT_OPEN_BRACE,	"Reference counter brace is not closed"), \
	C(BAD_REFCNT_SUFFIX,	"Reference counter has wrong suffix"),	\
	C(BAD_UPROBE_OFFS,	"Invalid uprobe offset"),		\
	C(MAXACT_NO_KPROBE,	"Maxactive is not for kprobe"),		\
	C(BAD_MAXACT,		"Invalid maxactive number"),		\
	C(MAXACT_TOO_BIG,	"Maxactive is too big"),		\
	C(BAD_PROBE_ADDR,	"Invalid probed address or symbol"),	\
	C(BAD_RETPROBE,		"Retprobe address must be an function entry"), \
	C(BAD_ADDR_SUFFIX,	"Invalid probed address suffix"), \
	C(NO_GROUP_NAME,	"Group name is not specified"),		\
	C(GROUP_TOO_LONG,	"Group name is too long"),		\
	C(BAD_GROUP_NAME,	"Group name must follow the same rules as C identifiers"), \
	C(NO_EVENT_NAME,	"Event name is not specified"),		\
	C(EVENT_TOO_LONG,	"Event name is too long"),		\
	C(BAD_EVENT_NAME,	"Event name must follow the same rules as C identifiers"), \
	C(EVENT_EXIST,		"Given group/event name is already used by another event"), \
	C(RETVAL_ON_PROBE,	"$retval is not available on probe"),	\
	C(BAD_STACK_NUM,	"Invalid stack number"),		\
	C(BAD_ARG_NUM,		"Invalid argument number"),		\
	C(BAD_VAR,		"Invalid $-valiable specified"),	\
	C(BAD_REG_NAME,		"Invalid register name"),		\
	C(BAD_MEM_ADDR,		"Invalid memory address"),		\
	C(BAD_IMM,		"Invalid immediate value"),		\
	C(IMMSTR_NO_CLOSE,	"String is not closed with '\"'"),	\
	C(FILE_ON_KPROBE,	"File offset is not available with kprobe"), \
	C(BAD_FILE_OFFS,	"Invalid file offset value"),		\
	C(SYM_ON_UPROBE,	"Symbol is not available with uprobe"),	\
	C(TOO_MANY_OPS,		"Dereference is too much nested"), 	\
	C(DEREF_NEED_BRACE,	"Dereference needs a brace"),		\
	C(BAD_DEREF_OFFS,	"Invalid dereference offset"),		\
	C(DEREF_OPEN_BRACE,	"Dereference brace is not closed"),	\
	C(COMM_CANT_DEREF,	"$comm can not be dereferenced"),	\
	C(BAD_FETCH_ARG,	"Invalid fetch argument"),		\
	C(ARRAY_NO_CLOSE,	"Array is not closed"),			\
	C(BAD_ARRAY_SUFFIX,	"Array has wrong suffix"),		\
	C(BAD_ARRAY_NUM,	"Invalid array size"),			\
	C(ARRAY_TOO_BIG,	"Array number is too big"),		\
	C(BAD_TYPE,		"Unknown type is specified"),		\
	C(BAD_STRING,		"String accepts only memory argument"),	\
	C(BAD_SYMSTRING,	"Symbol String doesn't accept data/userdata"),	\
	C(BAD_BITFIELD,		"Invalid bitfield"),			\
	C(ARG_NAME_TOO_LONG,	"Argument name is too long"),		\
	C(NO_ARG_NAME,		"Argument name is not specified"),	\
	C(BAD_ARG_NAME,		"Argument name must follow the same rules as C identifiers"), \
	C(USED_ARG_NAME,	"This argument name is already used"),	\
	C(ARG_TOO_LONG,		"Argument expression is too long"),	\
	C(NO_ARG_BODY,		"No argument expression"),		\
	C(BAD_INSN_BNDRY,	"Probe point is not an instruction boundary"),\
	C(FAIL_REG_PROBE,	"Failed to register probe event"),\
	C(DIFF_PROBE_TYPE,	"Probe type is different from existing probe"),\
	C(DIFF_ARG_TYPE,	"Argument type or name is different from existing probe"),\
	C(SAME_PROBE,		"There is already the exact same probe event"),\
	C(NO_EVENT_INFO,	"This requires both group and event name to attach"),\
	C(BAD_ATTACH_EVENT,	"Attached event does not exist"),\
	C(BAD_ATTACH_ARG,	"Attached event does not have this field"),\
	C(NO_EP_FILTER,		"No filter rule after 'if'"),

#undef C
#define C(a, b)		TP_ERR_##a

/* Define TP_ERR_ */
enum { ERRORS };

/* Error text is defined in trace_probe.c */

struct trace_probe_log {
	const char	*subsystem;
	const char	**argv;
	int		argc;
	int		index;
};

void trace_probe_log_init(const char *subsystem, int argc, const char **argv);
void trace_probe_log_set_index(int index);
void trace_probe_log_clear(void);
void __trace_probe_log_err(int offset, int err);

#define trace_probe_log_err(offs, err)	\
	__trace_probe_log_err(offs, TP_ERR_##err)
Commit	Line	Data
bcea3f96	1	// SPDX-License-Identifier: GPL-2.0
8ab83f56 SD	2	/*
	3	* Common header file for probe-based Dynamic events.
	4	*
8ab83f56 SD	5	* This code was copied from kernel/trace/trace_kprobe.h written by
	6	* Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
	7	*
	8	* Updates to make this generic:
	9	* Copyright (C) IBM Corporation, 2010-2011
	10	* Author: Srikar Dronamraju
	11	*/
	12
	13	#include <linux/seq_file.h>
	14	#include <linux/slab.h>
	15	#include <linux/smp.h>
8434dc93	16	#include <linux/tracefs.h>
8ab83f56 SD	17	#include <linux/types.h>
8ab83f56 SD	18	#include <linux/string.h>
8ab83f56 SD	19	#include <linux/ptrace.h>
	20	#include <linux/perf_event.h>
	21	#include <linux/kprobes.h>
	22	#include <linux/stringify.h>
	23	#include <linux/limits.h>
	24	#include <linux/uaccess.h>
a1303af5	25	#include <linux/bitops.h>
8ab83f56 SD	26	#include <asm/bitsperlong.h>
	27
	28	#include "trace.h"
	29	#include "trace_output.h"
	30
	31	#define MAX_TRACE_ARGS 128
	32	#define MAX_ARGSTR_LEN 63
40b53b77	33	#define MAX_ARRAY_LEN 64
b4443c17	34	#define MAX_ARG_NAME_LEN 32
8ab83f56 SD	35	#define MAX_STRING_SIZE PATH_MAX
	36
	37	/* Reserved field names */
	38	#define FIELD_STRING_IP "__probe_ip"
	39	#define FIELD_STRING_RETIP "__probe_ret_ip"
	40	#define FIELD_STRING_FUNC "__probe_func"
	41
	42	#undef DEFINE_FIELD
	43	#define DEFINE_FIELD(type, item, name, is_signed) \
	44	do { \
	45	ret = trace_define_field(event_call, #type, name, \
	46	offsetof(typeof(field), item), \
	47	sizeof(field.item), is_signed, \
	48	FILTER_OTHER); \
	49	if (ret) \
	50	return ret; \
	51	} while (0)
	52
	53
	54	/* Flags for trace_probe */
	55	#define TP_FLAG_TRACE 1
	56	#define TP_FLAG_PROFILE 2
8ab83f56	57
9178412d MH	58	/* data_loc: data location, compatible with u32 */
	59	#define make_data_loc(len, offs) \
	60	(((u32)(len) << 16) \| ((u32)(offs) & 0xffff))
	61	#define get_loc_len(dl) ((u32)(dl) >> 16)
	62	#define get_loc_offs(dl) ((u32)(dl) & 0xffff)
8ab83f56	63
3da0f180	64	static nokprobe_inline void get_loc_data(u32 dl, void *ent)
b26c74e1	65	{
9178412d	66	return (u8 )ent + get_loc_offs(dl);
b26c74e1 NK	67	}
b26c74e1 NK	68
40b53b77 MH	69	static nokprobe_inline u32 update_data_loc(u32 loc, int consumed)
	70	{
	71	u32 maxlen = get_loc_len(loc);
	72	u32 offset = get_loc_offs(loc);
	73
	74	return make_data_loc(maxlen - consumed, offset + consumed);
	75	}
	76
8ab83f56	77	/* Printing function type */
56de7630	78	typedef int (print_type_func_t)(struct trace_seq , void , void );
8ab83f56	79
53305928 MH	80	enum fetch_op {
	81	FETCH_OP_NOP = 0,
	82	// Stage 1 (load) ops
	83	FETCH_OP_REG, /* Register : .param = offset */
	84	FETCH_OP_STACK, /* Stack : .param = index */
	85	FETCH_OP_STACKP, /* Stack pointer */
	86	FETCH_OP_RETVAL, /* Return value */
	87	FETCH_OP_IMM, /* Immediate : .immediate */
	88	FETCH_OP_COMM, /* Current comm */
a1303af5	89	FETCH_OP_ARG, /* Function argument : .param */
53305928	90	FETCH_OP_FOFFS, /* File offset: .immediate */
a42e3c4d	91	FETCH_OP_DATA, /* Allocated data: .data */
53305928 MH	92	// Stage 2 (dereference) op
53305928 MH	93	FETCH_OP_DEREF, /* Dereference: .offset */
e65f7ae7	94	FETCH_OP_UDEREF, /* User-space Dereference: .offset */
53305928 MH	95	// Stage 3 (store) ops
	96	FETCH_OP_ST_RAW, /* Raw: .size */
	97	FETCH_OP_ST_MEM, /* Mem: .offset, .size */
e65f7ae7	98	FETCH_OP_ST_UMEM, /* Mem: .offset, .size */
53305928	99	FETCH_OP_ST_STRING, /* String: .offset, .size */
88903c46	100	FETCH_OP_ST_USTRING, /* User String: .offset, .size */
b26a124c	101	FETCH_OP_ST_SYMSTR, /* Kernel Symbol String: .offset, .size */
53305928 MH	102	// Stage 4 (modify) op
53305928 MH	103	FETCH_OP_MOD_BF, /* Bitfield: .basesize, .lshift, .rshift */
40b53b77 MH	104	// Stage 5 (loop) op
40b53b77 MH	105	FETCH_OP_LP_ARRAY, /* Array: .param = loop count */
7491e2c4	106	FETCH_OP_TP_ARG, /* Trace Point argument */
53305928	107	FETCH_OP_END,
a6682814	108	FETCH_NOP_SYMBOL, /* Unresolved Symbol holder */
8ab83f56 SD	109	};
8ab83f56 SD	110
53305928 MH	111	struct fetch_insn {
	112	enum fetch_op op;
	113	union {
	114	unsigned int param;
	115	struct {
	116	unsigned int size;
	117	int offset;
	118	};
	119	struct {
	120	unsigned char basesize;
	121	unsigned char lshift;
	122	unsigned char rshift;
	123	};
	124	unsigned long immediate;
a6682814	125	void *data;
53305928 MH	126	};
	127	};
	128
	129	/* fetch + derefN + store + mod + end <= 16, this allows N=12, enough /
	130	#define FETCH_INSN_MAX 16
4dd537ac	131	#define FETCH_TOKEN_COMM (-ECOMM)
53305928	132
8ab83f56 SD	133	/* Fetch type information table */
	134	struct fetch_type {
	135	const char name; / Name of type */
	136	size_t size; /* Byte size of type */
b26a124c MHG	137	bool is_signed; /* Signed flag */
b26a124c MHG	138	bool is_string; /* String flag */
8ab83f56	139	print_type_func_t print; /* Print functions */
f2cc020d	140	const char fmt; / Format string */
8ab83f56	141	const char fmttype; / Name in format file */
8ab83f56 SD	142	};
8ab83f56 SD	143
34fee3a1 NK	144	/* For defining macros, define string/string_size types */
	145	typedef u32 string;
	146	typedef u32 string_size;
	147
b26c74e1 NK	148	#define PRINT_TYPE_FUNC_NAME(type) print_type_##type
	149	#define PRINT_TYPE_FMT_NAME(type) print_type_format_##type
	150
	151	/* Printing in basic type function template */
	152	#define DECLARE_BASIC_PRINT_TYPE_FUNC(type) \
56de7630	153	int PRINT_TYPE_FUNC_NAME(type)(struct trace_seq s, void data, void *ent);\
b26c74e1 NK	154	extern const char PRINT_TYPE_FMT_NAME(type)[]
	155
	156	DECLARE_BASIC_PRINT_TYPE_FUNC(u8);
	157	DECLARE_BASIC_PRINT_TYPE_FUNC(u16);
	158	DECLARE_BASIC_PRINT_TYPE_FUNC(u32);
	159	DECLARE_BASIC_PRINT_TYPE_FUNC(u64);
	160	DECLARE_BASIC_PRINT_TYPE_FUNC(s8);
	161	DECLARE_BASIC_PRINT_TYPE_FUNC(s16);
	162	DECLARE_BASIC_PRINT_TYPE_FUNC(s32);
	163	DECLARE_BASIC_PRINT_TYPE_FUNC(s64);
17ce3dc7 MH	164	DECLARE_BASIC_PRINT_TYPE_FUNC(x8);
	165	DECLARE_BASIC_PRINT_TYPE_FUNC(x16);
	166	DECLARE_BASIC_PRINT_TYPE_FUNC(x32);
	167	DECLARE_BASIC_PRINT_TYPE_FUNC(x64);
	168
8478cca1	169	DECLARE_BASIC_PRINT_TYPE_FUNC(char);
b26c74e1	170	DECLARE_BASIC_PRINT_TYPE_FUNC(string);
60c2e0ce	171	DECLARE_BASIC_PRINT_TYPE_FUNC(symbol);
b26c74e1 NK	172
b26c74e1 NK	173	/* Default (unsigned long) fetch type */
bdca79c2	174	#define __DEFAULT_FETCH_TYPE(t) x##t
b26c74e1 NK	175	#define _DEFAULT_FETCH_TYPE(t) __DEFAULT_FETCH_TYPE(t)
	176	#define DEFAULT_FETCH_TYPE _DEFAULT_FETCH_TYPE(BITS_PER_LONG)
	177	#define DEFAULT_FETCH_TYPE_STR __stringify(DEFAULT_FETCH_TYPE)
	178
60c2e0ce MH	179	#define __ADDR_FETCH_TYPE(t) u##t
	180	#define _ADDR_FETCH_TYPE(t) __ADDR_FETCH_TYPE(t)
	181	#define ADDR_FETCH_TYPE _ADDR_FETCH_TYPE(BITS_PER_LONG)
	182
b26a124c MHG	183	#define __ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, str, _fmttype) \
b26a124c MHG	184	{.name = _name, \
b26c74e1	185	.size = _size, \
b26a124c MHG	186	.is_signed = (bool)sign, \
b26a124c MHG	187	.is_string = (bool)str, \
b26c74e1 NK	188	.print = PRINT_TYPE_FUNC_NAME(ptype), \
	189	.fmt = PRINT_TYPE_FMT_NAME(ptype), \
	190	.fmttype = _fmttype, \
b26c74e1	191	}
b26a124c MHG	192
b26a124c MHG	193	/* Non string types can use these macros */
60c2e0ce	194	#define _ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, _fmttype) \
b26a124c	195	__ASSIGN_FETCH_TYPE(_name, ptype, ftype, _size, sign, 0, #_fmttype)
b26c74e1	196	#define ASSIGN_FETCH_TYPE(ptype, ftype, sign) \
60c2e0ce	197	_ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, ptype)
b26c74e1	198
17ce3dc7 MH	199	/* If ptype is an alias of atype, use this macro (show atype in format) */
17ce3dc7 MH	200	#define ASSIGN_FETCH_TYPE_ALIAS(ptype, atype, ftype, sign) \
60c2e0ce	201	_ASSIGN_FETCH_TYPE(#ptype, ptype, ftype, sizeof(ftype), sign, atype)
17ce3dc7	202
34fee3a1	203	#define ASSIGN_FETCH_TYPE_END {}
40b53b77	204	#define MAX_ARRAY_LEN 64
34fee3a1	205
6b0b7551	206	#ifdef CONFIG_KPROBE_EVENTS
b4da3340 MH	207	bool trace_kprobe_on_func_entry(struct trace_event_call *call);
b4da3340 MH	208	bool trace_kprobe_error_injectable(struct trace_event_call *call);
1301a44e	209	#else
b4da3340	210	static inline bool trace_kprobe_on_func_entry(struct trace_event_call *call)
9802d865	211	{
b4da3340	212	return false;
9802d865 JB	213	}
9802d865 JB	214
b4da3340	215	static inline bool trace_kprobe_error_injectable(struct trace_event_call *call)
9802d865	216	{
b4da3340	217	return false;
9802d865	218	}
6b0b7551	219	#endif /* CONFIG_KPROBE_EVENTS */
1301a44e	220
8ab83f56	221	struct probe_arg {
53305928 MH	222	struct fetch_insn *code;
53305928 MH	223	bool dynamic;/* Dynamic array (string) is used */
8ab83f56	224	unsigned int offset; /* Offset from argument entry */
40b53b77	225	unsigned int count; /* Array count */
8ab83f56 SD	226	const char name; / Name of this argument */
8ab83f56 SD	227	const char comm; / Command of this argument */
40b53b77	228	char fmt; / Format string if needed */
8ab83f56 SD	229	const struct fetch_type type; / Type of this argument */
	230	};
	231
b61387cb MH	232	struct trace_uprobe_filter {
	233	rwlock_t rwlock;
	234	int nr_systemwide;
	235	struct list_head perf_events;
	236	};
	237
60d53e2c MH	238	/* Event call and class holder */
60d53e2c MH	239	struct trace_probe_event {
c31ffb3f	240	unsigned int flags; /* For TP_FLAG_* */
2425bcb9 SRRH	241	struct trace_event_class class;
2425bcb9 SRRH	242	struct trace_event_call call;
c31ffb3f	243	struct list_head files;
60d53e2c	244	struct list_head probes;
7fac96f2	245	struct trace_uprobe_filter filter[];
60d53e2c MH	246	};
	247
	248	struct trace_probe {
	249	struct list_head list;
	250	struct trace_probe_event *event;
c31ffb3f NK	251	ssize_t size; /* trace entry size */
	252	unsigned int nr_args;
	253	struct probe_arg args[];
	254	};
	255
70ed91c6	256	struct event_file_link {
7f1d2f82	257	struct trace_event_file *file;
70ed91c6 J	258	struct list_head list;
	259	};
	260
747774d6 MH	261	static inline bool trace_probe_test_flag(struct trace_probe *tp,
	262	unsigned int flag)
	263	{
60d53e2c	264	return !!(tp->event->flags & flag);
747774d6 MH	265	}
	266
	267	static inline void trace_probe_set_flag(struct trace_probe *tp,
	268	unsigned int flag)
	269	{
60d53e2c	270	tp->event->flags \|= flag;
747774d6 MH	271	}
	272
	273	static inline void trace_probe_clear_flag(struct trace_probe *tp,
	274	unsigned int flag)
	275	{
60d53e2c	276	tp->event->flags &= ~flag;
747774d6 MH	277	}
747774d6 MH	278
c31ffb3f NK	279	static inline bool trace_probe_is_enabled(struct trace_probe *tp)
c31ffb3f NK	280	{
747774d6	281	return trace_probe_test_flag(tp, TP_FLAG_TRACE \| TP_FLAG_PROFILE);
c31ffb3f NK	282	}
c31ffb3f NK	283
b55ce203 MH	284	static inline const char trace_probe_name(struct trace_probe tp)
b55ce203 MH	285	{
60d53e2c	286	return trace_event_name(&tp->event->call);
b55ce203 MH	287	}
	288
	289	static inline const char trace_probe_group_name(struct trace_probe tp)
	290	{
60d53e2c	291	return tp->event->call.class->system;
b55ce203 MH	292	}
b55ce203 MH	293
e3dc9f89 MH	294	static inline struct trace_event_call *
	295	trace_probe_event_call(struct trace_probe *tp)
	296	{
60d53e2c MH	297	return &tp->event->call;
	298	}
	299
	300	static inline struct trace_probe_event *
	301	trace_probe_event_from_call(struct trace_event_call *event_call)
	302	{
	303	return container_of(event_call, struct trace_probe_event, call);
	304	}
	305
	306	static inline struct trace_probe *
	307	trace_probe_primary_from_call(struct trace_event_call *call)
	308	{
	309	struct trace_probe_event *tpe = trace_probe_event_from_call(call);
	310
	311	return list_first_entry(&tpe->probes, struct trace_probe, list);
	312	}
	313
	314	static inline struct list_head trace_probe_probe_list(struct trace_probe tp)
	315	{
	316	return &tp->event->probes;
e3dc9f89 MH	317	}
e3dc9f89 MH	318
ca89bc07 MH	319	static inline bool trace_probe_has_sibling(struct trace_probe *tp)
	320	{
	321	struct list_head *list = trace_probe_probe_list(tp);
	322
	323	return !list_empty(list) && !list_is_singular(list);
	324	}
	325
46e5376d MH	326	static inline int trace_probe_unregister_event_call(struct trace_probe *tp)
	327	{
	328	/* tp->event is unregistered in trace_remove_event_call() */
60d53e2c	329	return trace_remove_event_call(&tp->event->call);
46e5376d	330	}
455b2899	331
b5f935ee MH	332	static inline bool trace_probe_has_single_file(struct trace_probe *tp)
b5f935ee MH	333	{
60d53e2c	334	return !!list_is_singular(&tp->event->files);
b5f935ee MH	335	}
	336
	337	int trace_probe_init(struct trace_probe tp, const char event,
b61387cb	338	const char *group, bool alloc_filter);
b5f935ee	339	void trace_probe_cleanup(struct trace_probe *tp);
ca89bc07 MH	340	int trace_probe_append(struct trace_probe tp, struct trace_probe to);
ca89bc07 MH	341	void trace_probe_unlink(struct trace_probe *tp);
b5f935ee MH	342	int trace_probe_register_event_call(struct trace_probe *tp);
	343	int trace_probe_add_file(struct trace_probe tp, struct trace_event_file file);
	344	int trace_probe_remove_file(struct trace_probe *tp,
	345	struct trace_event_file *file);
	346	struct event_file_link trace_probe_get_file_link(struct trace_probe tp,
	347	struct trace_event_file *file);
ca89bc07	348	int trace_probe_compare_arg_type(struct trace_probe a, struct trace_probe b);
eb5bf813 MH	349	bool trace_probe_match_command_args(struct trace_probe *tp,
eb5bf813 MH	350	int argc, const char **argv);
d262271d	351	int trace_probe_create(const char raw_command, int (createfn)(int, const char **));
196b6389 SC	352	int trace_probe_print_args(struct trace_seq s, struct probe_arg args, int nr_args,
196b6389 SC	353	u8 data, void field);
b5f935ee MH	354
b5f935ee MH	355	#define trace_probe_for_each_link(pos, tp) \
60d53e2c	356	list_for_each_entry(pos, &(tp)->event->files, list)
b5f935ee	357	#define trace_probe_for_each_link_rcu(pos, tp) \
60d53e2c	358	list_for_each_entry_rcu(pos, &(tp)->event->files, list)
b5f935ee	359
a1303af5 MH	360	#define TPARG_FL_RETURN BIT(0)
	361	#define TPARG_FL_KERNEL BIT(1)
	362	#define TPARG_FL_FENTRY BIT(2)
7491e2c4	363	#define TPARG_FL_TPOINT BIT(3)
d4505aa6 MHG	364	#define TPARG_FL_USER BIT(4)
d4505aa6 MHG	365	#define TPARG_FL_MASK GENMASK(4, 0)
a1303af5	366
d00bbea9	367	extern int traceprobe_parse_probe_arg(struct trace_probe *tp, int i,
fcd9db51	368	const char *argv, unsigned int flags);
8ab83f56	369
a6682814	370	extern int traceprobe_update_arg(struct probe_arg *arg);
8ab83f56 SD	371	extern void traceprobe_free_probe_arg(struct probe_arg *arg);
8ab83f56 SD	372
c5d343b6	373	extern int traceprobe_split_symbol_offset(char symbol, long offset);
ab105a4f MH	374	int traceprobe_parse_event_name(const char pevent, const char pgroup,
ab105a4f MH	375	char *buf, int offset);
8ab83f56	376
007517a0 SRV	377	enum probe_print_type {
	378	PROBE_PRINT_NORMAL,
	379	PROBE_PRINT_RETURN,
7491e2c4	380	PROBE_PRINT_EVENT,
007517a0 SRV	381	};
	382
	383	extern int traceprobe_set_print_fmt(struct trace_probe *tp, enum probe_print_type ptype);
e12f03d7 SL	384
	385	#ifdef CONFIG_PERF_EVENTS
	386	extern struct trace_event_call *
	387	create_local_trace_kprobe(char func, void addr, unsigned long offs,
	388	bool is_return);
	389	extern void destroy_local_trace_kprobe(struct trace_event_call *event_call);
33ea4b24 SL	390
33ea4b24 SL	391	extern struct trace_event_call *
a6ca88b2 SL	392	create_local_trace_uprobe(char *name, unsigned long offs,
a6ca88b2 SL	393	unsigned long ref_ctr_offset, bool is_return);
33ea4b24	394	extern void destroy_local_trace_uprobe(struct trace_event_call *event_call);
e12f03d7	395	#endif
eeb07b06 MH	396	extern int traceprobe_define_arg_fields(struct trace_event_call *event_call,
eeb07b06 MH	397	size_t offset, struct trace_probe *tp);
ab105a4f MH	398
	399	#undef ERRORS
	400	#define ERRORS \
	401	C(FILE_NOT_FOUND, "Failed to find the given file"), \
	402	C(NO_REGULAR_FILE, "Not a regular file"), \
	403	C(BAD_REFCNT, "Invalid reference counter offset"), \
	404	C(REFCNT_OPEN_BRACE, "Reference counter brace is not closed"), \
	405	C(BAD_REFCNT_SUFFIX, "Reference counter has wrong suffix"), \
	406	C(BAD_UPROBE_OFFS, "Invalid uprobe offset"), \
	407	C(MAXACT_NO_KPROBE, "Maxactive is not for kprobe"), \
	408	C(BAD_MAXACT, "Invalid maxactive number"), \
	409	C(MAXACT_TOO_BIG, "Maxactive is too big"), \
	410	C(BAD_PROBE_ADDR, "Invalid probed address or symbol"), \
	411	C(BAD_RETPROBE, "Retprobe address must be an function entry"), \
4725cd89	412	C(BAD_ADDR_SUFFIX, "Invalid probed address suffix"), \
ab105a4f MH	413	C(NO_GROUP_NAME, "Group name is not specified"), \
	414	C(GROUP_TOO_LONG, "Group name is too long"), \
	415	C(BAD_GROUP_NAME, "Group name must follow the same rules as C identifiers"), \
	416	C(NO_EVENT_NAME, "Event name is not specified"), \
	417	C(EVENT_TOO_LONG, "Event name is too long"), \
	418	C(BAD_EVENT_NAME, "Event name must follow the same rules as C identifiers"), \
8e242060	419	C(EVENT_EXIST, "Given group/event name is already used by another event"), \
ab105a4f MH	420	C(RETVAL_ON_PROBE, "$retval is not available on probe"), \
	421	C(BAD_STACK_NUM, "Invalid stack number"), \
	422	C(BAD_ARG_NUM, "Invalid argument number"), \
	423	C(BAD_VAR, "Invalid $-valiable specified"), \
	424	C(BAD_REG_NAME, "Invalid register name"), \
	425	C(BAD_MEM_ADDR, "Invalid memory address"), \
6218bf9f	426	C(BAD_IMM, "Invalid immediate value"), \
a42e3c4d	427	C(IMMSTR_NO_CLOSE, "String is not closed with '\"'"), \
ab105a4f MH	428	C(FILE_ON_KPROBE, "File offset is not available with kprobe"), \
	429	C(BAD_FILE_OFFS, "Invalid file offset value"), \
	430	C(SYM_ON_UPROBE, "Symbol is not available with uprobe"), \
	431	C(TOO_MANY_OPS, "Dereference is too much nested"), \
	432	C(DEREF_NEED_BRACE, "Dereference needs a brace"), \
	433	C(BAD_DEREF_OFFS, "Invalid dereference offset"), \
	434	C(DEREF_OPEN_BRACE, "Dereference brace is not closed"), \
	435	C(COMM_CANT_DEREF, "$comm can not be dereferenced"), \
	436	C(BAD_FETCH_ARG, "Invalid fetch argument"), \
	437	C(ARRAY_NO_CLOSE, "Array is not closed"), \
	438	C(BAD_ARRAY_SUFFIX, "Array has wrong suffix"), \
	439	C(BAD_ARRAY_NUM, "Invalid array size"), \
	440	C(ARRAY_TOO_BIG, "Array number is too big"), \
	441	C(BAD_TYPE, "Unknown type is specified"), \
	442	C(BAD_STRING, "String accepts only memory argument"), \
b26a124c	443	C(BAD_SYMSTRING, "Symbol String doesn't accept data/userdata"), \
ab105a4f MH	444	C(BAD_BITFIELD, "Invalid bitfield"), \
	445	C(ARG_NAME_TOO_LONG, "Argument name is too long"), \
	446	C(NO_ARG_NAME, "Argument name is not specified"), \
	447	C(BAD_ARG_NAME, "Argument name must follow the same rules as C identifiers"), \
	448	C(USED_ARG_NAME, "This argument name is already used"), \
	449	C(ARG_TOO_LONG, "Argument expression is too long"), \
	450	C(NO_ARG_BODY, "No argument expression"), \
	451	C(BAD_INSN_BNDRY, "Probe point is not an instruction boundary"),\
ca89bc07 MH	452	C(FAIL_REG_PROBE, "Failed to register probe event"),\
ca89bc07 MH	453	C(DIFF_PROBE_TYPE, "Probe type is different from existing probe"),\
fe60b0ce	454	C(DIFF_ARG_TYPE, "Argument type or name is different from existing probe"),\
2f63e5d2 MHG	455	C(SAME_PROBE, "There is already the exact same probe event"),\
	456	C(NO_EVENT_INFO, "This requires both group and event name to attach"),\
	457	C(BAD_ATTACH_EVENT, "Attached event does not exist"),\
752be5c5 MHG	458	C(BAD_ATTACH_ARG, "Attached event does not have this field"),\
752be5c5 MHG	459	C(NO_EP_FILTER, "No filter rule after 'if'"),
ab105a4f MH	460
	461	#undef C
	462	#define C(a, b) TP_ERR_##a
	463
	464	/* Define TP_ERR_ */
	465	enum { ERRORS };
	466
	467	/* Error text is defined in trace_probe.c */
	468
	469	struct trace_probe_log {
	470	const char *subsystem;
	471	const char **argv;
	472	int argc;
	473	int index;
	474	};
	475
	476	void trace_probe_log_init(const char subsystem, int argc, const char *argv);
	477	void trace_probe_log_set_index(int index);
	478	void trace_probe_log_clear(void);
	479	void __trace_probe_log_err(int offset, int err);
	480
	481	#define trace_probe_log_err(offs, err) \
	482	__trace_probe_log_err(offs, TP_ERR_##err)