PCI: Tolerate hierarchies with no Root Port
[linux-2.6-block.git] / kernel / jump_label.c
CommitLineData
bf5438fc
JB
1/*
2 * jump label support
3 *
4 * Copyright (C) 2009 Jason Baron <jbaron@redhat.com>
d430d3d7 5 * Copyright (C) 2011 Peter Zijlstra <pzijlstr@redhat.com>
bf5438fc
JB
6 *
7 */
bf5438fc
JB
8#include <linux/memory.h>
9#include <linux/uaccess.h>
10#include <linux/module.h>
11#include <linux/list.h>
bf5438fc
JB
12#include <linux/slab.h>
13#include <linux/sort.h>
14#include <linux/err.h>
c5905afb 15#include <linux/static_key.h>
851cf6e7 16#include <linux/jump_label_ratelimit.h>
bf5438fc
JB
17
18#ifdef HAVE_JUMP_LABEL
19
bf5438fc
JB
20/* mutex to protect coming/going of the the jump_label table */
21static DEFINE_MUTEX(jump_label_mutex);
22
91bad2f8
JB
23void jump_label_lock(void)
24{
25 mutex_lock(&jump_label_mutex);
26}
27
28void jump_label_unlock(void)
29{
30 mutex_unlock(&jump_label_mutex);
31}
32
bf5438fc
JB
33static int jump_label_cmp(const void *a, const void *b)
34{
35 const struct jump_entry *jea = a;
36 const struct jump_entry *jeb = b;
37
38 if (jea->key < jeb->key)
39 return -1;
40
41 if (jea->key > jeb->key)
42 return 1;
43
44 return 0;
45}
46
47static void
d430d3d7 48jump_label_sort_entries(struct jump_entry *start, struct jump_entry *stop)
bf5438fc
JB
49{
50 unsigned long size;
51
52 size = (((unsigned long)stop - (unsigned long)start)
53 / sizeof(struct jump_entry));
54 sort(start, size, sizeof(struct jump_entry), jump_label_cmp, NULL);
55}
56
c5905afb 57static void jump_label_update(struct static_key *key, int enable);
bf5438fc 58
c5905afb 59void static_key_slow_inc(struct static_key *key)
bf5438fc 60{
c4b2c0c5 61 STATIC_KEY_CHECK_USE();
d430d3d7
JB
62 if (atomic_inc_not_zero(&key->enabled))
63 return;
bf5438fc 64
d430d3d7 65 jump_label_lock();
c5905afb
IM
66 if (atomic_read(&key->enabled) == 0) {
67 if (!jump_label_get_branch_default(key))
68 jump_label_update(key, JUMP_LABEL_ENABLE);
69 else
70 jump_label_update(key, JUMP_LABEL_DISABLE);
71 }
bbbf7af4 72 atomic_inc(&key->enabled);
d430d3d7 73 jump_label_unlock();
bf5438fc 74}
c5905afb 75EXPORT_SYMBOL_GPL(static_key_slow_inc);
bf5438fc 76
c5905afb 77static void __static_key_slow_dec(struct static_key *key,
b2029520 78 unsigned long rate_limit, struct delayed_work *work)
bf5438fc 79{
fadf0464
JB
80 if (!atomic_dec_and_mutex_lock(&key->enabled, &jump_label_mutex)) {
81 WARN(atomic_read(&key->enabled) < 0,
82 "jump label: negative count!\n");
d430d3d7 83 return;
fadf0464 84 }
bf5438fc 85
b2029520
GN
86 if (rate_limit) {
87 atomic_inc(&key->enabled);
88 schedule_delayed_work(work, rate_limit);
c5905afb
IM
89 } else {
90 if (!jump_label_get_branch_default(key))
91 jump_label_update(key, JUMP_LABEL_DISABLE);
92 else
93 jump_label_update(key, JUMP_LABEL_ENABLE);
94 }
91bad2f8 95 jump_label_unlock();
bf5438fc
JB
96}
97
b2029520
GN
98static void jump_label_update_timeout(struct work_struct *work)
99{
c5905afb
IM
100 struct static_key_deferred *key =
101 container_of(work, struct static_key_deferred, work.work);
102 __static_key_slow_dec(&key->key, 0, NULL);
b2029520
GN
103}
104
c5905afb 105void static_key_slow_dec(struct static_key *key)
b2029520 106{
c4b2c0c5 107 STATIC_KEY_CHECK_USE();
c5905afb 108 __static_key_slow_dec(key, 0, NULL);
b2029520 109}
c5905afb 110EXPORT_SYMBOL_GPL(static_key_slow_dec);
b2029520 111
c5905afb 112void static_key_slow_dec_deferred(struct static_key_deferred *key)
b2029520 113{
c4b2c0c5 114 STATIC_KEY_CHECK_USE();
c5905afb 115 __static_key_slow_dec(&key->key, key->timeout, &key->work);
b2029520 116}
c5905afb 117EXPORT_SYMBOL_GPL(static_key_slow_dec_deferred);
b2029520 118
c5905afb 119void jump_label_rate_limit(struct static_key_deferred *key,
b2029520
GN
120 unsigned long rl)
121{
c4b2c0c5 122 STATIC_KEY_CHECK_USE();
b2029520
GN
123 key->timeout = rl;
124 INIT_DELAYED_WORK(&key->work, jump_label_update_timeout);
125}
a181dc14 126EXPORT_SYMBOL_GPL(jump_label_rate_limit);
b2029520 127
4c3ef6d7
JB
128static int addr_conflict(struct jump_entry *entry, void *start, void *end)
129{
130 if (entry->code <= (unsigned long)end &&
131 entry->code + JUMP_LABEL_NOP_SIZE > (unsigned long)start)
132 return 1;
133
134 return 0;
135}
136
d430d3d7
JB
137static int __jump_label_text_reserved(struct jump_entry *iter_start,
138 struct jump_entry *iter_stop, void *start, void *end)
4c3ef6d7 139{
4c3ef6d7 140 struct jump_entry *iter;
4c3ef6d7 141
4c3ef6d7
JB
142 iter = iter_start;
143 while (iter < iter_stop) {
d430d3d7
JB
144 if (addr_conflict(iter, start, end))
145 return 1;
4c3ef6d7
JB
146 iter++;
147 }
148
d430d3d7
JB
149 return 0;
150}
151
20284aa7
JF
152/*
153 * Update code which is definitely not currently executing.
154 * Architectures which need heavyweight synchronization to modify
155 * running code can override this to make the non-live update case
156 * cheaper.
157 */
9cdbe1cb 158void __weak __init_or_module arch_jump_label_transform_static(struct jump_entry *entry,
20284aa7
JF
159 enum jump_label_type type)
160{
161 arch_jump_label_transform(entry, type);
162}
163
c5905afb 164static void __jump_label_update(struct static_key *key,
7cbc5b8d
JO
165 struct jump_entry *entry,
166 struct jump_entry *stop, int enable)
d430d3d7 167{
7cbc5b8d
JO
168 for (; (entry < stop) &&
169 (entry->key == (jump_label_t)(unsigned long)key);
170 entry++) {
d430d3d7
JB
171 /*
172 * entry->code set to 0 invalidates module init text sections
173 * kernel_text_address() verifies we are not in core kernel
174 * init code, see jump_label_invalidate_module_init().
175 */
176 if (entry->code && kernel_text_address(entry->code))
177 arch_jump_label_transform(entry, enable);
178 }
4c3ef6d7
JB
179}
180
c5905afb
IM
181static enum jump_label_type jump_label_type(struct static_key *key)
182{
183 bool true_branch = jump_label_get_branch_default(key);
184 bool state = static_key_enabled(key);
185
186 if ((!true_branch && state) || (true_branch && !state))
187 return JUMP_LABEL_ENABLE;
188
189 return JUMP_LABEL_DISABLE;
190}
191
97ce2c88 192void __init jump_label_init(void)
bf5438fc 193{
bf5438fc
JB
194 struct jump_entry *iter_start = __start___jump_table;
195 struct jump_entry *iter_stop = __stop___jump_table;
c5905afb 196 struct static_key *key = NULL;
bf5438fc
JB
197 struct jump_entry *iter;
198
91bad2f8 199 jump_label_lock();
d430d3d7
JB
200 jump_label_sort_entries(iter_start, iter_stop);
201
202 for (iter = iter_start; iter < iter_stop; iter++) {
c5905afb 203 struct static_key *iterk;
37348804 204
c5905afb
IM
205 iterk = (struct static_key *)(unsigned long)iter->key;
206 arch_jump_label_transform_static(iter, jump_label_type(iterk));
37348804 207 if (iterk == key)
d430d3d7
JB
208 continue;
209
37348804 210 key = iterk;
c5905afb
IM
211 /*
212 * Set key->entries to iter, but preserve JUMP_LABEL_TRUE_BRANCH.
213 */
214 *((unsigned long *)&key->entries) += (unsigned long)iter;
d430d3d7
JB
215#ifdef CONFIG_MODULES
216 key->next = NULL;
217#endif
bf5438fc 218 }
c4b2c0c5 219 static_key_initialized = true;
91bad2f8 220 jump_label_unlock();
bf5438fc 221}
bf5438fc
JB
222
223#ifdef CONFIG_MODULES
224
c5905afb
IM
225struct static_key_mod {
226 struct static_key_mod *next;
d430d3d7
JB
227 struct jump_entry *entries;
228 struct module *mod;
229};
230
231static int __jump_label_mod_text_reserved(void *start, void *end)
232{
233 struct module *mod;
234
235 mod = __module_text_address((unsigned long)start);
236 if (!mod)
237 return 0;
238
239 WARN_ON_ONCE(__module_text_address((unsigned long)end) != mod);
240
241 return __jump_label_text_reserved(mod->jump_entries,
242 mod->jump_entries + mod->num_jump_entries,
243 start, end);
244}
245
c5905afb 246static void __jump_label_mod_update(struct static_key *key, int enable)
d430d3d7 247{
c5905afb 248 struct static_key_mod *mod = key->next;
d430d3d7
JB
249
250 while (mod) {
7cbc5b8d
JO
251 struct module *m = mod->mod;
252
253 __jump_label_update(key, mod->entries,
254 m->jump_entries + m->num_jump_entries,
255 enable);
d430d3d7
JB
256 mod = mod->next;
257 }
258}
259
260/***
261 * apply_jump_label_nops - patch module jump labels with arch_get_jump_label_nop()
262 * @mod: module to patch
263 *
264 * Allow for run-time selection of the optimal nops. Before the module
265 * loads patch these with arch_get_jump_label_nop(), which is specified by
266 * the arch specific jump label code.
267 */
268void jump_label_apply_nops(struct module *mod)
bf5438fc 269{
d430d3d7
JB
270 struct jump_entry *iter_start = mod->jump_entries;
271 struct jump_entry *iter_stop = iter_start + mod->num_jump_entries;
272 struct jump_entry *iter;
273
274 /* if the module doesn't have jump label entries, just return */
275 if (iter_start == iter_stop)
276 return;
277
ac99b862 278 for (iter = iter_start; iter < iter_stop; iter++) {
c5905afb 279 arch_jump_label_transform_static(iter, JUMP_LABEL_DISABLE);
ac99b862 280 }
bf5438fc
JB
281}
282
d430d3d7 283static int jump_label_add_module(struct module *mod)
bf5438fc 284{
d430d3d7
JB
285 struct jump_entry *iter_start = mod->jump_entries;
286 struct jump_entry *iter_stop = iter_start + mod->num_jump_entries;
287 struct jump_entry *iter;
c5905afb
IM
288 struct static_key *key = NULL;
289 struct static_key_mod *jlm;
bf5438fc
JB
290
291 /* if the module doesn't have jump label entries, just return */
d430d3d7 292 if (iter_start == iter_stop)
bf5438fc
JB
293 return 0;
294
d430d3d7
JB
295 jump_label_sort_entries(iter_start, iter_stop);
296
297 for (iter = iter_start; iter < iter_stop; iter++) {
c5905afb 298 struct static_key *iterk;
d430d3d7 299
c5905afb
IM
300 iterk = (struct static_key *)(unsigned long)iter->key;
301 if (iterk == key)
302 continue;
d430d3d7 303
c5905afb 304 key = iterk;
bed831f9 305 if (within_module(iter->key, mod)) {
c5905afb
IM
306 /*
307 * Set key->entries to iter, but preserve JUMP_LABEL_TRUE_BRANCH.
308 */
309 *((unsigned long *)&key->entries) += (unsigned long)iter;
d430d3d7
JB
310 key->next = NULL;
311 continue;
bf5438fc 312 }
c5905afb 313 jlm = kzalloc(sizeof(struct static_key_mod), GFP_KERNEL);
d430d3d7
JB
314 if (!jlm)
315 return -ENOMEM;
d430d3d7
JB
316 jlm->mod = mod;
317 jlm->entries = iter;
318 jlm->next = key->next;
319 key->next = jlm;
320
c5905afb 321 if (jump_label_type(key) == JUMP_LABEL_ENABLE)
ac99b862 322 __jump_label_update(key, iter, iter_stop, JUMP_LABEL_ENABLE);
bf5438fc 323 }
d430d3d7 324
bf5438fc
JB
325 return 0;
326}
327
d430d3d7 328static void jump_label_del_module(struct module *mod)
bf5438fc 329{
d430d3d7
JB
330 struct jump_entry *iter_start = mod->jump_entries;
331 struct jump_entry *iter_stop = iter_start + mod->num_jump_entries;
332 struct jump_entry *iter;
c5905afb
IM
333 struct static_key *key = NULL;
334 struct static_key_mod *jlm, **prev;
bf5438fc 335
d430d3d7
JB
336 for (iter = iter_start; iter < iter_stop; iter++) {
337 if (iter->key == (jump_label_t)(unsigned long)key)
338 continue;
339
c5905afb 340 key = (struct static_key *)(unsigned long)iter->key;
d430d3d7 341
bed831f9 342 if (within_module(iter->key, mod))
d430d3d7
JB
343 continue;
344
345 prev = &key->next;
346 jlm = key->next;
bf5438fc 347
d430d3d7
JB
348 while (jlm && jlm->mod != mod) {
349 prev = &jlm->next;
350 jlm = jlm->next;
351 }
352
353 if (jlm) {
354 *prev = jlm->next;
355 kfree(jlm);
bf5438fc
JB
356 }
357 }
358}
359
d430d3d7 360static void jump_label_invalidate_module_init(struct module *mod)
b842f8fa 361{
d430d3d7
JB
362 struct jump_entry *iter_start = mod->jump_entries;
363 struct jump_entry *iter_stop = iter_start + mod->num_jump_entries;
b842f8fa 364 struct jump_entry *iter;
b842f8fa 365
d430d3d7
JB
366 for (iter = iter_start; iter < iter_stop; iter++) {
367 if (within_module_init(iter->code, mod))
368 iter->code = 0;
b842f8fa
JB
369 }
370}
371
bf5438fc
JB
372static int
373jump_label_module_notify(struct notifier_block *self, unsigned long val,
374 void *data)
375{
376 struct module *mod = data;
377 int ret = 0;
378
379 switch (val) {
380 case MODULE_STATE_COMING:
91bad2f8 381 jump_label_lock();
d430d3d7 382 ret = jump_label_add_module(mod);
bf5438fc 383 if (ret)
d430d3d7 384 jump_label_del_module(mod);
91bad2f8 385 jump_label_unlock();
bf5438fc
JB
386 break;
387 case MODULE_STATE_GOING:
91bad2f8 388 jump_label_lock();
d430d3d7 389 jump_label_del_module(mod);
91bad2f8 390 jump_label_unlock();
bf5438fc 391 break;
b842f8fa 392 case MODULE_STATE_LIVE:
91bad2f8 393 jump_label_lock();
d430d3d7 394 jump_label_invalidate_module_init(mod);
91bad2f8 395 jump_label_unlock();
b842f8fa 396 break;
bf5438fc 397 }
bf5438fc 398
d430d3d7 399 return notifier_from_errno(ret);
bf5438fc
JB
400}
401
402struct notifier_block jump_label_module_nb = {
403 .notifier_call = jump_label_module_notify,
d430d3d7 404 .priority = 1, /* higher than tracepoints */
bf5438fc
JB
405};
406
d430d3d7 407static __init int jump_label_init_module(void)
bf5438fc
JB
408{
409 return register_module_notifier(&jump_label_module_nb);
410}
d430d3d7 411early_initcall(jump_label_init_module);
bf5438fc
JB
412
413#endif /* CONFIG_MODULES */
414
d430d3d7
JB
415/***
416 * jump_label_text_reserved - check if addr range is reserved
417 * @start: start text addr
418 * @end: end text addr
419 *
420 * checks if the text addr located between @start and @end
421 * overlaps with any of the jump label patch addresses. Code
422 * that wants to modify kernel text should first verify that
423 * it does not overlap with any of the jump label addresses.
424 * Caller must hold jump_label_mutex.
425 *
426 * returns 1 if there is an overlap, 0 otherwise
427 */
428int jump_label_text_reserved(void *start, void *end)
429{
430 int ret = __jump_label_text_reserved(__start___jump_table,
431 __stop___jump_table, start, end);
432
433 if (ret)
434 return ret;
435
436#ifdef CONFIG_MODULES
437 ret = __jump_label_mod_text_reserved(start, end);
438#endif
439 return ret;
440}
441
c5905afb 442static void jump_label_update(struct static_key *key, int enable)
d430d3d7 443{
c5905afb
IM
444 struct jump_entry *stop = __stop___jump_table;
445 struct jump_entry *entry = jump_label_get_entries(key);
d430d3d7 446#ifdef CONFIG_MODULES
bed831f9 447 struct module *mod;
140fe3b1 448
d430d3d7 449 __jump_label_mod_update(key, enable);
140fe3b1 450
bed831f9
PZ
451 preempt_disable();
452 mod = __module_address((unsigned long)key);
140fe3b1
XG
453 if (mod)
454 stop = mod->jump_entries + mod->num_jump_entries;
bed831f9 455 preempt_enable();
d430d3d7 456#endif
140fe3b1
XG
457 /* if there are no users, entry can be NULL */
458 if (entry)
459 __jump_label_update(key, entry, stop, enable);
d430d3d7
JB
460}
461
bf5438fc 462#endif