2 * linux/kernel/ptrace.c
4 * (C) Copyright 1999 Linus Torvalds
6 * Common interfaces for "ptrace()" which we do not want
7 * to continually duplicate across every architecture.
10 #include <linux/capability.h>
11 #include <linux/module.h>
12 #include <linux/sched.h>
13 #include <linux/errno.h>
15 #include <linux/highmem.h>
16 #include <linux/pagemap.h>
17 #include <linux/smp_lock.h>
18 #include <linux/ptrace.h>
19 #include <linux/security.h>
20 #include <linux/signal.h>
21 #include <linux/audit.h>
22 #include <linux/pid_namespace.h>
23 #include <linux/syscalls.h>
24 #include <linux/uaccess.h>
28 * ptrace a task: make the debugger its new parent and
29 * move it to the ptrace list.
31 * Must be called with the tasklist lock write-held.
33 void __ptrace_link(struct task_struct *child, struct task_struct *new_parent)
35 BUG_ON(!list_empty(&child->ptrace_entry));
36 list_add(&child->ptrace_entry, &new_parent->ptraced);
37 child->parent = new_parent;
41 * Turn a tracing stop into a normal stop now, since with no tracer there
42 * would be no way to wake it up with SIGCONT or SIGKILL. If there was a
43 * signal sent that would resume the child, but didn't because it was in
44 * TASK_TRACED, resume it now.
45 * Requires that irqs be disabled.
47 static void ptrace_untrace(struct task_struct *child)
49 spin_lock(&child->sighand->siglock);
50 if (task_is_traced(child)) {
52 * If the group stop is completed or in progress,
53 * this thread was already counted as stopped.
55 if (child->signal->flags & SIGNAL_STOP_STOPPED ||
56 child->signal->group_stop_count)
57 __set_task_state(child, TASK_STOPPED);
59 signal_wake_up(child, 1);
61 spin_unlock(&child->sighand->siglock);
65 * unptrace a task: move it back to its original parent and
66 * remove it from the ptrace list.
68 * Must be called with the tasklist lock write-held.
70 void __ptrace_unlink(struct task_struct *child)
72 BUG_ON(!child->ptrace);
75 child->parent = child->real_parent;
76 list_del_init(&child->ptrace_entry);
78 arch_ptrace_untrace(child);
79 if (task_is_traced(child))
80 ptrace_untrace(child);
84 * Check that we have indeed attached to the thing..
86 int ptrace_check_attach(struct task_struct *child, int kill)
91 * We take the read lock around doing both checks to close a
92 * possible race where someone else was tracing our child and
93 * detached between these two checks. After this locked check,
94 * we are sure that this is our traced child and that can only
95 * be changed by us so it's not changing right after this.
97 read_lock(&tasklist_lock);
98 if ((child->ptrace & PT_PTRACED) && child->parent == current) {
101 * child->sighand can't be NULL, release_task()
102 * does ptrace_unlink() before __exit_signal().
104 spin_lock_irq(&child->sighand->siglock);
105 if (task_is_stopped(child))
106 child->state = TASK_TRACED;
107 else if (!task_is_traced(child) && !kill)
109 spin_unlock_irq(&child->sighand->siglock);
111 read_unlock(&tasklist_lock);
114 ret = wait_task_inactive(child, TASK_TRACED) ? 0 : -ESRCH;
116 /* All systems go.. */
120 int __ptrace_may_access(struct task_struct *task, unsigned int mode)
122 const struct cred *cred = current_cred(), *tcred;
124 /* May we inspect the given task?
125 * This check is used both for attaching with ptrace
126 * and for allowing access to sensitive information in /proc.
128 * ptrace_attach denies several cases that /proc allows
129 * because setting up the necessary parent/child relationship
130 * or halting the specified task is impossible.
133 /* Don't let security modules deny introspection */
137 tcred = __task_cred(task);
138 if ((cred->uid != tcred->euid ||
139 cred->uid != tcred->suid ||
140 cred->uid != tcred->uid ||
141 cred->gid != tcred->egid ||
142 cred->gid != tcred->sgid ||
143 cred->gid != tcred->gid) &&
144 !capable(CAP_SYS_PTRACE)) {
151 dumpable = get_dumpable(task->mm);
152 if (!dumpable && !capable(CAP_SYS_PTRACE))
155 return security_ptrace_may_access(task, mode);
158 bool ptrace_may_access(struct task_struct *task, unsigned int mode)
162 err = __ptrace_may_access(task, mode);
167 int ptrace_attach(struct task_struct *task)
174 if (unlikely(task->flags & PF_KTHREAD))
176 if (same_thread_group(task, current))
180 * Protect exec's credential calculations against our interference;
181 * interference; SUID, SGID and LSM creds get determined differently
184 retval = -ERESTARTNOINTR;
185 if (mutex_lock_interruptible(&task->cred_guard_mutex))
189 retval = __ptrace_may_access(task, PTRACE_MODE_ATTACH);
194 write_lock_irq(&tasklist_lock);
196 if (unlikely(task->exit_state))
197 goto unlock_tasklist;
199 goto unlock_tasklist;
201 task->ptrace = PT_PTRACED;
202 if (capable(CAP_SYS_PTRACE))
203 task->ptrace |= PT_PTRACE_CAP;
205 __ptrace_link(task, current);
206 send_sig_info(SIGSTOP, SEND_SIG_FORCED, task);
210 write_unlock_irq(&tasklist_lock);
212 mutex_unlock(&task->cred_guard_mutex);
218 * ptrace_traceme -- helper for PTRACE_TRACEME
220 * Performs checks and sets PT_PTRACED.
221 * Should be used by all ptrace implementations for PTRACE_TRACEME.
223 int ptrace_traceme(void)
227 write_lock_irq(&tasklist_lock);
228 /* Are we already being traced? */
229 if (!current->ptrace) {
230 ret = security_ptrace_traceme(current->parent);
232 * Check PF_EXITING to ensure ->real_parent has not passed
233 * exit_ptrace(). Otherwise we don't report the error but
234 * pretend ->real_parent untraces us right after return.
236 if (!ret && !(current->real_parent->flags & PF_EXITING)) {
237 current->ptrace = PT_PTRACED;
238 __ptrace_link(current, current->real_parent);
241 write_unlock_irq(&tasklist_lock);
247 * Called with irqs disabled, returns true if childs should reap themselves.
249 static int ignoring_children(struct sighand_struct *sigh)
252 spin_lock(&sigh->siglock);
253 ret = (sigh->action[SIGCHLD-1].sa.sa_handler == SIG_IGN) ||
254 (sigh->action[SIGCHLD-1].sa.sa_flags & SA_NOCLDWAIT);
255 spin_unlock(&sigh->siglock);
260 * Called with tasklist_lock held for writing.
261 * Unlink a traced task, and clean it up if it was a traced zombie.
262 * Return true if it needs to be reaped with release_task().
263 * (We can't call release_task() here because we already hold tasklist_lock.)
265 * If it's a zombie, our attachedness prevented normal parent notification
266 * or self-reaping. Do notification now if it would have happened earlier.
267 * If it should reap itself, return true.
269 * If it's our own child, there is no notification to do.
270 * But if our normal children self-reap, then this child
271 * was prevented by ptrace and we must reap it now.
273 static bool __ptrace_detach(struct task_struct *tracer, struct task_struct *p)
277 if (p->exit_state == EXIT_ZOMBIE) {
278 if (!task_detached(p) && thread_group_empty(p)) {
279 if (!same_thread_group(p->real_parent, tracer))
280 do_notify_parent(p, p->exit_signal);
281 else if (ignoring_children(tracer->sighand))
284 if (task_detached(p)) {
285 /* Mark it as in the process of being reaped. */
286 p->exit_state = EXIT_DEAD;
294 int ptrace_detach(struct task_struct *child, unsigned int data)
298 if (!valid_signal(data))
301 /* Architecture-specific hardware disable .. */
302 ptrace_disable(child);
303 clear_tsk_thread_flag(child, TIF_SYSCALL_TRACE);
305 write_lock_irq(&tasklist_lock);
307 * This child can be already killed. Make sure de_thread() or
308 * our sub-thread doing do_wait() didn't do release_task() yet.
311 child->exit_code = data;
312 dead = __ptrace_detach(current, child);
313 if (!child->exit_state)
314 wake_up_process(child);
316 write_unlock_irq(&tasklist_lock);
325 * Detach all tasks we were using ptrace on.
327 void exit_ptrace(struct task_struct *tracer)
329 struct task_struct *p, *n;
330 LIST_HEAD(ptrace_dead);
332 write_lock_irq(&tasklist_lock);
333 list_for_each_entry_safe(p, n, &tracer->ptraced, ptrace_entry) {
334 if (__ptrace_detach(tracer, p))
335 list_add(&p->ptrace_entry, &ptrace_dead);
337 write_unlock_irq(&tasklist_lock);
339 BUG_ON(!list_empty(&tracer->ptraced));
341 list_for_each_entry_safe(p, n, &ptrace_dead, ptrace_entry) {
342 list_del_init(&p->ptrace_entry);
347 int ptrace_readdata(struct task_struct *tsk, unsigned long src, char __user *dst, int len)
353 int this_len, retval;
355 this_len = (len > sizeof(buf)) ? sizeof(buf) : len;
356 retval = access_process_vm(tsk, src, buf, this_len, 0);
362 if (copy_to_user(dst, buf, retval))
372 int ptrace_writedata(struct task_struct *tsk, char __user *src, unsigned long dst, int len)
378 int this_len, retval;
380 this_len = (len > sizeof(buf)) ? sizeof(buf) : len;
381 if (copy_from_user(buf, src, this_len))
383 retval = access_process_vm(tsk, dst, buf, this_len, 1);
397 static int ptrace_setoptions(struct task_struct *child, long data)
399 child->ptrace &= ~PT_TRACE_MASK;
401 if (data & PTRACE_O_TRACESYSGOOD)
402 child->ptrace |= PT_TRACESYSGOOD;
404 if (data & PTRACE_O_TRACEFORK)
405 child->ptrace |= PT_TRACE_FORK;
407 if (data & PTRACE_O_TRACEVFORK)
408 child->ptrace |= PT_TRACE_VFORK;
410 if (data & PTRACE_O_TRACECLONE)
411 child->ptrace |= PT_TRACE_CLONE;
413 if (data & PTRACE_O_TRACEEXEC)
414 child->ptrace |= PT_TRACE_EXEC;
416 if (data & PTRACE_O_TRACEVFORKDONE)
417 child->ptrace |= PT_TRACE_VFORK_DONE;
419 if (data & PTRACE_O_TRACEEXIT)
420 child->ptrace |= PT_TRACE_EXIT;
422 return (data & ~PTRACE_O_MASK) ? -EINVAL : 0;
425 static int ptrace_getsiginfo(struct task_struct *child, siginfo_t *info)
430 if (lock_task_sighand(child, &flags)) {
432 if (likely(child->last_siginfo != NULL)) {
433 *info = *child->last_siginfo;
436 unlock_task_sighand(child, &flags);
441 static int ptrace_setsiginfo(struct task_struct *child, const siginfo_t *info)
446 if (lock_task_sighand(child, &flags)) {
448 if (likely(child->last_siginfo != NULL)) {
449 *child->last_siginfo = *info;
452 unlock_task_sighand(child, &flags);
458 #ifdef PTRACE_SINGLESTEP
459 #define is_singlestep(request) ((request) == PTRACE_SINGLESTEP)
461 #define is_singlestep(request) 0
464 #ifdef PTRACE_SINGLEBLOCK
465 #define is_singleblock(request) ((request) == PTRACE_SINGLEBLOCK)
467 #define is_singleblock(request) 0
471 #define is_sysemu_singlestep(request) ((request) == PTRACE_SYSEMU_SINGLESTEP)
473 #define is_sysemu_singlestep(request) 0
476 static int ptrace_resume(struct task_struct *child, long request, long data)
478 if (!valid_signal(data))
481 if (request == PTRACE_SYSCALL)
482 set_tsk_thread_flag(child, TIF_SYSCALL_TRACE);
484 clear_tsk_thread_flag(child, TIF_SYSCALL_TRACE);
486 #ifdef TIF_SYSCALL_EMU
487 if (request == PTRACE_SYSEMU || request == PTRACE_SYSEMU_SINGLESTEP)
488 set_tsk_thread_flag(child, TIF_SYSCALL_EMU);
490 clear_tsk_thread_flag(child, TIF_SYSCALL_EMU);
493 if (is_singleblock(request)) {
494 if (unlikely(!arch_has_block_step()))
496 user_enable_block_step(child);
497 } else if (is_singlestep(request) || is_sysemu_singlestep(request)) {
498 if (unlikely(!arch_has_single_step()))
500 user_enable_single_step(child);
502 user_disable_single_step(child);
505 child->exit_code = data;
506 wake_up_process(child);
511 int ptrace_request(struct task_struct *child, long request,
512 long addr, long data)
518 case PTRACE_PEEKTEXT:
519 case PTRACE_PEEKDATA:
520 return generic_ptrace_peekdata(child, addr, data);
521 case PTRACE_POKETEXT:
522 case PTRACE_POKEDATA:
523 return generic_ptrace_pokedata(child, addr, data);
525 #ifdef PTRACE_OLDSETOPTIONS
526 case PTRACE_OLDSETOPTIONS:
528 case PTRACE_SETOPTIONS:
529 ret = ptrace_setoptions(child, data);
531 case PTRACE_GETEVENTMSG:
532 ret = put_user(child->ptrace_message, (unsigned long __user *) data);
535 case PTRACE_GETSIGINFO:
536 ret = ptrace_getsiginfo(child, &siginfo);
538 ret = copy_siginfo_to_user((siginfo_t __user *) data,
542 case PTRACE_SETSIGINFO:
543 if (copy_from_user(&siginfo, (siginfo_t __user *) data,
547 ret = ptrace_setsiginfo(child, &siginfo);
550 case PTRACE_DETACH: /* detach a process that was attached. */
551 ret = ptrace_detach(child, data);
554 #ifdef PTRACE_SINGLESTEP
555 case PTRACE_SINGLESTEP:
557 #ifdef PTRACE_SINGLEBLOCK
558 case PTRACE_SINGLEBLOCK:
562 case PTRACE_SYSEMU_SINGLESTEP:
566 return ptrace_resume(child, request, data);
569 if (child->exit_state) /* already dead */
571 return ptrace_resume(child, request, SIGKILL);
580 static struct task_struct *ptrace_get_task_struct(pid_t pid)
582 struct task_struct *child;
585 child = find_task_by_vpid(pid);
587 get_task_struct(child);
591 return ERR_PTR(-ESRCH);
595 #ifndef arch_ptrace_attach
596 #define arch_ptrace_attach(child) do { } while (0)
599 SYSCALL_DEFINE4(ptrace, long, request, long, pid, long, addr, long, data)
601 struct task_struct *child;
605 * This lock_kernel fixes a subtle race with suid exec
608 if (request == PTRACE_TRACEME) {
609 ret = ptrace_traceme();
611 arch_ptrace_attach(current);
615 child = ptrace_get_task_struct(pid);
617 ret = PTR_ERR(child);
621 if (request == PTRACE_ATTACH) {
622 ret = ptrace_attach(child);
624 * Some architectures need to do book-keeping after
628 arch_ptrace_attach(child);
629 goto out_put_task_struct;
632 ret = ptrace_check_attach(child, request == PTRACE_KILL);
634 goto out_put_task_struct;
636 ret = arch_ptrace(child, request, addr, data);
639 put_task_struct(child);
645 int generic_ptrace_peekdata(struct task_struct *tsk, long addr, long data)
650 copied = access_process_vm(tsk, addr, &tmp, sizeof(tmp), 0);
651 if (copied != sizeof(tmp))
653 return put_user(tmp, (unsigned long __user *)data);
656 int generic_ptrace_pokedata(struct task_struct *tsk, long addr, long data)
660 copied = access_process_vm(tsk, addr, &data, sizeof(data), 1);
661 return (copied == sizeof(data)) ? 0 : -EIO;
664 #if defined CONFIG_COMPAT
665 #include <linux/compat.h>
667 int compat_ptrace_request(struct task_struct *child, compat_long_t request,
668 compat_ulong_t addr, compat_ulong_t data)
670 compat_ulong_t __user *datap = compat_ptr(data);
676 case PTRACE_PEEKTEXT:
677 case PTRACE_PEEKDATA:
678 ret = access_process_vm(child, addr, &word, sizeof(word), 0);
679 if (ret != sizeof(word))
682 ret = put_user(word, datap);
685 case PTRACE_POKETEXT:
686 case PTRACE_POKEDATA:
687 ret = access_process_vm(child, addr, &data, sizeof(data), 1);
688 ret = (ret != sizeof(data) ? -EIO : 0);
691 case PTRACE_GETEVENTMSG:
692 ret = put_user((compat_ulong_t) child->ptrace_message, datap);
695 case PTRACE_GETSIGINFO:
696 ret = ptrace_getsiginfo(child, &siginfo);
698 ret = copy_siginfo_to_user32(
699 (struct compat_siginfo __user *) datap,
703 case PTRACE_SETSIGINFO:
704 memset(&siginfo, 0, sizeof siginfo);
705 if (copy_siginfo_from_user32(
706 &siginfo, (struct compat_siginfo __user *) datap))
709 ret = ptrace_setsiginfo(child, &siginfo);
713 ret = ptrace_request(child, request, addr, data);
719 asmlinkage long compat_sys_ptrace(compat_long_t request, compat_long_t pid,
720 compat_long_t addr, compat_long_t data)
722 struct task_struct *child;
726 * This lock_kernel fixes a subtle race with suid exec
729 if (request == PTRACE_TRACEME) {
730 ret = ptrace_traceme();
734 child = ptrace_get_task_struct(pid);
736 ret = PTR_ERR(child);
740 if (request == PTRACE_ATTACH) {
741 ret = ptrace_attach(child);
743 * Some architectures need to do book-keeping after
747 arch_ptrace_attach(child);
748 goto out_put_task_struct;
751 ret = ptrace_check_attach(child, request == PTRACE_KILL);
753 ret = compat_arch_ptrace(child, request, addr, data);
756 put_task_struct(child);
761 #endif /* CONFIG_COMPAT */