blob: e32251e00e62f0b2629c0ef7658d1445e6647586 [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>
Oleg Nesterov32473432013-11-08 18:52:21 +010029#include <linux/types.h>
Srikar Dronamraju2b144492012-02-09 14:56:42 +053030
31struct vm_area_struct;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +053032struct mm_struct;
33struct inode;
David A. Long3820b4d2013-10-15 17:04:16 -040034struct notifier_block;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053035
Oleg Nesterovda1816b2012-12-29 17:49:11 +010036#define UPROBE_HANDLER_REMOVE 1
37#define UPROBE_HANDLER_MASK 1
38
Anton Arapovded49c52013-04-03 18:00:37 +020039#define MAX_URETPROBE_DEPTH 64
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);
Anton Arapovea024872013-04-03 18:00:31 +020049 int (*ret_handler)(struct uprobe_consumer *self,
50 unsigned long func,
51 struct pt_regs *regs);
Oleg Nesterov8a7f2fa2012-12-28 17:58:38 +010052 bool (*filter)(struct uprobe_consumer *self,
53 enum uprobe_filter_ctx ctx,
54 struct mm_struct *mm);
Srikar Dronamraju2b144492012-02-09 14:56:42 +053055
56 struct uprobe_consumer *next;
57};
58
Srikar Dronamraju2b144492012-02-09 14:56:42 +053059#ifdef CONFIG_UPROBES
Oleg Nesterovc912dae2013-11-09 19:49:39 +010060#include <asm/uprobes.h>
61
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053062enum uprobe_task_state {
63 UTASK_RUNNING,
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053064 UTASK_SSTEP,
65 UTASK_SSTEP_ACK,
66 UTASK_SSTEP_TRAPPED,
67};
68
69/*
70 * uprobe_task: Metadata of a task while it singlesteps.
71 */
72struct uprobe_task {
73 enum uprobe_task_state state;
Oleg Nesterov32473432013-11-08 18:52:21 +010074
75 union {
76 struct {
77 struct arch_uprobe_task autask;
78 unsigned long vaddr;
79 };
80
81 struct {
82 struct callback_head dup_xol_work;
83 unsigned long dup_xol_addr;
84 };
85 };
86
87 struct uprobe *active_uprobe;
88 unsigned long xol_vaddr;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053089
Anton Arapov0dfd0eb2013-04-03 18:00:35 +020090 struct return_instance *return_instances;
Anton Arapovded49c52013-04-03 18:00:37 +020091 unsigned int depth;
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +053092};
93
Oleg Nesterovc912dae2013-11-09 19:49:39 +010094struct xol_area;
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +053095
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);
Ananth N Mavinakayanahalli0908ad62013-03-22 20:46:27 +0530103extern bool __weak is_trap_insn(uprobe_opcode_t *insn);
Oleg Nesterovc912dae2013-11-09 19:49:39 +0100104extern unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs);
Oleg Nesterovf72d41f2013-11-05 19:50:39 +0100105extern int uprobe_write_opcode(struct mm_struct *mm, unsigned long vaddr, uprobe_opcode_t);
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530106extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
Oleg Nesterovbdf86472013-02-03 19:21:12 +0100107extern int uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool);
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530108extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100109extern int uprobe_mmap(struct vm_area_struct *vma);
Srikar Dronamrajucbc91f72012-04-11 16:05:27 +0530110extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end);
Oleg Nesterov32cdba12012-11-14 19:03:42 +0100111extern void uprobe_start_dup_mmap(void);
112extern void uprobe_end_dup_mmap(void);
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +0200113extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530114extern void uprobe_free_utask(struct task_struct *t);
Oleg Nesterov3ab67962013-10-16 19:39:37 +0200115extern void uprobe_copy_process(struct task_struct *t, unsigned long flags);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530116extern int uprobe_post_sstep_notifier(struct pt_regs *regs);
117extern int uprobe_pre_sstep_notifier(struct pt_regs *regs);
118extern void uprobe_notify_resume(struct pt_regs *regs);
119extern bool uprobe_deny_signal(void);
Ralf Baechlec2d3f252013-10-09 14:08:09 +0200120extern bool arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs);
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +0530121extern void uprobe_clear_state(struct mm_struct *mm);
David A. Long3820b4d2013-10-15 17:04:16 -0400122extern int arch_uprobe_analyze_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long addr);
123extern int arch_uprobe_pre_xol(struct arch_uprobe *aup, struct pt_regs *regs);
124extern int arch_uprobe_post_xol(struct arch_uprobe *aup, struct pt_regs *regs);
125extern bool arch_uprobe_xol_was_trapped(struct task_struct *tsk);
126extern int arch_uprobe_exception_notify(struct notifier_block *self, unsigned long val, void *data);
127extern void arch_uprobe_abort_xol(struct arch_uprobe *aup, struct pt_regs *regs);
128extern unsigned long arch_uretprobe_hijack_return_addr(unsigned long trampoline_vaddr, struct pt_regs *regs);
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530129#else /* !CONFIG_UPROBES */
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +0530130struct uprobes_state {
131};
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100132static inline int
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530133uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530134{
135 return -ENOSYS;
136}
Oleg Nesterovbdf86472013-02-03 19:21:12 +0100137static inline int
138uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool add)
139{
140 return -ENOSYS;
141}
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100142static inline void
Srikar Dronamrajue3343e62012-03-12 14:55:30 +0530143uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530144{
145}
Ingo Molnar7b2d81d2012-02-17 09:27:41 +0100146static inline int uprobe_mmap(struct vm_area_struct *vma)
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530147{
148 return 0;
149}
Srikar Dronamrajucbc91f72012-04-11 16:05:27 +0530150static inline void
151uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
Srikar Dronamraju682968e2012-03-30 23:56:46 +0530152{
153}
Oleg Nesterov32cdba12012-11-14 19:03:42 +0100154static inline void uprobe_start_dup_mmap(void)
155{
156}
157static inline void uprobe_end_dup_mmap(void)
158{
159}
Oleg Nesterovf8ac4ec2012-08-08 17:11:42 +0200160static inline void
161uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm)
162{
163}
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530164static inline void uprobe_notify_resume(struct pt_regs *regs)
165{
166}
167static inline bool uprobe_deny_signal(void)
168{
169 return false;
170}
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530171static inline void uprobe_free_utask(struct task_struct *t)
172{
173}
Oleg Nesterov3ab67962013-10-16 19:39:37 +0200174static inline void uprobe_copy_process(struct task_struct *t, unsigned long flags)
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530175{
176}
Srikar Dronamrajud4b3b632012-03-30 23:56:31 +0530177static inline void uprobe_clear_state(struct mm_struct *mm)
178{
179}
Srikar Dronamraju0326f5a2012-03-13 23:30:11 +0530180#endif /* !CONFIG_UPROBES */
Srikar Dronamraju2b144492012-02-09 14:56:42 +0530181#endif /* _LINUX_UPROBES_H */