xref: /openbmc/linux/arch/x86/include/asm/thread_info.h (revision dfa9a942)
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 
7 #ifndef _ASM_X86_THREAD_INFO_H
8 #define _ASM_X86_THREAD_INFO_H
9 
10 #include <linux/compiler.h>
11 #include <asm/page.h>
12 #include <asm/percpu.h>
13 #include <asm/types.h>
14 
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  *
30  * In vm86 mode, the hardware frame is much longer still, so add 16
31  * bytes to make room for the real-mode segments.
32  *
33  * x86_64 has a fixed-length stack frame.
34  */
35 #ifdef CONFIG_X86_32
36 # ifdef CONFIG_VM86
37 #  define TOP_OF_KERNEL_STACK_PADDING 16
38 # else
39 #  define TOP_OF_KERNEL_STACK_PADDING 8
40 # endif
41 #else
42 # define TOP_OF_KERNEL_STACK_PADDING 0
43 #endif
44 
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
49  */
50 #ifndef __ASSEMBLY__
51 struct task_struct;
52 #include <asm/cpufeature.h>
53 #include <linux/atomic.h>
54 
55 struct thread_info {
56 	struct task_struct	*task;		/* main task structure */
57 	__u32			flags;		/* low level flags */
58 	__u32			status;		/* thread synchronous flags */
59 	__u32			cpu;		/* current CPU */
60 	mm_segment_t		addr_limit;
61 };
62 
63 #define INIT_THREAD_INFO(tsk)			\
64 {						\
65 	.task		= &tsk,			\
66 	.flags		= 0,			\
67 	.cpu		= 0,			\
68 	.addr_limit	= KERNEL_DS,		\
69 }
70 
71 #define init_thread_info	(init_thread_union.thread_info)
72 #define init_stack		(init_thread_union.stack)
73 
74 #else /* !__ASSEMBLY__ */
75 
76 #include <asm/asm-offsets.h>
77 
78 #endif
79 
80 /*
81  * thread information flags
82  * - these are process state flags that various assembly files
83  *   may need to access
84  * - pending work-to-be-done flags are in LSW
85  * - other flags in MSW
86  * Warning: layout of LSW is hardcoded in entry.S
87  */
88 #define TIF_SYSCALL_TRACE	0	/* syscall trace active */
89 #define TIF_NOTIFY_RESUME	1	/* callback before returning to user */
90 #define TIF_SIGPENDING		2	/* signal pending */
91 #define TIF_NEED_RESCHED	3	/* rescheduling necessary */
92 #define TIF_SINGLESTEP		4	/* reenable singlestep on user return*/
93 #define TIF_SYSCALL_EMU		6	/* syscall emulation active */
94 #define TIF_SYSCALL_AUDIT	7	/* syscall auditing active */
95 #define TIF_SECCOMP		8	/* secure computing */
96 #define TIF_USER_RETURN_NOTIFY	11	/* notify kernel of userspace return */
97 #define TIF_UPROBE		12	/* breakpointed or singlestepping */
98 #define TIF_NOTSC		16	/* TSC is not accessible in userland */
99 #define TIF_IA32		17	/* IA32 compatibility process */
100 #define TIF_FORK		18	/* ret_from_fork */
101 #define TIF_NOHZ		19	/* in adaptive nohz mode */
102 #define TIF_MEMDIE		20	/* is terminating due to OOM killer */
103 #define TIF_POLLING_NRFLAG	21	/* idle is polling for TIF_NEED_RESCHED */
104 #define TIF_IO_BITMAP		22	/* uses I/O bitmap */
105 #define TIF_FORCED_TF		24	/* true if TF in eflags artificially */
106 #define TIF_BLOCKSTEP		25	/* set when we want DEBUGCTLMSR_BTF */
107 #define TIF_LAZY_MMU_UPDATES	27	/* task is updating the mmu lazily */
108 #define TIF_SYSCALL_TRACEPOINT	28	/* syscall tracepoint instrumentation */
109 #define TIF_ADDR32		29	/* 32-bit address space on 64 bits */
110 #define TIF_X32			30	/* 32-bit native x86-64 binary */
111 
112 #define _TIF_SYSCALL_TRACE	(1 << TIF_SYSCALL_TRACE)
113 #define _TIF_NOTIFY_RESUME	(1 << TIF_NOTIFY_RESUME)
114 #define _TIF_SIGPENDING		(1 << TIF_SIGPENDING)
115 #define _TIF_SINGLESTEP		(1 << TIF_SINGLESTEP)
116 #define _TIF_NEED_RESCHED	(1 << TIF_NEED_RESCHED)
117 #define _TIF_SYSCALL_EMU	(1 << TIF_SYSCALL_EMU)
118 #define _TIF_SYSCALL_AUDIT	(1 << TIF_SYSCALL_AUDIT)
119 #define _TIF_SECCOMP		(1 << TIF_SECCOMP)
120 #define _TIF_USER_RETURN_NOTIFY	(1 << TIF_USER_RETURN_NOTIFY)
121 #define _TIF_UPROBE		(1 << TIF_UPROBE)
122 #define _TIF_NOTSC		(1 << TIF_NOTSC)
123 #define _TIF_IA32		(1 << TIF_IA32)
124 #define _TIF_FORK		(1 << TIF_FORK)
125 #define _TIF_NOHZ		(1 << TIF_NOHZ)
126 #define _TIF_POLLING_NRFLAG	(1 << TIF_POLLING_NRFLAG)
127 #define _TIF_IO_BITMAP		(1 << TIF_IO_BITMAP)
128 #define _TIF_FORCED_TF		(1 << TIF_FORCED_TF)
129 #define _TIF_BLOCKSTEP		(1 << TIF_BLOCKSTEP)
130 #define _TIF_LAZY_MMU_UPDATES	(1 << TIF_LAZY_MMU_UPDATES)
131 #define _TIF_SYSCALL_TRACEPOINT	(1 << TIF_SYSCALL_TRACEPOINT)
132 #define _TIF_ADDR32		(1 << TIF_ADDR32)
133 #define _TIF_X32		(1 << TIF_X32)
134 
135 /*
136  * work to do in syscall_trace_enter().  Also includes TIF_NOHZ for
137  * enter_from_user_mode()
138  */
139 #define _TIF_WORK_SYSCALL_ENTRY	\
140 	(_TIF_SYSCALL_TRACE | _TIF_SYSCALL_EMU | _TIF_SYSCALL_AUDIT |	\
141 	 _TIF_SECCOMP | _TIF_SYSCALL_TRACEPOINT |	\
142 	 _TIF_NOHZ)
143 
144 /* work to do on any return to user space */
145 #define _TIF_ALLWORK_MASK						\
146 	((0x0000FFFF & ~_TIF_SECCOMP) | _TIF_SYSCALL_TRACEPOINT |	\
147 	_TIF_NOHZ)
148 
149 /* flags to check in __switch_to() */
150 #define _TIF_WORK_CTXSW							\
151 	(_TIF_IO_BITMAP|_TIF_NOTSC|_TIF_BLOCKSTEP)
152 
153 #define _TIF_WORK_CTXSW_PREV (_TIF_WORK_CTXSW|_TIF_USER_RETURN_NOTIFY)
154 #define _TIF_WORK_CTXSW_NEXT (_TIF_WORK_CTXSW)
155 
156 #define STACK_WARN		(THREAD_SIZE/8)
157 
158 /*
159  * macros/functions for gaining access to the thread information structure
160  *
161  * preempt_count needs to be 1 initially, until the scheduler is functional.
162  */
163 #ifndef __ASSEMBLY__
164 
165 static inline struct thread_info *current_thread_info(void)
166 {
167 	return (struct thread_info *)(current_top_of_stack() - THREAD_SIZE);
168 }
169 
170 static inline unsigned long current_stack_pointer(void)
171 {
172 	unsigned long sp;
173 #ifdef CONFIG_X86_64
174 	asm("mov %%rsp,%0" : "=g" (sp));
175 #else
176 	asm("mov %%esp,%0" : "=g" (sp));
177 #endif
178 	return sp;
179 }
180 
181 #else /* !__ASSEMBLY__ */
182 
183 #ifdef CONFIG_X86_64
184 # define cpu_current_top_of_stack (cpu_tss + TSS_sp0)
185 #endif
186 
187 /* Load thread_info address into "reg" */
188 #define GET_THREAD_INFO(reg) \
189 	_ASM_MOV PER_CPU_VAR(cpu_current_top_of_stack),reg ; \
190 	_ASM_SUB $(THREAD_SIZE),reg ;
191 
192 /*
193  * ASM operand which evaluates to a 'thread_info' address of
194  * the current task, if it is known that "reg" is exactly "off"
195  * bytes below the top of the stack currently.
196  *
197  * ( The kernel stack's size is known at build time, it is usually
198  *   2 or 4 pages, and the bottom  of the kernel stack contains
199  *   the thread_info structure. So to access the thread_info very
200  *   quickly from assembly code we can calculate down from the
201  *   top of the kernel stack to the bottom, using constant,
202  *   build-time calculations only. )
203  *
204  * For example, to fetch the current thread_info->flags value into %eax
205  * on x86-64 defconfig kernels, in syscall entry code where RSP is
206  * currently at exactly SIZEOF_PTREGS bytes away from the top of the
207  * stack:
208  *
209  *      mov ASM_THREAD_INFO(TI_flags, %rsp, SIZEOF_PTREGS), %eax
210  *
211  * will translate to:
212  *
213  *      8b 84 24 b8 c0 ff ff      mov    -0x3f48(%rsp), %eax
214  *
215  * which is below the current RSP by almost 16K.
216  */
217 #define ASM_THREAD_INFO(field, reg, off) ((field)+(off)-THREAD_SIZE)(reg)
218 
219 #endif
220 
221 /*
222  * Thread-synchronous status.
223  *
224  * This is different from the flags in that nobody else
225  * ever touches our thread-synchronous status, so we don't
226  * have to worry about atomic accesses.
227  */
228 #define TS_COMPAT		0x0002	/* 32bit syscall active (64BIT)*/
229 #define TS_RESTORE_SIGMASK	0x0008	/* restore signal mask in do_signal() */
230 
231 #ifndef __ASSEMBLY__
232 #define HAVE_SET_RESTORE_SIGMASK	1
233 static inline void set_restore_sigmask(void)
234 {
235 	struct thread_info *ti = current_thread_info();
236 	ti->status |= TS_RESTORE_SIGMASK;
237 	WARN_ON(!test_bit(TIF_SIGPENDING, (unsigned long *)&ti->flags));
238 }
239 static inline void clear_restore_sigmask(void)
240 {
241 	current_thread_info()->status &= ~TS_RESTORE_SIGMASK;
242 }
243 static inline bool test_restore_sigmask(void)
244 {
245 	return current_thread_info()->status & TS_RESTORE_SIGMASK;
246 }
247 static inline bool test_and_clear_restore_sigmask(void)
248 {
249 	struct thread_info *ti = current_thread_info();
250 	if (!(ti->status & TS_RESTORE_SIGMASK))
251 		return false;
252 	ti->status &= ~TS_RESTORE_SIGMASK;
253 	return true;
254 }
255 
256 static inline bool in_ia32_syscall(void)
257 {
258 #ifdef CONFIG_X86_32
259 	return true;
260 #endif
261 #ifdef CONFIG_IA32_EMULATION
262 	if (current_thread_info()->status & TS_COMPAT)
263 		return true;
264 #endif
265 	return false;
266 }
267 
268 /*
269  * Force syscall return via IRET by making it look as if there was
270  * some work pending. IRET is our most capable (but slowest) syscall
271  * return path, which is able to restore modified SS, CS and certain
272  * EFLAGS values that other (fast) syscall return instructions
273  * are not able to restore properly.
274  */
275 #define force_iret() set_thread_flag(TIF_NOTIFY_RESUME)
276 
277 extern void arch_task_cache_init(void);
278 extern int arch_dup_task_struct(struct task_struct *dst, struct task_struct *src);
279 extern void arch_release_task_struct(struct task_struct *tsk);
280 #endif	/* !__ASSEMBLY__ */
281 
282 #endif /* _ASM_X86_THREAD_INFO_H */
283