ptrace.h 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  1. #ifndef _LINUX_PTRACE_H
  2. #define _LINUX_PTRACE_H
  3. /* ptrace.h */
  4. /* structs and defines to help the user use the ptrace system call. */
  5. /* has the defines to get at the registers. */
  6. #define PTRACE_TRACEME 0
  7. #define PTRACE_PEEKTEXT 1
  8. #define PTRACE_PEEKDATA 2
  9. #define PTRACE_PEEKUSR 3
  10. #define PTRACE_POKETEXT 4
  11. #define PTRACE_POKEDATA 5
  12. #define PTRACE_POKEUSR 6
  13. #define PTRACE_CONT 7
  14. #define PTRACE_KILL 8
  15. #define PTRACE_SINGLESTEP 9
  16. #define PTRACE_ATTACH 16
  17. #define PTRACE_DETACH 17
  18. #define PTRACE_SYSCALL 24
  19. /* 0x4200-0x4300 are reserved for architecture-independent additions. */
  20. #define PTRACE_SETOPTIONS 0x4200
  21. #define PTRACE_GETEVENTMSG 0x4201
  22. #define PTRACE_GETSIGINFO 0x4202
  23. #define PTRACE_SETSIGINFO 0x4203
  24. /* options set using PTRACE_SETOPTIONS */
  25. #define PTRACE_O_TRACESYSGOOD 0x00000001
  26. #define PTRACE_O_TRACEFORK 0x00000002
  27. #define PTRACE_O_TRACEVFORK 0x00000004
  28. #define PTRACE_O_TRACECLONE 0x00000008
  29. #define PTRACE_O_TRACEEXEC 0x00000010
  30. #define PTRACE_O_TRACEVFORKDONE 0x00000020
  31. #define PTRACE_O_TRACEEXIT 0x00000040
  32. #define PTRACE_O_MASK 0x0000007f
  33. /* Wait extended result codes for the above trace options. */
  34. #define PTRACE_EVENT_FORK 1
  35. #define PTRACE_EVENT_VFORK 2
  36. #define PTRACE_EVENT_CLONE 3
  37. #define PTRACE_EVENT_EXEC 4
  38. #define PTRACE_EVENT_VFORK_DONE 5
  39. #define PTRACE_EVENT_EXIT 6
  40. #include <asm/ptrace.h>
  41. #ifdef __KERNEL__
  42. /*
  43. * Ptrace flags
  44. *
  45. * The owner ship rules for task->ptrace which holds the ptrace
  46. * flags is simple. When a task is running it owns it's task->ptrace
  47. * flags. When the a task is stopped the ptracer owns task->ptrace.
  48. */
  49. #define PT_PTRACED 0x00000001
  50. #define PT_DTRACE 0x00000002 /* delayed trace (used on m68k, i386) */
  51. #define PT_TRACESYSGOOD 0x00000004
  52. #define PT_PTRACE_CAP 0x00000008 /* ptracer can follow suid-exec */
  53. #define PT_TRACE_FORK 0x00000010
  54. #define PT_TRACE_VFORK 0x00000020
  55. #define PT_TRACE_CLONE 0x00000040
  56. #define PT_TRACE_EXEC 0x00000080
  57. #define PT_TRACE_VFORK_DONE 0x00000100
  58. #define PT_TRACE_EXIT 0x00000200
  59. #define PT_ATTACHED 0x00000400 /* parent != real_parent */
  60. #define PT_TRACE_MASK 0x000003f4
  61. /* single stepping state bits (used on ARM and PA-RISC) */
  62. #define PT_SINGLESTEP_BIT 31
  63. #define PT_SINGLESTEP (1<<PT_SINGLESTEP_BIT)
  64. #define PT_BLOCKSTEP_BIT 30
  65. #define PT_BLOCKSTEP (1<<PT_BLOCKSTEP_BIT)
  66. #include <linux/compiler.h> /* For unlikely. */
  67. #include <linux/sched.h> /* For struct task_struct. */
  68. extern long arch_ptrace(struct task_struct *child, long request, long addr, long data);
  69. extern struct task_struct *ptrace_get_task_struct(pid_t pid);
  70. extern int ptrace_traceme(void);
  71. extern int ptrace_readdata(struct task_struct *tsk, unsigned long src, char __user *dst, int len);
  72. extern int ptrace_writedata(struct task_struct *tsk, char __user *src, unsigned long dst, int len);
  73. extern int ptrace_attach(struct task_struct *tsk);
  74. extern int ptrace_detach(struct task_struct *, unsigned int);
  75. extern void ptrace_disable(struct task_struct *);
  76. extern int ptrace_check_attach(struct task_struct *task, int kill);
  77. extern int ptrace_request(struct task_struct *child, long request, long addr, long data);
  78. extern void ptrace_notify(int exit_code);
  79. extern void __ptrace_link(struct task_struct *child,
  80. struct task_struct *new_parent);
  81. extern void __ptrace_unlink(struct task_struct *child);
  82. extern void ptrace_untrace(struct task_struct *child);
  83. extern int ptrace_may_attach(struct task_struct *task);
  84. extern int __ptrace_may_attach(struct task_struct *task);
  85. static inline void ptrace_link(struct task_struct *child,
  86. struct task_struct *new_parent)
  87. {
  88. if (unlikely(child->ptrace))
  89. __ptrace_link(child, new_parent);
  90. }
  91. static inline void ptrace_unlink(struct task_struct *child)
  92. {
  93. if (unlikely(child->ptrace))
  94. __ptrace_unlink(child);
  95. }
  96. int generic_ptrace_peekdata(struct task_struct *tsk, long addr, long data);
  97. int generic_ptrace_pokedata(struct task_struct *tsk, long addr, long data);
  98. #ifndef force_successful_syscall_return
  99. /*
  100. * System call handlers that, upon successful completion, need to return a
  101. * negative value should call force_successful_syscall_return() right before
  102. * returning. On architectures where the syscall convention provides for a
  103. * separate error flag (e.g., alpha, ia64, ppc{,64}, sparc{,64}, possibly
  104. * others), this macro can be used to ensure that the error flag will not get
  105. * set. On architectures which do not support a separate error flag, the macro
  106. * is a no-op and the spurious error condition needs to be filtered out by some
  107. * other means (e.g., in user-level, by passing an extra argument to the
  108. * syscall handler, or something along those lines).
  109. */
  110. #define force_successful_syscall_return() do { } while (0)
  111. #endif
  112. /*
  113. * <asm/ptrace.h> should define the following things inside #ifdef __KERNEL__.
  114. *
  115. * These do-nothing inlines are used when the arch does not
  116. * implement single-step. The kerneldoc comments are here
  117. * to document the interface for all arch definitions.
  118. */
  119. #ifndef arch_has_single_step
  120. /**
  121. * arch_has_single_step - does this CPU support user-mode single-step?
  122. *
  123. * If this is defined, then there must be function declarations or
  124. * inlines for user_enable_single_step() and user_disable_single_step().
  125. * arch_has_single_step() should evaluate to nonzero iff the machine
  126. * supports instruction single-step for user mode.
  127. * It can be a constant or it can test a CPU feature bit.
  128. */
  129. #define arch_has_single_step() (0)
  130. /**
  131. * user_enable_single_step - single-step in user-mode task
  132. * @task: either current or a task stopped in %TASK_TRACED
  133. *
  134. * This can only be called when arch_has_single_step() has returned nonzero.
  135. * Set @task so that when it returns to user mode, it will trap after the
  136. * next single instruction executes. If arch_has_block_step() is defined,
  137. * this must clear the effects of user_enable_block_step() too.
  138. */
  139. static inline void user_enable_single_step(struct task_struct *task)
  140. {
  141. BUG(); /* This can never be called. */
  142. }
  143. /**
  144. * user_disable_single_step - cancel user-mode single-step
  145. * @task: either current or a task stopped in %TASK_TRACED
  146. *
  147. * Clear @task of the effects of user_enable_single_step() and
  148. * user_enable_block_step(). This can be called whether or not either
  149. * of those was ever called on @task, and even if arch_has_single_step()
  150. * returned zero.
  151. */
  152. static inline void user_disable_single_step(struct task_struct *task)
  153. {
  154. }
  155. #endif /* arch_has_single_step */
  156. #ifndef arch_has_block_step
  157. /**
  158. * arch_has_block_step - does this CPU support user-mode block-step?
  159. *
  160. * If this is defined, then there must be a function declaration or inline
  161. * for user_enable_block_step(), and arch_has_single_step() must be defined
  162. * too. arch_has_block_step() should evaluate to nonzero iff the machine
  163. * supports step-until-branch for user mode. It can be a constant or it
  164. * can test a CPU feature bit.
  165. */
  166. #define arch_has_single_step() (0)
  167. /**
  168. * user_enable_block_step - step until branch in user-mode task
  169. * @task: either current or a task stopped in %TASK_TRACED
  170. *
  171. * This can only be called when arch_has_block_step() has returned nonzero,
  172. * and will never be called when single-instruction stepping is being used.
  173. * Set @task so that when it returns to user mode, it will trap after the
  174. * next branch or trap taken.
  175. */
  176. static inline void user_enable_block_step(struct task_struct *task)
  177. {
  178. BUG(); /* This can never be called. */
  179. }
  180. #endif /* arch_has_block_step */
  181. #endif
  182. #endif