blob: 5ec778fdce6f13d4331f463691aae2ae4873ca7c [file] [log] [blame]
Srikar Dronamraju2b144492012-02-09 14:56:42 +05301#ifndef _LINUX_UPROBES_H
2#define _LINUX_UPROBES_H
3/*
Ingo Molnar7b2d81d2012-02-17 09:27:41 +01004 * User-space Probes (UProbes)
Srikar Dronamraju2b144492012-02-09 14:56:42 +05305 *
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 *
Ingo Molnar35aa6212012-02-22 11:37:29 +010020 * Copyright (C) IBM Corporation, 2008-2012
Srikar Dronamraju2b144492012-02-09 14:56:42 +053021 * Authors:
22 * Srikar Dronamraju
23 * Jim Keniston
Ingo Molnar35aa6212012-02-22 11:37:29 +010024 * Copyright (C) 2011-2012 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
Srikar Dronamraju2b144492012-02-09 14:56:42 +053025 */
26
27#include <linux/errno.h>
28#include <linux/rbtree.h>
29
30struct vm_area_struct;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053031
Srikar Dronamraju2b144492012-02-09 14:56:42 +053032#ifdef CONFIG_ARCH_SUPPORTS_UPROBES
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053033# include <asm/uprobes.h>
Srikar Dronamraju2b144492012-02-09 14:56:42 +053034#endif
35
Srikar Dronamraju2b144492012-02-09 14:56:42 +053036/* flags that denote/change uprobes behaviour */
Ingo Molnar7b2d81d2012-02-17 09:27:41 +010037
Srikar Dronamraju2b144492012-02-09 14:56:42 +053038/* Have a copy of original instruction */
Srikar Dronamraju900771a2012-03-12 14:55:14 +053039#define UPROBE_COPY_INSN 0x1
Ingo Molnar7b2d81d2012-02-17 09:27:41 +010040
Srikar Dronamraju2b144492012-02-09 14:56:42 +053041/* Dont run handlers when first register/ last unregister in progress*/
Srikar Dronamraju900771a2012-03-12 14:55:14 +053042#define UPROBE_RUN_HANDLER 0x2
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053043/* Can skip singlestep */
44#define UPROBE_SKIP_SSTEP 0x4
Srikar Dronamraju2b144492012-02-09 14:56:42 +053045
46struct uprobe_consumer {
47 int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs);
48 /*
49 * filter is optional; If a filter exists, handler is run
50 * if and only if filter returns true.
51 */
52 bool (*filter)(struct uprobe_consumer *self, struct task_struct *task);
53
54 struct uprobe_consumer *next;
55};
56
Srikar Dronamraju2b144492012-02-09 14:56:42 +053057#ifdef CONFIG_UPROBES
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053058enum uprobe_task_state {
59 UTASK_RUNNING,
60 UTASK_BP_HIT,
61 UTASK_SSTEP,
62 UTASK_SSTEP_ACK,
63 UTASK_SSTEP_TRAPPED,
64};
65
66/*
67 * uprobe_task: Metadata of a task while it singlesteps.
68 */
69struct uprobe_task {
70 enum uprobe_task_state state;
71 struct arch_uprobe_task autask;
72
73 struct uprobe *active_uprobe;
74
75 unsigned long xol_vaddr;
76 unsigned long vaddr;
77};
78
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +053079extern int __weak set_swbp(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
Srikar Dronamrajue3343e62012-03-12 14:55:30 +053080extern int __weak set_orig_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr, bool verify);
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +053081extern bool __weak is_swbp_insn(uprobe_opcode_t *insn);
Srikar Dronamrajue3343e62012-03-12 14:55:30 +053082extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
83extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +010084extern int uprobe_mmap(struct vm_area_struct *vma);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053085extern void uprobe_free_utask(struct task_struct *t);
86extern void uprobe_copy_process(struct task_struct *t);
87extern unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs);
88extern int uprobe_post_sstep_notifier(struct pt_regs *regs);
89extern int uprobe_pre_sstep_notifier(struct pt_regs *regs);
90extern void uprobe_notify_resume(struct pt_regs *regs);
91extern bool uprobe_deny_signal(void);
92extern bool __weak arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs);
93#else /* !CONFIG_UPROBES */
Ingo Molnar7b2d81d2012-02-17 09:27:41 +010094static inline int
Srikar Dronamrajue3343e62012-03-12 14:55:30 +053095uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +053096{
97 return -ENOSYS;
98}
Ingo Molnar7b2d81d2012-02-17 09:27:41 +010099static inline void
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530100uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530101{
102}
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100103static inline int uprobe_mmap(struct vm_area_struct *vma)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530104{
105 return 0;
106}
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530107static inline void uprobe_notify_resume(struct pt_regs *regs)
108{
109}
110static inline bool uprobe_deny_signal(void)
111{
112 return false;
113}
114static inline unsigned long uprobe_get_swbp_addr(struct pt_regs *regs)
115{
116 return 0;
117}
118static inline void uprobe_free_utask(struct task_struct *t)
119{
120}
121static inline void uprobe_copy_process(struct task_struct *t)
122{
123}
124#endif /* !CONFIG_UPROBES */
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530125#endif /* _LINUX_UPROBES_H */