arm64: Add regs_return_value() in syscall.h
[cascardo/linux.git] / arch / arm64 / include / asm / ptrace.h
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 /* AArch32-specific ptrace requests */
25 #define COMPAT_PTRACE_GETREGS           12
26 #define COMPAT_PTRACE_SETREGS           13
27 #define COMPAT_PTRACE_GET_THREAD_AREA   22
28 #define COMPAT_PTRACE_SET_SYSCALL       23
29 #define COMPAT_PTRACE_GETVFPREGS        27
30 #define COMPAT_PTRACE_SETVFPREGS        28
31 #define COMPAT_PTRACE_GETHBPREGS        29
32 #define COMPAT_PTRACE_SETHBPREGS        30
33
34 /* AArch32 CPSR bits */
35 #define COMPAT_PSR_MODE_MASK    0x0000001f
36 #define COMPAT_PSR_MODE_USR     0x00000010
37 #define COMPAT_PSR_MODE_FIQ     0x00000011
38 #define COMPAT_PSR_MODE_IRQ     0x00000012
39 #define COMPAT_PSR_MODE_SVC     0x00000013
40 #define COMPAT_PSR_MODE_ABT     0x00000017
41 #define COMPAT_PSR_MODE_HYP     0x0000001a
42 #define COMPAT_PSR_MODE_UND     0x0000001b
43 #define COMPAT_PSR_MODE_SYS     0x0000001f
44 #define COMPAT_PSR_T_BIT        0x00000020
45 #define COMPAT_PSR_E_BIT        0x00000200
46 #define COMPAT_PSR_F_BIT        0x00000040
47 #define COMPAT_PSR_I_BIT        0x00000080
48 #define COMPAT_PSR_A_BIT        0x00000100
49 #define COMPAT_PSR_E_BIT        0x00000200
50 #define COMPAT_PSR_J_BIT        0x01000000
51 #define COMPAT_PSR_Q_BIT        0x08000000
52 #define COMPAT_PSR_V_BIT        0x10000000
53 #define COMPAT_PSR_C_BIT        0x20000000
54 #define COMPAT_PSR_Z_BIT        0x40000000
55 #define COMPAT_PSR_N_BIT        0x80000000
56 #define COMPAT_PSR_IT_MASK      0x0600fc00      /* If-Then execution state mask */
57 /*
58  * These are 'magic' values for PTRACE_PEEKUSR that return info about where a
59  * process is located in memory.
60  */
61 #define COMPAT_PT_TEXT_ADDR             0x10000
62 #define COMPAT_PT_DATA_ADDR             0x10004
63 #define COMPAT_PT_TEXT_END_ADDR         0x10008
64 #ifndef __ASSEMBLY__
65
66 /* sizeof(struct user) for AArch32 */
67 #define COMPAT_USER_SZ  296
68
69 /* Architecturally defined mapping between AArch32 and AArch64 registers */
70 #define compat_usr(x)   regs[(x)]
71 #define compat_fp       regs[11]
72 #define compat_sp       regs[13]
73 #define compat_lr       regs[14]
74 #define compat_sp_hyp   regs[15]
75 #define compat_sp_irq   regs[16]
76 #define compat_lr_irq   regs[17]
77 #define compat_sp_svc   regs[18]
78 #define compat_lr_svc   regs[19]
79 #define compat_sp_abt   regs[20]
80 #define compat_lr_abt   regs[21]
81 #define compat_sp_und   regs[22]
82 #define compat_lr_und   regs[23]
83 #define compat_r8_fiq   regs[24]
84 #define compat_r9_fiq   regs[25]
85 #define compat_r10_fiq  regs[26]
86 #define compat_r11_fiq  regs[27]
87 #define compat_r12_fiq  regs[28]
88 #define compat_sp_fiq   regs[29]
89 #define compat_lr_fiq   regs[30]
90
91 /*
92  * This struct defines the way the registers are stored on the stack during an
93  * exception. Note that sizeof(struct pt_regs) has to be a multiple of 16 (for
94  * stack alignment). struct user_pt_regs must form a prefix of struct pt_regs.
95  */
96 struct pt_regs {
97         union {
98                 struct user_pt_regs user_regs;
99                 struct {
100                         u64 regs[31];
101                         u64 sp;
102                         u64 pc;
103                         u64 pstate;
104                 };
105         };
106         u64 orig_x0;
107         u64 syscallno;
108 };
109
110 #define arch_has_single_step()  (1)
111
112 #ifdef CONFIG_COMPAT
113 #define compat_thumb_mode(regs) \
114         (((regs)->pstate & COMPAT_PSR_T_BIT))
115 #else
116 #define compat_thumb_mode(regs) (0)
117 #endif
118
119 #define user_mode(regs) \
120         (((regs)->pstate & PSR_MODE_MASK) == PSR_MODE_EL0t)
121
122 #define compat_user_mode(regs)  \
123         (((regs)->pstate & (PSR_MODE32_BIT | PSR_MODE_MASK)) == \
124          (PSR_MODE32_BIT | PSR_MODE_EL0t))
125
126 #define processor_mode(regs) \
127         ((regs)->pstate & PSR_MODE_MASK)
128
129 #define interrupts_enabled(regs) \
130         (!((regs)->pstate & PSR_I_BIT))
131
132 #define fast_interrupts_enabled(regs) \
133         (!((regs)->pstate & PSR_F_BIT))
134
135 #define user_stack_pointer(regs) \
136         (!compat_user_mode(regs)) ? ((regs)->sp) : ((regs)->compat_sp)
137
138 static inline unsigned long regs_return_value(struct pt_regs *regs)
139 {
140         return regs->regs[0];
141 }
142
143 /*
144  * Are the current registers suitable for user mode? (used to maintain
145  * security in signal handlers)
146  */
147 static inline int valid_user_regs(struct user_pt_regs *regs)
148 {
149         if (user_mode(regs) && (regs->pstate & PSR_I_BIT) == 0) {
150                 regs->pstate &= ~(PSR_F_BIT | PSR_A_BIT);
151
152                 /* The T bit is reserved for AArch64 */
153                 if (!(regs->pstate & PSR_MODE32_BIT))
154                         regs->pstate &= ~COMPAT_PSR_T_BIT;
155
156                 return 1;
157         }
158
159         /*
160          * Force PSR to something logical...
161          */
162         regs->pstate &= PSR_f | PSR_s | (PSR_x & ~PSR_A_BIT) | \
163                         COMPAT_PSR_T_BIT | PSR_MODE32_BIT;
164
165         if (!(regs->pstate & PSR_MODE32_BIT)) {
166                 regs->pstate &= ~COMPAT_PSR_T_BIT;
167                 regs->pstate |= PSR_MODE_EL0t;
168         }
169
170         return 0;
171 }
172
173 #define instruction_pointer(regs)       ((unsigned long)(regs)->pc)
174
175 #ifdef CONFIG_SMP
176 extern unsigned long profile_pc(struct pt_regs *regs);
177 #else
178 #define profile_pc(regs) instruction_pointer(regs)
179 #endif
180
181 #endif /* __ASSEMBLY__ */
182 #endif