[mirror_ubuntu-jammy-kernel.git] / include / linux / thread_info.h

/* SPDX-License-Identifier: GPL-2.0 */
/* thread_info.h: common low-level thread information accessors
 *
 * Copyright (C) 2002  David Howells (dhowells@redhat.com)
 * - Incorporating suggestions made by Linus Torvalds
 */

#ifndef _LINUX_THREAD_INFO_H
#define _LINUX_THREAD_INFO_H

#include <linux/types.h>
#include <linux/bug.h>
#include <linux/restart_block.h>

#ifdef CONFIG_THREAD_INFO_IN_TASK
/*
 * For CONFIG_THREAD_INFO_IN_TASK kernels we need <asm/current.h> for the
 * definition of current, but for !CONFIG_THREAD_INFO_IN_TASK kernels,
 * including <asm/current.h> can cause a circular dependency on some platforms.
 */
#include <asm/current.h>
#define current_thread_info() ((struct thread_info *)current)
#endif

#include <linux/bitops.h>

/*
 * For per-arch arch_within_stack_frames() implementations, defined in
 * asm/thread_info.h.
 */
enum {
	BAD_STACK = -1,
	NOT_STACK = 0,
	GOOD_FRAME,
	GOOD_STACK,
};

#ifdef CONFIG_GENERIC_ENTRY
enum syscall_work_bit {
	SYSCALL_WORK_BIT_SECCOMP,
	SYSCALL_WORK_BIT_SYSCALL_TRACEPOINT,
	SYSCALL_WORK_BIT_SYSCALL_TRACE,
	SYSCALL_WORK_BIT_SYSCALL_EMU,
	SYSCALL_WORK_BIT_SYSCALL_AUDIT,
	SYSCALL_WORK_BIT_SYSCALL_USER_DISPATCH,
	SYSCALL_WORK_BIT_SYSCALL_EXIT_TRAP,
};

#define SYSCALL_WORK_SECCOMP		BIT(SYSCALL_WORK_BIT_SECCOMP)
#define SYSCALL_WORK_SYSCALL_TRACEPOINT	BIT(SYSCALL_WORK_BIT_SYSCALL_TRACEPOINT)
#define SYSCALL_WORK_SYSCALL_TRACE	BIT(SYSCALL_WORK_BIT_SYSCALL_TRACE)
#define SYSCALL_WORK_SYSCALL_EMU	BIT(SYSCALL_WORK_BIT_SYSCALL_EMU)
#define SYSCALL_WORK_SYSCALL_AUDIT	BIT(SYSCALL_WORK_BIT_SYSCALL_AUDIT)
#define SYSCALL_WORK_SYSCALL_USER_DISPATCH BIT(SYSCALL_WORK_BIT_SYSCALL_USER_DISPATCH)
#define SYSCALL_WORK_SYSCALL_EXIT_TRAP	BIT(SYSCALL_WORK_BIT_SYSCALL_EXIT_TRAP)
#endif

#include <asm/thread_info.h>

#ifdef __KERNEL__

#ifndef THREAD_ALIGN
#define THREAD_ALIGN	THREAD_SIZE
#endif

#define THREADINFO_GFP		(GFP_KERNEL_ACCOUNT | __GFP_ZERO)

/*
 * flag set/clear/test wrappers
 * - pass TIF_xxxx constants to these functions
 */

static inline void set_ti_thread_flag(struct thread_info *ti, int flag)
{
	set_bit(flag, (unsigned long *)&ti->flags);
}

static inline void clear_ti_thread_flag(struct thread_info *ti, int flag)
{
	clear_bit(flag, (unsigned long *)&ti->flags);
}

static inline void update_ti_thread_flag(struct thread_info *ti, int flag,
					 bool value)
{
	if (value)
		set_ti_thread_flag(ti, flag);
	else
		clear_ti_thread_flag(ti, flag);
}

static inline int test_and_set_ti_thread_flag(struct thread_info *ti, int flag)
{
	return test_and_set_bit(flag, (unsigned long *)&ti->flags);
}

static inline int test_and_clear_ti_thread_flag(struct thread_info *ti, int flag)
{
	return test_and_clear_bit(flag, (unsigned long *)&ti->flags);
}

static inline int test_ti_thread_flag(struct thread_info *ti, int flag)
{
	return test_bit(flag, (unsigned long *)&ti->flags);
}

#define set_thread_flag(flag) \
	set_ti_thread_flag(current_thread_info(), flag)
#define clear_thread_flag(flag) \
	clear_ti_thread_flag(current_thread_info(), flag)
#define update_thread_flag(flag, value) \
	update_ti_thread_flag(current_thread_info(), flag, value)
#define test_and_set_thread_flag(flag) \
	test_and_set_ti_thread_flag(current_thread_info(), flag)
#define test_and_clear_thread_flag(flag) \
	test_and_clear_ti_thread_flag(current_thread_info(), flag)
#define test_thread_flag(flag) \
	test_ti_thread_flag(current_thread_info(), flag)

#ifdef CONFIG_GENERIC_ENTRY
#define set_syscall_work(fl) \
	set_bit(SYSCALL_WORK_BIT_##fl, &current_thread_info()->syscall_work)
#define test_syscall_work(fl) \
	test_bit(SYSCALL_WORK_BIT_##fl, &current_thread_info()->syscall_work)
#define clear_syscall_work(fl) \
	clear_bit(SYSCALL_WORK_BIT_##fl, &current_thread_info()->syscall_work)

#define set_task_syscall_work(t, fl) \
	set_bit(SYSCALL_WORK_BIT_##fl, &task_thread_info(t)->syscall_work)
#define test_task_syscall_work(t, fl) \
	test_bit(SYSCALL_WORK_BIT_##fl, &task_thread_info(t)->syscall_work)
#define clear_task_syscall_work(t, fl) \
	clear_bit(SYSCALL_WORK_BIT_##fl, &task_thread_info(t)->syscall_work)

#else /* CONFIG_GENERIC_ENTRY */

#define set_syscall_work(fl)						\
	set_ti_thread_flag(current_thread_info(), TIF_##fl)
#define test_syscall_work(fl) \
	test_ti_thread_flag(current_thread_info(), TIF_##fl)
#define clear_syscall_work(fl) \
	clear_ti_thread_flag(current_thread_info(), TIF_##fl)

#define set_task_syscall_work(t, fl) \
	set_ti_thread_flag(task_thread_info(t), TIF_##fl)
#define test_task_syscall_work(t, fl) \
	test_ti_thread_flag(task_thread_info(t), TIF_##fl)
#define clear_task_syscall_work(t, fl) \
	clear_ti_thread_flag(task_thread_info(t), TIF_##fl)
#endif /* !CONFIG_GENERIC_ENTRY */

#define tif_need_resched() test_thread_flag(TIF_NEED_RESCHED)

#ifndef CONFIG_HAVE_ARCH_WITHIN_STACK_FRAMES
static inline int arch_within_stack_frames(const void * const stack,
					   const void * const stackend,
					   const void *obj, unsigned long len)
{
	return 0;
}
#endif

#ifdef CONFIG_HARDENED_USERCOPY
extern void __check_object_size(const void *ptr, unsigned long n,
					bool to_user);

static __always_inline void check_object_size(const void *ptr, unsigned long n,
					      bool to_user)
{
	if (!__builtin_constant_p(n))
		__check_object_size(ptr, n, to_user);
}
#else
static inline void check_object_size(const void *ptr, unsigned long n,
				     bool to_user)
{ }
#endif /* CONFIG_HARDENED_USERCOPY */

extern void __compiletime_error("copy source size is too small")
__bad_copy_from(void);
extern void __compiletime_error("copy destination size is too small")
__bad_copy_to(void);

static inline void copy_overflow(int size, unsigned long count)
{
	WARN(1, "Buffer overflow detected (%d < %lu)!\n", size, count);
}

static __always_inline __must_check bool
check_copy_size(const void *addr, size_t bytes, bool is_source)
{
	int sz = __compiletime_object_size(addr);
	if (unlikely(sz >= 0 && sz < bytes)) {
		if (!__builtin_constant_p(bytes))
			copy_overflow(sz, bytes);
		else if (is_source)
			__bad_copy_from();
		else
			__bad_copy_to();
		return false;
	}
	if (WARN_ON_ONCE(bytes > INT_MAX))
		return false;
	check_object_size(addr, bytes, is_source);
	return true;
}

#ifndef arch_setup_new_exec
static inline void arch_setup_new_exec(void) { }
#endif

#endif	/* __KERNEL__ */

#endif /* _LINUX_THREAD_INFO_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	/* thread_info.h: common low-level thread information accessors
	3	*
	4	* Copyright (C) 2002 David Howells (dhowells@redhat.com)
	5	* - Incorporating suggestions made by Linus Torvalds
	6	*/
	7
	8	#ifndef _LINUX_THREAD_INFO_H
	9	#define _LINUX_THREAD_INFO_H
	10
ce6bd420	11	#include <linux/types.h>
edd63a27	12	#include <linux/bug.h>
53d74d05	13	#include <linux/restart_block.h>
a332d86d	14
c65eacbe	15	#ifdef CONFIG_THREAD_INFO_IN_TASK
dc3d2a67 MR	16	/*
	17	* For CONFIG_THREAD_INFO_IN_TASK kernels we need <asm/current.h> for the
	18	* definition of current, but for !CONFIG_THREAD_INFO_IN_TASK kernels,
	19	* including <asm/current.h> can cause a circular dependency on some platforms.
	20	*/
	21	#include <asm/current.h>
c65eacbe AL	22	#define current_thread_info() ((struct thread_info *)current)
	23	#endif
	24
1da177e4	25	#include <linux/bitops.h>
96dc4f9f S	26
	27	/*
	28	* For per-arch arch_within_stack_frames() implementations, defined in
	29	* asm/thread_info.h.
	30	*/
	31	enum {
	32	BAD_STACK = -1,
	33	NOT_STACK = 0,
	34	GOOD_FRAME,
	35	GOOD_STACK,
	36	};
	37
5903f61e	38	#ifdef CONFIG_GENERIC_ENTRY
23d67a54 GKB	39	enum syscall_work_bit {
23d67a54 GKB	40	SYSCALL_WORK_BIT_SECCOMP,
524666cb	41	SYSCALL_WORK_BIT_SYSCALL_TRACEPOINT,
64c19ba2	42	SYSCALL_WORK_BIT_SYSCALL_TRACE,
64eb35f7	43	SYSCALL_WORK_BIT_SYSCALL_EMU,
785dc4eb	44	SYSCALL_WORK_BIT_SYSCALL_AUDIT,
1446e1df	45	SYSCALL_WORK_BIT_SYSCALL_USER_DISPATCH,
6342adca	46	SYSCALL_WORK_BIT_SYSCALL_EXIT_TRAP,
23d67a54 GKB	47	};
	48
	49	#define SYSCALL_WORK_SECCOMP BIT(SYSCALL_WORK_BIT_SECCOMP)
524666cb	50	#define SYSCALL_WORK_SYSCALL_TRACEPOINT BIT(SYSCALL_WORK_BIT_SYSCALL_TRACEPOINT)
64c19ba2	51	#define SYSCALL_WORK_SYSCALL_TRACE BIT(SYSCALL_WORK_BIT_SYSCALL_TRACE)
64eb35f7	52	#define SYSCALL_WORK_SYSCALL_EMU BIT(SYSCALL_WORK_BIT_SYSCALL_EMU)
785dc4eb	53	#define SYSCALL_WORK_SYSCALL_AUDIT BIT(SYSCALL_WORK_BIT_SYSCALL_AUDIT)
1446e1df	54	#define SYSCALL_WORK_SYSCALL_USER_DISPATCH BIT(SYSCALL_WORK_BIT_SYSCALL_USER_DISPATCH)
6342adca	55	#define SYSCALL_WORK_SYSCALL_EXIT_TRAP BIT(SYSCALL_WORK_BIT_SYSCALL_EXIT_TRAP)
5903f61e	56	#endif
23d67a54	57
1da177e4 LT	58	#include <asm/thread_info.h>
	59
	60	#ifdef __KERNEL__
	61
48ac3c18 MR	62	#ifndef THREAD_ALIGN
	63	#define THREAD_ALIGN THREAD_SIZE
	64	#endif
	65
e01e8063	66	#define THREADINFO_GFP (GFP_KERNEL_ACCOUNT \| __GFP_ZERO)
2889f608	67
1da177e4 LT	68	/*
	69	* flag set/clear/test wrappers
	70	* - pass TIF_xxxx constants to these functions
	71	*/
	72
1da177e4 LT	73	static inline void set_ti_thread_flag(struct thread_info *ti, int flag)
1da177e4 LT	74	{
5548fecd	75	set_bit(flag, (unsigned long *)&ti->flags);
1da177e4 LT	76	}
	77
	78	static inline void clear_ti_thread_flag(struct thread_info *ti, int flag)
	79	{
5548fecd	80	clear_bit(flag, (unsigned long *)&ti->flags);
1da177e4 LT	81	}
1da177e4 LT	82
93ee37c2 DM	83	static inline void update_ti_thread_flag(struct thread_info *ti, int flag,
	84	bool value)
	85	{
	86	if (value)
	87	set_ti_thread_flag(ti, flag);
	88	else
	89	clear_ti_thread_flag(ti, flag);
	90	}
	91
1da177e4 LT	92	static inline int test_and_set_ti_thread_flag(struct thread_info *ti, int flag)
1da177e4 LT	93	{
5548fecd	94	return test_and_set_bit(flag, (unsigned long *)&ti->flags);
1da177e4 LT	95	}
	96
	97	static inline int test_and_clear_ti_thread_flag(struct thread_info *ti, int flag)
	98	{
5548fecd	99	return test_and_clear_bit(flag, (unsigned long *)&ti->flags);
1da177e4 LT	100	}
	101
	102	static inline int test_ti_thread_flag(struct thread_info *ti, int flag)
	103	{
5548fecd	104	return test_bit(flag, (unsigned long *)&ti->flags);
1da177e4 LT	105	}
1da177e4 LT	106
3b66a1ed RZ	107	#define set_thread_flag(flag) \
	108	set_ti_thread_flag(current_thread_info(), flag)
	109	#define clear_thread_flag(flag) \
	110	clear_ti_thread_flag(current_thread_info(), flag)
93ee37c2 DM	111	#define update_thread_flag(flag, value) \
93ee37c2 DM	112	update_ti_thread_flag(current_thread_info(), flag, value)
3b66a1ed RZ	113	#define test_and_set_thread_flag(flag) \
	114	test_and_set_ti_thread_flag(current_thread_info(), flag)
	115	#define test_and_clear_thread_flag(flag) \
	116	test_and_clear_ti_thread_flag(current_thread_info(), flag)
	117	#define test_thread_flag(flag) \
	118	test_ti_thread_flag(current_thread_info(), flag)
	119
3136b93c GKB	120	#ifdef CONFIG_GENERIC_ENTRY
	121	#define set_syscall_work(fl) \
	122	set_bit(SYSCALL_WORK_BIT_##fl, &current_thread_info()->syscall_work)
	123	#define test_syscall_work(fl) \
	124	test_bit(SYSCALL_WORK_BIT_##fl, &current_thread_info()->syscall_work)
	125	#define clear_syscall_work(fl) \
	126	clear_bit(SYSCALL_WORK_BIT_##fl, &current_thread_info()->syscall_work)
	127
	128	#define set_task_syscall_work(t, fl) \
	129	set_bit(SYSCALL_WORK_BIT_##fl, &task_thread_info(t)->syscall_work)
	130	#define test_task_syscall_work(t, fl) \
	131	test_bit(SYSCALL_WORK_BIT_##fl, &task_thread_info(t)->syscall_work)
	132	#define clear_task_syscall_work(t, fl) \
	133	clear_bit(SYSCALL_WORK_BIT_##fl, &task_thread_info(t)->syscall_work)
	134
	135	#else /* CONFIG_GENERIC_ENTRY */
	136
	137	#define set_syscall_work(fl) \
5903f61e	138	set_ti_thread_flag(current_thread_info(), TIF_##fl)
3136b93c	139	#define test_syscall_work(fl) \
5903f61e	140	test_ti_thread_flag(current_thread_info(), TIF_##fl)
3136b93c	141	#define clear_syscall_work(fl) \
5903f61e	142	clear_ti_thread_flag(current_thread_info(), TIF_##fl)
3136b93c GKB	143
	144	#define set_task_syscall_work(t, fl) \
	145	set_ti_thread_flag(task_thread_info(t), TIF_##fl)
	146	#define test_task_syscall_work(t, fl) \
	147	test_ti_thread_flag(task_thread_info(t), TIF_##fl)
	148	#define clear_task_syscall_work(t, fl) \
	149	clear_ti_thread_flag(task_thread_info(t), TIF_##fl)
	150	#endif /* !CONFIG_GENERIC_ENTRY */
	151
ea811747 PZ	152	#define tif_need_resched() test_thread_flag(TIF_NEED_RESCHED)
ea811747 PZ	153
0f60a8ef KC	154	#ifndef CONFIG_HAVE_ARCH_WITHIN_STACK_FRAMES
	155	static inline int arch_within_stack_frames(const void * const stack,
	156	const void * const stackend,
	157	const void *obj, unsigned long len)
	158	{
	159	return 0;
	160	}
	161	#endif
	162
f5509cc1 KC	163	#ifdef CONFIG_HARDENED_USERCOPY
	164	extern void __check_object_size(const void *ptr, unsigned long n,
	165	bool to_user);
	166
a85d6b82 KC	167	static __always_inline void check_object_size(const void *ptr, unsigned long n,
a85d6b82 KC	168	bool to_user)
f5509cc1	169	{
81409e9e KC	170	if (!__builtin_constant_p(n))
81409e9e KC	171	__check_object_size(ptr, n, to_user);
f5509cc1 KC	172	}
	173	#else
	174	static inline void check_object_size(const void *ptr, unsigned long n,
	175	bool to_user)
	176	{ }
	177	#endif /* CONFIG_HARDENED_USERCOPY */
	178
b0377fed AV	179	extern void __compiletime_error("copy source size is too small")
	180	__bad_copy_from(void);
	181	extern void __compiletime_error("copy destination size is too small")
	182	__bad_copy_to(void);
	183
	184	static inline void copy_overflow(int size, unsigned long count)
	185	{
	186	WARN(1, "Buffer overflow detected (%d < %lu)!\n", size, count);
	187	}
	188
9dd819a1	189	static __always_inline __must_check bool
b0377fed AV	190	check_copy_size(const void *addr, size_t bytes, bool is_source)
	191	{
	192	int sz = __compiletime_object_size(addr);
	193	if (unlikely(sz >= 0 && sz < bytes)) {
	194	if (!__builtin_constant_p(bytes))
	195	copy_overflow(sz, bytes);
	196	else if (is_source)
	197	__bad_copy_from();
	198	else
	199	__bad_copy_to();
	200	return false;
	201	}
6d13de14 KC	202	if (WARN_ON_ONCE(bytes > INT_MAX))
6d13de14 KC	203	return false;
b0377fed AV	204	check_object_size(addr, bytes, is_source);
	205	return true;
	206	}
	207
e9ea1e7f KH	208	#ifndef arch_setup_new_exec
	209	static inline void arch_setup_new_exec(void) { }
	210	#endif
	211
4e4c22c7	212	#endif /* __KERNEL__ */
1da177e4 LT	213
1da177e4 LT	214	#endif /* _LINUX_THREAD_INFO_H */