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
  32 #ifdef CONFIG_ARCH_SUPPORTS_UPROBES
  33 # include <asm/uprobes.h>
  34 #endif
  35
  36 /* flags that denote/change uprobes behaviour */
  37
  38 /* Have a copy of original instruction */
  39 #define UPROBE_COPY_INSN        0x1
  40
  41 /* Dont run handlers when first register/ last unregister in progress*/
  42 #define UPROBE_RUN_HANDLER      0x2
  43 /* Can skip singlestep */
  44 #define UPROBE_SKIP_SSTEP       0x4
  45
  46 struct uprobe_consumer {
  47         int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs);
  48         /*
  49          * filter is optional; If a filter exists, handler is run
  50          * if and only if filter returns true.
  51          */
  52         bool (*filter)(struct uprobe_consumer *self, struct task_struct *task);
  53
  54         struct uprobe_consumer *next;
  55 };
  56
  57 #ifdef CONFIG_UPROBES
  58 enum uprobe_task_state {
  59         UTASK_RUNNING,
  60         UTASK_BP_HIT,
  61         UTASK_SSTEP,
  62         UTASK_SSTEP_ACK,
  63         UTASK_SSTEP_TRAPPED,
  64 };
  65
  66 /*
  67  * uprobe_task: Metadata of a task while it singlesteps.
  68  */
  69 struct uprobe_task {
  70         enum uprobe_task_state          state;
  71         struct arch_uprobe_task         autask;
  72
  73         struct uprobe                   *active_uprobe;
  74
  75         unsigned long                   xol_vaddr;
  76         unsigned long                   vaddr;
  77 };
  78
  79 extern int __weak set_swbp(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
  80 extern int __weak set_orig_insn(struct arch_uprobe *aup, struct mm_struct *mm,  unsigned long vaddr, bool verify);
  81 extern bool __weak is_swbp_insn(uprobe_opcode_t *insn);
  82 extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
  83 extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
  84 extern int uprobe_mmap(struct vm_area_struct *vma);
  85 extern void uprobe_free_utask(struct task_struct *t);
  86 extern void uprobe_copy_process(struct task_struct *t);
  87 extern unsigned long __weak uprobe_get_swbp_addr(struct pt_regs *regs);
  88 extern int uprobe_post_sstep_notifier(struct pt_regs *regs);
  89 extern int uprobe_pre_sstep_notifier(struct pt_regs *regs);
  90 extern void uprobe_notify_resume(struct pt_regs *regs);
  91 extern bool uprobe_deny_signal(void);
  92 extern bool __weak arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs);
  93 #else /* !CONFIG_UPROBES */
  94 static inline int
  95 uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
  96 {
  97         return -ENOSYS;
  98 }
  99 static inline void
 100 uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
 101 {
 102 }
 103 static inline int uprobe_mmap(struct vm_area_struct *vma)
 104 {
 105         return 0;
 106 }
 107 static inline void uprobe_notify_resume(struct pt_regs *regs)
 108 {
 109 }
 110 static inline bool uprobe_deny_signal(void)
 111 {
 112         return false;
 113 }
 114 static inline unsigned long uprobe_get_swbp_addr(struct pt_regs *regs)
 115 {
 116         return 0;
 117 }
 118 static inline void uprobe_free_utask(struct task_struct *t)
 119 {
 120 }
 121 static inline void uprobe_copy_process(struct task_struct *t)
 122 {
 123 }
 124 #endif /* !CONFIG_UPROBES */
 125 #endif  /* _LINUX_UPROBES_H */