blob: 02b83db8e2c5d2f330407a7f76c42e7ff0ac11c2 [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 Dronamrajud4b3b632012-03-30 23:56:31 +053031struct mm_struct;
32struct inode;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053033
Srikar Dronamraju2b144492012-02-09 14:56:42 +053034#ifdef CONFIG_ARCH_SUPPORTS_UPROBES
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053035# include <asm/uprobes.h>
Srikar Dronamraju2b144492012-02-09 14:56:42 +053036#endif
37
Oleg Nesterovda1816b2012-12-29 17:49:11 +010038#define UPROBE_HANDLER_REMOVE 1
39#define UPROBE_HANDLER_MASK 1
40
Oleg Nesterov8a7f2fa2012-12-28 17:58:38 +010041enum uprobe_filter_ctx {
42 UPROBE_FILTER_REGISTER,
43 UPROBE_FILTER_UNREGISTER,
44 UPROBE_FILTER_MMAP,
45};
46
Srikar Dronamraju2b144492012-02-09 14:56:42 +053047struct uprobe_consumer {
48 int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs);
Oleg Nesterov8a7f2fa2012-12-28 17:58:38 +010049 bool (*filter)(struct uprobe_consumer *self,
50 enum uprobe_filter_ctx ctx,
51 struct mm_struct *mm);
Srikar Dronamraju2b144492012-02-09 14:56:42 +053052
53 struct uprobe_consumer *next;
54};
55
Srikar Dronamraju2b144492012-02-09 14:56:42 +053056#ifdef CONFIG_UPROBES
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053057enum uprobe_task_state {
58 UTASK_RUNNING,
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053059 UTASK_SSTEP,
60 UTASK_SSTEP_ACK,
61 UTASK_SSTEP_TRAPPED,
62};
63
64/*
65 * uprobe_task: Metadata of a task while it singlesteps.
66 */
67struct uprobe_task {
68 enum uprobe_task_state state;
69 struct arch_uprobe_task autask;
70
71 struct uprobe *active_uprobe;
72
73 unsigned long xol_vaddr;
74 unsigned long vaddr;
75};
76
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +053077/*
78 * On a breakpoint hit, thread contests for a slot. It frees the
79 * slot after singlestep. Currently a fixed number of slots are
80 * allocated.
81 */
82struct xol_area {
83 wait_queue_head_t wq; /* if all slots are busy */
84 atomic_t slot_count; /* number of in-use slots */
85 unsigned long *bitmap; /* 0 = free slot */
86 struct page *page;
87
88 /*
89 * We keep the vma's vm_start rather than a pointer to the vma
90 * itself. The probed process or a naughty kernel module could make
91 * the vma go away, and we must handle that reasonably gracefully.
92 */
93 unsigned long vaddr; /* Page(s) of instruction slots */
94};
95
96struct uprobes_state {
97 struct xol_area *xol_area;
98};
Oleg Nesterov647c42d2012-08-06 13:15:09 +020099
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530100extern int __weak set_swbp(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
Oleg Nesterovded86e72012-08-08 18:07:03 +0200101extern int __weak set_orig_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530102extern bool __weak is_swbp_insn(uprobe_opcode_t *insn);
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530103extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
Oleg Nesterovbdf86472013-02-03 19:21:12 +0100104extern int uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool);
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530105extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100106extern int uprobe_mmap(struct vm_area_struct *vma);
Srikar Dronamrajucbc91f72012-04-11 16:05:27 +0530107extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end);
Oleg Nesterov32cdba12012-11-14 19:03:42 +0100108extern void uprobe_start_dup_mmap(void);
109extern void uprobe_end_dup_mmap(void);
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +0200110extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530111extern void uprobe_free_utask(struct task_struct *t);
112extern void uprobe_copy_process(struct task_struct *t);
113extern unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs);
114extern int uprobe_post_sstep_notifier(struct pt_regs *regs);
115extern int uprobe_pre_sstep_notifier(struct pt_regs *regs);
116extern void uprobe_notify_resume(struct pt_regs *regs);
117extern bool uprobe_deny_signal(void);
118extern bool __weak arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs);
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +0530119extern void uprobe_clear_state(struct mm_struct *mm);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530120#else /* !CONFIG_UPROBES */
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +0530121struct uprobes_state {
122};
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100123static inline int
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530124uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530125{
126 return -ENOSYS;
127}
Oleg Nesterovbdf86472013-02-03 19:21:12 +0100128static inline int
129uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool add)
130{
131 return -ENOSYS;
132}
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100133static inline void
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530134uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530135{
136}
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100137static inline int uprobe_mmap(struct vm_area_struct *vma)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530138{
139 return 0;
140}
Srikar Dronamrajucbc91f72012-04-11 16:05:27 +0530141static inline void
142uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
Srikar Dronamraju682968e2012-03-30 23:56:46 +0530143{
144}
Oleg Nesterov32cdba12012-11-14 19:03:42 +0100145static inline void uprobe_start_dup_mmap(void)
146{
147}
148static inline void uprobe_end_dup_mmap(void)
149{
150}
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +0200151static inline void
152uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm)
153{
154}
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530155static inline void uprobe_notify_resume(struct pt_regs *regs)
156{
157}
158static inline bool uprobe_deny_signal(void)
159{
160 return false;
161}
162static inline unsigned long uprobe_get_swbp_addr(struct pt_regs *regs)
163{
164 return 0;
165}
166static inline void uprobe_free_utask(struct task_struct *t)
167{
168}
169static inline void uprobe_copy_process(struct task_struct *t)
170{
171}
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +0530172static inline void uprobe_clear_state(struct mm_struct *mm)
173{
174}
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530175#endif /* !CONFIG_UPROBES */
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530176#endif /* _LINUX_UPROBES_H */