xref: /linux/arch/powerpc/include/asm/ptrace.h (revision 0c874100108f03401cb3154801d2671bbad40ad4)
1 /*
2  * Copyright (C) 2001 PPC64 Team, IBM Corp
3  *
4  * This struct defines the way the registers are stored on the
5  * kernel stack during a system call or other kernel entry.
6  *
7  * this should only contain volatile regs
8  * since we can keep non-volatile in the thread_struct
9  * should set this up when only volatiles are saved
10  * by intr code.
11  *
12  * Since this is going on the stack, *CARE MUST BE TAKEN* to insure
13  * that the overall structure is a multiple of 16 bytes in length.
14  *
15  * Note that the offsets of the fields in this struct correspond with
16  * the PT_* values below.  This simplifies arch/powerpc/kernel/ptrace.c.
17  *
18  * This program is free software; you can redistribute it and/or
19  * modify it under the terms of the GNU General Public License
20  * as published by the Free Software Foundation; either version
21  * 2 of the License, or (at your option) any later version.
22  */
23 #ifndef _ASM_POWERPC_PTRACE_H
24 #define _ASM_POWERPC_PTRACE_H
25 
26 #include <uapi/asm/ptrace.h>
27 #include <asm/asm-const.h>
28 
29 #ifndef __ASSEMBLY__
30 struct pt_regs
31 {
32 	union {
33 		struct user_pt_regs user_regs;
34 		struct {
35 			unsigned long gpr[32];
36 			unsigned long nip;
37 			unsigned long msr;
38 			unsigned long orig_gpr3;
39 			unsigned long ctr;
40 			unsigned long link;
41 			unsigned long xer;
42 			unsigned long ccr;
43 #ifdef CONFIG_PPC64
44 			unsigned long softe;
45 #else
46 			unsigned long mq;
47 #endif
48 			unsigned long trap;
49 			unsigned long dar;
50 			unsigned long dsisr;
51 			unsigned long result;
52 		};
53 	};
54 
55 #ifdef CONFIG_PPC64
56 	unsigned long ppr;
57 #endif
58 };
59 #endif
60 
61 #ifdef __powerpc64__
62 
63 /*
64  * Size of redzone that userspace is allowed to use below the stack
65  * pointer.  This is 288 in the 64-bit big-endian ELF ABI, and 512 in
66  * the new ELFv2 little-endian ABI, so we allow the larger amount.
67  *
68  * For kernel code we allow a 288-byte redzone, in order to conserve
69  * kernel stack space; gcc currently only uses 288 bytes, and will
70  * hopefully allow explicit control of the redzone size in future.
71  */
72 #define USER_REDZONE_SIZE	512
73 #define KERNEL_REDZONE_SIZE	288
74 
75 #define STACK_FRAME_OVERHEAD	112	/* size of minimum stack frame */
76 #define STACK_FRAME_LR_SAVE	2	/* Location of LR in stack frame */
77 #define STACK_FRAME_REGS_MARKER	ASM_CONST(0x7265677368657265)
78 #define STACK_INT_FRAME_SIZE	(sizeof(struct pt_regs) + \
79 				 STACK_FRAME_OVERHEAD + KERNEL_REDZONE_SIZE)
80 #define STACK_FRAME_MARKER	12
81 
82 #ifdef PPC64_ELF_ABI_v2
83 #define STACK_FRAME_MIN_SIZE	32
84 #else
85 #define STACK_FRAME_MIN_SIZE	STACK_FRAME_OVERHEAD
86 #endif
87 
88 /* Size of dummy stack frame allocated when calling signal handler. */
89 #define __SIGNAL_FRAMESIZE	128
90 #define __SIGNAL_FRAMESIZE32	64
91 
92 #else /* __powerpc64__ */
93 
94 #define USER_REDZONE_SIZE	0
95 #define KERNEL_REDZONE_SIZE	0
96 #define STACK_FRAME_OVERHEAD	16	/* size of minimum stack frame */
97 #define STACK_FRAME_LR_SAVE	1	/* Location of LR in stack frame */
98 #define STACK_FRAME_REGS_MARKER	ASM_CONST(0x72656773)
99 #define STACK_INT_FRAME_SIZE	(sizeof(struct pt_regs) + STACK_FRAME_OVERHEAD)
100 #define STACK_FRAME_MARKER	2
101 #define STACK_FRAME_MIN_SIZE	STACK_FRAME_OVERHEAD
102 
103 /* Size of stack frame allocated when calling signal handler. */
104 #define __SIGNAL_FRAMESIZE	64
105 
106 #endif /* __powerpc64__ */
107 
108 #ifndef __ASSEMBLY__
109 
110 #define GET_IP(regs)		((regs)->nip)
111 #define GET_USP(regs)		((regs)->gpr[1])
112 #define GET_FP(regs)		(0)
113 #define SET_FP(regs, val)
114 
115 #ifdef CONFIG_SMP
116 extern unsigned long profile_pc(struct pt_regs *regs);
117 #define profile_pc profile_pc
118 #endif
119 
120 #include <asm-generic/ptrace.h>
121 
122 #define kernel_stack_pointer(regs) ((regs)->gpr[1])
123 static inline int is_syscall_success(struct pt_regs *regs)
124 {
125 	return !(regs->ccr & 0x10000000);
126 }
127 
128 static inline long regs_return_value(struct pt_regs *regs)
129 {
130 	if (is_syscall_success(regs))
131 		return regs->gpr[3];
132 	else
133 		return -regs->gpr[3];
134 }
135 
136 static inline void regs_set_return_value(struct pt_regs *regs, unsigned long rc)
137 {
138 	regs->gpr[3] = rc;
139 }
140 
141 #ifdef __powerpc64__
142 #define user_mode(regs) ((((regs)->msr) >> MSR_PR_LG) & 0x1)
143 #else
144 #define user_mode(regs) (((regs)->msr & MSR_PR) != 0)
145 #endif
146 
147 #define force_successful_syscall_return()   \
148 	do { \
149 		set_thread_flag(TIF_NOERROR); \
150 	} while(0)
151 
152 struct task_struct;
153 extern int ptrace_get_reg(struct task_struct *task, int regno,
154 			  unsigned long *data);
155 extern int ptrace_put_reg(struct task_struct *task, int regno,
156 			  unsigned long data);
157 
158 #define current_pt_regs() \
159 	((struct pt_regs *)((unsigned long)current_thread_info() + THREAD_SIZE) - 1)
160 /*
161  * We use the least-significant bit of the trap field to indicate
162  * whether we have saved the full set of registers, or only a
163  * partial set.  A 1 there means the partial set.
164  * On 4xx we use the next bit to indicate whether the exception
165  * is a critical exception (1 means it is).
166  */
167 #define FULL_REGS(regs)		(((regs)->trap & 1) == 0)
168 #ifndef __powerpc64__
169 #define IS_CRITICAL_EXC(regs)	(((regs)->trap & 2) != 0)
170 #define IS_MCHECK_EXC(regs)	(((regs)->trap & 4) != 0)
171 #define IS_DEBUG_EXC(regs)	(((regs)->trap & 8) != 0)
172 #endif /* ! __powerpc64__ */
173 #define TRAP(regs)		((regs)->trap & ~0xF)
174 #ifdef __powerpc64__
175 #define NV_REG_POISON		0xdeadbeefdeadbeefUL
176 #define CHECK_FULL_REGS(regs)	BUG_ON(regs->trap & 1)
177 #else
178 #define NV_REG_POISON		0xdeadbeef
179 #define CHECK_FULL_REGS(regs)						      \
180 do {									      \
181 	if ((regs)->trap & 1)						      \
182 		printk(KERN_CRIT "%s: partial register set\n", __func__); \
183 } while (0)
184 #endif /* __powerpc64__ */
185 
186 #define arch_has_single_step()	(1)
187 #define arch_has_block_step()	(!cpu_has_feature(CPU_FTR_601))
188 #define ARCH_HAS_USER_SINGLE_STEP_REPORT
189 
190 /*
191  * kprobe-based event tracer support
192  */
193 
194 #include <linux/stddef.h>
195 #include <linux/thread_info.h>
196 extern int regs_query_register_offset(const char *name);
197 extern const char *regs_query_register_name(unsigned int offset);
198 #define MAX_REG_OFFSET (offsetof(struct pt_regs, dsisr))
199 
200 /**
201  * regs_get_register() - get register value from its offset
202  * @regs:	   pt_regs from which register value is gotten
203  * @offset:    offset number of the register.
204  *
205  * regs_get_register returns the value of a register whose offset from @regs.
206  * The @offset is the offset of the register in struct pt_regs.
207  * If @offset is bigger than MAX_REG_OFFSET, this returns 0.
208  */
209 static inline unsigned long regs_get_register(struct pt_regs *regs,
210 						unsigned int offset)
211 {
212 	if (unlikely(offset > MAX_REG_OFFSET))
213 		return 0;
214 	return *(unsigned long *)((unsigned long)regs + offset);
215 }
216 
217 /**
218  * regs_within_kernel_stack() - check the address in the stack
219  * @regs:      pt_regs which contains kernel stack pointer.
220  * @addr:      address which is checked.
221  *
222  * regs_within_kernel_stack() checks @addr is within the kernel stack page(s).
223  * If @addr is within the kernel stack, it returns true. If not, returns false.
224  */
225 
226 static inline bool regs_within_kernel_stack(struct pt_regs *regs,
227 						unsigned long addr)
228 {
229 	return ((addr & ~(THREAD_SIZE - 1))  ==
230 		(kernel_stack_pointer(regs) & ~(THREAD_SIZE - 1)));
231 }
232 
233 /**
234  * regs_get_kernel_stack_nth() - get Nth entry of the stack
235  * @regs:	pt_regs which contains kernel stack pointer.
236  * @n:		stack entry number.
237  *
238  * regs_get_kernel_stack_nth() returns @n th entry of the kernel stack which
239  * is specified by @regs. If the @n th entry is NOT in the kernel stack,
240  * this returns 0.
241  */
242 static inline unsigned long regs_get_kernel_stack_nth(struct pt_regs *regs,
243 						      unsigned int n)
244 {
245 	unsigned long *addr = (unsigned long *)kernel_stack_pointer(regs);
246 	addr += n;
247 	if (regs_within_kernel_stack(regs, (unsigned long)addr))
248 		return *addr;
249 	else
250 		return 0;
251 }
252 
253 #endif /* __ASSEMBLY__ */
254 
255 #ifndef __powerpc64__
256 #else /* __powerpc64__ */
257 #define PT_FPSCR32 (PT_FPR0 + 2*32 + 1)	/* each FP reg occupies 2 32-bit userspace slots */
258 #define PT_VR0_32 164	/* each Vector reg occupies 4 slots in 32-bit */
259 #define PT_VSCR_32 (PT_VR0 + 32*4 + 3)
260 #define PT_VRSAVE_32 (PT_VR0 + 33*4)
261 #define PT_VSR0_32 300 	/* each VSR reg occupies 4 slots in 32-bit */
262 #endif /* __powerpc64__ */
263 #endif /* _ASM_POWERPC_PTRACE_H */
264