Linux 4.9.243
[linux/fpc-iii.git] / kernel / kprobes.c
blob3938e4670b89bcff4ef328e0ccde3daf7df09080
1 /*
2 * Kernel Probes (KProbes)
3 * kernel/kprobes.c
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.
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.
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.
19 * Copyright (C) IBM Corporation, 2002, 2004
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.
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.
34 #include <linux/kprobes.h>
35 #include <linux/hash.h>
36 #include <linux/init.h>
37 #include <linux/slab.h>
38 #include <linux/stddef.h>
39 #include <linux/export.h>
40 #include <linux/moduleloader.h>
41 #include <linux/kallsyms.h>
42 #include <linux/freezer.h>
43 #include <linux/seq_file.h>
44 #include <linux/debugfs.h>
45 #include <linux/sysctl.h>
46 #include <linux/kdebug.h>
47 #include <linux/memory.h>
48 #include <linux/ftrace.h>
49 #include <linux/cpu.h>
50 #include <linux/jump_label.h>
52 #include <asm/sections.h>
53 #include <asm/cacheflush.h>
54 #include <asm/errno.h>
55 #include <asm/uaccess.h>
57 #define KPROBE_HASH_BITS 6
58 #define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
62 * Some oddball architectures like 64bit powerpc have function descriptors
63 * so this must be overridable.
65 #ifndef kprobe_lookup_name
66 #define kprobe_lookup_name(name, addr) \
67 addr = ((kprobe_opcode_t *)(kallsyms_lookup_name(name)))
68 #endif
70 static int kprobes_initialized;
71 static struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
72 static struct hlist_head kretprobe_inst_table[KPROBE_TABLE_SIZE];
74 /* NOTE: change this value only with kprobe_mutex held */
75 static bool kprobes_all_disarmed;
77 /* This protects kprobe_table and optimizing_list */
78 static DEFINE_MUTEX(kprobe_mutex);
79 static DEFINE_PER_CPU(struct kprobe *, kprobe_instance) = NULL;
80 static struct {
81 raw_spinlock_t lock ____cacheline_aligned_in_smp;
82 } kretprobe_table_locks[KPROBE_TABLE_SIZE];
84 static raw_spinlock_t *kretprobe_table_lock_ptr(unsigned long hash)
86 return &(kretprobe_table_locks[hash].lock);
89 /* Blacklist -- list of struct kprobe_blacklist_entry */
90 static LIST_HEAD(kprobe_blacklist);
92 #ifdef __ARCH_WANT_KPROBES_INSN_SLOT
94 * kprobe->ainsn.insn points to the copy of the instruction to be
95 * single-stepped. x86_64, POWER4 and above have no-exec support and
96 * stepping on the instruction on a vmalloced/kmalloced/data page
97 * is a recipe for disaster
99 struct kprobe_insn_page {
100 struct list_head list;
101 kprobe_opcode_t *insns; /* Page of instruction slots */
102 struct kprobe_insn_cache *cache;
103 int nused;
104 int ngarbage;
105 char slot_used[];
108 #define KPROBE_INSN_PAGE_SIZE(slots) \
109 (offsetof(struct kprobe_insn_page, slot_used) + \
110 (sizeof(char) * (slots)))
112 static int slots_per_page(struct kprobe_insn_cache *c)
114 return PAGE_SIZE/(c->insn_size * sizeof(kprobe_opcode_t));
117 enum kprobe_slot_state {
118 SLOT_CLEAN = 0,
119 SLOT_DIRTY = 1,
120 SLOT_USED = 2,
123 static void *alloc_insn_page(void)
125 return module_alloc(PAGE_SIZE);
128 void __weak free_insn_page(void *page)
130 module_memfree(page);
133 struct kprobe_insn_cache kprobe_insn_slots = {
134 .mutex = __MUTEX_INITIALIZER(kprobe_insn_slots.mutex),
135 .alloc = alloc_insn_page,
136 .free = free_insn_page,
137 .pages = LIST_HEAD_INIT(kprobe_insn_slots.pages),
138 .insn_size = MAX_INSN_SIZE,
139 .nr_garbage = 0,
141 static int collect_garbage_slots(struct kprobe_insn_cache *c);
144 * __get_insn_slot() - Find a slot on an executable page for an instruction.
145 * We allocate an executable page if there's no room on existing ones.
147 kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c)
149 struct kprobe_insn_page *kip;
150 kprobe_opcode_t *slot = NULL;
152 mutex_lock(&c->mutex);
153 retry:
154 list_for_each_entry(kip, &c->pages, list) {
155 if (kip->nused < slots_per_page(c)) {
156 int i;
157 for (i = 0; i < slots_per_page(c); i++) {
158 if (kip->slot_used[i] == SLOT_CLEAN) {
159 kip->slot_used[i] = SLOT_USED;
160 kip->nused++;
161 slot = kip->insns + (i * c->insn_size);
162 goto out;
165 /* kip->nused is broken. Fix it. */
166 kip->nused = slots_per_page(c);
167 WARN_ON(1);
171 /* If there are any garbage slots, collect it and try again. */
172 if (c->nr_garbage && collect_garbage_slots(c) == 0)
173 goto retry;
175 /* All out of space. Need to allocate a new page. */
176 kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
177 if (!kip)
178 goto out;
181 * Use module_alloc so this page is within +/- 2GB of where the
182 * kernel image and loaded module images reside. This is required
183 * so x86_64 can correctly handle the %rip-relative fixups.
185 kip->insns = c->alloc();
186 if (!kip->insns) {
187 kfree(kip);
188 goto out;
190 INIT_LIST_HEAD(&kip->list);
191 memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
192 kip->slot_used[0] = SLOT_USED;
193 kip->nused = 1;
194 kip->ngarbage = 0;
195 kip->cache = c;
196 list_add(&kip->list, &c->pages);
197 slot = kip->insns;
198 out:
199 mutex_unlock(&c->mutex);
200 return slot;
203 /* Return 1 if all garbages are collected, otherwise 0. */
204 static int collect_one_slot(struct kprobe_insn_page *kip, int idx)
206 kip->slot_used[idx] = SLOT_CLEAN;
207 kip->nused--;
208 if (kip->nused == 0) {
210 * Page is no longer in use. Free it unless
211 * it's the last one. We keep the last one
212 * so as not to have to set it up again the
213 * next time somebody inserts a probe.
215 if (!list_is_singular(&kip->list)) {
216 list_del(&kip->list);
217 kip->cache->free(kip->insns);
218 kfree(kip);
220 return 1;
222 return 0;
225 static int collect_garbage_slots(struct kprobe_insn_cache *c)
227 struct kprobe_insn_page *kip, *next;
229 /* Ensure no-one is interrupted on the garbages */
230 synchronize_sched();
232 list_for_each_entry_safe(kip, next, &c->pages, list) {
233 int i;
234 if (kip->ngarbage == 0)
235 continue;
236 kip->ngarbage = 0; /* we will collect all garbages */
237 for (i = 0; i < slots_per_page(c); i++) {
238 if (kip->slot_used[i] == SLOT_DIRTY &&
239 collect_one_slot(kip, i))
240 break;
243 c->nr_garbage = 0;
244 return 0;
247 void __free_insn_slot(struct kprobe_insn_cache *c,
248 kprobe_opcode_t *slot, int dirty)
250 struct kprobe_insn_page *kip;
252 mutex_lock(&c->mutex);
253 list_for_each_entry(kip, &c->pages, list) {
254 long idx = ((long)slot - (long)kip->insns) /
255 (c->insn_size * sizeof(kprobe_opcode_t));
256 if (idx >= 0 && idx < slots_per_page(c)) {
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 goto out;
268 /* Could not free this slot. */
269 WARN_ON(1);
270 out:
271 mutex_unlock(&c->mutex);
274 #ifdef CONFIG_OPTPROBES
275 /* For optimized_kprobe buffer */
276 struct kprobe_insn_cache kprobe_optinsn_slots = {
277 .mutex = __MUTEX_INITIALIZER(kprobe_optinsn_slots.mutex),
278 .alloc = alloc_insn_page,
279 .free = free_insn_page,
280 .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
281 /* .insn_size is initialized later */
282 .nr_garbage = 0,
284 #endif
285 #endif
287 /* We have preemption disabled.. so it is safe to use __ versions */
288 static inline void set_kprobe_instance(struct kprobe *kp)
290 __this_cpu_write(kprobe_instance, kp);
293 static inline void reset_kprobe_instance(void)
295 __this_cpu_write(kprobe_instance, NULL);
299 * This routine is called either:
300 * - under the kprobe_mutex - during kprobe_[un]register()
301 * OR
302 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
304 struct kprobe *get_kprobe(void *addr)
306 struct hlist_head *head;
307 struct kprobe *p;
309 head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
310 hlist_for_each_entry_rcu(p, head, hlist) {
311 if (p->addr == addr)
312 return p;
315 return NULL;
317 NOKPROBE_SYMBOL(get_kprobe);
319 static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
321 /* Return true if the kprobe is an aggregator */
322 static inline int kprobe_aggrprobe(struct kprobe *p)
324 return p->pre_handler == aggr_pre_handler;
327 /* Return true(!0) if the kprobe is unused */
328 static inline int kprobe_unused(struct kprobe *p)
330 return kprobe_aggrprobe(p) && kprobe_disabled(p) &&
331 list_empty(&p->list);
335 * Keep all fields in the kprobe consistent
337 static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
339 memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
340 memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
343 #ifdef CONFIG_OPTPROBES
344 /* NOTE: change this value only with kprobe_mutex held */
345 static bool kprobes_allow_optimization;
348 * Call all pre_handler on the list, but ignores its return value.
349 * This must be called from arch-dep optimized caller.
351 void opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
353 struct kprobe *kp;
355 list_for_each_entry_rcu(kp, &p->list, list) {
356 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
357 set_kprobe_instance(kp);
358 kp->pre_handler(kp, regs);
360 reset_kprobe_instance();
363 NOKPROBE_SYMBOL(opt_pre_handler);
365 /* Free optimized instructions and optimized_kprobe */
366 static void free_aggr_kprobe(struct kprobe *p)
368 struct optimized_kprobe *op;
370 op = container_of(p, struct optimized_kprobe, kp);
371 arch_remove_optimized_kprobe(op);
372 arch_remove_kprobe(p);
373 kfree(op);
376 /* Return true(!0) if the kprobe is ready for optimization. */
377 static inline int kprobe_optready(struct kprobe *p)
379 struct optimized_kprobe *op;
381 if (kprobe_aggrprobe(p)) {
382 op = container_of(p, struct optimized_kprobe, kp);
383 return arch_prepared_optinsn(&op->optinsn);
386 return 0;
389 /* Return true(!0) if the kprobe is disarmed. Note: p must be on hash list */
390 static inline int kprobe_disarmed(struct kprobe *p)
392 struct optimized_kprobe *op;
394 /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
395 if (!kprobe_aggrprobe(p))
396 return kprobe_disabled(p);
398 op = container_of(p, struct optimized_kprobe, kp);
400 return kprobe_disabled(p) && list_empty(&op->list);
403 /* Return true(!0) if the probe is queued on (un)optimizing lists */
404 static int kprobe_queued(struct kprobe *p)
406 struct optimized_kprobe *op;
408 if (kprobe_aggrprobe(p)) {
409 op = container_of(p, struct optimized_kprobe, kp);
410 if (!list_empty(&op->list))
411 return 1;
413 return 0;
417 * Return an optimized kprobe whose optimizing code replaces
418 * instructions including addr (exclude breakpoint).
420 static struct kprobe *get_optimized_kprobe(unsigned long addr)
422 int i;
423 struct kprobe *p = NULL;
424 struct optimized_kprobe *op;
426 /* Don't check i == 0, since that is a breakpoint case. */
427 for (i = 1; !p && i < MAX_OPTIMIZED_LENGTH; i++)
428 p = get_kprobe((void *)(addr - i));
430 if (p && kprobe_optready(p)) {
431 op = container_of(p, struct optimized_kprobe, kp);
432 if (arch_within_optimized_kprobe(op, addr))
433 return p;
436 return NULL;
439 /* Optimization staging list, protected by kprobe_mutex */
440 static LIST_HEAD(optimizing_list);
441 static LIST_HEAD(unoptimizing_list);
442 static LIST_HEAD(freeing_list);
444 static void kprobe_optimizer(struct work_struct *work);
445 static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
446 #define OPTIMIZE_DELAY 5
449 * Optimize (replace a breakpoint with a jump) kprobes listed on
450 * optimizing_list.
452 static void do_optimize_kprobes(void)
454 /* Optimization never be done when disarmed */
455 if (kprobes_all_disarmed || !kprobes_allow_optimization ||
456 list_empty(&optimizing_list))
457 return;
460 * The optimization/unoptimization refers online_cpus via
461 * stop_machine() and cpu-hotplug modifies online_cpus.
462 * And same time, text_mutex will be held in cpu-hotplug and here.
463 * This combination can cause a deadlock (cpu-hotplug try to lock
464 * text_mutex but stop_machine can not be done because online_cpus
465 * has been changed)
466 * To avoid this deadlock, we need to call get_online_cpus()
467 * for preventing cpu-hotplug outside of text_mutex locking.
469 get_online_cpus();
470 mutex_lock(&text_mutex);
471 arch_optimize_kprobes(&optimizing_list);
472 mutex_unlock(&text_mutex);
473 put_online_cpus();
477 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
478 * if need) kprobes listed on unoptimizing_list.
480 static void do_unoptimize_kprobes(void)
482 struct optimized_kprobe *op, *tmp;
484 /* Unoptimization must be done anytime */
485 if (list_empty(&unoptimizing_list))
486 return;
488 /* Ditto to do_optimize_kprobes */
489 get_online_cpus();
490 mutex_lock(&text_mutex);
491 arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
492 /* Loop free_list for disarming */
493 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
494 /* Disarm probes if marked disabled */
495 if (kprobe_disabled(&op->kp))
496 arch_disarm_kprobe(&op->kp);
497 if (kprobe_unused(&op->kp)) {
499 * Remove unused probes from hash list. After waiting
500 * for synchronization, these probes are reclaimed.
501 * (reclaiming is done by do_free_cleaned_kprobes.)
503 hlist_del_rcu(&op->kp.hlist);
504 } else
505 list_del_init(&op->list);
507 mutex_unlock(&text_mutex);
508 put_online_cpus();
511 /* Reclaim all kprobes on the free_list */
512 static void do_free_cleaned_kprobes(void)
514 struct optimized_kprobe *op, *tmp;
516 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
517 list_del_init(&op->list);
518 if (WARN_ON_ONCE(!kprobe_unused(&op->kp))) {
520 * This must not happen, but if there is a kprobe
521 * still in use, keep it on kprobes hash list.
523 continue;
525 free_aggr_kprobe(&op->kp);
529 /* Start optimizer after OPTIMIZE_DELAY passed */
530 static void kick_kprobe_optimizer(void)
532 schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
535 /* Kprobe jump optimizer */
536 static void kprobe_optimizer(struct work_struct *work)
538 mutex_lock(&kprobe_mutex);
539 /* Lock modules while optimizing kprobes */
540 mutex_lock(&module_mutex);
543 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
544 * kprobes before waiting for quiesence period.
546 do_unoptimize_kprobes();
549 * Step 2: Wait for quiesence period to ensure all running interrupts
550 * are done. Because optprobe may modify multiple instructions
551 * there is a chance that Nth instruction is interrupted. In that
552 * case, running interrupt can return to 2nd-Nth byte of jump
553 * instruction. This wait is for avoiding it.
555 synchronize_sched();
557 /* Step 3: Optimize kprobes after quiesence period */
558 do_optimize_kprobes();
560 /* Step 4: Free cleaned kprobes after quiesence period */
561 do_free_cleaned_kprobes();
563 mutex_unlock(&module_mutex);
565 /* Step 5: Kick optimizer again if needed */
566 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
567 kick_kprobe_optimizer();
569 mutex_unlock(&kprobe_mutex);
572 /* Wait for completing optimization and unoptimization */
573 void wait_for_kprobe_optimizer(void)
575 mutex_lock(&kprobe_mutex);
577 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
578 mutex_unlock(&kprobe_mutex);
580 /* this will also make optimizing_work execute immmediately */
581 flush_delayed_work(&optimizing_work);
582 /* @optimizing_work might not have been queued yet, relax */
583 cpu_relax();
585 mutex_lock(&kprobe_mutex);
588 mutex_unlock(&kprobe_mutex);
591 /* Optimize kprobe if p is ready to be optimized */
592 static void optimize_kprobe(struct kprobe *p)
594 struct optimized_kprobe *op;
596 /* Check if the kprobe is disabled or not ready for optimization. */
597 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
598 (kprobe_disabled(p) || kprobes_all_disarmed))
599 return;
601 /* Both of break_handler and post_handler are not supported. */
602 if (p->break_handler || p->post_handler)
603 return;
605 op = container_of(p, struct optimized_kprobe, kp);
607 /* Check there is no other kprobes at the optimized instructions */
608 if (arch_check_optimized_kprobe(op) < 0)
609 return;
611 /* Check if it is already optimized. */
612 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED)
613 return;
614 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
616 if (!list_empty(&op->list))
617 /* This is under unoptimizing. Just dequeue the probe */
618 list_del_init(&op->list);
619 else {
620 list_add(&op->list, &optimizing_list);
621 kick_kprobe_optimizer();
625 /* Short cut to direct unoptimizing */
626 static void force_unoptimize_kprobe(struct optimized_kprobe *op)
628 get_online_cpus();
629 arch_unoptimize_kprobe(op);
630 put_online_cpus();
631 if (kprobe_disabled(&op->kp))
632 arch_disarm_kprobe(&op->kp);
635 /* Unoptimize a kprobe if p is optimized */
636 static void unoptimize_kprobe(struct kprobe *p, bool force)
638 struct optimized_kprobe *op;
640 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
641 return; /* This is not an optprobe nor optimized */
643 op = container_of(p, struct optimized_kprobe, kp);
644 if (!kprobe_optimized(p)) {
645 /* Unoptimized or unoptimizing case */
646 if (force && !list_empty(&op->list)) {
648 * Only if this is unoptimizing kprobe and forced,
649 * forcibly unoptimize it. (No need to unoptimize
650 * unoptimized kprobe again :)
652 list_del_init(&op->list);
653 force_unoptimize_kprobe(op);
655 return;
658 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
659 if (!list_empty(&op->list)) {
660 /* Dequeue from the optimization queue */
661 list_del_init(&op->list);
662 return;
664 /* Optimized kprobe case */
665 if (force)
666 /* Forcibly update the code: this is a special case */
667 force_unoptimize_kprobe(op);
668 else {
669 list_add(&op->list, &unoptimizing_list);
670 kick_kprobe_optimizer();
674 /* Cancel unoptimizing for reusing */
675 static int reuse_unused_kprobe(struct kprobe *ap)
677 struct optimized_kprobe *op;
679 BUG_ON(!kprobe_unused(ap));
681 * Unused kprobe MUST be on the way of delayed unoptimizing (means
682 * there is still a relative jump) and disabled.
684 op = container_of(ap, struct optimized_kprobe, kp);
685 if (unlikely(list_empty(&op->list)))
686 printk(KERN_WARNING "Warning: found a stray unused "
687 "aggrprobe@%p\n", ap->addr);
688 /* Enable the probe again */
689 ap->flags &= ~KPROBE_FLAG_DISABLED;
690 /* Optimize it again (remove from op->list) */
691 if (!kprobe_optready(ap))
692 return -EINVAL;
694 optimize_kprobe(ap);
695 return 0;
698 /* Remove optimized instructions */
699 static void kill_optimized_kprobe(struct kprobe *p)
701 struct optimized_kprobe *op;
703 op = container_of(p, struct optimized_kprobe, kp);
704 if (!list_empty(&op->list))
705 /* Dequeue from the (un)optimization queue */
706 list_del_init(&op->list);
707 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
709 if (kprobe_unused(p)) {
710 /* Enqueue if it is unused */
711 list_add(&op->list, &freeing_list);
713 * Remove unused probes from the hash list. After waiting
714 * for synchronization, this probe is reclaimed.
715 * (reclaiming is done by do_free_cleaned_kprobes().)
717 hlist_del_rcu(&op->kp.hlist);
720 /* Don't touch the code, because it is already freed. */
721 arch_remove_optimized_kprobe(op);
724 /* Try to prepare optimized instructions */
725 static void prepare_optimized_kprobe(struct kprobe *p)
727 struct optimized_kprobe *op;
729 op = container_of(p, struct optimized_kprobe, kp);
730 arch_prepare_optimized_kprobe(op, p);
733 /* Allocate new optimized_kprobe and try to prepare optimized instructions */
734 static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
736 struct optimized_kprobe *op;
738 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
739 if (!op)
740 return NULL;
742 INIT_LIST_HEAD(&op->list);
743 op->kp.addr = p->addr;
744 arch_prepare_optimized_kprobe(op, p);
746 return &op->kp;
749 static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
752 * Prepare an optimized_kprobe and optimize it
753 * NOTE: p must be a normal registered kprobe
755 static void try_to_optimize_kprobe(struct kprobe *p)
757 struct kprobe *ap;
758 struct optimized_kprobe *op;
760 /* Impossible to optimize ftrace-based kprobe */
761 if (kprobe_ftrace(p))
762 return;
764 /* For preparing optimization, jump_label_text_reserved() is called */
765 jump_label_lock();
766 mutex_lock(&text_mutex);
768 ap = alloc_aggr_kprobe(p);
769 if (!ap)
770 goto out;
772 op = container_of(ap, struct optimized_kprobe, kp);
773 if (!arch_prepared_optinsn(&op->optinsn)) {
774 /* If failed to setup optimizing, fallback to kprobe */
775 arch_remove_optimized_kprobe(op);
776 kfree(op);
777 goto out;
780 init_aggr_kprobe(ap, p);
781 optimize_kprobe(ap); /* This just kicks optimizer thread */
783 out:
784 mutex_unlock(&text_mutex);
785 jump_label_unlock();
788 #ifdef CONFIG_SYSCTL
789 static void optimize_all_kprobes(void)
791 struct hlist_head *head;
792 struct kprobe *p;
793 unsigned int i;
795 mutex_lock(&kprobe_mutex);
796 /* If optimization is already allowed, just return */
797 if (kprobes_allow_optimization)
798 goto out;
800 kprobes_allow_optimization = true;
801 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
802 head = &kprobe_table[i];
803 hlist_for_each_entry_rcu(p, head, hlist)
804 if (!kprobe_disabled(p))
805 optimize_kprobe(p);
807 printk(KERN_INFO "Kprobes globally optimized\n");
808 out:
809 mutex_unlock(&kprobe_mutex);
812 static void unoptimize_all_kprobes(void)
814 struct hlist_head *head;
815 struct kprobe *p;
816 unsigned int i;
818 mutex_lock(&kprobe_mutex);
819 /* If optimization is already prohibited, just return */
820 if (!kprobes_allow_optimization) {
821 mutex_unlock(&kprobe_mutex);
822 return;
825 kprobes_allow_optimization = false;
826 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
827 head = &kprobe_table[i];
828 hlist_for_each_entry_rcu(p, head, hlist) {
829 if (!kprobe_disabled(p))
830 unoptimize_kprobe(p, false);
833 mutex_unlock(&kprobe_mutex);
835 /* Wait for unoptimizing completion */
836 wait_for_kprobe_optimizer();
837 printk(KERN_INFO "Kprobes globally unoptimized\n");
840 static DEFINE_MUTEX(kprobe_sysctl_mutex);
841 int sysctl_kprobes_optimization;
842 int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
843 void __user *buffer, size_t *length,
844 loff_t *ppos)
846 int ret;
848 mutex_lock(&kprobe_sysctl_mutex);
849 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
850 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
852 if (sysctl_kprobes_optimization)
853 optimize_all_kprobes();
854 else
855 unoptimize_all_kprobes();
856 mutex_unlock(&kprobe_sysctl_mutex);
858 return ret;
860 #endif /* CONFIG_SYSCTL */
862 /* Put a breakpoint for a probe. Must be called with text_mutex locked */
863 static void __arm_kprobe(struct kprobe *p)
865 struct kprobe *_p;
867 /* Check collision with other optimized kprobes */
868 _p = get_optimized_kprobe((unsigned long)p->addr);
869 if (unlikely(_p))
870 /* Fallback to unoptimized kprobe */
871 unoptimize_kprobe(_p, true);
873 arch_arm_kprobe(p);
874 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
877 /* Remove the breakpoint of a probe. Must be called with text_mutex locked */
878 static void __disarm_kprobe(struct kprobe *p, bool reopt)
880 struct kprobe *_p;
882 /* Try to unoptimize */
883 unoptimize_kprobe(p, kprobes_all_disarmed);
885 if (!kprobe_queued(p)) {
886 arch_disarm_kprobe(p);
887 /* If another kprobe was blocked, optimize it. */
888 _p = get_optimized_kprobe((unsigned long)p->addr);
889 if (unlikely(_p) && reopt)
890 optimize_kprobe(_p);
892 /* TODO: reoptimize others after unoptimized this probe */
895 #else /* !CONFIG_OPTPROBES */
897 #define optimize_kprobe(p) do {} while (0)
898 #define unoptimize_kprobe(p, f) do {} while (0)
899 #define kill_optimized_kprobe(p) do {} while (0)
900 #define prepare_optimized_kprobe(p) do {} while (0)
901 #define try_to_optimize_kprobe(p) do {} while (0)
902 #define __arm_kprobe(p) arch_arm_kprobe(p)
903 #define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
904 #define kprobe_disarmed(p) kprobe_disabled(p)
905 #define wait_for_kprobe_optimizer() do {} while (0)
907 static int reuse_unused_kprobe(struct kprobe *ap)
910 * If the optimized kprobe is NOT supported, the aggr kprobe is
911 * released at the same time that the last aggregated kprobe is
912 * unregistered.
913 * Thus there should be no chance to reuse unused kprobe.
915 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
916 return -EINVAL;
919 static void free_aggr_kprobe(struct kprobe *p)
921 arch_remove_kprobe(p);
922 kfree(p);
925 static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
927 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
929 #endif /* CONFIG_OPTPROBES */
931 #ifdef CONFIG_KPROBES_ON_FTRACE
932 static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
933 .func = kprobe_ftrace_handler,
934 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
936 static int kprobe_ftrace_enabled;
938 /* Must ensure p->addr is really on ftrace */
939 static int prepare_kprobe(struct kprobe *p)
941 if (!kprobe_ftrace(p))
942 return arch_prepare_kprobe(p);
944 return arch_prepare_kprobe_ftrace(p);
947 /* Caller must lock kprobe_mutex */
948 static void arm_kprobe_ftrace(struct kprobe *p)
950 int ret;
952 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
953 (unsigned long)p->addr, 0, 0);
954 WARN(ret < 0, "Failed to arm kprobe-ftrace at %p (%d)\n", p->addr, ret);
955 kprobe_ftrace_enabled++;
956 if (kprobe_ftrace_enabled == 1) {
957 ret = register_ftrace_function(&kprobe_ftrace_ops);
958 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
962 /* Caller must lock kprobe_mutex */
963 static void disarm_kprobe_ftrace(struct kprobe *p)
965 int ret;
967 kprobe_ftrace_enabled--;
968 if (kprobe_ftrace_enabled == 0) {
969 ret = unregister_ftrace_function(&kprobe_ftrace_ops);
970 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
972 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
973 (unsigned long)p->addr, 1, 0);
974 WARN(ret < 0, "Failed to disarm kprobe-ftrace at %p (%d)\n", p->addr, ret);
976 #else /* !CONFIG_KPROBES_ON_FTRACE */
977 #define prepare_kprobe(p) arch_prepare_kprobe(p)
978 #define arm_kprobe_ftrace(p) do {} while (0)
979 #define disarm_kprobe_ftrace(p) do {} while (0)
980 #endif
982 /* Arm a kprobe with text_mutex */
983 static void arm_kprobe(struct kprobe *kp)
985 if (unlikely(kprobe_ftrace(kp))) {
986 arm_kprobe_ftrace(kp);
987 return;
990 * Here, since __arm_kprobe() doesn't use stop_machine(),
991 * this doesn't cause deadlock on text_mutex. So, we don't
992 * need get_online_cpus().
994 mutex_lock(&text_mutex);
995 __arm_kprobe(kp);
996 mutex_unlock(&text_mutex);
999 /* Disarm a kprobe with text_mutex */
1000 static void disarm_kprobe(struct kprobe *kp, bool reopt)
1002 if (unlikely(kprobe_ftrace(kp))) {
1003 disarm_kprobe_ftrace(kp);
1004 return;
1006 /* Ditto */
1007 mutex_lock(&text_mutex);
1008 __disarm_kprobe(kp, reopt);
1009 mutex_unlock(&text_mutex);
1013 * Aggregate handlers for multiple kprobes support - these handlers
1014 * take care of invoking the individual kprobe handlers on p->list
1016 static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
1018 struct kprobe *kp;
1020 list_for_each_entry_rcu(kp, &p->list, list) {
1021 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
1022 set_kprobe_instance(kp);
1023 if (kp->pre_handler(kp, regs))
1024 return 1;
1026 reset_kprobe_instance();
1028 return 0;
1030 NOKPROBE_SYMBOL(aggr_pre_handler);
1032 static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1033 unsigned long flags)
1035 struct kprobe *kp;
1037 list_for_each_entry_rcu(kp, &p->list, list) {
1038 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
1039 set_kprobe_instance(kp);
1040 kp->post_handler(kp, regs, flags);
1041 reset_kprobe_instance();
1045 NOKPROBE_SYMBOL(aggr_post_handler);
1047 static int aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
1048 int trapnr)
1050 struct kprobe *cur = __this_cpu_read(kprobe_instance);
1053 * if we faulted "during" the execution of a user specified
1054 * probe handler, invoke just that probe's fault handler
1056 if (cur && cur->fault_handler) {
1057 if (cur->fault_handler(cur, regs, trapnr))
1058 return 1;
1060 return 0;
1062 NOKPROBE_SYMBOL(aggr_fault_handler);
1064 static int aggr_break_handler(struct kprobe *p, struct pt_regs *regs)
1066 struct kprobe *cur = __this_cpu_read(kprobe_instance);
1067 int ret = 0;
1069 if (cur && cur->break_handler) {
1070 if (cur->break_handler(cur, regs))
1071 ret = 1;
1073 reset_kprobe_instance();
1074 return ret;
1076 NOKPROBE_SYMBOL(aggr_break_handler);
1078 /* Walks the list and increments nmissed count for multiprobe case */
1079 void kprobes_inc_nmissed_count(struct kprobe *p)
1081 struct kprobe *kp;
1082 if (!kprobe_aggrprobe(p)) {
1083 p->nmissed++;
1084 } else {
1085 list_for_each_entry_rcu(kp, &p->list, list)
1086 kp->nmissed++;
1088 return;
1090 NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
1092 void recycle_rp_inst(struct kretprobe_instance *ri,
1093 struct hlist_head *head)
1095 struct kretprobe *rp = ri->rp;
1097 /* remove rp inst off the rprobe_inst_table */
1098 hlist_del(&ri->hlist);
1099 INIT_HLIST_NODE(&ri->hlist);
1100 if (likely(rp)) {
1101 raw_spin_lock(&rp->lock);
1102 hlist_add_head(&ri->hlist, &rp->free_instances);
1103 raw_spin_unlock(&rp->lock);
1104 } else
1105 /* Unregistering */
1106 hlist_add_head(&ri->hlist, head);
1108 NOKPROBE_SYMBOL(recycle_rp_inst);
1110 void kretprobe_hash_lock(struct task_struct *tsk,
1111 struct hlist_head **head, unsigned long *flags)
1112 __acquires(hlist_lock)
1114 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
1115 raw_spinlock_t *hlist_lock;
1117 *head = &kretprobe_inst_table[hash];
1118 hlist_lock = kretprobe_table_lock_ptr(hash);
1119 raw_spin_lock_irqsave(hlist_lock, *flags);
1121 NOKPROBE_SYMBOL(kretprobe_hash_lock);
1123 static void kretprobe_table_lock(unsigned long hash,
1124 unsigned long *flags)
1125 __acquires(hlist_lock)
1127 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1128 raw_spin_lock_irqsave(hlist_lock, *flags);
1130 NOKPROBE_SYMBOL(kretprobe_table_lock);
1132 void kretprobe_hash_unlock(struct task_struct *tsk,
1133 unsigned long *flags)
1134 __releases(hlist_lock)
1136 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
1137 raw_spinlock_t *hlist_lock;
1139 hlist_lock = kretprobe_table_lock_ptr(hash);
1140 raw_spin_unlock_irqrestore(hlist_lock, *flags);
1142 NOKPROBE_SYMBOL(kretprobe_hash_unlock);
1144 static void kretprobe_table_unlock(unsigned long hash,
1145 unsigned long *flags)
1146 __releases(hlist_lock)
1148 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1149 raw_spin_unlock_irqrestore(hlist_lock, *flags);
1151 NOKPROBE_SYMBOL(kretprobe_table_unlock);
1153 struct kprobe kprobe_busy = {
1154 .addr = (void *) get_kprobe,
1157 void kprobe_busy_begin(void)
1159 struct kprobe_ctlblk *kcb;
1161 preempt_disable();
1162 __this_cpu_write(current_kprobe, &kprobe_busy);
1163 kcb = get_kprobe_ctlblk();
1164 kcb->kprobe_status = KPROBE_HIT_ACTIVE;
1167 void kprobe_busy_end(void)
1169 __this_cpu_write(current_kprobe, NULL);
1170 preempt_enable();
1174 * This function is called from finish_task_switch when task tk becomes dead,
1175 * so that we can recycle any function-return probe instances associated
1176 * with this task. These left over instances represent probed functions
1177 * that have been called but will never return.
1179 void kprobe_flush_task(struct task_struct *tk)
1181 struct kretprobe_instance *ri;
1182 struct hlist_head *head, empty_rp;
1183 struct hlist_node *tmp;
1184 unsigned long hash, flags = 0;
1186 if (unlikely(!kprobes_initialized))
1187 /* Early boot. kretprobe_table_locks not yet initialized. */
1188 return;
1190 kprobe_busy_begin();
1192 INIT_HLIST_HEAD(&empty_rp);
1193 hash = hash_ptr(tk, KPROBE_HASH_BITS);
1194 head = &kretprobe_inst_table[hash];
1195 kretprobe_table_lock(hash, &flags);
1196 hlist_for_each_entry_safe(ri, tmp, head, hlist) {
1197 if (ri->task == tk)
1198 recycle_rp_inst(ri, &empty_rp);
1200 kretprobe_table_unlock(hash, &flags);
1201 hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
1202 hlist_del(&ri->hlist);
1203 kfree(ri);
1206 kprobe_busy_end();
1208 NOKPROBE_SYMBOL(kprobe_flush_task);
1210 static inline void free_rp_inst(struct kretprobe *rp)
1212 struct kretprobe_instance *ri;
1213 struct hlist_node *next;
1215 hlist_for_each_entry_safe(ri, next, &rp->free_instances, hlist) {
1216 hlist_del(&ri->hlist);
1217 kfree(ri);
1221 static void cleanup_rp_inst(struct kretprobe *rp)
1223 unsigned long flags, hash;
1224 struct kretprobe_instance *ri;
1225 struct hlist_node *next;
1226 struct hlist_head *head;
1228 /* No race here */
1229 for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
1230 kretprobe_table_lock(hash, &flags);
1231 head = &kretprobe_inst_table[hash];
1232 hlist_for_each_entry_safe(ri, next, head, hlist) {
1233 if (ri->rp == rp)
1234 ri->rp = NULL;
1236 kretprobe_table_unlock(hash, &flags);
1238 free_rp_inst(rp);
1240 NOKPROBE_SYMBOL(cleanup_rp_inst);
1243 * Add the new probe to ap->list. Fail if this is the
1244 * second jprobe at the address - two jprobes can't coexist
1246 static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
1248 BUG_ON(kprobe_gone(ap) || kprobe_gone(p));
1250 if (p->break_handler || p->post_handler)
1251 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
1253 if (p->break_handler) {
1254 if (ap->break_handler)
1255 return -EEXIST;
1256 list_add_tail_rcu(&p->list, &ap->list);
1257 ap->break_handler = aggr_break_handler;
1258 } else
1259 list_add_rcu(&p->list, &ap->list);
1260 if (p->post_handler && !ap->post_handler)
1261 ap->post_handler = aggr_post_handler;
1263 return 0;
1267 * Fill in the required fields of the "manager kprobe". Replace the
1268 * earlier kprobe in the hlist with the manager kprobe
1270 static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
1272 /* Copy p's insn slot to ap */
1273 copy_kprobe(p, ap);
1274 flush_insn_slot(ap);
1275 ap->addr = p->addr;
1276 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
1277 ap->pre_handler = aggr_pre_handler;
1278 ap->fault_handler = aggr_fault_handler;
1279 /* We don't care the kprobe which has gone. */
1280 if (p->post_handler && !kprobe_gone(p))
1281 ap->post_handler = aggr_post_handler;
1282 if (p->break_handler && !kprobe_gone(p))
1283 ap->break_handler = aggr_break_handler;
1285 INIT_LIST_HEAD(&ap->list);
1286 INIT_HLIST_NODE(&ap->hlist);
1288 list_add_rcu(&p->list, &ap->list);
1289 hlist_replace_rcu(&p->hlist, &ap->hlist);
1293 * This is the second or subsequent kprobe at the address - handle
1294 * the intricacies
1296 static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
1298 int ret = 0;
1299 struct kprobe *ap = orig_p;
1301 /* For preparing optimization, jump_label_text_reserved() is called */
1302 jump_label_lock();
1304 * Get online CPUs to avoid text_mutex deadlock.with stop machine,
1305 * which is invoked by unoptimize_kprobe() in add_new_kprobe()
1307 get_online_cpus();
1308 mutex_lock(&text_mutex);
1310 if (!kprobe_aggrprobe(orig_p)) {
1311 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1312 ap = alloc_aggr_kprobe(orig_p);
1313 if (!ap) {
1314 ret = -ENOMEM;
1315 goto out;
1317 init_aggr_kprobe(ap, orig_p);
1318 } else if (kprobe_unused(ap)) {
1319 /* This probe is going to die. Rescue it */
1320 ret = reuse_unused_kprobe(ap);
1321 if (ret)
1322 goto out;
1325 if (kprobe_gone(ap)) {
1327 * Attempting to insert new probe at the same location that
1328 * had a probe in the module vaddr area which already
1329 * freed. So, the instruction slot has already been
1330 * released. We need a new slot for the new probe.
1332 ret = arch_prepare_kprobe(ap);
1333 if (ret)
1335 * Even if fail to allocate new slot, don't need to
1336 * free aggr_probe. It will be used next time, or
1337 * freed by unregister_kprobe.
1339 goto out;
1341 /* Prepare optimized instructions if possible. */
1342 prepare_optimized_kprobe(ap);
1345 * Clear gone flag to prevent allocating new slot again, and
1346 * set disabled flag because it is not armed yet.
1348 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1349 | KPROBE_FLAG_DISABLED;
1352 /* Copy ap's insn slot to p */
1353 copy_kprobe(ap, p);
1354 ret = add_new_kprobe(ap, p);
1356 out:
1357 mutex_unlock(&text_mutex);
1358 put_online_cpus();
1359 jump_label_unlock();
1361 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1362 ap->flags &= ~KPROBE_FLAG_DISABLED;
1363 if (!kprobes_all_disarmed)
1364 /* Arm the breakpoint again. */
1365 arm_kprobe(ap);
1367 return ret;
1370 bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1372 /* The __kprobes marked functions and entry code must not be probed */
1373 return addr >= (unsigned long)__kprobes_text_start &&
1374 addr < (unsigned long)__kprobes_text_end;
1377 bool within_kprobe_blacklist(unsigned long addr)
1379 struct kprobe_blacklist_entry *ent;
1381 if (arch_within_kprobe_blacklist(addr))
1382 return true;
1384 * If there exists a kprobe_blacklist, verify and
1385 * fail any probe registration in the prohibited area
1387 list_for_each_entry(ent, &kprobe_blacklist, list) {
1388 if (addr >= ent->start_addr && addr < ent->end_addr)
1389 return true;
1392 return false;
1396 * If we have a symbol_name argument, look it up and add the offset field
1397 * to it. This way, we can specify a relative address to a symbol.
1398 * This returns encoded errors if it fails to look up symbol or invalid
1399 * combination of parameters.
1401 static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
1403 kprobe_opcode_t *addr = p->addr;
1405 if ((p->symbol_name && p->addr) ||
1406 (!p->symbol_name && !p->addr))
1407 goto invalid;
1409 if (p->symbol_name) {
1410 kprobe_lookup_name(p->symbol_name, addr);
1411 if (!addr)
1412 return ERR_PTR(-ENOENT);
1415 addr = (kprobe_opcode_t *)(((char *)addr) + p->offset);
1416 if (addr)
1417 return addr;
1419 invalid:
1420 return ERR_PTR(-EINVAL);
1423 /* Check passed kprobe is valid and return kprobe in kprobe_table. */
1424 static struct kprobe *__get_valid_kprobe(struct kprobe *p)
1426 struct kprobe *ap, *list_p;
1428 ap = get_kprobe(p->addr);
1429 if (unlikely(!ap))
1430 return NULL;
1432 if (p != ap) {
1433 list_for_each_entry_rcu(list_p, &ap->list, list)
1434 if (list_p == p)
1435 /* kprobe p is a valid probe */
1436 goto valid;
1437 return NULL;
1439 valid:
1440 return ap;
1443 /* Return error if the kprobe is being re-registered */
1444 static inline int check_kprobe_rereg(struct kprobe *p)
1446 int ret = 0;
1448 mutex_lock(&kprobe_mutex);
1449 if (__get_valid_kprobe(p))
1450 ret = -EINVAL;
1451 mutex_unlock(&kprobe_mutex);
1453 return ret;
1456 int __weak arch_check_ftrace_location(struct kprobe *p)
1458 unsigned long ftrace_addr;
1460 ftrace_addr = ftrace_location((unsigned long)p->addr);
1461 if (ftrace_addr) {
1462 #ifdef CONFIG_KPROBES_ON_FTRACE
1463 /* Given address is not on the instruction boundary */
1464 if ((unsigned long)p->addr != ftrace_addr)
1465 return -EILSEQ;
1466 p->flags |= KPROBE_FLAG_FTRACE;
1467 #else /* !CONFIG_KPROBES_ON_FTRACE */
1468 return -EINVAL;
1469 #endif
1471 return 0;
1474 static int check_kprobe_address_safe(struct kprobe *p,
1475 struct module **probed_mod)
1477 int ret;
1479 ret = arch_check_ftrace_location(p);
1480 if (ret)
1481 return ret;
1482 jump_label_lock();
1483 preempt_disable();
1485 /* Ensure it is not in reserved area nor out of text */
1486 if (!kernel_text_address((unsigned long) p->addr) ||
1487 within_kprobe_blacklist((unsigned long) p->addr) ||
1488 jump_label_text_reserved(p->addr, p->addr) ||
1489 find_bug((unsigned long)p->addr)) {
1490 ret = -EINVAL;
1491 goto out;
1494 /* Check if are we probing a module */
1495 *probed_mod = __module_text_address((unsigned long) p->addr);
1496 if (*probed_mod) {
1498 * We must hold a refcount of the probed module while updating
1499 * its code to prohibit unexpected unloading.
1501 if (unlikely(!try_module_get(*probed_mod))) {
1502 ret = -ENOENT;
1503 goto out;
1507 * If the module freed .init.text, we couldn't insert
1508 * kprobes in there.
1510 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1511 (*probed_mod)->state != MODULE_STATE_COMING) {
1512 module_put(*probed_mod);
1513 *probed_mod = NULL;
1514 ret = -ENOENT;
1517 out:
1518 preempt_enable();
1519 jump_label_unlock();
1521 return ret;
1524 int register_kprobe(struct kprobe *p)
1526 int ret;
1527 struct kprobe *old_p;
1528 struct module *probed_mod;
1529 kprobe_opcode_t *addr;
1531 /* Adjust probe address from symbol */
1532 addr = kprobe_addr(p);
1533 if (IS_ERR(addr))
1534 return PTR_ERR(addr);
1535 p->addr = addr;
1537 ret = check_kprobe_rereg(p);
1538 if (ret)
1539 return ret;
1541 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1542 p->flags &= KPROBE_FLAG_DISABLED;
1543 p->nmissed = 0;
1544 INIT_LIST_HEAD(&p->list);
1546 ret = check_kprobe_address_safe(p, &probed_mod);
1547 if (ret)
1548 return ret;
1550 mutex_lock(&kprobe_mutex);
1552 old_p = get_kprobe(p->addr);
1553 if (old_p) {
1554 /* Since this may unoptimize old_p, locking text_mutex. */
1555 ret = register_aggr_kprobe(old_p, p);
1556 goto out;
1559 mutex_lock(&text_mutex); /* Avoiding text modification */
1560 ret = prepare_kprobe(p);
1561 mutex_unlock(&text_mutex);
1562 if (ret)
1563 goto out;
1565 INIT_HLIST_NODE(&p->hlist);
1566 hlist_add_head_rcu(&p->hlist,
1567 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1569 if (!kprobes_all_disarmed && !kprobe_disabled(p))
1570 arm_kprobe(p);
1572 /* Try to optimize kprobe */
1573 try_to_optimize_kprobe(p);
1575 out:
1576 mutex_unlock(&kprobe_mutex);
1578 if (probed_mod)
1579 module_put(probed_mod);
1581 return ret;
1583 EXPORT_SYMBOL_GPL(register_kprobe);
1585 /* Check if all probes on the aggrprobe are disabled */
1586 static int aggr_kprobe_disabled(struct kprobe *ap)
1588 struct kprobe *kp;
1590 list_for_each_entry_rcu(kp, &ap->list, list)
1591 if (!kprobe_disabled(kp))
1593 * There is an active probe on the list.
1594 * We can't disable this ap.
1596 return 0;
1598 return 1;
1601 /* Disable one kprobe: Make sure called under kprobe_mutex is locked */
1602 static struct kprobe *__disable_kprobe(struct kprobe *p)
1604 struct kprobe *orig_p;
1606 /* Get an original kprobe for return */
1607 orig_p = __get_valid_kprobe(p);
1608 if (unlikely(orig_p == NULL))
1609 return NULL;
1611 if (!kprobe_disabled(p)) {
1612 /* Disable probe if it is a child probe */
1613 if (p != orig_p)
1614 p->flags |= KPROBE_FLAG_DISABLED;
1616 /* Try to disarm and disable this/parent probe */
1617 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
1619 * If kprobes_all_disarmed is set, orig_p
1620 * should have already been disarmed, so
1621 * skip unneed disarming process.
1623 if (!kprobes_all_disarmed)
1624 disarm_kprobe(orig_p, true);
1625 orig_p->flags |= KPROBE_FLAG_DISABLED;
1629 return orig_p;
1633 * Unregister a kprobe without a scheduler synchronization.
1635 static int __unregister_kprobe_top(struct kprobe *p)
1637 struct kprobe *ap, *list_p;
1639 /* Disable kprobe. This will disarm it if needed. */
1640 ap = __disable_kprobe(p);
1641 if (ap == NULL)
1642 return -EINVAL;
1644 if (ap == p)
1646 * This probe is an independent(and non-optimized) kprobe
1647 * (not an aggrprobe). Remove from the hash list.
1649 goto disarmed;
1651 /* Following process expects this probe is an aggrprobe */
1652 WARN_ON(!kprobe_aggrprobe(ap));
1654 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1656 * !disarmed could be happen if the probe is under delayed
1657 * unoptimizing.
1659 goto disarmed;
1660 else {
1661 /* If disabling probe has special handlers, update aggrprobe */
1662 if (p->break_handler && !kprobe_gone(p))
1663 ap->break_handler = NULL;
1664 if (p->post_handler && !kprobe_gone(p)) {
1665 list_for_each_entry_rcu(list_p, &ap->list, list) {
1666 if ((list_p != p) && (list_p->post_handler))
1667 goto noclean;
1669 ap->post_handler = NULL;
1671 noclean:
1673 * Remove from the aggrprobe: this path will do nothing in
1674 * __unregister_kprobe_bottom().
1676 list_del_rcu(&p->list);
1677 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1679 * Try to optimize this probe again, because post
1680 * handler may have been changed.
1682 optimize_kprobe(ap);
1684 return 0;
1686 disarmed:
1687 BUG_ON(!kprobe_disarmed(ap));
1688 hlist_del_rcu(&ap->hlist);
1689 return 0;
1692 static void __unregister_kprobe_bottom(struct kprobe *p)
1694 struct kprobe *ap;
1696 if (list_empty(&p->list))
1697 /* This is an independent kprobe */
1698 arch_remove_kprobe(p);
1699 else if (list_is_singular(&p->list)) {
1700 /* This is the last child of an aggrprobe */
1701 ap = list_entry(p->list.next, struct kprobe, list);
1702 list_del(&p->list);
1703 free_aggr_kprobe(ap);
1705 /* Otherwise, do nothing. */
1708 int register_kprobes(struct kprobe **kps, int num)
1710 int i, ret = 0;
1712 if (num <= 0)
1713 return -EINVAL;
1714 for (i = 0; i < num; i++) {
1715 ret = register_kprobe(kps[i]);
1716 if (ret < 0) {
1717 if (i > 0)
1718 unregister_kprobes(kps, i);
1719 break;
1722 return ret;
1724 EXPORT_SYMBOL_GPL(register_kprobes);
1726 void unregister_kprobe(struct kprobe *p)
1728 unregister_kprobes(&p, 1);
1730 EXPORT_SYMBOL_GPL(unregister_kprobe);
1732 void unregister_kprobes(struct kprobe **kps, int num)
1734 int i;
1736 if (num <= 0)
1737 return;
1738 mutex_lock(&kprobe_mutex);
1739 for (i = 0; i < num; i++)
1740 if (__unregister_kprobe_top(kps[i]) < 0)
1741 kps[i]->addr = NULL;
1742 mutex_unlock(&kprobe_mutex);
1744 synchronize_sched();
1745 for (i = 0; i < num; i++)
1746 if (kps[i]->addr)
1747 __unregister_kprobe_bottom(kps[i]);
1749 EXPORT_SYMBOL_GPL(unregister_kprobes);
1751 static struct notifier_block kprobe_exceptions_nb = {
1752 .notifier_call = kprobe_exceptions_notify,
1753 .priority = 0x7fffffff /* we need to be notified first */
1756 unsigned long __weak arch_deref_entry_point(void *entry)
1758 return (unsigned long)entry;
1761 int register_jprobes(struct jprobe **jps, int num)
1763 struct jprobe *jp;
1764 int ret = 0, i;
1766 if (num <= 0)
1767 return -EINVAL;
1768 for (i = 0; i < num; i++) {
1769 unsigned long addr, offset;
1770 jp = jps[i];
1771 addr = arch_deref_entry_point(jp->entry);
1773 /* Verify probepoint is a function entry point */
1774 if (kallsyms_lookup_size_offset(addr, NULL, &offset) &&
1775 offset == 0) {
1776 jp->kp.pre_handler = setjmp_pre_handler;
1777 jp->kp.break_handler = longjmp_break_handler;
1778 ret = register_kprobe(&jp->kp);
1779 } else
1780 ret = -EINVAL;
1782 if (ret < 0) {
1783 if (i > 0)
1784 unregister_jprobes(jps, i);
1785 break;
1788 return ret;
1790 EXPORT_SYMBOL_GPL(register_jprobes);
1792 int register_jprobe(struct jprobe *jp)
1794 return register_jprobes(&jp, 1);
1796 EXPORT_SYMBOL_GPL(register_jprobe);
1798 void unregister_jprobe(struct jprobe *jp)
1800 unregister_jprobes(&jp, 1);
1802 EXPORT_SYMBOL_GPL(unregister_jprobe);
1804 void unregister_jprobes(struct jprobe **jps, int num)
1806 int i;
1808 if (num <= 0)
1809 return;
1810 mutex_lock(&kprobe_mutex);
1811 for (i = 0; i < num; i++)
1812 if (__unregister_kprobe_top(&jps[i]->kp) < 0)
1813 jps[i]->kp.addr = NULL;
1814 mutex_unlock(&kprobe_mutex);
1816 synchronize_sched();
1817 for (i = 0; i < num; i++) {
1818 if (jps[i]->kp.addr)
1819 __unregister_kprobe_bottom(&jps[i]->kp);
1822 EXPORT_SYMBOL_GPL(unregister_jprobes);
1824 #ifdef CONFIG_KRETPROBES
1826 * This kprobe pre_handler is registered with every kretprobe. When probe
1827 * hits it will set up the return probe.
1829 static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
1831 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
1832 unsigned long hash, flags = 0;
1833 struct kretprobe_instance *ri;
1836 * To avoid deadlocks, prohibit return probing in NMI contexts,
1837 * just skip the probe and increase the (inexact) 'nmissed'
1838 * statistical counter, so that the user is informed that
1839 * something happened:
1841 if (unlikely(in_nmi())) {
1842 rp->nmissed++;
1843 return 0;
1846 /* TODO: consider to only swap the RA after the last pre_handler fired */
1847 hash = hash_ptr(current, KPROBE_HASH_BITS);
1848 raw_spin_lock_irqsave(&rp->lock, flags);
1849 if (!hlist_empty(&rp->free_instances)) {
1850 ri = hlist_entry(rp->free_instances.first,
1851 struct kretprobe_instance, hlist);
1852 hlist_del(&ri->hlist);
1853 raw_spin_unlock_irqrestore(&rp->lock, flags);
1855 ri->rp = rp;
1856 ri->task = current;
1858 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1859 raw_spin_lock_irqsave(&rp->lock, flags);
1860 hlist_add_head(&ri->hlist, &rp->free_instances);
1861 raw_spin_unlock_irqrestore(&rp->lock, flags);
1862 return 0;
1865 arch_prepare_kretprobe(ri, regs);
1867 /* XXX(hch): why is there no hlist_move_head? */
1868 INIT_HLIST_NODE(&ri->hlist);
1869 kretprobe_table_lock(hash, &flags);
1870 hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
1871 kretprobe_table_unlock(hash, &flags);
1872 } else {
1873 rp->nmissed++;
1874 raw_spin_unlock_irqrestore(&rp->lock, flags);
1876 return 0;
1878 NOKPROBE_SYMBOL(pre_handler_kretprobe);
1880 int register_kretprobe(struct kretprobe *rp)
1882 int ret = 0;
1883 struct kretprobe_instance *inst;
1884 int i;
1885 void *addr;
1887 if (kretprobe_blacklist_size) {
1888 addr = kprobe_addr(&rp->kp);
1889 if (IS_ERR(addr))
1890 return PTR_ERR(addr);
1892 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1893 if (kretprobe_blacklist[i].addr == addr)
1894 return -EINVAL;
1898 rp->kp.pre_handler = pre_handler_kretprobe;
1899 rp->kp.post_handler = NULL;
1900 rp->kp.fault_handler = NULL;
1901 rp->kp.break_handler = NULL;
1903 /* Pre-allocate memory for max kretprobe instances */
1904 if (rp->maxactive <= 0) {
1905 #ifdef CONFIG_PREEMPT
1906 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
1907 #else
1908 rp->maxactive = num_possible_cpus();
1909 #endif
1911 raw_spin_lock_init(&rp->lock);
1912 INIT_HLIST_HEAD(&rp->free_instances);
1913 for (i = 0; i < rp->maxactive; i++) {
1914 inst = kmalloc(sizeof(struct kretprobe_instance) +
1915 rp->data_size, GFP_KERNEL);
1916 if (inst == NULL) {
1917 free_rp_inst(rp);
1918 return -ENOMEM;
1920 INIT_HLIST_NODE(&inst->hlist);
1921 hlist_add_head(&inst->hlist, &rp->free_instances);
1924 rp->nmissed = 0;
1925 /* Establish function entry probe point */
1926 ret = register_kprobe(&rp->kp);
1927 if (ret != 0)
1928 free_rp_inst(rp);
1929 return ret;
1931 EXPORT_SYMBOL_GPL(register_kretprobe);
1933 int register_kretprobes(struct kretprobe **rps, int num)
1935 int ret = 0, i;
1937 if (num <= 0)
1938 return -EINVAL;
1939 for (i = 0; i < num; i++) {
1940 ret = register_kretprobe(rps[i]);
1941 if (ret < 0) {
1942 if (i > 0)
1943 unregister_kretprobes(rps, i);
1944 break;
1947 return ret;
1949 EXPORT_SYMBOL_GPL(register_kretprobes);
1951 void unregister_kretprobe(struct kretprobe *rp)
1953 unregister_kretprobes(&rp, 1);
1955 EXPORT_SYMBOL_GPL(unregister_kretprobe);
1957 void unregister_kretprobes(struct kretprobe **rps, int num)
1959 int i;
1961 if (num <= 0)
1962 return;
1963 mutex_lock(&kprobe_mutex);
1964 for (i = 0; i < num; i++)
1965 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
1966 rps[i]->kp.addr = NULL;
1967 mutex_unlock(&kprobe_mutex);
1969 synchronize_sched();
1970 for (i = 0; i < num; i++) {
1971 if (rps[i]->kp.addr) {
1972 __unregister_kprobe_bottom(&rps[i]->kp);
1973 cleanup_rp_inst(rps[i]);
1977 EXPORT_SYMBOL_GPL(unregister_kretprobes);
1979 #else /* CONFIG_KRETPROBES */
1980 int register_kretprobe(struct kretprobe *rp)
1982 return -ENOSYS;
1984 EXPORT_SYMBOL_GPL(register_kretprobe);
1986 int register_kretprobes(struct kretprobe **rps, int num)
1988 return -ENOSYS;
1990 EXPORT_SYMBOL_GPL(register_kretprobes);
1992 void unregister_kretprobe(struct kretprobe *rp)
1995 EXPORT_SYMBOL_GPL(unregister_kretprobe);
1997 void unregister_kretprobes(struct kretprobe **rps, int num)
2000 EXPORT_SYMBOL_GPL(unregister_kretprobes);
2002 static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
2004 return 0;
2006 NOKPROBE_SYMBOL(pre_handler_kretprobe);
2008 #endif /* CONFIG_KRETPROBES */
2010 /* Set the kprobe gone and remove its instruction buffer. */
2011 static void kill_kprobe(struct kprobe *p)
2013 struct kprobe *kp;
2015 if (WARN_ON_ONCE(kprobe_gone(p)))
2016 return;
2018 p->flags |= KPROBE_FLAG_GONE;
2019 if (kprobe_aggrprobe(p)) {
2021 * If this is an aggr_kprobe, we have to list all the
2022 * chained probes and mark them GONE.
2024 list_for_each_entry_rcu(kp, &p->list, list)
2025 kp->flags |= KPROBE_FLAG_GONE;
2026 p->post_handler = NULL;
2027 p->break_handler = NULL;
2028 kill_optimized_kprobe(p);
2031 * Here, we can remove insn_slot safely, because no thread calls
2032 * the original probed function (which will be freed soon) any more.
2034 arch_remove_kprobe(p);
2037 * The module is going away. We should disarm the kprobe which
2038 * is using ftrace, because ftrace framework is still available at
2039 * MODULE_STATE_GOING notification.
2041 if (kprobe_ftrace(p) && !kprobe_disabled(p) && !kprobes_all_disarmed)
2042 disarm_kprobe_ftrace(p);
2045 /* Disable one kprobe */
2046 int disable_kprobe(struct kprobe *kp)
2048 int ret = 0;
2050 mutex_lock(&kprobe_mutex);
2052 /* Disable this kprobe */
2053 if (__disable_kprobe(kp) == NULL)
2054 ret = -EINVAL;
2056 mutex_unlock(&kprobe_mutex);
2057 return ret;
2059 EXPORT_SYMBOL_GPL(disable_kprobe);
2061 /* Enable one kprobe */
2062 int enable_kprobe(struct kprobe *kp)
2064 int ret = 0;
2065 struct kprobe *p;
2067 mutex_lock(&kprobe_mutex);
2069 /* Check whether specified probe is valid. */
2070 p = __get_valid_kprobe(kp);
2071 if (unlikely(p == NULL)) {
2072 ret = -EINVAL;
2073 goto out;
2076 if (kprobe_gone(kp)) {
2077 /* This kprobe has gone, we couldn't enable it. */
2078 ret = -EINVAL;
2079 goto out;
2082 if (p != kp)
2083 kp->flags &= ~KPROBE_FLAG_DISABLED;
2085 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2086 p->flags &= ~KPROBE_FLAG_DISABLED;
2087 arm_kprobe(p);
2089 out:
2090 mutex_unlock(&kprobe_mutex);
2091 return ret;
2093 EXPORT_SYMBOL_GPL(enable_kprobe);
2095 void dump_kprobe(struct kprobe *kp)
2097 printk(KERN_WARNING "Dumping kprobe:\n");
2098 printk(KERN_WARNING "Name: %s\nAddress: %p\nOffset: %x\n",
2099 kp->symbol_name, kp->addr, kp->offset);
2101 NOKPROBE_SYMBOL(dump_kprobe);
2104 * Lookup and populate the kprobe_blacklist.
2106 * Unlike the kretprobe blacklist, we'll need to determine
2107 * the range of addresses that belong to the said functions,
2108 * since a kprobe need not necessarily be at the beginning
2109 * of a function.
2111 static int __init populate_kprobe_blacklist(unsigned long *start,
2112 unsigned long *end)
2114 unsigned long *iter;
2115 struct kprobe_blacklist_entry *ent;
2116 unsigned long entry, offset = 0, size = 0;
2118 for (iter = start; iter < end; iter++) {
2119 entry = arch_deref_entry_point((void *)*iter);
2121 if (!kernel_text_address(entry) ||
2122 !kallsyms_lookup_size_offset(entry, &size, &offset)) {
2123 pr_err("Failed to find blacklist at %p\n",
2124 (void *)entry);
2125 continue;
2128 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2129 if (!ent)
2130 return -ENOMEM;
2131 ent->start_addr = entry;
2132 ent->end_addr = entry + size;
2133 INIT_LIST_HEAD(&ent->list);
2134 list_add_tail(&ent->list, &kprobe_blacklist);
2136 return 0;
2139 /* Module notifier call back, checking kprobes on the module */
2140 static int kprobes_module_callback(struct notifier_block *nb,
2141 unsigned long val, void *data)
2143 struct module *mod = data;
2144 struct hlist_head *head;
2145 struct kprobe *p;
2146 unsigned int i;
2147 int checkcore = (val == MODULE_STATE_GOING);
2149 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
2150 return NOTIFY_DONE;
2153 * When MODULE_STATE_GOING was notified, both of module .text and
2154 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2155 * notified, only .init.text section would be freed. We need to
2156 * disable kprobes which have been inserted in the sections.
2158 mutex_lock(&kprobe_mutex);
2159 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2160 head = &kprobe_table[i];
2161 hlist_for_each_entry_rcu(p, head, hlist) {
2162 if (kprobe_gone(p))
2163 continue;
2165 if (within_module_init((unsigned long)p->addr, mod) ||
2166 (checkcore &&
2167 within_module_core((unsigned long)p->addr, mod))) {
2169 * The vaddr this probe is installed will soon
2170 * be vfreed buy not synced to disk. Hence,
2171 * disarming the breakpoint isn't needed.
2173 kill_kprobe(p);
2177 mutex_unlock(&kprobe_mutex);
2178 return NOTIFY_DONE;
2181 static struct notifier_block kprobe_module_nb = {
2182 .notifier_call = kprobes_module_callback,
2183 .priority = 0
2186 /* Markers of _kprobe_blacklist section */
2187 extern unsigned long __start_kprobe_blacklist[];
2188 extern unsigned long __stop_kprobe_blacklist[];
2190 static int __init init_kprobes(void)
2192 int i, err = 0;
2194 /* FIXME allocate the probe table, currently defined statically */
2195 /* initialize all list heads */
2196 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2197 INIT_HLIST_HEAD(&kprobe_table[i]);
2198 INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
2199 raw_spin_lock_init(&(kretprobe_table_locks[i].lock));
2202 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2203 __stop_kprobe_blacklist);
2204 if (err) {
2205 pr_err("kprobes: failed to populate blacklist: %d\n", err);
2206 pr_err("Please take care of using kprobes.\n");
2209 if (kretprobe_blacklist_size) {
2210 /* lookup the function address from its name */
2211 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
2212 kprobe_lookup_name(kretprobe_blacklist[i].name,
2213 kretprobe_blacklist[i].addr);
2214 if (!kretprobe_blacklist[i].addr)
2215 printk("kretprobe: lookup failed: %s\n",
2216 kretprobe_blacklist[i].name);
2220 #if defined(CONFIG_OPTPROBES)
2221 #if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
2222 /* Init kprobe_optinsn_slots */
2223 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2224 #endif
2225 /* By default, kprobes can be optimized */
2226 kprobes_allow_optimization = true;
2227 #endif
2229 /* By default, kprobes are armed */
2230 kprobes_all_disarmed = false;
2232 err = arch_init_kprobes();
2233 if (!err)
2234 err = register_die_notifier(&kprobe_exceptions_nb);
2235 if (!err)
2236 err = register_module_notifier(&kprobe_module_nb);
2238 kprobes_initialized = (err == 0);
2240 if (!err)
2241 init_test_probes();
2242 return err;
2245 #ifdef CONFIG_DEBUG_FS
2246 static void report_probe(struct seq_file *pi, struct kprobe *p,
2247 const char *sym, int offset, char *modname, struct kprobe *pp)
2249 char *kprobe_type;
2251 if (p->pre_handler == pre_handler_kretprobe)
2252 kprobe_type = "r";
2253 else if (p->pre_handler == setjmp_pre_handler)
2254 kprobe_type = "j";
2255 else
2256 kprobe_type = "k";
2258 if (sym)
2259 seq_printf(pi, "%p %s %s+0x%x %s ",
2260 p->addr, kprobe_type, sym, offset,
2261 (modname ? modname : " "));
2262 else
2263 seq_printf(pi, "%p %s %p ",
2264 p->addr, kprobe_type, p->addr);
2266 if (!pp)
2267 pp = p;
2268 seq_printf(pi, "%s%s%s%s\n",
2269 (kprobe_gone(p) ? "[GONE]" : ""),
2270 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
2271 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2272 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
2275 static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
2277 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2280 static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
2282 (*pos)++;
2283 if (*pos >= KPROBE_TABLE_SIZE)
2284 return NULL;
2285 return pos;
2288 static void kprobe_seq_stop(struct seq_file *f, void *v)
2290 /* Nothing to do */
2293 static int show_kprobe_addr(struct seq_file *pi, void *v)
2295 struct hlist_head *head;
2296 struct kprobe *p, *kp;
2297 const char *sym = NULL;
2298 unsigned int i = *(loff_t *) v;
2299 unsigned long offset = 0;
2300 char *modname, namebuf[KSYM_NAME_LEN];
2302 head = &kprobe_table[i];
2303 preempt_disable();
2304 hlist_for_each_entry_rcu(p, head, hlist) {
2305 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
2306 &offset, &modname, namebuf);
2307 if (kprobe_aggrprobe(p)) {
2308 list_for_each_entry_rcu(kp, &p->list, list)
2309 report_probe(pi, kp, sym, offset, modname, p);
2310 } else
2311 report_probe(pi, p, sym, offset, modname, NULL);
2313 preempt_enable();
2314 return 0;
2317 static const struct seq_operations kprobes_seq_ops = {
2318 .start = kprobe_seq_start,
2319 .next = kprobe_seq_next,
2320 .stop = kprobe_seq_stop,
2321 .show = show_kprobe_addr
2324 static int kprobes_open(struct inode *inode, struct file *filp)
2326 return seq_open(filp, &kprobes_seq_ops);
2329 static const struct file_operations debugfs_kprobes_operations = {
2330 .open = kprobes_open,
2331 .read = seq_read,
2332 .llseek = seq_lseek,
2333 .release = seq_release,
2336 /* kprobes/blacklist -- shows which functions can not be probed */
2337 static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2339 return seq_list_start(&kprobe_blacklist, *pos);
2342 static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2344 return seq_list_next(v, &kprobe_blacklist, pos);
2347 static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2349 struct kprobe_blacklist_entry *ent =
2350 list_entry(v, struct kprobe_blacklist_entry, list);
2352 seq_printf(m, "0x%p-0x%p\t%ps\n", (void *)ent->start_addr,
2353 (void *)ent->end_addr, (void *)ent->start_addr);
2354 return 0;
2357 static const struct seq_operations kprobe_blacklist_seq_ops = {
2358 .start = kprobe_blacklist_seq_start,
2359 .next = kprobe_blacklist_seq_next,
2360 .stop = kprobe_seq_stop, /* Reuse void function */
2361 .show = kprobe_blacklist_seq_show,
2364 static int kprobe_blacklist_open(struct inode *inode, struct file *filp)
2366 return seq_open(filp, &kprobe_blacklist_seq_ops);
2369 static const struct file_operations debugfs_kprobe_blacklist_ops = {
2370 .open = kprobe_blacklist_open,
2371 .read = seq_read,
2372 .llseek = seq_lseek,
2373 .release = seq_release,
2376 static void arm_all_kprobes(void)
2378 struct hlist_head *head;
2379 struct kprobe *p;
2380 unsigned int i;
2382 mutex_lock(&kprobe_mutex);
2384 /* If kprobes are armed, just return */
2385 if (!kprobes_all_disarmed)
2386 goto already_enabled;
2389 * optimize_kprobe() called by arm_kprobe() checks
2390 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2391 * arm_kprobe.
2393 kprobes_all_disarmed = false;
2394 /* Arming kprobes doesn't optimize kprobe itself */
2395 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2396 head = &kprobe_table[i];
2397 hlist_for_each_entry_rcu(p, head, hlist)
2398 if (!kprobe_disabled(p))
2399 arm_kprobe(p);
2402 printk(KERN_INFO "Kprobes globally enabled\n");
2404 already_enabled:
2405 mutex_unlock(&kprobe_mutex);
2406 return;
2409 static void disarm_all_kprobes(void)
2411 struct hlist_head *head;
2412 struct kprobe *p;
2413 unsigned int i;
2415 mutex_lock(&kprobe_mutex);
2417 /* If kprobes are already disarmed, just return */
2418 if (kprobes_all_disarmed) {
2419 mutex_unlock(&kprobe_mutex);
2420 return;
2423 kprobes_all_disarmed = true;
2424 printk(KERN_INFO "Kprobes globally disabled\n");
2426 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2427 head = &kprobe_table[i];
2428 hlist_for_each_entry_rcu(p, head, hlist) {
2429 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p))
2430 disarm_kprobe(p, false);
2433 mutex_unlock(&kprobe_mutex);
2435 /* Wait for disarming all kprobes by optimizer */
2436 wait_for_kprobe_optimizer();
2440 * XXX: The debugfs bool file interface doesn't allow for callbacks
2441 * when the bool state is switched. We can reuse that facility when
2442 * available
2444 static ssize_t read_enabled_file_bool(struct file *file,
2445 char __user *user_buf, size_t count, loff_t *ppos)
2447 char buf[3];
2449 if (!kprobes_all_disarmed)
2450 buf[0] = '1';
2451 else
2452 buf[0] = '0';
2453 buf[1] = '\n';
2454 buf[2] = 0x00;
2455 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2458 static ssize_t write_enabled_file_bool(struct file *file,
2459 const char __user *user_buf, size_t count, loff_t *ppos)
2461 char buf[32];
2462 size_t buf_size;
2464 buf_size = min(count, (sizeof(buf)-1));
2465 if (copy_from_user(buf, user_buf, buf_size))
2466 return -EFAULT;
2468 buf[buf_size] = '\0';
2469 switch (buf[0]) {
2470 case 'y':
2471 case 'Y':
2472 case '1':
2473 arm_all_kprobes();
2474 break;
2475 case 'n':
2476 case 'N':
2477 case '0':
2478 disarm_all_kprobes();
2479 break;
2480 default:
2481 return -EINVAL;
2484 return count;
2487 static const struct file_operations fops_kp = {
2488 .read = read_enabled_file_bool,
2489 .write = write_enabled_file_bool,
2490 .llseek = default_llseek,
2493 static int __init debugfs_kprobe_init(void)
2495 struct dentry *dir, *file;
2496 unsigned int value = 1;
2498 dir = debugfs_create_dir("kprobes", NULL);
2499 if (!dir)
2500 return -ENOMEM;
2502 file = debugfs_create_file("list", 0400, dir, NULL,
2503 &debugfs_kprobes_operations);
2504 if (!file)
2505 goto error;
2507 file = debugfs_create_file("enabled", 0600, dir,
2508 &value, &fops_kp);
2509 if (!file)
2510 goto error;
2512 file = debugfs_create_file("blacklist", 0400, dir, NULL,
2513 &debugfs_kprobe_blacklist_ops);
2514 if (!file)
2515 goto error;
2517 return 0;
2519 error:
2520 debugfs_remove(dir);
2521 return -ENOMEM;
2524 late_initcall(debugfs_kprobe_init);
2525 #endif /* CONFIG_DEBUG_FS */
2527 module_init(init_kprobes);
2529 /* defined in arch/.../kernel/kprobes.c */
2530 EXPORT_SYMBOL_GPL(jprobe_return);