]> git.openfabrics.org - ~shefty/rdma-dev.git/blob - include/linux/uprobes.h
Merge branch 'linus' into perf/core
[~shefty/rdma-dev.git] / include / linux / uprobes.h
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
30 struct vm_area_struct;
31 struct mm_struct;
32 struct inode;
33
34 #ifdef CONFIG_ARCH_SUPPORTS_UPROBES
35 # include <asm/uprobes.h>
36 #endif
37
38 struct uprobe_consumer {
39         int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs);
40         /*
41          * filter is optional; If a filter exists, handler is run
42          * if and only if filter returns true.
43          */
44         bool (*filter)(struct uprobe_consumer *self, struct task_struct *task);
45
46         struct uprobe_consumer *next;
47 };
48
49 #ifdef CONFIG_UPROBES
50 enum uprobe_task_state {
51         UTASK_RUNNING,
52         UTASK_SSTEP,
53         UTASK_SSTEP_ACK,
54         UTASK_SSTEP_TRAPPED,
55 };
56
57 /*
58  * uprobe_task: Metadata of a task while it singlesteps.
59  */
60 struct uprobe_task {
61         enum uprobe_task_state          state;
62         struct arch_uprobe_task         autask;
63
64         struct uprobe                   *active_uprobe;
65
66         unsigned long                   xol_vaddr;
67         unsigned long                   vaddr;
68 };
69
70 /*
71  * On a breakpoint hit, thread contests for a slot.  It frees the
72  * slot after singlestep. Currently a fixed number of slots are
73  * allocated.
74  */
75 struct xol_area {
76         wait_queue_head_t       wq;             /* if all slots are busy */
77         atomic_t                slot_count;     /* number of in-use slots */
78         unsigned long           *bitmap;        /* 0 = free slot */
79         struct page             *page;
80
81         /*
82          * We keep the vma's vm_start rather than a pointer to the vma
83          * itself.  The probed process or a naughty kernel module could make
84          * the vma go away, and we must handle that reasonably gracefully.
85          */
86         unsigned long           vaddr;          /* Page(s) of instruction slots */
87 };
88
89 struct uprobes_state {
90         struct xol_area         *xol_area;
91 };
92
93 extern int __weak set_swbp(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
94 extern int __weak set_orig_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
95 extern bool __weak is_swbp_insn(uprobe_opcode_t *insn);
96 extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
97 extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
98 extern int uprobe_mmap(struct vm_area_struct *vma);
99 extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end);
100 extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm);
101 extern void uprobe_free_utask(struct task_struct *t);
102 extern void uprobe_copy_process(struct task_struct *t);
103 extern unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs);
104 extern void __weak arch_uprobe_enable_step(struct arch_uprobe *arch);
105 extern void __weak arch_uprobe_disable_step(struct arch_uprobe *arch);
106 extern int uprobe_post_sstep_notifier(struct pt_regs *regs);
107 extern int uprobe_pre_sstep_notifier(struct pt_regs *regs);
108 extern void uprobe_notify_resume(struct pt_regs *regs);
109 extern bool uprobe_deny_signal(void);
110 extern bool __weak arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs);
111 extern void uprobe_clear_state(struct mm_struct *mm);
112 #else /* !CONFIG_UPROBES */
113 struct uprobes_state {
114 };
115 static inline int
116 uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
117 {
118         return -ENOSYS;
119 }
120 static inline void
121 uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
122 {
123 }
124 static inline int uprobe_mmap(struct vm_area_struct *vma)
125 {
126         return 0;
127 }
128 static inline void
129 uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
130 {
131 }
132 static inline void
133 uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm)
134 {
135 }
136 static inline void uprobe_notify_resume(struct pt_regs *regs)
137 {
138 }
139 static inline bool uprobe_deny_signal(void)
140 {
141         return false;
142 }
143 static inline unsigned long uprobe_get_swbp_addr(struct pt_regs *regs)
144 {
145         return 0;
146 }
147 static inline void uprobe_free_utask(struct task_struct *t)
148 {
149 }
150 static inline void uprobe_copy_process(struct task_struct *t)
151 {
152 }
153 static inline void uprobe_clear_state(struct mm_struct *mm)
154 {
155 }
156 #endif /* !CONFIG_UPROBES */
157 #endif  /* _LINUX_UPROBES_H */