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 /* 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 /* SPSR_ELx bits for exceptions taken from AArch32 */
  39 #define PSR_AA32_MODE_MASK      0x0000001f
  40 #define PSR_AA32_MODE_USR       0x00000010
  41 #define PSR_AA32_MODE_FIQ       0x00000011
  42 #define PSR_AA32_MODE_IRQ       0x00000012
  43 #define PSR_AA32_MODE_SVC       0x00000013
  44 #define PSR_AA32_MODE_ABT       0x00000017
  45 #define PSR_AA32_MODE_HYP       0x0000001a
  46 #define PSR_AA32_MODE_UND       0x0000001b
  47 #define PSR_AA32_MODE_SYS       0x0000001f
  48 #define PSR_AA32_T_BIT          0x00000020
  49 #define PSR_AA32_F_BIT          0x00000040
  50 #define PSR_AA32_I_BIT          0x00000080
  51 #define PSR_AA32_A_BIT          0x00000100
  52 #define PSR_AA32_E_BIT          0x00000200
  53 #define PSR_AA32_PAN_BIT        0x00400000
  54 #define PSR_AA32_SSBS_BIT       0x00800000
  55 #define PSR_AA32_DIT_BIT        0x01000000
  56 #define PSR_AA32_Q_BIT          0x08000000
  57 #define PSR_AA32_V_BIT          0x10000000
  58 #define PSR_AA32_C_BIT          0x20000000
  59 #define PSR_AA32_Z_BIT          0x40000000
  60 #define PSR_AA32_N_BIT          0x80000000
  61 #define PSR_AA32_IT_MASK        0x0600fc00      /* If-Then execution state mask */
  62 #define PSR_AA32_GE_MASK        0x000f0000
  63
  64 #ifdef CONFIG_CPU_BIG_ENDIAN
  65 #define PSR_AA32_ENDSTATE       PSR_AA32_E_BIT
  66 #else
  67 #define PSR_AA32_ENDSTATE       0
  68 #endif
  69
  70 /* AArch32 CPSR bits, as seen in AArch32 */
  71 #define COMPAT_PSR_DIT_BIT      0x00200000
  72
  73 /*
  74  * These are 'magic' values for PTRACE_PEEKUSR that return info about where a
  75  * process is located in memory.
  76  */
  77 #define COMPAT_PT_TEXT_ADDR             0x10000
  78 #define COMPAT_PT_DATA_ADDR             0x10004
  79 #define COMPAT_PT_TEXT_END_ADDR         0x10008
  80
  81 /*
  82  * If pt_regs.syscallno == NO_SYSCALL, then the thread is not executing
  83  * a syscall -- i.e., its most recent entry into the kernel from
  84  * userspace was not via SVC, or otherwise a tracer cancelled the syscall.
  85  *
  86  * This must have the value -1, for ABI compatibility with ptrace etc.
  87  */
  88 #define NO_SYSCALL (-1)
  89
  90 #ifndef __ASSEMBLY__
  91 #include <linux/bug.h>
  92 #include <linux/types.h>
  93
  94 /* sizeof(struct user) for AArch32 */
  95 #define COMPAT_USER_SZ  296
  96
  97 /* Architecturally defined mapping between AArch32 and AArch64 registers */
  98 #define compat_usr(x)   regs[(x)]
  99 #define compat_fp       regs[11]
 100 #define compat_sp       regs[13]
 101 #define compat_lr       regs[14]
 102 #define compat_sp_hyp   regs[15]
 103 #define compat_lr_irq   regs[16]
 104 #define compat_sp_irq   regs[17]
 105 #define compat_lr_svc   regs[18]
 106 #define compat_sp_svc   regs[19]
 107 #define compat_lr_abt   regs[20]
 108 #define compat_sp_abt   regs[21]
 109 #define compat_lr_und   regs[22]
 110 #define compat_sp_und   regs[23]
 111 #define compat_r8_fiq   regs[24]
 112 #define compat_r9_fiq   regs[25]
 113 #define compat_r10_fiq  regs[26]
 114 #define compat_r11_fiq  regs[27]
 115 #define compat_r12_fiq  regs[28]
 116 #define compat_sp_fiq   regs[29]
 117 #define compat_lr_fiq   regs[30]
 118
 119 static inline unsigned long compat_psr_to_pstate(const unsigned long psr)
 120 {
 121         unsigned long pstate;
 122
 123         pstate = psr & ~COMPAT_PSR_DIT_BIT;
 124
 125         if (psr & COMPAT_PSR_DIT_BIT)
 126                 pstate |= PSR_AA32_DIT_BIT;
 127
 128         return pstate;
 129 }
 130
 131 static inline unsigned long pstate_to_compat_psr(const unsigned long pstate)
 132 {
 133         unsigned long psr;
 134
 135         psr = pstate & ~PSR_AA32_DIT_BIT;
 136
 137         if (pstate & PSR_AA32_DIT_BIT)
 138                 psr |= COMPAT_PSR_DIT_BIT;
 139
 140         return psr;
 141 }
 142
 143 /*
 144  * This struct defines the way the registers are stored on the stack during an
 145  * exception. Note that sizeof(struct pt_regs) has to be a multiple of 16 (for
 146  * stack alignment). struct user_pt_regs must form a prefix of struct pt_regs.
 147  */
 148 struct pt_regs {
 149         union {
 150                 struct user_pt_regs user_regs;
 151                 struct {
 152                         u64 regs[31];
 153                         u64 sp;
 154                         u64 pc;
 155                         u64 pstate;
 156                 };
 157         };
 158         u64 orig_x0;
 159 #ifdef __AARCH64EB__
 160         u32 unused2;
 161         s32 syscallno;
 162 #else
 163         s32 syscallno;
 164         u32 unused2;
 165 #endif
 166
 167         u64 orig_addr_limit;
 168         u64 unused;     // maintain 16 byte alignment
 169         u64 stackframe[2];
 170 };
 171
 172 static inline bool in_syscall(struct pt_regs const *regs)
 173 {
 174         return regs->syscallno != NO_SYSCALL;
 175 }
 176
 177 static inline void forget_syscall(struct pt_regs *regs)
 178 {
 179         regs->syscallno = NO_SYSCALL;
 180 }
 181
 182 #define MAX_REG_OFFSET offsetof(struct pt_regs, pstate)
 183
 184 #define arch_has_single_step()  (1)
 185
 186 #ifdef CONFIG_COMPAT
 187 #define compat_thumb_mode(regs) \
 188         (((regs)->pstate & PSR_AA32_T_BIT))
 189 #else
 190 #define compat_thumb_mode(regs) (0)
 191 #endif
 192
 193 #define user_mode(regs) \
 194         (((regs)->pstate & PSR_MODE_MASK) == PSR_MODE_EL0t)
 195
 196 #define compat_user_mode(regs)  \
 197         (((regs)->pstate & (PSR_MODE32_BIT | PSR_MODE_MASK)) == \
 198          (PSR_MODE32_BIT | PSR_MODE_EL0t))
 199
 200 #define processor_mode(regs) \
 201         ((regs)->pstate & PSR_MODE_MASK)
 202
 203 #define interrupts_enabled(regs) \
 204         (!((regs)->pstate & PSR_I_BIT))
 205
 206 #define fast_interrupts_enabled(regs) \
 207         (!((regs)->pstate & PSR_F_BIT))
 208
 209 #define GET_USP(regs) \
 210         (!compat_user_mode(regs) ? (regs)->sp : (regs)->compat_sp)
 211
 212 #define SET_USP(ptregs, value) \
 213         (!compat_user_mode(regs) ? ((regs)->sp = value) : ((regs)->compat_sp = value))
 214
 215 extern int regs_query_register_offset(const char *name);
 216 extern unsigned long regs_get_kernel_stack_nth(struct pt_regs *regs,
 217                                                unsigned int n);
 218
 219 /**
 220  * regs_get_register() - get register value from its offset
 221  * @regs:       pt_regs from which register value is gotten
 222  * @offset:     offset of the register.
 223  *
 224  * regs_get_register returns the value of a register whose offset from @regs.
 225  * The @offset is the offset of the register in struct pt_regs.
 226  * If @offset is bigger than MAX_REG_OFFSET, this returns 0.
 227  */
 228 static inline u64 regs_get_register(struct pt_regs *regs, unsigned int offset)
 229 {
 230         u64 val = 0;
 231
 232         WARN_ON(offset & 7);
 233
 234         offset >>= 3;
 235         switch (offset) {
 236         case 0 ... 30:
 237                 val = regs->regs[offset];
 238                 break;
 239         case offsetof(struct pt_regs, sp) >> 3:
 240                 val = regs->sp;
 241                 break;
 242         case offsetof(struct pt_regs, pc) >> 3:
 243                 val = regs->pc;
 244                 break;
 245         case offsetof(struct pt_regs, pstate) >> 3:
 246                 val = regs->pstate;
 247                 break;
 248         default:
 249                 val = 0;
 250         }
 251
 252         return val;
 253 }
 254
 255 /*
 256  * Read a register given an architectural register index r.
 257  * This handles the common case where 31 means XZR, not SP.
 258  */
 259 static inline unsigned long pt_regs_read_reg(const struct pt_regs *regs, int r)
 260 {
 261         return (r == 31) ? 0 : regs->regs[r];
 262 }
 263
 264 /*
 265  * Write a register given an architectural register index r.
 266  * This handles the common case where 31 means XZR, not SP.
 267  */
 268 static inline void pt_regs_write_reg(struct pt_regs *regs, int r,
 269                                      unsigned long val)
 270 {
 271         if (r != 31)
 272                 regs->regs[r] = val;
 273 }
 274
 275 /* Valid only for Kernel mode traps. */
 276 static inline unsigned long kernel_stack_pointer(struct pt_regs *regs)
 277 {
 278         return regs->sp;
 279 }
 280
 281 static inline unsigned long regs_return_value(struct pt_regs *regs)
 282 {
 283         return regs->regs[0];
 284 }
 285
 286 /* We must avoid circular header include via sched.h */
 287 struct task_struct;
 288 int valid_user_regs(struct user_pt_regs *regs, struct task_struct *task);
 289
 290 #define GET_IP(regs)            ((unsigned long)(regs)->pc)
 291 #define SET_IP(regs, value)     ((regs)->pc = ((u64) (value)))
 292
 293 #define GET_FP(ptregs)          ((unsigned long)(ptregs)->regs[29])
 294 #define SET_FP(ptregs, value)   ((ptregs)->regs[29] = ((u64) (value)))
 295
 296 #include <asm-generic/ptrace.h>
 297
 298 #define procedure_link_pointer(regs)    ((regs)->regs[30])
 299
 300 static inline void procedure_link_pointer_set(struct pt_regs *regs,
 301                                            unsigned long val)
 302 {
 303         procedure_link_pointer(regs) = val;
 304 }
 305
 306 #undef profile_pc
 307 extern unsigned long profile_pc(struct pt_regs *regs);
 308
 309 #endif /* __ASSEMBLY__ */
 310 #endif