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