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