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