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