1 #ifndef _LINUX_PTRACE_H
2 #define _LINUX_PTRACE_H
4 /* structs and defines to help the user use the ptrace system call. */
6 /* has the defines to get at the registers. */
8 #define PTRACE_TRACEME 0
9 #define PTRACE_PEEKTEXT 1
10 #define PTRACE_PEEKDATA 2
11 #define PTRACE_PEEKUSR 3
12 #define PTRACE_POKETEXT 4
13 #define PTRACE_POKEDATA 5
14 #define PTRACE_POKEUSR 6
17 #define PTRACE_SINGLESTEP 9
19 #define PTRACE_ATTACH 16
20 #define PTRACE_DETACH 17
22 #define PTRACE_SYSCALL 24
24 /* 0x4200-0x4300 are reserved for architecture-independent additions. */
25 #define PTRACE_SETOPTIONS 0x4200
26 #define PTRACE_GETEVENTMSG 0x4201
27 #define PTRACE_GETSIGINFO 0x4202
28 #define PTRACE_SETSIGINFO 0x4203
31 * Generic ptrace interface that exports the architecture specific regsets
32 * using the corresponding NT_* types (which are also used in the core dump).
33 * Please note that the NT_PRSTATUS note type in a core dump contains a full
34 * 'struct elf_prstatus'. But the user_regset for NT_PRSTATUS contains just the
35 * elf_gregset_t that is the pr_reg field of 'struct elf_prstatus'. For all the
36 * other user_regset flavors, the user_regset layout and the ELF core dump note
37 * payload are exactly the same layout.
39 * This interface usage is as follows:
40 * struct iovec iov = { buf, len};
42 * ret = ptrace(PTRACE_GETREGSET/PTRACE_SETREGSET, pid, NT_XXX_TYPE, &iov);
44 * On the successful completion, iov.len will be updated by the kernel,
45 * specifying how much the kernel has written/read to/from the user's iov.buf.
47 #define PTRACE_GETREGSET 0x4204
48 #define PTRACE_SETREGSET 0x4205
50 #define PTRACE_SEIZE 0x4206
51 #define PTRACE_INTERRUPT 0x4207
52 #define PTRACE_LISTEN 0x4208
54 /* flags in @data for PTRACE_SEIZE */
55 #define PTRACE_SEIZE_DEVEL 0x80000000 /* temp flag for development */
57 /* options set using PTRACE_SETOPTIONS */
58 #define PTRACE_O_TRACESYSGOOD 0x00000001
59 #define PTRACE_O_TRACEFORK 0x00000002
60 #define PTRACE_O_TRACEVFORK 0x00000004
61 #define PTRACE_O_TRACECLONE 0x00000008
62 #define PTRACE_O_TRACEEXEC 0x00000010
63 #define PTRACE_O_TRACEVFORKDONE 0x00000020
64 #define PTRACE_O_TRACEEXIT 0x00000040
66 #define PTRACE_O_MASK 0x0000007f
68 /* Wait extended result codes for the above trace options. */
69 #define PTRACE_EVENT_FORK 1
70 #define PTRACE_EVENT_VFORK 2
71 #define PTRACE_EVENT_CLONE 3
72 #define PTRACE_EVENT_EXEC 4
73 #define PTRACE_EVENT_VFORK_DONE 5
74 #define PTRACE_EVENT_EXIT 6
75 #define PTRACE_EVENT_STOP 7
77 #include <asm/ptrace.h>
83 * The owner ship rules for task->ptrace which holds the ptrace
84 * flags is simple. When a task is running it owns it's task->ptrace
85 * flags. When the a task is stopped the ptracer owns task->ptrace.
88 #define PT_SEIZED 0x00010000 /* SEIZE used, enable new behavior */
89 #define PT_PTRACED 0x00000001
90 #define PT_DTRACE 0x00000002 /* delayed trace (used on m68k, i386) */
91 #define PT_TRACESYSGOOD 0x00000004
92 #define PT_PTRACE_CAP 0x00000008 /* ptracer can follow suid-exec */
94 /* PT_TRACE_* event enable flags */
95 #define PT_EVENT_FLAG_SHIFT 4
96 #define PT_EVENT_FLAG(event) (1 << (PT_EVENT_FLAG_SHIFT + (event) - 1))
98 #define PT_TRACE_FORK PT_EVENT_FLAG(PTRACE_EVENT_FORK)
99 #define PT_TRACE_VFORK PT_EVENT_FLAG(PTRACE_EVENT_VFORK)
100 #define PT_TRACE_CLONE PT_EVENT_FLAG(PTRACE_EVENT_CLONE)
101 #define PT_TRACE_EXEC PT_EVENT_FLAG(PTRACE_EVENT_EXEC)
102 #define PT_TRACE_VFORK_DONE PT_EVENT_FLAG(PTRACE_EVENT_VFORK_DONE)
103 #define PT_TRACE_EXIT PT_EVENT_FLAG(PTRACE_EVENT_EXIT)
105 #define PT_TRACE_MASK 0x000003f4
107 /* single stepping state bits (used on ARM and PA-RISC) */
108 #define PT_SINGLESTEP_BIT 31
109 #define PT_SINGLESTEP (1<<PT_SINGLESTEP_BIT)
110 #define PT_BLOCKSTEP_BIT 30
111 #define PT_BLOCKSTEP (1<<PT_BLOCKSTEP_BIT)
113 #include <linux/compiler.h> /* For unlikely. */
114 #include <linux/sched.h> /* For struct task_struct. */
115 #include <linux/pid_namespace.h> /* For task_active_pid_ns. */
118 extern long arch_ptrace(struct task_struct *child, long request,
119 unsigned long addr, unsigned long data);
120 extern int ptrace_readdata(struct task_struct *tsk, unsigned long src, char __user *dst, int len);
121 extern int ptrace_writedata(struct task_struct *tsk, char __user *src, unsigned long dst, int len);
122 extern void ptrace_disable(struct task_struct *);
123 extern int ptrace_check_attach(struct task_struct *task, bool ignore_state);
124 extern int ptrace_request(struct task_struct *child, long request,
125 unsigned long addr, unsigned long data);
126 extern void ptrace_notify(int exit_code);
127 extern void __ptrace_link(struct task_struct *child,
128 struct task_struct *new_parent);
129 extern void __ptrace_unlink(struct task_struct *child);
130 extern void exit_ptrace(struct task_struct *tracer);
131 #define PTRACE_MODE_READ 1
132 #define PTRACE_MODE_ATTACH 2
133 /* Returns 0 on success, -errno on denial. */
134 extern int __ptrace_may_access(struct task_struct *task, unsigned int mode);
135 /* Returns true on success, false on denial. */
136 extern bool ptrace_may_access(struct task_struct *task, unsigned int mode);
138 static inline int ptrace_reparented(struct task_struct *child)
140 return !same_thread_group(child->real_parent, child->parent);
143 static inline void ptrace_unlink(struct task_struct *child)
145 if (unlikely(child->ptrace))
146 __ptrace_unlink(child);
149 int generic_ptrace_peekdata(struct task_struct *tsk, unsigned long addr,
151 int generic_ptrace_pokedata(struct task_struct *tsk, unsigned long addr,
155 * ptrace_parent - return the task that is tracing the given task
156 * @task: task to consider
158 * Returns %NULL if no one is tracing @task, or the &struct task_struct
159 * pointer to its tracer.
161 * Must called under rcu_read_lock(). The pointer returned might be kept
162 * live only by RCU. During exec, this may be called with task_lock() held
163 * on @task, still held from when check_unsafe_exec() was called.
165 static inline struct task_struct *ptrace_parent(struct task_struct *task)
167 if (unlikely(task->ptrace))
168 return rcu_dereference(task->parent);
173 * ptrace_event_enabled - test whether a ptrace event is enabled
174 * @task: ptracee of interest
175 * @event: %PTRACE_EVENT_* to test
177 * Test whether @event is enabled for ptracee @task.
179 * Returns %true if @event is enabled, %false otherwise.
181 static inline bool ptrace_event_enabled(struct task_struct *task, int event)
183 return task->ptrace & PT_EVENT_FLAG(event);
187 * ptrace_event - possibly stop for a ptrace event notification
188 * @event: %PTRACE_EVENT_* value to report
189 * @message: value for %PTRACE_GETEVENTMSG to return
191 * Check whether @event is enabled and, if so, report @event and @message
192 * to the ptrace parent.
194 * Called without locks.
196 static inline void ptrace_event(int event, unsigned long message)
198 if (unlikely(ptrace_event_enabled(current, event))) {
199 current->ptrace_message = message;
200 ptrace_notify((event << 8) | SIGTRAP);
201 } else if (event == PTRACE_EVENT_EXEC && unlikely(current->ptrace)) {
202 /* legacy EXEC report via SIGTRAP */
203 send_sig(SIGTRAP, current, 0);
208 * ptrace_event_pid - possibly stop for a ptrace event notification
209 * @event: %PTRACE_EVENT_* value to report
210 * @pid: process identifier for %PTRACE_GETEVENTMSG to return
212 * Check whether @event is enabled and, if so, report @event and @pid
213 * to the ptrace parent. @pid is reported as the pid_t seen from the
214 * the ptrace parent's pid namespace.
216 * Called without locks.
218 static inline void ptrace_event_pid(int event, struct pid *pid)
221 * FIXME: There's a potential race if a ptracer in a different pid
222 * namespace than parent attaches between computing message below and
223 * when we acquire tasklist_lock in ptrace_stop(). If this happens,
224 * the ptracer will get a bogus pid from PTRACE_GETEVENTMSG.
226 unsigned long message = 0;
227 struct pid_namespace *ns;
230 ns = task_active_pid_ns(rcu_dereference(current->parent));
232 message = pid_nr_ns(pid, ns);
235 ptrace_event(event, message);
239 * ptrace_init_task - initialize ptrace state for a new child
240 * @child: new child task
241 * @ptrace: true if child should be ptrace'd by parent's tracer
243 * This is called immediately after adding @child to its parent's children
244 * list. @ptrace is false in the normal case, and true to ptrace @child.
246 * Called with current's siglock and write_lock_irq(&tasklist_lock) held.
248 static inline void ptrace_init_task(struct task_struct *child, bool ptrace)
250 INIT_LIST_HEAD(&child->ptrace_entry);
251 INIT_LIST_HEAD(&child->ptraced);
252 #ifdef CONFIG_HAVE_HW_BREAKPOINT
253 atomic_set(&child->ptrace_bp_refcnt, 1);
257 child->parent = child->real_parent;
259 if (unlikely(ptrace) && current->ptrace) {
260 child->ptrace = current->ptrace;
261 __ptrace_link(child, current->parent);
263 if (child->ptrace & PT_SEIZED)
264 task_set_jobctl_pending(child, JOBCTL_TRAP_STOP);
266 sigaddset(&child->pending.signal, SIGSTOP);
268 set_tsk_thread_flag(child, TIF_SIGPENDING);
273 * ptrace_release_task - final ptrace-related cleanup of a zombie being reaped
274 * @task: task in %EXIT_DEAD state
276 * Called with write_lock(&tasklist_lock) held.
278 static inline void ptrace_release_task(struct task_struct *task)
280 BUG_ON(!list_empty(&task->ptraced));
282 BUG_ON(!list_empty(&task->ptrace_entry));
285 #ifndef force_successful_syscall_return
287 * System call handlers that, upon successful completion, need to return a
288 * negative value should call force_successful_syscall_return() right before
289 * returning. On architectures where the syscall convention provides for a
290 * separate error flag (e.g., alpha, ia64, ppc{,64}, sparc{,64}, possibly
291 * others), this macro can be used to ensure that the error flag will not get
292 * set. On architectures which do not support a separate error flag, the macro
293 * is a no-op and the spurious error condition needs to be filtered out by some
294 * other means (e.g., in user-level, by passing an extra argument to the
295 * syscall handler, or something along those lines).
297 #define force_successful_syscall_return() do { } while (0)
301 * <asm/ptrace.h> should define the following things inside #ifdef __KERNEL__.
303 * These do-nothing inlines are used when the arch does not
304 * implement single-step. The kerneldoc comments are here
305 * to document the interface for all arch definitions.
308 #ifndef arch_has_single_step
310 * arch_has_single_step - does this CPU support user-mode single-step?
312 * If this is defined, then there must be function declarations or
313 * inlines for user_enable_single_step() and user_disable_single_step().
314 * arch_has_single_step() should evaluate to nonzero iff the machine
315 * supports instruction single-step for user mode.
316 * It can be a constant or it can test a CPU feature bit.
318 #define arch_has_single_step() (0)
321 * user_enable_single_step - single-step in user-mode task
322 * @task: either current or a task stopped in %TASK_TRACED
324 * This can only be called when arch_has_single_step() has returned nonzero.
325 * Set @task so that when it returns to user mode, it will trap after the
326 * next single instruction executes. If arch_has_block_step() is defined,
327 * this must clear the effects of user_enable_block_step() too.
329 static inline void user_enable_single_step(struct task_struct *task)
331 BUG(); /* This can never be called. */
335 * user_disable_single_step - cancel user-mode single-step
336 * @task: either current or a task stopped in %TASK_TRACED
338 * Clear @task of the effects of user_enable_single_step() and
339 * user_enable_block_step(). This can be called whether or not either
340 * of those was ever called on @task, and even if arch_has_single_step()
343 static inline void user_disable_single_step(struct task_struct *task)
347 extern void user_enable_single_step(struct task_struct *);
348 extern void user_disable_single_step(struct task_struct *);
349 #endif /* arch_has_single_step */
351 #ifndef arch_has_block_step
353 * arch_has_block_step - does this CPU support user-mode block-step?
355 * If this is defined, then there must be a function declaration or inline
356 * for user_enable_block_step(), and arch_has_single_step() must be defined
357 * too. arch_has_block_step() should evaluate to nonzero iff the machine
358 * supports step-until-branch for user mode. It can be a constant or it
359 * can test a CPU feature bit.
361 #define arch_has_block_step() (0)
364 * user_enable_block_step - step until branch in user-mode task
365 * @task: either current or a task stopped in %TASK_TRACED
367 * This can only be called when arch_has_block_step() has returned nonzero,
368 * and will never be called when single-instruction stepping is being used.
369 * Set @task so that when it returns to user mode, it will trap after the
370 * next branch or trap taken.
372 static inline void user_enable_block_step(struct task_struct *task)
374 BUG(); /* This can never be called. */
377 extern void user_enable_block_step(struct task_struct *);
378 #endif /* arch_has_block_step */
380 #ifdef ARCH_HAS_USER_SINGLE_STEP_INFO
381 extern void user_single_step_siginfo(struct task_struct *tsk,
382 struct pt_regs *regs, siginfo_t *info);
384 static inline void user_single_step_siginfo(struct task_struct *tsk,
385 struct pt_regs *regs, siginfo_t *info)
387 memset(info, 0, sizeof(*info));
388 info->si_signo = SIGTRAP;
392 #ifndef arch_ptrace_stop_needed
394 * arch_ptrace_stop_needed - Decide whether arch_ptrace_stop() should be called
395 * @code: current->exit_code value ptrace will stop with
396 * @info: siginfo_t pointer (or %NULL) for signal ptrace will stop with
398 * This is called with the siglock held, to decide whether or not it's
399 * necessary to release the siglock and call arch_ptrace_stop() with the
400 * same @code and @info arguments. It can be defined to a constant if
401 * arch_ptrace_stop() is never required, or always is. On machines where
402 * this makes sense, it should be defined to a quick test to optimize out
403 * calling arch_ptrace_stop() when it would be superfluous. For example,
404 * if the thread has not been back to user mode since the last stop, the
405 * thread state might indicate that nothing needs to be done.
407 * This is guaranteed to be invoked once before a task stops for ptrace and
408 * may include arch-specific operations necessary prior to a ptrace stop.
410 #define arch_ptrace_stop_needed(code, info) (0)
413 #ifndef arch_ptrace_stop
415 * arch_ptrace_stop - Do machine-specific work before stopping for ptrace
416 * @code: current->exit_code value ptrace will stop with
417 * @info: siginfo_t pointer (or %NULL) for signal ptrace will stop with
419 * This is called with no locks held when arch_ptrace_stop_needed() has
420 * just returned nonzero. It is allowed to block, e.g. for user memory
421 * access. The arch can have machine-specific work to be done before
422 * ptrace stops. On ia64, register backing store gets written back to user
423 * memory here. Since this can be costly (requires dropping the siglock),
424 * we only do it when the arch requires it for this particular stop, as
425 * indicated by arch_ptrace_stop_needed().
427 #define arch_ptrace_stop(code, info) do { } while (0)
430 extern int task_current_syscall(struct task_struct *target, long *callno,
431 unsigned long args[6], unsigned int maxargs,
432 unsigned long *sp, unsigned long *pc);
434 #ifdef CONFIG_HAVE_HW_BREAKPOINT
435 extern int ptrace_get_breakpoints(struct task_struct *tsk);
436 extern void ptrace_put_breakpoints(struct task_struct *tsk);
438 static inline void ptrace_put_breakpoints(struct task_struct *tsk) { }
439 #endif /* CONFIG_HAVE_HW_BREAKPOINT */
441 #endif /* __KERNEL */