[linux-2.6-block.git] / arch / powerpc / include / asm / ptrace.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Copyright (C) 2001 PPC64 Team, IBM Corp
 *
 * This struct defines the way the registers are stored on the
 * kernel stack during a system call or other kernel entry.
 *
 * this should only contain volatile regs
 * since we can keep non-volatile in the thread_struct
 * should set this up when only volatiles are saved
 * by intr code.
 *
 * Since this is going on the stack, *CARE MUST BE TAKEN* to insure
 * that the overall structure is a multiple of 16 bytes in length.
 *
 * Note that the offsets of the fields in this struct correspond with
 * the PT_* values below.  This simplifies arch/powerpc/kernel/ptrace.c.
 */
#ifndef _ASM_POWERPC_PTRACE_H
#define _ASM_POWERPC_PTRACE_H

#include <uapi/asm/ptrace.h>
#include <asm/asm-const.h>

#ifndef __ASSEMBLY__
struct pt_regs
{
	union {
		struct user_pt_regs user_regs;
		struct {
			unsigned long gpr[32];
			unsigned long nip;
			unsigned long msr;
			unsigned long orig_gpr3;
			unsigned long ctr;
			unsigned long link;
			unsigned long xer;
			unsigned long ccr;
#ifdef CONFIG_PPC64
			unsigned long softe;
#else
			unsigned long mq;
#endif
			unsigned long trap;
			unsigned long dar;
			unsigned long dsisr;
			unsigned long result;
		};
	};

	union {
		struct {
#ifdef CONFIG_PPC64
			unsigned long ppr;
#endif
#ifdef CONFIG_PPC_KUAP
			unsigned long kuap;
#endif
		};
		unsigned long __pad[2];	/* Maintain 16 byte interrupt stack alignment */
	};
};
#endif

#ifdef __powerpc64__

/*
 * Size of redzone that userspace is allowed to use below the stack
 * pointer.  This is 288 in the 64-bit big-endian ELF ABI, and 512 in
 * the new ELFv2 little-endian ABI, so we allow the larger amount.
 *
 * For kernel code we allow a 288-byte redzone, in order to conserve
 * kernel stack space; gcc currently only uses 288 bytes, and will
 * hopefully allow explicit control of the redzone size in future.
 */
#define USER_REDZONE_SIZE	512
#define KERNEL_REDZONE_SIZE	288

#define STACK_FRAME_OVERHEAD	112	/* size of minimum stack frame */
#define STACK_FRAME_LR_SAVE	2	/* Location of LR in stack frame */
#define STACK_FRAME_REGS_MARKER	ASM_CONST(0x7265677368657265)
#define STACK_INT_FRAME_SIZE	(sizeof(struct pt_regs) + \
				 STACK_FRAME_OVERHEAD + KERNEL_REDZONE_SIZE)
#define STACK_FRAME_MARKER	12

#ifdef PPC64_ELF_ABI_v2
#define STACK_FRAME_MIN_SIZE	32
#else
#define STACK_FRAME_MIN_SIZE	STACK_FRAME_OVERHEAD
#endif

/* Size of dummy stack frame allocated when calling signal handler. */
#define __SIGNAL_FRAMESIZE	128
#define __SIGNAL_FRAMESIZE32	64

#else /* __powerpc64__ */

#define USER_REDZONE_SIZE	0
#define KERNEL_REDZONE_SIZE	0
#define STACK_FRAME_OVERHEAD	16	/* size of minimum stack frame */
#define STACK_FRAME_LR_SAVE	1	/* Location of LR in stack frame */
#define STACK_FRAME_REGS_MARKER	ASM_CONST(0x72656773)
#define STACK_INT_FRAME_SIZE	(sizeof(struct pt_regs) + STACK_FRAME_OVERHEAD)
#define STACK_FRAME_MARKER	2
#define STACK_FRAME_MIN_SIZE	STACK_FRAME_OVERHEAD

/* Size of stack frame allocated when calling signal handler. */
#define __SIGNAL_FRAMESIZE	64

#endif /* __powerpc64__ */

#ifndef __ASSEMBLY__

static inline unsigned long instruction_pointer(struct pt_regs *regs)
{
	return regs->nip;
}

static inline void instruction_pointer_set(struct pt_regs *regs,
		unsigned long val)
{
	regs->nip = val;
}

static inline unsigned long user_stack_pointer(struct pt_regs *regs)
{
	return regs->gpr[1];
}

static inline unsigned long frame_pointer(struct pt_regs *regs)
{
	return 0;
}

#ifdef CONFIG_SMP
extern unsigned long profile_pc(struct pt_regs *regs);
#else
#define profile_pc(regs) instruction_pointer(regs)
#endif

#define kernel_stack_pointer(regs) ((regs)->gpr[1])
static inline int is_syscall_success(struct pt_regs *regs)
{
	return !(regs->ccr & 0x10000000);
}

static inline long regs_return_value(struct pt_regs *regs)
{
	if (is_syscall_success(regs))
		return regs->gpr[3];
	else
		return -regs->gpr[3];
}

static inline void regs_set_return_value(struct pt_regs *regs, unsigned long rc)
{
	regs->gpr[3] = rc;
}

#ifdef __powerpc64__
#define user_mode(regs) ((((regs)->msr) >> MSR_PR_LG) & 0x1)
#else
#define user_mode(regs) (((regs)->msr & MSR_PR) != 0)
#endif

#define force_successful_syscall_return()   \
	do { \
		set_thread_flag(TIF_NOERROR); \
	} while(0)

struct task_struct;
extern int ptrace_get_reg(struct task_struct *task, int regno,
			  unsigned long *data);
extern int ptrace_put_reg(struct task_struct *task, int regno,
			  unsigned long data);

#define current_pt_regs() \
	((struct pt_regs *)((unsigned long)task_stack_page(current) + THREAD_SIZE) - 1)
/*
 * We use the least-significant bit of the trap field to indicate
 * whether we have saved the full set of registers, or only a
 * partial set.  A 1 there means the partial set.
 * On 4xx we use the next bit to indicate whether the exception
 * is a critical exception (1 means it is).
 */
#define FULL_REGS(regs)		(((regs)->trap & 1) == 0)
#ifndef __powerpc64__
#define IS_CRITICAL_EXC(regs)	(((regs)->trap & 2) != 0)
#define IS_MCHECK_EXC(regs)	(((regs)->trap & 4) != 0)
#define IS_DEBUG_EXC(regs)	(((regs)->trap & 8) != 0)
#endif /* ! __powerpc64__ */
#define TRAP(regs)		((regs)->trap & ~0xF)
#ifdef __powerpc64__
#define NV_REG_POISON		0xdeadbeefdeadbeefUL
#define CHECK_FULL_REGS(regs)	BUG_ON(regs->trap & 1)
#else
#define NV_REG_POISON		0xdeadbeef
#define CHECK_FULL_REGS(regs)						      \
do {									      \
	if ((regs)->trap & 1)						      \
		printk(KERN_CRIT "%s: partial register set\n", __func__); \
} while (0)
#endif /* __powerpc64__ */

#define arch_has_single_step()	(1)
#ifndef CONFIG_BOOK3S_601
#define arch_has_block_step()	(true)
#else
#define arch_has_block_step()	(false)
#endif
#define ARCH_HAS_USER_SINGLE_STEP_REPORT

/*
 * kprobe-based event tracer support
 */

#include <linux/stddef.h>
#include <linux/thread_info.h>
extern int regs_query_register_offset(const char *name);
extern const char *regs_query_register_name(unsigned int offset);
#define MAX_REG_OFFSET (offsetof(struct pt_regs, dsisr))

/**
 * regs_get_register() - get register value from its offset
 * @regs:	   pt_regs from which register value is gotten
 * @offset:    offset number of the register.
 *
 * regs_get_register returns the value of a register whose offset from @regs.
 * The @offset is the offset of the register in struct pt_regs.
 * If @offset is bigger than MAX_REG_OFFSET, this returns 0.
 */
static inline unsigned long regs_get_register(struct pt_regs *regs,
						unsigned int offset)
{
	if (unlikely(offset > MAX_REG_OFFSET))
		return 0;
	return *(unsigned long *)((unsigned long)regs + offset);
}

/**
 * regs_within_kernel_stack() - check the address in the stack
 * @regs:      pt_regs which contains kernel stack pointer.
 * @addr:      address which is checked.
 *
 * regs_within_kernel_stack() checks @addr is within the kernel stack page(s).
 * If @addr is within the kernel stack, it returns true. If not, returns false.
 */

static inline bool regs_within_kernel_stack(struct pt_regs *regs,
						unsigned long addr)
{
	return ((addr & ~(THREAD_SIZE - 1))  ==
		(kernel_stack_pointer(regs) & ~(THREAD_SIZE - 1)));
}

/**
 * regs_get_kernel_stack_nth() - get Nth entry of the stack
 * @regs:	pt_regs which contains kernel stack pointer.
 * @n:		stack entry number.
 *
 * regs_get_kernel_stack_nth() returns @n th entry of the kernel stack which
 * is specified by @regs. If the @n th entry is NOT in the kernel stack,
 * this returns 0.
 */
static inline unsigned long regs_get_kernel_stack_nth(struct pt_regs *regs,
						      unsigned int n)
{
	unsigned long *addr = (unsigned long *)kernel_stack_pointer(regs);
	addr += n;
	if (regs_within_kernel_stack(regs, (unsigned long)addr))
		return *addr;
	else
		return 0;
}

#endif /* __ASSEMBLY__ */

#ifndef __powerpc64__
#else /* __powerpc64__ */
#define PT_FPSCR32 (PT_FPR0 + 2*32 + 1)	/* each FP reg occupies 2 32-bit userspace slots */
#define PT_VR0_32 164	/* each Vector reg occupies 4 slots in 32-bit */
#define PT_VSCR_32 (PT_VR0 + 32*4 + 3)
#define PT_VRSAVE_32 (PT_VR0 + 33*4)
#define PT_VSR0_32 300 	/* each VSR reg occupies 4 slots in 32-bit */
#endif /* __powerpc64__ */
#endif /* _ASM_POWERPC_PTRACE_H */
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 LT	2	/*
	3	* Copyright (C) 2001 PPC64 Team, IBM Corp
	4	*
	5	* This struct defines the way the registers are stored on the
	6	* kernel stack during a system call or other kernel entry.
	7	*
	8	* this should only contain volatile regs
	9	* since we can keep non-volatile in the thread_struct
	10	* should set this up when only volatiles are saved
	11	* by intr code.
	12	*
	13	* Since this is going on the stack, CARE MUST BE TAKEN to insure
	14	* that the overall structure is a multiple of 16 bytes in length.
	15	*
	16	* Note that the offsets of the fields in this struct correspond with
da80d460	17	* the PT_* values below. This simplifies arch/powerpc/kernel/ptrace.c.
1da177e4	18	*/
c3617f72 DH	19	#ifndef _ASM_POWERPC_PTRACE_H
c3617f72 DH	20	#define _ASM_POWERPC_PTRACE_H
1da177e4	21
c3617f72	22	#include <uapi/asm/ptrace.h>
ec0c464c	23	#include <asm/asm-const.h>
1da177e4	24
002af939 ME	25	#ifndef __ASSEMBLY__
	26	struct pt_regs
	27	{
	28	union {
	29	struct user_pt_regs user_regs;
	30	struct {
	31	unsigned long gpr[32];
	32	unsigned long nip;
	33	unsigned long msr;
	34	unsigned long orig_gpr3;
	35	unsigned long ctr;
	36	unsigned long link;
	37	unsigned long xer;
	38	unsigned long ccr;
	39	#ifdef CONFIG_PPC64
	40	unsigned long softe;
	41	#else
	42	unsigned long mq;
	43	#endif
	44	unsigned long trap;
	45	unsigned long dar;
	46	unsigned long dsisr;
	47	unsigned long result;
	48	};
	49	};
4c2de74c	50
de78a9c4 CL	51	union {
de78a9c4 CL	52	struct {
4c2de74c	53	#ifdef CONFIG_PPC64
de78a9c4 CL	54	unsigned long ppr;
	55	#endif
	56	#ifdef CONFIG_PPC_KUAP
	57	unsigned long kuap;
4c2de74c	58	#endif
de78a9c4 CL	59	};
	60	unsigned long __pad[2]; /* Maintain 16 byte interrupt stack alignment */
	61	};
002af939 ME	62	};
002af939 ME	63	#endif
a0987224	64
da80d460 SR	65	#ifdef __powerpc64__
da80d460 SR	66
573ebfa6 PM	67	/*
	68	* Size of redzone that userspace is allowed to use below the stack
	69	* pointer. This is 288 in the 64-bit big-endian ELF ABI, and 512 in
	70	* the new ELFv2 little-endian ABI, so we allow the larger amount.
	71	*
	72	* For kernel code we allow a 288-byte redzone, in order to conserve
	73	* kernel stack space; gcc currently only uses 288 bytes, and will
	74	* hopefully allow explicit control of the redzone size in future.
	75	*/
	76	#define USER_REDZONE_SIZE 512
	77	#define KERNEL_REDZONE_SIZE 288
	78
da80d460	79	#define STACK_FRAME_OVERHEAD 112 /* size of minimum stack frame */
ec2b36b9 BH	80	#define STACK_FRAME_LR_SAVE 2 /* Location of LR in stack frame */
	81	#define STACK_FRAME_REGS_MARKER ASM_CONST(0x7265677368657265)
	82	#define STACK_INT_FRAME_SIZE (sizeof(struct pt_regs) + \
573ebfa6	83	STACK_FRAME_OVERHEAD + KERNEL_REDZONE_SIZE)
ec2b36b9	84	#define STACK_FRAME_MARKER 12
da80d460	85
f55d9665	86	#ifdef PPC64_ELF_ABI_v2
85101af1 AB	87	#define STACK_FRAME_MIN_SIZE 32
	88	#else
	89	#define STACK_FRAME_MIN_SIZE STACK_FRAME_OVERHEAD
	90	#endif
	91
da80d460 SR	92	/* Size of dummy stack frame allocated when calling signal handler. */
	93	#define __SIGNAL_FRAMESIZE 128
	94	#define __SIGNAL_FRAMESIZE32 64
	95
	96	#else /* __powerpc64__ */
	97
573ebfa6 PM	98	#define USER_REDZONE_SIZE 0
573ebfa6 PM	99	#define KERNEL_REDZONE_SIZE 0
da80d460	100	#define STACK_FRAME_OVERHEAD 16 /* size of minimum stack frame */
ec2b36b9 BH	101	#define STACK_FRAME_LR_SAVE 1 /* Location of LR in stack frame */
	102	#define STACK_FRAME_REGS_MARKER ASM_CONST(0x72656773)
	103	#define STACK_INT_FRAME_SIZE (sizeof(struct pt_regs) + STACK_FRAME_OVERHEAD)
	104	#define STACK_FRAME_MARKER 2
85101af1	105	#define STACK_FRAME_MIN_SIZE STACK_FRAME_OVERHEAD
da80d460 SR	106
	107	/* Size of stack frame allocated when calling signal handler. */
	108	#define __SIGNAL_FRAMESIZE 64
	109
	110	#endif /* __powerpc64__ */
a0987224	111
da80d460 SR	112	#ifndef __ASSEMBLY__
da80d460 SR	113
b42dfdea CH	114	static inline unsigned long instruction_pointer(struct pt_regs *regs)
	115	{
	116	return regs->nip;
	117	}
	118
	119	static inline void instruction_pointer_set(struct pt_regs *regs,
	120	unsigned long val)
	121	{
	122	regs->nip = val;
	123	}
	124
	125	static inline unsigned long user_stack_pointer(struct pt_regs *regs)
	126	{
	127	return regs->gpr[1];
	128	}
	129
	130	static inline unsigned long frame_pointer(struct pt_regs *regs)
	131	{
	132	return 0;
	133	}
e6289427 SD	134
	135	#ifdef CONFIG_SMP
	136	extern unsigned long profile_pc(struct pt_regs *regs);
b42dfdea CH	137	#else
b42dfdea CH	138	#define profile_pc(regs) instruction_pointer(regs)
e6289427 SD	139	#endif
e6289427 SD	140
359e4284	141	#define kernel_stack_pointer(regs) ((regs)->gpr[1])
d7e7528b EP	142	static inline int is_syscall_success(struct pt_regs *regs)
	143	{
	144	return !(regs->ccr & 0x10000000);
	145	}
	146
	147	static inline long regs_return_value(struct pt_regs *regs)
	148	{
	149	if (is_syscall_success(regs))
	150	return regs->gpr[3];
	151	else
	152	return -regs->gpr[3];
	153	}
b3f827cb	154
7cd01b08 NR	155	static inline void regs_set_return_value(struct pt_regs *regs, unsigned long rc)
	156	{
	157	regs->gpr[3] = rc;
	158	}
	159
da80d460	160	#ifdef __powerpc64__
1da177e4	161	#define user_mode(regs) ((((regs)->msr) >> MSR_PR_LG) & 0x1)
da80d460 SR	162	#else
	163	#define user_mode(regs) (((regs)->msr & MSR_PR) != 0)
	164	#endif
1da177e4 LT	165
1da177e4 LT	166	#define force_successful_syscall_return() \
da80d460	167	do { \
401d1f02	168	set_thread_flag(TIF_NOERROR); \
da80d460	169	} while(0)
1da177e4	170
865418d8	171	struct task_struct;
ee4a3916 AK	172	extern int ptrace_get_reg(struct task_struct *task, int regno,
ee4a3916 AK	173	unsigned long *data);
865418d8 BH	174	extern int ptrace_put_reg(struct task_struct *task, int regno,
	175	unsigned long data);
	176
be6abfa7	177	#define current_pt_regs() \
b72cc2e7	178	((struct pt_regs *)((unsigned long)task_stack_page(current) + THREAD_SIZE) - 1)
1da177e4 LT	179	/*
	180	* We use the least-significant bit of the trap field to indicate
	181	* whether we have saved the full set of registers, or only a
	182	* partial set. A 1 there means the partial set.
da80d460 SR	183	* On 4xx we use the next bit to indicate whether the exception
da80d460 SR	184	* is a critical exception (1 means it is).
1da177e4 LT	185	*/
1da177e4 LT	186	#define FULL_REGS(regs) (((regs)->trap & 1) == 0)
da80d460	187	#ifndef __powerpc64__
47c0bd1a BH	188	#define IS_CRITICAL_EXC(regs) (((regs)->trap & 2) != 0)
47c0bd1a BH	189	#define IS_MCHECK_EXC(regs) (((regs)->trap & 4) != 0)
663276b7	190	#define IS_DEBUG_EXC(regs) (((regs)->trap & 8) != 0)
da80d460	191	#endif /* ! __powerpc64__ */
1da177e4	192	#define TRAP(regs) ((regs)->trap & ~0xF)
da80d460	193	#ifdef __powerpc64__
a71f5d5d	194	#define NV_REG_POISON 0xdeadbeefdeadbeefUL
1da177e4	195	#define CHECK_FULL_REGS(regs) BUG_ON(regs->trap & 1)
da80d460	196	#else
a71f5d5d	197	#define NV_REG_POISON 0xdeadbeef
da80d460 SR	198	#define CHECK_FULL_REGS(regs) \
	199	do { \
	200	if ((regs)->trap & 1) \
653c0316	201	printk(KERN_CRIT "%s: partial register set\n", __func__); \
da80d460 SR	202	} while (0)
da80d460 SR	203	#endif /* __powerpc64__ */
a0987224	204
2a84b0d7	205	#define arch_has_single_step() (1)
12c3f1fd CL	206	#ifndef CONFIG_BOOK3S_601
	207	#define arch_has_block_step() (true)
	208	#else
	209	#define arch_has_block_step() (false)
	210	#endif
efc463ad	211	#define ARCH_HAS_USER_SINGLE_STEP_REPORT
25baa35b	212
359e4284 MS	213	/*
	214	* kprobe-based event tracer support
	215	*/
	216
	217	#include <linux/stddef.h>
	218	#include <linux/thread_info.h>
	219	extern int regs_query_register_offset(const char *name);
	220	extern const char *regs_query_register_name(unsigned int offset);
	221	#define MAX_REG_OFFSET (offsetof(struct pt_regs, dsisr))
	222
	223	/**
	224	* regs_get_register() - get register value from its offset
	225	* @regs: pt_regs from which register value is gotten
	226	* @offset: offset number of the register.
	227	*
	228	* regs_get_register returns the value of a register whose offset from @regs.
	229	* The @offset is the offset of the register in struct pt_regs.
	230	* If @offset is bigger than MAX_REG_OFFSET, this returns 0.
	231	*/
	232	static inline unsigned long regs_get_register(struct pt_regs *regs,
	233	unsigned int offset)
	234	{
	235	if (unlikely(offset > MAX_REG_OFFSET))
	236	return 0;
	237	return (unsigned long )((unsigned long)regs + offset);
	238	}
	239
	240	/**
	241	* regs_within_kernel_stack() - check the address in the stack
	242	* @regs: pt_regs which contains kernel stack pointer.
	243	* @addr: address which is checked.
	244	*
	245	* regs_within_kernel_stack() checks @addr is within the kernel stack page(s).
	246	* If @addr is within the kernel stack, it returns true. If not, returns false.
	247	*/
	248
	249	static inline bool regs_within_kernel_stack(struct pt_regs *regs,
	250	unsigned long addr)
	251	{
	252	return ((addr & ~(THREAD_SIZE - 1)) ==
	253	(kernel_stack_pointer(regs) & ~(THREAD_SIZE - 1)));
	254	}
	255
	256	/**
	257	* regs_get_kernel_stack_nth() - get Nth entry of the stack
	258	* @regs: pt_regs which contains kernel stack pointer.
	259	* @n: stack entry number.
	260	*
	261	* regs_get_kernel_stack_nth() returns @n th entry of the kernel stack which
	262	* is specified by @regs. If the @n th entry is NOT in the kernel stack,
	263	* this returns 0.
	264	*/
	265	static inline unsigned long regs_get_kernel_stack_nth(struct pt_regs *regs,
	266	unsigned int n)
	267	{
	268	unsigned long addr = (unsigned long )kernel_stack_pointer(regs);
	269	addr += n;
	270	if (regs_within_kernel_stack(regs, (unsigned long)addr))
	271	return *addr;
	272	else
	273	return 0;
	274	}
	275
a0987224 AB	276	#endif /* __ASSEMBLY__ */
a0987224 AB	277
da80d460	278	#ifndef __powerpc64__
da80d460	279	#else /* __powerpc64__ */
a0987224	280	#define PT_FPSCR32 (PT_FPR0 + 232 + 1) / each FP reg occupies 2 32-bit userspace slots */
1da177e4 LT	281	#define PT_VR0_32 164 /* each Vector reg occupies 4 slots in 32-bit */
	282	#define PT_VSCR_32 (PT_VR0 + 32*4 + 3)
	283	#define PT_VRSAVE_32 (PT_VR0 + 33*4)
ce48b210	284	#define PT_VSR0_32 300 /* each VSR reg occupies 4 slots in 32-bit */
da80d460	285	#endif /* __powerpc64__ */
da80d460	286	#endif /* _ASM_POWERPC_PTRACE_H */