uprobes.h 4.6 KB

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