1 #ifndef _LINUX_JUMP_LABEL_H
2 #define _LINUX_JUMP_LABEL_H
7 * Copyright (C) 2009-2012 Jason Baron <jbaron@redhat.com>
8 * Copyright (C) 2011-2012 Peter Zijlstra <pzijlstr@redhat.com>
12 * The use of 'struct static_key' directly, is now DEPRECATED. In addition
13 * static_key_{true,false}() is also DEPRECATED. IE DO NOT use the following:
15 * struct static_key false = STATIC_KEY_INIT_FALSE;
16 * struct static_key true = STATIC_KEY_INIT_TRUE;
20 * The updated API replacements are:
22 * DEFINE_STATIC_KEY_TRUE(key);
23 * DEFINE_STATIC_KEY_FALSE(key);
24 * static_branch_likely()
25 * static_branch_unlikely()
27 * Jump labels provide an interface to generate dynamic branches using
28 * self-modifying code. Assuming toolchain and architecture support, if we
29 * define a "key" that is initially false via "DEFINE_STATIC_KEY_FALSE(key)",
30 * an "if (static_branch_unlikely(&key))" statement is an unconditional branch
31 * (which defaults to false - and the true block is placed out of line).
32 * Similarly, we can define an initially true key via
33 * "DEFINE_STATIC_KEY_TRUE(key)", and use it in the same
34 * "if (static_branch_unlikely(&key))", in which case we will generate an
35 * unconditional branch to the out-of-line true branch. Keys that are
36 * initially true or false can be using in both static_branch_unlikely()
37 * and static_branch_likely() statements.
39 * At runtime we can change the branch target by setting the key
40 * to true via a call to static_branch_enable(), or false using
41 * static_branch_disable(). If the direction of the branch is switched by
42 * these calls then we run-time modify the branch target via a
43 * no-op -> jump or jump -> no-op conversion. For example, for an
44 * initially false key that is used in an "if (static_branch_unlikely(&key))"
45 * statement, setting the key to true requires us to patch in a jump
46 * to the out-of-line of true branch.
48 * In addition to static_branch_{enable,disable}, we can also reference count
49 * the key or branch direction via static_branch_{inc,dec}. Thus,
50 * static_branch_inc() can be thought of as a 'make more true' and
51 * static_branch_dec() as a 'make more false'.
53 * Since this relies on modifying code, the branch modifying functions
54 * must be considered absolute slow paths (machine wide synchronization etc.).
55 * OTOH, since the affected branches are unconditional, their runtime overhead
56 * will be absolutely minimal, esp. in the default (off) case where the total
57 * effect is a single NOP of appropriate size. The on case will patch in a jump
58 * to the out-of-line block.
60 * When the control is directly exposed to userspace, it is prudent to delay the
61 * decrement to avoid high frequency code modifications which can (and do)
62 * cause significant performance degradation. Struct static_key_deferred and
63 * static_key_slow_dec_deferred() provide for this.
65 * Lacking toolchain and or architecture support, static keys fall back to a
66 * simple conditional branch.
68 * Additional babbling in: Documentation/static-keys.txt
71 #if defined(CC_HAVE_ASM_GOTO) && defined(CONFIG_JUMP_LABEL)
72 # define HAVE_JUMP_LABEL
77 #include <linux/types.h>
78 #include <linux/compiler.h>
79 #include <linux/bug.h>
81 extern bool static_key_initialized;
83 #define STATIC_KEY_CHECK_USE() WARN(!static_key_initialized, \
84 "%s used before call to jump_label_init", \
87 #ifdef HAVE_JUMP_LABEL
91 /* Set lsb bit to 1 if branch is default true, 0 ot */
92 struct jump_entry *entries;
94 struct static_key_mod *next;
102 #endif /* HAVE_JUMP_LABEL */
103 #endif /* __ASSEMBLY__ */
105 #ifdef HAVE_JUMP_LABEL
106 #include <asm/jump_label.h>
111 enum jump_label_type {
118 #include <linux/atomic.h>
120 #ifdef HAVE_JUMP_LABEL
122 static inline int static_key_count(struct static_key *key)
125 * -1 means the first static_key_slow_inc() is in progress.
126 * static_key_enabled() must return true, so return 1 here.
128 int n = atomic_read(&key->enabled);
129 return n >= 0 ? n : 1;
132 #define JUMP_TYPE_FALSE 0UL
133 #define JUMP_TYPE_TRUE 1UL
134 #define JUMP_TYPE_MASK 1UL
136 static __always_inline bool static_key_false(struct static_key *key)
138 return arch_static_branch(key, false);
141 static __always_inline bool static_key_true(struct static_key *key)
143 return !arch_static_branch(key, true);
146 extern struct jump_entry __start___jump_table[];
147 extern struct jump_entry __stop___jump_table[];
149 extern void jump_label_init(void);
150 extern void jump_label_lock(void);
151 extern void jump_label_unlock(void);
152 extern void arch_jump_label_transform(struct jump_entry *entry,
153 enum jump_label_type type);
154 extern void arch_jump_label_transform_static(struct jump_entry *entry,
155 enum jump_label_type type);
156 extern int jump_label_text_reserved(void *start, void *end);
157 extern void static_key_slow_inc(struct static_key *key);
158 extern void static_key_slow_dec(struct static_key *key);
159 extern void jump_label_apply_nops(struct module *mod);
161 #define STATIC_KEY_INIT_TRUE \
162 { .enabled = ATOMIC_INIT(1), \
163 .entries = (void *)JUMP_TYPE_TRUE }
164 #define STATIC_KEY_INIT_FALSE \
165 { .enabled = ATOMIC_INIT(0), \
166 .entries = (void *)JUMP_TYPE_FALSE }
168 #else /* !HAVE_JUMP_LABEL */
170 static inline int static_key_count(struct static_key *key)
172 return atomic_read(&key->enabled);
175 static __always_inline void jump_label_init(void)
177 static_key_initialized = true;
180 static __always_inline bool static_key_false(struct static_key *key)
182 if (unlikely(static_key_count(key) > 0))
187 static __always_inline bool static_key_true(struct static_key *key)
189 if (likely(static_key_count(key) > 0))
194 static inline void static_key_slow_inc(struct static_key *key)
196 STATIC_KEY_CHECK_USE();
197 atomic_inc(&key->enabled);
200 static inline void static_key_slow_dec(struct static_key *key)
202 STATIC_KEY_CHECK_USE();
203 atomic_dec(&key->enabled);
206 static inline int jump_label_text_reserved(void *start, void *end)
211 static inline void jump_label_lock(void) {}
212 static inline void jump_label_unlock(void) {}
214 static inline int jump_label_apply_nops(struct module *mod)
219 #define STATIC_KEY_INIT_TRUE { .enabled = ATOMIC_INIT(1) }
220 #define STATIC_KEY_INIT_FALSE { .enabled = ATOMIC_INIT(0) }
222 #endif /* HAVE_JUMP_LABEL */
224 #define STATIC_KEY_INIT STATIC_KEY_INIT_FALSE
225 #define jump_label_enabled static_key_enabled
227 static inline void static_key_enable(struct static_key *key)
229 int count = static_key_count(key);
231 WARN_ON_ONCE(count < 0 || count > 1);
234 static_key_slow_inc(key);
237 static inline void static_key_disable(struct static_key *key)
239 int count = static_key_count(key);
241 WARN_ON_ONCE(count < 0 || count > 1);
244 static_key_slow_dec(key);
247 /* -------------------------------------------------------------------------- */
250 * Two type wrappers around static_key, such that we can use compile time
251 * type differentiation to emit the right code.
253 * All the below code is macros in order to play type games.
256 struct static_key_true {
257 struct static_key key;
260 struct static_key_false {
261 struct static_key key;
264 #define STATIC_KEY_TRUE_INIT (struct static_key_true) { .key = STATIC_KEY_INIT_TRUE, }
265 #define STATIC_KEY_FALSE_INIT (struct static_key_false){ .key = STATIC_KEY_INIT_FALSE, }
267 #define DEFINE_STATIC_KEY_TRUE(name) \
268 struct static_key_true name = STATIC_KEY_TRUE_INIT
270 #define DECLARE_STATIC_KEY_TRUE(name) \
271 extern struct static_key_true name
273 #define DEFINE_STATIC_KEY_FALSE(name) \
274 struct static_key_false name = STATIC_KEY_FALSE_INIT
276 #define DECLARE_STATIC_KEY_FALSE(name) \
277 extern struct static_key_false name
279 extern bool ____wrong_branch_error(void);
281 #define static_key_enabled(x) \
283 if (!__builtin_types_compatible_p(typeof(*x), struct static_key) && \
284 !__builtin_types_compatible_p(typeof(*x), struct static_key_true) &&\
285 !__builtin_types_compatible_p(typeof(*x), struct static_key_false)) \
286 ____wrong_branch_error(); \
287 static_key_count((struct static_key *)x) > 0; \
290 #ifdef HAVE_JUMP_LABEL
293 * Combine the right initial value (type) with the right branch order
294 * to generate the desired result.
297 * type\branch| likely (1) | unlikely (0)
298 * -----------+-----------------------+------------------
300 * true (1) | ... | ...
302 * | <br-stmts> | 1: ...
308 * -----------+-----------------------+------------------
310 * false (0) | ... | ...
312 * | <br-stmts> | 1: ...
318 * -----------+-----------------------+------------------
320 * The initial value is encoded in the LSB of static_key::entries,
321 * type: 0 = false, 1 = true.
323 * The branch type is encoded in the LSB of jump_entry::key,
324 * branch: 0 = unlikely, 1 = likely.
326 * This gives the following logic table:
328 * enabled type branch instuction
329 * -----------------------------+-----------
340 * Which gives the following functions:
342 * dynamic: instruction = enabled ^ branch
343 * static: instruction = type ^ branch
345 * See jump_label_type() / jump_label_init_type().
348 #define static_branch_likely(x) \
351 if (__builtin_types_compatible_p(typeof(*x), struct static_key_true)) \
352 branch = !arch_static_branch(&(x)->key, true); \
353 else if (__builtin_types_compatible_p(typeof(*x), struct static_key_false)) \
354 branch = !arch_static_branch_jump(&(x)->key, true); \
356 branch = ____wrong_branch_error(); \
360 #define static_branch_unlikely(x) \
363 if (__builtin_types_compatible_p(typeof(*x), struct static_key_true)) \
364 branch = arch_static_branch_jump(&(x)->key, false); \
365 else if (__builtin_types_compatible_p(typeof(*x), struct static_key_false)) \
366 branch = arch_static_branch(&(x)->key, false); \
368 branch = ____wrong_branch_error(); \
372 #else /* !HAVE_JUMP_LABEL */
374 #define static_branch_likely(x) likely(static_key_enabled(&(x)->key))
375 #define static_branch_unlikely(x) unlikely(static_key_enabled(&(x)->key))
377 #endif /* HAVE_JUMP_LABEL */
380 * Advanced usage; refcount, branch is enabled when: count != 0
383 #define static_branch_inc(x) static_key_slow_inc(&(x)->key)
384 #define static_branch_dec(x) static_key_slow_dec(&(x)->key)
387 * Normal usage; boolean enable/disable.
390 #define static_branch_enable(x) static_key_enable(&(x)->key)
391 #define static_branch_disable(x) static_key_disable(&(x)->key)
393 #endif /* _LINUX_JUMP_LABEL_H */
395 #endif /* __ASSEMBLY__ */