1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
2c6557e7fSMartin Schwidefsky /*
3c6557e7fSMartin Schwidefsky * S390 version
4a53c8fabSHeiko Carstens * Copyright IBM Corp. 1999, 2000
5c6557e7fSMartin Schwidefsky * Author(s): Denis Joseph Barrow (djbarrow@de.ibm.com,barrow_dj@yahoo.com)
6c6557e7fSMartin Schwidefsky */
7c6557e7fSMartin Schwidefsky #ifndef _S390_PTRACE_H
8c6557e7fSMartin Schwidefsky #define _S390_PTRACE_H
9c6557e7fSMartin Schwidefsky
10fe6ba88bSMasahiro Yamada #include <linux/bits.h>
119807f759SDavid Howells #include <uapi/asm/ptrace.h>
1234bbeed0SSven Schnelle #include <asm/tpi.h>
13c6557e7fSMartin Schwidefsky
14d3a73acbSMartin Schwidefsky #define PIF_SYSCALL 0 /* inside a system call */
15d26a357fSSven Schnelle #define PIF_EXECVE_PGSTE_RESTART 1 /* restart execve for PGSTE binaries */
1656e62a73SSven Schnelle #define PIF_SYSCALL_RET_SET 2 /* return value was set via ptrace */
17c771320eSMartin Schwidefsky #define PIF_GUEST_FAULT 3 /* indicates program check in sie64a */
181389f179SHeiko Carstens #define PIF_FTRACE_FULL_REGS 4 /* all register contents valid (ftrace) */
19d3a73acbSMartin Schwidefsky
20fe6ba88bSMasahiro Yamada #define _PIF_SYSCALL BIT(PIF_SYSCALL)
21d26a357fSSven Schnelle #define _PIF_EXECVE_PGSTE_RESTART BIT(PIF_EXECVE_PGSTE_RESTART)
2256e62a73SSven Schnelle #define _PIF_SYSCALL_RET_SET BIT(PIF_SYSCALL_RET_SET)
23fe6ba88bSMasahiro Yamada #define _PIF_GUEST_FAULT BIT(PIF_GUEST_FAULT)
241389f179SHeiko Carstens #define _PIF_FTRACE_FULL_REGS BIT(PIF_FTRACE_FULL_REGS)
25d3a73acbSMartin Schwidefsky
26*b8af5999SHeiko Carstens #define PSW32_MASK_PER _AC(0x40000000, UL)
27*b8af5999SHeiko Carstens #define PSW32_MASK_DAT _AC(0x04000000, UL)
28*b8af5999SHeiko Carstens #define PSW32_MASK_IO _AC(0x02000000, UL)
29*b8af5999SHeiko Carstens #define PSW32_MASK_EXT _AC(0x01000000, UL)
30*b8af5999SHeiko Carstens #define PSW32_MASK_KEY _AC(0x00F00000, UL)
31*b8af5999SHeiko Carstens #define PSW32_MASK_BASE _AC(0x00080000, UL) /* Always one */
32*b8af5999SHeiko Carstens #define PSW32_MASK_MCHECK _AC(0x00040000, UL)
33*b8af5999SHeiko Carstens #define PSW32_MASK_WAIT _AC(0x00020000, UL)
34*b8af5999SHeiko Carstens #define PSW32_MASK_PSTATE _AC(0x00010000, UL)
35*b8af5999SHeiko Carstens #define PSW32_MASK_ASC _AC(0x0000C000, UL)
36*b8af5999SHeiko Carstens #define PSW32_MASK_CC _AC(0x00003000, UL)
37*b8af5999SHeiko Carstens #define PSW32_MASK_PM _AC(0x00000f00, UL)
38*b8af5999SHeiko Carstens #define PSW32_MASK_RI _AC(0x00000080, UL)
3963764028SHeiko Carstens
40*b8af5999SHeiko Carstens #define PSW32_ADDR_AMODE _AC(0x80000000, UL)
41*b8af5999SHeiko Carstens #define PSW32_ADDR_INSN _AC(0x7FFFFFFF, UL)
42*b8af5999SHeiko Carstens
43*b8af5999SHeiko Carstens #define PSW32_DEFAULT_KEY ((PAGE_DEFAULT_ACC) << 20)
44*b8af5999SHeiko Carstens
45*b8af5999SHeiko Carstens #define PSW32_ASC_PRIMARY _AC(0x00000000, UL)
46*b8af5999SHeiko Carstens #define PSW32_ASC_ACCREG _AC(0x00004000, UL)
47*b8af5999SHeiko Carstens #define PSW32_ASC_SECONDARY _AC(0x00008000, UL)
48*b8af5999SHeiko Carstens #define PSW32_ASC_HOME _AC(0x0000C000, UL)
49*b8af5999SHeiko Carstens
50*b8af5999SHeiko Carstens #define PSW_DEFAULT_KEY ((PAGE_DEFAULT_ACC) << 52)
5163dd9b44SHeiko Carstens
52e258d719SMartin Schwidefsky #define PSW_KERNEL_BITS (PSW_DEFAULT_KEY | PSW_MASK_BASE | PSW_ASC_HOME | \
53bb1520d5SAlexander Gordeev PSW_MASK_EA | PSW_MASK_BA | PSW_MASK_DAT)
54e258d719SMartin Schwidefsky #define PSW_USER_BITS (PSW_MASK_DAT | PSW_MASK_IO | PSW_MASK_EXT | \
55e258d719SMartin Schwidefsky PSW_DEFAULT_KEY | PSW_MASK_BASE | PSW_MASK_MCHECK | \
56e258d719SMartin Schwidefsky PSW_MASK_PSTATE | PSW_ASC_PRIMARY)
57c6557e7fSMartin Schwidefsky
58*b8af5999SHeiko Carstens #ifndef __ASSEMBLY__
59*b8af5999SHeiko Carstens
601365632bSHeiko Carstens struct psw_bits {
61cb951785SHeiko Carstens unsigned long : 1;
62a7525982SHeiko Carstens unsigned long per : 1; /* PER-Mask */
63cb951785SHeiko Carstens unsigned long : 3;
64a7525982SHeiko Carstens unsigned long dat : 1; /* DAT Mode */
65a7525982SHeiko Carstens unsigned long io : 1; /* Input/Output Mask */
66a7525982SHeiko Carstens unsigned long ext : 1; /* External Mask */
67cb951785SHeiko Carstens unsigned long key : 4; /* PSW Key */
68cb951785SHeiko Carstens unsigned long : 1;
69a7525982SHeiko Carstens unsigned long mcheck : 1; /* Machine-Check Mask */
70a7525982SHeiko Carstens unsigned long wait : 1; /* Wait State */
71a7525982SHeiko Carstens unsigned long pstate : 1; /* Problem State */
72cb951785SHeiko Carstens unsigned long as : 2; /* Address Space Control */
73cb951785SHeiko Carstens unsigned long cc : 2; /* Condition Code */
74cb951785SHeiko Carstens unsigned long pm : 4; /* Program Mask */
75cb951785SHeiko Carstens unsigned long ri : 1; /* Runtime Instrumentation */
76cb951785SHeiko Carstens unsigned long : 6;
77cb951785SHeiko Carstens unsigned long eaba : 2; /* Addressing Mode */
78cb951785SHeiko Carstens unsigned long : 31;
79cb951785SHeiko Carstens unsigned long ia : 64; /* Instruction Address */
801365632bSHeiko Carstens };
811365632bSHeiko Carstens
821365632bSHeiko Carstens enum {
838bb3fdd6SHeiko Carstens PSW_BITS_AMODE_24BIT = 0,
848bb3fdd6SHeiko Carstens PSW_BITS_AMODE_31BIT = 1,
858bb3fdd6SHeiko Carstens PSW_BITS_AMODE_64BIT = 3
861365632bSHeiko Carstens };
871365632bSHeiko Carstens
881365632bSHeiko Carstens enum {
898bb3fdd6SHeiko Carstens PSW_BITS_AS_PRIMARY = 0,
908bb3fdd6SHeiko Carstens PSW_BITS_AS_ACCREG = 1,
918bb3fdd6SHeiko Carstens PSW_BITS_AS_SECONDARY = 2,
928bb3fdd6SHeiko Carstens PSW_BITS_AS_HOME = 3
931365632bSHeiko Carstens };
941365632bSHeiko Carstens
951365632bSHeiko Carstens #define psw_bits(__psw) (*({ \
961365632bSHeiko Carstens typecheck(psw_t, __psw); \
971365632bSHeiko Carstens &(*(struct psw_bits *)(&(__psw))); \
981365632bSHeiko Carstens }))
991365632bSHeiko Carstens
10067a9c428SHeiko Carstens typedef struct {
10167a9c428SHeiko Carstens unsigned int mask;
10267a9c428SHeiko Carstens unsigned int addr;
10367a9c428SHeiko Carstens } psw_t32 __aligned(8);
10467a9c428SHeiko Carstens
10556e62a73SSven Schnelle #define PGM_INT_CODE_MASK 0x7f
10656e62a73SSven Schnelle #define PGM_INT_CODE_PER 0x80
10756e62a73SSven Schnelle
108c6557e7fSMartin Schwidefsky /*
109c6557e7fSMartin Schwidefsky * The pt_regs struct defines the way the registers are stored on
110c6557e7fSMartin Schwidefsky * the stack during a system call.
111c6557e7fSMartin Schwidefsky */
112885359c4SHeiko Carstens struct pt_regs {
113466698e6SHendrik Brueckner union {
114466698e6SHendrik Brueckner user_pt_regs user_regs;
115466698e6SHendrik Brueckner struct {
116c6557e7fSMartin Schwidefsky unsigned long args[1];
117c6557e7fSMartin Schwidefsky psw_t psw;
118c6557e7fSMartin Schwidefsky unsigned long gprs[NUM_GPRS];
119466698e6SHendrik Brueckner };
120466698e6SHendrik Brueckner };
121c6557e7fSMartin Schwidefsky unsigned long orig_gpr2;
12234bbeed0SSven Schnelle union {
12334bbeed0SSven Schnelle struct {
124aa33c8cbSMartin Schwidefsky unsigned int int_code;
12548f6b00cSMartin Schwidefsky unsigned int int_parm;
126aa33c8cbSMartin Schwidefsky unsigned long int_parm_long;
12734bbeed0SSven Schnelle };
12834bbeed0SSven Schnelle struct tpi_info tpi_info;
12934bbeed0SSven Schnelle };
130d3a73acbSMartin Schwidefsky unsigned long flags;
13187d59863SHeiko Carstens unsigned long cr1;
132c8f573ecSSven Schnelle unsigned long last_break;
133c6557e7fSMartin Schwidefsky };
1345e9a2692SMartin Schwidefsky
1355e9a2692SMartin Schwidefsky /*
1365e9a2692SMartin Schwidefsky * Program event recording (PER) register set.
1375e9a2692SMartin Schwidefsky */
1385e9a2692SMartin Schwidefsky struct per_regs {
1395e9a2692SMartin Schwidefsky unsigned long control; /* PER control bits */
1405e9a2692SMartin Schwidefsky unsigned long start; /* PER starting address */
1415e9a2692SMartin Schwidefsky unsigned long end; /* PER ending address */
1425e9a2692SMartin Schwidefsky };
1435e9a2692SMartin Schwidefsky
1445e9a2692SMartin Schwidefsky /*
1455e9a2692SMartin Schwidefsky * PER event contains information about the cause of the last PER exception.
1465e9a2692SMartin Schwidefsky */
1475e9a2692SMartin Schwidefsky struct per_event {
1485e9a2692SMartin Schwidefsky unsigned short cause; /* PER code, ATMID and AI */
1495e9a2692SMartin Schwidefsky unsigned long address; /* PER address */
1505e9a2692SMartin Schwidefsky unsigned char paid; /* PER access identification */
1515e9a2692SMartin Schwidefsky };
1525e9a2692SMartin Schwidefsky
1535e9a2692SMartin Schwidefsky /*
1545e9a2692SMartin Schwidefsky * Simplified per_info structure used to decode the ptrace user space ABI.
1555e9a2692SMartin Schwidefsky */
1565e9a2692SMartin Schwidefsky struct per_struct_kernel {
1575e9a2692SMartin Schwidefsky unsigned long cr9; /* PER control bits */
1585e9a2692SMartin Schwidefsky unsigned long cr10; /* PER starting address */
1595e9a2692SMartin Schwidefsky unsigned long cr11; /* PER ending address */
1605e9a2692SMartin Schwidefsky unsigned long bits; /* Obsolete software bits */
1615e9a2692SMartin Schwidefsky unsigned long starting_addr; /* User specified start address */
1625e9a2692SMartin Schwidefsky unsigned long ending_addr; /* User specified end address */
1635e9a2692SMartin Schwidefsky unsigned short perc_atmid; /* PER trap ATMID */
1645e9a2692SMartin Schwidefsky unsigned long address; /* PER trap instruction address */
1655e9a2692SMartin Schwidefsky unsigned char access_id; /* PER trap access identification */
1665e9a2692SMartin Schwidefsky };
1675e9a2692SMartin Schwidefsky
168d35339a4SMartin Schwidefsky #define PER_EVENT_MASK 0xEB000000UL
1695e9a2692SMartin Schwidefsky
1705e9a2692SMartin Schwidefsky #define PER_EVENT_BRANCH 0x80000000UL
1715e9a2692SMartin Schwidefsky #define PER_EVENT_IFETCH 0x40000000UL
1725e9a2692SMartin Schwidefsky #define PER_EVENT_STORE 0x20000000UL
1735e9a2692SMartin Schwidefsky #define PER_EVENT_STORE_REAL 0x08000000UL
174d35339a4SMartin Schwidefsky #define PER_EVENT_TRANSACTION_END 0x02000000UL
1755e9a2692SMartin Schwidefsky #define PER_EVENT_NULLIFICATION 0x01000000UL
1765e9a2692SMartin Schwidefsky
177d35339a4SMartin Schwidefsky #define PER_CONTROL_MASK 0x00e00000UL
1785e9a2692SMartin Schwidefsky
1795e9a2692SMartin Schwidefsky #define PER_CONTROL_BRANCH_ADDRESS 0x00800000UL
180d35339a4SMartin Schwidefsky #define PER_CONTROL_SUSPENSION 0x00400000UL
1815e9a2692SMartin Schwidefsky #define PER_CONTROL_ALTERATION 0x00200000UL
1825e9a2692SMartin Schwidefsky
set_pt_regs_flag(struct pt_regs * regs,int flag)183d3a73acbSMartin Schwidefsky static inline void set_pt_regs_flag(struct pt_regs *regs, int flag)
184d3a73acbSMartin Schwidefsky {
185ac25e790SHeiko Carstens regs->flags |= (1UL << flag);
186d3a73acbSMartin Schwidefsky }
187d3a73acbSMartin Schwidefsky
clear_pt_regs_flag(struct pt_regs * regs,int flag)188d3a73acbSMartin Schwidefsky static inline void clear_pt_regs_flag(struct pt_regs *regs, int flag)
189d3a73acbSMartin Schwidefsky {
190ac25e790SHeiko Carstens regs->flags &= ~(1UL << flag);
191d3a73acbSMartin Schwidefsky }
192d3a73acbSMartin Schwidefsky
test_pt_regs_flag(struct pt_regs * regs,int flag)193d3a73acbSMartin Schwidefsky static inline int test_pt_regs_flag(struct pt_regs *regs, int flag)
194d3a73acbSMartin Schwidefsky {
195ac25e790SHeiko Carstens return !!(regs->flags & (1UL << flag));
196d3a73acbSMartin Schwidefsky }
197d3a73acbSMartin Schwidefsky
test_and_clear_pt_regs_flag(struct pt_regs * regs,int flag)198e3c7a8d7SSven Schnelle static inline int test_and_clear_pt_regs_flag(struct pt_regs *regs, int flag)
199e3c7a8d7SSven Schnelle {
200e3c7a8d7SSven Schnelle int ret = test_pt_regs_flag(regs, flag);
201e3c7a8d7SSven Schnelle
202e3c7a8d7SSven Schnelle clear_pt_regs_flag(regs, flag);
203e3c7a8d7SSven Schnelle return ret;
204e3c7a8d7SSven Schnelle }
205e3c7a8d7SSven Schnelle
206c6557e7fSMartin Schwidefsky /*
207c6557e7fSMartin Schwidefsky * These are defined as per linux/ptrace.h, which see.
208c6557e7fSMartin Schwidefsky */
209c6557e7fSMartin Schwidefsky #define arch_has_single_step() (1)
210818a330cSMartin Schwidefsky #define arch_has_block_step() (1)
211c6557e7fSMartin Schwidefsky
212c6557e7fSMartin Schwidefsky #define user_mode(regs) (((regs)->psw.mask & PSW_MASK_PSTATE) != 0)
2139cb1ccecSHeiko Carstens #define instruction_pointer(regs) ((regs)->psw.addr)
214753c4dd6SMartin Schwidefsky #define user_stack_pointer(regs)((regs)->gprs[15])
215c6557e7fSMartin Schwidefsky #define profile_pc(regs) instruction_pointer(regs)
216952974acSHeiko Carstens
regs_return_value(struct pt_regs * regs)217d7e7528bSEric Paris static inline long regs_return_value(struct pt_regs *regs)
218d7e7528bSEric Paris {
219d7e7528bSEric Paris return regs->gprs[2];
220d7e7528bSEric Paris }
221d7e7528bSEric Paris
instruction_pointer_set(struct pt_regs * regs,unsigned long val)2222a0a5b22SJan Willeke static inline void instruction_pointer_set(struct pt_regs *regs,
2232a0a5b22SJan Willeke unsigned long val)
2242a0a5b22SJan Willeke {
225fecc868aSHeiko Carstens regs->psw.addr = val;
2262a0a5b22SJan Willeke }
2272a0a5b22SJan Willeke
228952974acSHeiko Carstens int regs_query_register_offset(const char *name);
229952974acSHeiko Carstens const char *regs_query_register_name(unsigned int offset);
230952974acSHeiko Carstens unsigned long regs_get_register(struct pt_regs *regs, unsigned int offset);
231952974acSHeiko Carstens unsigned long regs_get_kernel_stack_nth(struct pt_regs *regs, unsigned int n);
232952974acSHeiko Carstens
233a30b5b03SHeiko Carstens /**
234a30b5b03SHeiko Carstens * regs_get_kernel_argument() - get Nth function argument in kernel
235a30b5b03SHeiko Carstens * @regs: pt_regs of that context
236a30b5b03SHeiko Carstens * @n: function argument number (start from 0)
237a30b5b03SHeiko Carstens *
238a30b5b03SHeiko Carstens * regs_get_kernel_argument() returns @n th argument of the function call.
239a30b5b03SHeiko Carstens */
regs_get_kernel_argument(struct pt_regs * regs,unsigned int n)240a30b5b03SHeiko Carstens static inline unsigned long regs_get_kernel_argument(struct pt_regs *regs,
241a30b5b03SHeiko Carstens unsigned int n)
242a30b5b03SHeiko Carstens {
243a30b5b03SHeiko Carstens unsigned int argoffset = STACK_FRAME_OVERHEAD / sizeof(long);
244a30b5b03SHeiko Carstens
245a30b5b03SHeiko Carstens #define NR_REG_ARGUMENTS 5
246a30b5b03SHeiko Carstens if (n < NR_REG_ARGUMENTS)
247a30b5b03SHeiko Carstens return regs_get_register(regs, 2 + n);
248a30b5b03SHeiko Carstens n -= NR_REG_ARGUMENTS;
249a30b5b03SHeiko Carstens return regs_get_kernel_stack_nth(regs, argoffset + n);
250a30b5b03SHeiko Carstens }
251a30b5b03SHeiko Carstens
kernel_stack_pointer(struct pt_regs * regs)252952974acSHeiko Carstens static inline unsigned long kernel_stack_pointer(struct pt_regs *regs)
253952974acSHeiko Carstens {
2549cb1ccecSHeiko Carstens return regs->gprs[15];
255952974acSHeiko Carstens }
256952974acSHeiko Carstens
regs_set_return_value(struct pt_regs * regs,unsigned long rc)25773d6eb48SIlya Leoshkevich static inline void regs_set_return_value(struct pt_regs *regs, unsigned long rc)
25873d6eb48SIlya Leoshkevich {
25973d6eb48SIlya Leoshkevich regs->gprs[2] = rc;
26073d6eb48SIlya Leoshkevich }
26173d6eb48SIlya Leoshkevich
262c6557e7fSMartin Schwidefsky #endif /* __ASSEMBLY__ */
263c6557e7fSMartin Schwidefsky #endif /* _S390_PTRACE_H */
264