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