xref: /linux/arch/arm64/include/asm/ptrace.h (revision 0a8ea52c3eb157dd65e224fc95b7c9c99fcba9f7)
1 /*
2  * Based on arch/arm/include/asm/ptrace.h
3  *
4  * Copyright (C) 1996-2003 Russell King
5  * Copyright (C) 2012 ARM Ltd.
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19 #ifndef __ASM_PTRACE_H
20 #define __ASM_PTRACE_H
21 
22 #include <uapi/asm/ptrace.h>
23 
24 /* Current Exception Level values, as contained in CurrentEL */
25 #define CurrentEL_EL1		(1 << 2)
26 #define CurrentEL_EL2		(2 << 2)
27 
28 /* AArch32-specific ptrace requests */
29 #define COMPAT_PTRACE_GETREGS		12
30 #define COMPAT_PTRACE_SETREGS		13
31 #define COMPAT_PTRACE_GET_THREAD_AREA	22
32 #define COMPAT_PTRACE_SET_SYSCALL	23
33 #define COMPAT_PTRACE_GETVFPREGS	27
34 #define COMPAT_PTRACE_SETVFPREGS	28
35 #define COMPAT_PTRACE_GETHBPREGS	29
36 #define COMPAT_PTRACE_SETHBPREGS	30
37 
38 /* AArch32 CPSR bits */
39 #define COMPAT_PSR_MODE_MASK	0x0000001f
40 #define COMPAT_PSR_MODE_USR	0x00000010
41 #define COMPAT_PSR_MODE_FIQ	0x00000011
42 #define COMPAT_PSR_MODE_IRQ	0x00000012
43 #define COMPAT_PSR_MODE_SVC	0x00000013
44 #define COMPAT_PSR_MODE_ABT	0x00000017
45 #define COMPAT_PSR_MODE_HYP	0x0000001a
46 #define COMPAT_PSR_MODE_UND	0x0000001b
47 #define COMPAT_PSR_MODE_SYS	0x0000001f
48 #define COMPAT_PSR_T_BIT	0x00000020
49 #define COMPAT_PSR_E_BIT	0x00000200
50 #define COMPAT_PSR_F_BIT	0x00000040
51 #define COMPAT_PSR_I_BIT	0x00000080
52 #define COMPAT_PSR_A_BIT	0x00000100
53 #define COMPAT_PSR_E_BIT	0x00000200
54 #define COMPAT_PSR_J_BIT	0x01000000
55 #define COMPAT_PSR_Q_BIT	0x08000000
56 #define COMPAT_PSR_V_BIT	0x10000000
57 #define COMPAT_PSR_C_BIT	0x20000000
58 #define COMPAT_PSR_Z_BIT	0x40000000
59 #define COMPAT_PSR_N_BIT	0x80000000
60 #define COMPAT_PSR_IT_MASK	0x0600fc00	/* If-Then execution state mask */
61 #define COMPAT_PSR_GE_MASK	0x000f0000
62 
63 #ifdef CONFIG_CPU_BIG_ENDIAN
64 #define COMPAT_PSR_ENDSTATE	COMPAT_PSR_E_BIT
65 #else
66 #define COMPAT_PSR_ENDSTATE	0
67 #endif
68 
69 /*
70  * These are 'magic' values for PTRACE_PEEKUSR that return info about where a
71  * process is located in memory.
72  */
73 #define COMPAT_PT_TEXT_ADDR		0x10000
74 #define COMPAT_PT_DATA_ADDR		0x10004
75 #define COMPAT_PT_TEXT_END_ADDR		0x10008
76 #ifndef __ASSEMBLY__
77 #include <linux/bug.h>
78 
79 /* sizeof(struct user) for AArch32 */
80 #define COMPAT_USER_SZ	296
81 
82 /* Architecturally defined mapping between AArch32 and AArch64 registers */
83 #define compat_usr(x)	regs[(x)]
84 #define compat_fp	regs[11]
85 #define compat_sp	regs[13]
86 #define compat_lr	regs[14]
87 #define compat_sp_hyp	regs[15]
88 #define compat_lr_irq	regs[16]
89 #define compat_sp_irq	regs[17]
90 #define compat_lr_svc	regs[18]
91 #define compat_sp_svc	regs[19]
92 #define compat_lr_abt	regs[20]
93 #define compat_sp_abt	regs[21]
94 #define compat_lr_und	regs[22]
95 #define compat_sp_und	regs[23]
96 #define compat_r8_fiq	regs[24]
97 #define compat_r9_fiq	regs[25]
98 #define compat_r10_fiq	regs[26]
99 #define compat_r11_fiq	regs[27]
100 #define compat_r12_fiq	regs[28]
101 #define compat_sp_fiq	regs[29]
102 #define compat_lr_fiq	regs[30]
103 
104 /*
105  * This struct defines the way the registers are stored on the stack during an
106  * exception. Note that sizeof(struct pt_regs) has to be a multiple of 16 (for
107  * stack alignment). struct user_pt_regs must form a prefix of struct pt_regs.
108  */
109 struct pt_regs {
110 	union {
111 		struct user_pt_regs user_regs;
112 		struct {
113 			u64 regs[31];
114 			u64 sp;
115 			u64 pc;
116 			u64 pstate;
117 		};
118 	};
119 	u64 orig_x0;
120 	u64 syscallno;
121 };
122 
123 #define MAX_REG_OFFSET offsetof(struct pt_regs, pstate)
124 
125 #define arch_has_single_step()	(1)
126 
127 #ifdef CONFIG_COMPAT
128 #define compat_thumb_mode(regs) \
129 	(((regs)->pstate & COMPAT_PSR_T_BIT))
130 #else
131 #define compat_thumb_mode(regs) (0)
132 #endif
133 
134 #define user_mode(regs)	\
135 	(((regs)->pstate & PSR_MODE_MASK) == PSR_MODE_EL0t)
136 
137 #define compat_user_mode(regs)	\
138 	(((regs)->pstate & (PSR_MODE32_BIT | PSR_MODE_MASK)) == \
139 	 (PSR_MODE32_BIT | PSR_MODE_EL0t))
140 
141 #define processor_mode(regs) \
142 	((regs)->pstate & PSR_MODE_MASK)
143 
144 #define interrupts_enabled(regs) \
145 	(!((regs)->pstate & PSR_I_BIT))
146 
147 #define fast_interrupts_enabled(regs) \
148 	(!((regs)->pstate & PSR_F_BIT))
149 
150 #define user_stack_pointer(regs) \
151 	(!compat_user_mode(regs) ? (regs)->sp : (regs)->compat_sp)
152 
153 extern int regs_query_register_offset(const char *name);
154 extern const char *regs_query_register_name(unsigned int offset);
155 extern unsigned long regs_get_kernel_stack_nth(struct pt_regs *regs,
156 					       unsigned int n);
157 
158 /**
159  * regs_get_register() - get register value from its offset
160  * @regs:	pt_regs from which register value is gotten
161  * @offset:	offset of the register.
162  *
163  * regs_get_register returns the value of a register whose offset from @regs.
164  * The @offset is the offset of the register in struct pt_regs.
165  * If @offset is bigger than MAX_REG_OFFSET, this returns 0.
166  */
167 static inline u64 regs_get_register(struct pt_regs *regs, unsigned int offset)
168 {
169 	u64 val = 0;
170 
171 	WARN_ON(offset & 7);
172 
173 	offset >>= 3;
174 	switch (offset) {
175 	case 0 ... 30:
176 		val = regs->regs[offset];
177 		break;
178 	case offsetof(struct pt_regs, sp) >> 3:
179 		val = regs->sp;
180 		break;
181 	case offsetof(struct pt_regs, pc) >> 3:
182 		val = regs->pc;
183 		break;
184 	case offsetof(struct pt_regs, pstate) >> 3:
185 		val = regs->pstate;
186 		break;
187 	default:
188 		val = 0;
189 	}
190 
191 	return val;
192 }
193 
194 /* Valid only for Kernel mode traps. */
195 static inline unsigned long kernel_stack_pointer(struct pt_regs *regs)
196 {
197 	return regs->sp;
198 }
199 
200 static inline unsigned long regs_return_value(struct pt_regs *regs)
201 {
202 	return regs->regs[0];
203 }
204 
205 /* We must avoid circular header include via sched.h */
206 struct task_struct;
207 int valid_user_regs(struct user_pt_regs *regs, struct task_struct *task);
208 
209 #define instruction_pointer(regs)	((unsigned long)(regs)->pc)
210 
211 extern unsigned long profile_pc(struct pt_regs *regs);
212 
213 #endif /* __ASSEMBLY__ */
214 #endif
215