1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2 /* 3 * Based on arch/arm/include/asm/ptrace.h 4 * 5 * Copyright (C) 1996-2003 Russell King 6 * Copyright (C) 2012 ARM Ltd. 7 * 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. 11 * 12 * This program is distributed in the hope that it will be useful, 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * GNU General Public License for more details. 16 * 17 * You should have received a copy of the GNU General Public License 18 * along with this program. If not, see <http://www.gnu.org/licenses/>. 19 */ 20 #ifndef _UAPI__ASM_PTRACE_H 21 #define _UAPI__ASM_PTRACE_H 22 23 #include <linux/types.h> 24 25 #include <asm/hwcap.h> 26 #include <asm/sve_context.h> 27 28 29 /* 30 * PSR bits 31 */ 32 #define PSR_MODE_EL0t 0x00000000 33 #define PSR_MODE_EL1t 0x00000004 34 #define PSR_MODE_EL1h 0x00000005 35 #define PSR_MODE_EL2t 0x00000008 36 #define PSR_MODE_EL2h 0x00000009 37 #define PSR_MODE_EL3t 0x0000000c 38 #define PSR_MODE_EL3h 0x0000000d 39 #define PSR_MODE_MASK 0x0000000f 40 41 /* AArch32 CPSR bits */ 42 #define PSR_MODE32_BIT 0x00000010 43 44 /* AArch64 SPSR bits */ 45 #define PSR_F_BIT 0x00000040 46 #define PSR_I_BIT 0x00000080 47 #define PSR_A_BIT 0x00000100 48 #define PSR_D_BIT 0x00000200 49 #define PSR_SSBS_BIT 0x00001000 50 #define PSR_PAN_BIT 0x00400000 51 #define PSR_UAO_BIT 0x00800000 52 #define PSR_V_BIT 0x10000000 53 #define PSR_C_BIT 0x20000000 54 #define PSR_Z_BIT 0x40000000 55 #define PSR_N_BIT 0x80000000 56 57 /* 58 * Groups of PSR bits 59 */ 60 #define PSR_f 0xff000000 /* Flags */ 61 #define PSR_s 0x00ff0000 /* Status */ 62 #define PSR_x 0x0000ff00 /* Extension */ 63 #define PSR_c 0x000000ff /* Control */ 64 65 66 #ifndef __ASSEMBLY__ 67 68 /* 69 * User structures for general purpose, floating point and debug registers. 70 */ 71 struct user_pt_regs { 72 __u64 regs[31]; 73 __u64 sp; 74 __u64 pc; 75 __u64 pstate; 76 }; 77 78 struct user_fpsimd_state { 79 __uint128_t vregs[32]; 80 __u32 fpsr; 81 __u32 fpcr; 82 __u32 __reserved[2]; 83 }; 84 85 struct user_hwdebug_state { 86 __u32 dbg_info; 87 __u32 pad; 88 struct { 89 __u64 addr; 90 __u32 ctrl; 91 __u32 pad; 92 } dbg_regs[16]; 93 }; 94 95 /* SVE/FP/SIMD state (NT_ARM_SVE) */ 96 97 struct user_sve_header { 98 __u32 size; /* total meaningful regset content in bytes */ 99 __u32 max_size; /* maxmium possible size for this thread */ 100 __u16 vl; /* current vector length */ 101 __u16 max_vl; /* maximum possible vector length */ 102 __u16 flags; 103 __u16 __reserved; 104 }; 105 106 /* Definitions for user_sve_header.flags: */ 107 #define SVE_PT_REGS_MASK (1 << 0) 108 109 #define SVE_PT_REGS_FPSIMD 0 110 #define SVE_PT_REGS_SVE SVE_PT_REGS_MASK 111 112 /* 113 * Common SVE_PT_* flags: 114 * These must be kept in sync with prctl interface in <linux/prctl.h> 115 */ 116 #define SVE_PT_VL_INHERIT ((1 << 17) /* PR_SVE_VL_INHERIT */ >> 16) 117 #define SVE_PT_VL_ONEXEC ((1 << 18) /* PR_SVE_SET_VL_ONEXEC */ >> 16) 118 119 120 /* 121 * The remainder of the SVE state follows struct user_sve_header. The 122 * total size of the SVE state (including header) depends on the 123 * metadata in the header: SVE_PT_SIZE(vq, flags) gives the total size 124 * of the state in bytes, including the header. 125 * 126 * Refer to <asm/sigcontext.h> for details of how to pass the correct 127 * "vq" argument to these macros. 128 */ 129 130 /* Offset from the start of struct user_sve_header to the register data */ 131 #define SVE_PT_REGS_OFFSET \ 132 ((sizeof(struct user_sve_header) + (__SVE_VQ_BYTES - 1)) \ 133 / __SVE_VQ_BYTES * __SVE_VQ_BYTES) 134 135 /* 136 * The register data content and layout depends on the value of the 137 * flags field. 138 */ 139 140 /* 141 * (flags & SVE_PT_REGS_MASK) == SVE_PT_REGS_FPSIMD case: 142 * 143 * The payload starts at offset SVE_PT_FPSIMD_OFFSET, and is of type 144 * struct user_fpsimd_state. Additional data might be appended in the 145 * future: use SVE_PT_FPSIMD_SIZE(vq, flags) to compute the total size. 146 * SVE_PT_FPSIMD_SIZE(vq, flags) will never be less than 147 * sizeof(struct user_fpsimd_state). 148 */ 149 150 #define SVE_PT_FPSIMD_OFFSET SVE_PT_REGS_OFFSET 151 152 #define SVE_PT_FPSIMD_SIZE(vq, flags) (sizeof(struct user_fpsimd_state)) 153 154 /* 155 * (flags & SVE_PT_REGS_MASK) == SVE_PT_REGS_SVE case: 156 * 157 * The payload starts at offset SVE_PT_SVE_OFFSET, and is of size 158 * SVE_PT_SVE_SIZE(vq, flags). 159 * 160 * Additional macros describe the contents and layout of the payload. 161 * For each, SVE_PT_SVE_x_OFFSET(args) is the start offset relative to 162 * the start of struct user_sve_header, and SVE_PT_SVE_x_SIZE(args) is 163 * the size in bytes: 164 * 165 * x type description 166 * - ---- ----------- 167 * ZREGS \ 168 * ZREG | 169 * PREGS | refer to <asm/sigcontext.h> 170 * PREG | 171 * FFR / 172 * 173 * FPSR uint32_t FPSR 174 * FPCR uint32_t FPCR 175 * 176 * Additional data might be appended in the future. 177 * 178 * The Z-, P- and FFR registers are represented in memory in an endianness- 179 * invariant layout which differs from the layout used for the FPSIMD 180 * V-registers on big-endian systems: see sigcontext.h for more explanation. 181 */ 182 183 #define SVE_PT_SVE_ZREG_SIZE(vq) __SVE_ZREG_SIZE(vq) 184 #define SVE_PT_SVE_PREG_SIZE(vq) __SVE_PREG_SIZE(vq) 185 #define SVE_PT_SVE_FFR_SIZE(vq) __SVE_FFR_SIZE(vq) 186 #define SVE_PT_SVE_FPSR_SIZE sizeof(__u32) 187 #define SVE_PT_SVE_FPCR_SIZE sizeof(__u32) 188 189 #define SVE_PT_SVE_OFFSET SVE_PT_REGS_OFFSET 190 191 #define SVE_PT_SVE_ZREGS_OFFSET \ 192 (SVE_PT_REGS_OFFSET + __SVE_ZREGS_OFFSET) 193 #define SVE_PT_SVE_ZREG_OFFSET(vq, n) \ 194 (SVE_PT_REGS_OFFSET + __SVE_ZREG_OFFSET(vq, n)) 195 #define SVE_PT_SVE_ZREGS_SIZE(vq) \ 196 (SVE_PT_SVE_ZREG_OFFSET(vq, __SVE_NUM_ZREGS) - SVE_PT_SVE_ZREGS_OFFSET) 197 198 #define SVE_PT_SVE_PREGS_OFFSET(vq) \ 199 (SVE_PT_REGS_OFFSET + __SVE_PREGS_OFFSET(vq)) 200 #define SVE_PT_SVE_PREG_OFFSET(vq, n) \ 201 (SVE_PT_REGS_OFFSET + __SVE_PREG_OFFSET(vq, n)) 202 #define SVE_PT_SVE_PREGS_SIZE(vq) \ 203 (SVE_PT_SVE_PREG_OFFSET(vq, __SVE_NUM_PREGS) - \ 204 SVE_PT_SVE_PREGS_OFFSET(vq)) 205 206 #define SVE_PT_SVE_FFR_OFFSET(vq) \ 207 (SVE_PT_REGS_OFFSET + __SVE_FFR_OFFSET(vq)) 208 209 #define SVE_PT_SVE_FPSR_OFFSET(vq) \ 210 ((SVE_PT_SVE_FFR_OFFSET(vq) + SVE_PT_SVE_FFR_SIZE(vq) + \ 211 (__SVE_VQ_BYTES - 1)) \ 212 / __SVE_VQ_BYTES * __SVE_VQ_BYTES) 213 #define SVE_PT_SVE_FPCR_OFFSET(vq) \ 214 (SVE_PT_SVE_FPSR_OFFSET(vq) + SVE_PT_SVE_FPSR_SIZE) 215 216 /* 217 * Any future extension appended after FPCR must be aligned to the next 218 * 128-bit boundary. 219 */ 220 221 #define SVE_PT_SVE_SIZE(vq, flags) \ 222 ((SVE_PT_SVE_FPCR_OFFSET(vq) + SVE_PT_SVE_FPCR_SIZE \ 223 - SVE_PT_SVE_OFFSET + (__SVE_VQ_BYTES - 1)) \ 224 / __SVE_VQ_BYTES * __SVE_VQ_BYTES) 225 226 #define SVE_PT_SIZE(vq, flags) \ 227 (((flags) & SVE_PT_REGS_MASK) == SVE_PT_REGS_SVE ? \ 228 SVE_PT_SVE_OFFSET + SVE_PT_SVE_SIZE(vq, flags) \ 229 : SVE_PT_FPSIMD_OFFSET + SVE_PT_FPSIMD_SIZE(vq, flags)) 230 231 /* pointer authentication masks (NT_ARM_PAC_MASK) */ 232 233 struct user_pac_mask { 234 __u64 data_mask; 235 __u64 insn_mask; 236 }; 237 238 /* pointer authentication keys (NT_ARM_PACA_KEYS, NT_ARM_PACG_KEYS) */ 239 240 struct user_pac_address_keys { 241 __uint128_t apiakey; 242 __uint128_t apibkey; 243 __uint128_t apdakey; 244 __uint128_t apdbkey; 245 }; 246 247 struct user_pac_generic_keys { 248 __uint128_t apgakey; 249 }; 250 251 #endif /* __ASSEMBLY__ */ 252 253 #endif /* _UAPI__ASM_PTRACE_H */ 254