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

/* thread_info.h: low-level thread information
 *
 * Copyright (C) 2002  David Howells (dhowells@redhat.com)
 * - Incorporating suggestions made by Linus Torvalds and Dave Miller
 */

#ifndef _ASM_X86_THREAD_INFO_H
#define _ASM_X86_THREAD_INFO_H

#include <linux/compiler.h>
#include <asm/page.h>
#include <asm/percpu.h>
#include <asm/types.h>

/*
 * TOP_OF_KERNEL_STACK_PADDING is a number of unused bytes that we
 * reserve at the top of the kernel stack.  We do it because of a nasty
 * 32-bit corner case.  On x86_32, the hardware stack frame is
 * variable-length.  Except for vm86 mode, struct pt_regs assumes a
 * maximum-length frame.  If we enter from CPL 0, the top 8 bytes of
 * pt_regs don't actually exist.  Ordinarily this doesn't matter, but it
 * does in at least one case:
 *
 * If we take an NMI early enough in SYSENTER, then we can end up with
 * pt_regs that extends above sp0.  On the way out, in the espfix code,
 * we can read the saved SS value, but that value will be above sp0.
 * Without this offset, that can result in a page fault.  (We are
 * careful that, in this case, the value we read doesn't matter.)
 *
 * In vm86 mode, the hardware frame is much longer still, so add 16
 * bytes to make room for the real-mode segments.
 *
 * x86_64 has a fixed-length stack frame.
 */
#ifdef CONFIG_X86_32
# ifdef CONFIG_VM86
#  define TOP_OF_KERNEL_STACK_PADDING 16
# else
#  define TOP_OF_KERNEL_STACK_PADDING 8
# endif
#else
# define TOP_OF_KERNEL_STACK_PADDING 0
#endif

/*
 * low level task data that entry.S needs immediate access to
 * - this struct should fit entirely inside of one cache line
 * - this struct shares the supervisor stack pages
 */
#ifndef __ASSEMBLY__
struct task_struct;
#include <asm/cpufeature.h>
#include <linux/atomic.h>

struct thread_info {
	unsigned long		flags;		/* low level flags */
};

#define INIT_THREAD_INFO(tsk)			\
{						\
	.flags		= 0,			\
}

#define init_stack		(init_thread_union.stack)

#else /* !__ASSEMBLY__ */

#include <asm/asm-offsets.h>

#endif

/*
 * thread information flags
 * - these are process state flags that various assembly files
 *   may need to access
 * - pending work-to-be-done flags are in LSW
 * - other flags in MSW
 * Warning: layout of LSW is hardcoded in entry.S
 */
#define TIF_SYSCALL_TRACE	0	/* syscall trace active */
#define TIF_NOTIFY_RESUME	1	/* callback before returning to user */
#define TIF_SIGPENDING		2	/* signal pending */
#define TIF_NEED_RESCHED	3	/* rescheduling necessary */
#define TIF_SINGLESTEP		4	/* reenable singlestep on user return*/
#define TIF_SYSCALL_EMU		6	/* syscall emulation active */
#define TIF_SYSCALL_AUDIT	7	/* syscall auditing active */
#define TIF_SECCOMP		8	/* secure computing */
#define TIF_USER_RETURN_NOTIFY	11	/* notify kernel of userspace return */
#define TIF_UPROBE		12	/* breakpointed or singlestepping */
#define TIF_NOCPUID		15	/* CPUID is not accessible in userland */
#define TIF_NOTSC		16	/* TSC is not accessible in userland */
#define TIF_IA32		17	/* IA32 compatibility process */
#define TIF_NOHZ		19	/* in adaptive nohz mode */
#define TIF_MEMDIE		20	/* is terminating due to OOM killer */
#define TIF_POLLING_NRFLAG	21	/* idle is polling for TIF_NEED_RESCHED */
#define TIF_IO_BITMAP		22	/* uses I/O bitmap */
#define TIF_FORCED_TF		24	/* true if TF in eflags artificially */
#define TIF_BLOCKSTEP		25	/* set when we want DEBUGCTLMSR_BTF */
#define TIF_LAZY_MMU_UPDATES	27	/* task is updating the mmu lazily */
#define TIF_SYSCALL_TRACEPOINT	28	/* syscall tracepoint instrumentation */
#define TIF_ADDR32		29	/* 32-bit address space on 64 bits */
#define TIF_X32			30	/* 32-bit native x86-64 binary */

#define _TIF_SYSCALL_TRACE	(1 << TIF_SYSCALL_TRACE)
#define _TIF_NOTIFY_RESUME	(1 << TIF_NOTIFY_RESUME)
#define _TIF_SIGPENDING		(1 << TIF_SIGPENDING)
#define _TIF_SINGLESTEP		(1 << TIF_SINGLESTEP)
#define _TIF_NEED_RESCHED	(1 << TIF_NEED_RESCHED)
#define _TIF_SYSCALL_EMU	(1 << TIF_SYSCALL_EMU)
#define _TIF_SYSCALL_AUDIT	(1 << TIF_SYSCALL_AUDIT)
#define _TIF_SECCOMP		(1 << TIF_SECCOMP)
#define _TIF_USER_RETURN_NOTIFY	(1 << TIF_USER_RETURN_NOTIFY)
#define _TIF_UPROBE		(1 << TIF_UPROBE)
#define _TIF_NOCPUID		(1 << TIF_NOCPUID)
#define _TIF_NOTSC		(1 << TIF_NOTSC)
#define _TIF_IA32		(1 << TIF_IA32)
#define _TIF_NOHZ		(1 << TIF_NOHZ)
#define _TIF_POLLING_NRFLAG	(1 << TIF_POLLING_NRFLAG)
#define _TIF_IO_BITMAP		(1 << TIF_IO_BITMAP)
#define _TIF_FORCED_TF		(1 << TIF_FORCED_TF)
#define _TIF_BLOCKSTEP		(1 << TIF_BLOCKSTEP)
#define _TIF_LAZY_MMU_UPDATES	(1 << TIF_LAZY_MMU_UPDATES)
#define _TIF_SYSCALL_TRACEPOINT	(1 << TIF_SYSCALL_TRACEPOINT)
#define _TIF_ADDR32		(1 << TIF_ADDR32)
#define _TIF_X32		(1 << TIF_X32)

/*
 * work to do in syscall_trace_enter().  Also includes TIF_NOHZ for
 * enter_from_user_mode()
 */
#define _TIF_WORK_SYSCALL_ENTRY	\
	(_TIF_SYSCALL_TRACE | _TIF_SYSCALL_EMU | _TIF_SYSCALL_AUDIT |	\
	 _TIF_SECCOMP | _TIF_SYSCALL_TRACEPOINT |	\
	 _TIF_NOHZ)

/* work to do on any return to user space */
#define _TIF_ALLWORK_MASK						\
	((0x0000FFFF & ~_TIF_SECCOMP) | _TIF_SYSCALL_TRACEPOINT |	\
	_TIF_NOHZ)

/* flags to check in __switch_to() */
#define _TIF_WORK_CTXSW							\
	(_TIF_IO_BITMAP|_TIF_NOCPUID|_TIF_NOTSC|_TIF_BLOCKSTEP)

#define _TIF_WORK_CTXSW_PREV (_TIF_WORK_CTXSW|_TIF_USER_RETURN_NOTIFY)
#define _TIF_WORK_CTXSW_NEXT (_TIF_WORK_CTXSW)

#define STACK_WARN		(THREAD_SIZE/8)

/*
 * macros/functions for gaining access to the thread information structure
 *
 * preempt_count needs to be 1 initially, until the scheduler is functional.
 */
#ifndef __ASSEMBLY__

static inline unsigned long current_stack_pointer(void)
{
	unsigned long sp;
#ifdef CONFIG_X86_64
	asm("mov %%rsp,%0" : "=g" (sp));
#else
	asm("mov %%esp,%0" : "=g" (sp));
#endif
	return sp;
}

/*
 * Walks up the stack frames to make sure that the specified object is
 * entirely contained by a single stack frame.
 *
 * Returns:
 *		 1 if within a frame
 *		-1 if placed across a frame boundary (or outside stack)
 *		 0 unable to determine (no frame pointers, etc)
 */
static inline int arch_within_stack_frames(const void * const stack,
					   const void * const stackend,
					   const void *obj, unsigned long len)
{
#if defined(CONFIG_FRAME_POINTER)
	const void *frame = NULL;
	const void *oldframe;

	oldframe = __builtin_frame_address(1);
	if (oldframe)
		frame = __builtin_frame_address(2);
	/*
	 * low ----------------------------------------------> high
	 * [saved bp][saved ip][args][local vars][saved bp][saved ip]
	 *                     ^----------------^
	 *               allow copies only within here
	 */
	while (stack <= frame && frame < stackend) {
		/*
		 * If obj + len extends past the last frame, this
		 * check won't pass and the next frame will be 0,
		 * causing us to bail out and correctly report
		 * the copy as invalid.
		 */
		if (obj + len <= frame)
			return obj >= oldframe + 2 * sizeof(void *) ? 1 : -1;
		oldframe = frame;
		frame = *(const void * const *)frame;
	}
	return -1;
#else
	return 0;
#endif
}

#else /* !__ASSEMBLY__ */

#ifdef CONFIG_X86_64
# define cpu_current_top_of_stack (cpu_tss + TSS_sp0)
#endif

#endif

#ifdef CONFIG_COMPAT
#define TS_I386_REGS_POKED	0x0004	/* regs poked by 32-bit ptracer */
#endif
#ifndef __ASSEMBLY__

#ifdef CONFIG_X86_32
#define in_ia32_syscall() true
#else
#define in_ia32_syscall() (IS_ENABLED(CONFIG_IA32_EMULATION) && \
			   current->thread.status & TS_COMPAT)
#endif

/*
 * Force syscall return via IRET by making it look as if there was
 * some work pending. IRET is our most capable (but slowest) syscall
 * return path, which is able to restore modified SS, CS and certain
 * EFLAGS values that other (fast) syscall return instructions
 * are not able to restore properly.
 */
#define force_iret() set_thread_flag(TIF_NOTIFY_RESUME)

extern void arch_task_cache_init(void);
extern int arch_dup_task_struct(struct task_struct *dst, struct task_struct *src);
extern void arch_release_task_struct(struct task_struct *tsk);
extern void arch_setup_new_exec(void);
#define arch_setup_new_exec arch_setup_new_exec
#endif	/* !__ASSEMBLY__ */

#endif /* _ASM_X86_THREAD_INFO_H */
Commit	Line	Data
2052e8d4 CL	1	/* thread_info.h: low-level thread information
	2	*
	3	* Copyright (C) 2002 David Howells (dhowells@redhat.com)
	4	* - Incorporating suggestions made by Linus Torvalds and Dave Miller
	5	*/
	6
1965aae3 PA	7	#ifndef _ASM_X86_THREAD_INFO_H
1965aae3 PA	8	#define _ASM_X86_THREAD_INFO_H
2052e8d4	9
2052e8d4 CL	10	#include <linux/compiler.h>
2052e8d4 CL	11	#include <asm/page.h>
198d208d	12	#include <asm/percpu.h>
12a638e1 CL	13	#include <asm/types.h>
12a638e1 CL	14
3ee4298f AL	15	/*
	16	* TOP_OF_KERNEL_STACK_PADDING is a number of unused bytes that we
	17	* reserve at the top of the kernel stack. We do it because of a nasty
	18	* 32-bit corner case. On x86_32, the hardware stack frame is
	19	* variable-length. Except for vm86 mode, struct pt_regs assumes a
	20	* maximum-length frame. If we enter from CPL 0, the top 8 bytes of
	21	* pt_regs don't actually exist. Ordinarily this doesn't matter, but it
	22	* does in at least one case:
	23	*
	24	* If we take an NMI early enough in SYSENTER, then we can end up with
	25	* pt_regs that extends above sp0. On the way out, in the espfix code,
	26	* we can read the saved SS value, but that value will be above sp0.
	27	* Without this offset, that can result in a page fault. (We are
	28	* careful that, in this case, the value we read doesn't matter.)
	29	*
5ed92a8a BG	30	* In vm86 mode, the hardware frame is much longer still, so add 16
5ed92a8a BG	31	* bytes to make room for the real-mode segments.
3ee4298f AL	32	*
	33	* x86_64 has a fixed-length stack frame.
	34	*/
	35	#ifdef CONFIG_X86_32
5ed92a8a BG	36	# ifdef CONFIG_VM86
	37	# define TOP_OF_KERNEL_STACK_PADDING 16
	38	# else
	39	# define TOP_OF_KERNEL_STACK_PADDING 8
	40	# endif
3ee4298f AL	41	#else
	42	# define TOP_OF_KERNEL_STACK_PADDING 0
	43	#endif
	44
2052e8d4 CL	45	/*
	46	* low level task data that entry.S needs immediate access to
	47	* - this struct should fit entirely inside of one cache line
	48	* - this struct shares the supervisor stack pages
2052e8d4 CL	49	*/
2052e8d4 CL	50	#ifndef __ASSEMBLY__
006c484b	51	struct task_struct;
cd4d09ec	52	#include <asm/cpufeature.h>
60063497	53	#include <linux/atomic.h>
2052e8d4	54
c8061485 HC	55	struct thread_info {
	56	unsigned long flags; /* low level flags */
	57	};
	58
	59	#define INIT_THREAD_INFO(tsk) \
	60	{ \
	61	.flags = 0, \
	62	}
	63
3351cc03 CL	64	#define init_stack (init_thread_union.stack)
3351cc03 CL	65
2052e8d4 CL	66	#else /* !__ASSEMBLY__ */
	67
	68	#include <asm/asm-offsets.h>
	69
	70	#endif
	71
e57549b0 CL	72	/*
	73	* thread information flags
	74	* - these are process state flags that various assembly files
	75	* may need to access
	76	* - pending work-to-be-done flags are in LSW
	77	* - other flags in MSW
	78	* Warning: layout of LSW is hardcoded in entry.S
	79	*/
	80	#define TIF_SYSCALL_TRACE 0 /* syscall trace active */
59e52130	81	#define TIF_NOTIFY_RESUME 1 /* callback before returning to user */
e57549b0 CL	82	#define TIF_SIGPENDING 2 /* signal pending */
	83	#define TIF_NEED_RESCHED 3 /* rescheduling necessary */
	84	#define TIF_SINGLESTEP 4 /* reenable singlestep on user return*/
e57549b0	85	#define TIF_SYSCALL_EMU 6 /* syscall emulation active */
e57549b0 CL	86	#define TIF_SYSCALL_AUDIT 7 /* syscall auditing active */
e57549b0 CL	87	#define TIF_SECCOMP 8 /* secure computing */
7c68af6e	88	#define TIF_USER_RETURN_NOTIFY 11 /* notify kernel of userspace return */
0326f5a9	89	#define TIF_UPROBE 12 /* breakpointed or singlestepping */
e9ea1e7f	90	#define TIF_NOCPUID 15 /* CPUID is not accessible in userland */
e57549b0	91	#define TIF_NOTSC 16 /* TSC is not accessible in userland */
6bd33008	92	#define TIF_IA32 17 /* IA32 compatibility process */
bf5a3c13	93	#define TIF_NOHZ 19 /* in adaptive nohz mode */
0ddc9324	94	#define TIF_MEMDIE 20 /* is terminating due to OOM killer */
f80c5b39	95	#define TIF_POLLING_NRFLAG 21 /* idle is polling for TIF_NEED_RESCHED */
e57549b0	96	#define TIF_IO_BITMAP 22 /* uses I/O bitmap */
e57549b0	97	#define TIF_FORCED_TF 24 /* true if TF in eflags artificially */
ea8e61b7	98	#define TIF_BLOCKSTEP 25 /* set when we want DEBUGCTLMSR_BTF */
b407fc57	99	#define TIF_LAZY_MMU_UPDATES 27 /* task is updating the mmu lazily */
66700001	100	#define TIF_SYSCALL_TRACEPOINT 28 /* syscall tracepoint instrumentation */
6bd33008	101	#define TIF_ADDR32 29 /* 32-bit address space on 64 bits */
bb212724	102	#define TIF_X32 30 /* 32-bit native x86-64 binary */
e57549b0 CL	103
e57549b0 CL	104	#define _TIF_SYSCALL_TRACE (1 << TIF_SYSCALL_TRACE)
59e52130	105	#define _TIF_NOTIFY_RESUME (1 << TIF_NOTIFY_RESUME)
e57549b0 CL	106	#define _TIF_SIGPENDING (1 << TIF_SIGPENDING)
	107	#define _TIF_SINGLESTEP (1 << TIF_SINGLESTEP)
	108	#define _TIF_NEED_RESCHED (1 << TIF_NEED_RESCHED)
e57549b0	109	#define _TIF_SYSCALL_EMU (1 << TIF_SYSCALL_EMU)
e57549b0 CL	110	#define _TIF_SYSCALL_AUDIT (1 << TIF_SYSCALL_AUDIT)
e57549b0 CL	111	#define _TIF_SECCOMP (1 << TIF_SECCOMP)
7c68af6e	112	#define _TIF_USER_RETURN_NOTIFY (1 << TIF_USER_RETURN_NOTIFY)
0326f5a9	113	#define _TIF_UPROBE (1 << TIF_UPROBE)
e9ea1e7f	114	#define _TIF_NOCPUID (1 << TIF_NOCPUID)
e57549b0 CL	115	#define _TIF_NOTSC (1 << TIF_NOTSC)
e57549b0 CL	116	#define _TIF_IA32 (1 << TIF_IA32)
bf5a3c13	117	#define _TIF_NOHZ (1 << TIF_NOHZ)
f80c5b39	118	#define _TIF_POLLING_NRFLAG (1 << TIF_POLLING_NRFLAG)
e57549b0	119	#define _TIF_IO_BITMAP (1 << TIF_IO_BITMAP)
e57549b0	120	#define _TIF_FORCED_TF (1 << TIF_FORCED_TF)
ea8e61b7	121	#define _TIF_BLOCKSTEP (1 << TIF_BLOCKSTEP)
b407fc57	122	#define _TIF_LAZY_MMU_UPDATES (1 << TIF_LAZY_MMU_UPDATES)
66700001	123	#define _TIF_SYSCALL_TRACEPOINT (1 << TIF_SYSCALL_TRACEPOINT)
6bd33008	124	#define _TIF_ADDR32 (1 << TIF_ADDR32)
bb212724	125	#define _TIF_X32 (1 << TIF_X32)
e57549b0	126
9999c8c0 AL	127	/*
	128	* work to do in syscall_trace_enter(). Also includes TIF_NOHZ for
	129	* enter_from_user_mode()
	130	*/
d4d67150	131	#define _TIF_WORK_SYSCALL_ENTRY \
66700001	132	(_TIF_SYSCALL_TRACE \| _TIF_SYSCALL_EMU \| _TIF_SYSCALL_AUDIT \| \
392a6254	133	_TIF_SECCOMP \| _TIF_SYSCALL_TRACEPOINT \| \
bf5a3c13	134	_TIF_NOHZ)
d4d67150	135
00c1bb13	136	/* work to do on any return to user space */
66700001	137	#define _TIF_ALLWORK_MASK \
bf5a3c13 FW	138	((0x0000FFFF & ~_TIF_SECCOMP) \| _TIF_SYSCALL_TRACEPOINT \| \
bf5a3c13 FW	139	_TIF_NOHZ)
00c1bb13	140
00c1bb13 CL	141	/* flags to check in __switch_to() */
00c1bb13 CL	142	#define _TIF_WORK_CTXSW \
e9ea1e7f	143	(_TIF_IO_BITMAP\|_TIF_NOCPUID\|_TIF_NOTSC\|_TIF_BLOCKSTEP)
00c1bb13	144
7c68af6e	145	#define _TIF_WORK_CTXSW_PREV (_TIF_WORK_CTXSW\|_TIF_USER_RETURN_NOTIFY)
37f07655	146	#define _TIF_WORK_CTXSW_NEXT (_TIF_WORK_CTXSW)
00c1bb13	147
198d208d	148	#define STACK_WARN (THREAD_SIZE/8)
b84200b3	149
2052e8d4 CL	150	/*
	151	* macros/functions for gaining access to the thread information structure
	152	*
	153	* preempt_count needs to be 1 initially, until the scheduler is functional.
	154	*/
	155	#ifndef __ASSEMBLY__
	156
83653c16 AL	157	static inline unsigned long current_stack_pointer(void)
	158	{
	159	unsigned long sp;
	160	#ifdef CONFIG_X86_64
	161	asm("mov %%rsp,%0" : "=g" (sp));
	162	#else
	163	asm("mov %%esp,%0" : "=g" (sp));
	164	#endif
	165	return sp;
	166	}
	167
0f60a8ef KC	168	/*
	169	* Walks up the stack frames to make sure that the specified object is
	170	* entirely contained by a single stack frame.
	171	*
	172	* Returns:
	173	* 1 if within a frame
	174	* -1 if placed across a frame boundary (or outside stack)
	175	* 0 unable to determine (no frame pointers, etc)
	176	*/
	177	static inline int arch_within_stack_frames(const void * const stack,
	178	const void * const stackend,
	179	const void *obj, unsigned long len)
	180	{
	181	#if defined(CONFIG_FRAME_POINTER)
	182	const void *frame = NULL;
	183	const void *oldframe;
	184
	185	oldframe = __builtin_frame_address(1);
	186	if (oldframe)
	187	frame = __builtin_frame_address(2);
	188	/*
	189	* low ----------------------------------------------> high
	190	* [saved bp][saved ip][args][local vars][saved bp][saved ip]
	191	* ^----------------^
	192	* allow copies only within here
	193	*/
	194	while (stack <= frame && frame < stackend) {
	195	/*
	196	* If obj + len extends past the last frame, this
	197	* check won't pass and the next frame will be 0,
	198	* causing us to bail out and correctly report
	199	* the copy as invalid.
	200	*/
	201	if (obj + len <= frame)
	202	return obj >= oldframe + 2 * sizeof(void *) ? 1 : -1;
	203	oldframe = frame;
	204	frame = (const void const *)frame;
	205	}
	206	return -1;
	207	#else
	208	return 0;
	209	#endif
	210	}
	211
2052e8d4 CL	212	#else /* !__ASSEMBLY__ */
2052e8d4 CL	213
3a23208e DV	214	#ifdef CONFIG_X86_64
	215	# define cpu_current_top_of_stack (cpu_tss + TSS_sp0)
	216	#endif
	217
2052e8d4 CL	218	#endif
2052e8d4 CL	219
609c19a3 AL	220	#ifdef CONFIG_COMPAT
	221	#define TS_I386_REGS_POKED 0x0004 /* regs poked by 32-bit ptracer */
	222	#endif
8a6c160a	223	#ifndef __ASSEMBLY__
ef334a20	224
ef334a20	225	#ifdef CONFIG_X86_32
b9d989c7 AL	226	#define in_ia32_syscall() true
	227	#else
	228	#define in_ia32_syscall() (IS_ENABLED(CONFIG_IA32_EMULATION) && \
	229	current->thread.status & TS_COMPAT)
ef334a20	230	#endif
1daeaa31 BG	231
	232	/*
	233	* Force syscall return via IRET by making it look as if there was
	234	* some work pending. IRET is our most capable (but slowest) syscall
	235	* return path, which is able to restore modified SS, CS and certain
	236	* EFLAGS values that other (fast) syscall return instructions
	237	* are not able to restore properly.
	238	*/
	239	#define force_iret() set_thread_flag(TIF_NOTIFY_RESUME)
	240
61c4628b	241	extern void arch_task_cache_init(void);
61c4628b	242	extern int arch_dup_task_struct(struct task_struct dst, struct task_struct src);
38e7c572	243	extern void arch_release_task_struct(struct task_struct *tsk);
e9ea1e7f KH	244	extern void arch_setup_new_exec(void);
e9ea1e7f KH	245	#define arch_setup_new_exec arch_setup_new_exec
5f870a3f BP	246	#endif /* !__ASSEMBLY__ */
5f870a3f BP	247
1965aae3	248	#endif /* _ASM_X86_THREAD_INFO_H */