9c6be62787ed596ccdca61cd4f7887aea5326eb5
[firefly-linux-kernel-4.4.55.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-2011
21  * Authors:
22  *      Srikar Dronamraju
23  *      Jim Keniston
24  */
25
26 #include <linux/errno.h>
27 #include <linux/rbtree.h>
28
29 struct vm_area_struct;
30 #ifdef CONFIG_ARCH_SUPPORTS_UPROBES
31 #include <asm/uprobes.h>
32 #endif
33
34 /* flags that denote/change uprobes behaviour */
35
36 /* Have a copy of original instruction */
37 #define UPROBES_COPY_INSN       0x1
38
39 /* Dont run handlers when first register/ last unregister in progress*/
40 #define UPROBES_RUN_HANDLER     0x2
41
42 struct uprobe_consumer {
43         int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs);
44         /*
45          * filter is optional; If a filter exists, handler is run
46          * if and only if filter returns true.
47          */
48         bool (*filter)(struct uprobe_consumer *self, struct task_struct *task);
49
50         struct uprobe_consumer *next;
51 };
52
53 #ifdef CONFIG_UPROBES
54 extern int __weak set_bkpt(struct mm_struct *mm, struct arch_uprobe *auprobe, unsigned long vaddr);
55 extern int __weak set_orig_insn(struct mm_struct *mm, struct arch_uprobe *auprobe, unsigned long vaddr, bool verify);
56 extern bool __weak is_bkpt_insn(uprobe_opcode_t *insn);
57 extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *consumer);
58 extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *consumer);
59 extern int uprobe_mmap(struct vm_area_struct *vma);
60 #else /* CONFIG_UPROBES is not defined */
61 static inline int
62 uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *consumer)
63 {
64         return -ENOSYS;
65 }
66 static inline void
67 uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *consumer)
68 {
69 }
70 static inline int uprobe_mmap(struct vm_area_struct *vma)
71 {
72         return 0;
73 }
74 #endif /* CONFIG_UPROBES */
75 #endif  /* _LINUX_UPROBES_H */