ptrace.h 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  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_TRACE_MASK 0x000003f4
  60. /* single stepping state bits (used on ARM and PA-RISC) */
  61. #define PT_SINGLESTEP_BIT 31
  62. #define PT_SINGLESTEP (1<<PT_SINGLESTEP_BIT)
  63. #define PT_BLOCKSTEP_BIT 30
  64. #define PT_BLOCKSTEP (1<<PT_BLOCKSTEP_BIT)
  65. #include <linux/compiler.h> /* For unlikely. */
  66. #include <linux/sched.h> /* For struct task_struct. */
  67. extern long arch_ptrace(struct task_struct *child, long request, long addr, long data);
  68. extern struct task_struct *ptrace_get_task_struct(pid_t pid);
  69. extern int ptrace_traceme(void);
  70. extern int ptrace_readdata(struct task_struct *tsk, unsigned long src, char __user *dst, int len);
  71. extern int ptrace_writedata(struct task_struct *tsk, char __user *src, unsigned long dst, int len);
  72. extern int ptrace_attach(struct task_struct *tsk);
  73. extern int ptrace_detach(struct task_struct *, unsigned int);
  74. extern void ptrace_disable(struct task_struct *);
  75. extern int ptrace_check_attach(struct task_struct *task, int kill);
  76. extern int ptrace_request(struct task_struct *child, long request, long addr, long data);
  77. extern void ptrace_notify(int exit_code);
  78. extern void __ptrace_link(struct task_struct *child,
  79. struct task_struct *new_parent);
  80. extern void __ptrace_unlink(struct task_struct *child);
  81. extern void ptrace_untrace(struct task_struct *child);
  82. #define PTRACE_MODE_READ 1
  83. #define PTRACE_MODE_ATTACH 2
  84. /* Returns 0 on success, -errno on denial. */
  85. extern int __ptrace_may_access(struct task_struct *task, unsigned int mode);
  86. /* Returns true on success, false on denial. */
  87. extern bool ptrace_may_access(struct task_struct *task, unsigned int mode);
  88. static inline int ptrace_reparented(struct task_struct *child)
  89. {
  90. return child->real_parent != child->parent;
  91. }
  92. static inline void ptrace_link(struct task_struct *child,
  93. struct task_struct *new_parent)
  94. {
  95. if (unlikely(child->ptrace))
  96. __ptrace_link(child, new_parent);
  97. }
  98. static inline void ptrace_unlink(struct task_struct *child)
  99. {
  100. if (unlikely(child->ptrace))
  101. __ptrace_unlink(child);
  102. }
  103. int generic_ptrace_peekdata(struct task_struct *tsk, long addr, long data);
  104. int generic_ptrace_pokedata(struct task_struct *tsk, long addr, long data);
  105. #ifndef force_successful_syscall_return
  106. /*
  107. * System call handlers that, upon successful completion, need to return a
  108. * negative value should call force_successful_syscall_return() right before
  109. * returning. On architectures where the syscall convention provides for a
  110. * separate error flag (e.g., alpha, ia64, ppc{,64}, sparc{,64}, possibly
  111. * others), this macro can be used to ensure that the error flag will not get
  112. * set. On architectures which do not support a separate error flag, the macro
  113. * is a no-op and the spurious error condition needs to be filtered out by some
  114. * other means (e.g., in user-level, by passing an extra argument to the
  115. * syscall handler, or something along those lines).
  116. */
  117. #define force_successful_syscall_return() do { } while (0)
  118. #endif
  119. /*
  120. * <asm/ptrace.h> should define the following things inside #ifdef __KERNEL__.
  121. *
  122. * These do-nothing inlines are used when the arch does not
  123. * implement single-step. The kerneldoc comments are here
  124. * to document the interface for all arch definitions.
  125. */
  126. #ifndef arch_has_single_step
  127. /**
  128. * arch_has_single_step - does this CPU support user-mode single-step?
  129. *
  130. * If this is defined, then there must be function declarations or
  131. * inlines for user_enable_single_step() and user_disable_single_step().
  132. * arch_has_single_step() should evaluate to nonzero iff the machine
  133. * supports instruction single-step for user mode.
  134. * It can be a constant or it can test a CPU feature bit.
  135. */
  136. #define arch_has_single_step() (0)
  137. /**
  138. * user_enable_single_step - single-step in user-mode task
  139. * @task: either current or a task stopped in %TASK_TRACED
  140. *
  141. * This can only be called when arch_has_single_step() has returned nonzero.
  142. * Set @task so that when it returns to user mode, it will trap after the
  143. * next single instruction executes. If arch_has_block_step() is defined,
  144. * this must clear the effects of user_enable_block_step() too.
  145. */
  146. static inline void user_enable_single_step(struct task_struct *task)
  147. {
  148. BUG(); /* This can never be called. */
  149. }
  150. /**
  151. * user_disable_single_step - cancel user-mode single-step
  152. * @task: either current or a task stopped in %TASK_TRACED
  153. *
  154. * Clear @task of the effects of user_enable_single_step() and
  155. * user_enable_block_step(). This can be called whether or not either
  156. * of those was ever called on @task, and even if arch_has_single_step()
  157. * returned zero.
  158. */
  159. static inline void user_disable_single_step(struct task_struct *task)
  160. {
  161. }
  162. #endif /* arch_has_single_step */
  163. #ifndef arch_has_block_step
  164. /**
  165. * arch_has_block_step - does this CPU support user-mode block-step?
  166. *
  167. * If this is defined, then there must be a function declaration or inline
  168. * for user_enable_block_step(), and arch_has_single_step() must be defined
  169. * too. arch_has_block_step() should evaluate to nonzero iff the machine
  170. * supports step-until-branch for user mode. It can be a constant or it
  171. * can test a CPU feature bit.
  172. */
  173. #define arch_has_block_step() (0)
  174. /**
  175. * user_enable_block_step - step until branch in user-mode task
  176. * @task: either current or a task stopped in %TASK_TRACED
  177. *
  178. * This can only be called when arch_has_block_step() has returned nonzero,
  179. * and will never be called when single-instruction stepping is being used.
  180. * Set @task so that when it returns to user mode, it will trap after the
  181. * next branch or trap taken.
  182. */
  183. static inline void user_enable_block_step(struct task_struct *task)
  184. {
  185. BUG(); /* This can never be called. */
  186. }
  187. #endif /* arch_has_block_step */
  188. #ifndef arch_ptrace_stop_needed
  189. /**
  190. * arch_ptrace_stop_needed - Decide whether arch_ptrace_stop() should be called
  191. * @code: current->exit_code value ptrace will stop with
  192. * @info: siginfo_t pointer (or %NULL) for signal ptrace will stop with
  193. *
  194. * This is called with the siglock held, to decide whether or not it's
  195. * necessary to release the siglock and call arch_ptrace_stop() with the
  196. * same @code and @info arguments. It can be defined to a constant if
  197. * arch_ptrace_stop() is never required, or always is. On machines where
  198. * this makes sense, it should be defined to a quick test to optimize out
  199. * calling arch_ptrace_stop() when it would be superfluous. For example,
  200. * if the thread has not been back to user mode since the last stop, the
  201. * thread state might indicate that nothing needs to be done.
  202. */
  203. #define arch_ptrace_stop_needed(code, info) (0)
  204. #endif
  205. #ifndef arch_ptrace_stop
  206. /**
  207. * arch_ptrace_stop - Do machine-specific work before stopping for ptrace
  208. * @code: current->exit_code value ptrace will stop with
  209. * @info: siginfo_t pointer (or %NULL) for signal ptrace will stop with
  210. *
  211. * This is called with no locks held when arch_ptrace_stop_needed() has
  212. * just returned nonzero. It is allowed to block, e.g. for user memory
  213. * access. The arch can have machine-specific work to be done before
  214. * ptrace stops. On ia64, register backing store gets written back to user
  215. * memory here. Since this can be costly (requires dropping the siglock),
  216. * we only do it when the arch requires it for this particular stop, as
  217. * indicated by arch_ptrace_stop_needed().
  218. */
  219. #define arch_ptrace_stop(code, info) do { } while (0)
  220. #endif
  221. #endif
  222. #endif