1 #ifndef _LINUX_PTRACE_H
2 #define _LINUX_PTRACE_H
4 #include <linux/compiler.h> /* For unlikely. */
5 #include <linux/sched.h> /* For struct task_struct. */
6 #include <linux/err.h> /* for IS_ERR_VALUE */
7 #include <linux/bug.h> /* For BUG_ON. */
8 #include <linux/pid_namespace.h> /* For task_active_pid_ns. */
9 #include <uapi/linux/ptrace.h>
14 * The owner ship rules for task->ptrace which holds the ptrace
15 * flags is simple. When a task is running it owns it's task->ptrace
16 * flags. When the a task is stopped the ptracer owns task->ptrace.
19 #define PT_SEIZED 0x00010000 /* SEIZE used, enable new behavior */
20 #define PT_PTRACED 0x00000001
21 #define PT_DTRACE 0x00000002 /* delayed trace (used on m68k, i386) */
23 #define PT_OPT_FLAG_SHIFT 3
24 /* PT_TRACE_* event enable flags */
25 #define PT_EVENT_FLAG(event) (1 << (PT_OPT_FLAG_SHIFT + (event)))
26 #define PT_TRACESYSGOOD PT_EVENT_FLAG(0)
27 #define PT_TRACE_FORK PT_EVENT_FLAG(PTRACE_EVENT_FORK)
28 #define PT_TRACE_VFORK PT_EVENT_FLAG(PTRACE_EVENT_VFORK)
29 #define PT_TRACE_CLONE PT_EVENT_FLAG(PTRACE_EVENT_CLONE)
30 #define PT_TRACE_EXEC PT_EVENT_FLAG(PTRACE_EVENT_EXEC)
31 #define PT_TRACE_VFORK_DONE PT_EVENT_FLAG(PTRACE_EVENT_VFORK_DONE)
32 #define PT_TRACE_EXIT PT_EVENT_FLAG(PTRACE_EVENT_EXIT)
33 #define PT_TRACE_SECCOMP PT_EVENT_FLAG(PTRACE_EVENT_SECCOMP)
35 #define PT_EXITKILL (PTRACE_O_EXITKILL << PT_OPT_FLAG_SHIFT)
36 #define PT_SUSPEND_SECCOMP (PTRACE_O_SUSPEND_SECCOMP << PT_OPT_FLAG_SHIFT)
38 /* single stepping state bits (used on ARM and PA-RISC) */
39 #define PT_SINGLESTEP_BIT 31
40 #define PT_SINGLESTEP (1<<PT_SINGLESTEP_BIT)
41 #define PT_BLOCKSTEP_BIT 30
42 #define PT_BLOCKSTEP (1<<PT_BLOCKSTEP_BIT)
44 extern long arch_ptrace(struct task_struct *child, long request,
45 unsigned long addr, unsigned long data);
46 extern int ptrace_readdata(struct task_struct *tsk, unsigned long src, char __user *dst, int len);
47 extern int ptrace_writedata(struct task_struct *tsk, char __user *src, unsigned long dst, int len);
48 extern void ptrace_disable(struct task_struct *);
49 extern int ptrace_request(struct task_struct *child, long request,
50 unsigned long addr, unsigned long data);
51 extern void ptrace_notify(int exit_code);
52 extern void __ptrace_link(struct task_struct *child,
53 struct task_struct *new_parent,
54 const struct cred *ptracer_cred);
55 extern void __ptrace_unlink(struct task_struct *child);
56 extern void exit_ptrace(struct task_struct *tracer, struct list_head *dead);
57 #define PTRACE_MODE_READ 0x01
58 #define PTRACE_MODE_ATTACH 0x02
59 #define PTRACE_MODE_NOAUDIT 0x04
60 #define PTRACE_MODE_FSCREDS 0x08
61 #define PTRACE_MODE_REALCREDS 0x10
63 /* shorthands for READ/ATTACH and FSCREDS/REALCREDS combinations */
64 #define PTRACE_MODE_READ_FSCREDS (PTRACE_MODE_READ | PTRACE_MODE_FSCREDS)
65 #define PTRACE_MODE_READ_REALCREDS (PTRACE_MODE_READ | PTRACE_MODE_REALCREDS)
66 #define PTRACE_MODE_ATTACH_FSCREDS (PTRACE_MODE_ATTACH | PTRACE_MODE_FSCREDS)
67 #define PTRACE_MODE_ATTACH_REALCREDS (PTRACE_MODE_ATTACH | PTRACE_MODE_REALCREDS)
70 * ptrace_may_access - check whether the caller is permitted to access
73 * @mode: selects type of access and caller credentials
75 * Returns true on success, false on denial.
77 * One of the flags PTRACE_MODE_FSCREDS and PTRACE_MODE_REALCREDS must
78 * be set in @mode to specify whether the access was requested through
79 * a filesystem syscall (should use effective capabilities and fsuid
80 * of the caller) or through an explicit syscall such as
81 * process_vm_writev or ptrace (and should use the real credentials).
83 extern bool ptrace_may_access(struct task_struct *task, unsigned int mode);
85 static inline int ptrace_reparented(struct task_struct *child)
87 return !same_thread_group(child->real_parent, child->parent);
90 static inline void ptrace_unlink(struct task_struct *child)
92 if (unlikely(child->ptrace))
93 __ptrace_unlink(child);
96 int generic_ptrace_peekdata(struct task_struct *tsk, unsigned long addr,
98 int generic_ptrace_pokedata(struct task_struct *tsk, unsigned long addr,
102 * ptrace_parent - return the task that is tracing the given task
103 * @task: task to consider
105 * Returns %NULL if no one is tracing @task, or the &struct task_struct
106 * pointer to its tracer.
108 * Must called under rcu_read_lock(). The pointer returned might be kept
109 * live only by RCU. During exec, this may be called with task_lock() held
110 * on @task, still held from when check_unsafe_exec() was called.
112 static inline struct task_struct *ptrace_parent(struct task_struct *task)
114 if (unlikely(task->ptrace))
115 return rcu_dereference(task->parent);
120 * ptrace_event_enabled - test whether a ptrace event is enabled
121 * @task: ptracee of interest
122 * @event: %PTRACE_EVENT_* to test
124 * Test whether @event is enabled for ptracee @task.
126 * Returns %true if @event is enabled, %false otherwise.
128 static inline bool ptrace_event_enabled(struct task_struct *task, int event)
130 return task->ptrace & PT_EVENT_FLAG(event);
134 * ptrace_event - possibly stop for a ptrace event notification
135 * @event: %PTRACE_EVENT_* value to report
136 * @message: value for %PTRACE_GETEVENTMSG to return
138 * Check whether @event is enabled and, if so, report @event and @message
139 * to the ptrace parent.
141 * Called without locks.
143 static inline void ptrace_event(int event, unsigned long message)
145 if (unlikely(ptrace_event_enabled(current, event))) {
146 current->ptrace_message = message;
147 ptrace_notify((event << 8) | SIGTRAP);
148 } else if (event == PTRACE_EVENT_EXEC) {
149 /* legacy EXEC report via SIGTRAP */
150 if ((current->ptrace & (PT_PTRACED|PT_SEIZED)) == PT_PTRACED)
151 send_sig(SIGTRAP, current, 0);
156 * ptrace_event_pid - possibly stop for a ptrace event notification
157 * @event: %PTRACE_EVENT_* value to report
158 * @pid: process identifier for %PTRACE_GETEVENTMSG to return
160 * Check whether @event is enabled and, if so, report @event and @pid
161 * to the ptrace parent. @pid is reported as the pid_t seen from the
162 * the ptrace parent's pid namespace.
164 * Called without locks.
166 static inline void ptrace_event_pid(int event, struct pid *pid)
169 * FIXME: There's a potential race if a ptracer in a different pid
170 * namespace than parent attaches between computing message below and
171 * when we acquire tasklist_lock in ptrace_stop(). If this happens,
172 * the ptracer will get a bogus pid from PTRACE_GETEVENTMSG.
174 unsigned long message = 0;
175 struct pid_namespace *ns;
178 ns = task_active_pid_ns(rcu_dereference(current->parent));
180 message = pid_nr_ns(pid, ns);
183 ptrace_event(event, message);
187 * ptrace_init_task - initialize ptrace state for a new child
188 * @child: new child task
189 * @ptrace: true if child should be ptrace'd by parent's tracer
191 * This is called immediately after adding @child to its parent's children
192 * list. @ptrace is false in the normal case, and true to ptrace @child.
194 * Called with current's siglock and write_lock_irq(&tasklist_lock) held.
196 static inline void ptrace_init_task(struct task_struct *child, bool ptrace)
198 INIT_LIST_HEAD(&child->ptrace_entry);
199 INIT_LIST_HEAD(&child->ptraced);
202 child->parent = child->real_parent;
204 if (unlikely(ptrace) && current->ptrace) {
205 child->ptrace = current->ptrace;
206 __ptrace_link(child, current->parent, current->ptracer_cred);
208 if (child->ptrace & PT_SEIZED)
209 task_set_jobctl_pending(child, JOBCTL_TRAP_STOP);
211 sigaddset(&child->pending.signal, SIGSTOP);
213 set_tsk_thread_flag(child, TIF_SIGPENDING);
216 child->ptracer_cred = NULL;
220 * ptrace_release_task - final ptrace-related cleanup of a zombie being reaped
221 * @task: task in %EXIT_DEAD state
223 * Called with write_lock(&tasklist_lock) held.
225 static inline void ptrace_release_task(struct task_struct *task)
227 BUG_ON(!list_empty(&task->ptraced));
229 BUG_ON(!list_empty(&task->ptrace_entry));
232 #ifndef force_successful_syscall_return
234 * System call handlers that, upon successful completion, need to return a
235 * negative value should call force_successful_syscall_return() right before
236 * returning. On architectures where the syscall convention provides for a
237 * separate error flag (e.g., alpha, ia64, ppc{,64}, sparc{,64}, possibly
238 * others), this macro can be used to ensure that the error flag will not get
239 * set. On architectures which do not support a separate error flag, the macro
240 * is a no-op and the spurious error condition needs to be filtered out by some
241 * other means (e.g., in user-level, by passing an extra argument to the
242 * syscall handler, or something along those lines).
244 #define force_successful_syscall_return() do { } while (0)
247 #ifndef is_syscall_success
249 * On most systems we can tell if a syscall is a success based on if the retval
250 * is an error value. On some systems like ia64 and powerpc they have different
251 * indicators of success/failure and must define their own.
253 #define is_syscall_success(regs) (!IS_ERR_VALUE((unsigned long)(regs_return_value(regs))))
257 * <asm/ptrace.h> should define the following things inside #ifdef __KERNEL__.
259 * These do-nothing inlines are used when the arch does not
260 * implement single-step. The kerneldoc comments are here
261 * to document the interface for all arch definitions.
264 #ifndef arch_has_single_step
266 * arch_has_single_step - does this CPU support user-mode single-step?
268 * If this is defined, then there must be function declarations or
269 * inlines for user_enable_single_step() and user_disable_single_step().
270 * arch_has_single_step() should evaluate to nonzero iff the machine
271 * supports instruction single-step for user mode.
272 * It can be a constant or it can test a CPU feature bit.
274 #define arch_has_single_step() (0)
277 * user_enable_single_step - single-step in user-mode task
278 * @task: either current or a task stopped in %TASK_TRACED
280 * This can only be called when arch_has_single_step() has returned nonzero.
281 * Set @task so that when it returns to user mode, it will trap after the
282 * next single instruction executes. If arch_has_block_step() is defined,
283 * this must clear the effects of user_enable_block_step() too.
285 static inline void user_enable_single_step(struct task_struct *task)
287 BUG(); /* This can never be called. */
291 * user_disable_single_step - cancel user-mode single-step
292 * @task: either current or a task stopped in %TASK_TRACED
294 * Clear @task of the effects of user_enable_single_step() and
295 * user_enable_block_step(). This can be called whether or not either
296 * of those was ever called on @task, and even if arch_has_single_step()
299 static inline void user_disable_single_step(struct task_struct *task)
303 extern void user_enable_single_step(struct task_struct *);
304 extern void user_disable_single_step(struct task_struct *);
305 #endif /* arch_has_single_step */
307 #ifndef arch_has_block_step
309 * arch_has_block_step - does this CPU support user-mode block-step?
311 * If this is defined, then there must be a function declaration or inline
312 * for user_enable_block_step(), and arch_has_single_step() must be defined
313 * too. arch_has_block_step() should evaluate to nonzero iff the machine
314 * supports step-until-branch for user mode. It can be a constant or it
315 * can test a CPU feature bit.
317 #define arch_has_block_step() (0)
320 * user_enable_block_step - step until branch in user-mode task
321 * @task: either current or a task stopped in %TASK_TRACED
323 * This can only be called when arch_has_block_step() has returned nonzero,
324 * and will never be called when single-instruction stepping is being used.
325 * Set @task so that when it returns to user mode, it will trap after the
326 * next branch or trap taken.
328 static inline void user_enable_block_step(struct task_struct *task)
330 BUG(); /* This can never be called. */
333 extern void user_enable_block_step(struct task_struct *);
334 #endif /* arch_has_block_step */
336 #ifdef ARCH_HAS_USER_SINGLE_STEP_INFO
337 extern void user_single_step_siginfo(struct task_struct *tsk,
338 struct pt_regs *regs, siginfo_t *info);
340 static inline void user_single_step_siginfo(struct task_struct *tsk,
341 struct pt_regs *regs, siginfo_t *info)
343 memset(info, 0, sizeof(*info));
344 info->si_signo = SIGTRAP;
348 #ifndef arch_ptrace_stop_needed
350 * arch_ptrace_stop_needed - Decide whether arch_ptrace_stop() should be called
351 * @code: current->exit_code value ptrace will stop with
352 * @info: siginfo_t pointer (or %NULL) for signal ptrace will stop with
354 * This is called with the siglock held, to decide whether or not it's
355 * necessary to release the siglock and call arch_ptrace_stop() with the
356 * same @code and @info arguments. It can be defined to a constant if
357 * arch_ptrace_stop() is never required, or always is. On machines where
358 * this makes sense, it should be defined to a quick test to optimize out
359 * calling arch_ptrace_stop() when it would be superfluous. For example,
360 * if the thread has not been back to user mode since the last stop, the
361 * thread state might indicate that nothing needs to be done.
363 * This is guaranteed to be invoked once before a task stops for ptrace and
364 * may include arch-specific operations necessary prior to a ptrace stop.
366 #define arch_ptrace_stop_needed(code, info) (0)
369 #ifndef arch_ptrace_stop
371 * arch_ptrace_stop - Do machine-specific work before stopping for ptrace
372 * @code: current->exit_code value ptrace will stop with
373 * @info: siginfo_t pointer (or %NULL) for signal ptrace will stop with
375 * This is called with no locks held when arch_ptrace_stop_needed() has
376 * just returned nonzero. It is allowed to block, e.g. for user memory
377 * access. The arch can have machine-specific work to be done before
378 * ptrace stops. On ia64, register backing store gets written back to user
379 * memory here. Since this can be costly (requires dropping the siglock),
380 * we only do it when the arch requires it for this particular stop, as
381 * indicated by arch_ptrace_stop_needed().
383 #define arch_ptrace_stop(code, info) do { } while (0)
386 #ifndef current_pt_regs
387 #define current_pt_regs() task_pt_regs(current)
390 #ifndef ptrace_signal_deliver
391 #define ptrace_signal_deliver() ((void)0)
395 * unlike current_pt_regs(), this one is equal to task_pt_regs(current)
396 * on *all* architectures; the only reason to have a per-arch definition
399 #ifndef signal_pt_regs
400 #define signal_pt_regs() task_pt_regs(current)
403 #ifndef current_user_stack_pointer
404 #define current_user_stack_pointer() user_stack_pointer(current_pt_regs())
407 extern int task_current_syscall(struct task_struct *target, long *callno,
408 unsigned long args[6], unsigned int maxargs,
409 unsigned long *sp, unsigned long *pc);