1#ifndef _LINUX_UPROBES_H
2#define _LINUX_UPROBES_H
3/*
4 * User-space Probes (UProbes)
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 *
20 * Copyright (C) IBM Corporation, 2008-2012
21 * Authors:
22 *	Srikar Dronamraju
23 *	Jim Keniston
24 * Copyright (C) 2011-2012 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
25 */
26
27#include <linux/errno.h>
28#include <linux/rbtree.h>
29#include <linux/types.h>
30
31struct vm_area_struct;
32struct mm_struct;
33struct inode;
34struct notifier_block;
35struct page;
36
37#define UPROBE_HANDLER_REMOVE		1
38#define UPROBE_HANDLER_MASK		1
39
40#define MAX_URETPROBE_DEPTH		64
41
42enum uprobe_filter_ctx {
43	UPROBE_FILTER_REGISTER,
44	UPROBE_FILTER_UNREGISTER,
45	UPROBE_FILTER_MMAP,
46};
47
48struct uprobe_consumer {
49	int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs);
50	int (*ret_handler)(struct uprobe_consumer *self,
51				unsigned long func,
52				struct pt_regs *regs);
53	bool (*filter)(struct uprobe_consumer *self,
54				enum uprobe_filter_ctx ctx,
55				struct mm_struct *mm);
56
57	struct uprobe_consumer *next;
58};
59
60#ifdef CONFIG_UPROBES
61#include <asm/uprobes.h>
62
63enum uprobe_task_state {
64	UTASK_RUNNING,
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 */
73struct uprobe_task {
74	enum uprobe_task_state		state;
75
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	};
87
88	struct uprobe			*active_uprobe;
89	unsigned long			xol_vaddr;
90
91	struct return_instance		*return_instances;
92	unsigned int			depth;
93};
94
95struct xol_area;
96
97struct uprobes_state {
98	struct xol_area		*xol_area;
99};
100
101extern int set_swbp(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
102extern int set_orig_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
103extern bool is_swbp_insn(uprobe_opcode_t *insn);
104extern bool is_trap_insn(uprobe_opcode_t *insn);
105extern unsigned long uprobe_get_swbp_addr(struct pt_regs *regs);
106extern unsigned long uprobe_get_trap_addr(struct pt_regs *regs);
107extern int uprobe_write_opcode(struct mm_struct *mm, unsigned long vaddr, uprobe_opcode_t);
108extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
109extern int uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool);
110extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
111extern int uprobe_mmap(struct vm_area_struct *vma);
112extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end);
113extern void uprobe_start_dup_mmap(void);
114extern void uprobe_end_dup_mmap(void);
115extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm);
116extern void uprobe_free_utask(struct task_struct *t);
117extern void uprobe_copy_process(struct task_struct *t, unsigned long flags);
118extern int uprobe_post_sstep_notifier(struct pt_regs *regs);
119extern int uprobe_pre_sstep_notifier(struct pt_regs *regs);
120extern void uprobe_notify_resume(struct pt_regs *regs);
121extern bool uprobe_deny_signal(void);
122extern bool arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs);
123extern void uprobe_clear_state(struct mm_struct *mm);
124extern int  arch_uprobe_analyze_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long addr);
125extern int  arch_uprobe_pre_xol(struct arch_uprobe *aup, struct pt_regs *regs);
126extern int  arch_uprobe_post_xol(struct arch_uprobe *aup, struct pt_regs *regs);
127extern bool arch_uprobe_xol_was_trapped(struct task_struct *tsk);
128extern int  arch_uprobe_exception_notify(struct notifier_block *self, unsigned long val, void *data);
129extern void arch_uprobe_abort_xol(struct arch_uprobe *aup, struct pt_regs *regs);
130extern unsigned long arch_uretprobe_hijack_return_addr(unsigned long trampoline_vaddr, struct pt_regs *regs);
131extern bool arch_uprobe_ignore(struct arch_uprobe *aup, struct pt_regs *regs);
132extern void arch_uprobe_copy_ixol(struct page *page, unsigned long vaddr,
133					 void *src, unsigned long len);
134#else /* !CONFIG_UPROBES */
135struct uprobes_state {
136};
137
138#define uprobe_get_trap_addr(regs)	instruction_pointer(regs)
139
140static inline int
141uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
142{
143	return -ENOSYS;
144}
145static inline int
146uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool add)
147{
148	return -ENOSYS;
149}
150static inline void
151uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
152{
153}
154static inline int uprobe_mmap(struct vm_area_struct *vma)
155{
156	return 0;
157}
158static inline void
159uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
160{
161}
162static inline void uprobe_start_dup_mmap(void)
163{
164}
165static inline void uprobe_end_dup_mmap(void)
166{
167}
168static inline void
169uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm)
170{
171}
172static inline void uprobe_notify_resume(struct pt_regs *regs)
173{
174}
175static inline bool uprobe_deny_signal(void)
176{
177	return false;
178}
179static inline void uprobe_free_utask(struct task_struct *t)
180{
181}
182static inline void uprobe_copy_process(struct task_struct *t, unsigned long flags)
183{
184}
185static inline void uprobe_clear_state(struct mm_struct *mm)
186{
187}
188#endif /* !CONFIG_UPROBES */
189#endif	/* _LINUX_UPROBES_H */
190