]> git.ipfire.org Git - people/arne_f/kernel.git/blame - kernel/kprobes.c
RDMA/rxe: Fix memleak in rxe_mem_init_user
[people/arne_f/kernel.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
af96397d
HC
120static void *alloc_insn_page(void)
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);
390 kp->pre_handler(kp, regs);
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{
ab978e79 486 lockdep_assert_held(&text_mutex);
afd66255
MH
487 /*
488 * The optimization/unoptimization refers online_cpus via
489 * stop_machine() and cpu-hotplug modifies online_cpus.
490 * And same time, text_mutex will be held in cpu-hotplug and here.
491 * This combination can cause a deadlock (cpu-hotplug try to lock
492 * text_mutex but stop_machine can not be done because online_cpus
493 * has been changed)
2d1e38f5 494 * To avoid this deadlock, caller must have locked cpu hotplug
afd66255
MH
495 * for preventing cpu-hotplug outside of text_mutex locking.
496 */
2d1e38f5
TG
497 lockdep_assert_cpus_held();
498
499 /* Optimization never be done when disarmed */
500 if (kprobes_all_disarmed || !kprobes_allow_optimization ||
501 list_empty(&optimizing_list))
502 return;
503
cd7ebe22 504 arch_optimize_kprobes(&optimizing_list);
61f4e13f
MH
505}
506
6274de49
MH
507/*
508 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
509 * if need) kprobes listed on unoptimizing_list.
510 */
55479f64 511static void do_unoptimize_kprobes(void)
6274de49
MH
512{
513 struct optimized_kprobe *op, *tmp;
514
ab978e79 515 lockdep_assert_held(&text_mutex);
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
7b959fc5 523 arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
f984ba4e 524 /* Loop free_list for disarming */
7b959fc5 525 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
b996b668
MH
526 /* Switching from detour code to origin */
527 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
6274de49
MH
528 /* Disarm probes if marked disabled */
529 if (kprobe_disabled(&op->kp))
530 arch_disarm_kprobe(&op->kp);
531 if (kprobe_unused(&op->kp)) {
532 /*
533 * Remove unused probes from hash list. After waiting
534 * for synchronization, these probes are reclaimed.
535 * (reclaiming is done by do_free_cleaned_kprobes.)
536 */
537 hlist_del_rcu(&op->kp.hlist);
6274de49
MH
538 } else
539 list_del_init(&op->list);
540 }
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);
9e50bed6
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();
ab978e79 572 mutex_lock(&text_mutex);
61f4e13f
MH
573 /* Lock modules while optimizing kprobes */
574 mutex_lock(&module_mutex);
61f4e13f
MH
575
576 /*
6274de49
MH
577 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
578 * kprobes before waiting for quiesence period.
579 */
7b959fc5 580 do_unoptimize_kprobes();
6274de49
MH
581
582 /*
5715de46
MH
583 * Step 2: Wait for quiesence period to ensure all potentially
584 * preempted tasks to have normally scheduled. Because optprobe
585 * may modify multiple instructions, there is a chance that Nth
586 * instruction is preempted. In that case, such tasks can return
587 * to 2nd-Nth byte of jump instruction. This wait is for avoiding it.
588 * Note that on non-preemptive kernel, this is transparently converted
589 * to synchronoze_sched() to wait for all interrupts to have completed.
61f4e13f 590 */
5715de46 591 synchronize_rcu_tasks();
61f4e13f 592
6274de49 593 /* Step 3: Optimize kprobes after quiesence period */
61f4e13f 594 do_optimize_kprobes();
6274de49
MH
595
596 /* Step 4: Free cleaned kprobes after quiesence period */
7b959fc5 597 do_free_cleaned_kprobes();
6274de49 598
afd66255 599 mutex_unlock(&module_mutex);
ab978e79 600 mutex_unlock(&text_mutex);
2d1e38f5 601 cpus_read_unlock();
6274de49 602
cd7ebe22 603 /* Step 5: Kick optimizer again if needed */
f984ba4e 604 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
cd7ebe22 605 kick_kprobe_optimizer();
c18d5164
MH
606
607 mutex_unlock(&kprobe_mutex);
6274de49
MH
608}
609
610/* Wait for completing optimization and unoptimization */
30e7d894 611void wait_for_kprobe_optimizer(void)
6274de49 612{
ad72b3be
TH
613 mutex_lock(&kprobe_mutex);
614
615 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
616 mutex_unlock(&kprobe_mutex);
617
618 /* this will also make optimizing_work execute immmediately */
619 flush_delayed_work(&optimizing_work);
620 /* @optimizing_work might not have been queued yet, relax */
621 cpu_relax();
622
623 mutex_lock(&kprobe_mutex);
624 }
625
626 mutex_unlock(&kprobe_mutex);
afd66255
MH
627}
628
53647b82
MH
629static bool optprobe_queued_unopt(struct optimized_kprobe *op)
630{
631 struct optimized_kprobe *_op;
632
633 list_for_each_entry(_op, &unoptimizing_list, list) {
634 if (op == _op)
635 return true;
636 }
637
638 return false;
639}
640
afd66255 641/* Optimize kprobe if p is ready to be optimized */
55479f64 642static void optimize_kprobe(struct kprobe *p)
afd66255
MH
643{
644 struct optimized_kprobe *op;
645
646 /* Check if the kprobe is disabled or not ready for optimization. */
b2be84df 647 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
afd66255
MH
648 (kprobe_disabled(p) || kprobes_all_disarmed))
649 return;
650
651 /* Both of break_handler and post_handler are not supported. */
652 if (p->break_handler || p->post_handler)
653 return;
654
655 op = container_of(p, struct optimized_kprobe, kp);
656
657 /* Check there is no other kprobes at the optimized instructions */
658 if (arch_check_optimized_kprobe(op) < 0)
659 return;
660
661 /* Check if it is already optimized. */
53647b82
MH
662 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED) {
663 if (optprobe_queued_unopt(op)) {
664 /* This is under unoptimizing. Just dequeue the probe */
665 list_del_init(&op->list);
666 }
afd66255 667 return;
53647b82 668 }
afd66255 669 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
6274de49 670
53647b82
MH
671 /* On unoptimizing/optimizing_list, op must have OPTIMIZED flag */
672 if (WARN_ON_ONCE(!list_empty(&op->list)))
673 return;
674
675 list_add(&op->list, &optimizing_list);
676 kick_kprobe_optimizer();
6274de49
MH
677}
678
679/* Short cut to direct unoptimizing */
55479f64 680static void force_unoptimize_kprobe(struct optimized_kprobe *op)
6274de49 681{
2d1e38f5 682 lockdep_assert_cpus_held();
6274de49 683 arch_unoptimize_kprobe(op);
b996b668 684 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
6274de49
MH
685 if (kprobe_disabled(&op->kp))
686 arch_disarm_kprobe(&op->kp);
afd66255
MH
687}
688
689/* Unoptimize a kprobe if p is optimized */
55479f64 690static void unoptimize_kprobe(struct kprobe *p, bool force)
afd66255
MH
691{
692 struct optimized_kprobe *op;
693
6274de49
MH
694 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
695 return; /* This is not an optprobe nor optimized */
696
697 op = container_of(p, struct optimized_kprobe, kp);
53647b82 698 if (!kprobe_optimized(p))
6274de49 699 return;
6274de49 700
6274de49 701 if (!list_empty(&op->list)) {
53647b82
MH
702 if (optprobe_queued_unopt(op)) {
703 /* Queued in unoptimizing queue */
704 if (force) {
705 /*
706 * Forcibly unoptimize the kprobe here, and queue it
707 * in the freeing list for release afterwards.
708 */
709 force_unoptimize_kprobe(op);
710 list_move(&op->list, &freeing_list);
711 }
712 } else {
713 /* Dequeue from the optimizing queue */
714 list_del_init(&op->list);
715 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
716 }
6274de49
MH
717 return;
718 }
53647b82 719
6274de49 720 /* Optimized kprobe case */
53647b82 721 if (force) {
6274de49
MH
722 /* Forcibly update the code: this is a special case */
723 force_unoptimize_kprobe(op);
53647b82 724 } else {
6274de49
MH
725 list_add(&op->list, &unoptimizing_list);
726 kick_kprobe_optimizer();
afd66255
MH
727 }
728}
729
0490cd1f 730/* Cancel unoptimizing for reusing */
0e0b860f 731static int reuse_unused_kprobe(struct kprobe *ap)
0490cd1f
MH
732{
733 struct optimized_kprobe *op;
734
735 BUG_ON(!kprobe_unused(ap));
736 /*
737 * Unused kprobe MUST be on the way of delayed unoptimizing (means
738 * there is still a relative jump) and disabled.
739 */
740 op = container_of(ap, struct optimized_kprobe, kp);
741 if (unlikely(list_empty(&op->list)))
742 printk(KERN_WARNING "Warning: found a stray unused "
743 "aggrprobe@%p\n", ap->addr);
744 /* Enable the probe again */
745 ap->flags &= ~KPROBE_FLAG_DISABLED;
746 /* Optimize it again (remove from op->list) */
5e8002fb
MH
747 if (!kprobe_optready(ap))
748 return -EINVAL;
0e0b860f 749
0490cd1f 750 optimize_kprobe(ap);
0e0b860f 751 return 0;
0490cd1f
MH
752}
753
afd66255 754/* Remove optimized instructions */
55479f64 755static void kill_optimized_kprobe(struct kprobe *p)
afd66255
MH
756{
757 struct optimized_kprobe *op;
758
759 op = container_of(p, struct optimized_kprobe, kp);
6274de49
MH
760 if (!list_empty(&op->list))
761 /* Dequeue from the (un)optimization queue */
afd66255 762 list_del_init(&op->list);
6274de49 763 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
7b959fc5
MH
764
765 if (kprobe_unused(p)) {
766 /* Enqueue if it is unused */
767 list_add(&op->list, &freeing_list);
768 /*
769 * Remove unused probes from the hash list. After waiting
770 * for synchronization, this probe is reclaimed.
771 * (reclaiming is done by do_free_cleaned_kprobes().)
772 */
773 hlist_del_rcu(&op->kp.hlist);
774 }
775
6274de49 776 /* Don't touch the code, because it is already freed. */
afd66255
MH
777 arch_remove_optimized_kprobe(op);
778}
779
a460246c
MH
780static inline
781void __prepare_optimized_kprobe(struct optimized_kprobe *op, struct kprobe *p)
782{
783 if (!kprobe_ftrace(p))
784 arch_prepare_optimized_kprobe(op, p);
785}
786
afd66255 787/* Try to prepare optimized instructions */
55479f64 788static void prepare_optimized_kprobe(struct kprobe *p)
afd66255
MH
789{
790 struct optimized_kprobe *op;
791
792 op = container_of(p, struct optimized_kprobe, kp);
a460246c 793 __prepare_optimized_kprobe(op, p);
afd66255
MH
794}
795
afd66255 796/* Allocate new optimized_kprobe and try to prepare optimized instructions */
55479f64 797static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
afd66255
MH
798{
799 struct optimized_kprobe *op;
800
801 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
802 if (!op)
803 return NULL;
804
805 INIT_LIST_HEAD(&op->list);
806 op->kp.addr = p->addr;
a460246c 807 __prepare_optimized_kprobe(op, p);
afd66255
MH
808
809 return &op->kp;
810}
811
55479f64 812static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
afd66255
MH
813
814/*
815 * Prepare an optimized_kprobe and optimize it
816 * NOTE: p must be a normal registered kprobe
817 */
55479f64 818static void try_to_optimize_kprobe(struct kprobe *p)
afd66255
MH
819{
820 struct kprobe *ap;
821 struct optimized_kprobe *op;
822
ae6aa16f
MH
823 /* Impossible to optimize ftrace-based kprobe */
824 if (kprobe_ftrace(p))
825 return;
826
25764288 827 /* For preparing optimization, jump_label_text_reserved() is called */
2d1e38f5 828 cpus_read_lock();
25764288
MH
829 jump_label_lock();
830 mutex_lock(&text_mutex);
831
afd66255
MH
832 ap = alloc_aggr_kprobe(p);
833 if (!ap)
25764288 834 goto out;
afd66255
MH
835
836 op = container_of(ap, struct optimized_kprobe, kp);
837 if (!arch_prepared_optinsn(&op->optinsn)) {
838 /* If failed to setup optimizing, fallback to kprobe */
6274de49
MH
839 arch_remove_optimized_kprobe(op);
840 kfree(op);
25764288 841 goto out;
afd66255
MH
842 }
843
844 init_aggr_kprobe(ap, p);
25764288
MH
845 optimize_kprobe(ap); /* This just kicks optimizer thread */
846
847out:
848 mutex_unlock(&text_mutex);
849 jump_label_unlock();
2d1e38f5 850 cpus_read_unlock();
afd66255
MH
851}
852
b2be84df 853#ifdef CONFIG_SYSCTL
55479f64 854static void optimize_all_kprobes(void)
b2be84df
MH
855{
856 struct hlist_head *head;
b2be84df
MH
857 struct kprobe *p;
858 unsigned int i;
859
5c51543b 860 mutex_lock(&kprobe_mutex);
b2be84df
MH
861 /* If optimization is already allowed, just return */
862 if (kprobes_allow_optimization)
5c51543b 863 goto out;
b2be84df 864
2d1e38f5 865 cpus_read_lock();
b2be84df 866 kprobes_allow_optimization = true;
b2be84df
MH
867 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
868 head = &kprobe_table[i];
b67bfe0d 869 hlist_for_each_entry_rcu(p, head, hlist)
b2be84df
MH
870 if (!kprobe_disabled(p))
871 optimize_kprobe(p);
872 }
2d1e38f5 873 cpus_read_unlock();
b2be84df 874 printk(KERN_INFO "Kprobes globally optimized\n");
5c51543b
MH
875out:
876 mutex_unlock(&kprobe_mutex);
b2be84df
MH
877}
878
55479f64 879static void unoptimize_all_kprobes(void)
b2be84df
MH
880{
881 struct hlist_head *head;
b2be84df
MH
882 struct kprobe *p;
883 unsigned int i;
884
5c51543b 885 mutex_lock(&kprobe_mutex);
b2be84df 886 /* If optimization is already prohibited, just return */
5c51543b
MH
887 if (!kprobes_allow_optimization) {
888 mutex_unlock(&kprobe_mutex);
b2be84df 889 return;
5c51543b 890 }
b2be84df 891
2d1e38f5 892 cpus_read_lock();
b2be84df 893 kprobes_allow_optimization = false;
b2be84df
MH
894 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
895 head = &kprobe_table[i];
b67bfe0d 896 hlist_for_each_entry_rcu(p, head, hlist) {
b2be84df 897 if (!kprobe_disabled(p))
6274de49 898 unoptimize_kprobe(p, false);
b2be84df
MH
899 }
900 }
2d1e38f5 901 cpus_read_unlock();
5c51543b
MH
902 mutex_unlock(&kprobe_mutex);
903
6274de49
MH
904 /* Wait for unoptimizing completion */
905 wait_for_kprobe_optimizer();
906 printk(KERN_INFO "Kprobes globally unoptimized\n");
b2be84df
MH
907}
908
5c51543b 909static DEFINE_MUTEX(kprobe_sysctl_mutex);
b2be84df
MH
910int sysctl_kprobes_optimization;
911int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
912 void __user *buffer, size_t *length,
913 loff_t *ppos)
914{
915 int ret;
916
5c51543b 917 mutex_lock(&kprobe_sysctl_mutex);
b2be84df
MH
918 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
919 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
920
921 if (sysctl_kprobes_optimization)
922 optimize_all_kprobes();
923 else
924 unoptimize_all_kprobes();
5c51543b 925 mutex_unlock(&kprobe_sysctl_mutex);
b2be84df
MH
926
927 return ret;
928}
929#endif /* CONFIG_SYSCTL */
930
6274de49 931/* Put a breakpoint for a probe. Must be called with text_mutex locked */
55479f64 932static void __arm_kprobe(struct kprobe *p)
afd66255 933{
6d8e40a8 934 struct kprobe *_p;
afd66255
MH
935
936 /* Check collision with other optimized kprobes */
6d8e40a8
MH
937 _p = get_optimized_kprobe((unsigned long)p->addr);
938 if (unlikely(_p))
6274de49
MH
939 /* Fallback to unoptimized kprobe */
940 unoptimize_kprobe(_p, true);
afd66255
MH
941
942 arch_arm_kprobe(p);
943 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
944}
945
6274de49 946/* Remove the breakpoint of a probe. Must be called with text_mutex locked */
55479f64 947static void __disarm_kprobe(struct kprobe *p, bool reopt)
afd66255 948{
6d8e40a8 949 struct kprobe *_p;
afd66255 950
69d54b91
WN
951 /* Try to unoptimize */
952 unoptimize_kprobe(p, kprobes_all_disarmed);
afd66255 953
6274de49
MH
954 if (!kprobe_queued(p)) {
955 arch_disarm_kprobe(p);
956 /* If another kprobe was blocked, optimize it. */
957 _p = get_optimized_kprobe((unsigned long)p->addr);
958 if (unlikely(_p) && reopt)
959 optimize_kprobe(_p);
960 }
961 /* TODO: reoptimize others after unoptimized this probe */
afd66255
MH
962}
963
964#else /* !CONFIG_OPTPROBES */
965
966#define optimize_kprobe(p) do {} while (0)
6274de49 967#define unoptimize_kprobe(p, f) do {} while (0)
afd66255
MH
968#define kill_optimized_kprobe(p) do {} while (0)
969#define prepare_optimized_kprobe(p) do {} while (0)
970#define try_to_optimize_kprobe(p) do {} while (0)
971#define __arm_kprobe(p) arch_arm_kprobe(p)
6274de49
MH
972#define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
973#define kprobe_disarmed(p) kprobe_disabled(p)
974#define wait_for_kprobe_optimizer() do {} while (0)
afd66255 975
0e0b860f 976static int reuse_unused_kprobe(struct kprobe *ap)
0490cd1f 977{
0e0b860f
MH
978 /*
979 * If the optimized kprobe is NOT supported, the aggr kprobe is
980 * released at the same time that the last aggregated kprobe is
981 * unregistered.
982 * Thus there should be no chance to reuse unused kprobe.
983 */
0490cd1f 984 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
0e0b860f 985 return -EINVAL;
0490cd1f
MH
986}
987
55479f64 988static void free_aggr_kprobe(struct kprobe *p)
afd66255 989{
6274de49 990 arch_remove_kprobe(p);
afd66255
MH
991 kfree(p);
992}
993
55479f64 994static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
afd66255
MH
995{
996 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
997}
998#endif /* CONFIG_OPTPROBES */
999
e7dbfe34 1000#ifdef CONFIG_KPROBES_ON_FTRACE
ae6aa16f 1001static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
e5253896 1002 .func = kprobe_ftrace_handler,
1d70be34 1003 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
ae6aa16f
MH
1004};
1005static int kprobe_ftrace_enabled;
1006
1007/* Must ensure p->addr is really on ftrace */
55479f64 1008static int prepare_kprobe(struct kprobe *p)
ae6aa16f
MH
1009{
1010 if (!kprobe_ftrace(p))
1011 return arch_prepare_kprobe(p);
1012
1013 return arch_prepare_kprobe_ftrace(p);
1014}
1015
1016/* Caller must lock kprobe_mutex */
55479f64 1017static void arm_kprobe_ftrace(struct kprobe *p)
ae6aa16f
MH
1018{
1019 int ret;
1020
1021 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
1022 (unsigned long)p->addr, 0, 0);
1023 WARN(ret < 0, "Failed to arm kprobe-ftrace at %p (%d)\n", p->addr, ret);
1024 kprobe_ftrace_enabled++;
1025 if (kprobe_ftrace_enabled == 1) {
1026 ret = register_ftrace_function(&kprobe_ftrace_ops);
1027 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
1028 }
1029}
1030
1031/* Caller must lock kprobe_mutex */
55479f64 1032static void disarm_kprobe_ftrace(struct kprobe *p)
ae6aa16f
MH
1033{
1034 int ret;
1035
1036 kprobe_ftrace_enabled--;
1037 if (kprobe_ftrace_enabled == 0) {
1038 ret = unregister_ftrace_function(&kprobe_ftrace_ops);
1039 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
1040 }
1041 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
1042 (unsigned long)p->addr, 1, 0);
1043 WARN(ret < 0, "Failed to disarm kprobe-ftrace at %p (%d)\n", p->addr, ret);
1044}
e7dbfe34 1045#else /* !CONFIG_KPROBES_ON_FTRACE */
ae6aa16f
MH
1046#define prepare_kprobe(p) arch_prepare_kprobe(p)
1047#define arm_kprobe_ftrace(p) do {} while (0)
1048#define disarm_kprobe_ftrace(p) do {} while (0)
1049#endif
1050
201517a7 1051/* Arm a kprobe with text_mutex */
55479f64 1052static void arm_kprobe(struct kprobe *kp)
201517a7 1053{
ae6aa16f
MH
1054 if (unlikely(kprobe_ftrace(kp))) {
1055 arm_kprobe_ftrace(kp);
1056 return;
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();
201517a7
MH
1063}
1064
1065/* Disarm a kprobe with text_mutex */
55479f64 1066static void disarm_kprobe(struct kprobe *kp, bool reopt)
201517a7 1067{
ae6aa16f
MH
1068 if (unlikely(kprobe_ftrace(kp))) {
1069 disarm_kprobe_ftrace(kp);
1070 return;
1071 }
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();
201517a7
MH
1078}
1079
64f562c6
AM
1080/*
1081 * Aggregate handlers for multiple kprobes support - these handlers
1082 * take care of invoking the individual kprobe handlers on p->list
1083 */
820aede0 1084static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
64f562c6
AM
1085{
1086 struct kprobe *kp;
1087
3516a460 1088 list_for_each_entry_rcu(kp, &p->list, list) {
de5bd88d 1089 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
e6584523 1090 set_kprobe_instance(kp);
8b0914ea
PP
1091 if (kp->pre_handler(kp, regs))
1092 return 1;
64f562c6 1093 }
e6584523 1094 reset_kprobe_instance();
64f562c6
AM
1095 }
1096 return 0;
1097}
820aede0 1098NOKPROBE_SYMBOL(aggr_pre_handler);
64f562c6 1099
820aede0
MH
1100static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1101 unsigned long flags)
64f562c6
AM
1102{
1103 struct kprobe *kp;
1104
3516a460 1105 list_for_each_entry_rcu(kp, &p->list, list) {
de5bd88d 1106 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
e6584523 1107 set_kprobe_instance(kp);
64f562c6 1108 kp->post_handler(kp, regs, flags);
e6584523 1109 reset_kprobe_instance();
64f562c6
AM
1110 }
1111 }
64f562c6 1112}
820aede0 1113NOKPROBE_SYMBOL(aggr_post_handler);
64f562c6 1114
820aede0
MH
1115static int aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
1116 int trapnr)
64f562c6 1117{
b76834bc 1118 struct kprobe *cur = __this_cpu_read(kprobe_instance);
e6584523 1119
64f562c6
AM
1120 /*
1121 * if we faulted "during" the execution of a user specified
1122 * probe handler, invoke just that probe's fault handler
1123 */
e6584523
AM
1124 if (cur && cur->fault_handler) {
1125 if (cur->fault_handler(cur, regs, trapnr))
64f562c6
AM
1126 return 1;
1127 }
1128 return 0;
1129}
820aede0 1130NOKPROBE_SYMBOL(aggr_fault_handler);
64f562c6 1131
820aede0 1132static int aggr_break_handler(struct kprobe *p, struct pt_regs *regs)
8b0914ea 1133{
b76834bc 1134 struct kprobe *cur = __this_cpu_read(kprobe_instance);
e6584523
AM
1135 int ret = 0;
1136
1137 if (cur && cur->break_handler) {
1138 if (cur->break_handler(cur, regs))
1139 ret = 1;
8b0914ea 1140 }
e6584523
AM
1141 reset_kprobe_instance();
1142 return ret;
8b0914ea 1143}
820aede0 1144NOKPROBE_SYMBOL(aggr_break_handler);
8b0914ea 1145
bf8d5c52 1146/* Walks the list and increments nmissed count for multiprobe case */
820aede0 1147void kprobes_inc_nmissed_count(struct kprobe *p)
bf8d5c52
KA
1148{
1149 struct kprobe *kp;
afd66255 1150 if (!kprobe_aggrprobe(p)) {
bf8d5c52
KA
1151 p->nmissed++;
1152 } else {
1153 list_for_each_entry_rcu(kp, &p->list, list)
1154 kp->nmissed++;
1155 }
1156 return;
1157}
820aede0 1158NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
bf8d5c52 1159
820aede0
MH
1160void recycle_rp_inst(struct kretprobe_instance *ri,
1161 struct hlist_head *head)
b94cce92 1162{
ef53d9c5
S
1163 struct kretprobe *rp = ri->rp;
1164
b94cce92
HN
1165 /* remove rp inst off the rprobe_inst_table */
1166 hlist_del(&ri->hlist);
ef53d9c5
S
1167 INIT_HLIST_NODE(&ri->hlist);
1168 if (likely(rp)) {
ec484608 1169 raw_spin_lock(&rp->lock);
ef53d9c5 1170 hlist_add_head(&ri->hlist, &rp->free_instances);
ec484608 1171 raw_spin_unlock(&rp->lock);
b94cce92
HN
1172 } else
1173 /* Unregistering */
99219a3f 1174 hlist_add_head(&ri->hlist, head);
b94cce92 1175}
820aede0 1176NOKPROBE_SYMBOL(recycle_rp_inst);
b94cce92 1177
820aede0 1178void kretprobe_hash_lock(struct task_struct *tsk,
ef53d9c5 1179 struct hlist_head **head, unsigned long *flags)
635c17c2 1180__acquires(hlist_lock)
ef53d9c5
S
1181{
1182 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
ec484608 1183 raw_spinlock_t *hlist_lock;
ef53d9c5
S
1184
1185 *head = &kretprobe_inst_table[hash];
1186 hlist_lock = kretprobe_table_lock_ptr(hash);
ec484608 1187 raw_spin_lock_irqsave(hlist_lock, *flags);
ef53d9c5 1188}
820aede0 1189NOKPROBE_SYMBOL(kretprobe_hash_lock);
ef53d9c5 1190
820aede0
MH
1191static void kretprobe_table_lock(unsigned long hash,
1192 unsigned long *flags)
635c17c2 1193__acquires(hlist_lock)
b94cce92 1194{
ec484608
TG
1195 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1196 raw_spin_lock_irqsave(hlist_lock, *flags);
ef53d9c5 1197}
820aede0 1198NOKPROBE_SYMBOL(kretprobe_table_lock);
ef53d9c5 1199
820aede0
MH
1200void kretprobe_hash_unlock(struct task_struct *tsk,
1201 unsigned long *flags)
635c17c2 1202__releases(hlist_lock)
ef53d9c5
S
1203{
1204 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
ec484608 1205 raw_spinlock_t *hlist_lock;
ef53d9c5
S
1206
1207 hlist_lock = kretprobe_table_lock_ptr(hash);
ec484608 1208 raw_spin_unlock_irqrestore(hlist_lock, *flags);
ef53d9c5 1209}
820aede0 1210NOKPROBE_SYMBOL(kretprobe_hash_unlock);
ef53d9c5 1211
820aede0
MH
1212static void kretprobe_table_unlock(unsigned long hash,
1213 unsigned long *flags)
635c17c2 1214__releases(hlist_lock)
ef53d9c5 1215{
ec484608
TG
1216 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1217 raw_spin_unlock_irqrestore(hlist_lock, *flags);
b94cce92 1218}
820aede0 1219NOKPROBE_SYMBOL(kretprobe_table_unlock);
b94cce92 1220
62ce8f40
JO
1221struct kprobe kprobe_busy = {
1222 .addr = (void *) get_kprobe,
1223};
1224
1225void kprobe_busy_begin(void)
1226{
1227 struct kprobe_ctlblk *kcb;
1228
1229 preempt_disable();
1230 __this_cpu_write(current_kprobe, &kprobe_busy);
1231 kcb = get_kprobe_ctlblk();
1232 kcb->kprobe_status = KPROBE_HIT_ACTIVE;
1233}
1234
1235void kprobe_busy_end(void)
1236{
1237 __this_cpu_write(current_kprobe, NULL);
1238 preempt_enable();
1239}
1240
b94cce92 1241/*
c6fd91f0 1242 * This function is called from finish_task_switch when task tk becomes dead,
1243 * so that we can recycle any function-return probe instances associated
1244 * with this task. These left over instances represent probed functions
1245 * that have been called but will never return.
b94cce92 1246 */
820aede0 1247void kprobe_flush_task(struct task_struct *tk)
b94cce92 1248{
62c27be0 1249 struct kretprobe_instance *ri;
99219a3f 1250 struct hlist_head *head, empty_rp;
b67bfe0d 1251 struct hlist_node *tmp;
ef53d9c5 1252 unsigned long hash, flags = 0;
802eae7c 1253
ef53d9c5
S
1254 if (unlikely(!kprobes_initialized))
1255 /* Early boot. kretprobe_table_locks not yet initialized. */
1256 return;
1257
62ce8f40
JO
1258 kprobe_busy_begin();
1259
d496aab5 1260 INIT_HLIST_HEAD(&empty_rp);
ef53d9c5
S
1261 hash = hash_ptr(tk, KPROBE_HASH_BITS);
1262 head = &kretprobe_inst_table[hash];
1263 kretprobe_table_lock(hash, &flags);
b67bfe0d 1264 hlist_for_each_entry_safe(ri, tmp, head, hlist) {
62c27be0 1265 if (ri->task == tk)
99219a3f 1266 recycle_rp_inst(ri, &empty_rp);
62c27be0 1267 }
ef53d9c5 1268 kretprobe_table_unlock(hash, &flags);
b67bfe0d 1269 hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
99219a3f 1270 hlist_del(&ri->hlist);
1271 kfree(ri);
1272 }
62ce8f40
JO
1273
1274 kprobe_busy_end();
b94cce92 1275}
820aede0 1276NOKPROBE_SYMBOL(kprobe_flush_task);
b94cce92 1277
b94cce92
HN
1278static inline void free_rp_inst(struct kretprobe *rp)
1279{
1280 struct kretprobe_instance *ri;
b67bfe0d 1281 struct hlist_node *next;
4c4308cb 1282
b67bfe0d 1283 hlist_for_each_entry_safe(ri, next, &rp->free_instances, hlist) {
ef53d9c5 1284 hlist_del(&ri->hlist);
b94cce92
HN
1285 kfree(ri);
1286 }
1287}
1288
820aede0 1289static void cleanup_rp_inst(struct kretprobe *rp)
4a296e07 1290{
ef53d9c5 1291 unsigned long flags, hash;
4a296e07 1292 struct kretprobe_instance *ri;
b67bfe0d 1293 struct hlist_node *next;
ef53d9c5
S
1294 struct hlist_head *head;
1295
4a296e07 1296 /* No race here */
ef53d9c5
S
1297 for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
1298 kretprobe_table_lock(hash, &flags);
1299 head = &kretprobe_inst_table[hash];
b67bfe0d 1300 hlist_for_each_entry_safe(ri, next, head, hlist) {
ef53d9c5
S
1301 if (ri->rp == rp)
1302 ri->rp = NULL;
1303 }
1304 kretprobe_table_unlock(hash, &flags);
4a296e07 1305 }
4a296e07
MH
1306 free_rp_inst(rp);
1307}
820aede0 1308NOKPROBE_SYMBOL(cleanup_rp_inst);
4a296e07 1309
8b0914ea 1310/*
b918e5e6 1311* Add the new probe to ap->list. Fail if this is the
8b0914ea
PP
1312* second jprobe at the address - two jprobes can't coexist
1313*/
55479f64 1314static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
8b0914ea 1315{
de5bd88d 1316 BUG_ON(kprobe_gone(ap) || kprobe_gone(p));
afd66255
MH
1317
1318 if (p->break_handler || p->post_handler)
6274de49 1319 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
afd66255 1320
8b0914ea 1321 if (p->break_handler) {
b918e5e6 1322 if (ap->break_handler)
36721656 1323 return -EEXIST;
b918e5e6
MH
1324 list_add_tail_rcu(&p->list, &ap->list);
1325 ap->break_handler = aggr_break_handler;
8b0914ea 1326 } else
b918e5e6
MH
1327 list_add_rcu(&p->list, &ap->list);
1328 if (p->post_handler && !ap->post_handler)
1329 ap->post_handler = aggr_post_handler;
de5bd88d 1330
8b0914ea
PP
1331 return 0;
1332}
1333
64f562c6
AM
1334/*
1335 * Fill in the required fields of the "manager kprobe". Replace the
1336 * earlier kprobe in the hlist with the manager kprobe
1337 */
55479f64 1338static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
64f562c6 1339{
afd66255 1340 /* Copy p's insn slot to ap */
8b0914ea 1341 copy_kprobe(p, ap);
a9ad965e 1342 flush_insn_slot(ap);
64f562c6 1343 ap->addr = p->addr;
afd66255 1344 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
64f562c6 1345 ap->pre_handler = aggr_pre_handler;
64f562c6 1346 ap->fault_handler = aggr_fault_handler;
e8386a0c
MH
1347 /* We don't care the kprobe which has gone. */
1348 if (p->post_handler && !kprobe_gone(p))
36721656 1349 ap->post_handler = aggr_post_handler;
e8386a0c 1350 if (p->break_handler && !kprobe_gone(p))
36721656 1351 ap->break_handler = aggr_break_handler;
64f562c6
AM
1352
1353 INIT_LIST_HEAD(&ap->list);
afd66255 1354 INIT_HLIST_NODE(&ap->hlist);
64f562c6 1355
afd66255 1356 list_add_rcu(&p->list, &ap->list);
adad0f33 1357 hlist_replace_rcu(&p->hlist, &ap->hlist);
64f562c6
AM
1358}
1359
1360/*
1361 * This is the second or subsequent kprobe at the address - handle
1362 * the intricacies
64f562c6 1363 */
55479f64 1364static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
64f562c6
AM
1365{
1366 int ret = 0;
6d8e40a8 1367 struct kprobe *ap = orig_p;
64f562c6 1368
2d1e38f5
TG
1369 cpus_read_lock();
1370
25764288
MH
1371 /* For preparing optimization, jump_label_text_reserved() is called */
1372 jump_label_lock();
25764288
MH
1373 mutex_lock(&text_mutex);
1374
6d8e40a8
MH
1375 if (!kprobe_aggrprobe(orig_p)) {
1376 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1377 ap = alloc_aggr_kprobe(orig_p);
25764288
MH
1378 if (!ap) {
1379 ret = -ENOMEM;
1380 goto out;
1381 }
6d8e40a8 1382 init_aggr_kprobe(ap, orig_p);
0e0b860f 1383 } else if (kprobe_unused(ap)) {
0490cd1f 1384 /* This probe is going to die. Rescue it */
0e0b860f
MH
1385 ret = reuse_unused_kprobe(ap);
1386 if (ret)
1387 goto out;
1388 }
b918e5e6
MH
1389
1390 if (kprobe_gone(ap)) {
e8386a0c
MH
1391 /*
1392 * Attempting to insert new probe at the same location that
1393 * had a probe in the module vaddr area which already
1394 * freed. So, the instruction slot has already been
1395 * released. We need a new slot for the new probe.
1396 */
b918e5e6 1397 ret = arch_prepare_kprobe(ap);
e8386a0c 1398 if (ret)
b918e5e6
MH
1399 /*
1400 * Even if fail to allocate new slot, don't need to
1401 * free aggr_probe. It will be used next time, or
1402 * freed by unregister_kprobe.
1403 */
25764288 1404 goto out;
de5bd88d 1405
afd66255
MH
1406 /* Prepare optimized instructions if possible. */
1407 prepare_optimized_kprobe(ap);
1408
e8386a0c 1409 /*
de5bd88d
MH
1410 * Clear gone flag to prevent allocating new slot again, and
1411 * set disabled flag because it is not armed yet.
e8386a0c 1412 */
de5bd88d
MH
1413 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1414 | KPROBE_FLAG_DISABLED;
e8386a0c 1415 }
b918e5e6 1416
afd66255 1417 /* Copy ap's insn slot to p */
b918e5e6 1418 copy_kprobe(ap, p);
25764288
MH
1419 ret = add_new_kprobe(ap, p);
1420
1421out:
1422 mutex_unlock(&text_mutex);
25764288 1423 jump_label_unlock();
2d1e38f5 1424 cpus_read_unlock();
25764288
MH
1425
1426 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1427 ap->flags &= ~KPROBE_FLAG_DISABLED;
1428 if (!kprobes_all_disarmed)
1429 /* Arm the breakpoint again. */
1430 arm_kprobe(ap);
1431 }
1432 return ret;
64f562c6
AM
1433}
1434
be8f2743
MH
1435bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1436{
1437 /* The __kprobes marked functions and entry code must not be probed */
1438 return addr >= (unsigned long)__kprobes_text_start &&
1439 addr < (unsigned long)__kprobes_text_end;
1440}
1441
e5779e8e 1442bool within_kprobe_blacklist(unsigned long addr)
d0aaff97 1443{
376e2424 1444 struct kprobe_blacklist_entry *ent;
3d8d996e 1445
be8f2743 1446 if (arch_within_kprobe_blacklist(addr))
376e2424 1447 return true;
3d8d996e
SD
1448 /*
1449 * If there exists a kprobe_blacklist, verify and
1450 * fail any probe registration in the prohibited area
1451 */
376e2424
MH
1452 list_for_each_entry(ent, &kprobe_blacklist, list) {
1453 if (addr >= ent->start_addr && addr < ent->end_addr)
1454 return true;
3d8d996e 1455 }
376e2424
MH
1456
1457 return false;
d0aaff97
PP
1458}
1459
b2a5cd69
MH
1460/*
1461 * If we have a symbol_name argument, look it up and add the offset field
1462 * to it. This way, we can specify a relative address to a symbol.
bc81d48d
MH
1463 * This returns encoded errors if it fails to look up symbol or invalid
1464 * combination of parameters.
b2a5cd69 1465 */
1d585e70
NR
1466static kprobe_opcode_t *_kprobe_addr(kprobe_opcode_t *addr,
1467 const char *symbol_name, unsigned int offset)
b2a5cd69 1468{
1d585e70 1469 if ((symbol_name && addr) || (!symbol_name && !addr))
bc81d48d
MH
1470 goto invalid;
1471
1d585e70 1472 if (symbol_name) {
7246f600 1473 addr = kprobe_lookup_name(symbol_name, offset);
bc81d48d
MH
1474 if (!addr)
1475 return ERR_PTR(-ENOENT);
b2a5cd69
MH
1476 }
1477
1d585e70 1478 addr = (kprobe_opcode_t *)(((char *)addr) + offset);
bc81d48d
MH
1479 if (addr)
1480 return addr;
1481
1482invalid:
1483 return ERR_PTR(-EINVAL);
b2a5cd69
MH
1484}
1485
1d585e70
NR
1486static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
1487{
1488 return _kprobe_addr(p->addr, p->symbol_name, p->offset);
1489}
1490
1f0ab409 1491/* Check passed kprobe is valid and return kprobe in kprobe_table. */
55479f64 1492static struct kprobe *__get_valid_kprobe(struct kprobe *p)
1f0ab409 1493{
6d8e40a8 1494 struct kprobe *ap, *list_p;
1f0ab409 1495
6d8e40a8
MH
1496 ap = get_kprobe(p->addr);
1497 if (unlikely(!ap))
1f0ab409
AM
1498 return NULL;
1499
6d8e40a8
MH
1500 if (p != ap) {
1501 list_for_each_entry_rcu(list_p, &ap->list, list)
1f0ab409
AM
1502 if (list_p == p)
1503 /* kprobe p is a valid probe */
1504 goto valid;
1505 return NULL;
1506 }
1507valid:
6d8e40a8 1508 return ap;
1f0ab409
AM
1509}
1510
1511/* Return error if the kprobe is being re-registered */
1512static inline int check_kprobe_rereg(struct kprobe *p)
1513{
1514 int ret = 0;
1f0ab409
AM
1515
1516 mutex_lock(&kprobe_mutex);
6d8e40a8 1517 if (__get_valid_kprobe(p))
1f0ab409
AM
1518 ret = -EINVAL;
1519 mutex_unlock(&kprobe_mutex);
6d8e40a8 1520
1f0ab409
AM
1521 return ret;
1522}
1523
f7f242ff 1524int __weak arch_check_ftrace_location(struct kprobe *p)
1da177e4 1525{
ae6aa16f
MH
1526 unsigned long ftrace_addr;
1527
ae6aa16f
MH
1528 ftrace_addr = ftrace_location((unsigned long)p->addr);
1529 if (ftrace_addr) {
e7dbfe34 1530#ifdef CONFIG_KPROBES_ON_FTRACE
ae6aa16f
MH
1531 /* Given address is not on the instruction boundary */
1532 if ((unsigned long)p->addr != ftrace_addr)
1533 return -EILSEQ;
ae6aa16f 1534 p->flags |= KPROBE_FLAG_FTRACE;
e7dbfe34 1535#else /* !CONFIG_KPROBES_ON_FTRACE */
ae6aa16f
MH
1536 return -EINVAL;
1537#endif
1538 }
f7f242ff
HC
1539 return 0;
1540}
1541
1542static int check_kprobe_address_safe(struct kprobe *p,
1543 struct module **probed_mod)
1544{
1545 int ret;
1f0ab409 1546
f7f242ff
HC
1547 ret = arch_check_ftrace_location(p);
1548 if (ret)
1549 return ret;
91bad2f8 1550 jump_label_lock();
de31c3ca 1551 preempt_disable();
f7fa6ef0
MH
1552
1553 /* Ensure it is not in reserved area nor out of text */
ec30c5f3 1554 if (!kernel_text_address((unsigned long) p->addr) ||
376e2424 1555 within_kprobe_blacklist((unsigned long) p->addr) ||
05fade62
MH
1556 jump_label_text_reserved(p->addr, p->addr) ||
1557 find_bug((unsigned long)p->addr)) {
f986a499 1558 ret = -EINVAL;
f7fa6ef0 1559 goto out;
f986a499 1560 }
b3e55c72 1561
f7fa6ef0
MH
1562 /* Check if are we probing a module */
1563 *probed_mod = __module_text_address((unsigned long) p->addr);
1564 if (*probed_mod) {
6f716acd 1565 /*
e8386a0c
MH
1566 * We must hold a refcount of the probed module while updating
1567 * its code to prohibit unexpected unloading.
df019b1d 1568 */
f7fa6ef0
MH
1569 if (unlikely(!try_module_get(*probed_mod))) {
1570 ret = -ENOENT;
1571 goto out;
1572 }
de31c3ca 1573
f24659d9
MH
1574 /*
1575 * If the module freed .init.text, we couldn't insert
1576 * kprobes in there.
1577 */
f7fa6ef0
MH
1578 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1579 (*probed_mod)->state != MODULE_STATE_COMING) {
1580 module_put(*probed_mod);
1581 *probed_mod = NULL;
1582 ret = -ENOENT;
f24659d9 1583 }
df019b1d 1584 }
f7fa6ef0 1585out:
a189d035 1586 preempt_enable();
de31c3ca 1587 jump_label_unlock();
1da177e4 1588
f7fa6ef0
MH
1589 return ret;
1590}
1591
55479f64 1592int register_kprobe(struct kprobe *p)
f7fa6ef0
MH
1593{
1594 int ret;
1595 struct kprobe *old_p;
1596 struct module *probed_mod;
1597 kprobe_opcode_t *addr;
1598
1599 /* Adjust probe address from symbol */
1600 addr = kprobe_addr(p);
1601 if (IS_ERR(addr))
1602 return PTR_ERR(addr);
1603 p->addr = addr;
1604
1605 ret = check_kprobe_rereg(p);
1606 if (ret)
1607 return ret;
1608
1609 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1610 p->flags &= KPROBE_FLAG_DISABLED;
3516a460 1611 p->nmissed = 0;
9861668f 1612 INIT_LIST_HEAD(&p->list);
afd66255 1613
f7fa6ef0
MH
1614 ret = check_kprobe_address_safe(p, &probed_mod);
1615 if (ret)
1616 return ret;
1617
1618 mutex_lock(&kprobe_mutex);
afd66255 1619
64f562c6
AM
1620 old_p = get_kprobe(p->addr);
1621 if (old_p) {
afd66255 1622 /* Since this may unoptimize old_p, locking text_mutex. */
64f562c6 1623 ret = register_aggr_kprobe(old_p, p);
1da177e4
LT
1624 goto out;
1625 }
1da177e4 1626
2d1e38f5
TG
1627 cpus_read_lock();
1628 /* Prevent text modification */
1629 mutex_lock(&text_mutex);
ae6aa16f 1630 ret = prepare_kprobe(p);
25764288 1631 mutex_unlock(&text_mutex);
2d1e38f5 1632 cpus_read_unlock();
6f716acd 1633 if (ret)
afd66255 1634 goto out;
49a2a1b8 1635
64f562c6 1636 INIT_HLIST_NODE(&p->hlist);
3516a460 1637 hlist_add_head_rcu(&p->hlist,
1da177e4
LT
1638 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1639
de5bd88d 1640 if (!kprobes_all_disarmed && !kprobe_disabled(p))
25764288 1641 arm_kprobe(p);
afd66255
MH
1642
1643 /* Try to optimize kprobe */
1644 try_to_optimize_kprobe(p);
1da177e4 1645out:
7a7d1cf9 1646 mutex_unlock(&kprobe_mutex);
49a2a1b8 1647
e8386a0c 1648 if (probed_mod)
df019b1d 1649 module_put(probed_mod);
e8386a0c 1650
1da177e4
LT
1651 return ret;
1652}
99081ab5 1653EXPORT_SYMBOL_GPL(register_kprobe);
1da177e4 1654
6f0f1dd7 1655/* Check if all probes on the aggrprobe are disabled */
55479f64 1656static int aggr_kprobe_disabled(struct kprobe *ap)
6f0f1dd7
MH
1657{
1658 struct kprobe *kp;
1659
1660 list_for_each_entry_rcu(kp, &ap->list, list)
1661 if (!kprobe_disabled(kp))
1662 /*
1663 * There is an active probe on the list.
1664 * We can't disable this ap.
1665 */
1666 return 0;
1667
1668 return 1;
1669}
1670
1671/* Disable one kprobe: Make sure called under kprobe_mutex is locked */
55479f64 1672static struct kprobe *__disable_kprobe(struct kprobe *p)
6f0f1dd7
MH
1673{
1674 struct kprobe *orig_p;
1675
1676 /* Get an original kprobe for return */
1677 orig_p = __get_valid_kprobe(p);
1678 if (unlikely(orig_p == NULL))
1679 return NULL;
1680
1681 if (!kprobe_disabled(p)) {
1682 /* Disable probe if it is a child probe */
1683 if (p != orig_p)
1684 p->flags |= KPROBE_FLAG_DISABLED;
1685
1686 /* Try to disarm and disable this/parent probe */
1687 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
69d54b91
WN
1688 /*
1689 * If kprobes_all_disarmed is set, orig_p
1690 * should have already been disarmed, so
1691 * skip unneed disarming process.
1692 */
1693 if (!kprobes_all_disarmed)
1694 disarm_kprobe(orig_p, true);
6f0f1dd7
MH
1695 orig_p->flags |= KPROBE_FLAG_DISABLED;
1696 }
1697 }
1698
1699 return orig_p;
1700}
1701
de5bd88d
MH
1702/*
1703 * Unregister a kprobe without a scheduler synchronization.
1704 */
55479f64 1705static int __unregister_kprobe_top(struct kprobe *p)
de5bd88d 1706{
6d8e40a8 1707 struct kprobe *ap, *list_p;
de5bd88d 1708
6f0f1dd7
MH
1709 /* Disable kprobe. This will disarm it if needed. */
1710 ap = __disable_kprobe(p);
6d8e40a8 1711 if (ap == NULL)
de5bd88d
MH
1712 return -EINVAL;
1713
6f0f1dd7 1714 if (ap == p)
bf8f6e5b 1715 /*
6f0f1dd7
MH
1716 * This probe is an independent(and non-optimized) kprobe
1717 * (not an aggrprobe). Remove from the hash list.
bf8f6e5b 1718 */
6f0f1dd7
MH
1719 goto disarmed;
1720
1721 /* Following process expects this probe is an aggrprobe */
1722 WARN_ON(!kprobe_aggrprobe(ap));
1723
6274de49
MH
1724 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1725 /*
1726 * !disarmed could be happen if the probe is under delayed
1727 * unoptimizing.
1728 */
6f0f1dd7
MH
1729 goto disarmed;
1730 else {
1731 /* If disabling probe has special handlers, update aggrprobe */
e8386a0c 1732 if (p->break_handler && !kprobe_gone(p))
6d8e40a8 1733 ap->break_handler = NULL;
e8386a0c 1734 if (p->post_handler && !kprobe_gone(p)) {
6d8e40a8 1735 list_for_each_entry_rcu(list_p, &ap->list, list) {
9861668f
MH
1736 if ((list_p != p) && (list_p->post_handler))
1737 goto noclean;
1738 }
6d8e40a8 1739 ap->post_handler = NULL;
9861668f
MH
1740 }
1741noclean:
6f0f1dd7
MH
1742 /*
1743 * Remove from the aggrprobe: this path will do nothing in
1744 * __unregister_kprobe_bottom().
1745 */
49a2a1b8 1746 list_del_rcu(&p->list);
6f0f1dd7
MH
1747 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1748 /*
1749 * Try to optimize this probe again, because post
1750 * handler may have been changed.
1751 */
1752 optimize_kprobe(ap);
49a2a1b8 1753 }
9861668f 1754 return 0;
6f0f1dd7
MH
1755
1756disarmed:
6274de49 1757 BUG_ON(!kprobe_disarmed(ap));
6f0f1dd7
MH
1758 hlist_del_rcu(&ap->hlist);
1759 return 0;
9861668f 1760}
3516a460 1761
55479f64 1762static void __unregister_kprobe_bottom(struct kprobe *p)
9861668f 1763{
6d8e40a8 1764 struct kprobe *ap;
b3e55c72 1765
e8386a0c 1766 if (list_empty(&p->list))
6274de49 1767 /* This is an independent kprobe */
0498b635 1768 arch_remove_kprobe(p);
e8386a0c 1769 else if (list_is_singular(&p->list)) {
6274de49 1770 /* This is the last child of an aggrprobe */
6d8e40a8 1771 ap = list_entry(p->list.next, struct kprobe, list);
e8386a0c 1772 list_del(&p->list);
6d8e40a8 1773 free_aggr_kprobe(ap);
9861668f 1774 }
6274de49 1775 /* Otherwise, do nothing. */
9861668f
MH
1776}
1777
55479f64 1778int register_kprobes(struct kprobe **kps, int num)
9861668f
MH
1779{
1780 int i, ret = 0;
1781
1782 if (num <= 0)
1783 return -EINVAL;
1784 for (i = 0; i < num; i++) {
49ad2fd7 1785 ret = register_kprobe(kps[i]);
67dddaad
MH
1786 if (ret < 0) {
1787 if (i > 0)
1788 unregister_kprobes(kps, i);
9861668f 1789 break;
36721656 1790 }
49a2a1b8 1791 }
9861668f
MH
1792 return ret;
1793}
99081ab5 1794EXPORT_SYMBOL_GPL(register_kprobes);
9861668f 1795
55479f64 1796void unregister_kprobe(struct kprobe *p)
9861668f
MH
1797{
1798 unregister_kprobes(&p, 1);
1799}
99081ab5 1800EXPORT_SYMBOL_GPL(unregister_kprobe);
9861668f 1801
55479f64 1802void unregister_kprobes(struct kprobe **kps, int num)
9861668f
MH
1803{
1804 int i;
1805
1806 if (num <= 0)
1807 return;
1808 mutex_lock(&kprobe_mutex);
1809 for (i = 0; i < num; i++)
1810 if (__unregister_kprobe_top(kps[i]) < 0)
1811 kps[i]->addr = NULL;
1812 mutex_unlock(&kprobe_mutex);
1813
1814 synchronize_sched();
1815 for (i = 0; i < num; i++)
1816 if (kps[i]->addr)
1817 __unregister_kprobe_bottom(kps[i]);
1da177e4 1818}
99081ab5 1819EXPORT_SYMBOL_GPL(unregister_kprobes);
1da177e4 1820
5f6bee34
NR
1821int __weak kprobe_exceptions_notify(struct notifier_block *self,
1822 unsigned long val, void *data)
fc62d020
NR
1823{
1824 return NOTIFY_DONE;
1825}
5f6bee34 1826NOKPROBE_SYMBOL(kprobe_exceptions_notify);
fc62d020 1827
1da177e4 1828static struct notifier_block kprobe_exceptions_nb = {
3d5631e0
AK
1829 .notifier_call = kprobe_exceptions_notify,
1830 .priority = 0x7fffffff /* we need to be notified first */
1831};
1832
3d7e3382
ME
1833unsigned long __weak arch_deref_entry_point(void *entry)
1834{
1835 return (unsigned long)entry;
1836}
1da177e4 1837
55479f64 1838int register_jprobes(struct jprobe **jps, int num)
1da177e4 1839{
26b31c19 1840 int ret = 0, i;
3d7e3382 1841
26b31c19 1842 if (num <= 0)
3d7e3382 1843 return -EINVAL;
0f73ff80 1844
26b31c19 1845 for (i = 0; i < num; i++) {
0f73ff80 1846 ret = register_jprobe(jps[i]);
edbaadbe 1847
67dddaad
MH
1848 if (ret < 0) {
1849 if (i > 0)
1850 unregister_jprobes(jps, i);
26b31c19
MH
1851 break;
1852 }
1853 }
0f73ff80 1854
26b31c19
MH
1855 return ret;
1856}
99081ab5 1857EXPORT_SYMBOL_GPL(register_jprobes);
3d7e3382 1858
55479f64 1859int register_jprobe(struct jprobe *jp)
26b31c19 1860{
0f73ff80
NR
1861 unsigned long addr, offset;
1862 struct kprobe *kp = &jp->kp;
1863
dbf58062
NR
1864 /*
1865 * Verify probepoint as well as the jprobe handler are
1866 * valid function entry points.
1867 */
0f73ff80
NR
1868 addr = arch_deref_entry_point(jp->entry);
1869
dbf58062
NR
1870 if (kallsyms_lookup_size_offset(addr, NULL, &offset) && offset == 0 &&
1871 kprobe_on_func_entry(kp->addr, kp->symbol_name, kp->offset)) {
0f73ff80
NR
1872 kp->pre_handler = setjmp_pre_handler;
1873 kp->break_handler = longjmp_break_handler;
1874 return register_kprobe(kp);
1875 }
1876
1877 return -EINVAL;
1da177e4 1878}
99081ab5 1879EXPORT_SYMBOL_GPL(register_jprobe);
1da177e4 1880
55479f64 1881void unregister_jprobe(struct jprobe *jp)
1da177e4 1882{
26b31c19
MH
1883 unregister_jprobes(&jp, 1);
1884}
99081ab5 1885EXPORT_SYMBOL_GPL(unregister_jprobe);
26b31c19 1886
55479f64 1887void unregister_jprobes(struct jprobe **jps, int num)
26b31c19
MH
1888{
1889 int i;
1890
1891 if (num <= 0)
1892 return;
1893 mutex_lock(&kprobe_mutex);
1894 for (i = 0; i < num; i++)
1895 if (__unregister_kprobe_top(&jps[i]->kp) < 0)
1896 jps[i]->kp.addr = NULL;
1897 mutex_unlock(&kprobe_mutex);
1898
1899 synchronize_sched();
1900 for (i = 0; i < num; i++) {
1901 if (jps[i]->kp.addr)
1902 __unregister_kprobe_bottom(&jps[i]->kp);
1903 }
1da177e4 1904}
99081ab5 1905EXPORT_SYMBOL_GPL(unregister_jprobes);
1da177e4 1906
9edddaa2 1907#ifdef CONFIG_KRETPROBES
e65cefe8
AB
1908/*
1909 * This kprobe pre_handler is registered with every kretprobe. When probe
1910 * hits it will set up the return probe.
1911 */
820aede0 1912static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
e65cefe8
AB
1913{
1914 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
ef53d9c5
S
1915 unsigned long hash, flags = 0;
1916 struct kretprobe_instance *ri;
e65cefe8 1917
f96f5678
MH
1918 /*
1919 * To avoid deadlocks, prohibit return probing in NMI contexts,
1920 * just skip the probe and increase the (inexact) 'nmissed'
1921 * statistical counter, so that the user is informed that
1922 * something happened:
1923 */
1924 if (unlikely(in_nmi())) {
1925 rp->nmissed++;
1926 return 0;
1927 }
1928
1929 /* TODO: consider to only swap the RA after the last pre_handler fired */
ef53d9c5 1930 hash = hash_ptr(current, KPROBE_HASH_BITS);
ec484608 1931 raw_spin_lock_irqsave(&rp->lock, flags);
4c4308cb 1932 if (!hlist_empty(&rp->free_instances)) {
4c4308cb 1933 ri = hlist_entry(rp->free_instances.first,
ef53d9c5
S
1934 struct kretprobe_instance, hlist);
1935 hlist_del(&ri->hlist);
ec484608 1936 raw_spin_unlock_irqrestore(&rp->lock, flags);
ef53d9c5 1937
4c4308cb
CH
1938 ri->rp = rp;
1939 ri->task = current;
f47cd9b5 1940
55ca6140
JL
1941 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1942 raw_spin_lock_irqsave(&rp->lock, flags);
1943 hlist_add_head(&ri->hlist, &rp->free_instances);
1944 raw_spin_unlock_irqrestore(&rp->lock, flags);
f47cd9b5 1945 return 0;
55ca6140 1946 }
f47cd9b5 1947
4c4308cb
CH
1948 arch_prepare_kretprobe(ri, regs);
1949
1950 /* XXX(hch): why is there no hlist_move_head? */
ef53d9c5
S
1951 INIT_HLIST_NODE(&ri->hlist);
1952 kretprobe_table_lock(hash, &flags);
1953 hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
1954 kretprobe_table_unlock(hash, &flags);
1955 } else {
4c4308cb 1956 rp->nmissed++;
ec484608 1957 raw_spin_unlock_irqrestore(&rp->lock, flags);
ef53d9c5 1958 }
e65cefe8
AB
1959 return 0;
1960}
820aede0 1961NOKPROBE_SYMBOL(pre_handler_kretprobe);
e65cefe8 1962
659b957f 1963bool __weak arch_kprobe_on_func_entry(unsigned long offset)
90ec5e89
NR
1964{
1965 return !offset;
1966}
1967
659b957f 1968bool kprobe_on_func_entry(kprobe_opcode_t *addr, const char *sym, unsigned long offset)
1d585e70
NR
1969{
1970 kprobe_opcode_t *kp_addr = _kprobe_addr(addr, sym, offset);
1971
1972 if (IS_ERR(kp_addr))
1973 return false;
1974
1975 if (!kallsyms_lookup_size_offset((unsigned long)kp_addr, NULL, &offset) ||
659b957f 1976 !arch_kprobe_on_func_entry(offset))
1d585e70
NR
1977 return false;
1978
1979 return true;
1980}
1981
55479f64 1982int register_kretprobe(struct kretprobe *rp)
b94cce92
HN
1983{
1984 int ret = 0;
1985 struct kretprobe_instance *inst;
1986 int i;
b2a5cd69 1987 void *addr;
90ec5e89 1988
659b957f 1989 if (!kprobe_on_func_entry(rp->kp.addr, rp->kp.symbol_name, rp->kp.offset))
90ec5e89 1990 return -EINVAL;
f438d914
MH
1991
1992 if (kretprobe_blacklist_size) {
b2a5cd69 1993 addr = kprobe_addr(&rp->kp);
bc81d48d
MH
1994 if (IS_ERR(addr))
1995 return PTR_ERR(addr);
f438d914
MH
1996
1997 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1998 if (kretprobe_blacklist[i].addr == addr)
1999 return -EINVAL;
2000 }
2001 }
b94cce92
HN
2002
2003 rp->kp.pre_handler = pre_handler_kretprobe;
7522a842
AM
2004 rp->kp.post_handler = NULL;
2005 rp->kp.fault_handler = NULL;
2006 rp->kp.break_handler = NULL;
b94cce92
HN
2007
2008 /* Pre-allocate memory for max kretprobe instances */
2009 if (rp->maxactive <= 0) {
2010#ifdef CONFIG_PREEMPT
c2ef6661 2011 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
b94cce92 2012#else
4dae560f 2013 rp->maxactive = num_possible_cpus();
b94cce92
HN
2014#endif
2015 }
ec484608 2016 raw_spin_lock_init(&rp->lock);
b94cce92
HN
2017 INIT_HLIST_HEAD(&rp->free_instances);
2018 for (i = 0; i < rp->maxactive; i++) {
f47cd9b5
AS
2019 inst = kmalloc(sizeof(struct kretprobe_instance) +
2020 rp->data_size, GFP_KERNEL);
b94cce92
HN
2021 if (inst == NULL) {
2022 free_rp_inst(rp);
2023 return -ENOMEM;
2024 }
ef53d9c5
S
2025 INIT_HLIST_NODE(&inst->hlist);
2026 hlist_add_head(&inst->hlist, &rp->free_instances);
b94cce92
HN
2027 }
2028
2029 rp->nmissed = 0;
2030 /* Establish function entry probe point */
49ad2fd7 2031 ret = register_kprobe(&rp->kp);
4a296e07 2032 if (ret != 0)
b94cce92
HN
2033 free_rp_inst(rp);
2034 return ret;
2035}
99081ab5 2036EXPORT_SYMBOL_GPL(register_kretprobe);
b94cce92 2037
55479f64 2038int register_kretprobes(struct kretprobe **rps, int num)
4a296e07
MH
2039{
2040 int ret = 0, i;
2041
2042 if (num <= 0)
2043 return -EINVAL;
2044 for (i = 0; i < num; i++) {
49ad2fd7 2045 ret = register_kretprobe(rps[i]);
67dddaad
MH
2046 if (ret < 0) {
2047 if (i > 0)
2048 unregister_kretprobes(rps, i);
4a296e07
MH
2049 break;
2050 }
2051 }
2052 return ret;
2053}
99081ab5 2054EXPORT_SYMBOL_GPL(register_kretprobes);
4a296e07 2055
55479f64 2056void unregister_kretprobe(struct kretprobe *rp)
4a296e07
MH
2057{
2058 unregister_kretprobes(&rp, 1);
2059}
99081ab5 2060EXPORT_SYMBOL_GPL(unregister_kretprobe);
4a296e07 2061
55479f64 2062void unregister_kretprobes(struct kretprobe **rps, int num)
4a296e07
MH
2063{
2064 int i;
2065
2066 if (num <= 0)
2067 return;
2068 mutex_lock(&kprobe_mutex);
2069 for (i = 0; i < num; i++)
2070 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
2071 rps[i]->kp.addr = NULL;
2072 mutex_unlock(&kprobe_mutex);
2073
2074 synchronize_sched();
2075 for (i = 0; i < num; i++) {
2076 if (rps[i]->kp.addr) {
2077 __unregister_kprobe_bottom(&rps[i]->kp);
2078 cleanup_rp_inst(rps[i]);
2079 }
2080 }
2081}
99081ab5 2082EXPORT_SYMBOL_GPL(unregister_kretprobes);
4a296e07 2083
9edddaa2 2084#else /* CONFIG_KRETPROBES */
55479f64 2085int register_kretprobe(struct kretprobe *rp)
b94cce92
HN
2086{
2087 return -ENOSYS;
2088}
99081ab5 2089EXPORT_SYMBOL_GPL(register_kretprobe);
b94cce92 2090
55479f64 2091int register_kretprobes(struct kretprobe **rps, int num)
346fd59b 2092{
4a296e07 2093 return -ENOSYS;
346fd59b 2094}
99081ab5
MH
2095EXPORT_SYMBOL_GPL(register_kretprobes);
2096
55479f64 2097void unregister_kretprobe(struct kretprobe *rp)
b94cce92 2098{
4a296e07 2099}
99081ab5 2100EXPORT_SYMBOL_GPL(unregister_kretprobe);
b94cce92 2101
55479f64 2102void unregister_kretprobes(struct kretprobe **rps, int num)
4a296e07
MH
2103{
2104}
99081ab5 2105EXPORT_SYMBOL_GPL(unregister_kretprobes);
4c4308cb 2106
820aede0 2107static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
4a296e07
MH
2108{
2109 return 0;
b94cce92 2110}
820aede0 2111NOKPROBE_SYMBOL(pre_handler_kretprobe);
b94cce92 2112
4a296e07
MH
2113#endif /* CONFIG_KRETPROBES */
2114
e8386a0c 2115/* Set the kprobe gone and remove its instruction buffer. */
55479f64 2116static void kill_kprobe(struct kprobe *p)
e8386a0c
MH
2117{
2118 struct kprobe *kp;
de5bd88d 2119
e8386a0c 2120 p->flags |= KPROBE_FLAG_GONE;
afd66255 2121 if (kprobe_aggrprobe(p)) {
e8386a0c
MH
2122 /*
2123 * If this is an aggr_kprobe, we have to list all the
2124 * chained probes and mark them GONE.
2125 */
2126 list_for_each_entry_rcu(kp, &p->list, list)
2127 kp->flags |= KPROBE_FLAG_GONE;
2128 p->post_handler = NULL;
2129 p->break_handler = NULL;
afd66255 2130 kill_optimized_kprobe(p);
e8386a0c
MH
2131 }
2132 /*
2133 * Here, we can remove insn_slot safely, because no thread calls
2134 * the original probed function (which will be freed soon) any more.
2135 */
2136 arch_remove_kprobe(p);
afd39cba
MS
2137
2138 /*
2139 * The module is going away. We should disarm the kprobe which
2140 * is using ftrace.
2141 */
2142 if (kprobe_ftrace(p))
2143 disarm_kprobe_ftrace(p);
e8386a0c
MH
2144}
2145
c0614829 2146/* Disable one kprobe */
55479f64 2147int disable_kprobe(struct kprobe *kp)
c0614829
MH
2148{
2149 int ret = 0;
c0614829
MH
2150
2151 mutex_lock(&kprobe_mutex);
2152
6f0f1dd7
MH
2153 /* Disable this kprobe */
2154 if (__disable_kprobe(kp) == NULL)
c0614829 2155 ret = -EINVAL;
c0614829 2156
c0614829
MH
2157 mutex_unlock(&kprobe_mutex);
2158 return ret;
2159}
2160EXPORT_SYMBOL_GPL(disable_kprobe);
2161
2162/* Enable one kprobe */
55479f64 2163int enable_kprobe(struct kprobe *kp)
c0614829
MH
2164{
2165 int ret = 0;
2166 struct kprobe *p;
2167
2168 mutex_lock(&kprobe_mutex);
2169
2170 /* Check whether specified probe is valid. */
2171 p = __get_valid_kprobe(kp);
2172 if (unlikely(p == NULL)) {
2173 ret = -EINVAL;
2174 goto out;
2175 }
2176
2177 if (kprobe_gone(kp)) {
2178 /* This kprobe has gone, we couldn't enable it. */
2179 ret = -EINVAL;
2180 goto out;
2181 }
2182
2183 if (p != kp)
2184 kp->flags &= ~KPROBE_FLAG_DISABLED;
2185
2186 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2187 p->flags &= ~KPROBE_FLAG_DISABLED;
2188 arm_kprobe(p);
2189 }
2190out:
2191 mutex_unlock(&kprobe_mutex);
2192 return ret;
2193}
2194EXPORT_SYMBOL_GPL(enable_kprobe);
2195
820aede0 2196void dump_kprobe(struct kprobe *kp)
24851d24
FW
2197{
2198 printk(KERN_WARNING "Dumping kprobe:\n");
2199 printk(KERN_WARNING "Name: %s\nAddress: %p\nOffset: %x\n",
2200 kp->symbol_name, kp->addr, kp->offset);
2201}
820aede0 2202NOKPROBE_SYMBOL(dump_kprobe);
24851d24 2203
376e2424
MH
2204/*
2205 * Lookup and populate the kprobe_blacklist.
2206 *
2207 * Unlike the kretprobe blacklist, we'll need to determine
2208 * the range of addresses that belong to the said functions,
2209 * since a kprobe need not necessarily be at the beginning
2210 * of a function.
2211 */
2212static int __init populate_kprobe_blacklist(unsigned long *start,
2213 unsigned long *end)
2214{
2215 unsigned long *iter;
2216 struct kprobe_blacklist_entry *ent;
d81b4253 2217 unsigned long entry, offset = 0, size = 0;
376e2424
MH
2218
2219 for (iter = start; iter < end; iter++) {
d81b4253
MH
2220 entry = arch_deref_entry_point((void *)*iter);
2221
2222 if (!kernel_text_address(entry) ||
2223 !kallsyms_lookup_size_offset(entry, &size, &offset)) {
2224 pr_err("Failed to find blacklist at %p\n",
2225 (void *)entry);
376e2424
MH
2226 continue;
2227 }
2228
2229 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2230 if (!ent)
2231 return -ENOMEM;
d81b4253
MH
2232 ent->start_addr = entry;
2233 ent->end_addr = entry + size;
376e2424
MH
2234 INIT_LIST_HEAD(&ent->list);
2235 list_add_tail(&ent->list, &kprobe_blacklist);
2236 }
2237 return 0;
2238}
2239
e8386a0c 2240/* Module notifier call back, checking kprobes on the module */
55479f64
MH
2241static int kprobes_module_callback(struct notifier_block *nb,
2242 unsigned long val, void *data)
e8386a0c
MH
2243{
2244 struct module *mod = data;
2245 struct hlist_head *head;
e8386a0c
MH
2246 struct kprobe *p;
2247 unsigned int i;
f24659d9 2248 int checkcore = (val == MODULE_STATE_GOING);
e8386a0c 2249
f24659d9 2250 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
e8386a0c
MH
2251 return NOTIFY_DONE;
2252
2253 /*
f24659d9
MH
2254 * When MODULE_STATE_GOING was notified, both of module .text and
2255 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2256 * notified, only .init.text section would be freed. We need to
2257 * disable kprobes which have been inserted in the sections.
e8386a0c
MH
2258 */
2259 mutex_lock(&kprobe_mutex);
2260 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2261 head = &kprobe_table[i];
b67bfe0d 2262 hlist_for_each_entry_rcu(p, head, hlist)
f24659d9
MH
2263 if (within_module_init((unsigned long)p->addr, mod) ||
2264 (checkcore &&
2265 within_module_core((unsigned long)p->addr, mod))) {
e8386a0c
MH
2266 /*
2267 * The vaddr this probe is installed will soon
2268 * be vfreed buy not synced to disk. Hence,
2269 * disarming the breakpoint isn't needed.
545a0281
SRV
2270 *
2271 * Note, this will also move any optimized probes
2272 * that are pending to be removed from their
2273 * corresponding lists to the freeing_list and
2274 * will not be touched by the delayed
2275 * kprobe_optimizer work handler.
e8386a0c
MH
2276 */
2277 kill_kprobe(p);
2278 }
2279 }
2280 mutex_unlock(&kprobe_mutex);
2281 return NOTIFY_DONE;
2282}
2283
2284static struct notifier_block kprobe_module_nb = {
2285 .notifier_call = kprobes_module_callback,
2286 .priority = 0
2287};
2288
376e2424
MH
2289/* Markers of _kprobe_blacklist section */
2290extern unsigned long __start_kprobe_blacklist[];
2291extern unsigned long __stop_kprobe_blacklist[];
2292
1da177e4
LT
2293static int __init init_kprobes(void)
2294{
2295 int i, err = 0;
2296
2297 /* FIXME allocate the probe table, currently defined statically */
2298 /* initialize all list heads */
b94cce92 2299 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
1da177e4 2300 INIT_HLIST_HEAD(&kprobe_table[i]);
b94cce92 2301 INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
ec484608 2302 raw_spin_lock_init(&(kretprobe_table_locks[i].lock));
b94cce92 2303 }
1da177e4 2304
376e2424
MH
2305 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2306 __stop_kprobe_blacklist);
2307 if (err) {
2308 pr_err("kprobes: failed to populate blacklist: %d\n", err);
2309 pr_err("Please take care of using kprobes.\n");
3d8d996e
SD
2310 }
2311
f438d914
MH
2312 if (kretprobe_blacklist_size) {
2313 /* lookup the function address from its name */
2314 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
49e0b465 2315 kretprobe_blacklist[i].addr =
290e3070 2316 kprobe_lookup_name(kretprobe_blacklist[i].name, 0);
f438d914
MH
2317 if (!kretprobe_blacklist[i].addr)
2318 printk("kretprobe: lookup failed: %s\n",
2319 kretprobe_blacklist[i].name);
2320 }
2321 }
2322
b2be84df
MH
2323#if defined(CONFIG_OPTPROBES)
2324#if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
afd66255
MH
2325 /* Init kprobe_optinsn_slots */
2326 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2327#endif
b2be84df
MH
2328 /* By default, kprobes can be optimized */
2329 kprobes_allow_optimization = true;
2330#endif
afd66255 2331
e579abeb
MH
2332 /* By default, kprobes are armed */
2333 kprobes_all_disarmed = false;
bf8f6e5b 2334
6772926b 2335 err = arch_init_kprobes();
802eae7c
RL
2336 if (!err)
2337 err = register_die_notifier(&kprobe_exceptions_nb);
e8386a0c
MH
2338 if (!err)
2339 err = register_module_notifier(&kprobe_module_nb);
2340
ef53d9c5 2341 kprobes_initialized = (err == 0);
802eae7c 2342
8c1c9356
AM
2343 if (!err)
2344 init_test_probes();
1da177e4
LT
2345 return err;
2346}
2347
346fd59b 2348#ifdef CONFIG_DEBUG_FS
55479f64 2349static void report_probe(struct seq_file *pi, struct kprobe *p,
afd66255 2350 const char *sym, int offset, char *modname, struct kprobe *pp)
346fd59b
SD
2351{
2352 char *kprobe_type;
2353
2354 if (p->pre_handler == pre_handler_kretprobe)
2355 kprobe_type = "r";
2356 else if (p->pre_handler == setjmp_pre_handler)
2357 kprobe_type = "j";
2358 else
2359 kprobe_type = "k";
afd66255 2360
346fd59b 2361 if (sym)
afd66255 2362 seq_printf(pi, "%p %s %s+0x%x %s ",
de5bd88d 2363 p->addr, kprobe_type, sym, offset,
afd66255 2364 (modname ? modname : " "));
346fd59b 2365 else
afd66255
MH
2366 seq_printf(pi, "%p %s %p ",
2367 p->addr, kprobe_type, p->addr);
2368
2369 if (!pp)
2370 pp = p;
ae6aa16f 2371 seq_printf(pi, "%s%s%s%s\n",
afd66255
MH
2372 (kprobe_gone(p) ? "[GONE]" : ""),
2373 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
ae6aa16f
MH
2374 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2375 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
346fd59b
SD
2376}
2377
55479f64 2378static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
346fd59b
SD
2379{
2380 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2381}
2382
55479f64 2383static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
346fd59b
SD
2384{
2385 (*pos)++;
2386 if (*pos >= KPROBE_TABLE_SIZE)
2387 return NULL;
2388 return pos;
2389}
2390
55479f64 2391static void kprobe_seq_stop(struct seq_file *f, void *v)
346fd59b
SD
2392{
2393 /* Nothing to do */
2394}
2395
55479f64 2396static int show_kprobe_addr(struct seq_file *pi, void *v)
346fd59b
SD
2397{
2398 struct hlist_head *head;
346fd59b
SD
2399 struct kprobe *p, *kp;
2400 const char *sym = NULL;
2401 unsigned int i = *(loff_t *) v;
ffb45122 2402 unsigned long offset = 0;
ab767865 2403 char *modname, namebuf[KSYM_NAME_LEN];
346fd59b
SD
2404
2405 head = &kprobe_table[i];
2406 preempt_disable();
b67bfe0d 2407 hlist_for_each_entry_rcu(p, head, hlist) {
ffb45122 2408 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
346fd59b 2409 &offset, &modname, namebuf);
afd66255 2410 if (kprobe_aggrprobe(p)) {
346fd59b 2411 list_for_each_entry_rcu(kp, &p->list, list)
afd66255 2412 report_probe(pi, kp, sym, offset, modname, p);
346fd59b 2413 } else
afd66255 2414 report_probe(pi, p, sym, offset, modname, NULL);
346fd59b
SD
2415 }
2416 preempt_enable();
2417 return 0;
2418}
2419
88e9d34c 2420static const struct seq_operations kprobes_seq_ops = {
346fd59b
SD
2421 .start = kprobe_seq_start,
2422 .next = kprobe_seq_next,
2423 .stop = kprobe_seq_stop,
2424 .show = show_kprobe_addr
2425};
2426
55479f64 2427static int kprobes_open(struct inode *inode, struct file *filp)
346fd59b
SD
2428{
2429 return seq_open(filp, &kprobes_seq_ops);
2430}
2431
828c0950 2432static const struct file_operations debugfs_kprobes_operations = {
346fd59b
SD
2433 .open = kprobes_open,
2434 .read = seq_read,
2435 .llseek = seq_lseek,
2436 .release = seq_release,
2437};
2438
63724740
MH
2439/* kprobes/blacklist -- shows which functions can not be probed */
2440static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2441{
2442 return seq_list_start(&kprobe_blacklist, *pos);
2443}
2444
2445static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2446{
2447 return seq_list_next(v, &kprobe_blacklist, pos);
2448}
2449
2450static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2451{
2452 struct kprobe_blacklist_entry *ent =
2453 list_entry(v, struct kprobe_blacklist_entry, list);
2454
2455 seq_printf(m, "0x%p-0x%p\t%ps\n", (void *)ent->start_addr,
2456 (void *)ent->end_addr, (void *)ent->start_addr);
2457 return 0;
2458}
2459
2460static const struct seq_operations kprobe_blacklist_seq_ops = {
2461 .start = kprobe_blacklist_seq_start,
2462 .next = kprobe_blacklist_seq_next,
2463 .stop = kprobe_seq_stop, /* Reuse void function */
2464 .show = kprobe_blacklist_seq_show,
2465};
2466
2467static int kprobe_blacklist_open(struct inode *inode, struct file *filp)
2468{
2469 return seq_open(filp, &kprobe_blacklist_seq_ops);
2470}
2471
2472static const struct file_operations debugfs_kprobe_blacklist_ops = {
2473 .open = kprobe_blacklist_open,
2474 .read = seq_read,
2475 .llseek = seq_lseek,
2476 .release = seq_release,
2477};
2478
55479f64 2479static void arm_all_kprobes(void)
bf8f6e5b
AM
2480{
2481 struct hlist_head *head;
bf8f6e5b
AM
2482 struct kprobe *p;
2483 unsigned int i;
2484
2485 mutex_lock(&kprobe_mutex);
2486
e579abeb
MH
2487 /* If kprobes are armed, just return */
2488 if (!kprobes_all_disarmed)
bf8f6e5b
AM
2489 goto already_enabled;
2490
977ad481
WN
2491 /*
2492 * optimize_kprobe() called by arm_kprobe() checks
2493 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2494 * arm_kprobe.
2495 */
2496 kprobes_all_disarmed = false;
afd66255 2497 /* Arming kprobes doesn't optimize kprobe itself */
bf8f6e5b
AM
2498 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2499 head = &kprobe_table[i];
b67bfe0d 2500 hlist_for_each_entry_rcu(p, head, hlist)
de5bd88d 2501 if (!kprobe_disabled(p))
ae6aa16f 2502 arm_kprobe(p);
bf8f6e5b
AM
2503 }
2504
bf8f6e5b
AM
2505 printk(KERN_INFO "Kprobes globally enabled\n");
2506
2507already_enabled:
2508 mutex_unlock(&kprobe_mutex);
2509 return;
2510}
2511
55479f64 2512static void disarm_all_kprobes(void)
bf8f6e5b
AM
2513{
2514 struct hlist_head *head;
bf8f6e5b
AM
2515 struct kprobe *p;
2516 unsigned int i;
2517
2518 mutex_lock(&kprobe_mutex);
2519
e579abeb 2520 /* If kprobes are already disarmed, just return */
6274de49
MH
2521 if (kprobes_all_disarmed) {
2522 mutex_unlock(&kprobe_mutex);
2523 return;
2524 }
bf8f6e5b 2525
e579abeb 2526 kprobes_all_disarmed = true;
bf8f6e5b 2527 printk(KERN_INFO "Kprobes globally disabled\n");
afd66255 2528
bf8f6e5b
AM
2529 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2530 head = &kprobe_table[i];
b67bfe0d 2531 hlist_for_each_entry_rcu(p, head, hlist) {
de5bd88d 2532 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p))
ae6aa16f 2533 disarm_kprobe(p, false);
bf8f6e5b
AM
2534 }
2535 }
bf8f6e5b 2536 mutex_unlock(&kprobe_mutex);
bf8f6e5b 2537
6274de49
MH
2538 /* Wait for disarming all kprobes by optimizer */
2539 wait_for_kprobe_optimizer();
bf8f6e5b
AM
2540}
2541
2542/*
2543 * XXX: The debugfs bool file interface doesn't allow for callbacks
2544 * when the bool state is switched. We can reuse that facility when
2545 * available
2546 */
2547static ssize_t read_enabled_file_bool(struct file *file,
2548 char __user *user_buf, size_t count, loff_t *ppos)
2549{
2550 char buf[3];
2551
e579abeb 2552 if (!kprobes_all_disarmed)
bf8f6e5b
AM
2553 buf[0] = '1';
2554 else
2555 buf[0] = '0';
2556 buf[1] = '\n';
2557 buf[2] = 0x00;
2558 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2559}
2560
2561static ssize_t write_enabled_file_bool(struct file *file,
2562 const char __user *user_buf, size_t count, loff_t *ppos)
2563{
2564 char buf[32];
efeb156e 2565 size_t buf_size;
bf8f6e5b
AM
2566
2567 buf_size = min(count, (sizeof(buf)-1));
2568 if (copy_from_user(buf, user_buf, buf_size))
2569 return -EFAULT;
2570
10fb46d5 2571 buf[buf_size] = '\0';
bf8f6e5b
AM
2572 switch (buf[0]) {
2573 case 'y':
2574 case 'Y':
2575 case '1':
e579abeb 2576 arm_all_kprobes();
bf8f6e5b
AM
2577 break;
2578 case 'n':
2579 case 'N':
2580 case '0':
e579abeb 2581 disarm_all_kprobes();
bf8f6e5b 2582 break;
10fb46d5
MK
2583 default:
2584 return -EINVAL;
bf8f6e5b
AM
2585 }
2586
2587 return count;
2588}
2589
828c0950 2590static const struct file_operations fops_kp = {
bf8f6e5b
AM
2591 .read = read_enabled_file_bool,
2592 .write = write_enabled_file_bool,
6038f373 2593 .llseek = default_llseek,
bf8f6e5b
AM
2594};
2595
55479f64 2596static int __init debugfs_kprobe_init(void)
346fd59b
SD
2597{
2598 struct dentry *dir, *file;
bf8f6e5b 2599 unsigned int value = 1;
346fd59b
SD
2600
2601 dir = debugfs_create_dir("kprobes", NULL);
2602 if (!dir)
2603 return -ENOMEM;
2604
4bdf9c17 2605 file = debugfs_create_file("list", 0400, dir, NULL,
346fd59b 2606 &debugfs_kprobes_operations);
63724740
MH
2607 if (!file)
2608 goto error;
346fd59b 2609
bf8f6e5b
AM
2610 file = debugfs_create_file("enabled", 0600, dir,
2611 &value, &fops_kp);
63724740
MH
2612 if (!file)
2613 goto error;
2614
4bdf9c17 2615 file = debugfs_create_file("blacklist", 0400, dir, NULL,
63724740
MH
2616 &debugfs_kprobe_blacklist_ops);
2617 if (!file)
2618 goto error;
bf8f6e5b 2619
346fd59b 2620 return 0;
63724740
MH
2621
2622error:
2623 debugfs_remove(dir);
2624 return -ENOMEM;
346fd59b
SD
2625}
2626
2627late_initcall(debugfs_kprobe_init);
2628#endif /* CONFIG_DEBUG_FS */
2629
2630module_init(init_kprobes);
1da177e4 2631
99081ab5 2632/* defined in arch/.../kernel/kprobes.c */
1da177e4 2633EXPORT_SYMBOL_GPL(jprobe_return);