1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (C) 2009 Jason Baron <jbaron@redhat.com>
6 * Copyright (C) 2011 Peter Zijlstra
9 #include <linux/memory.h>
10 #include <linux/uaccess.h>
11 #include <linux/module.h>
12 #include <linux/list.h>
13 #include <linux/slab.h>
14 #include <linux/sort.h>
15 #include <linux/err.h>
16 #include <linux/static_key.h>
17 #include <linux/jump_label_ratelimit.h>
18 #include <linux/bug.h>
19 #include <linux/cpu.h>
20 #include <asm/sections.h>
22 /* mutex to protect coming/going of the the jump_label table */
23 static DEFINE_MUTEX(jump_label_mutex);
25 void jump_label_lock(void)
27 mutex_lock(&jump_label_mutex);
30 void jump_label_unlock(void)
32 mutex_unlock(&jump_label_mutex);
35 static int jump_label_cmp(const void *a, const void *b)
37 const struct jump_entry *jea = a;
38 const struct jump_entry *jeb = b;
41 * Entrires are sorted by key.
43 if (jump_entry_key(jea) < jump_entry_key(jeb))
46 if (jump_entry_key(jea) > jump_entry_key(jeb))
50 * In the batching mode, entries should also be sorted by the code
51 * inside the already sorted list of entries, enabling a bsearch in
54 if (jump_entry_code(jea) < jump_entry_code(jeb))
57 if (jump_entry_code(jea) > jump_entry_code(jeb))
63 static void jump_label_swap(void *a, void *b, int size)
65 long delta = (unsigned long)a - (unsigned long)b;
66 struct jump_entry *jea = a;
67 struct jump_entry *jeb = b;
68 struct jump_entry tmp = *jea;
70 jea->code = jeb->code - delta;
71 jea->target = jeb->target - delta;
72 jea->key = jeb->key - delta;
74 jeb->code = tmp.code + delta;
75 jeb->target = tmp.target + delta;
76 jeb->key = tmp.key + delta;
80 jump_label_sort_entries(struct jump_entry *start, struct jump_entry *stop)
85 if (IS_ENABLED(CONFIG_HAVE_ARCH_JUMP_LABEL_RELATIVE))
86 swapfn = jump_label_swap;
88 size = (((unsigned long)stop - (unsigned long)start)
89 / sizeof(struct jump_entry));
90 sort(start, size, sizeof(struct jump_entry), jump_label_cmp, swapfn);
93 static void jump_label_update(struct static_key *key);
96 * There are similar definitions for the !CONFIG_JUMP_LABEL case in jump_label.h.
97 * The use of 'atomic_read()' requires atomic.h and its problematic for some
98 * kernel headers such as kernel.h and others. Since static_key_count() is not
99 * used in the branch statements as it is for the !CONFIG_JUMP_LABEL case its ok
100 * to have it be a function here. Similarly, for 'static_key_enable()' and
101 * 'static_key_disable()', which require bug.h. This should allow jump_label.h
102 * to be included from most/all places for CONFIG_JUMP_LABEL.
104 int static_key_count(struct static_key *key)
107 * -1 means the first static_key_slow_inc() is in progress.
108 * static_key_enabled() must return true, so return 1 here.
110 int n = atomic_read(&key->enabled);
112 return n >= 0 ? n : 1;
114 EXPORT_SYMBOL_GPL(static_key_count);
116 void static_key_slow_inc_cpuslocked(struct static_key *key)
120 STATIC_KEY_CHECK_USE(key);
121 lockdep_assert_cpus_held();
124 * Careful if we get concurrent static_key_slow_inc() calls;
125 * later calls must wait for the first one to _finish_ the
126 * jump_label_update() process. At the same time, however,
127 * the jump_label_update() call below wants to see
128 * static_key_enabled(&key) for jumps to be updated properly.
130 * So give a special meaning to negative key->enabled: it sends
131 * static_key_slow_inc() down the slow path, and it is non-zero
132 * so it counts as "enabled" in jump_label_update(). Note that
133 * atomic_inc_unless_negative() checks >= 0, so roll our own.
135 for (v = atomic_read(&key->enabled); v > 0; v = v1) {
136 v1 = atomic_cmpxchg(&key->enabled, v, v + 1);
142 if (atomic_read(&key->enabled) == 0) {
143 atomic_set(&key->enabled, -1);
144 jump_label_update(key);
146 * Ensure that if the above cmpxchg loop observes our positive
147 * value, it must also observe all the text changes.
149 atomic_set_release(&key->enabled, 1);
151 atomic_inc(&key->enabled);
156 void static_key_slow_inc(struct static_key *key)
159 static_key_slow_inc_cpuslocked(key);
162 EXPORT_SYMBOL_GPL(static_key_slow_inc);
164 void static_key_enable_cpuslocked(struct static_key *key)
166 STATIC_KEY_CHECK_USE(key);
167 lockdep_assert_cpus_held();
169 if (atomic_read(&key->enabled) > 0) {
170 WARN_ON_ONCE(atomic_read(&key->enabled) != 1);
175 if (atomic_read(&key->enabled) == 0) {
176 atomic_set(&key->enabled, -1);
177 jump_label_update(key);
179 * See static_key_slow_inc().
181 atomic_set_release(&key->enabled, 1);
185 EXPORT_SYMBOL_GPL(static_key_enable_cpuslocked);
187 void static_key_enable(struct static_key *key)
190 static_key_enable_cpuslocked(key);
193 EXPORT_SYMBOL_GPL(static_key_enable);
195 void static_key_disable_cpuslocked(struct static_key *key)
197 STATIC_KEY_CHECK_USE(key);
198 lockdep_assert_cpus_held();
200 if (atomic_read(&key->enabled) != 1) {
201 WARN_ON_ONCE(atomic_read(&key->enabled) != 0);
206 if (atomic_cmpxchg(&key->enabled, 1, 0))
207 jump_label_update(key);
210 EXPORT_SYMBOL_GPL(static_key_disable_cpuslocked);
212 void static_key_disable(struct static_key *key)
215 static_key_disable_cpuslocked(key);
218 EXPORT_SYMBOL_GPL(static_key_disable);
220 static bool static_key_slow_try_dec(struct static_key *key)
224 val = atomic_fetch_add_unless(&key->enabled, -1, 1);
229 * The negative count check is valid even when a negative
230 * key->enabled is in use by static_key_slow_inc(); a
231 * __static_key_slow_dec() before the first static_key_slow_inc()
232 * returns is unbalanced, because all other static_key_slow_inc()
233 * instances block while the update is in progress.
235 WARN(val < 0, "jump label: negative count!\n");
239 static void __static_key_slow_dec_cpuslocked(struct static_key *key)
241 lockdep_assert_cpus_held();
243 if (static_key_slow_try_dec(key))
247 if (atomic_dec_and_test(&key->enabled))
248 jump_label_update(key);
252 static void __static_key_slow_dec(struct static_key *key)
255 __static_key_slow_dec_cpuslocked(key);
259 void jump_label_update_timeout(struct work_struct *work)
261 struct static_key_deferred *key =
262 container_of(work, struct static_key_deferred, work.work);
263 __static_key_slow_dec(&key->key);
265 EXPORT_SYMBOL_GPL(jump_label_update_timeout);
267 void static_key_slow_dec(struct static_key *key)
269 STATIC_KEY_CHECK_USE(key);
270 __static_key_slow_dec(key);
272 EXPORT_SYMBOL_GPL(static_key_slow_dec);
274 void static_key_slow_dec_cpuslocked(struct static_key *key)
276 STATIC_KEY_CHECK_USE(key);
277 __static_key_slow_dec_cpuslocked(key);
280 void __static_key_slow_dec_deferred(struct static_key *key,
281 struct delayed_work *work,
282 unsigned long timeout)
284 STATIC_KEY_CHECK_USE(key);
286 if (static_key_slow_try_dec(key))
289 schedule_delayed_work(work, timeout);
291 EXPORT_SYMBOL_GPL(__static_key_slow_dec_deferred);
293 void __static_key_deferred_flush(void *key, struct delayed_work *work)
295 STATIC_KEY_CHECK_USE(key);
296 flush_delayed_work(work);
298 EXPORT_SYMBOL_GPL(__static_key_deferred_flush);
300 void jump_label_rate_limit(struct static_key_deferred *key,
303 STATIC_KEY_CHECK_USE(key);
305 INIT_DELAYED_WORK(&key->work, jump_label_update_timeout);
307 EXPORT_SYMBOL_GPL(jump_label_rate_limit);
309 static int addr_conflict(struct jump_entry *entry, void *start, void *end)
311 if (jump_entry_code(entry) <= (unsigned long)end &&
312 jump_entry_code(entry) + JUMP_LABEL_NOP_SIZE > (unsigned long)start)
318 static int __jump_label_text_reserved(struct jump_entry *iter_start,
319 struct jump_entry *iter_stop, void *start, void *end)
321 struct jump_entry *iter;
324 while (iter < iter_stop) {
325 if (addr_conflict(iter, start, end))
334 * Update code which is definitely not currently executing.
335 * Architectures which need heavyweight synchronization to modify
336 * running code can override this to make the non-live update case
339 void __weak __init_or_module arch_jump_label_transform_static(struct jump_entry *entry,
340 enum jump_label_type type)
342 arch_jump_label_transform(entry, type);
345 static inline struct jump_entry *static_key_entries(struct static_key *key)
347 WARN_ON_ONCE(key->type & JUMP_TYPE_LINKED);
348 return (struct jump_entry *)(key->type & ~JUMP_TYPE_MASK);
351 static inline bool static_key_type(struct static_key *key)
353 return key->type & JUMP_TYPE_TRUE;
356 static inline bool static_key_linked(struct static_key *key)
358 return key->type & JUMP_TYPE_LINKED;
361 static inline void static_key_clear_linked(struct static_key *key)
363 key->type &= ~JUMP_TYPE_LINKED;
366 static inline void static_key_set_linked(struct static_key *key)
368 key->type |= JUMP_TYPE_LINKED;
372 * A 'struct static_key' uses a union such that it either points directly
373 * to a table of 'struct jump_entry' or to a linked list of modules which in
374 * turn point to 'struct jump_entry' tables.
376 * The two lower bits of the pointer are used to keep track of which pointer
377 * type is in use and to store the initial branch direction, we use an access
378 * function which preserves these bits.
380 static void static_key_set_entries(struct static_key *key,
381 struct jump_entry *entries)
385 WARN_ON_ONCE((unsigned long)entries & JUMP_TYPE_MASK);
386 type = key->type & JUMP_TYPE_MASK;
387 key->entries = entries;
391 static enum jump_label_type jump_label_type(struct jump_entry *entry)
393 struct static_key *key = jump_entry_key(entry);
394 bool enabled = static_key_enabled(key);
395 bool branch = jump_entry_is_branch(entry);
397 /* See the comment in linux/jump_label.h */
398 return enabled ^ branch;
401 static bool jump_label_can_update(struct jump_entry *entry, bool init)
404 * Cannot update code that was in an init text area.
406 if (!init && jump_entry_is_init(entry))
409 if (!kernel_text_address(jump_entry_code(entry))) {
410 WARN_ONCE(!jump_entry_is_init(entry),
411 "can't patch jump_label at %pS",
412 (void *)jump_entry_code(entry));
419 #ifndef HAVE_JUMP_LABEL_BATCH
420 static void __jump_label_update(struct static_key *key,
421 struct jump_entry *entry,
422 struct jump_entry *stop,
425 for (; (entry < stop) && (jump_entry_key(entry) == key); entry++) {
426 if (jump_label_can_update(entry, init))
427 arch_jump_label_transform(entry, jump_label_type(entry));
431 static void __jump_label_update(struct static_key *key,
432 struct jump_entry *entry,
433 struct jump_entry *stop,
436 for (; (entry < stop) && (jump_entry_key(entry) == key); entry++) {
438 if (!jump_label_can_update(entry, init))
441 if (!arch_jump_label_transform_queue(entry, jump_label_type(entry))) {
443 * Queue is full: Apply the current queue and try again.
445 arch_jump_label_transform_apply();
446 BUG_ON(!arch_jump_label_transform_queue(entry, jump_label_type(entry)));
449 arch_jump_label_transform_apply();
453 void __init jump_label_init(void)
455 struct jump_entry *iter_start = __start___jump_table;
456 struct jump_entry *iter_stop = __stop___jump_table;
457 struct static_key *key = NULL;
458 struct jump_entry *iter;
461 * Since we are initializing the static_key.enabled field with
462 * with the 'raw' int values (to avoid pulling in atomic.h) in
463 * jump_label.h, let's make sure that is safe. There are only two
464 * cases to check since we initialize to 0 or 1.
466 BUILD_BUG_ON((int)ATOMIC_INIT(0) != 0);
467 BUILD_BUG_ON((int)ATOMIC_INIT(1) != 1);
469 if (static_key_initialized)
474 jump_label_sort_entries(iter_start, iter_stop);
476 for (iter = iter_start; iter < iter_stop; iter++) {
477 struct static_key *iterk;
480 if (jump_label_type(iter) == JUMP_LABEL_NOP)
481 arch_jump_label_transform_static(iter, JUMP_LABEL_NOP);
483 if (init_section_contains((void *)jump_entry_code(iter), 1))
484 jump_entry_set_init(iter);
486 iterk = jump_entry_key(iter);
491 static_key_set_entries(key, iter);
493 static_key_initialized = true;
498 #ifdef CONFIG_MODULES
500 static enum jump_label_type jump_label_init_type(struct jump_entry *entry)
502 struct static_key *key = jump_entry_key(entry);
503 bool type = static_key_type(key);
504 bool branch = jump_entry_is_branch(entry);
506 /* See the comment in linux/jump_label.h */
507 return type ^ branch;
510 struct static_key_mod {
511 struct static_key_mod *next;
512 struct jump_entry *entries;
516 static inline struct static_key_mod *static_key_mod(struct static_key *key)
518 WARN_ON_ONCE(!static_key_linked(key));
519 return (struct static_key_mod *)(key->type & ~JUMP_TYPE_MASK);
523 * key->type and key->next are the same via union.
524 * This sets key->next and preserves the type bits.
526 * See additional comments above static_key_set_entries().
528 static void static_key_set_mod(struct static_key *key,
529 struct static_key_mod *mod)
533 WARN_ON_ONCE((unsigned long)mod & JUMP_TYPE_MASK);
534 type = key->type & JUMP_TYPE_MASK;
539 static int __jump_label_mod_text_reserved(void *start, void *end)
544 mod = __module_text_address((unsigned long)start);
545 WARN_ON_ONCE(__module_text_address((unsigned long)end) != mod);
552 return __jump_label_text_reserved(mod->jump_entries,
553 mod->jump_entries + mod->num_jump_entries,
557 static void __jump_label_mod_update(struct static_key *key)
559 struct static_key_mod *mod;
561 for (mod = static_key_mod(key); mod; mod = mod->next) {
562 struct jump_entry *stop;
566 * NULL if the static_key is defined in a module
567 * that does not use it
574 stop = __stop___jump_table;
576 stop = m->jump_entries + m->num_jump_entries;
577 __jump_label_update(key, mod->entries, stop,
578 m && m->state == MODULE_STATE_COMING);
583 * apply_jump_label_nops - patch module jump labels with arch_get_jump_label_nop()
584 * @mod: module to patch
586 * Allow for run-time selection of the optimal nops. Before the module
587 * loads patch these with arch_get_jump_label_nop(), which is specified by
588 * the arch specific jump label code.
590 void jump_label_apply_nops(struct module *mod)
592 struct jump_entry *iter_start = mod->jump_entries;
593 struct jump_entry *iter_stop = iter_start + mod->num_jump_entries;
594 struct jump_entry *iter;
596 /* if the module doesn't have jump label entries, just return */
597 if (iter_start == iter_stop)
600 for (iter = iter_start; iter < iter_stop; iter++) {
601 /* Only write NOPs for arch_branch_static(). */
602 if (jump_label_init_type(iter) == JUMP_LABEL_NOP)
603 arch_jump_label_transform_static(iter, JUMP_LABEL_NOP);
607 static int jump_label_add_module(struct module *mod)
609 struct jump_entry *iter_start = mod->jump_entries;
610 struct jump_entry *iter_stop = iter_start + mod->num_jump_entries;
611 struct jump_entry *iter;
612 struct static_key *key = NULL;
613 struct static_key_mod *jlm, *jlm2;
615 /* if the module doesn't have jump label entries, just return */
616 if (iter_start == iter_stop)
619 jump_label_sort_entries(iter_start, iter_stop);
621 for (iter = iter_start; iter < iter_stop; iter++) {
622 struct static_key *iterk;
624 if (within_module_init(jump_entry_code(iter), mod))
625 jump_entry_set_init(iter);
627 iterk = jump_entry_key(iter);
632 if (within_module((unsigned long)key, mod)) {
633 static_key_set_entries(key, iter);
636 jlm = kzalloc(sizeof(struct static_key_mod), GFP_KERNEL);
639 if (!static_key_linked(key)) {
640 jlm2 = kzalloc(sizeof(struct static_key_mod),
647 jlm2->mod = __module_address((unsigned long)key);
649 jlm2->entries = static_key_entries(key);
651 static_key_set_mod(key, jlm2);
652 static_key_set_linked(key);
656 jlm->next = static_key_mod(key);
657 static_key_set_mod(key, jlm);
658 static_key_set_linked(key);
660 /* Only update if we've changed from our initial state */
661 if (jump_label_type(iter) != jump_label_init_type(iter))
662 __jump_label_update(key, iter, iter_stop, true);
668 static void jump_label_del_module(struct module *mod)
670 struct jump_entry *iter_start = mod->jump_entries;
671 struct jump_entry *iter_stop = iter_start + mod->num_jump_entries;
672 struct jump_entry *iter;
673 struct static_key *key = NULL;
674 struct static_key_mod *jlm, **prev;
676 for (iter = iter_start; iter < iter_stop; iter++) {
677 if (jump_entry_key(iter) == key)
680 key = jump_entry_key(iter);
682 if (within_module((unsigned long)key, mod))
685 /* No memory during module load */
686 if (WARN_ON(!static_key_linked(key)))
690 jlm = static_key_mod(key);
692 while (jlm && jlm->mod != mod) {
697 /* No memory during module load */
701 if (prev == &key->next)
702 static_key_set_mod(key, jlm->next);
708 jlm = static_key_mod(key);
709 /* if only one etry is left, fold it back into the static_key */
710 if (jlm->next == NULL) {
711 static_key_set_entries(key, jlm->entries);
712 static_key_clear_linked(key);
719 jump_label_module_notify(struct notifier_block *self, unsigned long val,
722 struct module *mod = data;
729 case MODULE_STATE_COMING:
730 ret = jump_label_add_module(mod);
732 WARN(1, "Failed to allocate memory: jump_label may not work properly.\n");
733 jump_label_del_module(mod);
736 case MODULE_STATE_GOING:
737 jump_label_del_module(mod);
744 return notifier_from_errno(ret);
747 static struct notifier_block jump_label_module_nb = {
748 .notifier_call = jump_label_module_notify,
749 .priority = 1, /* higher than tracepoints */
752 static __init int jump_label_init_module(void)
754 return register_module_notifier(&jump_label_module_nb);
756 early_initcall(jump_label_init_module);
758 #endif /* CONFIG_MODULES */
761 * jump_label_text_reserved - check if addr range is reserved
762 * @start: start text addr
763 * @end: end text addr
765 * checks if the text addr located between @start and @end
766 * overlaps with any of the jump label patch addresses. Code
767 * that wants to modify kernel text should first verify that
768 * it does not overlap with any of the jump label addresses.
769 * Caller must hold jump_label_mutex.
771 * returns 1 if there is an overlap, 0 otherwise
773 int jump_label_text_reserved(void *start, void *end)
775 int ret = __jump_label_text_reserved(__start___jump_table,
776 __stop___jump_table, start, end);
781 #ifdef CONFIG_MODULES
782 ret = __jump_label_mod_text_reserved(start, end);
787 static void jump_label_update(struct static_key *key)
789 struct jump_entry *stop = __stop___jump_table;
790 struct jump_entry *entry;
791 #ifdef CONFIG_MODULES
794 if (static_key_linked(key)) {
795 __jump_label_mod_update(key);
800 mod = __module_address((unsigned long)key);
802 stop = mod->jump_entries + mod->num_jump_entries;
805 entry = static_key_entries(key);
806 /* if there are no users, entry can be NULL */
808 __jump_label_update(key, entry, stop,
809 system_state < SYSTEM_RUNNING);
812 #ifdef CONFIG_STATIC_KEYS_SELFTEST
813 static DEFINE_STATIC_KEY_TRUE(sk_true);
814 static DEFINE_STATIC_KEY_FALSE(sk_false);
816 static __init int jump_label_test(void)
820 for (i = 0; i < 2; i++) {
821 WARN_ON(static_key_enabled(&sk_true.key) != true);
822 WARN_ON(static_key_enabled(&sk_false.key) != false);
824 WARN_ON(!static_branch_likely(&sk_true));
825 WARN_ON(!static_branch_unlikely(&sk_true));
826 WARN_ON(static_branch_likely(&sk_false));
827 WARN_ON(static_branch_unlikely(&sk_false));
829 static_branch_disable(&sk_true);
830 static_branch_enable(&sk_false);
832 WARN_ON(static_key_enabled(&sk_true.key) == true);
833 WARN_ON(static_key_enabled(&sk_false.key) == false);
835 WARN_ON(static_branch_likely(&sk_true));
836 WARN_ON(static_branch_unlikely(&sk_true));
837 WARN_ON(!static_branch_likely(&sk_false));
838 WARN_ON(!static_branch_unlikely(&sk_false));
840 static_branch_enable(&sk_true);
841 static_branch_disable(&sk_false);
846 early_initcall(jump_label_test);
847 #endif /* STATIC_KEYS_SELFTEST */