4 * Copyright (C) 2009 Jason Baron <jbaron@redhat.com>
5 * Copyright (C) 2011 Peter Zijlstra
8 #include <linux/memory.h>
9 #include <linux/uaccess.h>
10 #include <linux/module.h>
11 #include <linux/list.h>
12 #include <linux/slab.h>
13 #include <linux/sort.h>
14 #include <linux/err.h>
15 #include <linux/static_key.h>
16 #include <linux/jump_label_ratelimit.h>
17 #include <linux/bug.h>
18 #include <linux/cpu.h>
19 #include <asm/sections.h>
21 /* mutex to protect coming/going of the the jump_label table */
22 static DEFINE_MUTEX(jump_label_mutex);
24 void jump_label_lock(void)
26 mutex_lock(&jump_label_mutex);
29 void jump_label_unlock(void)
31 mutex_unlock(&jump_label_mutex);
34 static int jump_label_cmp(const void *a, const void *b)
36 const struct jump_entry *jea = a;
37 const struct jump_entry *jeb = b;
39 if (jump_entry_key(jea) < jump_entry_key(jeb))
42 if (jump_entry_key(jea) > jump_entry_key(jeb))
48 static void jump_label_swap(void *a, void *b, int size)
50 long delta = (unsigned long)a - (unsigned long)b;
51 struct jump_entry *jea = a;
52 struct jump_entry *jeb = b;
53 struct jump_entry tmp = *jea;
55 jea->code = jeb->code - delta;
56 jea->target = jeb->target - delta;
57 jea->key = jeb->key - delta;
59 jeb->code = tmp.code + delta;
60 jeb->target = tmp.target + delta;
61 jeb->key = tmp.key + delta;
65 jump_label_sort_entries(struct jump_entry *start, struct jump_entry *stop)
70 if (IS_ENABLED(CONFIG_HAVE_ARCH_JUMP_LABEL_RELATIVE))
71 swapfn = jump_label_swap;
73 size = (((unsigned long)stop - (unsigned long)start)
74 / sizeof(struct jump_entry));
75 sort(start, size, sizeof(struct jump_entry), jump_label_cmp, swapfn);
78 static void jump_label_update(struct static_key *key);
81 * There are similar definitions for the !CONFIG_JUMP_LABEL case in jump_label.h.
82 * The use of 'atomic_read()' requires atomic.h and its problematic for some
83 * kernel headers such as kernel.h and others. Since static_key_count() is not
84 * used in the branch statements as it is for the !CONFIG_JUMP_LABEL case its ok
85 * to have it be a function here. Similarly, for 'static_key_enable()' and
86 * 'static_key_disable()', which require bug.h. This should allow jump_label.h
87 * to be included from most/all places for CONFIG_JUMP_LABEL.
89 int static_key_count(struct static_key *key)
92 * -1 means the first static_key_slow_inc() is in progress.
93 * static_key_enabled() must return true, so return 1 here.
95 int n = atomic_read(&key->enabled);
97 return n >= 0 ? n : 1;
99 EXPORT_SYMBOL_GPL(static_key_count);
101 void static_key_slow_inc_cpuslocked(struct static_key *key)
105 STATIC_KEY_CHECK_USE(key);
106 lockdep_assert_cpus_held();
109 * Careful if we get concurrent static_key_slow_inc() calls;
110 * later calls must wait for the first one to _finish_ the
111 * jump_label_update() process. At the same time, however,
112 * the jump_label_update() call below wants to see
113 * static_key_enabled(&key) for jumps to be updated properly.
115 * So give a special meaning to negative key->enabled: it sends
116 * static_key_slow_inc() down the slow path, and it is non-zero
117 * so it counts as "enabled" in jump_label_update(). Note that
118 * atomic_inc_unless_negative() checks >= 0, so roll our own.
120 for (v = atomic_read(&key->enabled); v > 0; v = v1) {
121 v1 = atomic_cmpxchg(&key->enabled, v, v + 1);
127 if (atomic_read(&key->enabled) == 0) {
128 atomic_set(&key->enabled, -1);
129 jump_label_update(key);
131 * Ensure that if the above cmpxchg loop observes our positive
132 * value, it must also observe all the text changes.
134 atomic_set_release(&key->enabled, 1);
136 atomic_inc(&key->enabled);
141 void static_key_slow_inc(struct static_key *key)
144 static_key_slow_inc_cpuslocked(key);
147 EXPORT_SYMBOL_GPL(static_key_slow_inc);
149 void static_key_enable_cpuslocked(struct static_key *key)
151 STATIC_KEY_CHECK_USE(key);
152 lockdep_assert_cpus_held();
154 if (atomic_read(&key->enabled) > 0) {
155 WARN_ON_ONCE(atomic_read(&key->enabled) != 1);
160 if (atomic_read(&key->enabled) == 0) {
161 atomic_set(&key->enabled, -1);
162 jump_label_update(key);
164 * See static_key_slow_inc().
166 atomic_set_release(&key->enabled, 1);
170 EXPORT_SYMBOL_GPL(static_key_enable_cpuslocked);
172 void static_key_enable(struct static_key *key)
175 static_key_enable_cpuslocked(key);
178 EXPORT_SYMBOL_GPL(static_key_enable);
180 void static_key_disable_cpuslocked(struct static_key *key)
182 STATIC_KEY_CHECK_USE(key);
183 lockdep_assert_cpus_held();
185 if (atomic_read(&key->enabled) != 1) {
186 WARN_ON_ONCE(atomic_read(&key->enabled) != 0);
191 if (atomic_cmpxchg(&key->enabled, 1, 0))
192 jump_label_update(key);
195 EXPORT_SYMBOL_GPL(static_key_disable_cpuslocked);
197 void static_key_disable(struct static_key *key)
200 static_key_disable_cpuslocked(key);
203 EXPORT_SYMBOL_GPL(static_key_disable);
205 static bool static_key_slow_try_dec(struct static_key *key)
209 val = atomic_fetch_add_unless(&key->enabled, -1, 1);
214 * The negative count check is valid even when a negative
215 * key->enabled is in use by static_key_slow_inc(); a
216 * __static_key_slow_dec() before the first static_key_slow_inc()
217 * returns is unbalanced, because all other static_key_slow_inc()
218 * instances block while the update is in progress.
220 WARN(val < 0, "jump label: negative count!\n");
224 static void __static_key_slow_dec_cpuslocked(struct static_key *key,
225 unsigned long rate_limit,
226 struct delayed_work *work)
228 lockdep_assert_cpus_held();
230 if (static_key_slow_try_dec(key))
234 if (atomic_dec_and_test(&key->enabled)) {
236 atomic_inc(&key->enabled);
237 schedule_delayed_work(work, rate_limit);
239 jump_label_update(key);
245 static void __static_key_slow_dec(struct static_key *key,
246 unsigned long rate_limit,
247 struct delayed_work *work)
250 __static_key_slow_dec_cpuslocked(key, rate_limit, work);
254 void jump_label_update_timeout(struct work_struct *work)
256 struct static_key_deferred *key =
257 container_of(work, struct static_key_deferred, work.work);
258 __static_key_slow_dec(&key->key, 0, NULL);
260 EXPORT_SYMBOL_GPL(jump_label_update_timeout);
262 void static_key_slow_dec(struct static_key *key)
264 STATIC_KEY_CHECK_USE(key);
265 __static_key_slow_dec(key, 0, NULL);
267 EXPORT_SYMBOL_GPL(static_key_slow_dec);
269 void static_key_slow_dec_cpuslocked(struct static_key *key)
271 STATIC_KEY_CHECK_USE(key);
272 __static_key_slow_dec_cpuslocked(key, 0, NULL);
275 void __static_key_slow_dec_deferred(struct static_key *key,
276 struct delayed_work *work,
277 unsigned long timeout)
279 STATIC_KEY_CHECK_USE(key);
280 __static_key_slow_dec(key, timeout, work);
282 EXPORT_SYMBOL_GPL(__static_key_slow_dec_deferred);
284 void __static_key_deferred_flush(void *key, struct delayed_work *work)
286 STATIC_KEY_CHECK_USE(key);
287 flush_delayed_work(work);
289 EXPORT_SYMBOL_GPL(__static_key_deferred_flush);
291 void jump_label_rate_limit(struct static_key_deferred *key,
294 STATIC_KEY_CHECK_USE(key);
296 INIT_DELAYED_WORK(&key->work, jump_label_update_timeout);
298 EXPORT_SYMBOL_GPL(jump_label_rate_limit);
300 static int addr_conflict(struct jump_entry *entry, void *start, void *end)
302 if (jump_entry_code(entry) <= (unsigned long)end &&
303 jump_entry_code(entry) + JUMP_LABEL_NOP_SIZE > (unsigned long)start)
309 static int __jump_label_text_reserved(struct jump_entry *iter_start,
310 struct jump_entry *iter_stop, void *start, void *end)
312 struct jump_entry *iter;
315 while (iter < iter_stop) {
316 if (addr_conflict(iter, start, end))
325 * Update code which is definitely not currently executing.
326 * Architectures which need heavyweight synchronization to modify
327 * running code can override this to make the non-live update case
330 void __weak __init_or_module arch_jump_label_transform_static(struct jump_entry *entry,
331 enum jump_label_type type)
333 arch_jump_label_transform(entry, type);
336 static inline struct jump_entry *static_key_entries(struct static_key *key)
338 WARN_ON_ONCE(key->type & JUMP_TYPE_LINKED);
339 return (struct jump_entry *)(key->type & ~JUMP_TYPE_MASK);
342 static inline bool static_key_type(struct static_key *key)
344 return key->type & JUMP_TYPE_TRUE;
347 static inline bool static_key_linked(struct static_key *key)
349 return key->type & JUMP_TYPE_LINKED;
352 static inline void static_key_clear_linked(struct static_key *key)
354 key->type &= ~JUMP_TYPE_LINKED;
357 static inline void static_key_set_linked(struct static_key *key)
359 key->type |= JUMP_TYPE_LINKED;
363 * A 'struct static_key' uses a union such that it either points directly
364 * to a table of 'struct jump_entry' or to a linked list of modules which in
365 * turn point to 'struct jump_entry' tables.
367 * The two lower bits of the pointer are used to keep track of which pointer
368 * type is in use and to store the initial branch direction, we use an access
369 * function which preserves these bits.
371 static void static_key_set_entries(struct static_key *key,
372 struct jump_entry *entries)
376 WARN_ON_ONCE((unsigned long)entries & JUMP_TYPE_MASK);
377 type = key->type & JUMP_TYPE_MASK;
378 key->entries = entries;
382 static enum jump_label_type jump_label_type(struct jump_entry *entry)
384 struct static_key *key = jump_entry_key(entry);
385 bool enabled = static_key_enabled(key);
386 bool branch = jump_entry_is_branch(entry);
388 /* See the comment in linux/jump_label.h */
389 return enabled ^ branch;
392 static void __jump_label_update(struct static_key *key,
393 struct jump_entry *entry,
394 struct jump_entry *stop,
397 for (; (entry < stop) && (jump_entry_key(entry) == key); entry++) {
399 * An entry->code of 0 indicates an entry which has been
400 * disabled because it was in an init text area.
402 if (init || !jump_entry_is_init(entry)) {
403 if (kernel_text_address(jump_entry_code(entry)))
404 arch_jump_label_transform(entry, jump_label_type(entry));
406 WARN_ONCE(1, "can't patch jump_label at %pS",
407 (void *)jump_entry_code(entry));
412 void __init jump_label_init(void)
414 struct jump_entry *iter_start = __start___jump_table;
415 struct jump_entry *iter_stop = __stop___jump_table;
416 struct static_key *key = NULL;
417 struct jump_entry *iter;
420 * Since we are initializing the static_key.enabled field with
421 * with the 'raw' int values (to avoid pulling in atomic.h) in
422 * jump_label.h, let's make sure that is safe. There are only two
423 * cases to check since we initialize to 0 or 1.
425 BUILD_BUG_ON((int)ATOMIC_INIT(0) != 0);
426 BUILD_BUG_ON((int)ATOMIC_INIT(1) != 1);
428 if (static_key_initialized)
433 jump_label_sort_entries(iter_start, iter_stop);
435 for (iter = iter_start; iter < iter_stop; iter++) {
436 struct static_key *iterk;
439 if (jump_label_type(iter) == JUMP_LABEL_NOP)
440 arch_jump_label_transform_static(iter, JUMP_LABEL_NOP);
442 if (init_section_contains((void *)jump_entry_code(iter), 1))
443 jump_entry_set_init(iter);
445 iterk = jump_entry_key(iter);
450 static_key_set_entries(key, iter);
452 static_key_initialized = true;
457 #ifdef CONFIG_MODULES
459 static enum jump_label_type jump_label_init_type(struct jump_entry *entry)
461 struct static_key *key = jump_entry_key(entry);
462 bool type = static_key_type(key);
463 bool branch = jump_entry_is_branch(entry);
465 /* See the comment in linux/jump_label.h */
466 return type ^ branch;
469 struct static_key_mod {
470 struct static_key_mod *next;
471 struct jump_entry *entries;
475 static inline struct static_key_mod *static_key_mod(struct static_key *key)
477 WARN_ON_ONCE(!static_key_linked(key));
478 return (struct static_key_mod *)(key->type & ~JUMP_TYPE_MASK);
482 * key->type and key->next are the same via union.
483 * This sets key->next and preserves the type bits.
485 * See additional comments above static_key_set_entries().
487 static void static_key_set_mod(struct static_key *key,
488 struct static_key_mod *mod)
492 WARN_ON_ONCE((unsigned long)mod & JUMP_TYPE_MASK);
493 type = key->type & JUMP_TYPE_MASK;
498 static int __jump_label_mod_text_reserved(void *start, void *end)
503 mod = __module_text_address((unsigned long)start);
504 WARN_ON_ONCE(__module_text_address((unsigned long)end) != mod);
511 return __jump_label_text_reserved(mod->jump_entries,
512 mod->jump_entries + mod->num_jump_entries,
516 static void __jump_label_mod_update(struct static_key *key)
518 struct static_key_mod *mod;
520 for (mod = static_key_mod(key); mod; mod = mod->next) {
521 struct jump_entry *stop;
525 * NULL if the static_key is defined in a module
526 * that does not use it
533 stop = __stop___jump_table;
535 stop = m->jump_entries + m->num_jump_entries;
536 __jump_label_update(key, mod->entries, stop,
537 m && m->state == MODULE_STATE_COMING);
542 * apply_jump_label_nops - patch module jump labels with arch_get_jump_label_nop()
543 * @mod: module to patch
545 * Allow for run-time selection of the optimal nops. Before the module
546 * loads patch these with arch_get_jump_label_nop(), which is specified by
547 * the arch specific jump label code.
549 void jump_label_apply_nops(struct module *mod)
551 struct jump_entry *iter_start = mod->jump_entries;
552 struct jump_entry *iter_stop = iter_start + mod->num_jump_entries;
553 struct jump_entry *iter;
555 /* if the module doesn't have jump label entries, just return */
556 if (iter_start == iter_stop)
559 for (iter = iter_start; iter < iter_stop; iter++) {
560 /* Only write NOPs for arch_branch_static(). */
561 if (jump_label_init_type(iter) == JUMP_LABEL_NOP)
562 arch_jump_label_transform_static(iter, JUMP_LABEL_NOP);
566 static int jump_label_add_module(struct module *mod)
568 struct jump_entry *iter_start = mod->jump_entries;
569 struct jump_entry *iter_stop = iter_start + mod->num_jump_entries;
570 struct jump_entry *iter;
571 struct static_key *key = NULL;
572 struct static_key_mod *jlm, *jlm2;
574 /* if the module doesn't have jump label entries, just return */
575 if (iter_start == iter_stop)
578 jump_label_sort_entries(iter_start, iter_stop);
580 for (iter = iter_start; iter < iter_stop; iter++) {
581 struct static_key *iterk;
583 if (within_module_init(jump_entry_code(iter), mod))
584 jump_entry_set_init(iter);
586 iterk = jump_entry_key(iter);
591 if (within_module((unsigned long)key, mod)) {
592 static_key_set_entries(key, iter);
595 jlm = kzalloc(sizeof(struct static_key_mod), GFP_KERNEL);
598 if (!static_key_linked(key)) {
599 jlm2 = kzalloc(sizeof(struct static_key_mod),
606 jlm2->mod = __module_address((unsigned long)key);
608 jlm2->entries = static_key_entries(key);
610 static_key_set_mod(key, jlm2);
611 static_key_set_linked(key);
615 jlm->next = static_key_mod(key);
616 static_key_set_mod(key, jlm);
617 static_key_set_linked(key);
619 /* Only update if we've changed from our initial state */
620 if (jump_label_type(iter) != jump_label_init_type(iter))
621 __jump_label_update(key, iter, iter_stop, true);
627 static void jump_label_del_module(struct module *mod)
629 struct jump_entry *iter_start = mod->jump_entries;
630 struct jump_entry *iter_stop = iter_start + mod->num_jump_entries;
631 struct jump_entry *iter;
632 struct static_key *key = NULL;
633 struct static_key_mod *jlm, **prev;
635 for (iter = iter_start; iter < iter_stop; iter++) {
636 if (jump_entry_key(iter) == key)
639 key = jump_entry_key(iter);
641 if (within_module((unsigned long)key, mod))
644 /* No memory during module load */
645 if (WARN_ON(!static_key_linked(key)))
649 jlm = static_key_mod(key);
651 while (jlm && jlm->mod != mod) {
656 /* No memory during module load */
660 if (prev == &key->next)
661 static_key_set_mod(key, jlm->next);
667 jlm = static_key_mod(key);
668 /* if only one etry is left, fold it back into the static_key */
669 if (jlm->next == NULL) {
670 static_key_set_entries(key, jlm->entries);
671 static_key_clear_linked(key);
678 jump_label_module_notify(struct notifier_block *self, unsigned long val,
681 struct module *mod = data;
688 case MODULE_STATE_COMING:
689 ret = jump_label_add_module(mod);
691 WARN(1, "Failed to allocate memory: jump_label may not work properly.\n");
692 jump_label_del_module(mod);
695 case MODULE_STATE_GOING:
696 jump_label_del_module(mod);
703 return notifier_from_errno(ret);
706 static struct notifier_block jump_label_module_nb = {
707 .notifier_call = jump_label_module_notify,
708 .priority = 1, /* higher than tracepoints */
711 static __init int jump_label_init_module(void)
713 return register_module_notifier(&jump_label_module_nb);
715 early_initcall(jump_label_init_module);
717 #endif /* CONFIG_MODULES */
720 * jump_label_text_reserved - check if addr range is reserved
721 * @start: start text addr
722 * @end: end text addr
724 * checks if the text addr located between @start and @end
725 * overlaps with any of the jump label patch addresses. Code
726 * that wants to modify kernel text should first verify that
727 * it does not overlap with any of the jump label addresses.
728 * Caller must hold jump_label_mutex.
730 * returns 1 if there is an overlap, 0 otherwise
732 int jump_label_text_reserved(void *start, void *end)
734 int ret = __jump_label_text_reserved(__start___jump_table,
735 __stop___jump_table, start, end);
740 #ifdef CONFIG_MODULES
741 ret = __jump_label_mod_text_reserved(start, end);
746 static void jump_label_update(struct static_key *key)
748 struct jump_entry *stop = __stop___jump_table;
749 struct jump_entry *entry;
750 #ifdef CONFIG_MODULES
753 if (static_key_linked(key)) {
754 __jump_label_mod_update(key);
759 mod = __module_address((unsigned long)key);
761 stop = mod->jump_entries + mod->num_jump_entries;
764 entry = static_key_entries(key);
765 /* if there are no users, entry can be NULL */
767 __jump_label_update(key, entry, stop,
768 system_state < SYSTEM_RUNNING);
771 #ifdef CONFIG_STATIC_KEYS_SELFTEST
772 static DEFINE_STATIC_KEY_TRUE(sk_true);
773 static DEFINE_STATIC_KEY_FALSE(sk_false);
775 static __init int jump_label_test(void)
779 for (i = 0; i < 2; i++) {
780 WARN_ON(static_key_enabled(&sk_true.key) != true);
781 WARN_ON(static_key_enabled(&sk_false.key) != false);
783 WARN_ON(!static_branch_likely(&sk_true));
784 WARN_ON(!static_branch_unlikely(&sk_true));
785 WARN_ON(static_branch_likely(&sk_false));
786 WARN_ON(static_branch_unlikely(&sk_false));
788 static_branch_disable(&sk_true);
789 static_branch_enable(&sk_false);
791 WARN_ON(static_key_enabled(&sk_true.key) == true);
792 WARN_ON(static_key_enabled(&sk_false.key) == false);
794 WARN_ON(static_branch_likely(&sk_true));
795 WARN_ON(static_branch_unlikely(&sk_true));
796 WARN_ON(!static_branch_likely(&sk_false));
797 WARN_ON(!static_branch_unlikely(&sk_false));
799 static_branch_enable(&sk_true);
800 static_branch_disable(&sk_false);
805 early_initcall(jump_label_test);
806 #endif /* STATIC_KEYS_SELFTEST */