[linux-block.git] / include / linux / jump_label.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_JUMP_LABEL_H
#define _LINUX_JUMP_LABEL_H

/*
 * Jump label support
 *
 * Copyright (C) 2009-2012 Jason Baron <jbaron@redhat.com>
 * Copyright (C) 2011-2012 Red Hat, Inc., Peter Zijlstra
 *
 * DEPRECATED API:
 *
 * The use of 'struct static_key' directly, is now DEPRECATED. In addition
 * static_key_{true,false}() is also DEPRECATED. IE DO NOT use the following:
 *
 * struct static_key false = STATIC_KEY_INIT_FALSE;
 * struct static_key true = STATIC_KEY_INIT_TRUE;
 * static_key_true()
 * static_key_false()
 *
 * The updated API replacements are:
 *
 * DEFINE_STATIC_KEY_TRUE(key);
 * DEFINE_STATIC_KEY_FALSE(key);
 * DEFINE_STATIC_KEY_ARRAY_TRUE(keys, count);
 * DEFINE_STATIC_KEY_ARRAY_FALSE(keys, count);
 * static_branch_likely()
 * static_branch_unlikely()
 *
 * Jump labels provide an interface to generate dynamic branches using
 * self-modifying code. Assuming toolchain and architecture support, if we
 * define a "key" that is initially false via "DEFINE_STATIC_KEY_FALSE(key)",
 * an "if (static_branch_unlikely(&key))" statement is an unconditional branch
 * (which defaults to false - and the true block is placed out of line).
 * Similarly, we can define an initially true key via
 * "DEFINE_STATIC_KEY_TRUE(key)", and use it in the same
 * "if (static_branch_unlikely(&key))", in which case we will generate an
 * unconditional branch to the out-of-line true branch. Keys that are
 * initially true or false can be using in both static_branch_unlikely()
 * and static_branch_likely() statements.
 *
 * At runtime we can change the branch target by setting the key
 * to true via a call to static_branch_enable(), or false using
 * static_branch_disable(). If the direction of the branch is switched by
 * these calls then we run-time modify the branch target via a
 * no-op -> jump or jump -> no-op conversion. For example, for an
 * initially false key that is used in an "if (static_branch_unlikely(&key))"
 * statement, setting the key to true requires us to patch in a jump
 * to the out-of-line of true branch.
 *
 * In addition to static_branch_{enable,disable}, we can also reference count
 * the key or branch direction via static_branch_{inc,dec}. Thus,
 * static_branch_inc() can be thought of as a 'make more true' and
 * static_branch_dec() as a 'make more false'.
 *
 * Since this relies on modifying code, the branch modifying functions
 * must be considered absolute slow paths (machine wide synchronization etc.).
 * OTOH, since the affected branches are unconditional, their runtime overhead
 * will be absolutely minimal, esp. in the default (off) case where the total
 * effect is a single NOP of appropriate size. The on case will patch in a jump
 * to the out-of-line block.
 *
 * When the control is directly exposed to userspace, it is prudent to delay the
 * decrement to avoid high frequency code modifications which can (and do)
 * cause significant performance degradation. Struct static_key_deferred and
 * static_key_slow_dec_deferred() provide for this.
 *
 * Lacking toolchain and or architecture support, static keys fall back to a
 * simple conditional branch.
 *
 * Additional babbling in: Documentation/staging/static-keys.rst
 */

#ifndef __ASSEMBLY__

#include <linux/types.h>
#include <linux/compiler.h>

extern bool static_key_initialized;

#define STATIC_KEY_CHECK_USE(key) WARN(!static_key_initialized,		      \
				    "%s(): static key '%pS' used before call to jump_label_init()", \
				    __func__, (key))

struct static_key {
	atomic_t enabled;
#ifdef CONFIG_JUMP_LABEL
/*
 * Note:
 *   To make anonymous unions work with old compilers, the static
 *   initialization of them requires brackets. This creates a dependency
 *   on the order of the struct with the initializers. If any fields
 *   are added, STATIC_KEY_INIT_TRUE and STATIC_KEY_INIT_FALSE may need
 *   to be modified.
 *
 * bit 0 => 1 if key is initially true
 *	    0 if initially false
 * bit 1 => 1 if points to struct static_key_mod
 *	    0 if points to struct jump_entry
 */
	union {
		unsigned long type;
		struct jump_entry *entries;
		struct static_key_mod *next;
	};
#endif	/* CONFIG_JUMP_LABEL */
};

#endif /* __ASSEMBLY__ */

#ifdef CONFIG_JUMP_LABEL
#include <asm/jump_label.h>

#ifndef __ASSEMBLY__
#ifdef CONFIG_HAVE_ARCH_JUMP_LABEL_RELATIVE

struct jump_entry {
	s32 code;
	s32 target;
	long key;	// key may be far away from the core kernel under KASLR
};

static inline unsigned long jump_entry_code(const struct jump_entry *entry)
{
	return (unsigned long)&entry->code + entry->code;
}

static inline unsigned long jump_entry_target(const struct jump_entry *entry)
{
	return (unsigned long)&entry->target + entry->target;
}

static inline struct static_key *jump_entry_key(const struct jump_entry *entry)
{
	long offset = entry->key & ~3L;

	return (struct static_key *)((unsigned long)&entry->key + offset);
}

#else

static inline unsigned long jump_entry_code(const struct jump_entry *entry)
{
	return entry->code;
}

static inline unsigned long jump_entry_target(const struct jump_entry *entry)
{
	return entry->target;
}

static inline struct static_key *jump_entry_key(const struct jump_entry *entry)
{
	return (struct static_key *)((unsigned long)entry->key & ~3UL);
}

#endif

static inline bool jump_entry_is_branch(const struct jump_entry *entry)
{
	return (unsigned long)entry->key & 1UL;
}

static inline bool jump_entry_is_init(const struct jump_entry *entry)
{
	return (unsigned long)entry->key & 2UL;
}

static inline void jump_entry_set_init(struct jump_entry *entry, bool set)
{
	if (set)
		entry->key |= 2;
	else
		entry->key &= ~2;
}

static inline int jump_entry_size(struct jump_entry *entry)
{
#ifdef JUMP_LABEL_NOP_SIZE
	return JUMP_LABEL_NOP_SIZE;
#else
	return arch_jump_entry_size(entry);
#endif
}

#endif
#endif

#ifndef __ASSEMBLY__

enum jump_label_type {
	JUMP_LABEL_NOP = 0,
	JUMP_LABEL_JMP,
};

struct module;

#ifdef CONFIG_JUMP_LABEL

#define JUMP_TYPE_FALSE		0UL
#define JUMP_TYPE_TRUE		1UL
#define JUMP_TYPE_LINKED	2UL
#define JUMP_TYPE_MASK		3UL

static __always_inline bool static_key_false(struct static_key *key)
{
	return arch_static_branch(key, false);
}

static __always_inline bool static_key_true(struct static_key *key)
{
	return !arch_static_branch(key, true);
}

extern struct jump_entry __start___jump_table[];
extern struct jump_entry __stop___jump_table[];

extern void jump_label_init(void);
extern void jump_label_lock(void);
extern void jump_label_unlock(void);
extern void arch_jump_label_transform(struct jump_entry *entry,
				      enum jump_label_type type);
extern bool arch_jump_label_transform_queue(struct jump_entry *entry,
					    enum jump_label_type type);
extern void arch_jump_label_transform_apply(void);
extern int jump_label_text_reserved(void *start, void *end);
extern void static_key_slow_inc(struct static_key *key);
extern void static_key_slow_dec(struct static_key *key);
extern void static_key_slow_inc_cpuslocked(struct static_key *key);
extern void static_key_slow_dec_cpuslocked(struct static_key *key);
extern int static_key_count(struct static_key *key);
extern void static_key_enable(struct static_key *key);
extern void static_key_disable(struct static_key *key);
extern void static_key_enable_cpuslocked(struct static_key *key);
extern void static_key_disable_cpuslocked(struct static_key *key);
extern enum jump_label_type jump_label_init_type(struct jump_entry *entry);

/*
 * We should be using ATOMIC_INIT() for initializing .enabled, but
 * the inclusion of atomic.h is problematic for inclusion of jump_label.h
 * in 'low-level' headers. Thus, we are initializing .enabled with a
 * raw value, but have added a BUILD_BUG_ON() to catch any issues in
 * jump_label_init() see: kernel/jump_label.c.
 */
#define STATIC_KEY_INIT_TRUE					\
	{ .enabled = { 1 },					\
	  { .type = JUMP_TYPE_TRUE } }
#define STATIC_KEY_INIT_FALSE					\
	{ .enabled = { 0 },					\
	  { .type = JUMP_TYPE_FALSE } }

#else  /* !CONFIG_JUMP_LABEL */

#include <linux/atomic.h>
#include <linux/bug.h>

static __always_inline int static_key_count(struct static_key *key)
{
	return arch_atomic_read(&key->enabled);
}

static __always_inline void jump_label_init(void)
{
	static_key_initialized = true;
}

static __always_inline bool static_key_false(struct static_key *key)
{
	if (unlikely_notrace(static_key_count(key) > 0))
		return true;
	return false;
}

static __always_inline bool static_key_true(struct static_key *key)
{
	if (likely_notrace(static_key_count(key) > 0))
		return true;
	return false;
}

static inline void static_key_slow_inc(struct static_key *key)
{
	STATIC_KEY_CHECK_USE(key);
	atomic_inc(&key->enabled);
}

static inline void static_key_slow_dec(struct static_key *key)
{
	STATIC_KEY_CHECK_USE(key);
	atomic_dec(&key->enabled);
}

#define static_key_slow_inc_cpuslocked(key) static_key_slow_inc(key)
#define static_key_slow_dec_cpuslocked(key) static_key_slow_dec(key)

static inline int jump_label_text_reserved(void *start, void *end)
{
	return 0;
}

static inline void jump_label_lock(void) {}
static inline void jump_label_unlock(void) {}

static inline void static_key_enable(struct static_key *key)
{
	STATIC_KEY_CHECK_USE(key);

	if (atomic_read(&key->enabled) != 0) {
		WARN_ON_ONCE(atomic_read(&key->enabled) != 1);
		return;
	}
	atomic_set(&key->enabled, 1);
}

static inline void static_key_disable(struct static_key *key)
{
	STATIC_KEY_CHECK_USE(key);

	if (atomic_read(&key->enabled) != 1) {
		WARN_ON_ONCE(atomic_read(&key->enabled) != 0);
		return;
	}
	atomic_set(&key->enabled, 0);
}

#define static_key_enable_cpuslocked(k)		static_key_enable((k))
#define static_key_disable_cpuslocked(k)	static_key_disable((k))

#define STATIC_KEY_INIT_TRUE	{ .enabled = ATOMIC_INIT(1) }
#define STATIC_KEY_INIT_FALSE	{ .enabled = ATOMIC_INIT(0) }

#endif	/* CONFIG_JUMP_LABEL */

#define STATIC_KEY_INIT STATIC_KEY_INIT_FALSE
#define jump_label_enabled static_key_enabled

/* -------------------------------------------------------------------------- */

/*
 * Two type wrappers around static_key, such that we can use compile time
 * type differentiation to emit the right code.
 *
 * All the below code is macros in order to play type games.
 */

struct static_key_true {
	struct static_key key;
};

struct static_key_false {
	struct static_key key;
};

#define STATIC_KEY_TRUE_INIT  (struct static_key_true) { .key = STATIC_KEY_INIT_TRUE,  }
#define STATIC_KEY_FALSE_INIT (struct static_key_false){ .key = STATIC_KEY_INIT_FALSE, }

#define DEFINE_STATIC_KEY_TRUE(name)	\
	struct static_key_true name = STATIC_KEY_TRUE_INIT

#define DEFINE_STATIC_KEY_TRUE_RO(name)	\
	struct static_key_true name __ro_after_init = STATIC_KEY_TRUE_INIT

#define DECLARE_STATIC_KEY_TRUE(name)	\
	extern struct static_key_true name

#define DEFINE_STATIC_KEY_FALSE(name)	\
	struct static_key_false name = STATIC_KEY_FALSE_INIT

#define DEFINE_STATIC_KEY_FALSE_RO(name)	\
	struct static_key_false name __ro_after_init = STATIC_KEY_FALSE_INIT

#define DECLARE_STATIC_KEY_FALSE(name)	\
	extern struct static_key_false name

#define DEFINE_STATIC_KEY_ARRAY_TRUE(name, count)		\
	struct static_key_true name[count] = {			\
		[0 ... (count) - 1] = STATIC_KEY_TRUE_INIT,	\
	}

#define DEFINE_STATIC_KEY_ARRAY_FALSE(name, count)		\
	struct static_key_false name[count] = {			\
		[0 ... (count) - 1] = STATIC_KEY_FALSE_INIT,	\
	}

#define _DEFINE_STATIC_KEY_1(name)	DEFINE_STATIC_KEY_TRUE(name)
#define _DEFINE_STATIC_KEY_0(name)	DEFINE_STATIC_KEY_FALSE(name)
#define DEFINE_STATIC_KEY_MAYBE(cfg, name)			\
	__PASTE(_DEFINE_STATIC_KEY_, IS_ENABLED(cfg))(name)

#define _DEFINE_STATIC_KEY_RO_1(name)	DEFINE_STATIC_KEY_TRUE_RO(name)
#define _DEFINE_STATIC_KEY_RO_0(name)	DEFINE_STATIC_KEY_FALSE_RO(name)
#define DEFINE_STATIC_KEY_MAYBE_RO(cfg, name)			\
	__PASTE(_DEFINE_STATIC_KEY_RO_, IS_ENABLED(cfg))(name)

#define _DECLARE_STATIC_KEY_1(name)	DECLARE_STATIC_KEY_TRUE(name)
#define _DECLARE_STATIC_KEY_0(name)	DECLARE_STATIC_KEY_FALSE(name)
#define DECLARE_STATIC_KEY_MAYBE(cfg, name)			\
	__PASTE(_DECLARE_STATIC_KEY_, IS_ENABLED(cfg))(name)

extern bool ____wrong_branch_error(void);

#define static_key_enabled(x)							\
({										\
	if (!__builtin_types_compatible_p(typeof(*x), struct static_key) &&	\
	    !__builtin_types_compatible_p(typeof(*x), struct static_key_true) &&\
	    !__builtin_types_compatible_p(typeof(*x), struct static_key_false))	\
		____wrong_branch_error();					\
	static_key_count((struct static_key *)x) > 0;				\
})

#ifdef CONFIG_JUMP_LABEL

/*
 * Combine the right initial value (type) with the right branch order
 * to generate the desired result.
 *
 *
 * type\branch|	likely (1)	      |	unlikely (0)
 * -----------+-----------------------+------------------
 *            |                       |
 *  true (1)  |	   ...		      |	   ...
 *            |    NOP		      |	   JMP L
 *            |    <br-stmts>	      |	1: ...
 *            |	L: ...		      |
 *            |			      |
 *            |			      |	L: <br-stmts>
 *            |			      |	   jmp 1b
 *            |                       |
 * -----------+-----------------------+------------------
 *            |                       |
 *  false (0) |	   ...		      |	   ...
 *            |    JMP L	      |	   NOP
 *            |    <br-stmts>	      |	1: ...
 *            |	L: ...		      |
 *            |			      |
 *            |			      |	L: <br-stmts>
 *            |			      |	   jmp 1b
 *            |                       |
 * -----------+-----------------------+------------------
 *
 * The initial value is encoded in the LSB of static_key::entries,
 * type: 0 = false, 1 = true.
 *
 * The branch type is encoded in the LSB of jump_entry::key,
 * branch: 0 = unlikely, 1 = likely.
 *
 * This gives the following logic table:
 *
 *	enabled	type	branch	  instuction
 * -----------------------------+-----------
 *	0	0	0	| NOP
 *	0	0	1	| JMP
 *	0	1	0	| NOP
 *	0	1	1	| JMP
 *
 *	1	0	0	| JMP
 *	1	0	1	| NOP
 *	1	1	0	| JMP
 *	1	1	1	| NOP
 *
 * Which gives the following functions:
 *
 *   dynamic: instruction = enabled ^ branch
 *   static:  instruction = type ^ branch
 *
 * See jump_label_type() / jump_label_init_type().
 */

#define static_branch_likely(x)							\
({										\
	bool branch;								\
	if (__builtin_types_compatible_p(typeof(*x), struct static_key_true))	\
		branch = !arch_static_branch(&(x)->key, true);			\
	else if (__builtin_types_compatible_p(typeof(*x), struct static_key_false)) \
		branch = !arch_static_branch_jump(&(x)->key, true);		\
	else									\
		branch = ____wrong_branch_error();				\
	likely_notrace(branch);								\
})

#define static_branch_unlikely(x)						\
({										\
	bool branch;								\
	if (__builtin_types_compatible_p(typeof(*x), struct static_key_true))	\
		branch = arch_static_branch_jump(&(x)->key, false);		\
	else if (__builtin_types_compatible_p(typeof(*x), struct static_key_false)) \
		branch = arch_static_branch(&(x)->key, false);			\
	else									\
		branch = ____wrong_branch_error();				\
	unlikely_notrace(branch);							\
})

#else /* !CONFIG_JUMP_LABEL */

#define static_branch_likely(x)		likely_notrace(static_key_enabled(&(x)->key))
#define static_branch_unlikely(x)	unlikely_notrace(static_key_enabled(&(x)->key))

#endif /* CONFIG_JUMP_LABEL */

#define static_branch_maybe(config, x)					\
	(IS_ENABLED(config) ? static_branch_likely(x)			\
			    : static_branch_unlikely(x))

/*
 * Advanced usage; refcount, branch is enabled when: count != 0
 */

#define static_branch_inc(x)		static_key_slow_inc(&(x)->key)
#define static_branch_dec(x)		static_key_slow_dec(&(x)->key)
#define static_branch_inc_cpuslocked(x)	static_key_slow_inc_cpuslocked(&(x)->key)
#define static_branch_dec_cpuslocked(x)	static_key_slow_dec_cpuslocked(&(x)->key)

/*
 * Normal usage; boolean enable/disable.
 */

#define static_branch_enable(x)			static_key_enable(&(x)->key)
#define static_branch_disable(x)		static_key_disable(&(x)->key)
#define static_branch_enable_cpuslocked(x)	static_key_enable_cpuslocked(&(x)->key)
#define static_branch_disable_cpuslocked(x)	static_key_disable_cpuslocked(&(x)->key)

#endif /* __ASSEMBLY__ */

#endif	/* _LINUX_JUMP_LABEL_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
bf5438fc JB	2	#ifndef _LINUX_JUMP_LABEL_H
	3	#define _LINUX_JUMP_LABEL_H
	4
efb3040d PZ	5	/*
	6	* Jump label support
	7	*
	8	* Copyright (C) 2009-2012 Jason Baron <jbaron@redhat.com>
90eec103	9	* Copyright (C) 2011-2012 Red Hat, Inc., Peter Zijlstra
efb3040d	10	*
412758cb JB	11	* DEPRECATED API:
	12	*
	13	* The use of 'struct static_key' directly, is now DEPRECATED. In addition
	14	* static_key_{true,false}() is also DEPRECATED. IE DO NOT use the following:
	15	*
	16	* struct static_key false = STATIC_KEY_INIT_FALSE;
	17	* struct static_key true = STATIC_KEY_INIT_TRUE;
	18	* static_key_true()
	19	* static_key_false()
	20	*
	21	* The updated API replacements are:
	22	*
	23	* DEFINE_STATIC_KEY_TRUE(key);
	24	* DEFINE_STATIC_KEY_FALSE(key);
ef0da55a CM	25	* DEFINE_STATIC_KEY_ARRAY_TRUE(keys, count);
ef0da55a CM	26	* DEFINE_STATIC_KEY_ARRAY_FALSE(keys, count);
1975dbc2 JC	27	* static_branch_likely()
1975dbc2 JC	28	* static_branch_unlikely()
412758cb	29	*
efb3040d	30	* Jump labels provide an interface to generate dynamic branches using
412758cb JB	31	* self-modifying code. Assuming toolchain and architecture support, if we
	32	* define a "key" that is initially false via "DEFINE_STATIC_KEY_FALSE(key)",
	33	* an "if (static_branch_unlikely(&key))" statement is an unconditional branch
	34	* (which defaults to false - and the true block is placed out of line).
	35	* Similarly, we can define an initially true key via
	36	* "DEFINE_STATIC_KEY_TRUE(key)", and use it in the same
	37	* "if (static_branch_unlikely(&key))", in which case we will generate an
	38	* unconditional branch to the out-of-line true branch. Keys that are
	39	* initially true or false can be using in both static_branch_unlikely()
	40	* and static_branch_likely() statements.
efb3040d	41	*
412758cb JB	42	* At runtime we can change the branch target by setting the key
	43	* to true via a call to static_branch_enable(), or false using
	44	* static_branch_disable(). If the direction of the branch is switched by
	45	* these calls then we run-time modify the branch target via a
	46	* no-op -> jump or jump -> no-op conversion. For example, for an
	47	* initially false key that is used in an "if (static_branch_unlikely(&key))"
	48	* statement, setting the key to true requires us to patch in a jump
	49	* to the out-of-line of true branch.
efb3040d	50	*
1975dbc2	51	* In addition to static_branch_{enable,disable}, we can also reference count
412758cb JB	52	* the key or branch direction via static_branch_{inc,dec}. Thus,
412758cb JB	53	* static_branch_inc() can be thought of as a 'make more true' and
1975dbc2	54	* static_branch_dec() as a 'make more false'.
412758cb JB	55	*
412758cb JB	56	* Since this relies on modifying code, the branch modifying functions
efb3040d	57	* must be considered absolute slow paths (machine wide synchronization etc.).
fd3cbdc0	58	* OTOH, since the affected branches are unconditional, their runtime overhead
efb3040d PZ	59	* will be absolutely minimal, esp. in the default (off) case where the total
	60	* effect is a single NOP of appropriate size. The on case will patch in a jump
	61	* to the out-of-line block.
	62	*
fd3cbdc0	63	* When the control is directly exposed to userspace, it is prudent to delay the
efb3040d	64	* decrement to avoid high frequency code modifications which can (and do)
c5905afb IM	65	* cause significant performance degradation. Struct static_key_deferred and
c5905afb IM	66	* static_key_slow_dec_deferred() provide for this.
efb3040d	67	*
412758cb JB	68	* Lacking toolchain and or architecture support, static keys fall back to a
412758cb JB	69	* simple conditional branch.
c5905afb	70	*
8e2a46a4	71	* Additional babbling in: Documentation/staging/static-keys.rst
fd3cbdc0	72	*/
efb3040d	73
c0ccf6f9 AB	74	#ifndef __ASSEMBLY__
c0ccf6f9 AB	75
d430d3d7 JB	76	#include <linux/types.h>
d430d3d7 JB	77	#include <linux/compiler.h>
c4b2c0c5 HFS	78
	79	extern bool static_key_initialized;
	80
5cdda511 BP	81	#define STATIC_KEY_CHECK_USE(key) WARN(!static_key_initialized, \
	82	"%s(): static key '%pS' used before call to jump_label_init()", \
	83	__func__, (key))
d430d3d7	84
c5905afb	85	struct static_key {
d430d3d7	86	atomic_t enabled;
cd27ccfc	87	#ifdef CONFIG_JUMP_LABEL
3821fd35	88	/*
b17ef2ed SRV	89	* Note:
	90	* To make anonymous unions work with old compilers, the static
	91	* initialization of them requires brackets. This creates a dependency
	92	* on the order of the struct with the initializers. If any fields
	93	* are added, STATIC_KEY_INIT_TRUE and STATIC_KEY_INIT_FALSE may need
	94	* to be modified.
	95	*
3821fd35 JB	96	* bit 0 => 1 if key is initially true
	97	* 0 if initially false
	98	* bit 1 => 1 if points to struct static_key_mod
	99	* 0 if points to struct jump_entry
	100	*/
	101	union {
	102	unsigned long type;
	103	struct jump_entry *entries;
	104	struct static_key_mod *next;
	105	};
cd27ccfc	106	#endif /* CONFIG_JUMP_LABEL */
d430d3d7 JB	107	};
d430d3d7 JB	108
c0ccf6f9 AB	109	#endif /* __ASSEMBLY__ */
c0ccf6f9 AB	110
e9666d10	111	#ifdef CONFIG_JUMP_LABEL
c0ccf6f9	112	#include <asm/jump_label.h>
9ae033ac AB	113
9ae033ac AB	114	#ifndef __ASSEMBLY__
50ff18ab AB	115	#ifdef CONFIG_HAVE_ARCH_JUMP_LABEL_RELATIVE
	116
	117	struct jump_entry {
	118	s32 code;
	119	s32 target;
	120	long key; // key may be far away from the core kernel under KASLR
	121	};
	122
	123	static inline unsigned long jump_entry_code(const struct jump_entry *entry)
	124	{
	125	return (unsigned long)&entry->code + entry->code;
	126	}
	127
	128	static inline unsigned long jump_entry_target(const struct jump_entry *entry)
	129	{
	130	return (unsigned long)&entry->target + entry->target;
	131	}
	132
	133	static inline struct static_key jump_entry_key(const struct jump_entry entry)
	134	{
19483677	135	long offset = entry->key & ~3L;
50ff18ab AB	136
	137	return (struct static_key *)((unsigned long)&entry->key + offset);
	138	}
	139
	140	#else
9ae033ac AB	141
	142	static inline unsigned long jump_entry_code(const struct jump_entry *entry)
	143	{
	144	return entry->code;
	145	}
	146
	147	static inline unsigned long jump_entry_target(const struct jump_entry *entry)
	148	{
	149	return entry->target;
	150	}
	151
	152	static inline struct static_key jump_entry_key(const struct jump_entry entry)
	153	{
19483677	154	return (struct static_key *)((unsigned long)entry->key & ~3UL);
9ae033ac AB	155	}
9ae033ac AB	156
50ff18ab AB	157	#endif
50ff18ab AB	158
9ae033ac AB	159	static inline bool jump_entry_is_branch(const struct jump_entry *entry)
	160	{
	161	return (unsigned long)entry->key & 1UL;
	162	}
	163
	164	static inline bool jump_entry_is_init(const struct jump_entry *entry)
	165	{
19483677	166	return (unsigned long)entry->key & 2UL;
9ae033ac AB	167	}
9ae033ac AB	168
5af0ea29	169	static inline void jump_entry_set_init(struct jump_entry *entry, bool set)
9ae033ac	170	{
5af0ea29 PZ	171	if (set)
	172	entry->key \|= 2;
	173	else
	174	entry->key &= ~2;
9ae033ac AB	175	}
9ae033ac AB	176
fa5e5dc3 PZ	177	static inline int jump_entry_size(struct jump_entry *entry)
	178	{
	179	#ifdef JUMP_LABEL_NOP_SIZE
	180	return JUMP_LABEL_NOP_SIZE;
	181	#else
	182	return arch_jump_entry_size(entry);
	183	#endif
	184	}
	185
9ae033ac	186	#endif
c0ccf6f9 AB	187	#endif
	188
	189	#ifndef __ASSEMBLY__
bf5438fc JB	190
bf5438fc JB	191	enum jump_label_type {
76b235c6 PZ	192	JUMP_LABEL_NOP = 0,
76b235c6 PZ	193	JUMP_LABEL_JMP,
bf5438fc JB	194	};
	195
	196	struct module;
	197
e9666d10	198	#ifdef CONFIG_JUMP_LABEL
4c5ea0a9	199
3821fd35 JB	200	#define JUMP_TYPE_FALSE 0UL
	201	#define JUMP_TYPE_TRUE 1UL
	202	#define JUMP_TYPE_LINKED 2UL
	203	#define JUMP_TYPE_MASK 3UL
c5905afb IM	204
	205	static __always_inline bool static_key_false(struct static_key *key)
	206	{
11276d53	207	return arch_static_branch(key, false);
c5905afb	208	}
d430d3d7	209
c5905afb IM	210	static __always_inline bool static_key_true(struct static_key *key)
c5905afb IM	211	{
11276d53	212	return !arch_static_branch(key, true);
c5905afb IM	213	}
c5905afb IM	214
bf5438fc JB	215	extern struct jump_entry __start___jump_table[];
	216	extern struct jump_entry __stop___jump_table[];
	217
97ce2c88	218	extern void jump_label_init(void);
91bad2f8 JB	219	extern void jump_label_lock(void);
91bad2f8 JB	220	extern void jump_label_unlock(void);
bf5438fc	221	extern void arch_jump_label_transform(struct jump_entry *entry,
37348804	222	enum jump_label_type type);
c2ba8a15 DBO	223	extern bool arch_jump_label_transform_queue(struct jump_entry *entry,
	224	enum jump_label_type type);
	225	extern void arch_jump_label_transform_apply(void);
4c3ef6d7	226	extern int jump_label_text_reserved(void start, void end);
c5905afb IM	227	extern void static_key_slow_inc(struct static_key *key);
c5905afb IM	228	extern void static_key_slow_dec(struct static_key *key);
ce48c146 PZ	229	extern void static_key_slow_inc_cpuslocked(struct static_key *key);
ce48c146 PZ	230	extern void static_key_slow_dec_cpuslocked(struct static_key *key);
1f69bf9c JB	231	extern int static_key_count(struct static_key *key);
	232	extern void static_key_enable(struct static_key *key);
	233	extern void static_key_disable(struct static_key *key);
5a40527f MZ	234	extern void static_key_enable_cpuslocked(struct static_key *key);
5a40527f MZ	235	extern void static_key_disable_cpuslocked(struct static_key *key);
fdfd4289	236	extern enum jump_label_type jump_label_init_type(struct jump_entry *entry);
c5905afb	237
1f69bf9c JB	238	/*
	239	* We should be using ATOMIC_INIT() for initializing .enabled, but
	240	* the inclusion of atomic.h is problematic for inclusion of jump_label.h
	241	* in 'low-level' headers. Thus, we are initializing .enabled with a
	242	* raw value, but have added a BUILD_BUG_ON() to catch any issues in
	243	* jump_label_init() see: kernel/jump_label.c.
	244	*/
11276d53	245	#define STATIC_KEY_INIT_TRUE \
1f69bf9c	246	{ .enabled = { 1 }, \
fe65deb5	247	{ .type = JUMP_TYPE_TRUE } }
11276d53	248	#define STATIC_KEY_INIT_FALSE \
1f69bf9c	249	{ .enabled = { 0 }, \
fe65deb5	250	{ .type = JUMP_TYPE_FALSE } }
bf5438fc	251
e9666d10	252	#else /* !CONFIG_JUMP_LABEL */
bf5438fc	253
1f69bf9c JB	254	#include <linux/atomic.h>
	255	#include <linux/bug.h>
	256
656d054e	257	static __always_inline int static_key_count(struct static_key *key)
4c5ea0a9	258	{
656d054e	259	return arch_atomic_read(&key->enabled);
4c5ea0a9 PB	260	}
4c5ea0a9 PB	261
97ce2c88 JF	262	static __always_inline void jump_label_init(void)
97ce2c88 JF	263	{
c4b2c0c5	264	static_key_initialized = true;
97ce2c88 JF	265	}
97ce2c88 JF	266
c5905afb IM	267	static __always_inline bool static_key_false(struct static_key *key)
c5905afb IM	268	{
2f0df49c	269	if (unlikely_notrace(static_key_count(key) > 0))
c5905afb IM	270	return true;
	271	return false;
	272	}
	273
	274	static __always_inline bool static_key_true(struct static_key *key)
d430d3d7	275	{
2f0df49c	276	if (likely_notrace(static_key_count(key) > 0))
d430d3d7 JB	277	return true;
	278	return false;
	279	}
bf5438fc	280
c5905afb	281	static inline void static_key_slow_inc(struct static_key *key)
d430d3d7	282	{
5cdda511	283	STATIC_KEY_CHECK_USE(key);
d430d3d7 JB	284	atomic_inc(&key->enabled);
d430d3d7 JB	285	}
bf5438fc	286
c5905afb	287	static inline void static_key_slow_dec(struct static_key *key)
bf5438fc	288	{
5cdda511	289	STATIC_KEY_CHECK_USE(key);
d430d3d7	290	atomic_dec(&key->enabled);
bf5438fc JB	291	}
bf5438fc JB	292
ce48c146 PZ	293	#define static_key_slow_inc_cpuslocked(key) static_key_slow_inc(key)
	294	#define static_key_slow_dec_cpuslocked(key) static_key_slow_dec(key)
	295
4c3ef6d7 JB	296	static inline int jump_label_text_reserved(void start, void end)
	297	{
	298	return 0;
	299	}
	300
91bad2f8 JB	301	static inline void jump_label_lock(void) {}
	302	static inline void jump_label_unlock(void) {}
	303
e33886b3 PZ	304	static inline void static_key_enable(struct static_key *key)
e33886b3 PZ	305	{
5cdda511	306	STATIC_KEY_CHECK_USE(key);
e33886b3	307
1dbb6704 PB	308	if (atomic_read(&key->enabled) != 0) {
	309	WARN_ON_ONCE(atomic_read(&key->enabled) != 1);
	310	return;
	311	}
	312	atomic_set(&key->enabled, 1);
e33886b3 PZ	313	}
	314
	315	static inline void static_key_disable(struct static_key *key)
	316	{
5cdda511	317	STATIC_KEY_CHECK_USE(key);
e33886b3	318
1dbb6704 PB	319	if (atomic_read(&key->enabled) != 1) {
	320	WARN_ON_ONCE(atomic_read(&key->enabled) != 0);
	321	return;
	322	}
	323	atomic_set(&key->enabled, 0);
e33886b3 PZ	324	}
e33886b3 PZ	325
5a40527f MZ	326	#define static_key_enable_cpuslocked(k) static_key_enable((k))
	327	#define static_key_disable_cpuslocked(k) static_key_disable((k))
	328
1f69bf9c JB	329	#define STATIC_KEY_INIT_TRUE { .enabled = ATOMIC_INIT(1) }
	330	#define STATIC_KEY_INIT_FALSE { .enabled = ATOMIC_INIT(0) }
	331
e9666d10	332	#endif /* CONFIG_JUMP_LABEL */
1f69bf9c JB	333
	334	#define STATIC_KEY_INIT STATIC_KEY_INIT_FALSE
	335	#define jump_label_enabled static_key_enabled
	336
11276d53 PZ	337	/* -------------------------------------------------------------------------- */
	338
	339	/*
	340	* Two type wrappers around static_key, such that we can use compile time
	341	* type differentiation to emit the right code.
	342	*
	343	* All the below code is macros in order to play type games.
	344	*/
	345
	346	struct static_key_true {
	347	struct static_key key;
	348	};
	349
	350	struct static_key_false {
	351	struct static_key key;
	352	};
	353
	354	#define STATIC_KEY_TRUE_INIT (struct static_key_true) { .key = STATIC_KEY_INIT_TRUE, }
	355	#define STATIC_KEY_FALSE_INIT (struct static_key_false){ .key = STATIC_KEY_INIT_FALSE, }
	356
	357	#define DEFINE_STATIC_KEY_TRUE(name) \
	358	struct static_key_true name = STATIC_KEY_TRUE_INIT
	359
b5cb15d9 CR	360	#define DEFINE_STATIC_KEY_TRUE_RO(name) \
	361	struct static_key_true name __ro_after_init = STATIC_KEY_TRUE_INIT
	362
b8fb0378 TL	363	#define DECLARE_STATIC_KEY_TRUE(name) \
	364	extern struct static_key_true name
	365
11276d53 PZ	366	#define DEFINE_STATIC_KEY_FALSE(name) \
	367	struct static_key_false name = STATIC_KEY_FALSE_INIT
	368
b5cb15d9 CR	369	#define DEFINE_STATIC_KEY_FALSE_RO(name) \
	370	struct static_key_false name __ro_after_init = STATIC_KEY_FALSE_INIT
	371
b8fb0378 TL	372	#define DECLARE_STATIC_KEY_FALSE(name) \
	373	extern struct static_key_false name
	374
ef0da55a CM	375	#define DEFINE_STATIC_KEY_ARRAY_TRUE(name, count) \
	376	struct static_key_true name[count] = { \
	377	[0 ... (count) - 1] = STATIC_KEY_TRUE_INIT, \
	378	}
	379
	380	#define DEFINE_STATIC_KEY_ARRAY_FALSE(name, count) \
	381	struct static_key_false name[count] = { \
	382	[0 ... (count) - 1] = STATIC_KEY_FALSE_INIT, \
	383	}
	384
0d66ccc1 KC	385	#define _DEFINE_STATIC_KEY_1(name) DEFINE_STATIC_KEY_TRUE(name)
	386	#define _DEFINE_STATIC_KEY_0(name) DEFINE_STATIC_KEY_FALSE(name)
	387	#define DEFINE_STATIC_KEY_MAYBE(cfg, name) \
	388	__PASTE(_DEFINE_STATIC_KEY_, IS_ENABLED(cfg))(name)
	389
	390	#define _DEFINE_STATIC_KEY_RO_1(name) DEFINE_STATIC_KEY_TRUE_RO(name)
	391	#define _DEFINE_STATIC_KEY_RO_0(name) DEFINE_STATIC_KEY_FALSE_RO(name)
	392	#define DEFINE_STATIC_KEY_MAYBE_RO(cfg, name) \
	393	__PASTE(_DEFINE_STATIC_KEY_RO_, IS_ENABLED(cfg))(name)
	394
	395	#define _DECLARE_STATIC_KEY_1(name) DECLARE_STATIC_KEY_TRUE(name)
	396	#define _DECLARE_STATIC_KEY_0(name) DECLARE_STATIC_KEY_FALSE(name)
	397	#define DECLARE_STATIC_KEY_MAYBE(cfg, name) \
	398	__PASTE(_DECLARE_STATIC_KEY_, IS_ENABLED(cfg))(name)
	399
fa128fd7 TH	400	extern bool ____wrong_branch_error(void);
	401
	402	#define static_key_enabled(x) \
	403	({ \
	404	if (!__builtin_types_compatible_p(typeof(*x), struct static_key) && \
	405	!__builtin_types_compatible_p(typeof(*x), struct static_key_true) &&\
	406	!__builtin_types_compatible_p(typeof(*x), struct static_key_false)) \
	407	____wrong_branch_error(); \
	408	static_key_count((struct static_key *)x) > 0; \
	409	})
	410
e9666d10	411	#ifdef CONFIG_JUMP_LABEL
11276d53 PZ	412
	413	/*
	414	* Combine the right initial value (type) with the right branch order
	415	* to generate the desired result.
	416	*
	417	*
	418	* type\branch\| likely (1) \| unlikely (0)
	419	* -----------+-----------------------+------------------
	420	* \| \|
	421	* true (1) \| ... \| ...
	422	* \| NOP \| JMP L
	423	* \| <br-stmts> \| 1: ...
	424	* \| L: ... \|
	425	* \| \|
	426	* \| \| L: <br-stmts>
	427	* \| \| jmp 1b
	428	* \| \|
	429	* -----------+-----------------------+------------------
	430	* \| \|
	431	* false (0) \| ... \| ...
	432	* \| JMP L \| NOP
	433	* \| <br-stmts> \| 1: ...
	434	* \| L: ... \|
	435	* \| \|
	436	* \| \| L: <br-stmts>
	437	* \| \| jmp 1b
	438	* \| \|
	439	* -----------+-----------------------+------------------
	440	*
	441	* The initial value is encoded in the LSB of static_key::entries,
	442	* type: 0 = false, 1 = true.
	443	*
	444	* The branch type is encoded in the LSB of jump_entry::key,
	445	* branch: 0 = unlikely, 1 = likely.
	446	*
	447	* This gives the following logic table:
	448	*
	449	* enabled type branch instuction
	450	* -----------------------------+-----------
	451	* 0 0 0 \| NOP
	452	* 0 0 1 \| JMP
	453	* 0 1 0 \| NOP
	454	* 0 1 1 \| JMP
	455	*
	456	* 1 0 0 \| JMP
	457	* 1 0 1 \| NOP
	458	* 1 1 0 \| JMP
	459	* 1 1 1 \| NOP
	460	*
	461	* Which gives the following functions:
	462	*
	463	* dynamic: instruction = enabled ^ branch
	464	* static: instruction = type ^ branch
	465	*
	466	* See jump_label_type() / jump_label_init_type().
	467	*/
	468
11276d53 PZ	469	#define static_branch_likely(x) \
	470	({ \
	471	bool branch; \
	472	if (__builtin_types_compatible_p(typeof(*x), struct static_key_true)) \
	473	branch = !arch_static_branch(&(x)->key, true); \
	474	else if (__builtin_types_compatible_p(typeof(*x), struct static_key_false)) \
	475	branch = !arch_static_branch_jump(&(x)->key, true); \
	476	else \
	477	branch = ____wrong_branch_error(); \
2f0df49c	478	likely_notrace(branch); \
11276d53 PZ	479	})
	480
	481	#define static_branch_unlikely(x) \
	482	({ \
	483	bool branch; \
	484	if (__builtin_types_compatible_p(typeof(*x), struct static_key_true)) \
	485	branch = arch_static_branch_jump(&(x)->key, false); \
	486	else if (__builtin_types_compatible_p(typeof(*x), struct static_key_false)) \
	487	branch = arch_static_branch(&(x)->key, false); \
	488	else \
	489	branch = ____wrong_branch_error(); \
2f0df49c	490	unlikely_notrace(branch); \
11276d53 PZ	491	})
11276d53 PZ	492
e9666d10	493	#else /* !CONFIG_JUMP_LABEL */
11276d53	494
2f0df49c SRV	495	#define static_branch_likely(x) likely_notrace(static_key_enabled(&(x)->key))
2f0df49c SRV	496	#define static_branch_unlikely(x) unlikely_notrace(static_key_enabled(&(x)->key))
11276d53	497
e9666d10	498	#endif /* CONFIG_JUMP_LABEL */
11276d53	499
0d66ccc1 KC	500	#define static_branch_maybe(config, x) \
	501	(IS_ENABLED(config) ? static_branch_likely(x) \
	502	: static_branch_unlikely(x))
	503
11276d53 PZ	504	/*
	505	* Advanced usage; refcount, branch is enabled when: count != 0
	506	*/
	507
	508	#define static_branch_inc(x) static_key_slow_inc(&(x)->key)
	509	#define static_branch_dec(x) static_key_slow_dec(&(x)->key)
ce48c146 PZ	510	#define static_branch_inc_cpuslocked(x) static_key_slow_inc_cpuslocked(&(x)->key)
ce48c146 PZ	511	#define static_branch_dec_cpuslocked(x) static_key_slow_dec_cpuslocked(&(x)->key)
11276d53 PZ	512
	513	/*
	514	* Normal usage; boolean enable/disable.
	515	*/
	516
5a40527f MZ	517	#define static_branch_enable(x) static_key_enable(&(x)->key)
	518	#define static_branch_disable(x) static_key_disable(&(x)->key)
	519	#define static_branch_enable_cpuslocked(x) static_key_enable_cpuslocked(&(x)->key)
	520	#define static_branch_disable_cpuslocked(x) static_key_disable_cpuslocked(&(x)->key)
11276d53	521
c0ccf6f9	522	#endif /* __ASSEMBLY__ */
85b36c93 LR	523
85b36c93 LR	524	#endif /* _LINUX_JUMP_LABEL_H */