uprobes.h 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  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. #include <linux/errno.h>
  27. #include <linux/rbtree.h>
  28. #include <linux/types.h>
  29. struct vm_area_struct;
  30. struct mm_struct;
  31. struct inode;
  32. struct notifier_block;
  33. struct page;
  34. #define UPROBE_HANDLER_REMOVE 1
  35. #define UPROBE_HANDLER_MASK 1
  36. #define MAX_URETPROBE_DEPTH 64
  37. enum uprobe_filter_ctx {
  38. UPROBE_FILTER_REGISTER,
  39. UPROBE_FILTER_UNREGISTER,
  40. UPROBE_FILTER_MMAP,
  41. };
  42. struct uprobe_consumer {
  43. int (*handler)(struct uprobe_consumer *self, struct pt_regs *regs);
  44. int (*ret_handler)(struct uprobe_consumer *self,
  45. unsigned long func,
  46. struct pt_regs *regs);
  47. bool (*filter)(struct uprobe_consumer *self,
  48. enum uprobe_filter_ctx ctx,
  49. struct mm_struct *mm);
  50. struct uprobe_consumer *next;
  51. };
  52. #ifdef CONFIG_UPROBES
  53. #include <asm/uprobes.h>
  54. enum uprobe_task_state {
  55. UTASK_RUNNING,
  56. UTASK_SSTEP,
  57. UTASK_SSTEP_ACK,
  58. UTASK_SSTEP_TRAPPED,
  59. };
  60. /*
  61. * uprobe_task: Metadata of a task while it singlesteps.
  62. */
  63. struct uprobe_task {
  64. enum uprobe_task_state state;
  65. union {
  66. struct {
  67. struct arch_uprobe_task autask;
  68. unsigned long vaddr;
  69. };
  70. struct {
  71. struct callback_head dup_xol_work;
  72. unsigned long dup_xol_addr;
  73. };
  74. };
  75. struct uprobe *active_uprobe;
  76. unsigned long xol_vaddr;
  77. struct return_instance *return_instances;
  78. unsigned int depth;
  79. };
  80. struct xol_area;
  81. struct uprobes_state {
  82. struct xol_area *xol_area;
  83. };
  84. extern int set_swbp(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
  85. extern int set_orig_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long vaddr);
  86. extern bool is_swbp_insn(uprobe_opcode_t *insn);
  87. extern bool is_trap_insn(uprobe_opcode_t *insn);
  88. extern unsigned long uprobe_get_swbp_addr(struct pt_regs *regs);
  89. extern unsigned long uprobe_get_trap_addr(struct pt_regs *regs);
  90. extern int uprobe_write_opcode(struct mm_struct *mm, unsigned long vaddr, uprobe_opcode_t);
  91. extern int uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
  92. extern int uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool);
  93. extern void uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc);
  94. extern int uprobe_mmap(struct vm_area_struct *vma);
  95. extern void uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end);
  96. extern void uprobe_start_dup_mmap(void);
  97. extern void uprobe_end_dup_mmap(void);
  98. extern void uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm);
  99. extern void uprobe_free_utask(struct task_struct *t);
  100. extern void uprobe_copy_process(struct task_struct *t, unsigned long flags);
  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 arch_uprobe_skip_sstep(struct arch_uprobe *aup, struct pt_regs *regs);
  106. extern void uprobe_clear_state(struct mm_struct *mm);
  107. extern int arch_uprobe_analyze_insn(struct arch_uprobe *aup, struct mm_struct *mm, unsigned long addr);
  108. extern int arch_uprobe_pre_xol(struct arch_uprobe *aup, struct pt_regs *regs);
  109. extern int arch_uprobe_post_xol(struct arch_uprobe *aup, struct pt_regs *regs);
  110. extern bool arch_uprobe_xol_was_trapped(struct task_struct *tsk);
  111. extern int arch_uprobe_exception_notify(struct notifier_block *self, unsigned long val, void *data);
  112. extern void arch_uprobe_abort_xol(struct arch_uprobe *aup, struct pt_regs *regs);
  113. extern unsigned long arch_uretprobe_hijack_return_addr(unsigned long trampoline_vaddr, struct pt_regs *regs);
  114. extern bool arch_uprobe_ignore(struct arch_uprobe *aup, struct pt_regs *regs);
  115. extern void arch_uprobe_copy_ixol(struct page *page, unsigned long vaddr,
  116. void *src, unsigned long len);
  117. #else /* !CONFIG_UPROBES */
  118. struct uprobes_state {
  119. };
  120. #define uprobe_get_trap_addr(regs) instruction_pointer(regs)
  121. static inline int
  122. uprobe_register(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
  123. {
  124. return -ENOSYS;
  125. }
  126. static inline int
  127. uprobe_apply(struct inode *inode, loff_t offset, struct uprobe_consumer *uc, bool add)
  128. {
  129. return -ENOSYS;
  130. }
  131. static inline void
  132. uprobe_unregister(struct inode *inode, loff_t offset, struct uprobe_consumer *uc)
  133. {
  134. }
  135. static inline int uprobe_mmap(struct vm_area_struct *vma)
  136. {
  137. return 0;
  138. }
  139. static inline void
  140. uprobe_munmap(struct vm_area_struct *vma, unsigned long start, unsigned long end)
  141. {
  142. }
  143. static inline void uprobe_start_dup_mmap(void)
  144. {
  145. }
  146. static inline void uprobe_end_dup_mmap(void)
  147. {
  148. }
  149. static inline void
  150. uprobe_dup_mmap(struct mm_struct *oldmm, struct mm_struct *newmm)
  151. {
  152. }
  153. static inline void uprobe_notify_resume(struct pt_regs *regs)
  154. {
  155. }
  156. static inline bool uprobe_deny_signal(void)
  157. {
  158. return false;
  159. }
  160. static inline void uprobe_free_utask(struct task_struct *t)
  161. {
  162. }
  163. static inline void uprobe_copy_process(struct task_struct *t, unsigned long flags)
  164. {
  165. }
  166. static inline void uprobe_clear_state(struct mm_struct *mm)
  167. {
  168. }
  169. #endif /* !CONFIG_UPROBES */
  170. #endif /* _LINUX_UPROBES_H */