]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - kernel/kprobes.c
x86/speculation/mmio: Reuse SRBDS mitigation for SBDS
[mirror_ubuntu-jammy-kernel.git] / kernel / kprobes.c
CommitLineData
1a59d1b8 1// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4
LT
2/*
3 * Kernel Probes (KProbes)
4 * kernel/kprobes.c
5 *
1da177e4
LT
6 * Copyright (C) IBM Corporation, 2002, 2004
7 *
8 * 2002-Oct Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
9 * Probes initial implementation (includes suggestions from
10 * Rusty Russell).
11 * 2004-Aug Updated by Prasanna S Panchamukhi <prasanna@in.ibm.com> with
12 * hlists and exceptions notifier as suggested by Andi Kleen.
13 * 2004-July Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
14 * interface to access function arguments.
15 * 2004-Sep Prasanna S Panchamukhi <prasanna@in.ibm.com> Changed Kprobes
16 * exceptions notifier to be first on the priority list.
b94cce92
HN
17 * 2005-May Hien Nguyen <hien@us.ibm.com>, Jim Keniston
18 * <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
19 * <prasanna@in.ibm.com> added function-return probes.
1da177e4
LT
20 */
21#include <linux/kprobes.h>
1da177e4
LT
22#include <linux/hash.h>
23#include <linux/init.h>
4e57b681 24#include <linux/slab.h>
e3869792 25#include <linux/stddef.h>
9984de1a 26#include <linux/export.h>
9ec4b1f3 27#include <linux/moduleloader.h>
3a872d89 28#include <linux/kallsyms.h>
b4c6c34a 29#include <linux/freezer.h>
346fd59b
SD
30#include <linux/seq_file.h>
31#include <linux/debugfs.h>
b2be84df 32#include <linux/sysctl.h>
1eeb66a1 33#include <linux/kdebug.h>
4460fdad 34#include <linux/memory.h>
4554dbcb 35#include <linux/ftrace.h>
afd66255 36#include <linux/cpu.h>
bf5438fc 37#include <linux/jump_label.h>
fa68bd09 38#include <linux/static_call.h>
69e49088 39#include <linux/perf_event.h>
bf8f6e5b 40
bfd45be0 41#include <asm/sections.h>
1da177e4
LT
42#include <asm/cacheflush.h>
43#include <asm/errno.h>
7c0f6ba6 44#include <linux/uaccess.h>
1da177e4
LT
45
46#define KPROBE_HASH_BITS 6
47#define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
48
3a872d89 49
ef53d9c5 50static int kprobes_initialized;
7e6a71d8
MH
51/* kprobe_table can be accessed by
52 * - Normal hlist traversal and RCU add/del under kprobe_mutex is held.
53 * Or
54 * - RCU hlist traversal under disabling preempt (breakpoint handlers)
55 */
1da177e4
LT
56static struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
57
bf8f6e5b 58/* NOTE: change this value only with kprobe_mutex held */
e579abeb 59static bool kprobes_all_disarmed;
bf8f6e5b 60
43948f50
MH
61/* This protects kprobe_table and optimizing_list */
62static DEFINE_MUTEX(kprobe_mutex);
e6584523 63static DEFINE_PER_CPU(struct kprobe *, kprobe_instance) = NULL;
ef53d9c5 64
290e3070
NR
65kprobe_opcode_t * __weak kprobe_lookup_name(const char *name,
66 unsigned int __unused)
49e0b465
NR
67{
68 return ((kprobe_opcode_t *)(kallsyms_lookup_name(name)));
69}
70
376e2424
MH
71/* Blacklist -- list of struct kprobe_blacklist_entry */
72static LIST_HEAD(kprobe_blacklist);
3d8d996e 73
2d14e39d 74#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
9ec4b1f3
AM
75/*
76 * kprobe->ainsn.insn points to the copy of the instruction to be
77 * single-stepped. x86_64, POWER4 and above have no-exec support and
78 * stepping on the instruction on a vmalloced/kmalloced/data page
79 * is a recipe for disaster
80 */
9ec4b1f3 81struct kprobe_insn_page {
c5cb5a2d 82 struct list_head list;
9ec4b1f3 83 kprobe_opcode_t *insns; /* Page of instruction slots */
af96397d 84 struct kprobe_insn_cache *cache;
9ec4b1f3 85 int nused;
b4c6c34a 86 int ngarbage;
4610ee1d 87 char slot_used[];
9ec4b1f3
AM
88};
89
4610ee1d
MH
90#define KPROBE_INSN_PAGE_SIZE(slots) \
91 (offsetof(struct kprobe_insn_page, slot_used) + \
92 (sizeof(char) * (slots)))
93
4610ee1d
MH
94static int slots_per_page(struct kprobe_insn_cache *c)
95{
96 return PAGE_SIZE/(c->insn_size * sizeof(kprobe_opcode_t));
97}
98
ab40c5c6
MH
99enum kprobe_slot_state {
100 SLOT_CLEAN = 0,
101 SLOT_DIRTY = 1,
102 SLOT_USED = 2,
103};
104
63fef14f 105void __weak *alloc_insn_page(void)
af96397d
HC
106{
107 return module_alloc(PAGE_SIZE);
108}
109
66ce7514 110static void free_insn_page(void *page)
af96397d 111{
be1f221c 112 module_memfree(page);
af96397d
HC
113}
114
c802d64a
HC
115struct kprobe_insn_cache kprobe_insn_slots = {
116 .mutex = __MUTEX_INITIALIZER(kprobe_insn_slots.mutex),
af96397d
HC
117 .alloc = alloc_insn_page,
118 .free = free_insn_page,
d002b8bc 119 .sym = KPROBE_INSN_PAGE_SYM,
4610ee1d
MH
120 .pages = LIST_HEAD_INIT(kprobe_insn_slots.pages),
121 .insn_size = MAX_INSN_SIZE,
122 .nr_garbage = 0,
123};
55479f64 124static int collect_garbage_slots(struct kprobe_insn_cache *c);
b4c6c34a 125
9ec4b1f3 126/**
12941560 127 * __get_insn_slot() - Find a slot on an executable page for an instruction.
9ec4b1f3
AM
128 * We allocate an executable page if there's no room on existing ones.
129 */
55479f64 130kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c)
9ec4b1f3
AM
131{
132 struct kprobe_insn_page *kip;
c802d64a 133 kprobe_opcode_t *slot = NULL;
9ec4b1f3 134
5b485629 135 /* Since the slot array is not protected by rcu, we need a mutex */
c802d64a 136 mutex_lock(&c->mutex);
6f716acd 137 retry:
5b485629
MH
138 rcu_read_lock();
139 list_for_each_entry_rcu(kip, &c->pages, list) {
4610ee1d 140 if (kip->nused < slots_per_page(c)) {
9ec4b1f3 141 int i;
4610ee1d 142 for (i = 0; i < slots_per_page(c); i++) {
ab40c5c6
MH
143 if (kip->slot_used[i] == SLOT_CLEAN) {
144 kip->slot_used[i] = SLOT_USED;
9ec4b1f3 145 kip->nused++;
c802d64a 146 slot = kip->insns + (i * c->insn_size);
5b485629 147 rcu_read_unlock();
c802d64a 148 goto out;
9ec4b1f3
AM
149 }
150 }
4610ee1d
MH
151 /* kip->nused is broken. Fix it. */
152 kip->nused = slots_per_page(c);
153 WARN_ON(1);
9ec4b1f3
AM
154 }
155 }
5b485629 156 rcu_read_unlock();
9ec4b1f3 157
b4c6c34a 158 /* If there are any garbage slots, collect it and try again. */
4610ee1d 159 if (c->nr_garbage && collect_garbage_slots(c) == 0)
b4c6c34a 160 goto retry;
4610ee1d
MH
161
162 /* All out of space. Need to allocate a new page. */
163 kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
6f716acd 164 if (!kip)
c802d64a 165 goto out;
9ec4b1f3
AM
166
167 /*
168 * Use module_alloc so this page is within +/- 2GB of where the
169 * kernel image and loaded module images reside. This is required
170 * so x86_64 can correctly handle the %rip-relative fixups.
171 */
af96397d 172 kip->insns = c->alloc();
9ec4b1f3
AM
173 if (!kip->insns) {
174 kfree(kip);
c802d64a 175 goto out;
9ec4b1f3 176 }
c5cb5a2d 177 INIT_LIST_HEAD(&kip->list);
4610ee1d 178 memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
ab40c5c6 179 kip->slot_used[0] = SLOT_USED;
9ec4b1f3 180 kip->nused = 1;
b4c6c34a 181 kip->ngarbage = 0;
af96397d 182 kip->cache = c;
5b485629 183 list_add_rcu(&kip->list, &c->pages);
c802d64a 184 slot = kip->insns;
69e49088
AH
185
186 /* Record the perf ksymbol register event after adding the page */
187 perf_event_ksymbol(PERF_RECORD_KSYMBOL_TYPE_OOL, (unsigned long)kip->insns,
188 PAGE_SIZE, false, c->sym);
c802d64a
HC
189out:
190 mutex_unlock(&c->mutex);
191 return slot;
12941560
MH
192}
193
b4c6c34a 194/* Return 1 if all garbages are collected, otherwise 0. */
55479f64 195static int collect_one_slot(struct kprobe_insn_page *kip, int idx)
b4c6c34a 196{
ab40c5c6 197 kip->slot_used[idx] = SLOT_CLEAN;
b4c6c34a
MH
198 kip->nused--;
199 if (kip->nused == 0) {
200 /*
201 * Page is no longer in use. Free it unless
202 * it's the last one. We keep the last one
203 * so as not to have to set it up again the
204 * next time somebody inserts a probe.
205 */
4610ee1d 206 if (!list_is_singular(&kip->list)) {
69e49088
AH
207 /*
208 * Record perf ksymbol unregister event before removing
209 * the page.
210 */
211 perf_event_ksymbol(PERF_RECORD_KSYMBOL_TYPE_OOL,
212 (unsigned long)kip->insns, PAGE_SIZE, true,
213 kip->cache->sym);
5b485629
MH
214 list_del_rcu(&kip->list);
215 synchronize_rcu();
af96397d 216 kip->cache->free(kip->insns);
b4c6c34a
MH
217 kfree(kip);
218 }
219 return 1;
220 }
221 return 0;
222}
223
55479f64 224static int collect_garbage_slots(struct kprobe_insn_cache *c)
b4c6c34a 225{
c5cb5a2d 226 struct kprobe_insn_page *kip, *next;
b4c6c34a 227
615d0ebb 228 /* Ensure no-one is interrupted on the garbages */
ae8b7ce7 229 synchronize_rcu();
b4c6c34a 230
4610ee1d 231 list_for_each_entry_safe(kip, next, &c->pages, list) {
b4c6c34a 232 int i;
b4c6c34a
MH
233 if (kip->ngarbage == 0)
234 continue;
235 kip->ngarbage = 0; /* we will collect all garbages */
4610ee1d 236 for (i = 0; i < slots_per_page(c); i++) {
5b485629 237 if (kip->slot_used[i] == SLOT_DIRTY && collect_one_slot(kip, i))
b4c6c34a
MH
238 break;
239 }
240 }
4610ee1d 241 c->nr_garbage = 0;
b4c6c34a
MH
242 return 0;
243}
244
55479f64
MH
245void __free_insn_slot(struct kprobe_insn_cache *c,
246 kprobe_opcode_t *slot, int dirty)
9ec4b1f3
AM
247{
248 struct kprobe_insn_page *kip;
5b485629 249 long idx;
9ec4b1f3 250
c802d64a 251 mutex_lock(&c->mutex);
5b485629
MH
252 rcu_read_lock();
253 list_for_each_entry_rcu(kip, &c->pages, list) {
254 idx = ((long)slot - (long)kip->insns) /
255 (c->insn_size * sizeof(kprobe_opcode_t));
256 if (idx >= 0 && idx < slots_per_page(c))
c802d64a 257 goto out;
9ec4b1f3 258 }
5b485629 259 /* Could not find this slot. */
4610ee1d 260 WARN_ON(1);
5b485629 261 kip = NULL;
c802d64a 262out:
5b485629
MH
263 rcu_read_unlock();
264 /* Mark and sweep: this may sleep */
265 if (kip) {
266 /* Check double free */
267 WARN_ON(kip->slot_used[idx] != SLOT_USED);
268 if (dirty) {
269 kip->slot_used[idx] = SLOT_DIRTY;
270 kip->ngarbage++;
271 if (++c->nr_garbage > slots_per_page(c))
272 collect_garbage_slots(c);
273 } else {
274 collect_one_slot(kip, idx);
275 }
276 }
c802d64a 277 mutex_unlock(&c->mutex);
4610ee1d 278}
6f716acd 279
5b485629
MH
280/*
281 * Check given address is on the page of kprobe instruction slots.
282 * This will be used for checking whether the address on a stack
283 * is on a text area or not.
284 */
285bool __is_insn_slot_addr(struct kprobe_insn_cache *c, unsigned long addr)
286{
287 struct kprobe_insn_page *kip;
288 bool ret = false;
289
290 rcu_read_lock();
291 list_for_each_entry_rcu(kip, &c->pages, list) {
292 if (addr >= (unsigned long)kip->insns &&
293 addr < (unsigned long)kip->insns + PAGE_SIZE) {
294 ret = true;
295 break;
296 }
297 }
298 rcu_read_unlock();
299
300 return ret;
301}
302
d002b8bc
AH
303int kprobe_cache_get_kallsym(struct kprobe_insn_cache *c, unsigned int *symnum,
304 unsigned long *value, char *type, char *sym)
305{
306 struct kprobe_insn_page *kip;
307 int ret = -ERANGE;
308
309 rcu_read_lock();
310 list_for_each_entry_rcu(kip, &c->pages, list) {
311 if ((*symnum)--)
312 continue;
313 strlcpy(sym, c->sym, KSYM_NAME_LEN);
314 *type = 't';
315 *value = (unsigned long)kip->insns;
316 ret = 0;
317 break;
318 }
319 rcu_read_unlock();
320
321 return ret;
322}
323
afd66255 324#ifdef CONFIG_OPTPROBES
7ee3e97e
CL
325void __weak *alloc_optinsn_page(void)
326{
327 return alloc_insn_page();
328}
329
330void __weak free_optinsn_page(void *page)
331{
332 free_insn_page(page);
333}
334
afd66255 335/* For optimized_kprobe buffer */
c802d64a
HC
336struct kprobe_insn_cache kprobe_optinsn_slots = {
337 .mutex = __MUTEX_INITIALIZER(kprobe_optinsn_slots.mutex),
7ee3e97e
CL
338 .alloc = alloc_optinsn_page,
339 .free = free_optinsn_page,
d002b8bc 340 .sym = KPROBE_OPTINSN_PAGE_SYM,
afd66255
MH
341 .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
342 /* .insn_size is initialized later */
343 .nr_garbage = 0,
344};
afd66255 345#endif
2d14e39d 346#endif
9ec4b1f3 347
e6584523
AM
348/* We have preemption disabled.. so it is safe to use __ versions */
349static inline void set_kprobe_instance(struct kprobe *kp)
350{
b76834bc 351 __this_cpu_write(kprobe_instance, kp);
e6584523
AM
352}
353
354static inline void reset_kprobe_instance(void)
355{
b76834bc 356 __this_cpu_write(kprobe_instance, NULL);
e6584523
AM
357}
358
3516a460
AM
359/*
360 * This routine is called either:
49a2a1b8 361 * - under the kprobe_mutex - during kprobe_[un]register()
3516a460 362 * OR
d217d545 363 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
3516a460 364 */
820aede0 365struct kprobe *get_kprobe(void *addr)
1da177e4
LT
366{
367 struct hlist_head *head;
3516a460 368 struct kprobe *p;
1da177e4
LT
369
370 head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
6743ad43
MH
371 hlist_for_each_entry_rcu(p, head, hlist,
372 lockdep_is_held(&kprobe_mutex)) {
1da177e4
LT
373 if (p->addr == addr)
374 return p;
375 }
afd66255 376
1da177e4
LT
377 return NULL;
378}
820aede0 379NOKPROBE_SYMBOL(get_kprobe);
1da177e4 380
820aede0 381static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
afd66255
MH
382
383/* Return true if the kprobe is an aggregator */
384static inline int kprobe_aggrprobe(struct kprobe *p)
385{
386 return p->pre_handler == aggr_pre_handler;
387}
388
6274de49
MH
389/* Return true(!0) if the kprobe is unused */
390static inline int kprobe_unused(struct kprobe *p)
391{
392 return kprobe_aggrprobe(p) && kprobe_disabled(p) &&
393 list_empty(&p->list);
394}
395
afd66255
MH
396/*
397 * Keep all fields in the kprobe consistent
398 */
6d8e40a8 399static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
afd66255 400{
6d8e40a8
MH
401 memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
402 memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
afd66255
MH
403}
404
405#ifdef CONFIG_OPTPROBES
b2be84df
MH
406/* NOTE: change this value only with kprobe_mutex held */
407static bool kprobes_allow_optimization;
408
afd66255
MH
409/*
410 * Call all pre_handler on the list, but ignores its return value.
411 * This must be called from arch-dep optimized caller.
412 */
820aede0 413void opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
afd66255
MH
414{
415 struct kprobe *kp;
416
417 list_for_each_entry_rcu(kp, &p->list, list) {
418 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
419 set_kprobe_instance(kp);
4f3a8714 420 kp->pre_handler(kp, regs);
afd66255
MH
421 }
422 reset_kprobe_instance();
423 }
424}
820aede0 425NOKPROBE_SYMBOL(opt_pre_handler);
afd66255 426
6274de49 427/* Free optimized instructions and optimized_kprobe */
55479f64 428static void free_aggr_kprobe(struct kprobe *p)
6274de49
MH
429{
430 struct optimized_kprobe *op;
431
432 op = container_of(p, struct optimized_kprobe, kp);
433 arch_remove_optimized_kprobe(op);
434 arch_remove_kprobe(p);
435 kfree(op);
436}
437
afd66255
MH
438/* Return true(!0) if the kprobe is ready for optimization. */
439static inline int kprobe_optready(struct kprobe *p)
440{
441 struct optimized_kprobe *op;
442
443 if (kprobe_aggrprobe(p)) {
444 op = container_of(p, struct optimized_kprobe, kp);
445 return arch_prepared_optinsn(&op->optinsn);
446 }
447
448 return 0;
449}
450
6274de49
MH
451/* Return true(!0) if the kprobe is disarmed. Note: p must be on hash list */
452static inline int kprobe_disarmed(struct kprobe *p)
453{
454 struct optimized_kprobe *op;
455
456 /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
457 if (!kprobe_aggrprobe(p))
458 return kprobe_disabled(p);
459
460 op = container_of(p, struct optimized_kprobe, kp);
461
462 return kprobe_disabled(p) && list_empty(&op->list);
463}
464
465/* Return true(!0) if the probe is queued on (un)optimizing lists */
55479f64 466static int kprobe_queued(struct kprobe *p)
6274de49
MH
467{
468 struct optimized_kprobe *op;
469
470 if (kprobe_aggrprobe(p)) {
471 op = container_of(p, struct optimized_kprobe, kp);
472 if (!list_empty(&op->list))
473 return 1;
474 }
475 return 0;
476}
477
afd66255
MH
478/*
479 * Return an optimized kprobe whose optimizing code replaces
480 * instructions including addr (exclude breakpoint).
481 */
55479f64 482static struct kprobe *get_optimized_kprobe(unsigned long addr)
afd66255
MH
483{
484 int i;
485 struct kprobe *p = NULL;
486 struct optimized_kprobe *op;
487
488 /* Don't check i == 0, since that is a breakpoint case. */
489 for (i = 1; !p && i < MAX_OPTIMIZED_LENGTH; i++)
490 p = get_kprobe((void *)(addr - i));
491
492 if (p && kprobe_optready(p)) {
493 op = container_of(p, struct optimized_kprobe, kp);
494 if (arch_within_optimized_kprobe(op, addr))
495 return p;
496 }
497
498 return NULL;
499}
500
501/* Optimization staging list, protected by kprobe_mutex */
502static LIST_HEAD(optimizing_list);
6274de49 503static LIST_HEAD(unoptimizing_list);
7b959fc5 504static LIST_HEAD(freeing_list);
afd66255
MH
505
506static void kprobe_optimizer(struct work_struct *work);
507static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
508#define OPTIMIZE_DELAY 5
509
61f4e13f
MH
510/*
511 * Optimize (replace a breakpoint with a jump) kprobes listed on
512 * optimizing_list.
513 */
55479f64 514static void do_optimize_kprobes(void)
afd66255 515{
f1c6ece2 516 lockdep_assert_held(&text_mutex);
afd66255
MH
517 /*
518 * The optimization/unoptimization refers online_cpus via
519 * stop_machine() and cpu-hotplug modifies online_cpus.
520 * And same time, text_mutex will be held in cpu-hotplug and here.
521 * This combination can cause a deadlock (cpu-hotplug try to lock
522 * text_mutex but stop_machine can not be done because online_cpus
523 * has been changed)
2d1e38f5 524 * To avoid this deadlock, caller must have locked cpu hotplug
afd66255
MH
525 * for preventing cpu-hotplug outside of text_mutex locking.
526 */
2d1e38f5
TG
527 lockdep_assert_cpus_held();
528
529 /* Optimization never be done when disarmed */
530 if (kprobes_all_disarmed || !kprobes_allow_optimization ||
531 list_empty(&optimizing_list))
532 return;
533
cd7ebe22 534 arch_optimize_kprobes(&optimizing_list);
61f4e13f
MH
535}
536
6274de49
MH
537/*
538 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
539 * if need) kprobes listed on unoptimizing_list.
540 */
55479f64 541static void do_unoptimize_kprobes(void)
6274de49
MH
542{
543 struct optimized_kprobe *op, *tmp;
544
f1c6ece2 545 lockdep_assert_held(&text_mutex);
2d1e38f5
TG
546 /* See comment in do_optimize_kprobes() */
547 lockdep_assert_cpus_held();
548
6274de49
MH
549 /* Unoptimization must be done anytime */
550 if (list_empty(&unoptimizing_list))
551 return;
552
7b959fc5 553 arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
f984ba4e 554 /* Loop free_list for disarming */
7b959fc5 555 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
f66c0447
MH
556 /* Switching from detour code to origin */
557 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
6274de49
MH
558 /* Disarm probes if marked disabled */
559 if (kprobe_disabled(&op->kp))
560 arch_disarm_kprobe(&op->kp);
561 if (kprobe_unused(&op->kp)) {
562 /*
563 * Remove unused probes from hash list. After waiting
564 * for synchronization, these probes are reclaimed.
565 * (reclaiming is done by do_free_cleaned_kprobes.)
566 */
567 hlist_del_rcu(&op->kp.hlist);
6274de49
MH
568 } else
569 list_del_init(&op->list);
570 }
6274de49
MH
571}
572
573/* Reclaim all kprobes on the free_list */
55479f64 574static void do_free_cleaned_kprobes(void)
6274de49
MH
575{
576 struct optimized_kprobe *op, *tmp;
577
7b959fc5 578 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
6274de49 579 list_del_init(&op->list);
cbdd96f5
MH
580 if (WARN_ON_ONCE(!kprobe_unused(&op->kp))) {
581 /*
582 * This must not happen, but if there is a kprobe
583 * still in use, keep it on kprobes hash list.
584 */
585 continue;
586 }
6274de49
MH
587 free_aggr_kprobe(&op->kp);
588 }
589}
590
591/* Start optimizer after OPTIMIZE_DELAY passed */
55479f64 592static void kick_kprobe_optimizer(void)
6274de49 593{
ad72b3be 594 schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
6274de49
MH
595}
596
61f4e13f 597/* Kprobe jump optimizer */
55479f64 598static void kprobe_optimizer(struct work_struct *work)
61f4e13f 599{
72ef3794 600 mutex_lock(&kprobe_mutex);
2d1e38f5 601 cpus_read_lock();
f1c6ece2 602 mutex_lock(&text_mutex);
61f4e13f
MH
603
604 /*
6274de49
MH
605 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
606 * kprobes before waiting for quiesence period.
607 */
7b959fc5 608 do_unoptimize_kprobes();
6274de49
MH
609
610 /*
a30b85df
MH
611 * Step 2: Wait for quiesence period to ensure all potentially
612 * preempted tasks to have normally scheduled. Because optprobe
613 * may modify multiple instructions, there is a chance that Nth
614 * instruction is preempted. In that case, such tasks can return
615 * to 2nd-Nth byte of jump instruction. This wait is for avoiding it.
616 * Note that on non-preemptive kernel, this is transparently converted
617 * to synchronoze_sched() to wait for all interrupts to have completed.
61f4e13f 618 */
a30b85df 619 synchronize_rcu_tasks();
61f4e13f 620
6274de49 621 /* Step 3: Optimize kprobes after quiesence period */
61f4e13f 622 do_optimize_kprobes();
6274de49
MH
623
624 /* Step 4: Free cleaned kprobes after quiesence period */
7b959fc5 625 do_free_cleaned_kprobes();
6274de49 626
f1c6ece2 627 mutex_unlock(&text_mutex);
2d1e38f5 628 cpus_read_unlock();
6274de49 629
cd7ebe22 630 /* Step 5: Kick optimizer again if needed */
f984ba4e 631 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
cd7ebe22 632 kick_kprobe_optimizer();
1a0aa991
MH
633
634 mutex_unlock(&kprobe_mutex);
6274de49
MH
635}
636
637/* Wait for completing optimization and unoptimization */
30e7d894 638void wait_for_kprobe_optimizer(void)
6274de49 639{
ad72b3be
TH
640 mutex_lock(&kprobe_mutex);
641
642 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
643 mutex_unlock(&kprobe_mutex);
644
645 /* this will also make optimizing_work execute immmediately */
646 flush_delayed_work(&optimizing_work);
647 /* @optimizing_work might not have been queued yet, relax */
648 cpu_relax();
649
650 mutex_lock(&kprobe_mutex);
651 }
652
653 mutex_unlock(&kprobe_mutex);
afd66255
MH
654}
655
e4add247
MH
656static bool optprobe_queued_unopt(struct optimized_kprobe *op)
657{
658 struct optimized_kprobe *_op;
659
660 list_for_each_entry(_op, &unoptimizing_list, list) {
661 if (op == _op)
662 return true;
663 }
664
665 return false;
666}
667
afd66255 668/* Optimize kprobe if p is ready to be optimized */
55479f64 669static void optimize_kprobe(struct kprobe *p)
afd66255
MH
670{
671 struct optimized_kprobe *op;
672
673 /* Check if the kprobe is disabled or not ready for optimization. */
b2be84df 674 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
afd66255
MH
675 (kprobe_disabled(p) || kprobes_all_disarmed))
676 return;
677
059053a2
MH
678 /* kprobes with post_handler can not be optimized */
679 if (p->post_handler)
afd66255
MH
680 return;
681
682 op = container_of(p, struct optimized_kprobe, kp);
683
684 /* Check there is no other kprobes at the optimized instructions */
685 if (arch_check_optimized_kprobe(op) < 0)
686 return;
687
688 /* Check if it is already optimized. */
e4add247
MH
689 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED) {
690 if (optprobe_queued_unopt(op)) {
691 /* This is under unoptimizing. Just dequeue the probe */
692 list_del_init(&op->list);
693 }
afd66255 694 return;
e4add247 695 }
afd66255 696 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
6274de49 697
e4add247
MH
698 /* On unoptimizing/optimizing_list, op must have OPTIMIZED flag */
699 if (WARN_ON_ONCE(!list_empty(&op->list)))
700 return;
701
702 list_add(&op->list, &optimizing_list);
703 kick_kprobe_optimizer();
6274de49
MH
704}
705
706/* Short cut to direct unoptimizing */
55479f64 707static void force_unoptimize_kprobe(struct optimized_kprobe *op)
6274de49 708{
2d1e38f5 709 lockdep_assert_cpus_held();
6274de49 710 arch_unoptimize_kprobe(op);
f66c0447 711 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
afd66255
MH
712}
713
714/* Unoptimize a kprobe if p is optimized */
55479f64 715static void unoptimize_kprobe(struct kprobe *p, bool force)
afd66255
MH
716{
717 struct optimized_kprobe *op;
718
6274de49
MH
719 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
720 return; /* This is not an optprobe nor optimized */
721
722 op = container_of(p, struct optimized_kprobe, kp);
e4add247 723 if (!kprobe_optimized(p))
6274de49 724 return;
6274de49 725
6274de49 726 if (!list_empty(&op->list)) {
e4add247
MH
727 if (optprobe_queued_unopt(op)) {
728 /* Queued in unoptimizing queue */
729 if (force) {
730 /*
731 * Forcibly unoptimize the kprobe here, and queue it
732 * in the freeing list for release afterwards.
733 */
734 force_unoptimize_kprobe(op);
735 list_move(&op->list, &freeing_list);
736 }
737 } else {
738 /* Dequeue from the optimizing queue */
739 list_del_init(&op->list);
740 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
741 }
6274de49
MH
742 return;
743 }
e4add247 744
6274de49 745 /* Optimized kprobe case */
e4add247 746 if (force) {
6274de49
MH
747 /* Forcibly update the code: this is a special case */
748 force_unoptimize_kprobe(op);
e4add247 749 } else {
6274de49
MH
750 list_add(&op->list, &unoptimizing_list);
751 kick_kprobe_optimizer();
afd66255
MH
752 }
753}
754
0490cd1f 755/* Cancel unoptimizing for reusing */
819319fc 756static int reuse_unused_kprobe(struct kprobe *ap)
0490cd1f
MH
757{
758 struct optimized_kprobe *op;
759
0490cd1f
MH
760 /*
761 * Unused kprobe MUST be on the way of delayed unoptimizing (means
762 * there is still a relative jump) and disabled.
763 */
764 op = container_of(ap, struct optimized_kprobe, kp);
4458515b 765 WARN_ON_ONCE(list_empty(&op->list));
0490cd1f
MH
766 /* Enable the probe again */
767 ap->flags &= ~KPROBE_FLAG_DISABLED;
768 /* Optimize it again (remove from op->list) */
5f843ed4
MH
769 if (!kprobe_optready(ap))
770 return -EINVAL;
819319fc 771
0490cd1f 772 optimize_kprobe(ap);
819319fc 773 return 0;
0490cd1f
MH
774}
775
afd66255 776/* Remove optimized instructions */
55479f64 777static void kill_optimized_kprobe(struct kprobe *p)
afd66255
MH
778{
779 struct optimized_kprobe *op;
780
781 op = container_of(p, struct optimized_kprobe, kp);
6274de49
MH
782 if (!list_empty(&op->list))
783 /* Dequeue from the (un)optimization queue */
afd66255 784 list_del_init(&op->list);
6274de49 785 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
7b959fc5
MH
786
787 if (kprobe_unused(p)) {
788 /* Enqueue if it is unused */
789 list_add(&op->list, &freeing_list);
790 /*
791 * Remove unused probes from the hash list. After waiting
792 * for synchronization, this probe is reclaimed.
793 * (reclaiming is done by do_free_cleaned_kprobes().)
794 */
795 hlist_del_rcu(&op->kp.hlist);
796 }
797
6274de49 798 /* Don't touch the code, because it is already freed. */
afd66255
MH
799 arch_remove_optimized_kprobe(op);
800}
801
a460246c
MH
802static inline
803void __prepare_optimized_kprobe(struct optimized_kprobe *op, struct kprobe *p)
804{
805 if (!kprobe_ftrace(p))
806 arch_prepare_optimized_kprobe(op, p);
807}
808
afd66255 809/* Try to prepare optimized instructions */
55479f64 810static void prepare_optimized_kprobe(struct kprobe *p)
afd66255
MH
811{
812 struct optimized_kprobe *op;
813
814 op = container_of(p, struct optimized_kprobe, kp);
a460246c 815 __prepare_optimized_kprobe(op, p);
afd66255
MH
816}
817
afd66255 818/* Allocate new optimized_kprobe and try to prepare optimized instructions */
55479f64 819static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
afd66255
MH
820{
821 struct optimized_kprobe *op;
822
823 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
824 if (!op)
825 return NULL;
826
827 INIT_LIST_HEAD(&op->list);
828 op->kp.addr = p->addr;
a460246c 829 __prepare_optimized_kprobe(op, p);
afd66255
MH
830
831 return &op->kp;
832}
833
55479f64 834static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
afd66255
MH
835
836/*
837 * Prepare an optimized_kprobe and optimize it
838 * NOTE: p must be a normal registered kprobe
839 */
55479f64 840static void try_to_optimize_kprobe(struct kprobe *p)
afd66255
MH
841{
842 struct kprobe *ap;
843 struct optimized_kprobe *op;
844
ae6aa16f
MH
845 /* Impossible to optimize ftrace-based kprobe */
846 if (kprobe_ftrace(p))
847 return;
848
25764288 849 /* For preparing optimization, jump_label_text_reserved() is called */
2d1e38f5 850 cpus_read_lock();
25764288
MH
851 jump_label_lock();
852 mutex_lock(&text_mutex);
853
afd66255
MH
854 ap = alloc_aggr_kprobe(p);
855 if (!ap)
25764288 856 goto out;
afd66255
MH
857
858 op = container_of(ap, struct optimized_kprobe, kp);
859 if (!arch_prepared_optinsn(&op->optinsn)) {
860 /* If failed to setup optimizing, fallback to kprobe */
6274de49
MH
861 arch_remove_optimized_kprobe(op);
862 kfree(op);
25764288 863 goto out;
afd66255
MH
864 }
865
866 init_aggr_kprobe(ap, p);
25764288
MH
867 optimize_kprobe(ap); /* This just kicks optimizer thread */
868
869out:
870 mutex_unlock(&text_mutex);
871 jump_label_unlock();
2d1e38f5 872 cpus_read_unlock();
afd66255
MH
873}
874
55479f64 875static void optimize_all_kprobes(void)
b2be84df
MH
876{
877 struct hlist_head *head;
b2be84df
MH
878 struct kprobe *p;
879 unsigned int i;
880
5c51543b 881 mutex_lock(&kprobe_mutex);
b2be84df
MH
882 /* If optimization is already allowed, just return */
883 if (kprobes_allow_optimization)
5c51543b 884 goto out;
b2be84df 885
2d1e38f5 886 cpus_read_lock();
b2be84df 887 kprobes_allow_optimization = true;
b2be84df
MH
888 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
889 head = &kprobe_table[i];
7e6a71d8 890 hlist_for_each_entry(p, head, hlist)
b2be84df
MH
891 if (!kprobe_disabled(p))
892 optimize_kprobe(p);
893 }
2d1e38f5 894 cpus_read_unlock();
b2be84df 895 printk(KERN_INFO "Kprobes globally optimized\n");
5c51543b
MH
896out:
897 mutex_unlock(&kprobe_mutex);
b2be84df
MH
898}
899
c85c9a2c 900#ifdef CONFIG_SYSCTL
55479f64 901static void unoptimize_all_kprobes(void)
b2be84df
MH
902{
903 struct hlist_head *head;
b2be84df
MH
904 struct kprobe *p;
905 unsigned int i;
906
5c51543b 907 mutex_lock(&kprobe_mutex);
b2be84df 908 /* If optimization is already prohibited, just return */
5c51543b
MH
909 if (!kprobes_allow_optimization) {
910 mutex_unlock(&kprobe_mutex);
b2be84df 911 return;
5c51543b 912 }
b2be84df 913
2d1e38f5 914 cpus_read_lock();
b2be84df 915 kprobes_allow_optimization = false;
b2be84df
MH
916 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
917 head = &kprobe_table[i];
7e6a71d8 918 hlist_for_each_entry(p, head, hlist) {
b2be84df 919 if (!kprobe_disabled(p))
6274de49 920 unoptimize_kprobe(p, false);
b2be84df
MH
921 }
922 }
2d1e38f5 923 cpus_read_unlock();
5c51543b
MH
924 mutex_unlock(&kprobe_mutex);
925
6274de49
MH
926 /* Wait for unoptimizing completion */
927 wait_for_kprobe_optimizer();
928 printk(KERN_INFO "Kprobes globally unoptimized\n");
b2be84df
MH
929}
930
5c51543b 931static DEFINE_MUTEX(kprobe_sysctl_mutex);
b2be84df
MH
932int sysctl_kprobes_optimization;
933int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
32927393 934 void *buffer, size_t *length,
b2be84df
MH
935 loff_t *ppos)
936{
937 int ret;
938
5c51543b 939 mutex_lock(&kprobe_sysctl_mutex);
b2be84df
MH
940 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
941 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
942
943 if (sysctl_kprobes_optimization)
944 optimize_all_kprobes();
945 else
946 unoptimize_all_kprobes();
5c51543b 947 mutex_unlock(&kprobe_sysctl_mutex);
b2be84df
MH
948
949 return ret;
950}
951#endif /* CONFIG_SYSCTL */
952
6274de49 953/* Put a breakpoint for a probe. Must be called with text_mutex locked */
55479f64 954static void __arm_kprobe(struct kprobe *p)
afd66255 955{
6d8e40a8 956 struct kprobe *_p;
afd66255
MH
957
958 /* Check collision with other optimized kprobes */
6d8e40a8
MH
959 _p = get_optimized_kprobe((unsigned long)p->addr);
960 if (unlikely(_p))
6274de49
MH
961 /* Fallback to unoptimized kprobe */
962 unoptimize_kprobe(_p, true);
afd66255
MH
963
964 arch_arm_kprobe(p);
965 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
966}
967
6274de49 968/* Remove the breakpoint of a probe. Must be called with text_mutex locked */
55479f64 969static void __disarm_kprobe(struct kprobe *p, bool reopt)
afd66255 970{
6d8e40a8 971 struct kprobe *_p;
afd66255 972
69d54b91
WN
973 /* Try to unoptimize */
974 unoptimize_kprobe(p, kprobes_all_disarmed);
afd66255 975
6274de49
MH
976 if (!kprobe_queued(p)) {
977 arch_disarm_kprobe(p);
978 /* If another kprobe was blocked, optimize it. */
979 _p = get_optimized_kprobe((unsigned long)p->addr);
980 if (unlikely(_p) && reopt)
981 optimize_kprobe(_p);
982 }
983 /* TODO: reoptimize others after unoptimized this probe */
afd66255
MH
984}
985
986#else /* !CONFIG_OPTPROBES */
987
988#define optimize_kprobe(p) do {} while (0)
6274de49 989#define unoptimize_kprobe(p, f) do {} while (0)
afd66255
MH
990#define kill_optimized_kprobe(p) do {} while (0)
991#define prepare_optimized_kprobe(p) do {} while (0)
992#define try_to_optimize_kprobe(p) do {} while (0)
993#define __arm_kprobe(p) arch_arm_kprobe(p)
6274de49
MH
994#define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
995#define kprobe_disarmed(p) kprobe_disabled(p)
996#define wait_for_kprobe_optimizer() do {} while (0)
afd66255 997
819319fc 998static int reuse_unused_kprobe(struct kprobe *ap)
0490cd1f 999{
819319fc
MH
1000 /*
1001 * If the optimized kprobe is NOT supported, the aggr kprobe is
1002 * released at the same time that the last aggregated kprobe is
1003 * unregistered.
1004 * Thus there should be no chance to reuse unused kprobe.
1005 */
0490cd1f 1006 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
819319fc 1007 return -EINVAL;
0490cd1f
MH
1008}
1009
55479f64 1010static void free_aggr_kprobe(struct kprobe *p)
afd66255 1011{
6274de49 1012 arch_remove_kprobe(p);
afd66255
MH
1013 kfree(p);
1014}
1015
55479f64 1016static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
afd66255
MH
1017{
1018 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
1019}
1020#endif /* CONFIG_OPTPROBES */
1021
e7dbfe34 1022#ifdef CONFIG_KPROBES_ON_FTRACE
ae6aa16f 1023static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
0bc11ed5
MH
1024 .func = kprobe_ftrace_handler,
1025 .flags = FTRACE_OPS_FL_SAVE_REGS,
1026};
1027
1028static struct ftrace_ops kprobe_ipmodify_ops __read_mostly = {
e5253896 1029 .func = kprobe_ftrace_handler,
1d70be34 1030 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
ae6aa16f 1031};
0bc11ed5
MH
1032
1033static int kprobe_ipmodify_enabled;
ae6aa16f
MH
1034static int kprobe_ftrace_enabled;
1035
1036/* Must ensure p->addr is really on ftrace */
55479f64 1037static int prepare_kprobe(struct kprobe *p)
ae6aa16f
MH
1038{
1039 if (!kprobe_ftrace(p))
1040 return arch_prepare_kprobe(p);
1041
1042 return arch_prepare_kprobe_ftrace(p);
1043}
1044
1045/* Caller must lock kprobe_mutex */
0bc11ed5
MH
1046static int __arm_kprobe_ftrace(struct kprobe *p, struct ftrace_ops *ops,
1047 int *cnt)
ae6aa16f 1048{
12310e34 1049 int ret = 0;
ae6aa16f 1050
0bc11ed5 1051 ret = ftrace_set_filter_ip(ops, (unsigned long)p->addr, 0, 0);
12310e34 1052 if (ret) {
4458515b
MH
1053 pr_debug("Failed to arm kprobe-ftrace at %pS (%d)\n",
1054 p->addr, ret);
12310e34
JY
1055 return ret;
1056 }
1057
0bc11ed5
MH
1058 if (*cnt == 0) {
1059 ret = register_ftrace_function(ops);
12310e34
JY
1060 if (ret) {
1061 pr_debug("Failed to init kprobe-ftrace (%d)\n", ret);
1062 goto err_ftrace;
1063 }
ae6aa16f 1064 }
12310e34 1065
0bc11ed5 1066 (*cnt)++;
12310e34
JY
1067 return ret;
1068
1069err_ftrace:
1070 /*
0bc11ed5
MH
1071 * At this point, sinec ops is not registered, we should be sefe from
1072 * registering empty filter.
12310e34 1073 */
0bc11ed5 1074 ftrace_set_filter_ip(ops, (unsigned long)p->addr, 1, 0);
12310e34 1075 return ret;
ae6aa16f
MH
1076}
1077
0bc11ed5
MH
1078static int arm_kprobe_ftrace(struct kprobe *p)
1079{
1080 bool ipmodify = (p->post_handler != NULL);
1081
1082 return __arm_kprobe_ftrace(p,
1083 ipmodify ? &kprobe_ipmodify_ops : &kprobe_ftrace_ops,
1084 ipmodify ? &kprobe_ipmodify_enabled : &kprobe_ftrace_enabled);
1085}
1086
ae6aa16f 1087/* Caller must lock kprobe_mutex */
0bc11ed5
MH
1088static int __disarm_kprobe_ftrace(struct kprobe *p, struct ftrace_ops *ops,
1089 int *cnt)
ae6aa16f 1090{
297f9233 1091 int ret = 0;
ae6aa16f 1092
0bc11ed5
MH
1093 if (*cnt == 1) {
1094 ret = unregister_ftrace_function(ops);
297f9233
JY
1095 if (WARN(ret < 0, "Failed to unregister kprobe-ftrace (%d)\n", ret))
1096 return ret;
ae6aa16f 1097 }
297f9233 1098
0bc11ed5 1099 (*cnt)--;
297f9233 1100
0bc11ed5 1101 ret = ftrace_set_filter_ip(ops, (unsigned long)p->addr, 1, 0);
4458515b
MH
1102 WARN_ONCE(ret < 0, "Failed to disarm kprobe-ftrace at %pS (%d)\n",
1103 p->addr, ret);
297f9233 1104 return ret;
ae6aa16f 1105}
0bc11ed5
MH
1106
1107static int disarm_kprobe_ftrace(struct kprobe *p)
1108{
1109 bool ipmodify = (p->post_handler != NULL);
1110
1111 return __disarm_kprobe_ftrace(p,
1112 ipmodify ? &kprobe_ipmodify_ops : &kprobe_ftrace_ops,
1113 ipmodify ? &kprobe_ipmodify_enabled : &kprobe_ftrace_enabled);
1114}
e7dbfe34 1115#else /* !CONFIG_KPROBES_ON_FTRACE */
10de795a
MS
1116static inline int prepare_kprobe(struct kprobe *p)
1117{
1118 return arch_prepare_kprobe(p);
1119}
1120
1121static inline int arm_kprobe_ftrace(struct kprobe *p)
1122{
1123 return -ENODEV;
1124}
1125
1126static inline int disarm_kprobe_ftrace(struct kprobe *p)
1127{
1128 return -ENODEV;
1129}
ae6aa16f
MH
1130#endif
1131
201517a7 1132/* Arm a kprobe with text_mutex */
12310e34 1133static int arm_kprobe(struct kprobe *kp)
201517a7 1134{
12310e34
JY
1135 if (unlikely(kprobe_ftrace(kp)))
1136 return arm_kprobe_ftrace(kp);
1137
2d1e38f5 1138 cpus_read_lock();
201517a7 1139 mutex_lock(&text_mutex);
afd66255 1140 __arm_kprobe(kp);
201517a7 1141 mutex_unlock(&text_mutex);
2d1e38f5 1142 cpus_read_unlock();
12310e34
JY
1143
1144 return 0;
201517a7
MH
1145}
1146
1147/* Disarm a kprobe with text_mutex */
297f9233 1148static int disarm_kprobe(struct kprobe *kp, bool reopt)
201517a7 1149{
297f9233
JY
1150 if (unlikely(kprobe_ftrace(kp)))
1151 return disarm_kprobe_ftrace(kp);
2d1e38f5
TG
1152
1153 cpus_read_lock();
201517a7 1154 mutex_lock(&text_mutex);
ae6aa16f 1155 __disarm_kprobe(kp, reopt);
201517a7 1156 mutex_unlock(&text_mutex);
2d1e38f5 1157 cpus_read_unlock();
297f9233
JY
1158
1159 return 0;
201517a7
MH
1160}
1161
64f562c6
AM
1162/*
1163 * Aggregate handlers for multiple kprobes support - these handlers
1164 * take care of invoking the individual kprobe handlers on p->list
1165 */
820aede0 1166static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
64f562c6
AM
1167{
1168 struct kprobe *kp;
1169
3516a460 1170 list_for_each_entry_rcu(kp, &p->list, list) {
de5bd88d 1171 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
e6584523 1172 set_kprobe_instance(kp);
8b0914ea
PP
1173 if (kp->pre_handler(kp, regs))
1174 return 1;
64f562c6 1175 }
e6584523 1176 reset_kprobe_instance();
64f562c6
AM
1177 }
1178 return 0;
1179}
820aede0 1180NOKPROBE_SYMBOL(aggr_pre_handler);
64f562c6 1181
820aede0
MH
1182static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1183 unsigned long flags)
64f562c6
AM
1184{
1185 struct kprobe *kp;
1186
3516a460 1187 list_for_each_entry_rcu(kp, &p->list, list) {
de5bd88d 1188 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
e6584523 1189 set_kprobe_instance(kp);
64f562c6 1190 kp->post_handler(kp, regs, flags);
e6584523 1191 reset_kprobe_instance();
64f562c6
AM
1192 }
1193 }
64f562c6 1194}
820aede0 1195NOKPROBE_SYMBOL(aggr_post_handler);
64f562c6 1196
bf8d5c52 1197/* Walks the list and increments nmissed count for multiprobe case */
820aede0 1198void kprobes_inc_nmissed_count(struct kprobe *p)
bf8d5c52
KA
1199{
1200 struct kprobe *kp;
afd66255 1201 if (!kprobe_aggrprobe(p)) {
bf8d5c52
KA
1202 p->nmissed++;
1203 } else {
1204 list_for_each_entry_rcu(kp, &p->list, list)
1205 kp->nmissed++;
1206 }
1207 return;
1208}
820aede0 1209NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
bf8d5c52 1210
d741bf41
PZ
1211static void free_rp_inst_rcu(struct rcu_head *head)
1212{
1213 struct kretprobe_instance *ri = container_of(head, struct kretprobe_instance, rcu);
1214
1215 if (refcount_dec_and_test(&ri->rph->ref))
1216 kfree(ri->rph);
1217 kfree(ri);
1218}
1219NOKPROBE_SYMBOL(free_rp_inst_rcu);
1220
b3388178 1221static void recycle_rp_inst(struct kretprobe_instance *ri)
b94cce92 1222{
d741bf41 1223 struct kretprobe *rp = get_kretprobe(ri);
ef53d9c5 1224
ef53d9c5 1225 if (likely(rp)) {
6e426e0f 1226 freelist_add(&ri->freelist, &rp->freelist);
b94cce92 1227 } else
d741bf41 1228 call_rcu(&ri->rcu, free_rp_inst_rcu);
b94cce92 1229}
820aede0 1230NOKPROBE_SYMBOL(recycle_rp_inst);
b94cce92 1231
319f0ce2 1232static struct kprobe kprobe_busy = {
9b38cc70
JO
1233 .addr = (void *) get_kprobe,
1234};
1235
1236void kprobe_busy_begin(void)
1237{
1238 struct kprobe_ctlblk *kcb;
1239
1240 preempt_disable();
1241 __this_cpu_write(current_kprobe, &kprobe_busy);
1242 kcb = get_kprobe_ctlblk();
1243 kcb->kprobe_status = KPROBE_HIT_ACTIVE;
1244}
1245
1246void kprobe_busy_end(void)
1247{
1248 __this_cpu_write(current_kprobe, NULL);
1249 preempt_enable();
1250}
1251
b94cce92 1252/*
c6fd91f0 1253 * This function is called from finish_task_switch when task tk becomes dead,
1254 * so that we can recycle any function-return probe instances associated
1255 * with this task. These left over instances represent probed functions
1256 * that have been called but will never return.
b94cce92 1257 */
820aede0 1258void kprobe_flush_task(struct task_struct *tk)
b94cce92 1259{
62c27be0 1260 struct kretprobe_instance *ri;
d741bf41 1261 struct llist_node *node;
802eae7c 1262
d741bf41 1263 /* Early boot, not yet initialized. */
ef53d9c5 1264 if (unlikely(!kprobes_initialized))
ef53d9c5
S
1265 return;
1266
9b38cc70
JO
1267 kprobe_busy_begin();
1268
d741bf41
PZ
1269 node = __llist_del_all(&tk->kretprobe_instances);
1270 while (node) {
1271 ri = container_of(node, struct kretprobe_instance, llist);
1272 node = node->next;
1273
1274 recycle_rp_inst(ri);
62c27be0 1275 }
9b38cc70
JO
1276
1277 kprobe_busy_end();
b94cce92 1278}
820aede0 1279NOKPROBE_SYMBOL(kprobe_flush_task);
b94cce92 1280
b94cce92
HN
1281static inline void free_rp_inst(struct kretprobe *rp)
1282{
1283 struct kretprobe_instance *ri;
6e426e0f 1284 struct freelist_node *node;
d741bf41 1285 int count = 0;
4c4308cb 1286
6e426e0f
PZ
1287 node = rp->freelist.head;
1288 while (node) {
1289 ri = container_of(node, struct kretprobe_instance, freelist);
1290 node = node->next;
1291
b94cce92 1292 kfree(ri);
d741bf41 1293 count++;
b94cce92 1294 }
ef53d9c5 1295
d741bf41
PZ
1296 if (refcount_sub_and_test(count, &rp->rph->ref)) {
1297 kfree(rp->rph);
1298 rp->rph = NULL;
4a296e07 1299 }
4a296e07
MH
1300}
1301
059053a2 1302/* Add the new probe to ap->list */
55479f64 1303static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
8b0914ea 1304{
059053a2 1305 if (p->post_handler)
6274de49 1306 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
afd66255 1307
059053a2 1308 list_add_rcu(&p->list, &ap->list);
b918e5e6
MH
1309 if (p->post_handler && !ap->post_handler)
1310 ap->post_handler = aggr_post_handler;
de5bd88d 1311
8b0914ea
PP
1312 return 0;
1313}
1314
64f562c6
AM
1315/*
1316 * Fill in the required fields of the "manager kprobe". Replace the
1317 * earlier kprobe in the hlist with the manager kprobe
1318 */
55479f64 1319static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
64f562c6 1320{
afd66255 1321 /* Copy p's insn slot to ap */
8b0914ea 1322 copy_kprobe(p, ap);
a9ad965e 1323 flush_insn_slot(ap);
64f562c6 1324 ap->addr = p->addr;
afd66255 1325 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
64f562c6 1326 ap->pre_handler = aggr_pre_handler;
e8386a0c
MH
1327 /* We don't care the kprobe which has gone. */
1328 if (p->post_handler && !kprobe_gone(p))
36721656 1329 ap->post_handler = aggr_post_handler;
64f562c6
AM
1330
1331 INIT_LIST_HEAD(&ap->list);
afd66255 1332 INIT_HLIST_NODE(&ap->hlist);
64f562c6 1333
afd66255 1334 list_add_rcu(&p->list, &ap->list);
adad0f33 1335 hlist_replace_rcu(&p->hlist, &ap->hlist);
64f562c6
AM
1336}
1337
1338/*
1339 * This is the second or subsequent kprobe at the address - handle
1340 * the intricacies
64f562c6 1341 */
55479f64 1342static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
64f562c6
AM
1343{
1344 int ret = 0;
6d8e40a8 1345 struct kprobe *ap = orig_p;
64f562c6 1346
2d1e38f5
TG
1347 cpus_read_lock();
1348
25764288
MH
1349 /* For preparing optimization, jump_label_text_reserved() is called */
1350 jump_label_lock();
25764288
MH
1351 mutex_lock(&text_mutex);
1352
6d8e40a8
MH
1353 if (!kprobe_aggrprobe(orig_p)) {
1354 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1355 ap = alloc_aggr_kprobe(orig_p);
25764288
MH
1356 if (!ap) {
1357 ret = -ENOMEM;
1358 goto out;
1359 }
6d8e40a8 1360 init_aggr_kprobe(ap, orig_p);
819319fc 1361 } else if (kprobe_unused(ap)) {
0490cd1f 1362 /* This probe is going to die. Rescue it */
819319fc
MH
1363 ret = reuse_unused_kprobe(ap);
1364 if (ret)
1365 goto out;
1366 }
b918e5e6
MH
1367
1368 if (kprobe_gone(ap)) {
e8386a0c
MH
1369 /*
1370 * Attempting to insert new probe at the same location that
1371 * had a probe in the module vaddr area which already
1372 * freed. So, the instruction slot has already been
1373 * released. We need a new slot for the new probe.
1374 */
b918e5e6 1375 ret = arch_prepare_kprobe(ap);
e8386a0c 1376 if (ret)
b918e5e6
MH
1377 /*
1378 * Even if fail to allocate new slot, don't need to
1379 * free aggr_probe. It will be used next time, or
1380 * freed by unregister_kprobe.
1381 */
25764288 1382 goto out;
de5bd88d 1383
afd66255
MH
1384 /* Prepare optimized instructions if possible. */
1385 prepare_optimized_kprobe(ap);
1386
e8386a0c 1387 /*
de5bd88d
MH
1388 * Clear gone flag to prevent allocating new slot again, and
1389 * set disabled flag because it is not armed yet.
e8386a0c 1390 */
de5bd88d
MH
1391 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1392 | KPROBE_FLAG_DISABLED;
e8386a0c 1393 }
b918e5e6 1394
afd66255 1395 /* Copy ap's insn slot to p */
b918e5e6 1396 copy_kprobe(ap, p);
25764288
MH
1397 ret = add_new_kprobe(ap, p);
1398
1399out:
1400 mutex_unlock(&text_mutex);
25764288 1401 jump_label_unlock();
2d1e38f5 1402 cpus_read_unlock();
25764288
MH
1403
1404 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1405 ap->flags &= ~KPROBE_FLAG_DISABLED;
12310e34 1406 if (!kprobes_all_disarmed) {
25764288 1407 /* Arm the breakpoint again. */
12310e34
JY
1408 ret = arm_kprobe(ap);
1409 if (ret) {
1410 ap->flags |= KPROBE_FLAG_DISABLED;
1411 list_del_rcu(&p->list);
ae8b7ce7 1412 synchronize_rcu();
12310e34
JY
1413 }
1414 }
25764288
MH
1415 }
1416 return ret;
64f562c6
AM
1417}
1418
be8f2743
MH
1419bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1420{
1421 /* The __kprobes marked functions and entry code must not be probed */
1422 return addr >= (unsigned long)__kprobes_text_start &&
1423 addr < (unsigned long)__kprobes_text_end;
1424}
1425
6143c6fb 1426static bool __within_kprobe_blacklist(unsigned long addr)
d0aaff97 1427{
376e2424 1428 struct kprobe_blacklist_entry *ent;
3d8d996e 1429
be8f2743 1430 if (arch_within_kprobe_blacklist(addr))
376e2424 1431 return true;
3d8d996e
SD
1432 /*
1433 * If there exists a kprobe_blacklist, verify and
1434 * fail any probe registration in the prohibited area
1435 */
376e2424
MH
1436 list_for_each_entry(ent, &kprobe_blacklist, list) {
1437 if (addr >= ent->start_addr && addr < ent->end_addr)
1438 return true;
3d8d996e 1439 }
6143c6fb
MH
1440 return false;
1441}
376e2424 1442
6143c6fb
MH
1443bool within_kprobe_blacklist(unsigned long addr)
1444{
1445 char symname[KSYM_NAME_LEN], *p;
1446
1447 if (__within_kprobe_blacklist(addr))
1448 return true;
1449
1450 /* Check if the address is on a suffixed-symbol */
1451 if (!lookup_symbol_name(addr, symname)) {
1452 p = strchr(symname, '.');
1453 if (!p)
1454 return false;
1455 *p = '\0';
1456 addr = (unsigned long)kprobe_lookup_name(symname, 0);
1457 if (addr)
1458 return __within_kprobe_blacklist(addr);
1459 }
376e2424 1460 return false;
d0aaff97
PP
1461}
1462
b2a5cd69
MH
1463/*
1464 * If we have a symbol_name argument, look it up and add the offset field
1465 * to it. This way, we can specify a relative address to a symbol.
bc81d48d
MH
1466 * This returns encoded errors if it fails to look up symbol or invalid
1467 * combination of parameters.
b2a5cd69 1468 */
1d585e70
NR
1469static kprobe_opcode_t *_kprobe_addr(kprobe_opcode_t *addr,
1470 const char *symbol_name, unsigned int offset)
b2a5cd69 1471{
1d585e70 1472 if ((symbol_name && addr) || (!symbol_name && !addr))
bc81d48d
MH
1473 goto invalid;
1474
1d585e70 1475 if (symbol_name) {
7246f600 1476 addr = kprobe_lookup_name(symbol_name, offset);
bc81d48d
MH
1477 if (!addr)
1478 return ERR_PTR(-ENOENT);
b2a5cd69
MH
1479 }
1480
1d585e70 1481 addr = (kprobe_opcode_t *)(((char *)addr) + offset);
bc81d48d
MH
1482 if (addr)
1483 return addr;
1484
1485invalid:
1486 return ERR_PTR(-EINVAL);
b2a5cd69
MH
1487}
1488
1d585e70
NR
1489static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
1490{
1491 return _kprobe_addr(p->addr, p->symbol_name, p->offset);
1492}
1493
1f0ab409 1494/* Check passed kprobe is valid and return kprobe in kprobe_table. */
55479f64 1495static struct kprobe *__get_valid_kprobe(struct kprobe *p)
1f0ab409 1496{
6d8e40a8 1497 struct kprobe *ap, *list_p;
1f0ab409 1498
7e6a71d8
MH
1499 lockdep_assert_held(&kprobe_mutex);
1500
6d8e40a8
MH
1501 ap = get_kprobe(p->addr);
1502 if (unlikely(!ap))
1f0ab409
AM
1503 return NULL;
1504
6d8e40a8 1505 if (p != ap) {
7e6a71d8 1506 list_for_each_entry(list_p, &ap->list, list)
1f0ab409
AM
1507 if (list_p == p)
1508 /* kprobe p is a valid probe */
1509 goto valid;
1510 return NULL;
1511 }
1512valid:
6d8e40a8 1513 return ap;
1f0ab409
AM
1514}
1515
33b1d146
MH
1516/*
1517 * Warn and return error if the kprobe is being re-registered since
1518 * there must be a software bug.
1519 */
1520static inline int warn_kprobe_rereg(struct kprobe *p)
1f0ab409
AM
1521{
1522 int ret = 0;
1f0ab409
AM
1523
1524 mutex_lock(&kprobe_mutex);
33b1d146 1525 if (WARN_ON_ONCE(__get_valid_kprobe(p)))
1f0ab409
AM
1526 ret = -EINVAL;
1527 mutex_unlock(&kprobe_mutex);
6d8e40a8 1528
1f0ab409
AM
1529 return ret;
1530}
1531
f7f242ff 1532int __weak arch_check_ftrace_location(struct kprobe *p)
1da177e4 1533{
ae6aa16f
MH
1534 unsigned long ftrace_addr;
1535
ae6aa16f
MH
1536 ftrace_addr = ftrace_location((unsigned long)p->addr);
1537 if (ftrace_addr) {
e7dbfe34 1538#ifdef CONFIG_KPROBES_ON_FTRACE
ae6aa16f
MH
1539 /* Given address is not on the instruction boundary */
1540 if ((unsigned long)p->addr != ftrace_addr)
1541 return -EILSEQ;
ae6aa16f 1542 p->flags |= KPROBE_FLAG_FTRACE;
e7dbfe34 1543#else /* !CONFIG_KPROBES_ON_FTRACE */
ae6aa16f
MH
1544 return -EINVAL;
1545#endif
1546 }
f7f242ff
HC
1547 return 0;
1548}
1549
1550static int check_kprobe_address_safe(struct kprobe *p,
1551 struct module **probed_mod)
1552{
1553 int ret;
1f0ab409 1554
f7f242ff
HC
1555 ret = arch_check_ftrace_location(p);
1556 if (ret)
1557 return ret;
91bad2f8 1558 jump_label_lock();
de31c3ca 1559 preempt_disable();
f7fa6ef0
MH
1560
1561 /* Ensure it is not in reserved area nor out of text */
ec30c5f3 1562 if (!kernel_text_address((unsigned long) p->addr) ||
376e2424 1563 within_kprobe_blacklist((unsigned long) p->addr) ||
e336b402 1564 jump_label_text_reserved(p->addr, p->addr) ||
fa68bd09 1565 static_call_text_reserved(p->addr, p->addr) ||
e336b402 1566 find_bug((unsigned long)p->addr)) {
f986a499 1567 ret = -EINVAL;
f7fa6ef0 1568 goto out;
f986a499 1569 }
b3e55c72 1570
f7fa6ef0
MH
1571 /* Check if are we probing a module */
1572 *probed_mod = __module_text_address((unsigned long) p->addr);
1573 if (*probed_mod) {
6f716acd 1574 /*
e8386a0c
MH
1575 * We must hold a refcount of the probed module while updating
1576 * its code to prohibit unexpected unloading.
df019b1d 1577 */
f7fa6ef0
MH
1578 if (unlikely(!try_module_get(*probed_mod))) {
1579 ret = -ENOENT;
1580 goto out;
1581 }
de31c3ca 1582
f24659d9
MH
1583 /*
1584 * If the module freed .init.text, we couldn't insert
1585 * kprobes in there.
1586 */
f7fa6ef0
MH
1587 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1588 (*probed_mod)->state != MODULE_STATE_COMING) {
1589 module_put(*probed_mod);
1590 *probed_mod = NULL;
1591 ret = -ENOENT;
f24659d9 1592 }
df019b1d 1593 }
f7fa6ef0 1594out:
a189d035 1595 preempt_enable();
de31c3ca 1596 jump_label_unlock();
1da177e4 1597
f7fa6ef0
MH
1598 return ret;
1599}
1600
55479f64 1601int register_kprobe(struct kprobe *p)
f7fa6ef0
MH
1602{
1603 int ret;
1604 struct kprobe *old_p;
1605 struct module *probed_mod;
1606 kprobe_opcode_t *addr;
1607
1608 /* Adjust probe address from symbol */
1609 addr = kprobe_addr(p);
1610 if (IS_ERR(addr))
1611 return PTR_ERR(addr);
1612 p->addr = addr;
1613
33b1d146 1614 ret = warn_kprobe_rereg(p);
f7fa6ef0
MH
1615 if (ret)
1616 return ret;
1617
1618 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1619 p->flags &= KPROBE_FLAG_DISABLED;
3516a460 1620 p->nmissed = 0;
9861668f 1621 INIT_LIST_HEAD(&p->list);
afd66255 1622
f7fa6ef0
MH
1623 ret = check_kprobe_address_safe(p, &probed_mod);
1624 if (ret)
1625 return ret;
1626
1627 mutex_lock(&kprobe_mutex);
afd66255 1628
64f562c6
AM
1629 old_p = get_kprobe(p->addr);
1630 if (old_p) {
afd66255 1631 /* Since this may unoptimize old_p, locking text_mutex. */
64f562c6 1632 ret = register_aggr_kprobe(old_p, p);
1da177e4
LT
1633 goto out;
1634 }
1da177e4 1635
2d1e38f5
TG
1636 cpus_read_lock();
1637 /* Prevent text modification */
1638 mutex_lock(&text_mutex);
ae6aa16f 1639 ret = prepare_kprobe(p);
25764288 1640 mutex_unlock(&text_mutex);
2d1e38f5 1641 cpus_read_unlock();
6f716acd 1642 if (ret)
afd66255 1643 goto out;
49a2a1b8 1644
64f562c6 1645 INIT_HLIST_NODE(&p->hlist);
3516a460 1646 hlist_add_head_rcu(&p->hlist,
1da177e4
LT
1647 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1648
12310e34
JY
1649 if (!kprobes_all_disarmed && !kprobe_disabled(p)) {
1650 ret = arm_kprobe(p);
1651 if (ret) {
1652 hlist_del_rcu(&p->hlist);
ae8b7ce7 1653 synchronize_rcu();
12310e34
JY
1654 goto out;
1655 }
1656 }
afd66255
MH
1657
1658 /* Try to optimize kprobe */
1659 try_to_optimize_kprobe(p);
1da177e4 1660out:
7a7d1cf9 1661 mutex_unlock(&kprobe_mutex);
49a2a1b8 1662
e8386a0c 1663 if (probed_mod)
df019b1d 1664 module_put(probed_mod);
e8386a0c 1665
1da177e4
LT
1666 return ret;
1667}
99081ab5 1668EXPORT_SYMBOL_GPL(register_kprobe);
1da177e4 1669
6f0f1dd7 1670/* Check if all probes on the aggrprobe are disabled */
55479f64 1671static int aggr_kprobe_disabled(struct kprobe *ap)
6f0f1dd7
MH
1672{
1673 struct kprobe *kp;
1674
7e6a71d8
MH
1675 lockdep_assert_held(&kprobe_mutex);
1676
1677 list_for_each_entry(kp, &ap->list, list)
6f0f1dd7
MH
1678 if (!kprobe_disabled(kp))
1679 /*
1680 * There is an active probe on the list.
1681 * We can't disable this ap.
1682 */
1683 return 0;
1684
1685 return 1;
1686}
1687
1688/* Disable one kprobe: Make sure called under kprobe_mutex is locked */
55479f64 1689static struct kprobe *__disable_kprobe(struct kprobe *p)
6f0f1dd7
MH
1690{
1691 struct kprobe *orig_p;
297f9233 1692 int ret;
6f0f1dd7
MH
1693
1694 /* Get an original kprobe for return */
1695 orig_p = __get_valid_kprobe(p);
1696 if (unlikely(orig_p == NULL))
297f9233 1697 return ERR_PTR(-EINVAL);
6f0f1dd7
MH
1698
1699 if (!kprobe_disabled(p)) {
1700 /* Disable probe if it is a child probe */
1701 if (p != orig_p)
1702 p->flags |= KPROBE_FLAG_DISABLED;
1703
1704 /* Try to disarm and disable this/parent probe */
1705 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
69d54b91
WN
1706 /*
1707 * If kprobes_all_disarmed is set, orig_p
1708 * should have already been disarmed, so
1709 * skip unneed disarming process.
1710 */
297f9233
JY
1711 if (!kprobes_all_disarmed) {
1712 ret = disarm_kprobe(orig_p, true);
1713 if (ret) {
1714 p->flags &= ~KPROBE_FLAG_DISABLED;
1715 return ERR_PTR(ret);
1716 }
1717 }
6f0f1dd7
MH
1718 orig_p->flags |= KPROBE_FLAG_DISABLED;
1719 }
1720 }
1721
1722 return orig_p;
1723}
1724
de5bd88d
MH
1725/*
1726 * Unregister a kprobe without a scheduler synchronization.
1727 */
55479f64 1728static int __unregister_kprobe_top(struct kprobe *p)
de5bd88d 1729{
6d8e40a8 1730 struct kprobe *ap, *list_p;
de5bd88d 1731
6f0f1dd7
MH
1732 /* Disable kprobe. This will disarm it if needed. */
1733 ap = __disable_kprobe(p);
297f9233
JY
1734 if (IS_ERR(ap))
1735 return PTR_ERR(ap);
de5bd88d 1736
6f0f1dd7 1737 if (ap == p)
bf8f6e5b 1738 /*
6f0f1dd7
MH
1739 * This probe is an independent(and non-optimized) kprobe
1740 * (not an aggrprobe). Remove from the hash list.
bf8f6e5b 1741 */
6f0f1dd7
MH
1742 goto disarmed;
1743
1744 /* Following process expects this probe is an aggrprobe */
1745 WARN_ON(!kprobe_aggrprobe(ap));
1746
6274de49
MH
1747 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1748 /*
1749 * !disarmed could be happen if the probe is under delayed
1750 * unoptimizing.
1751 */
6f0f1dd7
MH
1752 goto disarmed;
1753 else {
1754 /* If disabling probe has special handlers, update aggrprobe */
e8386a0c 1755 if (p->post_handler && !kprobe_gone(p)) {
7e6a71d8 1756 list_for_each_entry(list_p, &ap->list, list) {
9861668f
MH
1757 if ((list_p != p) && (list_p->post_handler))
1758 goto noclean;
1759 }
6d8e40a8 1760 ap->post_handler = NULL;
9861668f
MH
1761 }
1762noclean:
6f0f1dd7
MH
1763 /*
1764 * Remove from the aggrprobe: this path will do nothing in
1765 * __unregister_kprobe_bottom().
1766 */
49a2a1b8 1767 list_del_rcu(&p->list);
6f0f1dd7
MH
1768 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1769 /*
1770 * Try to optimize this probe again, because post
1771 * handler may have been changed.
1772 */
1773 optimize_kprobe(ap);
49a2a1b8 1774 }
9861668f 1775 return 0;
6f0f1dd7
MH
1776
1777disarmed:
1778 hlist_del_rcu(&ap->hlist);
1779 return 0;
9861668f 1780}
3516a460 1781
55479f64 1782static void __unregister_kprobe_bottom(struct kprobe *p)
9861668f 1783{
6d8e40a8 1784 struct kprobe *ap;
b3e55c72 1785
e8386a0c 1786 if (list_empty(&p->list))
6274de49 1787 /* This is an independent kprobe */
0498b635 1788 arch_remove_kprobe(p);
e8386a0c 1789 else if (list_is_singular(&p->list)) {
6274de49 1790 /* This is the last child of an aggrprobe */
6d8e40a8 1791 ap = list_entry(p->list.next, struct kprobe, list);
e8386a0c 1792 list_del(&p->list);
6d8e40a8 1793 free_aggr_kprobe(ap);
9861668f 1794 }
6274de49 1795 /* Otherwise, do nothing. */
9861668f
MH
1796}
1797
55479f64 1798int register_kprobes(struct kprobe **kps, int num)
9861668f
MH
1799{
1800 int i, ret = 0;
1801
1802 if (num <= 0)
1803 return -EINVAL;
1804 for (i = 0; i < num; i++) {
49ad2fd7 1805 ret = register_kprobe(kps[i]);
67dddaad
MH
1806 if (ret < 0) {
1807 if (i > 0)
1808 unregister_kprobes(kps, i);
9861668f 1809 break;
36721656 1810 }
49a2a1b8 1811 }
9861668f
MH
1812 return ret;
1813}
99081ab5 1814EXPORT_SYMBOL_GPL(register_kprobes);
9861668f 1815
55479f64 1816void unregister_kprobe(struct kprobe *p)
9861668f
MH
1817{
1818 unregister_kprobes(&p, 1);
1819}
99081ab5 1820EXPORT_SYMBOL_GPL(unregister_kprobe);
9861668f 1821
55479f64 1822void unregister_kprobes(struct kprobe **kps, int num)
9861668f
MH
1823{
1824 int i;
1825
1826 if (num <= 0)
1827 return;
1828 mutex_lock(&kprobe_mutex);
1829 for (i = 0; i < num; i++)
1830 if (__unregister_kprobe_top(kps[i]) < 0)
1831 kps[i]->addr = NULL;
1832 mutex_unlock(&kprobe_mutex);
1833
ae8b7ce7 1834 synchronize_rcu();
9861668f
MH
1835 for (i = 0; i < num; i++)
1836 if (kps[i]->addr)
1837 __unregister_kprobe_bottom(kps[i]);
1da177e4 1838}
99081ab5 1839EXPORT_SYMBOL_GPL(unregister_kprobes);
1da177e4 1840
5f6bee34
NR
1841int __weak kprobe_exceptions_notify(struct notifier_block *self,
1842 unsigned long val, void *data)
fc62d020
NR
1843{
1844 return NOTIFY_DONE;
1845}
5f6bee34 1846NOKPROBE_SYMBOL(kprobe_exceptions_notify);
fc62d020 1847
1da177e4 1848static struct notifier_block kprobe_exceptions_nb = {
3d5631e0
AK
1849 .notifier_call = kprobe_exceptions_notify,
1850 .priority = 0x7fffffff /* we need to be notified first */
1851};
1852
3d7e3382
ME
1853unsigned long __weak arch_deref_entry_point(void *entry)
1854{
1855 return (unsigned long)entry;
1856}
1da177e4 1857
9edddaa2 1858#ifdef CONFIG_KRETPROBES
66ada2cc
MH
1859
1860unsigned long __kretprobe_trampoline_handler(struct pt_regs *regs,
1861 void *trampoline_address,
1862 void *frame_pointer)
1863{
66ada2cc 1864 kprobe_opcode_t *correct_ret_addr = NULL;
d741bf41
PZ
1865 struct kretprobe_instance *ri = NULL;
1866 struct llist_node *first, *node;
1867 struct kretprobe *rp;
66ada2cc 1868
d741bf41
PZ
1869 /* Find all nodes for this frame. */
1870 first = node = current->kretprobe_instances.first;
1871 while (node) {
1872 ri = container_of(node, struct kretprobe_instance, llist);
66ada2cc 1873
d741bf41 1874 BUG_ON(ri->fp != frame_pointer);
66ada2cc 1875
d741bf41
PZ
1876 if (ri->ret_addr != trampoline_address) {
1877 correct_ret_addr = ri->ret_addr;
66ada2cc
MH
1878 /*
1879 * This is the real return address. Any other
1880 * instances associated with this task are for
1881 * other calls deeper on the call stack
1882 */
d741bf41
PZ
1883 goto found;
1884 }
1885
1886 node = node->next;
66ada2cc 1887 }
d741bf41
PZ
1888 pr_err("Oops! Kretprobe fails to find correct return address.\n");
1889 BUG_ON(1);
66ada2cc 1890
d741bf41
PZ
1891found:
1892 /* Unlink all nodes for this frame. */
1893 current->kretprobe_instances.first = node->next;
1894 node->next = NULL;
66ada2cc 1895
d741bf41
PZ
1896 /* Run them.. */
1897 while (first) {
1898 ri = container_of(first, struct kretprobe_instance, llist);
1899 first = first->next;
66ada2cc 1900
d741bf41
PZ
1901 rp = get_kretprobe(ri);
1902 if (rp && rp->handler) {
66ada2cc
MH
1903 struct kprobe *prev = kprobe_running();
1904
d741bf41 1905 __this_cpu_write(current_kprobe, &rp->kp);
66ada2cc 1906 ri->ret_addr = correct_ret_addr;
d741bf41 1907 rp->handler(ri, regs);
66ada2cc
MH
1908 __this_cpu_write(current_kprobe, prev);
1909 }
1910
b3388178 1911 recycle_rp_inst(ri);
66ada2cc
MH
1912 }
1913
66ada2cc
MH
1914 return (unsigned long)correct_ret_addr;
1915}
1916NOKPROBE_SYMBOL(__kretprobe_trampoline_handler)
1917
e65cefe8
AB
1918/*
1919 * This kprobe pre_handler is registered with every kretprobe. When probe
1920 * hits it will set up the return probe.
1921 */
820aede0 1922static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
e65cefe8
AB
1923{
1924 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
ef53d9c5 1925 struct kretprobe_instance *ri;
6e426e0f 1926 struct freelist_node *fn;
e65cefe8 1927
6e426e0f
PZ
1928 fn = freelist_try_get(&rp->freelist);
1929 if (!fn) {
1930 rp->nmissed++;
1931 return 0;
1932 }
4c4308cb 1933
6e426e0f 1934 ri = container_of(fn, struct kretprobe_instance, freelist);
d741bf41 1935
6e426e0f
PZ
1936 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1937 freelist_add(&ri->freelist, &rp->freelist);
1938 return 0;
ef53d9c5 1939 }
6e426e0f
PZ
1940
1941 arch_prepare_kretprobe(ri, regs);
1942
1943 __llist_add(&ri->llist, &current->kretprobe_instances);
1944
e65cefe8
AB
1945 return 0;
1946}
820aede0 1947NOKPROBE_SYMBOL(pre_handler_kretprobe);
e65cefe8 1948
659b957f 1949bool __weak arch_kprobe_on_func_entry(unsigned long offset)
90ec5e89
NR
1950{
1951 return !offset;
1952}
1953
97c753e6
MH
1954/**
1955 * kprobe_on_func_entry() -- check whether given address is function entry
1956 * @addr: Target address
1957 * @sym: Target symbol name
1958 * @offset: The offset from the symbol or the address
1959 *
1960 * This checks whether the given @addr+@offset or @sym+@offset is on the
1961 * function entry address or not.
1962 * This returns 0 if it is the function entry, or -EINVAL if it is not.
1963 * And also it returns -ENOENT if it fails the symbol or address lookup.
1964 * Caller must pass @addr or @sym (either one must be NULL), or this
1965 * returns -EINVAL.
1966 */
1967int kprobe_on_func_entry(kprobe_opcode_t *addr, const char *sym, unsigned long offset)
1d585e70
NR
1968{
1969 kprobe_opcode_t *kp_addr = _kprobe_addr(addr, sym, offset);
1970
1971 if (IS_ERR(kp_addr))
97c753e6 1972 return PTR_ERR(kp_addr);
1d585e70 1973
97c753e6
MH
1974 if (!kallsyms_lookup_size_offset((unsigned long)kp_addr, NULL, &offset))
1975 return -ENOENT;
1d585e70 1976
97c753e6
MH
1977 if (!arch_kprobe_on_func_entry(offset))
1978 return -EINVAL;
1979
1980 return 0;
1d585e70
NR
1981}
1982
55479f64 1983int register_kretprobe(struct kretprobe *rp)
b94cce92 1984{
97c753e6 1985 int ret;
b94cce92
HN
1986 struct kretprobe_instance *inst;
1987 int i;
b2a5cd69 1988 void *addr;
90ec5e89 1989
97c753e6
MH
1990 ret = kprobe_on_func_entry(rp->kp.addr, rp->kp.symbol_name, rp->kp.offset);
1991 if (ret)
1992 return ret;
f438d914 1993
0188b878 1994 /* If only rp->kp.addr is specified, check reregistering kprobes */
33b1d146 1995 if (rp->kp.addr && warn_kprobe_rereg(&rp->kp))
0188b878
WS
1996 return -EINVAL;
1997
f438d914 1998 if (kretprobe_blacklist_size) {
b2a5cd69 1999 addr = kprobe_addr(&rp->kp);
bc81d48d
MH
2000 if (IS_ERR(addr))
2001 return PTR_ERR(addr);
f438d914
MH
2002
2003 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
2004 if (kretprobe_blacklist[i].addr == addr)
2005 return -EINVAL;
2006 }
2007 }
b94cce92 2008
a40b55fa
MH
2009 if (rp->data_size > KRETPROBE_MAX_DATA_SIZE)
2010 return -E2BIG;
2011
b94cce92 2012 rp->kp.pre_handler = pre_handler_kretprobe;
7522a842 2013 rp->kp.post_handler = NULL;
b94cce92
HN
2014
2015 /* Pre-allocate memory for max kretprobe instances */
2016 if (rp->maxactive <= 0) {
92616606 2017#ifdef CONFIG_PREEMPTION
c2ef6661 2018 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
b94cce92 2019#else
4dae560f 2020 rp->maxactive = num_possible_cpus();
b94cce92
HN
2021#endif
2022 }
6e426e0f 2023 rp->freelist.head = NULL;
d741bf41
PZ
2024 rp->rph = kzalloc(sizeof(struct kretprobe_holder), GFP_KERNEL);
2025 if (!rp->rph)
2026 return -ENOMEM;
2027
2028 rp->rph->rp = rp;
b94cce92 2029 for (i = 0; i < rp->maxactive; i++) {
d741bf41 2030 inst = kzalloc(sizeof(struct kretprobe_instance) +
f47cd9b5 2031 rp->data_size, GFP_KERNEL);
b94cce92 2032 if (inst == NULL) {
d741bf41 2033 refcount_set(&rp->rph->ref, i);
b94cce92
HN
2034 free_rp_inst(rp);
2035 return -ENOMEM;
2036 }
d741bf41 2037 inst->rph = rp->rph;
6e426e0f 2038 freelist_add(&inst->freelist, &rp->freelist);
b94cce92 2039 }
d741bf41 2040 refcount_set(&rp->rph->ref, i);
b94cce92
HN
2041
2042 rp->nmissed = 0;
2043 /* Establish function entry probe point */
49ad2fd7 2044 ret = register_kprobe(&rp->kp);
4a296e07 2045 if (ret != 0)
b94cce92
HN
2046 free_rp_inst(rp);
2047 return ret;
2048}
99081ab5 2049EXPORT_SYMBOL_GPL(register_kretprobe);
b94cce92 2050
55479f64 2051int register_kretprobes(struct kretprobe **rps, int num)
4a296e07
MH
2052{
2053 int ret = 0, i;
2054
2055 if (num <= 0)
2056 return -EINVAL;
2057 for (i = 0; i < num; i++) {
49ad2fd7 2058 ret = register_kretprobe(rps[i]);
67dddaad
MH
2059 if (ret < 0) {
2060 if (i > 0)
2061 unregister_kretprobes(rps, i);
4a296e07
MH
2062 break;
2063 }
2064 }
2065 return ret;
2066}
99081ab5 2067EXPORT_SYMBOL_GPL(register_kretprobes);
4a296e07 2068
55479f64 2069void unregister_kretprobe(struct kretprobe *rp)
4a296e07
MH
2070{
2071 unregister_kretprobes(&rp, 1);
2072}
99081ab5 2073EXPORT_SYMBOL_GPL(unregister_kretprobe);
4a296e07 2074
55479f64 2075void unregister_kretprobes(struct kretprobe **rps, int num)
4a296e07
MH
2076{
2077 int i;
2078
2079 if (num <= 0)
2080 return;
2081 mutex_lock(&kprobe_mutex);
d741bf41 2082 for (i = 0; i < num; i++) {
4a296e07
MH
2083 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
2084 rps[i]->kp.addr = NULL;
d741bf41
PZ
2085 rps[i]->rph->rp = NULL;
2086 }
4a296e07
MH
2087 mutex_unlock(&kprobe_mutex);
2088
ae8b7ce7 2089 synchronize_rcu();
4a296e07
MH
2090 for (i = 0; i < num; i++) {
2091 if (rps[i]->kp.addr) {
2092 __unregister_kprobe_bottom(&rps[i]->kp);
d741bf41 2093 free_rp_inst(rps[i]);
4a296e07
MH
2094 }
2095 }
2096}
99081ab5 2097EXPORT_SYMBOL_GPL(unregister_kretprobes);
4a296e07 2098
9edddaa2 2099#else /* CONFIG_KRETPROBES */
55479f64 2100int register_kretprobe(struct kretprobe *rp)
b94cce92
HN
2101{
2102 return -ENOSYS;
2103}
99081ab5 2104EXPORT_SYMBOL_GPL(register_kretprobe);
b94cce92 2105
55479f64 2106int register_kretprobes(struct kretprobe **rps, int num)
346fd59b 2107{
4a296e07 2108 return -ENOSYS;
346fd59b 2109}
99081ab5
MH
2110EXPORT_SYMBOL_GPL(register_kretprobes);
2111
55479f64 2112void unregister_kretprobe(struct kretprobe *rp)
b94cce92 2113{
4a296e07 2114}
99081ab5 2115EXPORT_SYMBOL_GPL(unregister_kretprobe);
b94cce92 2116
55479f64 2117void unregister_kretprobes(struct kretprobe **rps, int num)
4a296e07
MH
2118{
2119}
99081ab5 2120EXPORT_SYMBOL_GPL(unregister_kretprobes);
4c4308cb 2121
820aede0 2122static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
4a296e07
MH
2123{
2124 return 0;
b94cce92 2125}
820aede0 2126NOKPROBE_SYMBOL(pre_handler_kretprobe);
b94cce92 2127
4a296e07
MH
2128#endif /* CONFIG_KRETPROBES */
2129
e8386a0c 2130/* Set the kprobe gone and remove its instruction buffer. */
55479f64 2131static void kill_kprobe(struct kprobe *p)
e8386a0c
MH
2132{
2133 struct kprobe *kp;
de5bd88d 2134
7e6a71d8
MH
2135 lockdep_assert_held(&kprobe_mutex);
2136
e8386a0c 2137 p->flags |= KPROBE_FLAG_GONE;
afd66255 2138 if (kprobe_aggrprobe(p)) {
e8386a0c
MH
2139 /*
2140 * If this is an aggr_kprobe, we have to list all the
2141 * chained probes and mark them GONE.
2142 */
7e6a71d8 2143 list_for_each_entry(kp, &p->list, list)
e8386a0c
MH
2144 kp->flags |= KPROBE_FLAG_GONE;
2145 p->post_handler = NULL;
afd66255 2146 kill_optimized_kprobe(p);
e8386a0c
MH
2147 }
2148 /*
2149 * Here, we can remove insn_slot safely, because no thread calls
2150 * the original probed function (which will be freed soon) any more.
2151 */
2152 arch_remove_kprobe(p);
0cb2f137
MS
2153
2154 /*
2155 * The module is going away. We should disarm the kprobe which
bcb53209
MH
2156 * is using ftrace, because ftrace framework is still available at
2157 * MODULE_STATE_GOING notification.
0cb2f137 2158 */
bcb53209 2159 if (kprobe_ftrace(p) && !kprobe_disabled(p) && !kprobes_all_disarmed)
0cb2f137 2160 disarm_kprobe_ftrace(p);
e8386a0c
MH
2161}
2162
c0614829 2163/* Disable one kprobe */
55479f64 2164int disable_kprobe(struct kprobe *kp)
c0614829
MH
2165{
2166 int ret = 0;
297f9233 2167 struct kprobe *p;
c0614829
MH
2168
2169 mutex_lock(&kprobe_mutex);
2170
6f0f1dd7 2171 /* Disable this kprobe */
297f9233
JY
2172 p = __disable_kprobe(kp);
2173 if (IS_ERR(p))
2174 ret = PTR_ERR(p);
c0614829 2175
c0614829
MH
2176 mutex_unlock(&kprobe_mutex);
2177 return ret;
2178}
2179EXPORT_SYMBOL_GPL(disable_kprobe);
2180
2181/* Enable one kprobe */
55479f64 2182int enable_kprobe(struct kprobe *kp)
c0614829
MH
2183{
2184 int ret = 0;
2185 struct kprobe *p;
2186
2187 mutex_lock(&kprobe_mutex);
2188
2189 /* Check whether specified probe is valid. */
2190 p = __get_valid_kprobe(kp);
2191 if (unlikely(p == NULL)) {
2192 ret = -EINVAL;
2193 goto out;
2194 }
2195
2196 if (kprobe_gone(kp)) {
2197 /* This kprobe has gone, we couldn't enable it. */
2198 ret = -EINVAL;
2199 goto out;
2200 }
2201
2202 if (p != kp)
2203 kp->flags &= ~KPROBE_FLAG_DISABLED;
2204
2205 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2206 p->flags &= ~KPROBE_FLAG_DISABLED;
12310e34
JY
2207 ret = arm_kprobe(p);
2208 if (ret)
2209 p->flags |= KPROBE_FLAG_DISABLED;
c0614829
MH
2210 }
2211out:
2212 mutex_unlock(&kprobe_mutex);
2213 return ret;
2214}
2215EXPORT_SYMBOL_GPL(enable_kprobe);
2216
4458515b 2217/* Caller must NOT call this in usual path. This is only for critical case */
820aede0 2218void dump_kprobe(struct kprobe *kp)
24851d24 2219{
4458515b
MH
2220 pr_err("Dumping kprobe:\n");
2221 pr_err("Name: %s\nOffset: %x\nAddress: %pS\n",
2222 kp->symbol_name, kp->offset, kp->addr);
24851d24 2223}
820aede0 2224NOKPROBE_SYMBOL(dump_kprobe);
24851d24 2225
fb1a59fa
MH
2226int kprobe_add_ksym_blacklist(unsigned long entry)
2227{
2228 struct kprobe_blacklist_entry *ent;
2229 unsigned long offset = 0, size = 0;
2230
2231 if (!kernel_text_address(entry) ||
2232 !kallsyms_lookup_size_offset(entry, &size, &offset))
2233 return -EINVAL;
2234
2235 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2236 if (!ent)
2237 return -ENOMEM;
2238 ent->start_addr = entry;
2239 ent->end_addr = entry + size;
2240 INIT_LIST_HEAD(&ent->list);
2241 list_add_tail(&ent->list, &kprobe_blacklist);
2242
2243 return (int)size;
2244}
2245
2246/* Add all symbols in given area into kprobe blacklist */
2247int kprobe_add_area_blacklist(unsigned long start, unsigned long end)
2248{
2249 unsigned long entry;
2250 int ret = 0;
2251
2252 for (entry = start; entry < end; entry += ret) {
2253 ret = kprobe_add_ksym_blacklist(entry);
2254 if (ret < 0)
2255 return ret;
2256 if (ret == 0) /* In case of alias symbol */
2257 ret = 1;
2258 }
2259 return 0;
2260}
2261
1e6769b0
MH
2262/* Remove all symbols in given area from kprobe blacklist */
2263static void kprobe_remove_area_blacklist(unsigned long start, unsigned long end)
2264{
2265 struct kprobe_blacklist_entry *ent, *n;
2266
2267 list_for_each_entry_safe(ent, n, &kprobe_blacklist, list) {
2268 if (ent->start_addr < start || ent->start_addr >= end)
2269 continue;
2270 list_del(&ent->list);
2271 kfree(ent);
2272 }
2273}
2274
16db6264
MH
2275static void kprobe_remove_ksym_blacklist(unsigned long entry)
2276{
2277 kprobe_remove_area_blacklist(entry, entry + 1);
2278}
2279
d002b8bc
AH
2280int __weak arch_kprobe_get_kallsym(unsigned int *symnum, unsigned long *value,
2281 char *type, char *sym)
2282{
2283 return -ERANGE;
2284}
2285
2286int kprobe_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
2287 char *sym)
2288{
2289#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
2290 if (!kprobe_cache_get_kallsym(&kprobe_insn_slots, &symnum, value, type, sym))
2291 return 0;
2292#ifdef CONFIG_OPTPROBES
2293 if (!kprobe_cache_get_kallsym(&kprobe_optinsn_slots, &symnum, value, type, sym))
2294 return 0;
2295#endif
2296#endif
2297 if (!arch_kprobe_get_kallsym(&symnum, value, type, sym))
2298 return 0;
2299 return -ERANGE;
2300}
2301
fb1a59fa
MH
2302int __init __weak arch_populate_kprobe_blacklist(void)
2303{
2304 return 0;
2305}
2306
376e2424
MH
2307/*
2308 * Lookup and populate the kprobe_blacklist.
2309 *
2310 * Unlike the kretprobe blacklist, we'll need to determine
2311 * the range of addresses that belong to the said functions,
2312 * since a kprobe need not necessarily be at the beginning
2313 * of a function.
2314 */
2315static int __init populate_kprobe_blacklist(unsigned long *start,
2316 unsigned long *end)
2317{
fb1a59fa 2318 unsigned long entry;
376e2424 2319 unsigned long *iter;
fb1a59fa 2320 int ret;
376e2424
MH
2321
2322 for (iter = start; iter < end; iter++) {
d81b4253 2323 entry = arch_deref_entry_point((void *)*iter);
fb1a59fa
MH
2324 ret = kprobe_add_ksym_blacklist(entry);
2325 if (ret == -EINVAL)
376e2424 2326 continue;
fb1a59fa
MH
2327 if (ret < 0)
2328 return ret;
376e2424 2329 }
fb1a59fa
MH
2330
2331 /* Symbols in __kprobes_text are blacklisted */
2332 ret = kprobe_add_area_blacklist((unsigned long)__kprobes_text_start,
2333 (unsigned long)__kprobes_text_end);
66e9b071
TG
2334 if (ret)
2335 return ret;
2336
2337 /* Symbols in noinstr section are blacklisted */
2338 ret = kprobe_add_area_blacklist((unsigned long)__noinstr_text_start,
2339 (unsigned long)__noinstr_text_end);
fb1a59fa
MH
2340
2341 return ret ? : arch_populate_kprobe_blacklist();
376e2424
MH
2342}
2343
1e6769b0
MH
2344static void add_module_kprobe_blacklist(struct module *mod)
2345{
2346 unsigned long start, end;
16db6264
MH
2347 int i;
2348
2349 if (mod->kprobe_blacklist) {
2350 for (i = 0; i < mod->num_kprobe_blacklist; i++)
2351 kprobe_add_ksym_blacklist(mod->kprobe_blacklist[i]);
2352 }
1e6769b0
MH
2353
2354 start = (unsigned long)mod->kprobes_text_start;
2355 if (start) {
2356 end = start + mod->kprobes_text_size;
2357 kprobe_add_area_blacklist(start, end);
2358 }
66e9b071
TG
2359
2360 start = (unsigned long)mod->noinstr_text_start;
2361 if (start) {
2362 end = start + mod->noinstr_text_size;
2363 kprobe_add_area_blacklist(start, end);
2364 }
1e6769b0
MH
2365}
2366
2367static void remove_module_kprobe_blacklist(struct module *mod)
2368{
2369 unsigned long start, end;
16db6264
MH
2370 int i;
2371
2372 if (mod->kprobe_blacklist) {
2373 for (i = 0; i < mod->num_kprobe_blacklist; i++)
2374 kprobe_remove_ksym_blacklist(mod->kprobe_blacklist[i]);
2375 }
1e6769b0
MH
2376
2377 start = (unsigned long)mod->kprobes_text_start;
2378 if (start) {
2379 end = start + mod->kprobes_text_size;
2380 kprobe_remove_area_blacklist(start, end);
2381 }
66e9b071
TG
2382
2383 start = (unsigned long)mod->noinstr_text_start;
2384 if (start) {
2385 end = start + mod->noinstr_text_size;
2386 kprobe_remove_area_blacklist(start, end);
2387 }
1e6769b0
MH
2388}
2389
e8386a0c 2390/* Module notifier call back, checking kprobes on the module */
55479f64
MH
2391static int kprobes_module_callback(struct notifier_block *nb,
2392 unsigned long val, void *data)
e8386a0c
MH
2393{
2394 struct module *mod = data;
2395 struct hlist_head *head;
e8386a0c
MH
2396 struct kprobe *p;
2397 unsigned int i;
f24659d9 2398 int checkcore = (val == MODULE_STATE_GOING);
e8386a0c 2399
1e6769b0
MH
2400 if (val == MODULE_STATE_COMING) {
2401 mutex_lock(&kprobe_mutex);
2402 add_module_kprobe_blacklist(mod);
2403 mutex_unlock(&kprobe_mutex);
2404 }
f24659d9 2405 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
e8386a0c
MH
2406 return NOTIFY_DONE;
2407
2408 /*
f24659d9
MH
2409 * When MODULE_STATE_GOING was notified, both of module .text and
2410 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2411 * notified, only .init.text section would be freed. We need to
2412 * disable kprobes which have been inserted in the sections.
e8386a0c
MH
2413 */
2414 mutex_lock(&kprobe_mutex);
2415 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2416 head = &kprobe_table[i];
7e6a71d8 2417 hlist_for_each_entry(p, head, hlist)
f24659d9
MH
2418 if (within_module_init((unsigned long)p->addr, mod) ||
2419 (checkcore &&
2420 within_module_core((unsigned long)p->addr, mod))) {
e8386a0c
MH
2421 /*
2422 * The vaddr this probe is installed will soon
2423 * be vfreed buy not synced to disk. Hence,
2424 * disarming the breakpoint isn't needed.
545a0281
SRV
2425 *
2426 * Note, this will also move any optimized probes
2427 * that are pending to be removed from their
2428 * corresponding lists to the freeing_list and
2429 * will not be touched by the delayed
2430 * kprobe_optimizer work handler.
e8386a0c
MH
2431 */
2432 kill_kprobe(p);
2433 }
2434 }
1e6769b0
MH
2435 if (val == MODULE_STATE_GOING)
2436 remove_module_kprobe_blacklist(mod);
e8386a0c
MH
2437 mutex_unlock(&kprobe_mutex);
2438 return NOTIFY_DONE;
2439}
2440
2441static struct notifier_block kprobe_module_nb = {
2442 .notifier_call = kprobes_module_callback,
2443 .priority = 0
2444};
2445
376e2424
MH
2446/* Markers of _kprobe_blacklist section */
2447extern unsigned long __start_kprobe_blacklist[];
2448extern unsigned long __stop_kprobe_blacklist[];
2449
82d083ab
MH
2450void kprobe_free_init_mem(void)
2451{
2452 void *start = (void *)(&__init_begin);
2453 void *end = (void *)(&__init_end);
2454 struct hlist_head *head;
2455 struct kprobe *p;
2456 int i;
2457
2458 mutex_lock(&kprobe_mutex);
2459
2460 /* Kill all kprobes on initmem */
2461 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2462 head = &kprobe_table[i];
2463 hlist_for_each_entry(p, head, hlist) {
2464 if (start <= (void *)p->addr && (void *)p->addr < end)
2465 kill_kprobe(p);
2466 }
2467 }
2468
2469 mutex_unlock(&kprobe_mutex);
2470}
2471
1da177e4
LT
2472static int __init init_kprobes(void)
2473{
2474 int i, err = 0;
2475
2476 /* FIXME allocate the probe table, currently defined statically */
2477 /* initialize all list heads */
d741bf41 2478 for (i = 0; i < KPROBE_TABLE_SIZE; i++)
1da177e4
LT
2479 INIT_HLIST_HEAD(&kprobe_table[i]);
2480
376e2424
MH
2481 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2482 __stop_kprobe_blacklist);
2483 if (err) {
2484 pr_err("kprobes: failed to populate blacklist: %d\n", err);
2485 pr_err("Please take care of using kprobes.\n");
3d8d996e
SD
2486 }
2487
f438d914
MH
2488 if (kretprobe_blacklist_size) {
2489 /* lookup the function address from its name */
2490 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
49e0b465 2491 kretprobe_blacklist[i].addr =
290e3070 2492 kprobe_lookup_name(kretprobe_blacklist[i].name, 0);
f438d914
MH
2493 if (!kretprobe_blacklist[i].addr)
2494 printk("kretprobe: lookup failed: %s\n",
2495 kretprobe_blacklist[i].name);
2496 }
2497 }
2498
e579abeb
MH
2499 /* By default, kprobes are armed */
2500 kprobes_all_disarmed = false;
bf8f6e5b 2501
c85c9a2c
MH
2502#if defined(CONFIG_OPTPROBES) && defined(__ARCH_WANT_KPROBES_INSN_SLOT)
2503 /* Init kprobe_optinsn_slots for allocation */
2504 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2505#endif
2506
6772926b 2507 err = arch_init_kprobes();
802eae7c
RL
2508 if (!err)
2509 err = register_die_notifier(&kprobe_exceptions_nb);
e8386a0c
MH
2510 if (!err)
2511 err = register_module_notifier(&kprobe_module_nb);
2512
ef53d9c5 2513 kprobes_initialized = (err == 0);
802eae7c 2514
8c1c9356
AM
2515 if (!err)
2516 init_test_probes();
1da177e4
LT
2517 return err;
2518}
36dadef2 2519early_initcall(init_kprobes);
1da177e4 2520
c85c9a2c
MH
2521#if defined(CONFIG_OPTPROBES)
2522static int __init init_optprobes(void)
2523{
2524 /*
2525 * Enable kprobe optimization - this kicks the optimizer which
2526 * depends on synchronize_rcu_tasks() and ksoftirqd, that is
2527 * not spawned in early initcall. So delay the optimization.
2528 */
2529 optimize_all_kprobes();
2530
2531 return 0;
2532}
2533subsys_initcall(init_optprobes);
2534#endif
2535
346fd59b 2536#ifdef CONFIG_DEBUG_FS
55479f64 2537static void report_probe(struct seq_file *pi, struct kprobe *p,
afd66255 2538 const char *sym, int offset, char *modname, struct kprobe *pp)
346fd59b
SD
2539{
2540 char *kprobe_type;
81365a94 2541 void *addr = p->addr;
346fd59b
SD
2542
2543 if (p->pre_handler == pre_handler_kretprobe)
2544 kprobe_type = "r";
346fd59b
SD
2545 else
2546 kprobe_type = "k";
afd66255 2547
60f7bb66 2548 if (!kallsyms_show_value(pi->file->f_cred))
81365a94
MH
2549 addr = NULL;
2550
346fd59b 2551 if (sym)
81365a94
MH
2552 seq_printf(pi, "%px %s %s+0x%x %s ",
2553 addr, kprobe_type, sym, offset,
afd66255 2554 (modname ? modname : " "));
81365a94
MH
2555 else /* try to use %pS */
2556 seq_printf(pi, "%px %s %pS ",
2557 addr, kprobe_type, p->addr);
afd66255
MH
2558
2559 if (!pp)
2560 pp = p;
ae6aa16f 2561 seq_printf(pi, "%s%s%s%s\n",
afd66255
MH
2562 (kprobe_gone(p) ? "[GONE]" : ""),
2563 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
ae6aa16f
MH
2564 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2565 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
346fd59b
SD
2566}
2567
55479f64 2568static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
346fd59b
SD
2569{
2570 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2571}
2572
55479f64 2573static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
346fd59b
SD
2574{
2575 (*pos)++;
2576 if (*pos >= KPROBE_TABLE_SIZE)
2577 return NULL;
2578 return pos;
2579}
2580
55479f64 2581static void kprobe_seq_stop(struct seq_file *f, void *v)
346fd59b
SD
2582{
2583 /* Nothing to do */
2584}
2585
55479f64 2586static int show_kprobe_addr(struct seq_file *pi, void *v)
346fd59b
SD
2587{
2588 struct hlist_head *head;
346fd59b
SD
2589 struct kprobe *p, *kp;
2590 const char *sym = NULL;
2591 unsigned int i = *(loff_t *) v;
ffb45122 2592 unsigned long offset = 0;
ab767865 2593 char *modname, namebuf[KSYM_NAME_LEN];
346fd59b
SD
2594
2595 head = &kprobe_table[i];
2596 preempt_disable();
b67bfe0d 2597 hlist_for_each_entry_rcu(p, head, hlist) {
ffb45122 2598 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
346fd59b 2599 &offset, &modname, namebuf);
afd66255 2600 if (kprobe_aggrprobe(p)) {
346fd59b 2601 list_for_each_entry_rcu(kp, &p->list, list)
afd66255 2602 report_probe(pi, kp, sym, offset, modname, p);
346fd59b 2603 } else
afd66255 2604 report_probe(pi, p, sym, offset, modname, NULL);
346fd59b
SD
2605 }
2606 preempt_enable();
2607 return 0;
2608}
2609
eac2cece 2610static const struct seq_operations kprobes_sops = {
346fd59b
SD
2611 .start = kprobe_seq_start,
2612 .next = kprobe_seq_next,
2613 .stop = kprobe_seq_stop,
2614 .show = show_kprobe_addr
2615};
2616
eac2cece 2617DEFINE_SEQ_ATTRIBUTE(kprobes);
346fd59b 2618
63724740
MH
2619/* kprobes/blacklist -- shows which functions can not be probed */
2620static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2621{
4fdd8887 2622 mutex_lock(&kprobe_mutex);
63724740
MH
2623 return seq_list_start(&kprobe_blacklist, *pos);
2624}
2625
2626static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2627{
2628 return seq_list_next(v, &kprobe_blacklist, pos);
2629}
2630
2631static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2632{
2633 struct kprobe_blacklist_entry *ent =
2634 list_entry(v, struct kprobe_blacklist_entry, list);
2635
ffb9bd68
MH
2636 /*
2637 * If /proc/kallsyms is not showing kernel address, we won't
2638 * show them here either.
2639 */
60f7bb66 2640 if (!kallsyms_show_value(m->file->f_cred))
ffb9bd68
MH
2641 seq_printf(m, "0x%px-0x%px\t%ps\n", NULL, NULL,
2642 (void *)ent->start_addr);
2643 else
2644 seq_printf(m, "0x%px-0x%px\t%ps\n", (void *)ent->start_addr,
2645 (void *)ent->end_addr, (void *)ent->start_addr);
63724740
MH
2646 return 0;
2647}
2648
4fdd8887
MH
2649static void kprobe_blacklist_seq_stop(struct seq_file *f, void *v)
2650{
2651 mutex_unlock(&kprobe_mutex);
2652}
2653
eac2cece 2654static const struct seq_operations kprobe_blacklist_sops = {
63724740
MH
2655 .start = kprobe_blacklist_seq_start,
2656 .next = kprobe_blacklist_seq_next,
4fdd8887 2657 .stop = kprobe_blacklist_seq_stop,
63724740
MH
2658 .show = kprobe_blacklist_seq_show,
2659};
eac2cece 2660DEFINE_SEQ_ATTRIBUTE(kprobe_blacklist);
63724740 2661
12310e34 2662static int arm_all_kprobes(void)
bf8f6e5b
AM
2663{
2664 struct hlist_head *head;
bf8f6e5b 2665 struct kprobe *p;
12310e34
JY
2666 unsigned int i, total = 0, errors = 0;
2667 int err, ret = 0;
bf8f6e5b
AM
2668
2669 mutex_lock(&kprobe_mutex);
2670
e579abeb
MH
2671 /* If kprobes are armed, just return */
2672 if (!kprobes_all_disarmed)
bf8f6e5b
AM
2673 goto already_enabled;
2674
977ad481
WN
2675 /*
2676 * optimize_kprobe() called by arm_kprobe() checks
2677 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2678 * arm_kprobe.
2679 */
2680 kprobes_all_disarmed = false;
afd66255 2681 /* Arming kprobes doesn't optimize kprobe itself */
bf8f6e5b
AM
2682 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2683 head = &kprobe_table[i];
12310e34 2684 /* Arm all kprobes on a best-effort basis */
7e6a71d8 2685 hlist_for_each_entry(p, head, hlist) {
12310e34
JY
2686 if (!kprobe_disabled(p)) {
2687 err = arm_kprobe(p);
2688 if (err) {
2689 errors++;
2690 ret = err;
2691 }
2692 total++;
2693 }
2694 }
bf8f6e5b
AM
2695 }
2696
12310e34
JY
2697 if (errors)
2698 pr_warn("Kprobes globally enabled, but failed to arm %d out of %d probes\n",
2699 errors, total);
2700 else
2701 pr_info("Kprobes globally enabled\n");
bf8f6e5b
AM
2702
2703already_enabled:
2704 mutex_unlock(&kprobe_mutex);
12310e34 2705 return ret;
bf8f6e5b
AM
2706}
2707
297f9233 2708static int disarm_all_kprobes(void)
bf8f6e5b
AM
2709{
2710 struct hlist_head *head;
bf8f6e5b 2711 struct kprobe *p;
297f9233
JY
2712 unsigned int i, total = 0, errors = 0;
2713 int err, ret = 0;
bf8f6e5b
AM
2714
2715 mutex_lock(&kprobe_mutex);
2716
e579abeb 2717 /* If kprobes are already disarmed, just return */
6274de49
MH
2718 if (kprobes_all_disarmed) {
2719 mutex_unlock(&kprobe_mutex);
297f9233 2720 return 0;
6274de49 2721 }
bf8f6e5b 2722
e579abeb 2723 kprobes_all_disarmed = true;
afd66255 2724
bf8f6e5b
AM
2725 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2726 head = &kprobe_table[i];
297f9233 2727 /* Disarm all kprobes on a best-effort basis */
7e6a71d8 2728 hlist_for_each_entry(p, head, hlist) {
297f9233
JY
2729 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p)) {
2730 err = disarm_kprobe(p, false);
2731 if (err) {
2732 errors++;
2733 ret = err;
2734 }
2735 total++;
2736 }
bf8f6e5b
AM
2737 }
2738 }
297f9233
JY
2739
2740 if (errors)
2741 pr_warn("Kprobes globally disabled, but failed to disarm %d out of %d probes\n",
2742 errors, total);
2743 else
2744 pr_info("Kprobes globally disabled\n");
2745
bf8f6e5b 2746 mutex_unlock(&kprobe_mutex);
bf8f6e5b 2747
6274de49
MH
2748 /* Wait for disarming all kprobes by optimizer */
2749 wait_for_kprobe_optimizer();
297f9233
JY
2750
2751 return ret;
bf8f6e5b
AM
2752}
2753
2754/*
2755 * XXX: The debugfs bool file interface doesn't allow for callbacks
2756 * when the bool state is switched. We can reuse that facility when
2757 * available
2758 */
2759static ssize_t read_enabled_file_bool(struct file *file,
2760 char __user *user_buf, size_t count, loff_t *ppos)
2761{
2762 char buf[3];
2763
e579abeb 2764 if (!kprobes_all_disarmed)
bf8f6e5b
AM
2765 buf[0] = '1';
2766 else
2767 buf[0] = '0';
2768 buf[1] = '\n';
2769 buf[2] = 0x00;
2770 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2771}
2772
2773static ssize_t write_enabled_file_bool(struct file *file,
2774 const char __user *user_buf, size_t count, loff_t *ppos)
2775{
2776 char buf[32];
efeb156e 2777 size_t buf_size;
12310e34 2778 int ret = 0;
bf8f6e5b
AM
2779
2780 buf_size = min(count, (sizeof(buf)-1));
2781 if (copy_from_user(buf, user_buf, buf_size))
2782 return -EFAULT;
2783
10fb46d5 2784 buf[buf_size] = '\0';
bf8f6e5b
AM
2785 switch (buf[0]) {
2786 case 'y':
2787 case 'Y':
2788 case '1':
12310e34 2789 ret = arm_all_kprobes();
bf8f6e5b
AM
2790 break;
2791 case 'n':
2792 case 'N':
2793 case '0':
297f9233 2794 ret = disarm_all_kprobes();
bf8f6e5b 2795 break;
10fb46d5
MK
2796 default:
2797 return -EINVAL;
bf8f6e5b
AM
2798 }
2799
12310e34
JY
2800 if (ret)
2801 return ret;
2802
bf8f6e5b
AM
2803 return count;
2804}
2805
828c0950 2806static const struct file_operations fops_kp = {
bf8f6e5b
AM
2807 .read = read_enabled_file_bool,
2808 .write = write_enabled_file_bool,
6038f373 2809 .llseek = default_llseek,
bf8f6e5b
AM
2810};
2811
55479f64 2812static int __init debugfs_kprobe_init(void)
346fd59b 2813{
8c0fd1fa 2814 struct dentry *dir;
346fd59b
SD
2815
2816 dir = debugfs_create_dir("kprobes", NULL);
346fd59b 2817
eac2cece 2818 debugfs_create_file("list", 0400, dir, NULL, &kprobes_fops);
346fd59b 2819
a52fffa5 2820 debugfs_create_file("enabled", 0600, dir, NULL, &fops_kp);
63724740 2821
8c0fd1fa 2822 debugfs_create_file("blacklist", 0400, dir, NULL,
eac2cece 2823 &kprobe_blacklist_fops);
bf8f6e5b 2824
346fd59b
SD
2825 return 0;
2826}
2827
2828late_initcall(debugfs_kprobe_init);
2829#endif /* CONFIG_DEBUG_FS */