[mirror_ubuntu-artful-kernel.git] / arch / x86 / include / asm / ptrace.h

#ifndef _ASM_X86_PTRACE_H
#define _ASM_X86_PTRACE_H

#include <linux/compiler.h>	/* For __user */
#include <asm/ptrace-abi.h>
#include <asm/processor-flags.h>

#ifdef __KERNEL__
#include <asm/segment.h>
#include <asm/page_types.h>
#endif

#ifndef __ASSEMBLY__

#ifdef __i386__
/* this struct defines the way the registers are stored on the
   stack during a system call. */

#ifndef __KERNEL__

struct pt_regs {
	long ebx;
	long ecx;
	long edx;
	long esi;
	long edi;
	long ebp;
	long eax;
	int  xds;
	int  xes;
	int  xfs;
	int  xgs;
	long orig_eax;
	long eip;
	int  xcs;
	long eflags;
	long esp;
	int  xss;
};

#else /* __KERNEL__ */

struct pt_regs {
	unsigned long bx;
	unsigned long cx;
	unsigned long dx;
	unsigned long si;
	unsigned long di;
	unsigned long bp;
	unsigned long ax;
	unsigned long ds;
	unsigned long es;
	unsigned long fs;
	unsigned long gs;
	unsigned long orig_ax;
	unsigned long ip;
	unsigned long cs;
	unsigned long flags;
	unsigned long sp;
	unsigned long ss;
};

#endif /* __KERNEL__ */

#else /* __i386__ */

#ifndef __KERNEL__

struct pt_regs {
	unsigned long r15;
	unsigned long r14;
	unsigned long r13;
	unsigned long r12;
	unsigned long rbp;
	unsigned long rbx;
/* arguments: non interrupts/non tracing syscalls only save up to here*/
	unsigned long r11;
	unsigned long r10;
	unsigned long r9;
	unsigned long r8;
	unsigned long rax;
	unsigned long rcx;
	unsigned long rdx;
	unsigned long rsi;
	unsigned long rdi;
	unsigned long orig_rax;
/* end of arguments */
/* cpu exception frame or undefined */
	unsigned long rip;
	unsigned long cs;
	unsigned long eflags;
	unsigned long rsp;
	unsigned long ss;
/* top of stack page */
};

#else /* __KERNEL__ */

struct pt_regs {
	unsigned long r15;
	unsigned long r14;
	unsigned long r13;
	unsigned long r12;
	unsigned long bp;
	unsigned long bx;
/* arguments: non interrupts/non tracing syscalls only save up to here*/
	unsigned long r11;
	unsigned long r10;
	unsigned long r9;
	unsigned long r8;
	unsigned long ax;
	unsigned long cx;
	unsigned long dx;
	unsigned long si;
	unsigned long di;
	unsigned long orig_ax;
/* end of arguments */
/* cpu exception frame or undefined */
	unsigned long ip;
	unsigned long cs;
	unsigned long flags;
	unsigned long sp;
	unsigned long ss;
/* top of stack page */
};

#endif /* __KERNEL__ */
#endif /* !__i386__ */


#ifdef __KERNEL__

#include <linux/init.h>
#ifdef CONFIG_PARAVIRT
#include <asm/paravirt_types.h>
#endif

struct cpuinfo_x86;
struct task_struct;

extern unsigned long profile_pc(struct pt_regs *regs);
#define profile_pc profile_pc

extern unsigned long
convert_ip_to_linear(struct task_struct *child, struct pt_regs *regs);
extern void send_sigtrap(struct task_struct *tsk, struct pt_regs *regs,
			 int error_code, int si_code);
void signal_fault(struct pt_regs *regs, void __user *frame, char *where);

extern long syscall_trace_enter(struct pt_regs *);
extern void syscall_trace_leave(struct pt_regs *);

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

/*
 * user_mode_vm(regs) determines whether a register set came from user mode.
 * This is true if V8086 mode was enabled OR if the register set was from
 * protected mode with RPL-3 CS value.  This tricky test checks that with
 * one comparison.  Many places in the kernel can bypass this full check
 * if they have already ruled out V8086 mode, so user_mode(regs) can be used.
 */
static inline int user_mode(struct pt_regs *regs)
{
#ifdef CONFIG_X86_32
	return (regs->cs & SEGMENT_RPL_MASK) == USER_RPL;
#else
	return !!(regs->cs & 3);
#endif
}

static inline int user_mode_vm(struct pt_regs *regs)
{
#ifdef CONFIG_X86_32
	return ((regs->cs & SEGMENT_RPL_MASK) | (regs->flags & X86_VM_MASK)) >=
		USER_RPL;
#else
	return user_mode(regs);
#endif
}

static inline int v8086_mode(struct pt_regs *regs)
{
#ifdef CONFIG_X86_32
	return (regs->flags & X86_VM_MASK);
#else
	return 0;	/* No V86 mode support in long mode */
#endif
}

#ifdef CONFIG_X86_64
static inline bool user_64bit_mode(struct pt_regs *regs)
{
#ifndef CONFIG_PARAVIRT
	/*
	 * On non-paravirt systems, this is the only long mode CPL 3
	 * selector.  We do not allow long mode selectors in the LDT.
	 */
	return regs->cs == __USER_CS;
#else
	/* Headers are too twisted for this to go in paravirt.h. */
	return regs->cs == __USER_CS || regs->cs == pv_info.extra_user_64bit_cs;
#endif
}
#endif

/*
 * X86_32 CPUs don't save ss and esp if the CPU is already in kernel mode
 * when it traps.  The previous stack will be directly underneath the saved
 * registers, and 'sp/ss' won't even have been saved. Thus the '&regs->sp'.
 *
 * This is valid only for kernel mode traps.
 */
static inline unsigned long kernel_stack_pointer(struct pt_regs *regs)
{
#ifdef CONFIG_X86_32
	return (unsigned long)(&regs->sp);
#else
	return regs->sp;
#endif
}

#define GET_IP(regs) ((regs)->ip)
#define GET_FP(regs) ((regs)->bp)
#define GET_USP(regs) ((regs)->sp)

#include <asm-generic/ptrace.h>

/* Query offset/name of register from its name/offset */
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, ss))

/**
 * 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. The @offset is the
 * offset of the register in struct pt_regs address which specified by @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 int 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;
}

#define arch_has_single_step()	(1)
#ifdef CONFIG_X86_DEBUGCTLMSR
#define arch_has_block_step()	(1)
#else
#define arch_has_block_step()	(boot_cpu_data.x86 >= 6)
#endif

#define ARCH_HAS_USER_SINGLE_STEP_INFO

struct user_desc;
extern int do_get_thread_area(struct task_struct *p, int idx,
			      struct user_desc __user *info);
extern int do_set_thread_area(struct task_struct *p, int idx,
			      struct user_desc __user *info, int can_allocate);

#endif /* __KERNEL__ */

#endif /* !__ASSEMBLY__ */

#endif /* _ASM_X86_PTRACE_H */
Commit	Line	Data
1965aae3 PA	1	#ifndef _ASM_X86_PTRACE_H
1965aae3 PA	2	#define _ASM_X86_PTRACE_H
8fc37f2c TG	3
	4	#include <linux/compiler.h> /* For __user */
	5	#include <asm/ptrace-abi.h>
6330a30a	6	#include <asm/processor-flags.h>
8fc37f2c	7
6330a30a	8	#ifdef __KERNEL__
6330a30a	9	#include <asm/segment.h>
b1cf540f	10	#include <asm/page_types.h>
6330a30a	11	#endif
eee3af4a	12
8fc37f2c TG	13	#ifndef __ASSEMBLY__
	14
	15	#ifdef __i386__
	16	/* this struct defines the way the registers are stored on the
	17	stack during a system call. */
	18
65ea5b03 PA	19	#ifndef __KERNEL__
65ea5b03 PA	20
8fc37f2c TG	21	struct pt_regs {
	22	long ebx;
	23	long ecx;
	24	long edx;
	25	long esi;
	26	long edi;
	27	long ebp;
	28	long eax;
	29	int xds;
	30	int xes;
	31	int xfs;
ccbeed3a	32	int xgs;
8fc37f2c TG	33	long orig_eax;
	34	long eip;
	35	int xcs;
	36	long eflags;
	37	long esp;
	38	int xss;
	39	};
	40
65ea5b03 PA	41	#else /* __KERNEL__ */
	42
	43	struct pt_regs {
92bc2056 HH	44	unsigned long bx;
	45	unsigned long cx;
	46	unsigned long dx;
	47	unsigned long si;
	48	unsigned long di;
	49	unsigned long bp;
9902a702	50	unsigned long ax;
92bc2056 HH	51	unsigned long ds;
	52	unsigned long es;
	53	unsigned long fs;
ccbeed3a	54	unsigned long gs;
9902a702	55	unsigned long orig_ax;
92bc2056 HH	56	unsigned long ip;
	57	unsigned long cs;
	58	unsigned long flags;
	59	unsigned long sp;
	60	unsigned long ss;
65ea5b03	61	};
8fc37f2c	62
8fc37f2c TG	63	#endif /* __KERNEL__ */
	64
	65	#else /* __i386__ */
	66
65ea5b03 PA	67	#ifndef __KERNEL__
65ea5b03 PA	68
8fc37f2c TG	69	struct pt_regs {
	70	unsigned long r15;
	71	unsigned long r14;
	72	unsigned long r13;
	73	unsigned long r12;
	74	unsigned long rbp;
	75	unsigned long rbx;
0d2eb44f	76	/* arguments: non interrupts/non tracing syscalls only save up to here*/
8fc37f2c TG	77	unsigned long r11;
	78	unsigned long r10;
	79	unsigned long r9;
	80	unsigned long r8;
	81	unsigned long rax;
	82	unsigned long rcx;
	83	unsigned long rdx;
	84	unsigned long rsi;
	85	unsigned long rdi;
	86	unsigned long orig_rax;
	87	/* end of arguments */
	88	/* cpu exception frame or undefined */
	89	unsigned long rip;
	90	unsigned long cs;
	91	unsigned long eflags;
	92	unsigned long rsp;
	93	unsigned long ss;
	94	/* top of stack page */
	95	};
	96
65ea5b03 PA	97	#else /* __KERNEL__ */
	98
	99	struct pt_regs {
	100	unsigned long r15;
	101	unsigned long r14;
	102	unsigned long r13;
	103	unsigned long r12;
	104	unsigned long bp;
	105	unsigned long bx;
0d2eb44f	106	/* arguments: non interrupts/non tracing syscalls only save up to here*/
65ea5b03 PA	107	unsigned long r11;
	108	unsigned long r10;
	109	unsigned long r9;
	110	unsigned long r8;
	111	unsigned long ax;
	112	unsigned long cx;
	113	unsigned long dx;
	114	unsigned long si;
	115	unsigned long di;
	116	unsigned long orig_ax;
	117	/* end of arguments */
	118	/* cpu exception frame or undefined */
	119	unsigned long ip;
	120	unsigned long cs;
	121	unsigned long flags;
	122	unsigned long sp;
	123	unsigned long ss;
	124	/* top of stack page */
	125	};
8fc37f2c	126
dbe3533b HH	127	#endif /* __KERNEL__ */
dbe3533b HH	128	#endif /* !__i386__ */
8fc37f2c	129
93fa7636	130
dbe3533b HH	131	#ifdef __KERNEL__
dbe3533b HH	132
93fa7636	133	#include <linux/init.h>
318f5a2a AL	134	#ifdef CONFIG_PARAVIRT
	135	#include <asm/paravirt_types.h>
	136	#endif
8fc37f2c	137
93fa7636	138	struct cpuinfo_x86;
8fc37f2c TG	139	struct task_struct;
8fc37f2c TG	140
dbe3533b	141	extern unsigned long profile_pc(struct pt_regs *regs);
c46dd6b4	142	#define profile_pc profile_pc
dbe3533b	143
8fc37f2c	144	extern unsigned long
37cd9cf3	145	convert_ip_to_linear(struct task_struct child, struct pt_regs regs);
72f74fa2	146	extern void send_sigtrap(struct task_struct tsk, struct pt_regs regs,
da654b74	147	int error_code, int si_code);
72fa50f4 HS	148	void signal_fault(struct pt_regs regs, void __user frame, char *where);
72fa50f4 HS	149
c1686aea JS	150	extern long syscall_trace_enter(struct pt_regs *);
	151	extern void syscall_trace_leave(struct pt_regs *);
	152
9902a702 HH	153	static inline unsigned long regs_return_value(struct pt_regs *regs)
	154	{
	155	return regs->ax;
	156	}
efd1ca52	157
90d43d72 HH	158	/*
	159	* user_mode_vm(regs) determines whether a register set came from user mode.
	160	* This is true if V8086 mode was enabled OR if the register set was from
	161	* protected mode with RPL-3 CS value. This tricky test checks that with
	162	* one comparison. Many places in the kernel can bypass this full check
	163	* if they have already ruled out V8086 mode, so user_mode(regs) can be used.
	164	*/
	165	static inline int user_mode(struct pt_regs *regs)
	166	{
	167	#ifdef CONFIG_X86_32
	168	return (regs->cs & SEGMENT_RPL_MASK) == USER_RPL;
	169	#else
	170	return !!(regs->cs & 3);
	171	#endif
	172	}
	173
	174	static inline int user_mode_vm(struct pt_regs *regs)
	175	{
	176	#ifdef CONFIG_X86_32
6b6891f9	177	return ((regs->cs & SEGMENT_RPL_MASK) \| (regs->flags & X86_VM_MASK)) >=
72f74fa2	178	USER_RPL;
90d43d72 HH	179	#else
	180	return user_mode(regs);
	181	#endif
	182	}
	183
	184	static inline int v8086_mode(struct pt_regs *regs)
	185	{
	186	#ifdef CONFIG_X86_32
6b6891f9	187	return (regs->flags & X86_VM_MASK);
90d43d72 HH	188	#else
	189	return 0; /* No V86 mode support in long mode */
	190	#endif
	191	}
	192
318f5a2a AL	193	#ifdef CONFIG_X86_64
	194	static inline bool user_64bit_mode(struct pt_regs *regs)
	195	{
	196	#ifndef CONFIG_PARAVIRT
	197	/*
	198	* On non-paravirt systems, this is the only long mode CPL 3
	199	* selector. We do not allow long mode selectors in the LDT.
	200	*/
	201	return regs->cs == __USER_CS;
	202	#else
	203	/* Headers are too twisted for this to go in paravirt.h. */
	204	return regs->cs == __USER_CS \|\| regs->cs == pv_info.extra_user_64bit_cs;
	205	#endif
	206	}
	207	#endif
	208
f6e8e284 HH	209	/*
f6e8e284 HH	210	* X86_32 CPUs don't save ss and esp if the CPU is already in kernel mode
7b6c6c77 MH	211	* when it traps. The previous stack will be directly underneath the saved
7b6c6c77 MH	212	* registers, and 'sp/ss' won't even have been saved. Thus the '&regs->sp'.
f6e8e284 HH	213	*
	214	* This is valid only for kernel mode traps.
	215	*/
7b6c6c77	216	static inline unsigned long kernel_stack_pointer(struct pt_regs *regs)
90d43d72 HH	217	{
90d43d72 HH	218	#ifdef CONFIG_X86_32
7b6c6c77	219	return (unsigned long)(&regs->sp);
90d43d72 HH	220	#else
	221	return regs->sp;
	222	#endif
	223	}
	224
c46dd6b4 MF	225	#define GET_IP(regs) ((regs)->ip)
	226	#define GET_FP(regs) ((regs)->bp)
	227	#define GET_USP(regs) ((regs)->sp)
90d43d72	228
c46dd6b4	229	#include <asm-generic/ptrace.h>
68bd0f4e	230
b1cf540f MH	231	/* Query offset/name of register from its name/offset */
	232	extern int regs_query_register_offset(const char *name);
	233	extern const char *regs_query_register_name(unsigned int offset);
	234	#define MAX_REG_OFFSET (offsetof(struct pt_regs, ss))
	235
	236	/**
	237	* regs_get_register() - get register value from its offset
	238	* @regs: pt_regs from which register value is gotten.
	239	* @offset: offset number of the register.
	240	*
e859cf86 MH	241	* regs_get_register returns the value of a register. The @offset is the
e859cf86 MH	242	* offset of the register in struct pt_regs address which specified by @regs.
b1cf540f MH	243	* If @offset is bigger than MAX_REG_OFFSET, this returns 0.
	244	*/
	245	static inline unsigned long regs_get_register(struct pt_regs *regs,
	246	unsigned int offset)
	247	{
	248	if (unlikely(offset > MAX_REG_OFFSET))
	249	return 0;
	250	return (unsigned long )((unsigned long)regs + offset);
	251	}
	252
	253	/**
	254	* regs_within_kernel_stack() - check the address in the stack
	255	* @regs: pt_regs which contains kernel stack pointer.
	256	* @addr: address which is checked.
	257	*
e859cf86	258	* regs_within_kernel_stack() checks @addr is within the kernel stack page(s).
b1cf540f MH	259	* If @addr is within the kernel stack, it returns true. If not, returns false.
	260	*/
	261	static inline int regs_within_kernel_stack(struct pt_regs *regs,
	262	unsigned long addr)
	263	{
	264	return ((addr & ~(THREAD_SIZE - 1)) ==
	265	(kernel_stack_pointer(regs) & ~(THREAD_SIZE - 1)));
	266	}
	267
	268	/**
	269	* regs_get_kernel_stack_nth() - get Nth entry of the stack
	270	* @regs: pt_regs which contains kernel stack pointer.
	271	* @n: stack entry number.
	272	*
	273	* regs_get_kernel_stack_nth() returns @n th entry of the kernel stack which
e859cf86	274	* is specified by @regs. If the @n th entry is NOT in the kernel stack,
b1cf540f MH	275	* this returns 0.
	276	*/
	277	static inline unsigned long regs_get_kernel_stack_nth(struct pt_regs *regs,
	278	unsigned int n)
	279	{
	280	unsigned long addr = (unsigned long )kernel_stack_pointer(regs);
	281	addr += n;
	282	if (regs_within_kernel_stack(regs, (unsigned long)addr))
	283	return *addr;
	284	else
	285	return 0;
	286	}
	287
7f232343	288	#define arch_has_single_step() (1)
10faa81e RM	289	#ifdef CONFIG_X86_DEBUGCTLMSR
	290	#define arch_has_block_step() (1)
	291	#else
	292	#define arch_has_block_step() (boot_cpu_data.x86 >= 6)
	293	#endif
	294
7f38551f ON	295	#define ARCH_HAS_USER_SINGLE_STEP_INFO
7f38551f ON	296
efd1ca52 RM	297	struct user_desc;
	298	extern int do_get_thread_area(struct task_struct *p, int idx,
	299	struct user_desc __user *info);
	300	extern int do_set_thread_area(struct task_struct *p, int idx,
	301	struct user_desc __user *info, int can_allocate);
	302
	303	#endif /* __KERNEL__ */
	304
8fc37f2c TG	305	#endif /* !__ASSEMBLY__ */
8fc37f2c TG	306
1965aae3	307	#endif /* _ASM_X86_PTRACE_H */