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>
25 #include <linux/regset.h>
29 * ptrace a task: make the debugger its new parent and
30 * move it to the ptrace list.
32 * Must be called with the tasklist lock write-held.
34 void __ptrace_link(struct task_struct *child, struct task_struct *new_parent)
36 BUG_ON(!list_empty(&child->ptrace_entry));
37 list_add(&child->ptrace_entry, &new_parent->ptraced);
38 child->parent = new_parent;
42 * Turn a tracing stop into a normal stop now, since with no tracer there
43 * would be no way to wake it up with SIGCONT or SIGKILL. If there was a
44 * signal sent that would resume the child, but didn't because it was in
45 * TASK_TRACED, resume it now.
46 * Requires that irqs be disabled.
48 static void ptrace_untrace(struct task_struct *child)
50 spin_lock(&child->sighand->siglock);
51 if (task_is_traced(child)) {
53 * If the group stop is completed or in progress,
54 * this thread was already counted as stopped.
56 if (child->signal->flags & SIGNAL_STOP_STOPPED ||
57 child->signal->group_stop_count)
58 __set_task_state(child, TASK_STOPPED);
60 signal_wake_up(child, 1);
62 spin_unlock(&child->sighand->siglock);
66 * unptrace a task: move it back to its original parent and
67 * remove it from the ptrace list.
69 * Must be called with the tasklist lock write-held.
71 void __ptrace_unlink(struct task_struct *child)
73 BUG_ON(!child->ptrace);
76 child->parent = child->real_parent;
77 list_del_init(&child->ptrace_entry);
79 arch_ptrace_untrace(child);
80 if (task_is_traced(child))
81 ptrace_untrace(child);
85 * Check that we have indeed attached to the thing..
87 int ptrace_check_attach(struct task_struct *child, int kill)
92 * We take the read lock around doing both checks to close a
93 * possible race where someone else was tracing our child and
94 * detached between these two checks. After this locked check,
95 * we are sure that this is our traced child and that can only
96 * be changed by us so it's not changing right after this.
98 read_lock(&tasklist_lock);
99 if ((child->ptrace & PT_PTRACED) && child->parent == current) {
102 * child->sighand can't be NULL, release_task()
103 * does ptrace_unlink() before __exit_signal().
105 spin_lock_irq(&child->sighand->siglock);
106 if (task_is_stopped(child))
107 child->state = TASK_TRACED;
108 else if (!task_is_traced(child) && !kill)
110 spin_unlock_irq(&child->sighand->siglock);
112 read_unlock(&tasklist_lock);
115 ret = wait_task_inactive(child, TASK_TRACED) ? 0 : -ESRCH;
117 /* All systems go.. */
121 int __ptrace_may_access(struct task_struct *task, unsigned int mode)
123 const struct cred *cred = current_cred(), *tcred;
125 /* May we inspect the given task?
126 * This check is used both for attaching with ptrace
127 * and for allowing access to sensitive information in /proc.
129 * ptrace_attach denies several cases that /proc allows
130 * because setting up the necessary parent/child relationship
131 * or halting the specified task is impossible.
134 /* Don't let security modules deny introspection */
138 tcred = __task_cred(task);
139 if ((cred->uid != tcred->euid ||
140 cred->uid != tcred->suid ||
141 cred->uid != tcred->uid ||
142 cred->gid != tcred->egid ||
143 cred->gid != tcred->sgid ||
144 cred->gid != tcred->gid) &&
145 !capable(CAP_SYS_PTRACE)) {
152 dumpable = get_dumpable(task->mm);
153 if (!dumpable && !capable(CAP_SYS_PTRACE))
156 return security_ptrace_access_check(task, mode);
159 bool ptrace_may_access(struct task_struct *task, unsigned int mode)
163 err = __ptrace_may_access(task, mode);
168 int ptrace_attach(struct task_struct *task)
175 if (unlikely(task->flags & PF_KTHREAD))
177 if (same_thread_group(task, current))
181 * Protect exec's credential calculations against our interference;
182 * interference; SUID, SGID and LSM creds get determined differently
185 retval = -ERESTARTNOINTR;
186 if (mutex_lock_interruptible(&task->cred_guard_mutex))
190 retval = __ptrace_may_access(task, PTRACE_MODE_ATTACH);
195 write_lock_irq(&tasklist_lock);
197 if (unlikely(task->exit_state))
198 goto unlock_tasklist;
200 goto unlock_tasklist;
202 task->ptrace = PT_PTRACED;
203 if (capable(CAP_SYS_PTRACE))
204 task->ptrace |= PT_PTRACE_CAP;
206 __ptrace_link(task, current);
207 send_sig_info(SIGSTOP, SEND_SIG_FORCED, task);
211 write_unlock_irq(&tasklist_lock);
213 mutex_unlock(&task->cred_guard_mutex);
219 * ptrace_traceme -- helper for PTRACE_TRACEME
221 * Performs checks and sets PT_PTRACED.
222 * Should be used by all ptrace implementations for PTRACE_TRACEME.
224 int ptrace_traceme(void)
228 write_lock_irq(&tasklist_lock);
229 /* Are we already being traced? */
230 if (!current->ptrace) {
231 ret = security_ptrace_traceme(current->parent);
233 * Check PF_EXITING to ensure ->real_parent has not passed
234 * exit_ptrace(). Otherwise we don't report the error but
235 * pretend ->real_parent untraces us right after return.
237 if (!ret && !(current->real_parent->flags & PF_EXITING)) {
238 current->ptrace = PT_PTRACED;
239 __ptrace_link(current, current->real_parent);
242 write_unlock_irq(&tasklist_lock);
248 * Called with irqs disabled, returns true if childs should reap themselves.
250 static int ignoring_children(struct sighand_struct *sigh)
253 spin_lock(&sigh->siglock);
254 ret = (sigh->action[SIGCHLD-1].sa.sa_handler == SIG_IGN) ||
255 (sigh->action[SIGCHLD-1].sa.sa_flags & SA_NOCLDWAIT);
256 spin_unlock(&sigh->siglock);
261 * Called with tasklist_lock held for writing.
262 * Unlink a traced task, and clean it up if it was a traced zombie.
263 * Return true if it needs to be reaped with release_task().
264 * (We can't call release_task() here because we already hold tasklist_lock.)
266 * If it's a zombie, our attachedness prevented normal parent notification
267 * or self-reaping. Do notification now if it would have happened earlier.
268 * If it should reap itself, return true.
270 * If it's our own child, there is no notification to do. But if our normal
271 * children self-reap, then this child was prevented by ptrace and we must
272 * reap it now, in that case we must also wake up sub-threads sleeping in
275 static bool __ptrace_detach(struct task_struct *tracer, struct task_struct *p)
279 if (p->exit_state == EXIT_ZOMBIE) {
280 if (!task_detached(p) && thread_group_empty(p)) {
281 if (!same_thread_group(p->real_parent, tracer))
282 do_notify_parent(p, p->exit_signal);
283 else if (ignoring_children(tracer->sighand)) {
284 __wake_up_parent(p, tracer);
288 if (task_detached(p)) {
289 /* Mark it as in the process of being reaped. */
290 p->exit_state = EXIT_DEAD;
298 int ptrace_detach(struct task_struct *child, unsigned int data)
302 if (!valid_signal(data))
305 /* Architecture-specific hardware disable .. */
306 ptrace_disable(child);
307 clear_tsk_thread_flag(child, TIF_SYSCALL_TRACE);
309 write_lock_irq(&tasklist_lock);
311 * This child can be already killed. Make sure de_thread() or
312 * our sub-thread doing do_wait() didn't do release_task() yet.
315 child->exit_code = data;
316 dead = __ptrace_detach(current, child);
317 if (!child->exit_state)
318 wake_up_process(child);
320 write_unlock_irq(&tasklist_lock);
329 * Detach all tasks we were using ptrace on.
331 void exit_ptrace(struct task_struct *tracer)
333 struct task_struct *p, *n;
334 LIST_HEAD(ptrace_dead);
336 write_lock_irq(&tasklist_lock);
337 list_for_each_entry_safe(p, n, &tracer->ptraced, ptrace_entry) {
338 if (__ptrace_detach(tracer, p))
339 list_add(&p->ptrace_entry, &ptrace_dead);
341 write_unlock_irq(&tasklist_lock);
343 BUG_ON(!list_empty(&tracer->ptraced));
345 list_for_each_entry_safe(p, n, &ptrace_dead, ptrace_entry) {
346 list_del_init(&p->ptrace_entry);
351 int ptrace_readdata(struct task_struct *tsk, unsigned long src, char __user *dst, int len)
357 int this_len, retval;
359 this_len = (len > sizeof(buf)) ? sizeof(buf) : len;
360 retval = access_process_vm(tsk, src, buf, this_len, 0);
366 if (copy_to_user(dst, buf, retval))
376 int ptrace_writedata(struct task_struct *tsk, char __user *src, unsigned long dst, int len)
382 int this_len, retval;
384 this_len = (len > sizeof(buf)) ? sizeof(buf) : len;
385 if (copy_from_user(buf, src, this_len))
387 retval = access_process_vm(tsk, dst, buf, this_len, 1);
401 static int ptrace_setoptions(struct task_struct *child, long data)
403 child->ptrace &= ~PT_TRACE_MASK;
405 if (data & PTRACE_O_TRACESYSGOOD)
406 child->ptrace |= PT_TRACESYSGOOD;
408 if (data & PTRACE_O_TRACEFORK)
409 child->ptrace |= PT_TRACE_FORK;
411 if (data & PTRACE_O_TRACEVFORK)
412 child->ptrace |= PT_TRACE_VFORK;
414 if (data & PTRACE_O_TRACECLONE)
415 child->ptrace |= PT_TRACE_CLONE;
417 if (data & PTRACE_O_TRACEEXEC)
418 child->ptrace |= PT_TRACE_EXEC;
420 if (data & PTRACE_O_TRACEVFORKDONE)
421 child->ptrace |= PT_TRACE_VFORK_DONE;
423 if (data & PTRACE_O_TRACEEXIT)
424 child->ptrace |= PT_TRACE_EXIT;
426 return (data & ~PTRACE_O_MASK) ? -EINVAL : 0;
429 static int ptrace_getsiginfo(struct task_struct *child, siginfo_t *info)
434 if (lock_task_sighand(child, &flags)) {
436 if (likely(child->last_siginfo != NULL)) {
437 *info = *child->last_siginfo;
440 unlock_task_sighand(child, &flags);
445 static int ptrace_setsiginfo(struct task_struct *child, const siginfo_t *info)
450 if (lock_task_sighand(child, &flags)) {
452 if (likely(child->last_siginfo != NULL)) {
453 *child->last_siginfo = *info;
456 unlock_task_sighand(child, &flags);
462 #ifdef PTRACE_SINGLESTEP
463 #define is_singlestep(request) ((request) == PTRACE_SINGLESTEP)
465 #define is_singlestep(request) 0
468 #ifdef PTRACE_SINGLEBLOCK
469 #define is_singleblock(request) ((request) == PTRACE_SINGLEBLOCK)
471 #define is_singleblock(request) 0
475 #define is_sysemu_singlestep(request) ((request) == PTRACE_SYSEMU_SINGLESTEP)
477 #define is_sysemu_singlestep(request) 0
480 static int ptrace_resume(struct task_struct *child, long request, long data)
482 if (!valid_signal(data))
485 if (request == PTRACE_SYSCALL)
486 set_tsk_thread_flag(child, TIF_SYSCALL_TRACE);
488 clear_tsk_thread_flag(child, TIF_SYSCALL_TRACE);
490 #ifdef TIF_SYSCALL_EMU
491 if (request == PTRACE_SYSEMU || request == PTRACE_SYSEMU_SINGLESTEP)
492 set_tsk_thread_flag(child, TIF_SYSCALL_EMU);
494 clear_tsk_thread_flag(child, TIF_SYSCALL_EMU);
497 if (is_singleblock(request)) {
498 if (unlikely(!arch_has_block_step()))
500 user_enable_block_step(child);
501 } else if (is_singlestep(request) || is_sysemu_singlestep(request)) {
502 if (unlikely(!arch_has_single_step()))
504 user_enable_single_step(child);
506 user_disable_single_step(child);
509 child->exit_code = data;
510 wake_up_process(child);
515 #ifdef CONFIG_HAVE_ARCH_TRACEHOOK
517 static const struct user_regset *
518 find_regset(const struct user_regset_view *view, unsigned int type)
520 const struct user_regset *regset;
523 for (n = 0; n < view->n; ++n) {
524 regset = view->regsets + n;
525 if (regset->core_note_type == type)
532 static int ptrace_regset(struct task_struct *task, int req, unsigned int type,
535 const struct user_regset_view *view = task_user_regset_view(task);
536 const struct user_regset *regset = find_regset(view, type);
539 if (!regset || (kiov->iov_len % regset->size) != 0)
542 regset_no = regset - view->regsets;
543 kiov->iov_len = min(kiov->iov_len,
544 (__kernel_size_t) (regset->n * regset->size));
546 if (req == PTRACE_GETREGSET)
547 return copy_regset_to_user(task, view, regset_no, 0,
548 kiov->iov_len, kiov->iov_base);
550 return copy_regset_from_user(task, view, regset_no, 0,
551 kiov->iov_len, kiov->iov_base);
556 int ptrace_request(struct task_struct *child, long request,
557 long addr, long data)
563 case PTRACE_PEEKTEXT:
564 case PTRACE_PEEKDATA:
565 return generic_ptrace_peekdata(child, addr, data);
566 case PTRACE_POKETEXT:
567 case PTRACE_POKEDATA:
568 return generic_ptrace_pokedata(child, addr, data);
570 #ifdef PTRACE_OLDSETOPTIONS
571 case PTRACE_OLDSETOPTIONS:
573 case PTRACE_SETOPTIONS:
574 ret = ptrace_setoptions(child, data);
576 case PTRACE_GETEVENTMSG:
577 ret = put_user(child->ptrace_message, (unsigned long __user *) data);
580 case PTRACE_GETSIGINFO:
581 ret = ptrace_getsiginfo(child, &siginfo);
583 ret = copy_siginfo_to_user((siginfo_t __user *) data,
587 case PTRACE_SETSIGINFO:
588 if (copy_from_user(&siginfo, (siginfo_t __user *) data,
592 ret = ptrace_setsiginfo(child, &siginfo);
595 case PTRACE_DETACH: /* detach a process that was attached. */
596 ret = ptrace_detach(child, data);
599 #ifdef PTRACE_SINGLESTEP
600 case PTRACE_SINGLESTEP:
602 #ifdef PTRACE_SINGLEBLOCK
603 case PTRACE_SINGLEBLOCK:
607 case PTRACE_SYSEMU_SINGLESTEP:
611 return ptrace_resume(child, request, data);
614 if (child->exit_state) /* already dead */
616 return ptrace_resume(child, request, SIGKILL);
618 #ifdef CONFIG_HAVE_ARCH_TRACEHOOK
619 case PTRACE_GETREGSET:
620 case PTRACE_SETREGSET:
623 struct iovec __user *uiov = (struct iovec __user *) data;
625 if (!access_ok(VERIFY_WRITE, uiov, sizeof(*uiov)))
628 if (__get_user(kiov.iov_base, &uiov->iov_base) ||
629 __get_user(kiov.iov_len, &uiov->iov_len))
632 ret = ptrace_regset(child, request, addr, &kiov);
634 ret = __put_user(kiov.iov_len, &uiov->iov_len);
645 static struct task_struct *ptrace_get_task_struct(pid_t pid)
647 struct task_struct *child;
650 child = find_task_by_vpid(pid);
652 get_task_struct(child);
656 return ERR_PTR(-ESRCH);
660 #ifndef arch_ptrace_attach
661 #define arch_ptrace_attach(child) do { } while (0)
664 SYSCALL_DEFINE4(ptrace, long, request, long, pid, long, addr, long, data)
666 struct task_struct *child;
670 * This lock_kernel fixes a subtle race with suid exec
673 if (request == PTRACE_TRACEME) {
674 ret = ptrace_traceme();
676 arch_ptrace_attach(current);
680 child = ptrace_get_task_struct(pid);
682 ret = PTR_ERR(child);
686 if (request == PTRACE_ATTACH) {
687 ret = ptrace_attach(child);
689 * Some architectures need to do book-keeping after
693 arch_ptrace_attach(child);
694 goto out_put_task_struct;
697 ret = ptrace_check_attach(child, request == PTRACE_KILL);
699 goto out_put_task_struct;
701 ret = arch_ptrace(child, request, addr, data);
704 put_task_struct(child);
710 int generic_ptrace_peekdata(struct task_struct *tsk, long addr, long data)
715 copied = access_process_vm(tsk, addr, &tmp, sizeof(tmp), 0);
716 if (copied != sizeof(tmp))
718 return put_user(tmp, (unsigned long __user *)data);
721 int generic_ptrace_pokedata(struct task_struct *tsk, long addr, long data)
725 copied = access_process_vm(tsk, addr, &data, sizeof(data), 1);
726 return (copied == sizeof(data)) ? 0 : -EIO;
729 #if defined CONFIG_COMPAT
730 #include <linux/compat.h>
732 int compat_ptrace_request(struct task_struct *child, compat_long_t request,
733 compat_ulong_t addr, compat_ulong_t data)
735 compat_ulong_t __user *datap = compat_ptr(data);
741 case PTRACE_PEEKTEXT:
742 case PTRACE_PEEKDATA:
743 ret = access_process_vm(child, addr, &word, sizeof(word), 0);
744 if (ret != sizeof(word))
747 ret = put_user(word, datap);
750 case PTRACE_POKETEXT:
751 case PTRACE_POKEDATA:
752 ret = access_process_vm(child, addr, &data, sizeof(data), 1);
753 ret = (ret != sizeof(data) ? -EIO : 0);
756 case PTRACE_GETEVENTMSG:
757 ret = put_user((compat_ulong_t) child->ptrace_message, datap);
760 case PTRACE_GETSIGINFO:
761 ret = ptrace_getsiginfo(child, &siginfo);
763 ret = copy_siginfo_to_user32(
764 (struct compat_siginfo __user *) datap,
768 case PTRACE_SETSIGINFO:
769 memset(&siginfo, 0, sizeof siginfo);
770 if (copy_siginfo_from_user32(
771 &siginfo, (struct compat_siginfo __user *) datap))
774 ret = ptrace_setsiginfo(child, &siginfo);
776 #ifdef CONFIG_HAVE_ARCH_TRACEHOOK
777 case PTRACE_GETREGSET:
778 case PTRACE_SETREGSET:
781 struct compat_iovec __user *uiov =
782 (struct compat_iovec __user *) datap;
786 if (!access_ok(VERIFY_WRITE, uiov, sizeof(*uiov)))
789 if (__get_user(ptr, &uiov->iov_base) ||
790 __get_user(len, &uiov->iov_len))
793 kiov.iov_base = compat_ptr(ptr);
796 ret = ptrace_regset(child, request, addr, &kiov);
798 ret = __put_user(kiov.iov_len, &uiov->iov_len);
804 ret = ptrace_request(child, request, addr, data);
810 asmlinkage long compat_sys_ptrace(compat_long_t request, compat_long_t pid,
811 compat_long_t addr, compat_long_t data)
813 struct task_struct *child;
817 * This lock_kernel fixes a subtle race with suid exec
820 if (request == PTRACE_TRACEME) {
821 ret = ptrace_traceme();
825 child = ptrace_get_task_struct(pid);
827 ret = PTR_ERR(child);
831 if (request == PTRACE_ATTACH) {
832 ret = ptrace_attach(child);
834 * Some architectures need to do book-keeping after
838 arch_ptrace_attach(child);
839 goto out_put_task_struct;
842 ret = ptrace_check_attach(child, request == PTRACE_KILL);
844 ret = compat_arch_ptrace(child, request, addr, data);
847 put_task_struct(child);
852 #endif /* CONFIG_COMPAT */