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-2012
  21  * Authors:
  22  *      Srikar Dronamraju
  23  *      Jim Keniston
  24  * Copyright (C) 2011-2012 Red Hat, Inc., Peter Zijlstra <pzijlstr@redhat.com>
  25  */
  26
  27 #include <linux/errno.h>
  28 #include <linux/rbtree.h>
  29
  30 struct vm_area_struct;
  31 struct mm_struct;
  32 struct inode;
  33
  34 #ifdef CONFIG_ARCH_SUPPORTS_UPROBES
  35 # include <asm/uprobes.h>
  36 #endif
  37
  38 struct uprobe_consumer {
  39         int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs);
  40
  41         struct uprobe_consumer *next;
  42 };
  43
  44 #ifdef CONFIG_UPROBES
  45 enum uprobe_task_state {
  46         UTASK_RUNNING,
  47         UTASK_SSTEP,
  48         UTASK_SSTEP_ACK,
  49         UTASK_SSTEP_TRAPPED,
  50 };
  51
  52 /*
  53  * uprobe_task: Metadata of a task while it singlesteps.
  54  */
  55 struct uprobe_task {
  56         enum uprobe_task_state          state;
  57         struct arch_uprobe_task         autask;
  58
  59         struct uprobe                   *active_uprobe;
  60
  61         unsigned long                   xol_vaddr;
  62         unsigned long                   vaddr;
  63 };
  64
  65 /*
  66  * On a breakpoint hit, thread contests for a slot.  It frees the
  67  * slot after singlestep. Currently a fixed number of slots are
  68  * allocated.
  69  */
  70 struct xol_area {
  71         wait_queue_head_t       wq;             /* if all slots are busy */
  72         atomic_t                slot_count;     /* number of in-use slots */
  73         unsigned long           *bitmap;        /* 0 = free slot */
  74         struct page             *page;
  75
  76         /*
  77          * We keep the vma's vm_start rather than a pointer to the vma
  78          * itself.  The probed process or a naughty kernel module could make
  79          * the vma go away, and we must handle that reasonably gracefully.
  80          */
  81         unsigned long           vaddr;          /* Page(s) of instruction slots */
  82 };
  83
  84 struct uprobes_state {
  85         struct xol_area         *xol_area;
  86 };
  87
  88 extern int __weak set_swbp(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
  89 extern int __weak set_orig_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
  90 extern bool __weak is_swbp_insn(uprobe_opcode_t *insn);
  91 extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
  92 extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
  93 extern int uprobe_mmap(struct vm_area_struct *vma);
  94 extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end);
  95 extern void uprobe_start_dup_mmap(void);
  96 extern void uprobe_end_dup_mmap(void);
  97 extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm);
  98 extern void uprobe_free_utask(struct task_struct *t);
  99 extern void uprobe_copy_process(struct task_struct *t);
 100 extern unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs);
 101 extern int uprobe_post_sstep_notifier(struct pt_regs *regs);
 102 extern int uprobe_pre_sstep_notifier(struct pt_regs *regs);
 103 extern void uprobe_notify_resume(struct pt_regs *regs);
 104 extern bool uprobe_deny_signal(void);
 105 extern bool __weak arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs);
 106 extern void uprobe_clear_state(struct mm_struct *mm);
 107 #else /* !CONFIG_UPROBES */
 108 struct uprobes_state {
 109 };
 110 static inline int
 111 uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
 112 {
 113         return -ENOSYS;
 114 }
 115 static inline void
 116 uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
 117 {
 118 }
 119 static inline int uprobe_mmap(struct vm_area_struct *vma)
 120 {
 121         return 0;
 122 }
 123 static inline void
 124 uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
 125 {
 126 }
 127 static inline void uprobe_start_dup_mmap(void)
 128 {
 129 }
 130 static inline void uprobe_end_dup_mmap(void)
 131 {
 132 }
 133 static inline void
 134 uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm)
 135 {
 136 }
 137 static inline void uprobe_notify_resume(struct pt_regs *regs)
 138 {
 139 }
 140 static inline bool uprobe_deny_signal(void)
 141 {
 142         return false;
 143 }
 144 static inline unsigned long uprobe_get_swbp_addr(struct pt_regs *regs)
 145 {
 146         return 0;
 147 }
 148 static inline void uprobe_free_utask(struct task_struct *t)
 149 {
 150 }
 151 static inline void uprobe_copy_process(struct task_struct *t)
 152 {
 153 }
 154 static inline void uprobe_clear_state(struct mm_struct *mm)
 155 {
 156 }
 157 #endif /* !CONFIG_UPROBES */
 158 #endif  /* _LINUX_UPROBES_H */