2 * linux/arch/arm/kernel/ptrace.c
5 * edited by Linus Torvalds
6 * ARM modifications Copyright (C) 2000 Russell King
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
12 #include <linux/kernel.h>
13 #include <linux/sched/signal.h>
14 #include <linux/sched/task_stack.h>
16 #include <linux/elf.h>
17 #include <linux/smp.h>
18 #include <linux/ptrace.h>
19 #include <linux/user.h>
20 #include <linux/security.h>
21 #include <linux/init.h>
22 #include <linux/signal.h>
23 #include <linux/uaccess.h>
24 #include <linux/perf_event.h>
25 #include <linux/hw_breakpoint.h>
26 #include <linux/regset.h>
27 #include <linux/audit.h>
28 #include <linux/tracehook.h>
29 #include <linux/unistd.h>
31 #include <asm/pgtable.h>
32 #include <asm/traps.h>
34 #define CREATE_TRACE_POINTS
35 #include <trace/events/syscalls.h>
40 * does not yet catch signals sent when the child dies.
41 * in exit.c or in signal.c.
46 * Breakpoint SWI instruction: SWI &9F0001
48 #define BREAKINST_ARM 0xef9f0001
49 #define BREAKINST_THUMB 0xdf00 /* fill this in later */
52 * New breakpoints - use an undefined instruction. The ARM architecture
53 * reference manual guarantees that the following instruction space
54 * will produce an undefined instruction exception on all CPUs:
56 * ARM: xxxx 0111 1111 xxxx xxxx xxxx 1111 xxxx
57 * Thumb: 1101 1110 xxxx xxxx
59 #define BREAKINST_ARM 0xe7f001f0
60 #define BREAKINST_THUMB 0xde01
63 struct pt_regs_offset {
68 #define REG_OFFSET_NAME(r) \
69 {.name = #r, .offset = offsetof(struct pt_regs, ARM_##r)}
70 #define REG_OFFSET_END {.name = NULL, .offset = 0}
72 static const struct pt_regs_offset regoffset_table[] = {
89 REG_OFFSET_NAME(cpsr),
90 REG_OFFSET_NAME(ORIG_r0),
95 * regs_query_register_offset() - query register offset from its name
96 * @name: the name of a register
98 * regs_query_register_offset() returns the offset of a register in struct
99 * pt_regs from its name. If the name is invalid, this returns -EINVAL;
101 int regs_query_register_offset(const char *name)
103 const struct pt_regs_offset *roff;
104 for (roff = regoffset_table; roff->name != NULL; roff++)
105 if (!strcmp(roff->name, name))
111 * regs_query_register_name() - query register name from its offset
112 * @offset: the offset of a register in struct pt_regs.
114 * regs_query_register_name() returns the name of a register from its
115 * offset in struct pt_regs. If the @offset is invalid, this returns NULL;
117 const char *regs_query_register_name(unsigned int offset)
119 const struct pt_regs_offset *roff;
120 for (roff = regoffset_table; roff->name != NULL; roff++)
121 if (roff->offset == offset)
127 * regs_within_kernel_stack() - check the address in the stack
128 * @regs: pt_regs which contains kernel stack pointer.
129 * @addr: address which is checked.
131 * regs_within_kernel_stack() checks @addr is within the kernel stack page(s).
132 * If @addr is within the kernel stack, it returns true. If not, returns false.
134 bool regs_within_kernel_stack(struct pt_regs *regs, unsigned long addr)
136 return ((addr & ~(THREAD_SIZE - 1)) ==
137 (kernel_stack_pointer(regs) & ~(THREAD_SIZE - 1)));
141 * regs_get_kernel_stack_nth() - get Nth entry of the stack
142 * @regs: pt_regs which contains kernel stack pointer.
143 * @n: stack entry number.
145 * regs_get_kernel_stack_nth() returns @n th entry of the kernel stack which
146 * is specified by @regs. If the @n th entry is NOT in the kernel stack,
149 unsigned long regs_get_kernel_stack_nth(struct pt_regs *regs, unsigned int n)
151 unsigned long *addr = (unsigned long *)kernel_stack_pointer(regs);
153 if (regs_within_kernel_stack(regs, (unsigned long)addr))
160 * this routine will get a word off of the processes privileged stack.
161 * the offset is how far from the base addr as stored in the THREAD.
162 * this routine assumes that all the privileged stacks are in our
165 static inline long get_user_reg(struct task_struct *task, int offset)
167 return task_pt_regs(task)->uregs[offset];
171 * this routine will put a word on the processes privileged stack.
172 * the offset is how far from the base addr as stored in the THREAD.
173 * this routine assumes that all the privileged stacks are in our
177 put_user_reg(struct task_struct *task, int offset, long data)
179 struct pt_regs newregs, *regs = task_pt_regs(task);
183 newregs.uregs[offset] = data;
185 if (valid_user_regs(&newregs)) {
186 regs->uregs[offset] = data;
194 * Called by kernel/ptrace.c when detaching..
196 void ptrace_disable(struct task_struct *child)
202 * Handle hitting a breakpoint.
204 void ptrace_break(struct task_struct *tsk, struct pt_regs *regs)
206 force_sig_fault(SIGTRAP, TRAP_BRKPT,
207 (void __user *)instruction_pointer(regs), tsk);
210 static int break_trap(struct pt_regs *regs, unsigned int instr)
212 ptrace_break(current, regs);
216 static struct undef_hook arm_break_hook = {
217 .instr_mask = 0x0fffffff,
218 .instr_val = 0x07f001f0,
219 .cpsr_mask = PSR_T_BIT,
224 static struct undef_hook thumb_break_hook = {
225 .instr_mask = 0xffff,
227 .cpsr_mask = PSR_T_BIT,
228 .cpsr_val = PSR_T_BIT,
232 static struct undef_hook thumb2_break_hook = {
233 .instr_mask = 0xffffffff,
234 .instr_val = 0xf7f0a000,
235 .cpsr_mask = PSR_T_BIT,
236 .cpsr_val = PSR_T_BIT,
240 static int __init ptrace_break_init(void)
242 register_undef_hook(&arm_break_hook);
243 register_undef_hook(&thumb_break_hook);
244 register_undef_hook(&thumb2_break_hook);
248 core_initcall(ptrace_break_init);
251 * Read the word at offset "off" into the "struct user". We
252 * actually access the pt_regs stored on the kernel stack.
254 static int ptrace_read_user(struct task_struct *tsk, unsigned long off,
255 unsigned long __user *ret)
263 if (off == PT_TEXT_ADDR)
264 tmp = tsk->mm->start_code;
265 else if (off == PT_DATA_ADDR)
266 tmp = tsk->mm->start_data;
267 else if (off == PT_TEXT_END_ADDR)
268 tmp = tsk->mm->end_code;
269 else if (off < sizeof(struct pt_regs))
270 tmp = get_user_reg(tsk, off >> 2);
271 else if (off >= sizeof(struct user))
274 return put_user(tmp, ret);
278 * Write the word at offset "off" into "struct user". We
279 * actually access the pt_regs stored on the kernel stack.
281 static int ptrace_write_user(struct task_struct *tsk, unsigned long off,
284 if (off & 3 || off >= sizeof(struct user))
287 if (off >= sizeof(struct pt_regs))
290 return put_user_reg(tsk, off >> 2, val);
296 * Get the child iWMMXt state.
298 static int ptrace_getwmmxregs(struct task_struct *tsk, void __user *ufp)
300 struct thread_info *thread = task_thread_info(tsk);
302 if (!test_ti_thread_flag(thread, TIF_USING_IWMMXT))
304 iwmmxt_task_disable(thread); /* force it to ram */
305 return copy_to_user(ufp, &thread->fpstate.iwmmxt, IWMMXT_SIZE)
310 * Set the child iWMMXt state.
312 static int ptrace_setwmmxregs(struct task_struct *tsk, void __user *ufp)
314 struct thread_info *thread = task_thread_info(tsk);
316 if (!test_ti_thread_flag(thread, TIF_USING_IWMMXT))
318 iwmmxt_task_release(thread); /* force a reload */
319 return copy_from_user(&thread->fpstate.iwmmxt, ufp, IWMMXT_SIZE)
327 * Get the child Crunch state.
329 static int ptrace_getcrunchregs(struct task_struct *tsk, void __user *ufp)
331 struct thread_info *thread = task_thread_info(tsk);
333 crunch_task_disable(thread); /* force it to ram */
334 return copy_to_user(ufp, &thread->crunchstate, CRUNCH_SIZE)
339 * Set the child Crunch state.
341 static int ptrace_setcrunchregs(struct task_struct *tsk, void __user *ufp)
343 struct thread_info *thread = task_thread_info(tsk);
345 crunch_task_release(thread); /* force a reload */
346 return copy_from_user(&thread->crunchstate, ufp, CRUNCH_SIZE)
351 #ifdef CONFIG_HAVE_HW_BREAKPOINT
353 * Convert a virtual register number into an index for a thread_info
354 * breakpoint array. Breakpoints are identified using positive numbers
355 * whilst watchpoints are negative. The registers are laid out as pairs
356 * of (address, control), each pair mapping to a unique hw_breakpoint struct.
357 * Register 0 is reserved for describing resource information.
359 static int ptrace_hbp_num_to_idx(long num)
362 num = (ARM_MAX_BRP << 1) - num;
363 return (num - 1) >> 1;
367 * Returns the virtual register number for the address of the
368 * breakpoint at index idx.
370 static long ptrace_hbp_idx_to_num(int idx)
372 long mid = ARM_MAX_BRP << 1;
373 long num = (idx << 1) + 1;
374 return num > mid ? mid - num : num;
378 * Handle hitting a HW-breakpoint.
380 static void ptrace_hbptriggered(struct perf_event *bp,
381 struct perf_sample_data *data,
382 struct pt_regs *regs)
384 struct arch_hw_breakpoint *bkpt = counter_arch_bp(bp);
388 for (i = 0; i < ARM_MAX_HBP_SLOTS; ++i)
389 if (current->thread.debug.hbp[i] == bp)
392 num = (i == ARM_MAX_HBP_SLOTS) ? 0 : ptrace_hbp_idx_to_num(i);
394 force_sig_ptrace_errno_trap((int)num, (void __user *)(bkpt->trigger));
398 * Set ptrace breakpoint pointers to zero for this task.
399 * This is required in order to prevent child processes from unregistering
400 * breakpoints held by their parent.
402 void clear_ptrace_hw_breakpoint(struct task_struct *tsk)
404 memset(tsk->thread.debug.hbp, 0, sizeof(tsk->thread.debug.hbp));
408 * Unregister breakpoints from this task and reset the pointers in
411 void flush_ptrace_hw_breakpoint(struct task_struct *tsk)
414 struct thread_struct *t = &tsk->thread;
416 for (i = 0; i < ARM_MAX_HBP_SLOTS; i++) {
417 if (t->debug.hbp[i]) {
418 unregister_hw_breakpoint(t->debug.hbp[i]);
419 t->debug.hbp[i] = NULL;
424 static u32 ptrace_get_hbp_resource_info(void)
426 u8 num_brps, num_wrps, debug_arch, wp_len;
429 num_brps = hw_breakpoint_slots(TYPE_INST);
430 num_wrps = hw_breakpoint_slots(TYPE_DATA);
431 debug_arch = arch_get_debug_arch();
432 wp_len = arch_get_max_wp_len();
445 static struct perf_event *ptrace_hbp_create(struct task_struct *tsk, int type)
447 struct perf_event_attr attr;
449 ptrace_breakpoint_init(&attr);
451 /* Initialise fields to sane defaults. */
453 attr.bp_len = HW_BREAKPOINT_LEN_4;
457 return register_user_hw_breakpoint(&attr, ptrace_hbptriggered, NULL,
461 static int ptrace_gethbpregs(struct task_struct *tsk, long num,
462 unsigned long __user *data)
466 struct perf_event *bp;
467 struct arch_hw_breakpoint_ctrl arch_ctrl;
470 reg = ptrace_get_hbp_resource_info();
472 idx = ptrace_hbp_num_to_idx(num);
473 if (idx < 0 || idx >= ARM_MAX_HBP_SLOTS) {
478 bp = tsk->thread.debug.hbp[idx];
484 arch_ctrl = counter_arch_bp(bp)->ctrl;
487 * Fix up the len because we may have adjusted it
488 * to compensate for an unaligned address.
490 while (!(arch_ctrl.len & 0x1))
494 reg = bp->attr.bp_addr;
496 reg = encode_ctrl_reg(arch_ctrl);
500 if (put_user(reg, data))
507 static int ptrace_sethbpregs(struct task_struct *tsk, long num,
508 unsigned long __user *data)
510 int idx, gen_len, gen_type, implied_type, ret = 0;
512 struct perf_event *bp;
513 struct arch_hw_breakpoint_ctrl ctrl;
514 struct perf_event_attr attr;
519 implied_type = HW_BREAKPOINT_RW;
521 implied_type = HW_BREAKPOINT_X;
523 idx = ptrace_hbp_num_to_idx(num);
524 if (idx < 0 || idx >= ARM_MAX_HBP_SLOTS) {
529 if (get_user(user_val, data)) {
534 bp = tsk->thread.debug.hbp[idx];
536 bp = ptrace_hbp_create(tsk, implied_type);
541 tsk->thread.debug.hbp[idx] = bp;
548 attr.bp_addr = user_val;
551 decode_ctrl_reg(user_val, &ctrl);
552 ret = arch_bp_generic_fields(ctrl, &gen_len, &gen_type);
556 if ((gen_type & implied_type) != gen_type) {
561 attr.bp_len = gen_len;
562 attr.bp_type = gen_type;
563 attr.disabled = !ctrl.enabled;
566 ret = modify_user_hw_breakpoint(bp, &attr);
572 /* regset get/set implementations */
574 static int gpr_get(struct task_struct *target,
575 const struct user_regset *regset,
576 unsigned int pos, unsigned int count,
577 void *kbuf, void __user *ubuf)
579 struct pt_regs *regs = task_pt_regs(target);
581 return user_regset_copyout(&pos, &count, &kbuf, &ubuf,
586 static int gpr_set(struct task_struct *target,
587 const struct user_regset *regset,
588 unsigned int pos, unsigned int count,
589 const void *kbuf, const void __user *ubuf)
592 struct pt_regs newregs = *task_pt_regs(target);
594 ret = user_regset_copyin(&pos, &count, &kbuf, &ubuf,
600 if (!valid_user_regs(&newregs))
603 *task_pt_regs(target) = newregs;
607 static int fpa_get(struct task_struct *target,
608 const struct user_regset *regset,
609 unsigned int pos, unsigned int count,
610 void *kbuf, void __user *ubuf)
612 return user_regset_copyout(&pos, &count, &kbuf, &ubuf,
613 &task_thread_info(target)->fpstate,
614 0, sizeof(struct user_fp));
617 static int fpa_set(struct task_struct *target,
618 const struct user_regset *regset,
619 unsigned int pos, unsigned int count,
620 const void *kbuf, const void __user *ubuf)
622 struct thread_info *thread = task_thread_info(target);
624 thread->used_cp[1] = thread->used_cp[2] = 1;
626 return user_regset_copyin(&pos, &count, &kbuf, &ubuf,
628 0, sizeof(struct user_fp));
633 * VFP register get/set implementations.
635 * With respect to the kernel, struct user_fp is divided into three chunks:
636 * 16 or 32 real VFP registers (d0-d15 or d0-31)
637 * These are transferred to/from the real registers in the task's
638 * vfp_hard_struct. The number of registers depends on the kernel
641 * 16 or 0 fake VFP registers (d16-d31 or empty)
642 * i.e., the user_vfp structure has space for 32 registers even if
643 * the kernel doesn't have them all.
645 * vfp_get() reads this chunk as zero where applicable
646 * vfp_set() ignores this chunk
648 * 1 word for the FPSCR
650 * The bounds-checking logic built into user_regset_copyout and friends
651 * means that we can make a simple sequence of calls to map the relevant data
652 * to/from the specified slice of the user regset structure.
654 static int vfp_get(struct task_struct *target,
655 const struct user_regset *regset,
656 unsigned int pos, unsigned int count,
657 void *kbuf, void __user *ubuf)
660 struct thread_info *thread = task_thread_info(target);
661 struct vfp_hard_struct const *vfp = &thread->vfpstate.hard;
662 const size_t user_fpregs_offset = offsetof(struct user_vfp, fpregs);
663 const size_t user_fpscr_offset = offsetof(struct user_vfp, fpscr);
665 vfp_sync_hwstate(thread);
667 ret = user_regset_copyout(&pos, &count, &kbuf, &ubuf,
670 user_fpregs_offset + sizeof(vfp->fpregs));
674 ret = user_regset_copyout_zero(&pos, &count, &kbuf, &ubuf,
675 user_fpregs_offset + sizeof(vfp->fpregs),
680 return user_regset_copyout(&pos, &count, &kbuf, &ubuf,
683 user_fpscr_offset + sizeof(vfp->fpscr));
687 * For vfp_set() a read-modify-write is done on the VFP registers,
688 * in order to avoid writing back a half-modified set of registers on
691 static int vfp_set(struct task_struct *target,
692 const struct user_regset *regset,
693 unsigned int pos, unsigned int count,
694 const void *kbuf, const void __user *ubuf)
697 struct thread_info *thread = task_thread_info(target);
698 struct vfp_hard_struct new_vfp;
699 const size_t user_fpregs_offset = offsetof(struct user_vfp, fpregs);
700 const size_t user_fpscr_offset = offsetof(struct user_vfp, fpscr);
702 vfp_sync_hwstate(thread);
703 new_vfp = thread->vfpstate.hard;
705 ret = user_regset_copyin(&pos, &count, &kbuf, &ubuf,
708 user_fpregs_offset + sizeof(new_vfp.fpregs));
712 ret = user_regset_copyin_ignore(&pos, &count, &kbuf, &ubuf,
713 user_fpregs_offset + sizeof(new_vfp.fpregs),
718 ret = user_regset_copyin(&pos, &count, &kbuf, &ubuf,
721 user_fpscr_offset + sizeof(new_vfp.fpscr));
725 thread->vfpstate.hard = new_vfp;
726 vfp_flush_hwstate(thread);
730 #endif /* CONFIG_VFP */
740 static const struct user_regset arm_regsets[] = {
742 .core_note_type = NT_PRSTATUS,
745 .align = sizeof(u32),
751 * For the FPA regs in fpstate, the real fields are a mixture
752 * of sizes, so pretend that the registers are word-sized:
754 .core_note_type = NT_PRFPREG,
755 .n = sizeof(struct user_fp) / sizeof(u32),
757 .align = sizeof(u32),
764 * Pretend that the VFP regs are word-sized, since the FPSCR is
765 * a single word dangling at the end of struct user_vfp:
767 .core_note_type = NT_ARM_VFP,
768 .n = ARM_VFPREGS_SIZE / sizeof(u32),
770 .align = sizeof(u32),
774 #endif /* CONFIG_VFP */
777 static const struct user_regset_view user_arm_view = {
778 .name = "arm", .e_machine = ELF_ARCH, .ei_osabi = ELF_OSABI,
779 .regsets = arm_regsets, .n = ARRAY_SIZE(arm_regsets)
782 const struct user_regset_view *task_user_regset_view(struct task_struct *task)
784 return &user_arm_view;
787 long arch_ptrace(struct task_struct *child, long request,
788 unsigned long addr, unsigned long data)
791 unsigned long __user *datap = (unsigned long __user *) data;
795 ret = ptrace_read_user(child, addr, datap);
799 ret = ptrace_write_user(child, addr, data);
803 ret = copy_regset_to_user(child,
804 &user_arm_view, REGSET_GPR,
805 0, sizeof(struct pt_regs),
810 ret = copy_regset_from_user(child,
811 &user_arm_view, REGSET_GPR,
812 0, sizeof(struct pt_regs),
816 case PTRACE_GETFPREGS:
817 ret = copy_regset_to_user(child,
818 &user_arm_view, REGSET_FPR,
819 0, sizeof(union fp_state),
823 case PTRACE_SETFPREGS:
824 ret = copy_regset_from_user(child,
825 &user_arm_view, REGSET_FPR,
826 0, sizeof(union fp_state),
831 case PTRACE_GETWMMXREGS:
832 ret = ptrace_getwmmxregs(child, datap);
835 case PTRACE_SETWMMXREGS:
836 ret = ptrace_setwmmxregs(child, datap);
840 case PTRACE_GET_THREAD_AREA:
841 ret = put_user(task_thread_info(child)->tp_value[0],
845 case PTRACE_SET_SYSCALL:
846 task_thread_info(child)->syscall = data;
851 case PTRACE_GETCRUNCHREGS:
852 ret = ptrace_getcrunchregs(child, datap);
855 case PTRACE_SETCRUNCHREGS:
856 ret = ptrace_setcrunchregs(child, datap);
861 case PTRACE_GETVFPREGS:
862 ret = copy_regset_to_user(child,
863 &user_arm_view, REGSET_VFP,
868 case PTRACE_SETVFPREGS:
869 ret = copy_regset_from_user(child,
870 &user_arm_view, REGSET_VFP,
876 #ifdef CONFIG_HAVE_HW_BREAKPOINT
877 case PTRACE_GETHBPREGS:
878 ret = ptrace_gethbpregs(child, addr,
879 (unsigned long __user *)data);
881 case PTRACE_SETHBPREGS:
882 ret = ptrace_sethbpregs(child, addr,
883 (unsigned long __user *)data);
888 ret = ptrace_request(child, request, addr, data);
895 enum ptrace_syscall_dir {
896 PTRACE_SYSCALL_ENTER = 0,
900 static void tracehook_report_syscall(struct pt_regs *regs,
901 enum ptrace_syscall_dir dir)
906 * IP is used to denote syscall entry/exit:
907 * IP = 0 -> entry, =1 -> exit
912 if (dir == PTRACE_SYSCALL_EXIT)
913 tracehook_report_syscall_exit(regs, 0);
914 else if (tracehook_report_syscall_entry(regs))
915 current_thread_info()->syscall = -1;
920 asmlinkage int syscall_trace_enter(struct pt_regs *regs, int scno)
922 current_thread_info()->syscall = scno;
924 if (test_thread_flag(TIF_SYSCALL_TRACE))
925 tracehook_report_syscall(regs, PTRACE_SYSCALL_ENTER);
927 /* Do seccomp after ptrace; syscall may have changed. */
928 #ifdef CONFIG_HAVE_ARCH_SECCOMP_FILTER
929 if (secure_computing(NULL) == -1)
932 /* XXX: remove this once OABI gets fixed */
933 secure_computing_strict(current_thread_info()->syscall);
936 /* Tracer or seccomp may have changed syscall. */
937 scno = current_thread_info()->syscall;
939 if (test_thread_flag(TIF_SYSCALL_TRACEPOINT))
940 trace_sys_enter(regs, scno);
942 audit_syscall_entry(scno, regs->ARM_r0, regs->ARM_r1, regs->ARM_r2,
948 asmlinkage void syscall_trace_exit(struct pt_regs *regs)
951 * Audit the syscall before anything else, as a debugger may
952 * come in and change the current registers.
954 audit_syscall_exit(regs);
957 * Note that we haven't updated the ->syscall field for the
958 * current thread. This isn't a problem because it will have
959 * been set on syscall entry and there hasn't been an opportunity
960 * for a PTRACE_SET_SYSCALL since then.
962 if (test_thread_flag(TIF_SYSCALL_TRACEPOINT))
963 trace_sys_exit(regs, regs_return_value(regs));
965 if (test_thread_flag(TIF_SYSCALL_TRACE))
966 tracehook_report_syscall(regs, PTRACE_SYSCALL_EXIT);