Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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;
35
36#define UPROBE_HANDLER_REMOVE 1
37#define UPROBE_HANDLER_MASK 1
38
39#define MAX_URETPROBE_DEPTH 64
40
41enum uprobe_filter_ctx {
42 UPROBE_FILTER_REGISTER,
43 UPROBE_FILTER_UNREGISTER,
44 UPROBE_FILTER_MMAP,
45};
46
47struct uprobe_consumer {
48 int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs);
49 int (*ret_handler)(struct uprobe_consumer *self,
50 unsigned long func,
51 struct pt_regs *regs);
52 bool (*filter)(struct uprobe_consumer *self,
53 enum uprobe_filter_ctx ctx,
54 struct mm_struct *mm);
55
56 struct uprobe_consumer *next;
57};
58
59#ifdef CONFIG_UPROBES
60#include <asm/uprobes.h>
61
62enum uprobe_task_state {
63 UTASK_RUNNING,
64 UTASK_SSTEP,
65 UTASK_SSTEP_ACK,
66 UTASK_SSTEP_TRAPPED,
67};
68
69/*
70 * uprobe_task: Metadata of a task while it singlesteps.
71 */
72struct uprobe_task {
73 enum uprobe_task_state state;
74
75 union {
76 struct {
77 struct arch_uprobe_task autask;
78 unsigned long vaddr;
79 };
80
81 struct {
82 struct callback_head dup_xol_work;
83 unsigned long dup_xol_addr;
84 };
85 };
86
87 struct uprobe *active_uprobe;
88 unsigned long xol_vaddr;
89
90 struct return_instance *return_instances;
91 unsigned int depth;
92};
93
94struct xol_area;
95
96struct uprobes_state {
97 struct xol_area *xol_area;
98};
99
100extern int __weak set_swbp(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
101extern int __weak set_orig_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
102extern bool __weak is_swbp_insn(uprobe_opcode_t *insn);
103extern bool __weak is_trap_insn(uprobe_opcode_t *insn);
104extern unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs);
105extern int uprobe_write_opcode(struct mm_struct *mm, unsigned long vaddr, uprobe_opcode_t);
106extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
107extern int uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool);
108extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
109extern int uprobe_mmap(struct vm_area_struct *vma);
110extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end);
111extern void uprobe_start_dup_mmap(void);
112extern void uprobe_end_dup_mmap(void);
113extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm);
114extern void uprobe_free_utask(struct task_struct *t);
115extern void uprobe_copy_process(struct task_struct *t, unsigned long flags);
116extern int uprobe_post_sstep_notifier(struct pt_regs *regs);
117extern int uprobe_pre_sstep_notifier(struct pt_regs *regs);
118extern void uprobe_notify_resume(struct pt_regs *regs);
119extern bool uprobe_deny_signal(void);
120extern bool arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs);
121extern void uprobe_clear_state(struct mm_struct *mm);
122extern int arch_uprobe_analyze_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long addr);
123extern int arch_uprobe_pre_xol(struct arch_uprobe *aup, struct pt_regs *regs);
124extern int arch_uprobe_post_xol(struct arch_uprobe *aup, struct pt_regs *regs);
125extern bool arch_uprobe_xol_was_trapped(struct task_struct *tsk);
126extern int arch_uprobe_exception_notify(struct notifier_block *self, unsigned long val, void *data);
127extern void arch_uprobe_abort_xol(struct arch_uprobe *aup, struct pt_regs *regs);
128extern unsigned long arch_uretprobe_hijack_return_addr(unsigned long trampoline_vaddr, struct pt_regs *regs);
129#else /* !CONFIG_UPROBES */
130struct uprobes_state {
131};
132static inline int
133uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
134{
135 return -ENOSYS;
136}
137static inline int
138uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool add)
139{
140 return -ENOSYS;
141}
142static inline void
143uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
144{
145}
146static inline int uprobe_mmap(struct vm_area_struct *vma)
147{
148 return 0;
149}
150static inline void
151uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
152{
153}
154static inline void uprobe_start_dup_mmap(void)
155{
156}
157static inline void uprobe_end_dup_mmap(void)
158{
159}
160static inline void
161uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm)
162{
163}
164static inline void uprobe_notify_resume(struct pt_regs *regs)
165{
166}
167static inline bool uprobe_deny_signal(void)
168{
169 return false;
170}
171static inline void uprobe_free_utask(struct task_struct *t)
172{
173}
174static inline void uprobe_copy_process(struct task_struct *t, unsigned long flags)
175{
176}
177static inline void uprobe_clear_state(struct mm_struct *mm)
178{
179}
180#endif /* !CONFIG_UPROBES */
181#endif /* _LINUX_UPROBES_H */