blob: 319eae70fe8415f774e57c4861b98688fb81bb4c [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;
David A. Long3820b4d2013-10-15 17:04:16 -040033struct notifier_block;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053034
Srikar Dronamraju2b144492012-02-09 14:56:42 +053035#ifdef CONFIG_ARCH_SUPPORTS_UPROBES
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053036# include <asm/uprobes.h>
Srikar Dronamraju2b144492012-02-09 14:56:42 +053037#endif
38
Oleg Nesterovda1816b2012-12-29 17:49:11 +010039#define UPROBE_HANDLER_REMOVE 1
40#define UPROBE_HANDLER_MASK 1
41
Anton Arapovded49c52013-04-03 18:00:37 +020042#define MAX_URETPROBE_DEPTH 64
43
Oleg Nesterov8a7f2fa2012-12-28 17:58:38 +010044enum uprobe_filter_ctx {
45 UPROBE_FILTER_REGISTER,
46 UPROBE_FILTER_UNREGISTER,
47 UPROBE_FILTER_MMAP,
48};
49
Srikar Dronamraju2b144492012-02-09 14:56:42 +053050struct uprobe_consumer {
51 int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs);
Anton Arapovea024872013-04-03 18:00:31 +020052 int (*ret_handler)(struct uprobe_consumer *self,
53 unsigned long func,
54 struct pt_regs *regs);
Oleg Nesterov8a7f2fa2012-12-28 17:58:38 +010055 bool (*filter)(struct uprobe_consumer *self,
56 enum uprobe_filter_ctx ctx,
57 struct mm_struct *mm);
Srikar Dronamraju2b144492012-02-09 14:56:42 +053058
59 struct uprobe_consumer *next;
60};
61
Srikar Dronamraju2b144492012-02-09 14:56:42 +053062#ifdef CONFIG_UPROBES
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053063enum uprobe_task_state {
64 UTASK_RUNNING,
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053065 UTASK_SSTEP,
66 UTASK_SSTEP_ACK,
67 UTASK_SSTEP_TRAPPED,
68};
69
70/*
71 * uprobe_task: Metadata of a task while it singlesteps.
72 */
73struct uprobe_task {
74 enum uprobe_task_state state;
75 struct arch_uprobe_task autask;
76
Anton Arapov0dfd0eb2013-04-03 18:00:35 +020077 struct return_instance *return_instances;
Anton Arapovded49c52013-04-03 18:00:37 +020078 unsigned int depth;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053079 struct uprobe *active_uprobe;
80
81 unsigned long xol_vaddr;
82 unsigned long vaddr;
83};
84
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +053085/*
86 * On a breakpoint hit, thread contests for a slot. It frees the
87 * slot after singlestep. Currently a fixed number of slots are
88 * allocated.
89 */
90struct xol_area {
91 wait_queue_head_t wq; /* if all slots are busy */
92 atomic_t slot_count; /* number of in-use slots */
93 unsigned long *bitmap; /* 0 = free slot */
94 struct page *page;
95
96 /*
97 * We keep the vma's vm_start rather than a pointer to the vma
98 * itself. The probed process or a naughty kernel module could make
99 * the vma go away, and we must handle that reasonably gracefully.
100 */
101 unsigned long vaddr; /* Page(s) of instruction slots */
102};
103
104struct uprobes_state {
105 struct xol_area *xol_area;
106};
Oleg Nesterov647c42d2012-08-06 13:15:09 +0200107
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530108extern int __weak set_swbp(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
Oleg Nesterovded86e72012-08-08 18:07:03 +0200109extern int __weak set_orig_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
Srikar Dronamraju5cb4ac32012-03-12 14:55:45 +0530110extern bool __weak is_swbp_insn(uprobe_opcode_t *insn);
Ananth N Mavinakayanahalli0908ad62013-03-22 20:46:27 +0530111extern bool __weak is_trap_insn(uprobe_opcode_t *insn);
Oleg Nesterovf72d41f2013-11-05 19:50:39 +0100112extern int uprobe_write_opcode(struct mm_struct *mm, unsigned long vaddr, uprobe_opcode_t);
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530113extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
Oleg Nesterovbdf86472013-02-03 19:21:12 +0100114extern int uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool);
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530115extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100116extern int uprobe_mmap(struct vm_area_struct *vma);
Srikar Dronamrajucbc91f72012-04-11 16:05:27 +0530117extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end);
Oleg Nesterov32cdba12012-11-14 19:03:42 +0100118extern void uprobe_start_dup_mmap(void);
119extern void uprobe_end_dup_mmap(void);
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +0200120extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530121extern void uprobe_free_utask(struct task_struct *t);
Oleg Nesterov3ab67962013-10-16 19:39:37 +0200122extern void uprobe_copy_process(struct task_struct *t, unsigned long flags);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530123extern unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs);
124extern int uprobe_post_sstep_notifier(struct pt_regs *regs);
125extern int uprobe_pre_sstep_notifier(struct pt_regs *regs);
126extern void uprobe_notify_resume(struct pt_regs *regs);
127extern bool uprobe_deny_signal(void);
Ralf Baechlec2d3f252013-10-09 14:08:09 +0200128extern bool arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs);
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +0530129extern void uprobe_clear_state(struct mm_struct *mm);
David A. Long3820b4d2013-10-15 17:04:16 -0400130extern int arch_uprobe_analyze_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long addr);
131extern int arch_uprobe_pre_xol(struct arch_uprobe *aup, struct pt_regs *regs);
132extern int arch_uprobe_post_xol(struct arch_uprobe *aup, struct pt_regs *regs);
133extern bool arch_uprobe_xol_was_trapped(struct task_struct *tsk);
134extern int arch_uprobe_exception_notify(struct notifier_block *self, unsigned long val, void *data);
135extern void arch_uprobe_abort_xol(struct arch_uprobe *aup, struct pt_regs *regs);
136extern unsigned long arch_uretprobe_hijack_return_addr(unsigned long trampoline_vaddr, struct pt_regs *regs);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530137#else /* !CONFIG_UPROBES */
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +0530138struct uprobes_state {
139};
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100140static inline int
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530141uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530142{
143 return -ENOSYS;
144}
Oleg Nesterovbdf86472013-02-03 19:21:12 +0100145static inline int
146uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool add)
147{
148 return -ENOSYS;
149}
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100150static inline void
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530151uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530152{
153}
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100154static inline int uprobe_mmap(struct vm_area_struct *vma)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530155{
156 return 0;
157}
Srikar Dronamrajucbc91f72012-04-11 16:05:27 +0530158static inline void
159uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
Srikar Dronamraju682968e2012-03-30 23:56:46 +0530160{
161}
Oleg Nesterov32cdba12012-11-14 19:03:42 +0100162static inline void uprobe_start_dup_mmap(void)
163{
164}
165static inline void uprobe_end_dup_mmap(void)
166{
167}
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +0200168static inline void
169uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm)
170{
171}
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530172static inline void uprobe_notify_resume(struct pt_regs *regs)
173{
174}
175static inline bool uprobe_deny_signal(void)
176{
177 return false;
178}
179static inline unsigned long uprobe_get_swbp_addr(struct pt_regs *regs)
180{
181 return 0;
182}
183static inline void uprobe_free_utask(struct task_struct *t)
184{
185}
Oleg Nesterov3ab67962013-10-16 19:39:37 +0200186static inline void uprobe_copy_process(struct task_struct *t, unsigned long flags)
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530187{
188}
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +0530189static inline void uprobe_clear_state(struct mm_struct *mm)
190{
191}
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530192#endif /* !CONFIG_UPROBES */
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530193#endif /* _LINUX_UPROBES_H */