[mirror_ubuntu-bionic-kernel.git] / include / linux / uprobes.h

#ifndef _LINUX_UPROBES_H
#define _LINUX_UPROBES_H
/*
 * User-space Probes (UProbes)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * Copyright (C) IBM Corporation, 2008-2012
 * Authors:
 *	Srikar Dronamraju
 *	Jim Keniston
 * Copyright (C) 2011-2012 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
 */

#include <linux/errno.h>
#include <linux/rbtree.h>
#include <linux/types.h>

struct vm_area_struct;
struct mm_struct;
struct inode;
struct notifier_block;
struct page;

#define UPROBE_HANDLER_REMOVE		1
#define UPROBE_HANDLER_MASK		1

#define MAX_URETPROBE_DEPTH		64

enum uprobe_filter_ctx {
	UPROBE_FILTER_REGISTER,
	UPROBE_FILTER_UNREGISTER,
	UPROBE_FILTER_MMAP,
};

struct uprobe_consumer {
	int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs);
	int (*ret_handler)(struct uprobe_consumer *self,
				unsigned long func,
				struct pt_regs *regs);
	bool (*filter)(struct uprobe_consumer *self,
				enum uprobe_filter_ctx ctx,
				struct mm_struct *mm);

	struct uprobe_consumer *next;
};

#ifdef CONFIG_UPROBES
#include <asm/uprobes.h>

enum uprobe_task_state {
	UTASK_RUNNING,
	UTASK_SSTEP,
	UTASK_SSTEP_ACK,
	UTASK_SSTEP_TRAPPED,
};

/*
 * uprobe_task: Metadata of a task while it singlesteps.
 */
struct uprobe_task {
	enum uprobe_task_state		state;

	union {
		struct {
			struct arch_uprobe_task	autask;
			unsigned long		vaddr;
		};

		struct {
			struct callback_head	dup_xol_work;
			unsigned long		dup_xol_addr;
		};
	};

	struct uprobe			*active_uprobe;
	unsigned long			xol_vaddr;

	struct return_instance		*return_instances;
	unsigned int			depth;
};

struct return_instance {
	struct uprobe		*uprobe;
	unsigned long		func;
	unsigned long		orig_ret_vaddr; /* original return address */
	bool			chained;	/* true, if instance is nested */

	struct return_instance	*next;		/* keep as stack */
};

struct xol_area;

struct uprobes_state {
	struct xol_area		*xol_area;
};

extern int set_swbp(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
extern int set_orig_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
extern bool is_swbp_insn(uprobe_opcode_t *insn);
extern bool is_trap_insn(uprobe_opcode_t *insn);
extern unsigned long uprobe_get_swbp_addr(struct pt_regs *regs);
extern unsigned long uprobe_get_trap_addr(struct pt_regs *regs);
extern int uprobe_write_opcode(struct mm_struct *mm, unsigned long vaddr, uprobe_opcode_t);
extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
extern int uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool);
extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
extern int uprobe_mmap(struct vm_area_struct *vma);
extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end);
extern void uprobe_start_dup_mmap(void);
extern void uprobe_end_dup_mmap(void);
extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm);
extern void uprobe_free_utask(struct task_struct *t);
extern void uprobe_copy_process(struct task_struct *t, unsigned long flags);
extern int uprobe_post_sstep_notifier(struct pt_regs *regs);
extern int uprobe_pre_sstep_notifier(struct pt_regs *regs);
extern void uprobe_notify_resume(struct pt_regs *regs);
extern bool uprobe_deny_signal(void);
extern bool arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs);
extern void uprobe_clear_state(struct mm_struct *mm);
extern int  arch_uprobe_analyze_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long addr);
extern int  arch_uprobe_pre_xol(struct arch_uprobe *aup, struct pt_regs *regs);
extern int  arch_uprobe_post_xol(struct arch_uprobe *aup, struct pt_regs *regs);
extern bool arch_uprobe_xol_was_trapped(struct task_struct *tsk);
extern int  arch_uprobe_exception_notify(struct notifier_block *self, unsigned long val, void *data);
extern void arch_uprobe_abort_xol(struct arch_uprobe *aup, struct pt_regs *regs);
extern unsigned long arch_uretprobe_hijack_return_addr(unsigned long trampoline_vaddr, struct pt_regs *regs);
extern bool arch_uretprobe_is_alive(struct return_instance *ret, struct pt_regs *regs);
extern bool arch_uprobe_ignore(struct arch_uprobe *aup, struct pt_regs *regs);
extern void arch_uprobe_copy_ixol(struct page *page, unsigned long vaddr,
					 void *src, unsigned long len);
#else /* !CONFIG_UPROBES */
struct uprobes_state {
};

#define uprobe_get_trap_addr(regs)	instruction_pointer(regs)

static inline int
uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
{
	return -ENOSYS;
}
static inline int
uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool add)
{
	return -ENOSYS;
}
static inline void
uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
{
}
static inline int uprobe_mmap(struct vm_area_struct *vma)
{
	return 0;
}
static inline void
uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
{
}
static inline void uprobe_start_dup_mmap(void)
{
}
static inline void uprobe_end_dup_mmap(void)
{
}
static inline void
uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm)
{
}
static inline void uprobe_notify_resume(struct pt_regs *regs)
{
}
static inline bool uprobe_deny_signal(void)
{
	return false;
}
static inline void uprobe_free_utask(struct task_struct *t)
{
}
static inline void uprobe_copy_process(struct task_struct *t, unsigned long flags)
{
}
static inline void uprobe_clear_state(struct mm_struct *mm)
{
}
#endif /* !CONFIG_UPROBES */
#endif	/* _LINUX_UPROBES_H */
Commit	Line	Data
2b144498 SD	1	#ifndef _LINUX_UPROBES_H
	2	#define _LINUX_UPROBES_H
	3	/*
7b2d81d4	4	* User-space Probes (UProbes)
2b144498 SD	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	19	*
35aa621b	20	* Copyright (C) IBM Corporation, 2008-2012
2b144498 SD	21	* Authors:
	22	* Srikar Dronamraju
	23	* Jim Keniston
35aa621b	24	* Copyright (C) 2011-2012 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
2b144498 SD	25	*/
	26
	27	#include <linux/errno.h>
	28	#include <linux/rbtree.h>
32473431	29	#include <linux/types.h>
2b144498 SD	30
2b144498 SD	31	struct vm_area_struct;
d4b3b638 SD	32	struct mm_struct;
d4b3b638 SD	33	struct inode;
3820b4d2	34	struct notifier_block;
72e6ae28	35	struct page;
0326f5a9	36
da1816b1 ON	37	#define UPROBE_HANDLER_REMOVE 1
	38	#define UPROBE_HANDLER_MASK 1
	39
ded49c55 AA	40	#define MAX_URETPROBE_DEPTH 64
ded49c55 AA	41
8a7f2fa0 ON	42	enum uprobe_filter_ctx {
	43	UPROBE_FILTER_REGISTER,
	44	UPROBE_FILTER_UNREGISTER,
	45	UPROBE_FILTER_MMAP,
	46	};
	47
2b144498 SD	48	struct uprobe_consumer {
2b144498 SD	49	int (handler)(struct uprobe_consumer self, struct pt_regs *regs);
ea024870 AA	50	int (ret_handler)(struct uprobe_consumer self,
	51	unsigned long func,
	52	struct pt_regs *regs);
8a7f2fa0 ON	53	bool (filter)(struct uprobe_consumer self,
	54	enum uprobe_filter_ctx ctx,
	55	struct mm_struct *mm);
2b144498 SD	56
	57	struct uprobe_consumer *next;
	58	};
	59
2b144498	60	#ifdef CONFIG_UPROBES
c912dae6 ON	61	#include <asm/uprobes.h>
c912dae6 ON	62
0326f5a9 SD	63	enum uprobe_task_state {
0326f5a9 SD	64	UTASK_RUNNING,
0326f5a9 SD	65	UTASK_SSTEP,
	66	UTASK_SSTEP_ACK,
	67	UTASK_SSTEP_TRAPPED,
	68	};
	69
	70	/*
	71	* uprobe_task: Metadata of a task while it singlesteps.
	72	*/
	73	struct uprobe_task {
	74	enum uprobe_task_state state;
0326f5a9	75
32473431 ON	76	union {
	77	struct {
	78	struct arch_uprobe_task autask;
	79	unsigned long vaddr;
	80	};
	81
	82	struct {
	83	struct callback_head dup_xol_work;
	84	unsigned long dup_xol_addr;
	85	};
	86	};
0326f5a9	87
32473431	88	struct uprobe *active_uprobe;
0326f5a9	89	unsigned long xol_vaddr;
32473431 ON	90
	91	struct return_instance *return_instances;
	92	unsigned int depth;
0326f5a9 SD	93	};
0326f5a9 SD	94
97da8976 ON	95	struct return_instance {
	96	struct uprobe *uprobe;
	97	unsigned long func;
	98	unsigned long orig_ret_vaddr; /* original return address */
	99	bool chained; /* true, if instance is nested */
	100
	101	struct return_instance next; / keep as stack */
	102	};
	103
c912dae6	104	struct xol_area;
d4b3b638 SD	105
	106	struct uprobes_state {
	107	struct xol_area *xol_area;
	108	};
647c42df	109
271a9c35 BH	110	extern int set_swbp(struct arch_uprobe aup, struct mm_struct mm, unsigned long vaddr);
	111	extern int set_orig_insn(struct arch_uprobe aup, struct mm_struct mm, unsigned long vaddr);
	112	extern bool is_swbp_insn(uprobe_opcode_t *insn);
	113	extern bool is_trap_insn(uprobe_opcode_t *insn);
	114	extern unsigned long uprobe_get_swbp_addr(struct pt_regs *regs);
b02ef20a	115	extern unsigned long uprobe_get_trap_addr(struct pt_regs *regs);
f72d41fa	116	extern int uprobe_write_opcode(struct mm_struct *mm, unsigned long vaddr, uprobe_opcode_t);
e3343e6a	117	extern int uprobe_register(struct inode inode, loff_t offset, struct uprobe_consumer uc);
bdf8647c	118	extern int uprobe_apply(struct inode inode, loff_t offset, struct uprobe_consumer uc, bool);
e3343e6a	119	extern void uprobe_unregister(struct inode inode, loff_t offset, struct uprobe_consumer uc);
7b2d81d4	120	extern int uprobe_mmap(struct vm_area_struct *vma);
cbc91f71	121	extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end);
32cdba1e ON	122	extern void uprobe_start_dup_mmap(void);
32cdba1e ON	123	extern void uprobe_end_dup_mmap(void);
f8ac4ec9	124	extern void uprobe_dup_mmap(struct mm_struct oldmm, struct mm_struct newmm);
0326f5a9	125	extern void uprobe_free_utask(struct task_struct *t);
3ab67966	126	extern void uprobe_copy_process(struct task_struct *t, unsigned long flags);
0326f5a9 SD	127	extern int uprobe_post_sstep_notifier(struct pt_regs *regs);
	128	extern int uprobe_pre_sstep_notifier(struct pt_regs *regs);
	129	extern void uprobe_notify_resume(struct pt_regs *regs);
	130	extern bool uprobe_deny_signal(void);
c2d3f25d	131	extern bool arch_uprobe_skip_sstep(struct arch_uprobe aup, struct pt_regs regs);
d4b3b638	132	extern void uprobe_clear_state(struct mm_struct *mm);
3820b4d2 DL	133	extern int arch_uprobe_analyze_insn(struct arch_uprobe aup, struct mm_struct mm, unsigned long addr);
	134	extern int arch_uprobe_pre_xol(struct arch_uprobe aup, struct pt_regs regs);
	135	extern int arch_uprobe_post_xol(struct arch_uprobe aup, struct pt_regs regs);
	136	extern bool arch_uprobe_xol_was_trapped(struct task_struct *tsk);
	137	extern int arch_uprobe_exception_notify(struct notifier_block self, unsigned long val, void data);
	138	extern void arch_uprobe_abort_xol(struct arch_uprobe aup, struct pt_regs regs);
	139	extern unsigned long arch_uretprobe_hijack_return_addr(unsigned long trampoline_vaddr, struct pt_regs *regs);
97da8976	140	extern bool arch_uretprobe_is_alive(struct return_instance ret, struct pt_regs regs);
271a9c35 BH	141	extern bool arch_uprobe_ignore(struct arch_uprobe aup, struct pt_regs regs);
271a9c35 BH	142	extern void arch_uprobe_copy_ixol(struct page *page, unsigned long vaddr,
72e6ae28	143	void *src, unsigned long len);
0326f5a9	144	#else /* !CONFIG_UPROBES */
d4b3b638 SD	145	struct uprobes_state {
d4b3b638 SD	146	};
b02ef20a ON	147
	148	#define uprobe_get_trap_addr(regs) instruction_pointer(regs)
	149
7b2d81d4	150	static inline int
e3343e6a	151	uprobe_register(struct inode inode, loff_t offset, struct uprobe_consumer uc)
2b144498 SD	152	{
	153	return -ENOSYS;
	154	}
bdf8647c ON	155	static inline int
	156	uprobe_apply(struct inode inode, loff_t offset, struct uprobe_consumer uc, bool add)
	157	{
	158	return -ENOSYS;
	159	}
7b2d81d4	160	static inline void
e3343e6a	161	uprobe_unregister(struct inode inode, loff_t offset, struct uprobe_consumer uc)
2b144498 SD	162	{
2b144498 SD	163	}
7b2d81d4	164	static inline int uprobe_mmap(struct vm_area_struct *vma)
2b144498 SD	165	{
	166	return 0;
	167	}
cbc91f71 SD	168	static inline void
cbc91f71 SD	169	uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
682968e0 SD	170	{
682968e0 SD	171	}
32cdba1e ON	172	static inline void uprobe_start_dup_mmap(void)
	173	{
	174	}
	175	static inline void uprobe_end_dup_mmap(void)
	176	{
	177	}
f8ac4ec9 ON	178	static inline void
	179	uprobe_dup_mmap(struct mm_struct oldmm, struct mm_struct newmm)
	180	{
	181	}
0326f5a9 SD	182	static inline void uprobe_notify_resume(struct pt_regs *regs)
	183	{
	184	}
	185	static inline bool uprobe_deny_signal(void)
	186	{
	187	return false;
	188	}
0326f5a9 SD	189	static inline void uprobe_free_utask(struct task_struct *t)
	190	{
	191	}
3ab67966	192	static inline void uprobe_copy_process(struct task_struct *t, unsigned long flags)
0326f5a9 SD	193	{
0326f5a9 SD	194	}
d4b3b638 SD	195	static inline void uprobe_clear_state(struct mm_struct *mm)
	196	{
	197	}
0326f5a9	198	#endif /* !CONFIG_UPROBES */
2b144498	199	#endif /* _LINUX_UPROBES_H */