kprobes: Remove the now superfluous sentinel elements from ctl_table array
[linux-2.6-block.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 },
a737a3c6
XN
971};
972
973static void __init kprobe_sysctls_init(void)
974{
975 register_sysctl_init("debug", kprobe_sysctls);
976}
b2be84df
MH
977#endif /* CONFIG_SYSCTL */
978
57d4e317 979/* Put a breakpoint for a probe. */
55479f64 980static void __arm_kprobe(struct kprobe *p)
afd66255 981{
6d8e40a8 982 struct kprobe *_p;
afd66255 983
57d4e317
MH
984 lockdep_assert_held(&text_mutex);
985
223a76b2 986 /* Find the overlapping optimized kprobes. */
c42421e2 987 _p = get_optimized_kprobe(p->addr);
6d8e40a8 988 if (unlikely(_p))
6274de49
MH
989 /* Fallback to unoptimized kprobe */
990 unoptimize_kprobe(_p, true);
afd66255
MH
991
992 arch_arm_kprobe(p);
993 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
994}
995
57d4e317 996/* Remove the breakpoint of a probe. */
55479f64 997static void __disarm_kprobe(struct kprobe *p, bool reopt)
afd66255 998{
6d8e40a8 999 struct kprobe *_p;
afd66255 1000
57d4e317
MH
1001 lockdep_assert_held(&text_mutex);
1002
69d54b91
WN
1003 /* Try to unoptimize */
1004 unoptimize_kprobe(p, kprobes_all_disarmed);
afd66255 1005
6274de49
MH
1006 if (!kprobe_queued(p)) {
1007 arch_disarm_kprobe(p);
223a76b2 1008 /* If another kprobe was blocked, re-optimize it. */
c42421e2 1009 _p = get_optimized_kprobe(p->addr);
6274de49
MH
1010 if (unlikely(_p) && reopt)
1011 optimize_kprobe(_p);
1012 }
223a76b2
MH
1013 /*
1014 * TODO: Since unoptimization and real disarming will be done by
1015 * the worker thread, we can not check whether another probe are
1016 * unoptimized because of this probe here. It should be re-optimized
1017 * by the worker thread.
1018 */
afd66255
MH
1019}
1020
1021#else /* !CONFIG_OPTPROBES */
1022
1023#define optimize_kprobe(p) do {} while (0)
6274de49 1024#define unoptimize_kprobe(p, f) do {} while (0)
afd66255
MH
1025#define kill_optimized_kprobe(p) do {} while (0)
1026#define prepare_optimized_kprobe(p) do {} while (0)
1027#define try_to_optimize_kprobe(p) do {} while (0)
1028#define __arm_kprobe(p) arch_arm_kprobe(p)
6274de49
MH
1029#define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
1030#define kprobe_disarmed(p) kprobe_disabled(p)
1031#define wait_for_kprobe_optimizer() do {} while (0)
afd66255 1032
819319fc 1033static int reuse_unused_kprobe(struct kprobe *ap)
0490cd1f 1034{
819319fc
MH
1035 /*
1036 * If the optimized kprobe is NOT supported, the aggr kprobe is
1037 * released at the same time that the last aggregated kprobe is
1038 * unregistered.
1039 * Thus there should be no chance to reuse unused kprobe.
1040 */
9c89bb8e 1041 WARN_ON_ONCE(1);
819319fc 1042 return -EINVAL;
0490cd1f
MH
1043}
1044
55479f64 1045static void free_aggr_kprobe(struct kprobe *p)
afd66255 1046{
6274de49 1047 arch_remove_kprobe(p);
afd66255
MH
1048 kfree(p);
1049}
1050
55479f64 1051static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
afd66255
MH
1052{
1053 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
1054}
1055#endif /* CONFIG_OPTPROBES */
1056
e7dbfe34 1057#ifdef CONFIG_KPROBES_ON_FTRACE
ae6aa16f 1058static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
0bc11ed5
MH
1059 .func = kprobe_ftrace_handler,
1060 .flags = FTRACE_OPS_FL_SAVE_REGS,
1061};
1062
1063static struct ftrace_ops kprobe_ipmodify_ops __read_mostly = {
e5253896 1064 .func = kprobe_ftrace_handler,
1d70be34 1065 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
ae6aa16f 1066};
0bc11ed5
MH
1067
1068static int kprobe_ipmodify_enabled;
ae6aa16f
MH
1069static int kprobe_ftrace_enabled;
1070
0bc11ed5
MH
1071static int __arm_kprobe_ftrace(struct kprobe *p, struct ftrace_ops *ops,
1072 int *cnt)
ae6aa16f 1073{
ed9492df 1074 int ret;
ae6aa16f 1075
57d4e317
MH
1076 lockdep_assert_held(&kprobe_mutex);
1077
0bc11ed5 1078 ret = ftrace_set_filter_ip(ops, (unsigned long)p->addr, 0, 0);
9c89bb8e 1079 if (WARN_ONCE(ret < 0, "Failed to arm kprobe-ftrace at %pS (error %d)\n", p->addr, ret))
12310e34 1080 return ret;
12310e34 1081
0bc11ed5
MH
1082 if (*cnt == 0) {
1083 ret = register_ftrace_function(ops);
9c89bb8e 1084 if (WARN(ret < 0, "Failed to register kprobe-ftrace (error %d)\n", ret))
12310e34 1085 goto err_ftrace;
ae6aa16f 1086 }
12310e34 1087
0bc11ed5 1088 (*cnt)++;
12310e34
JY
1089 return ret;
1090
1091err_ftrace:
1092 /*
0bc11ed5
MH
1093 * At this point, sinec ops is not registered, we should be sefe from
1094 * registering empty filter.
12310e34 1095 */
0bc11ed5 1096 ftrace_set_filter_ip(ops, (unsigned long)p->addr, 1, 0);
12310e34 1097 return ret;
ae6aa16f
MH
1098}
1099
0bc11ed5
MH
1100static int arm_kprobe_ftrace(struct kprobe *p)
1101{
1102 bool ipmodify = (p->post_handler != NULL);
1103
1104 return __arm_kprobe_ftrace(p,
1105 ipmodify ? &kprobe_ipmodify_ops : &kprobe_ftrace_ops,
1106 ipmodify ? &kprobe_ipmodify_enabled : &kprobe_ftrace_enabled);
1107}
1108
0bc11ed5
MH
1109static int __disarm_kprobe_ftrace(struct kprobe *p, struct ftrace_ops *ops,
1110 int *cnt)
ae6aa16f 1111{
ed9492df 1112 int ret;
ae6aa16f 1113
57d4e317
MH
1114 lockdep_assert_held(&kprobe_mutex);
1115
0bc11ed5
MH
1116 if (*cnt == 1) {
1117 ret = unregister_ftrace_function(ops);
9c89bb8e 1118 if (WARN(ret < 0, "Failed to unregister kprobe-ftrace (error %d)\n", ret))
297f9233 1119 return ret;
ae6aa16f 1120 }
297f9233 1121
0bc11ed5 1122 (*cnt)--;
297f9233 1123
0bc11ed5 1124 ret = ftrace_set_filter_ip(ops, (unsigned long)p->addr, 1, 0);
9c89bb8e 1125 WARN_ONCE(ret < 0, "Failed to disarm kprobe-ftrace at %pS (error %d)\n",
4458515b 1126 p->addr, ret);
297f9233 1127 return ret;
ae6aa16f 1128}
0bc11ed5
MH
1129
1130static int disarm_kprobe_ftrace(struct kprobe *p)
1131{
1132 bool ipmodify = (p->post_handler != NULL);
1133
1134 return __disarm_kprobe_ftrace(p,
1135 ipmodify ? &kprobe_ipmodify_ops : &kprobe_ftrace_ops,
1136 ipmodify ? &kprobe_ipmodify_enabled : &kprobe_ftrace_enabled);
1137}
e7dbfe34 1138#else /* !CONFIG_KPROBES_ON_FTRACE */
10de795a
MS
1139static inline int arm_kprobe_ftrace(struct kprobe *p)
1140{
1141 return -ENODEV;
1142}
1143
1144static inline int disarm_kprobe_ftrace(struct kprobe *p)
1145{
1146 return -ENODEV;
1147}
ae6aa16f
MH
1148#endif
1149
02afb8d6
PA
1150static int prepare_kprobe(struct kprobe *p)
1151{
1152 /* Must ensure p->addr is really on ftrace */
1153 if (kprobe_ftrace(p))
1154 return arch_prepare_kprobe_ftrace(p);
1155
1156 return arch_prepare_kprobe(p);
1157}
1158
12310e34 1159static int arm_kprobe(struct kprobe *kp)
201517a7 1160{
12310e34
JY
1161 if (unlikely(kprobe_ftrace(kp)))
1162 return arm_kprobe_ftrace(kp);
1163
2d1e38f5 1164 cpus_read_lock();
201517a7 1165 mutex_lock(&text_mutex);
afd66255 1166 __arm_kprobe(kp);
201517a7 1167 mutex_unlock(&text_mutex);
2d1e38f5 1168 cpus_read_unlock();
12310e34
JY
1169
1170 return 0;
201517a7
MH
1171}
1172
297f9233 1173static int disarm_kprobe(struct kprobe *kp, bool reopt)
201517a7 1174{
297f9233
JY
1175 if (unlikely(kprobe_ftrace(kp)))
1176 return disarm_kprobe_ftrace(kp);
2d1e38f5
TG
1177
1178 cpus_read_lock();
201517a7 1179 mutex_lock(&text_mutex);
ae6aa16f 1180 __disarm_kprobe(kp, reopt);
201517a7 1181 mutex_unlock(&text_mutex);
2d1e38f5 1182 cpus_read_unlock();
297f9233
JY
1183
1184 return 0;
201517a7
MH
1185}
1186
64f562c6
AM
1187/*
1188 * Aggregate handlers for multiple kprobes support - these handlers
1189 * take care of invoking the individual kprobe handlers on p->list
1190 */
820aede0 1191static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
64f562c6
AM
1192{
1193 struct kprobe *kp;
1194
3516a460 1195 list_for_each_entry_rcu(kp, &p->list, list) {
de5bd88d 1196 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
e6584523 1197 set_kprobe_instance(kp);
8b0914ea
PP
1198 if (kp->pre_handler(kp, regs))
1199 return 1;
64f562c6 1200 }
e6584523 1201 reset_kprobe_instance();
64f562c6
AM
1202 }
1203 return 0;
1204}
820aede0 1205NOKPROBE_SYMBOL(aggr_pre_handler);
64f562c6 1206
820aede0
MH
1207static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1208 unsigned long flags)
64f562c6
AM
1209{
1210 struct kprobe *kp;
1211
3516a460 1212 list_for_each_entry_rcu(kp, &p->list, list) {
de5bd88d 1213 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
e6584523 1214 set_kprobe_instance(kp);
64f562c6 1215 kp->post_handler(kp, regs, flags);
e6584523 1216 reset_kprobe_instance();
64f562c6
AM
1217 }
1218 }
64f562c6 1219}
820aede0 1220NOKPROBE_SYMBOL(aggr_post_handler);
64f562c6 1221
223a76b2 1222/* Walks the list and increments 'nmissed' if 'p' has child probes. */
820aede0 1223void kprobes_inc_nmissed_count(struct kprobe *p)
bf8d5c52
KA
1224{
1225 struct kprobe *kp;
223a76b2 1226
afd66255 1227 if (!kprobe_aggrprobe(p)) {
bf8d5c52
KA
1228 p->nmissed++;
1229 } else {
1230 list_for_each_entry_rcu(kp, &p->list, list)
1231 kp->nmissed++;
1232 }
bf8d5c52 1233}
820aede0 1234NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
bf8d5c52 1235
73f9b911
MH
1236static struct kprobe kprobe_busy = {
1237 .addr = (void *) get_kprobe,
1238};
1239
1240void kprobe_busy_begin(void)
1241{
1242 struct kprobe_ctlblk *kcb;
1243
1244 preempt_disable();
1245 __this_cpu_write(current_kprobe, &kprobe_busy);
1246 kcb = get_kprobe_ctlblk();
1247 kcb->kprobe_status = KPROBE_HIT_ACTIVE;
1248}
1249
1250void kprobe_busy_end(void)
1251{
1252 __this_cpu_write(current_kprobe, NULL);
1253 preempt_enable();
1254}
1255
223a76b2 1256/* Add the new probe to 'ap->list'. */
55479f64 1257static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
8b0914ea 1258{
059053a2 1259 if (p->post_handler)
6274de49 1260 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
afd66255 1261
059053a2 1262 list_add_rcu(&p->list, &ap->list);
b918e5e6
MH
1263 if (p->post_handler && !ap->post_handler)
1264 ap->post_handler = aggr_post_handler;
de5bd88d 1265
8b0914ea
PP
1266 return 0;
1267}
1268
64f562c6 1269/*
223a76b2
MH
1270 * Fill in the required fields of the aggregator kprobe. Replace the
1271 * earlier kprobe in the hlist with the aggregator kprobe.
64f562c6 1272 */
55479f64 1273static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
64f562c6 1274{
223a76b2 1275 /* Copy the insn slot of 'p' to 'ap'. */
8b0914ea 1276 copy_kprobe(p, ap);
a9ad965e 1277 flush_insn_slot(ap);
64f562c6 1278 ap->addr = p->addr;
afd66255 1279 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
64f562c6 1280 ap->pre_handler = aggr_pre_handler;
e8386a0c
MH
1281 /* We don't care the kprobe which has gone. */
1282 if (p->post_handler && !kprobe_gone(p))
36721656 1283 ap->post_handler = aggr_post_handler;
64f562c6
AM
1284
1285 INIT_LIST_HEAD(&ap->list);
afd66255 1286 INIT_HLIST_NODE(&ap->hlist);
64f562c6 1287
afd66255 1288 list_add_rcu(&p->list, &ap->list);
adad0f33 1289 hlist_replace_rcu(&p->hlist, &ap->hlist);
64f562c6
AM
1290}
1291
1292/*
223a76b2 1293 * This registers the second or subsequent kprobe at the same address.
64f562c6 1294 */
55479f64 1295static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
64f562c6
AM
1296{
1297 int ret = 0;
6d8e40a8 1298 struct kprobe *ap = orig_p;
64f562c6 1299
2d1e38f5
TG
1300 cpus_read_lock();
1301
25764288
MH
1302 /* For preparing optimization, jump_label_text_reserved() is called */
1303 jump_label_lock();
25764288
MH
1304 mutex_lock(&text_mutex);
1305
6d8e40a8 1306 if (!kprobe_aggrprobe(orig_p)) {
223a76b2 1307 /* If 'orig_p' is not an 'aggr_kprobe', create new one. */
6d8e40a8 1308 ap = alloc_aggr_kprobe(orig_p);
25764288
MH
1309 if (!ap) {
1310 ret = -ENOMEM;
1311 goto out;
1312 }
6d8e40a8 1313 init_aggr_kprobe(ap, orig_p);
819319fc 1314 } else if (kprobe_unused(ap)) {
0490cd1f 1315 /* This probe is going to die. Rescue it */
819319fc
MH
1316 ret = reuse_unused_kprobe(ap);
1317 if (ret)
1318 goto out;
1319 }
b918e5e6
MH
1320
1321 if (kprobe_gone(ap)) {
e8386a0c
MH
1322 /*
1323 * Attempting to insert new probe at the same location that
1324 * had a probe in the module vaddr area which already
1325 * freed. So, the instruction slot has already been
1326 * released. We need a new slot for the new probe.
1327 */
b918e5e6 1328 ret = arch_prepare_kprobe(ap);
e8386a0c 1329 if (ret)
b918e5e6
MH
1330 /*
1331 * Even if fail to allocate new slot, don't need to
223a76b2
MH
1332 * free the 'ap'. It will be used next time, or
1333 * freed by unregister_kprobe().
b918e5e6 1334 */
25764288 1335 goto out;
de5bd88d 1336
afd66255
MH
1337 /* Prepare optimized instructions if possible. */
1338 prepare_optimized_kprobe(ap);
1339
e8386a0c 1340 /*
de5bd88d
MH
1341 * Clear gone flag to prevent allocating new slot again, and
1342 * set disabled flag because it is not armed yet.
e8386a0c 1343 */
de5bd88d
MH
1344 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1345 | KPROBE_FLAG_DISABLED;
e8386a0c 1346 }
b918e5e6 1347
223a76b2 1348 /* Copy the insn slot of 'p' to 'ap'. */
b918e5e6 1349 copy_kprobe(ap, p);
25764288
MH
1350 ret = add_new_kprobe(ap, p);
1351
1352out:
1353 mutex_unlock(&text_mutex);
25764288 1354 jump_label_unlock();
2d1e38f5 1355 cpus_read_unlock();
25764288
MH
1356
1357 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1358 ap->flags &= ~KPROBE_FLAG_DISABLED;
12310e34 1359 if (!kprobes_all_disarmed) {
25764288 1360 /* Arm the breakpoint again. */
12310e34
JY
1361 ret = arm_kprobe(ap);
1362 if (ret) {
1363 ap->flags |= KPROBE_FLAG_DISABLED;
1364 list_del_rcu(&p->list);
ae8b7ce7 1365 synchronize_rcu();
12310e34
JY
1366 }
1367 }
25764288
MH
1368 }
1369 return ret;
64f562c6
AM
1370}
1371
be8f2743
MH
1372bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1373{
223a76b2 1374 /* The '__kprobes' functions and entry code must not be probed. */
be8f2743
MH
1375 return addr >= (unsigned long)__kprobes_text_start &&
1376 addr < (unsigned long)__kprobes_text_end;
1377}
1378
6143c6fb 1379static bool __within_kprobe_blacklist(unsigned long addr)
d0aaff97 1380{
376e2424 1381 struct kprobe_blacklist_entry *ent;
3d8d996e 1382
be8f2743 1383 if (arch_within_kprobe_blacklist(addr))
376e2424 1384 return true;
3d8d996e 1385 /*
223a76b2
MH
1386 * If 'kprobe_blacklist' is defined, check the address and
1387 * reject any probe registration in the prohibited area.
3d8d996e 1388 */
376e2424
MH
1389 list_for_each_entry(ent, &kprobe_blacklist, list) {
1390 if (addr >= ent->start_addr && addr < ent->end_addr)
1391 return true;
3d8d996e 1392 }
6143c6fb
MH
1393 return false;
1394}
376e2424 1395
6143c6fb
MH
1396bool within_kprobe_blacklist(unsigned long addr)
1397{
1398 char symname[KSYM_NAME_LEN], *p;
1399
1400 if (__within_kprobe_blacklist(addr))
1401 return true;
1402
1403 /* Check if the address is on a suffixed-symbol */
1404 if (!lookup_symbol_name(addr, symname)) {
1405 p = strchr(symname, '.');
1406 if (!p)
1407 return false;
1408 *p = '\0';
1409 addr = (unsigned long)kprobe_lookup_name(symname, 0);
1410 if (addr)
1411 return __within_kprobe_blacklist(addr);
1412 }
376e2424 1413 return false;
d0aaff97
PP
1414}
1415
cc66bb91
PZ
1416/*
1417 * arch_adjust_kprobe_addr - adjust the address
1418 * @addr: symbol base address
1419 * @offset: offset within the symbol
1420 * @on_func_entry: was this @addr+@offset on the function entry
1421 *
1422 * Typically returns @addr + @offset, except for special cases where the
1423 * function might be prefixed by a CFI landing pad, in that case any offset
1424 * inside the landing pad is mapped to the first 'real' instruction of the
1425 * symbol.
1426 *
1427 * Specifically, for things like IBT/BTI, skip the resp. ENDBR/BTI.C
1428 * instruction at +0.
1429 */
1430kprobe_opcode_t *__weak arch_adjust_kprobe_addr(unsigned long addr,
1431 unsigned long offset,
1432 bool *on_func_entry)
1433{
1434 *on_func_entry = !offset;
1435 return (kprobe_opcode_t *)(addr + offset);
1436}
1437
b2a5cd69 1438/*
223a76b2 1439 * If 'symbol_name' is specified, look it up and add the 'offset'
b2a5cd69 1440 * to it. This way, we can specify a relative address to a symbol.
bc81d48d
MH
1441 * This returns encoded errors if it fails to look up symbol or invalid
1442 * combination of parameters.
b2a5cd69 1443 */
cc66bb91
PZ
1444static kprobe_opcode_t *
1445_kprobe_addr(kprobe_opcode_t *addr, const char *symbol_name,
1446 unsigned long offset, bool *on_func_entry)
b2a5cd69 1447{
1d585e70 1448 if ((symbol_name && addr) || (!symbol_name && !addr))
bc81d48d
MH
1449 goto invalid;
1450
1d585e70 1451 if (symbol_name) {
cc66bb91
PZ
1452 /*
1453 * Input: @sym + @offset
1454 * Output: @addr + @offset
1455 *
1456 * NOTE: kprobe_lookup_name() does *NOT* fold the offset
1457 * argument into it's output!
1458 */
7246f600 1459 addr = kprobe_lookup_name(symbol_name, offset);
bc81d48d
MH
1460 if (!addr)
1461 return ERR_PTR(-ENOENT);
b2a5cd69
MH
1462 }
1463
cc66bb91
PZ
1464 /*
1465 * So here we have @addr + @offset, displace it into a new
1466 * @addr' + @offset' where @addr' is the symbol start address.
1467 */
1468 addr = (void *)addr + offset;
1469 if (!kallsyms_lookup_size_offset((unsigned long)addr, NULL, &offset))
1470 return ERR_PTR(-ENOENT);
1471 addr = (void *)addr - offset;
1472
1473 /*
1474 * Then ask the architecture to re-combine them, taking care of
1475 * magical function entry details while telling us if this was indeed
1476 * at the start of the function.
1477 */
1478 addr = arch_adjust_kprobe_addr((unsigned long)addr, offset, on_func_entry);
bc81d48d
MH
1479 if (addr)
1480 return addr;
1481
1482invalid:
1483 return ERR_PTR(-EINVAL);
b2a5cd69
MH
1484}
1485
1d585e70
NR
1486static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
1487{
cc66bb91
PZ
1488 bool on_func_entry;
1489 return _kprobe_addr(p->addr, p->symbol_name, p->offset, &on_func_entry);
1d585e70
NR
1490}
1491
223a76b2
MH
1492/*
1493 * Check the 'p' is valid and return the aggregator kprobe
1494 * at the same address.
1495 */
55479f64 1496static struct kprobe *__get_valid_kprobe(struct kprobe *p)
1f0ab409 1497{
6d8e40a8 1498 struct kprobe *ap, *list_p;
1f0ab409 1499
7e6a71d8
MH
1500 lockdep_assert_held(&kprobe_mutex);
1501
6d8e40a8
MH
1502 ap = get_kprobe(p->addr);
1503 if (unlikely(!ap))
1f0ab409
AM
1504 return NULL;
1505
6d8e40a8 1506 if (p != ap) {
7e6a71d8 1507 list_for_each_entry(list_p, &ap->list, list)
1f0ab409
AM
1508 if (list_p == p)
1509 /* kprobe p is a valid probe */
1510 goto valid;
1511 return NULL;
1512 }
1513valid:
6d8e40a8 1514 return ap;
1f0ab409
AM
1515}
1516
33b1d146
MH
1517/*
1518 * Warn and return error if the kprobe is being re-registered since
1519 * there must be a software bug.
1520 */
1521static inline int warn_kprobe_rereg(struct kprobe *p)
1f0ab409
AM
1522{
1523 int ret = 0;
1f0ab409
AM
1524
1525 mutex_lock(&kprobe_mutex);
33b1d146 1526 if (WARN_ON_ONCE(__get_valid_kprobe(p)))
1f0ab409
AM
1527 ret = -EINVAL;
1528 mutex_unlock(&kprobe_mutex);
6d8e40a8 1529
1f0ab409
AM
1530 return ret;
1531}
1532
4402deae 1533static int check_ftrace_location(struct kprobe *p)
1da177e4 1534{
aebfd125 1535 unsigned long addr = (unsigned long)p->addr;
ae6aa16f 1536
aebfd125 1537 if (ftrace_location(addr) == addr) {
e7dbfe34 1538#ifdef CONFIG_KPROBES_ON_FTRACE
ae6aa16f 1539 p->flags |= KPROBE_FLAG_FTRACE;
e7dbfe34 1540#else /* !CONFIG_KPROBES_ON_FTRACE */
ae6aa16f
MH
1541 return -EINVAL;
1542#endif
1543 }
f7f242ff
HC
1544 return 0;
1545}
1546
de02f2ac
MHG
1547static bool is_cfi_preamble_symbol(unsigned long addr)
1548{
1549 char symbuf[KSYM_NAME_LEN];
1550
1551 if (lookup_symbol_name(addr, symbuf))
1552 return false;
1553
1554 return str_has_prefix("__cfi_", symbuf) ||
1555 str_has_prefix("__pfx_", symbuf);
1556}
1557
f7f242ff
HC
1558static int check_kprobe_address_safe(struct kprobe *p,
1559 struct module **probed_mod)
1560{
1561 int ret;
1f0ab409 1562
4402deae 1563 ret = check_ftrace_location(p);
f7f242ff
HC
1564 if (ret)
1565 return ret;
91bad2f8 1566 jump_label_lock();
de31c3ca 1567 preempt_disable();
f7fa6ef0
MH
1568
1569 /* Ensure it is not in reserved area nor out of text */
28f6c37a
CZ
1570 if (!(core_kernel_text((unsigned long) p->addr) ||
1571 is_module_text_address((unsigned long) p->addr)) ||
1efda38d 1572 in_gate_area_no_mm((unsigned long) p->addr) ||
376e2424 1573 within_kprobe_blacklist((unsigned long) p->addr) ||
e336b402 1574 jump_label_text_reserved(p->addr, p->addr) ||
fa68bd09 1575 static_call_text_reserved(p->addr, p->addr) ||
de02f2ac
MHG
1576 find_bug((unsigned long)p->addr) ||
1577 is_cfi_preamble_symbol((unsigned long)p->addr)) {
f986a499 1578 ret = -EINVAL;
f7fa6ef0 1579 goto out;
f986a499 1580 }
b3e55c72 1581
223a76b2 1582 /* Check if 'p' is probing a module. */
f7fa6ef0
MH
1583 *probed_mod = __module_text_address((unsigned long) p->addr);
1584 if (*probed_mod) {
6f716acd 1585 /*
e8386a0c
MH
1586 * We must hold a refcount of the probed module while updating
1587 * its code to prohibit unexpected unloading.
df019b1d 1588 */
f7fa6ef0
MH
1589 if (unlikely(!try_module_get(*probed_mod))) {
1590 ret = -ENOENT;
1591 goto out;
1592 }
de31c3ca 1593
f24659d9 1594 /*
223a76b2 1595 * If the module freed '.init.text', we couldn't insert
f24659d9
MH
1596 * kprobes in there.
1597 */
f7fa6ef0
MH
1598 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1599 (*probed_mod)->state != MODULE_STATE_COMING) {
1600 module_put(*probed_mod);
1601 *probed_mod = NULL;
1602 ret = -ENOENT;
f24659d9 1603 }
df019b1d 1604 }
f7fa6ef0 1605out:
a189d035 1606 preempt_enable();
de31c3ca 1607 jump_label_unlock();
1da177e4 1608
f7fa6ef0
MH
1609 return ret;
1610}
1611
55479f64 1612int register_kprobe(struct kprobe *p)
f7fa6ef0
MH
1613{
1614 int ret;
1615 struct kprobe *old_p;
1616 struct module *probed_mod;
1617 kprobe_opcode_t *addr;
bf7a87f1 1618 bool on_func_entry;
f7fa6ef0
MH
1619
1620 /* Adjust probe address from symbol */
bf7a87f1 1621 addr = _kprobe_addr(p->addr, p->symbol_name, p->offset, &on_func_entry);
f7fa6ef0
MH
1622 if (IS_ERR(addr))
1623 return PTR_ERR(addr);
1624 p->addr = addr;
1625
33b1d146 1626 ret = warn_kprobe_rereg(p);
f7fa6ef0
MH
1627 if (ret)
1628 return ret;
1629
1630 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1631 p->flags &= KPROBE_FLAG_DISABLED;
3516a460 1632 p->nmissed = 0;
9861668f 1633 INIT_LIST_HEAD(&p->list);
afd66255 1634
f7fa6ef0
MH
1635 ret = check_kprobe_address_safe(p, &probed_mod);
1636 if (ret)
1637 return ret;
1638
1639 mutex_lock(&kprobe_mutex);
afd66255 1640
bf7a87f1
JO
1641 if (on_func_entry)
1642 p->flags |= KPROBE_FLAG_ON_FUNC_ENTRY;
1643
64f562c6
AM
1644 old_p = get_kprobe(p->addr);
1645 if (old_p) {
223a76b2 1646 /* Since this may unoptimize 'old_p', locking 'text_mutex'. */
64f562c6 1647 ret = register_aggr_kprobe(old_p, p);
1da177e4
LT
1648 goto out;
1649 }
1da177e4 1650
2d1e38f5
TG
1651 cpus_read_lock();
1652 /* Prevent text modification */
1653 mutex_lock(&text_mutex);
ae6aa16f 1654 ret = prepare_kprobe(p);
25764288 1655 mutex_unlock(&text_mutex);
2d1e38f5 1656 cpus_read_unlock();
6f716acd 1657 if (ret)
afd66255 1658 goto out;
49a2a1b8 1659
64f562c6 1660 INIT_HLIST_NODE(&p->hlist);
3516a460 1661 hlist_add_head_rcu(&p->hlist,
1da177e4
LT
1662 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1663
12310e34
JY
1664 if (!kprobes_all_disarmed && !kprobe_disabled(p)) {
1665 ret = arm_kprobe(p);
1666 if (ret) {
1667 hlist_del_rcu(&p->hlist);
ae8b7ce7 1668 synchronize_rcu();
12310e34
JY
1669 goto out;
1670 }
1671 }
afd66255
MH
1672
1673 /* Try to optimize kprobe */
1674 try_to_optimize_kprobe(p);
1da177e4 1675out:
7a7d1cf9 1676 mutex_unlock(&kprobe_mutex);
49a2a1b8 1677
e8386a0c 1678 if (probed_mod)
df019b1d 1679 module_put(probed_mod);
e8386a0c 1680
1da177e4
LT
1681 return ret;
1682}
99081ab5 1683EXPORT_SYMBOL_GPL(register_kprobe);
1da177e4 1684
223a76b2 1685/* Check if all probes on the 'ap' are disabled. */
29e8077a 1686static bool aggr_kprobe_disabled(struct kprobe *ap)
6f0f1dd7
MH
1687{
1688 struct kprobe *kp;
1689
7e6a71d8
MH
1690 lockdep_assert_held(&kprobe_mutex);
1691
1692 list_for_each_entry(kp, &ap->list, list)
6f0f1dd7
MH
1693 if (!kprobe_disabled(kp))
1694 /*
223a76b2
MH
1695 * Since there is an active probe on the list,
1696 * we can't disable this 'ap'.
6f0f1dd7 1697 */
29e8077a 1698 return false;
6f0f1dd7 1699
29e8077a 1700 return true;
6f0f1dd7
MH
1701}
1702
55479f64 1703static struct kprobe *__disable_kprobe(struct kprobe *p)
6f0f1dd7
MH
1704{
1705 struct kprobe *orig_p;
297f9233 1706 int ret;
6f0f1dd7 1707
57d4e317
MH
1708 lockdep_assert_held(&kprobe_mutex);
1709
6f0f1dd7
MH
1710 /* Get an original kprobe for return */
1711 orig_p = __get_valid_kprobe(p);
1712 if (unlikely(orig_p == NULL))
297f9233 1713 return ERR_PTR(-EINVAL);
6f0f1dd7
MH
1714
1715 if (!kprobe_disabled(p)) {
1716 /* Disable probe if it is a child probe */
1717 if (p != orig_p)
1718 p->flags |= KPROBE_FLAG_DISABLED;
1719
1720 /* Try to disarm and disable this/parent probe */
1721 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
69d54b91 1722 /*
9c80e799
KI
1723 * Don't be lazy here. Even if 'kprobes_all_disarmed'
1724 * is false, 'orig_p' might not have been armed yet.
1725 * Note arm_all_kprobes() __tries__ to arm all kprobes
1726 * on the best effort basis.
69d54b91 1727 */
9c80e799 1728 if (!kprobes_all_disarmed && !kprobe_disabled(orig_p)) {
297f9233
JY
1729 ret = disarm_kprobe(orig_p, true);
1730 if (ret) {
1731 p->flags &= ~KPROBE_FLAG_DISABLED;
1732 return ERR_PTR(ret);
1733 }
1734 }
6f0f1dd7
MH
1735 orig_p->flags |= KPROBE_FLAG_DISABLED;
1736 }
1737 }
1738
1739 return orig_p;
1740}
1741
de5bd88d
MH
1742/*
1743 * Unregister a kprobe without a scheduler synchronization.
1744 */
55479f64 1745static int __unregister_kprobe_top(struct kprobe *p)
de5bd88d 1746{
6d8e40a8 1747 struct kprobe *ap, *list_p;
de5bd88d 1748
6f0f1dd7
MH
1749 /* Disable kprobe. This will disarm it if needed. */
1750 ap = __disable_kprobe(p);
297f9233
JY
1751 if (IS_ERR(ap))
1752 return PTR_ERR(ap);
de5bd88d 1753
6f0f1dd7 1754 if (ap == p)
bf8f6e5b 1755 /*
6f0f1dd7
MH
1756 * This probe is an independent(and non-optimized) kprobe
1757 * (not an aggrprobe). Remove from the hash list.
bf8f6e5b 1758 */
6f0f1dd7
MH
1759 goto disarmed;
1760
1761 /* Following process expects this probe is an aggrprobe */
1762 WARN_ON(!kprobe_aggrprobe(ap));
1763
6274de49
MH
1764 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1765 /*
1766 * !disarmed could be happen if the probe is under delayed
1767 * unoptimizing.
1768 */
6f0f1dd7
MH
1769 goto disarmed;
1770 else {
1771 /* If disabling probe has special handlers, update aggrprobe */
e8386a0c 1772 if (p->post_handler && !kprobe_gone(p)) {
7e6a71d8 1773 list_for_each_entry(list_p, &ap->list, list) {
9861668f
MH
1774 if ((list_p != p) && (list_p->post_handler))
1775 goto noclean;
1776 }
5dd7caf0
LH
1777 /*
1778 * For the kprobe-on-ftrace case, we keep the
1779 * post_handler setting to identify this aggrprobe
1780 * armed with kprobe_ipmodify_ops.
1781 */
1782 if (!kprobe_ftrace(ap))
1783 ap->post_handler = NULL;
9861668f
MH
1784 }
1785noclean:
6f0f1dd7
MH
1786 /*
1787 * Remove from the aggrprobe: this path will do nothing in
1788 * __unregister_kprobe_bottom().
1789 */
49a2a1b8 1790 list_del_rcu(&p->list);
6f0f1dd7
MH
1791 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1792 /*
1793 * Try to optimize this probe again, because post
1794 * handler may have been changed.
1795 */
1796 optimize_kprobe(ap);
49a2a1b8 1797 }
9861668f 1798 return 0;
6f0f1dd7
MH
1799
1800disarmed:
1801 hlist_del_rcu(&ap->hlist);
1802 return 0;
9861668f 1803}
3516a460 1804
55479f64 1805static void __unregister_kprobe_bottom(struct kprobe *p)
9861668f 1806{
6d8e40a8 1807 struct kprobe *ap;
b3e55c72 1808
e8386a0c 1809 if (list_empty(&p->list))
6274de49 1810 /* This is an independent kprobe */
0498b635 1811 arch_remove_kprobe(p);
e8386a0c 1812 else if (list_is_singular(&p->list)) {
6274de49 1813 /* This is the last child of an aggrprobe */
6d8e40a8 1814 ap = list_entry(p->list.next, struct kprobe, list);
e8386a0c 1815 list_del(&p->list);
6d8e40a8 1816 free_aggr_kprobe(ap);
9861668f 1817 }
6274de49 1818 /* Otherwise, do nothing. */
9861668f
MH
1819}
1820
55479f64 1821int register_kprobes(struct kprobe **kps, int num)
9861668f
MH
1822{
1823 int i, ret = 0;
1824
1825 if (num <= 0)
1826 return -EINVAL;
1827 for (i = 0; i < num; i++) {
49ad2fd7 1828 ret = register_kprobe(kps[i]);
67dddaad
MH
1829 if (ret < 0) {
1830 if (i > 0)
1831 unregister_kprobes(kps, i);
9861668f 1832 break;
36721656 1833 }
49a2a1b8 1834 }
9861668f
MH
1835 return ret;
1836}
99081ab5 1837EXPORT_SYMBOL_GPL(register_kprobes);
9861668f 1838
55479f64 1839void unregister_kprobe(struct kprobe *p)
9861668f
MH
1840{
1841 unregister_kprobes(&p, 1);
1842}
99081ab5 1843EXPORT_SYMBOL_GPL(unregister_kprobe);
9861668f 1844
55479f64 1845void unregister_kprobes(struct kprobe **kps, int num)
9861668f
MH
1846{
1847 int i;
1848
1849 if (num <= 0)
1850 return;
1851 mutex_lock(&kprobe_mutex);
1852 for (i = 0; i < num; i++)
1853 if (__unregister_kprobe_top(kps[i]) < 0)
1854 kps[i]->addr = NULL;
1855 mutex_unlock(&kprobe_mutex);
1856
ae8b7ce7 1857 synchronize_rcu();
9861668f
MH
1858 for (i = 0; i < num; i++)
1859 if (kps[i]->addr)
1860 __unregister_kprobe_bottom(kps[i]);
1da177e4 1861}
99081ab5 1862EXPORT_SYMBOL_GPL(unregister_kprobes);
1da177e4 1863
5f6bee34
NR
1864int __weak kprobe_exceptions_notify(struct notifier_block *self,
1865 unsigned long val, void *data)
fc62d020
NR
1866{
1867 return NOTIFY_DONE;
1868}
5f6bee34 1869NOKPROBE_SYMBOL(kprobe_exceptions_notify);
fc62d020 1870
1da177e4 1871static struct notifier_block kprobe_exceptions_nb = {
3d5631e0
AK
1872 .notifier_call = kprobe_exceptions_notify,
1873 .priority = 0x7fffffff /* we need to be notified first */
1874};
1875
9edddaa2 1876#ifdef CONFIG_KRETPROBES
66ada2cc 1877
73f9b911 1878#if !defined(CONFIG_KRETPROBE_ON_RETHOOK)
4bbd9345 1879
1880/* callbacks for objpool of kretprobe instances */
1881static int kretprobe_init_inst(void *nod, void *context)
1882{
1883 struct kretprobe_instance *ri = nod;
1884
1885 ri->rph = context;
1886 return 0;
1887}
1888static int kretprobe_fini_pool(struct objpool_head *head, void *context)
1889{
1890 kfree(context);
1891 return 0;
1892}
1893
43994049
MH
1894static void free_rp_inst_rcu(struct rcu_head *head)
1895{
1896 struct kretprobe_instance *ri = container_of(head, struct kretprobe_instance, rcu);
4bbd9345 1897 struct kretprobe_holder *rph = ri->rph;
43994049 1898
4bbd9345 1899 objpool_drop(ri, &rph->pool);
43994049
MH
1900}
1901NOKPROBE_SYMBOL(free_rp_inst_rcu);
1902
1903static void recycle_rp_inst(struct kretprobe_instance *ri)
1904{
1905 struct kretprobe *rp = get_kretprobe(ri);
1906
1907 if (likely(rp))
4bbd9345 1908 objpool_push(ri, &rp->rph->pool);
43994049
MH
1909 else
1910 call_rcu(&ri->rcu, free_rp_inst_rcu);
1911}
1912NOKPROBE_SYMBOL(recycle_rp_inst);
1913
1914/*
1915 * This function is called from delayed_put_task_struct() when a task is
1916 * dead and cleaned up to recycle any kretprobe instances associated with
1917 * this task. These left over instances represent probed functions that
1918 * have been called but will never return.
1919 */
1920void kprobe_flush_task(struct task_struct *tk)
1921{
1922 struct kretprobe_instance *ri;
1923 struct llist_node *node;
1924
1925 /* Early boot, not yet initialized. */
1926 if (unlikely(!kprobes_initialized))
1927 return;
1928
1929 kprobe_busy_begin();
1930
1931 node = __llist_del_all(&tk->kretprobe_instances);
1932 while (node) {
1933 ri = container_of(node, struct kretprobe_instance, llist);
1934 node = node->next;
1935
1936 recycle_rp_inst(ri);
1937 }
1938
1939 kprobe_busy_end();
1940}
1941NOKPROBE_SYMBOL(kprobe_flush_task);
1942
1943static inline void free_rp_inst(struct kretprobe *rp)
1944{
4bbd9345 1945 struct kretprobe_holder *rph = rp->rph;
43994049 1946
4bbd9345 1947 if (!rph)
1948 return;
1949 rp->rph = NULL;
1950 objpool_fini(&rph->pool);
43994049
MH
1951}
1952
03bac0df
MH
1953/* This assumes the 'tsk' is the current task or the is not running. */
1954static kprobe_opcode_t *__kretprobe_find_ret_addr(struct task_struct *tsk,
1955 struct llist_node **cur)
3d7e3382 1956{
d741bf41 1957 struct kretprobe_instance *ri = NULL;
03bac0df
MH
1958 struct llist_node *node = *cur;
1959
1960 if (!node)
1961 node = tsk->kretprobe_instances.first;
1962 else
1963 node = node->next;
66ada2cc 1964
d741bf41
PZ
1965 while (node) {
1966 ri = container_of(node, struct kretprobe_instance, llist);
96fed8ac 1967 if (ri->ret_addr != kretprobe_trampoline_addr()) {
03bac0df
MH
1968 *cur = node;
1969 return ri->ret_addr;
d741bf41 1970 }
d741bf41 1971 node = node->next;
66ada2cc 1972 }
03bac0df 1973 return NULL;
3d7e3382 1974}
03bac0df 1975NOKPROBE_SYMBOL(__kretprobe_find_ret_addr);
1da177e4 1976
03bac0df
MH
1977/**
1978 * kretprobe_find_ret_addr -- Find correct return address modified by kretprobe
1979 * @tsk: Target task
1980 * @fp: A frame pointer
1981 * @cur: a storage of the loop cursor llist_node pointer for next call
1982 *
1983 * Find the correct return address modified by a kretprobe on @tsk in unsigned
1984 * long type. If it finds the return address, this returns that address value,
1985 * or this returns 0.
1986 * The @tsk must be 'current' or a task which is not running. @fp is a hint
1987 * to get the currect return address - which is compared with the
1988 * kretprobe_instance::fp field. The @cur is a loop cursor for searching the
1989 * kretprobe return addresses on the @tsk. The '*@cur' should be NULL at the
1990 * first call, but '@cur' itself must NOT NULL.
1991 */
1992unsigned long kretprobe_find_ret_addr(struct task_struct *tsk, void *fp,
1993 struct llist_node **cur)
1994{
9efd24ec 1995 struct kretprobe_instance *ri;
03bac0df
MH
1996 kprobe_opcode_t *ret;
1997
1998 if (WARN_ON_ONCE(!cur))
1999 return 0;
66ada2cc 2000
03bac0df
MH
2001 do {
2002 ret = __kretprobe_find_ret_addr(tsk, cur);
2003 if (!ret)
2004 break;
2005 ri = container_of(*cur, struct kretprobe_instance, llist);
2006 } while (ri->fp != fp);
2007
2008 return (unsigned long)ret;
2009}
2010NOKPROBE_SYMBOL(kretprobe_find_ret_addr);
2011
bf094cff
MH
2012void __weak arch_kretprobe_fixup_return(struct pt_regs *regs,
2013 kprobe_opcode_t *correct_ret_addr)
2014{
2015 /*
2016 * Do nothing by default. Please fill this to update the fake return
2017 * address on the stack with the correct one on each arch if possible.
2018 */
2019}
66ada2cc
MH
2020
2021unsigned long __kretprobe_trampoline_handler(struct pt_regs *regs,
66ada2cc
MH
2022 void *frame_pointer)
2023{
d741bf41 2024 struct kretprobe_instance *ri = NULL;
03bac0df 2025 struct llist_node *first, *node = NULL;
e1164787 2026 kprobe_opcode_t *correct_ret_addr;
d741bf41 2027 struct kretprobe *rp;
66ada2cc 2028
03bac0df
MH
2029 /* Find correct address and all nodes for this frame. */
2030 correct_ret_addr = __kretprobe_find_ret_addr(current, &node);
2031 if (!correct_ret_addr) {
2032 pr_err("kretprobe: Return address not found, not execute handler. Maybe there is a bug in the kernel.\n");
2033 BUG_ON(1);
66ada2cc
MH
2034 }
2035
df91c5bc
MH
2036 /*
2037 * Set the return address as the instruction pointer, because if the
2038 * user handler calls stack_trace_save_regs() with this 'regs',
2039 * the stack trace will start from the instruction pointer.
2040 */
2041 instruction_pointer_set(regs, (unsigned long)correct_ret_addr);
66ada2cc 2042
03bac0df
MH
2043 /* Run the user handler of the nodes. */
2044 first = current->kretprobe_instances.first;
d741bf41
PZ
2045 while (first) {
2046 ri = container_of(first, struct kretprobe_instance, llist);
03bac0df
MH
2047
2048 if (WARN_ON_ONCE(ri->fp != frame_pointer))
2049 break;
66ada2cc 2050
d741bf41
PZ
2051 rp = get_kretprobe(ri);
2052 if (rp && rp->handler) {
66ada2cc
MH
2053 struct kprobe *prev = kprobe_running();
2054
d741bf41 2055 __this_cpu_write(current_kprobe, &rp->kp);
66ada2cc 2056 ri->ret_addr = correct_ret_addr;
d741bf41 2057 rp->handler(ri, regs);
66ada2cc
MH
2058 __this_cpu_write(current_kprobe, prev);
2059 }
03bac0df
MH
2060 if (first == node)
2061 break;
2062
2063 first = first->next;
2064 }
2065
bf094cff
MH
2066 arch_kretprobe_fixup_return(regs, correct_ret_addr);
2067
03bac0df
MH
2068 /* Unlink all nodes for this frame. */
2069 first = current->kretprobe_instances.first;
2070 current->kretprobe_instances.first = node->next;
2071 node->next = NULL;
2072
2073 /* Recycle free instances. */
2074 while (first) {
2075 ri = container_of(first, struct kretprobe_instance, llist);
2076 first = first->next;
66ada2cc 2077
b3388178 2078 recycle_rp_inst(ri);
66ada2cc
MH
2079 }
2080
66ada2cc
MH
2081 return (unsigned long)correct_ret_addr;
2082}
2083NOKPROBE_SYMBOL(__kretprobe_trampoline_handler)
2084
e65cefe8
AB
2085/*
2086 * This kprobe pre_handler is registered with every kretprobe. When probe
2087 * hits it will set up the return probe.
2088 */
820aede0 2089static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
e65cefe8
AB
2090{
2091 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
4bbd9345 2092 struct kretprobe_holder *rph = rp->rph;
ef53d9c5 2093 struct kretprobe_instance *ri;
e65cefe8 2094
4bbd9345 2095 ri = objpool_pop(&rph->pool);
2096 if (!ri) {
6e426e0f
PZ
2097 rp->nmissed++;
2098 return 0;
2099 }
4c4308cb 2100
6e426e0f 2101 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
4bbd9345 2102 objpool_push(ri, &rph->pool);
6e426e0f 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 2196 int i;
b2a5cd69 2197 void *addr;
90ec5e89 2198
97c753e6
MH
2199 ret = kprobe_on_func_entry(rp->kp.addr, rp->kp.symbol_name, rp->kp.offset);
2200 if (ret)
2201 return ret;
f438d914 2202
223a76b2 2203 /* If only 'rp->kp.addr' is specified, check reregistering kprobes */
33b1d146 2204 if (rp->kp.addr && warn_kprobe_rereg(&rp->kp))
0188b878
WS
2205 return -EINVAL;
2206
f438d914 2207 if (kretprobe_blacklist_size) {
b2a5cd69 2208 addr = kprobe_addr(&rp->kp);
bc81d48d
MH
2209 if (IS_ERR(addr))
2210 return PTR_ERR(addr);
f438d914
MH
2211
2212 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
2213 if (kretprobe_blacklist[i].addr == addr)
2214 return -EINVAL;
2215 }
2216 }
b94cce92 2217
6bbfa441
MH
2218 if (rp->data_size > KRETPROBE_MAX_DATA_SIZE)
2219 return -E2BIG;
2220
b94cce92 2221 rp->kp.pre_handler = pre_handler_kretprobe;
7522a842 2222 rp->kp.post_handler = NULL;
b94cce92
HN
2223
2224 /* Pre-allocate memory for max kretprobe instances */
3b7ddab8 2225 if (rp->maxactive <= 0)
c2ef6661 2226 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
3b7ddab8 2227
73f9b911 2228#ifdef CONFIG_KRETPROBE_ON_RETHOOK
4bbd9345 2229 rp->rh = rethook_alloc((void *)rp, kretprobe_rethook_handler,
2230 sizeof(struct kretprobe_instance) +
2231 rp->data_size, rp->maxactive);
2232 if (IS_ERR(rp->rh))
2233 return PTR_ERR(rp->rh);
73f9b911 2234
73f9b911
MH
2235 rp->nmissed = 0;
2236 /* Establish function entry probe point */
2237 ret = register_kprobe(&rp->kp);
2238 if (ret != 0) {
2239 rethook_free(rp->rh);
2240 rp->rh = NULL;
2241 }
2242#else /* !CONFIG_KRETPROBE_ON_RETHOOK */
d741bf41
PZ
2243 rp->rph = kzalloc(sizeof(struct kretprobe_holder), GFP_KERNEL);
2244 if (!rp->rph)
2245 return -ENOMEM;
2246
4bbd9345 2247 if (objpool_init(&rp->rph->pool, rp->maxactive, rp->data_size +
2248 sizeof(struct kretprobe_instance), GFP_KERNEL,
2249 rp->rph, kretprobe_init_inst, kretprobe_fini_pool)) {
2250 kfree(rp->rph);
2251 rp->rph = NULL;
2252 return -ENOMEM;
b94cce92 2253 }
d839a656 2254 rcu_assign_pointer(rp->rph->rp, rp);
b94cce92
HN
2255 rp->nmissed = 0;
2256 /* Establish function entry probe point */
49ad2fd7 2257 ret = register_kprobe(&rp->kp);
4a296e07 2258 if (ret != 0)
b94cce92 2259 free_rp_inst(rp);
73f9b911 2260#endif
b94cce92
HN
2261 return ret;
2262}
99081ab5 2263EXPORT_SYMBOL_GPL(register_kretprobe);
b94cce92 2264
55479f64 2265int register_kretprobes(struct kretprobe **rps, int num)
4a296e07
MH
2266{
2267 int ret = 0, i;
2268
2269 if (num <= 0)
2270 return -EINVAL;
2271 for (i = 0; i < num; i++) {
49ad2fd7 2272 ret = register_kretprobe(rps[i]);
67dddaad
MH
2273 if (ret < 0) {
2274 if (i > 0)
2275 unregister_kretprobes(rps, i);
4a296e07
MH
2276 break;
2277 }
2278 }
2279 return ret;
2280}
99081ab5 2281EXPORT_SYMBOL_GPL(register_kretprobes);
4a296e07 2282
55479f64 2283void unregister_kretprobe(struct kretprobe *rp)
4a296e07
MH
2284{
2285 unregister_kretprobes(&rp, 1);
2286}
99081ab5 2287EXPORT_SYMBOL_GPL(unregister_kretprobe);
4a296e07 2288
55479f64 2289void unregister_kretprobes(struct kretprobe **rps, int num)
4a296e07
MH
2290{
2291 int i;
2292
2293 if (num <= 0)
2294 return;
2295 mutex_lock(&kprobe_mutex);
d741bf41 2296 for (i = 0; i < num; i++) {
4a296e07
MH
2297 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
2298 rps[i]->kp.addr = NULL;
73f9b911
MH
2299#ifdef CONFIG_KRETPROBE_ON_RETHOOK
2300 rethook_free(rps[i]->rh);
2301#else
d839a656 2302 rcu_assign_pointer(rps[i]->rph->rp, NULL);
73f9b911 2303#endif
d741bf41 2304 }
4a296e07
MH
2305 mutex_unlock(&kprobe_mutex);
2306
ae8b7ce7 2307 synchronize_rcu();
4a296e07
MH
2308 for (i = 0; i < num; i++) {
2309 if (rps[i]->kp.addr) {
2310 __unregister_kprobe_bottom(&rps[i]->kp);
73f9b911 2311#ifndef CONFIG_KRETPROBE_ON_RETHOOK
d741bf41 2312 free_rp_inst(rps[i]);
73f9b911 2313#endif
4a296e07
MH
2314 }
2315 }
2316}
99081ab5 2317EXPORT_SYMBOL_GPL(unregister_kretprobes);
4a296e07 2318
9edddaa2 2319#else /* CONFIG_KRETPROBES */
55479f64 2320int register_kretprobe(struct kretprobe *rp)
b94cce92 2321{
223a76b2 2322 return -EOPNOTSUPP;
b94cce92 2323}
99081ab5 2324EXPORT_SYMBOL_GPL(register_kretprobe);
b94cce92 2325
55479f64 2326int register_kretprobes(struct kretprobe **rps, int num)
346fd59b 2327{
223a76b2 2328 return -EOPNOTSUPP;
346fd59b 2329}
99081ab5
MH
2330EXPORT_SYMBOL_GPL(register_kretprobes);
2331
55479f64 2332void unregister_kretprobe(struct kretprobe *rp)
b94cce92 2333{
4a296e07 2334}
99081ab5 2335EXPORT_SYMBOL_GPL(unregister_kretprobe);
b94cce92 2336
55479f64 2337void unregister_kretprobes(struct kretprobe **rps, int num)
4a296e07
MH
2338{
2339}
99081ab5 2340EXPORT_SYMBOL_GPL(unregister_kretprobes);
4c4308cb 2341
820aede0 2342static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
4a296e07
MH
2343{
2344 return 0;
b94cce92 2345}
820aede0 2346NOKPROBE_SYMBOL(pre_handler_kretprobe);
b94cce92 2347
4a296e07
MH
2348#endif /* CONFIG_KRETPROBES */
2349
e8386a0c 2350/* Set the kprobe gone and remove its instruction buffer. */
55479f64 2351static void kill_kprobe(struct kprobe *p)
e8386a0c
MH
2352{
2353 struct kprobe *kp;
de5bd88d 2354
7e6a71d8
MH
2355 lockdep_assert_held(&kprobe_mutex);
2356
0c76ef3f
LH
2357 /*
2358 * The module is going away. We should disarm the kprobe which
2359 * is using ftrace, because ftrace framework is still available at
2360 * 'MODULE_STATE_GOING' notification.
2361 */
2362 if (kprobe_ftrace(p) && !kprobe_disabled(p) && !kprobes_all_disarmed)
2363 disarm_kprobe_ftrace(p);
2364
e8386a0c 2365 p->flags |= KPROBE_FLAG_GONE;
afd66255 2366 if (kprobe_aggrprobe(p)) {
e8386a0c
MH
2367 /*
2368 * If this is an aggr_kprobe, we have to list all the
2369 * chained probes and mark them GONE.
2370 */
7e6a71d8 2371 list_for_each_entry(kp, &p->list, list)
e8386a0c
MH
2372 kp->flags |= KPROBE_FLAG_GONE;
2373 p->post_handler = NULL;
afd66255 2374 kill_optimized_kprobe(p);
e8386a0c
MH
2375 }
2376 /*
2377 * Here, we can remove insn_slot safely, because no thread calls
2378 * the original probed function (which will be freed soon) any more.
2379 */
2380 arch_remove_kprobe(p);
2381}
2382
c0614829 2383/* Disable one kprobe */
55479f64 2384int disable_kprobe(struct kprobe *kp)
c0614829
MH
2385{
2386 int ret = 0;
297f9233 2387 struct kprobe *p;
c0614829
MH
2388
2389 mutex_lock(&kprobe_mutex);
2390
6f0f1dd7 2391 /* Disable this kprobe */
297f9233
JY
2392 p = __disable_kprobe(kp);
2393 if (IS_ERR(p))
2394 ret = PTR_ERR(p);
c0614829 2395
c0614829
MH
2396 mutex_unlock(&kprobe_mutex);
2397 return ret;
2398}
2399EXPORT_SYMBOL_GPL(disable_kprobe);
2400
2401/* Enable one kprobe */
55479f64 2402int enable_kprobe(struct kprobe *kp)
c0614829
MH
2403{
2404 int ret = 0;
2405 struct kprobe *p;
2406
2407 mutex_lock(&kprobe_mutex);
2408
2409 /* Check whether specified probe is valid. */
2410 p = __get_valid_kprobe(kp);
2411 if (unlikely(p == NULL)) {
2412 ret = -EINVAL;
2413 goto out;
2414 }
2415
2416 if (kprobe_gone(kp)) {
2417 /* This kprobe has gone, we couldn't enable it. */
2418 ret = -EINVAL;
2419 goto out;
2420 }
2421
2422 if (p != kp)
2423 kp->flags &= ~KPROBE_FLAG_DISABLED;
2424
2425 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2426 p->flags &= ~KPROBE_FLAG_DISABLED;
12310e34 2427 ret = arm_kprobe(p);
4a6f316d 2428 if (ret) {
12310e34 2429 p->flags |= KPROBE_FLAG_DISABLED;
4a6f316d
LQ
2430 if (p != kp)
2431 kp->flags |= KPROBE_FLAG_DISABLED;
2432 }
c0614829
MH
2433 }
2434out:
2435 mutex_unlock(&kprobe_mutex);
2436 return ret;
2437}
2438EXPORT_SYMBOL_GPL(enable_kprobe);
2439
4458515b 2440/* Caller must NOT call this in usual path. This is only for critical case */
820aede0 2441void dump_kprobe(struct kprobe *kp)
24851d24 2442{
9c89bb8e 2443 pr_err("Dump kprobe:\n.symbol_name = %s, .offset = %x, .addr = %pS\n",
4458515b 2444 kp->symbol_name, kp->offset, kp->addr);
24851d24 2445}
820aede0 2446NOKPROBE_SYMBOL(dump_kprobe);
24851d24 2447
fb1a59fa
MH
2448int kprobe_add_ksym_blacklist(unsigned long entry)
2449{
2450 struct kprobe_blacklist_entry *ent;
2451 unsigned long offset = 0, size = 0;
2452
2453 if (!kernel_text_address(entry) ||
2454 !kallsyms_lookup_size_offset(entry, &size, &offset))
2455 return -EINVAL;
2456
2457 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2458 if (!ent)
2459 return -ENOMEM;
2460 ent->start_addr = entry;
2461 ent->end_addr = entry + size;
2462 INIT_LIST_HEAD(&ent->list);
2463 list_add_tail(&ent->list, &kprobe_blacklist);
2464
2465 return (int)size;
2466}
2467
2468/* Add all symbols in given area into kprobe blacklist */
2469int kprobe_add_area_blacklist(unsigned long start, unsigned long end)
2470{
2471 unsigned long entry;
2472 int ret = 0;
2473
2474 for (entry = start; entry < end; entry += ret) {
2475 ret = kprobe_add_ksym_blacklist(entry);
2476 if (ret < 0)
2477 return ret;
2478 if (ret == 0) /* In case of alias symbol */
2479 ret = 1;
2480 }
2481 return 0;
2482}
2483
1e6769b0
MH
2484/* Remove all symbols in given area from kprobe blacklist */
2485static void kprobe_remove_area_blacklist(unsigned long start, unsigned long end)
2486{
2487 struct kprobe_blacklist_entry *ent, *n;
2488
2489 list_for_each_entry_safe(ent, n, &kprobe_blacklist, list) {
2490 if (ent->start_addr < start || ent->start_addr >= end)
2491 continue;
2492 list_del(&ent->list);
2493 kfree(ent);
2494 }
2495}
2496
16db6264
MH
2497static void kprobe_remove_ksym_blacklist(unsigned long entry)
2498{
2499 kprobe_remove_area_blacklist(entry, entry + 1);
2500}
2501
d002b8bc
AH
2502int __weak arch_kprobe_get_kallsym(unsigned int *symnum, unsigned long *value,
2503 char *type, char *sym)
2504{
2505 return -ERANGE;
2506}
2507
2508int kprobe_get_kallsym(unsigned int symnum, unsigned long *value, char *type,
2509 char *sym)
2510{
2511#ifdef __ARCH_WANT_KPROBES_INSN_SLOT
2512 if (!kprobe_cache_get_kallsym(&kprobe_insn_slots, &symnum, value, type, sym))
2513 return 0;
2514#ifdef CONFIG_OPTPROBES
2515 if (!kprobe_cache_get_kallsym(&kprobe_optinsn_slots, &symnum, value, type, sym))
2516 return 0;
2517#endif
2518#endif
2519 if (!arch_kprobe_get_kallsym(&symnum, value, type, sym))
2520 return 0;
2521 return -ERANGE;
2522}
2523
fb1a59fa
MH
2524int __init __weak arch_populate_kprobe_blacklist(void)
2525{
2526 return 0;
2527}
2528
376e2424
MH
2529/*
2530 * Lookup and populate the kprobe_blacklist.
2531 *
2532 * Unlike the kretprobe blacklist, we'll need to determine
2533 * the range of addresses that belong to the said functions,
2534 * since a kprobe need not necessarily be at the beginning
2535 * of a function.
2536 */
2537static int __init populate_kprobe_blacklist(unsigned long *start,
2538 unsigned long *end)
2539{
fb1a59fa 2540 unsigned long entry;
376e2424 2541 unsigned long *iter;
fb1a59fa 2542 int ret;
376e2424
MH
2543
2544 for (iter = start; iter < end; iter++) {
f2ec8d9a 2545 entry = (unsigned long)dereference_symbol_descriptor((void *)*iter);
fb1a59fa
MH
2546 ret = kprobe_add_ksym_blacklist(entry);
2547 if (ret == -EINVAL)
376e2424 2548 continue;
fb1a59fa
MH
2549 if (ret < 0)
2550 return ret;
376e2424 2551 }
fb1a59fa 2552
223a76b2 2553 /* Symbols in '__kprobes_text' are blacklisted */
fb1a59fa
MH
2554 ret = kprobe_add_area_blacklist((unsigned long)__kprobes_text_start,
2555 (unsigned long)__kprobes_text_end);
66e9b071
TG
2556 if (ret)
2557 return ret;
2558
223a76b2 2559 /* Symbols in 'noinstr' section are blacklisted */
66e9b071
TG
2560 ret = kprobe_add_area_blacklist((unsigned long)__noinstr_text_start,
2561 (unsigned long)__noinstr_text_end);
fb1a59fa
MH
2562
2563 return ret ? : arch_populate_kprobe_blacklist();
376e2424
MH
2564}
2565
1e6769b0
MH
2566static void add_module_kprobe_blacklist(struct module *mod)
2567{
2568 unsigned long start, end;
16db6264
MH
2569 int i;
2570
2571 if (mod->kprobe_blacklist) {
2572 for (i = 0; i < mod->num_kprobe_blacklist; i++)
2573 kprobe_add_ksym_blacklist(mod->kprobe_blacklist[i]);
2574 }
1e6769b0
MH
2575
2576 start = (unsigned long)mod->kprobes_text_start;
2577 if (start) {
2578 end = start + mod->kprobes_text_size;
2579 kprobe_add_area_blacklist(start, end);
2580 }
66e9b071
TG
2581
2582 start = (unsigned long)mod->noinstr_text_start;
2583 if (start) {
2584 end = start + mod->noinstr_text_size;
2585 kprobe_add_area_blacklist(start, end);
2586 }
1e6769b0
MH
2587}
2588
2589static void remove_module_kprobe_blacklist(struct module *mod)
2590{
2591 unsigned long start, end;
16db6264
MH
2592 int i;
2593
2594 if (mod->kprobe_blacklist) {
2595 for (i = 0; i < mod->num_kprobe_blacklist; i++)
2596 kprobe_remove_ksym_blacklist(mod->kprobe_blacklist[i]);
2597 }
1e6769b0
MH
2598
2599 start = (unsigned long)mod->kprobes_text_start;
2600 if (start) {
2601 end = start + mod->kprobes_text_size;
2602 kprobe_remove_area_blacklist(start, end);
2603 }
66e9b071
TG
2604
2605 start = (unsigned long)mod->noinstr_text_start;
2606 if (start) {
2607 end = start + mod->noinstr_text_size;
2608 kprobe_remove_area_blacklist(start, end);
2609 }
1e6769b0
MH
2610}
2611
e8386a0c 2612/* Module notifier call back, checking kprobes on the module */
55479f64
MH
2613static int kprobes_module_callback(struct notifier_block *nb,
2614 unsigned long val, void *data)
e8386a0c
MH
2615{
2616 struct module *mod = data;
2617 struct hlist_head *head;
e8386a0c
MH
2618 struct kprobe *p;
2619 unsigned int i;
f24659d9 2620 int checkcore = (val == MODULE_STATE_GOING);
e8386a0c 2621
1e6769b0
MH
2622 if (val == MODULE_STATE_COMING) {
2623 mutex_lock(&kprobe_mutex);
2624 add_module_kprobe_blacklist(mod);
2625 mutex_unlock(&kprobe_mutex);
2626 }
f24659d9 2627 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
e8386a0c
MH
2628 return NOTIFY_DONE;
2629
2630 /*
223a76b2
MH
2631 * When 'MODULE_STATE_GOING' was notified, both of module '.text' and
2632 * '.init.text' sections would be freed. When 'MODULE_STATE_LIVE' was
2633 * notified, only '.init.text' section would be freed. We need to
f24659d9 2634 * disable kprobes which have been inserted in the sections.
e8386a0c
MH
2635 */
2636 mutex_lock(&kprobe_mutex);
2637 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2638 head = &kprobe_table[i];
7e6a71d8 2639 hlist_for_each_entry(p, head, hlist)
f24659d9
MH
2640 if (within_module_init((unsigned long)p->addr, mod) ||
2641 (checkcore &&
2642 within_module_core((unsigned long)p->addr, mod))) {
e8386a0c
MH
2643 /*
2644 * The vaddr this probe is installed will soon
2645 * be vfreed buy not synced to disk. Hence,
2646 * disarming the breakpoint isn't needed.
545a0281
SRV
2647 *
2648 * Note, this will also move any optimized probes
2649 * that are pending to be removed from their
223a76b2 2650 * corresponding lists to the 'freeing_list' and
545a0281 2651 * will not be touched by the delayed
223a76b2 2652 * kprobe_optimizer() work handler.
e8386a0c
MH
2653 */
2654 kill_kprobe(p);
2655 }
2656 }
1e6769b0
MH
2657 if (val == MODULE_STATE_GOING)
2658 remove_module_kprobe_blacklist(mod);
e8386a0c
MH
2659 mutex_unlock(&kprobe_mutex);
2660 return NOTIFY_DONE;
2661}
2662
2663static struct notifier_block kprobe_module_nb = {
2664 .notifier_call = kprobes_module_callback,
2665 .priority = 0
2666};
2667
82d083ab
MH
2668void kprobe_free_init_mem(void)
2669{
2670 void *start = (void *)(&__init_begin);
2671 void *end = (void *)(&__init_end);
2672 struct hlist_head *head;
2673 struct kprobe *p;
2674 int i;
2675
2676 mutex_lock(&kprobe_mutex);
2677
223a76b2 2678 /* Kill all kprobes on initmem because the target code has been freed. */
82d083ab
MH
2679 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2680 head = &kprobe_table[i];
2681 hlist_for_each_entry(p, head, hlist) {
2682 if (start <= (void *)p->addr && (void *)p->addr < end)
2683 kill_kprobe(p);
2684 }
2685 }
2686
2687 mutex_unlock(&kprobe_mutex);
2688}
2689
1da177e4
LT
2690static int __init init_kprobes(void)
2691{
ed9492df 2692 int i, err;
1da177e4
LT
2693
2694 /* FIXME allocate the probe table, currently defined statically */
2695 /* initialize all list heads */
d741bf41 2696 for (i = 0; i < KPROBE_TABLE_SIZE; i++)
1da177e4
LT
2697 INIT_HLIST_HEAD(&kprobe_table[i]);
2698
376e2424
MH
2699 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2700 __stop_kprobe_blacklist);
223a76b2 2701 if (err)
9c89bb8e 2702 pr_err("Failed to populate blacklist (error %d), kprobes not restricted, be careful using them!\n", err);
3d8d996e 2703
f438d914
MH
2704 if (kretprobe_blacklist_size) {
2705 /* lookup the function address from its name */
2706 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
49e0b465 2707 kretprobe_blacklist[i].addr =
290e3070 2708 kprobe_lookup_name(kretprobe_blacklist[i].name, 0);
f438d914 2709 if (!kretprobe_blacklist[i].addr)
9c89bb8e 2710 pr_err("Failed to lookup symbol '%s' for kretprobe blacklist. Maybe the target function is removed or renamed.\n",
f438d914
MH
2711 kretprobe_blacklist[i].name);
2712 }
2713 }
2714
e579abeb
MH
2715 /* By default, kprobes are armed */
2716 kprobes_all_disarmed = false;
bf8f6e5b 2717
c85c9a2c 2718#if defined(CONFIG_OPTPROBES) && defined(__ARCH_WANT_KPROBES_INSN_SLOT)
223a76b2 2719 /* Init 'kprobe_optinsn_slots' for allocation */
c85c9a2c
MH
2720 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2721#endif
2722
6772926b 2723 err = arch_init_kprobes();
802eae7c
RL
2724 if (!err)
2725 err = register_die_notifier(&kprobe_exceptions_nb);
e8386a0c
MH
2726 if (!err)
2727 err = register_module_notifier(&kprobe_module_nb);
2728
ef53d9c5 2729 kprobes_initialized = (err == 0);
a737a3c6 2730 kprobe_sysctls_init();
1da177e4
LT
2731 return err;
2732}
36dadef2 2733early_initcall(init_kprobes);
1da177e4 2734
c85c9a2c
MH
2735#if defined(CONFIG_OPTPROBES)
2736static int __init init_optprobes(void)
2737{
2738 /*
2739 * Enable kprobe optimization - this kicks the optimizer which
2740 * depends on synchronize_rcu_tasks() and ksoftirqd, that is
2741 * not spawned in early initcall. So delay the optimization.
2742 */
2743 optimize_all_kprobes();
2744
2745 return 0;
2746}
2747subsys_initcall(init_optprobes);
2748#endif
2749
346fd59b 2750#ifdef CONFIG_DEBUG_FS
55479f64 2751static void report_probe(struct seq_file *pi, struct kprobe *p,
afd66255 2752 const char *sym, int offset, char *modname, struct kprobe *pp)
346fd59b
SD
2753{
2754 char *kprobe_type;
81365a94 2755 void *addr = p->addr;
346fd59b
SD
2756
2757 if (p->pre_handler == pre_handler_kretprobe)
2758 kprobe_type = "r";
346fd59b
SD
2759 else
2760 kprobe_type = "k";
afd66255 2761
60f7bb66 2762 if (!kallsyms_show_value(pi->file->f_cred))
81365a94
MH
2763 addr = NULL;
2764
346fd59b 2765 if (sym)
81365a94
MH
2766 seq_printf(pi, "%px %s %s+0x%x %s ",
2767 addr, kprobe_type, sym, offset,
afd66255 2768 (modname ? modname : " "));
81365a94
MH
2769 else /* try to use %pS */
2770 seq_printf(pi, "%px %s %pS ",
2771 addr, kprobe_type, p->addr);
afd66255
MH
2772
2773 if (!pp)
2774 pp = p;
ae6aa16f 2775 seq_printf(pi, "%s%s%s%s\n",
afd66255
MH
2776 (kprobe_gone(p) ? "[GONE]" : ""),
2777 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
ae6aa16f
MH
2778 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2779 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
346fd59b
SD
2780}
2781
55479f64 2782static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
346fd59b
SD
2783{
2784 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2785}
2786
55479f64 2787static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
346fd59b
SD
2788{
2789 (*pos)++;
2790 if (*pos >= KPROBE_TABLE_SIZE)
2791 return NULL;
2792 return pos;
2793}
2794
55479f64 2795static void kprobe_seq_stop(struct seq_file *f, void *v)
346fd59b
SD
2796{
2797 /* Nothing to do */
2798}
2799
55479f64 2800static int show_kprobe_addr(struct seq_file *pi, void *v)
346fd59b
SD
2801{
2802 struct hlist_head *head;
346fd59b 2803 struct kprobe *p, *kp;
9efd24ec 2804 const char *sym;
346fd59b 2805 unsigned int i = *(loff_t *) v;
ffb45122 2806 unsigned long offset = 0;
ab767865 2807 char *modname, namebuf[KSYM_NAME_LEN];
346fd59b
SD
2808
2809 head = &kprobe_table[i];
2810 preempt_disable();
b67bfe0d 2811 hlist_for_each_entry_rcu(p, head, hlist) {
ffb45122 2812 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
346fd59b 2813 &offset, &modname, namebuf);
afd66255 2814 if (kprobe_aggrprobe(p)) {
346fd59b 2815 list_for_each_entry_rcu(kp, &p->list, list)
afd66255 2816 report_probe(pi, kp, sym, offset, modname, p);
346fd59b 2817 } else
afd66255 2818 report_probe(pi, p, sym, offset, modname, NULL);
346fd59b
SD
2819 }
2820 preempt_enable();
2821 return 0;
2822}
2823
eac2cece 2824static const struct seq_operations kprobes_sops = {
346fd59b
SD
2825 .start = kprobe_seq_start,
2826 .next = kprobe_seq_next,
2827 .stop = kprobe_seq_stop,
2828 .show = show_kprobe_addr
2829};
2830
eac2cece 2831DEFINE_SEQ_ATTRIBUTE(kprobes);
346fd59b 2832
63724740
MH
2833/* kprobes/blacklist -- shows which functions can not be probed */
2834static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2835{
4fdd8887 2836 mutex_lock(&kprobe_mutex);
63724740
MH
2837 return seq_list_start(&kprobe_blacklist, *pos);
2838}
2839
2840static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2841{
2842 return seq_list_next(v, &kprobe_blacklist, pos);
2843}
2844
2845static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2846{
2847 struct kprobe_blacklist_entry *ent =
2848 list_entry(v, struct kprobe_blacklist_entry, list);
2849
ffb9bd68 2850 /*
223a76b2 2851 * If '/proc/kallsyms' is not showing kernel address, we won't
ffb9bd68
MH
2852 * show them here either.
2853 */
60f7bb66 2854 if (!kallsyms_show_value(m->file->f_cred))
ffb9bd68
MH
2855 seq_printf(m, "0x%px-0x%px\t%ps\n", NULL, NULL,
2856 (void *)ent->start_addr);
2857 else
2858 seq_printf(m, "0x%px-0x%px\t%ps\n", (void *)ent->start_addr,
2859 (void *)ent->end_addr, (void *)ent->start_addr);
63724740
MH
2860 return 0;
2861}
2862
4fdd8887
MH
2863static void kprobe_blacklist_seq_stop(struct seq_file *f, void *v)
2864{
2865 mutex_unlock(&kprobe_mutex);
2866}
2867
eac2cece 2868static const struct seq_operations kprobe_blacklist_sops = {
63724740
MH
2869 .start = kprobe_blacklist_seq_start,
2870 .next = kprobe_blacklist_seq_next,
4fdd8887 2871 .stop = kprobe_blacklist_seq_stop,
63724740
MH
2872 .show = kprobe_blacklist_seq_show,
2873};
eac2cece 2874DEFINE_SEQ_ATTRIBUTE(kprobe_blacklist);
63724740 2875
12310e34 2876static int arm_all_kprobes(void)
bf8f6e5b
AM
2877{
2878 struct hlist_head *head;
bf8f6e5b 2879 struct kprobe *p;
12310e34
JY
2880 unsigned int i, total = 0, errors = 0;
2881 int err, ret = 0;
bf8f6e5b
AM
2882
2883 mutex_lock(&kprobe_mutex);
2884
e579abeb
MH
2885 /* If kprobes are armed, just return */
2886 if (!kprobes_all_disarmed)
bf8f6e5b
AM
2887 goto already_enabled;
2888
977ad481
WN
2889 /*
2890 * optimize_kprobe() called by arm_kprobe() checks
2891 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2892 * arm_kprobe.
2893 */
2894 kprobes_all_disarmed = false;
afd66255 2895 /* Arming kprobes doesn't optimize kprobe itself */
bf8f6e5b
AM
2896 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2897 head = &kprobe_table[i];
12310e34 2898 /* Arm all kprobes on a best-effort basis */
7e6a71d8 2899 hlist_for_each_entry(p, head, hlist) {
12310e34
JY
2900 if (!kprobe_disabled(p)) {
2901 err = arm_kprobe(p);
2902 if (err) {
2903 errors++;
2904 ret = err;
2905 }
2906 total++;
2907 }
2908 }
bf8f6e5b
AM
2909 }
2910
12310e34 2911 if (errors)
9c89bb8e 2912 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
2913 errors, total);
2914 else
2915 pr_info("Kprobes globally enabled\n");
bf8f6e5b
AM
2916
2917already_enabled:
2918 mutex_unlock(&kprobe_mutex);
12310e34 2919 return ret;
bf8f6e5b
AM
2920}
2921
297f9233 2922static int disarm_all_kprobes(void)
bf8f6e5b
AM
2923{
2924 struct hlist_head *head;
bf8f6e5b 2925 struct kprobe *p;
297f9233
JY
2926 unsigned int i, total = 0, errors = 0;
2927 int err, ret = 0;
bf8f6e5b
AM
2928
2929 mutex_lock(&kprobe_mutex);
2930
e579abeb 2931 /* If kprobes are already disarmed, just return */
6274de49
MH
2932 if (kprobes_all_disarmed) {
2933 mutex_unlock(&kprobe_mutex);
297f9233 2934 return 0;
6274de49 2935 }
bf8f6e5b 2936
e579abeb 2937 kprobes_all_disarmed = true;
afd66255 2938
bf8f6e5b
AM
2939 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2940 head = &kprobe_table[i];
297f9233 2941 /* Disarm all kprobes on a best-effort basis */
7e6a71d8 2942 hlist_for_each_entry(p, head, hlist) {
297f9233
JY
2943 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p)) {
2944 err = disarm_kprobe(p, false);
2945 if (err) {
2946 errors++;
2947 ret = err;
2948 }
2949 total++;
2950 }
bf8f6e5b
AM
2951 }
2952 }
297f9233
JY
2953
2954 if (errors)
9c89bb8e 2955 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
2956 errors, total);
2957 else
2958 pr_info("Kprobes globally disabled\n");
2959
bf8f6e5b 2960 mutex_unlock(&kprobe_mutex);
bf8f6e5b 2961
6274de49
MH
2962 /* Wait for disarming all kprobes by optimizer */
2963 wait_for_kprobe_optimizer();
297f9233
JY
2964
2965 return ret;
bf8f6e5b
AM
2966}
2967
2968/*
2969 * XXX: The debugfs bool file interface doesn't allow for callbacks
2970 * when the bool state is switched. We can reuse that facility when
2971 * available
2972 */
2973static ssize_t read_enabled_file_bool(struct file *file,
2974 char __user *user_buf, size_t count, loff_t *ppos)
2975{
2976 char buf[3];
2977
e579abeb 2978 if (!kprobes_all_disarmed)
bf8f6e5b
AM
2979 buf[0] = '1';
2980 else
2981 buf[0] = '0';
2982 buf[1] = '\n';
2983 buf[2] = 0x00;
2984 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2985}
2986
2987static ssize_t write_enabled_file_bool(struct file *file,
2988 const char __user *user_buf, size_t count, loff_t *ppos)
2989{
5d6de7d7
PA
2990 bool enable;
2991 int ret;
bf8f6e5b 2992
5d6de7d7
PA
2993 ret = kstrtobool_from_user(user_buf, count, &enable);
2994 if (ret)
2995 return ret;
bf8f6e5b 2996
5d6de7d7 2997 ret = enable ? arm_all_kprobes() : disarm_all_kprobes();
12310e34
JY
2998 if (ret)
2999 return ret;
3000
bf8f6e5b
AM
3001 return count;
3002}
3003
828c0950 3004static const struct file_operations fops_kp = {
bf8f6e5b
AM
3005 .read = read_enabled_file_bool,
3006 .write = write_enabled_file_bool,
6038f373 3007 .llseek = default_llseek,
bf8f6e5b
AM
3008};
3009
55479f64 3010static int __init debugfs_kprobe_init(void)
346fd59b 3011{
8c0fd1fa 3012 struct dentry *dir;
346fd59b
SD
3013
3014 dir = debugfs_create_dir("kprobes", NULL);
346fd59b 3015
eac2cece 3016 debugfs_create_file("list", 0400, dir, NULL, &kprobes_fops);
346fd59b 3017
8f7262cd 3018 debugfs_create_file("enabled", 0600, dir, NULL, &fops_kp);
63724740 3019
8c0fd1fa 3020 debugfs_create_file("blacklist", 0400, dir, NULL,
eac2cece 3021 &kprobe_blacklist_fops);
bf8f6e5b 3022
346fd59b
SD
3023 return 0;
3024}
3025
3026late_initcall(debugfs_kprobe_init);
3027#endif /* CONFIG_DEBUG_FS */