2 * Kernel Probes (KProbes)
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
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 <linux/uaccess.h>
57 #define KPROBE_HASH_BITS 6
58 #define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
61 static int kprobes_initialized;
62 static struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
63 static struct hlist_head kretprobe_inst_table[KPROBE_TABLE_SIZE];
65 /* NOTE: change this value only with kprobe_mutex held */
66 static bool kprobes_all_disarmed;
68 /* This protects kprobe_table and optimizing_list */
69 static DEFINE_MUTEX(kprobe_mutex);
70 static DEFINE_PER_CPU(struct kprobe *, kprobe_instance) = NULL;
72 raw_spinlock_t lock ____cacheline_aligned_in_smp;
73 } kretprobe_table_locks[KPROBE_TABLE_SIZE];
75 kprobe_opcode_t * __weak kprobe_lookup_name(const char *name,
76 unsigned int __unused)
78 return ((kprobe_opcode_t *)(kallsyms_lookup_name(name)));
81 static raw_spinlock_t *kretprobe_table_lock_ptr(unsigned long hash)
83 return &(kretprobe_table_locks[hash].lock);
86 /* Blacklist -- list of struct kprobe_blacklist_entry */
87 static LIST_HEAD(kprobe_blacklist);
89 #ifdef __ARCH_WANT_KPROBES_INSN_SLOT
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
96 struct kprobe_insn_page {
97 struct list_head list;
98 kprobe_opcode_t *insns; /* Page of instruction slots */
99 struct kprobe_insn_cache *cache;
105 #define KPROBE_INSN_PAGE_SIZE(slots) \
106 (offsetof(struct kprobe_insn_page, slot_used) + \
107 (sizeof(char) * (slots)))
109 static int slots_per_page(struct kprobe_insn_cache *c)
111 return PAGE_SIZE/(c->insn_size * sizeof(kprobe_opcode_t));
114 enum kprobe_slot_state {
120 void __weak *alloc_insn_page(void)
122 return module_alloc(PAGE_SIZE);
125 void __weak free_insn_page(void *page)
127 module_memfree(page);
130 struct kprobe_insn_cache kprobe_insn_slots = {
131 .mutex = __MUTEX_INITIALIZER(kprobe_insn_slots.mutex),
132 .alloc = alloc_insn_page,
133 .free = free_insn_page,
134 .pages = LIST_HEAD_INIT(kprobe_insn_slots.pages),
135 .insn_size = MAX_INSN_SIZE,
138 static int collect_garbage_slots(struct kprobe_insn_cache *c);
141 * __get_insn_slot() - Find a slot on an executable page for an instruction.
142 * We allocate an executable page if there's no room on existing ones.
144 kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c)
146 struct kprobe_insn_page *kip;
147 kprobe_opcode_t *slot = NULL;
149 /* Since the slot array is not protected by rcu, we need a mutex */
150 mutex_lock(&c->mutex);
153 list_for_each_entry_rcu(kip, &c->pages, list) {
154 if (kip->nused < slots_per_page(c)) {
156 for (i = 0; i < slots_per_page(c); i++) {
157 if (kip->slot_used[i] == SLOT_CLEAN) {
158 kip->slot_used[i] = SLOT_USED;
160 slot = kip->insns + (i * c->insn_size);
165 /* kip->nused is broken. Fix it. */
166 kip->nused = slots_per_page(c);
172 /* If there are any garbage slots, collect it and try again. */
173 if (c->nr_garbage && collect_garbage_slots(c) == 0)
176 /* All out of space. Need to allocate a new page. */
177 kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
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.
186 kip->insns = c->alloc();
191 INIT_LIST_HEAD(&kip->list);
192 memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
193 kip->slot_used[0] = SLOT_USED;
197 list_add_rcu(&kip->list, &c->pages);
200 mutex_unlock(&c->mutex);
204 /* Return 1 if all garbages are collected, otherwise 0. */
205 static int collect_one_slot(struct kprobe_insn_page *kip, int idx)
207 kip->slot_used[idx] = SLOT_CLEAN;
209 if (kip->nused == 0) {
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.
216 if (!list_is_singular(&kip->list)) {
217 list_del_rcu(&kip->list);
219 kip->cache->free(kip->insns);
227 static int collect_garbage_slots(struct kprobe_insn_cache *c)
229 struct kprobe_insn_page *kip, *next;
231 /* Ensure no-one is interrupted on the garbages */
234 list_for_each_entry_safe(kip, next, &c->pages, list) {
236 if (kip->ngarbage == 0)
238 kip->ngarbage = 0; /* we will collect all garbages */
239 for (i = 0; i < slots_per_page(c); i++) {
240 if (kip->slot_used[i] == SLOT_DIRTY && collect_one_slot(kip, i))
248 void __free_insn_slot(struct kprobe_insn_cache *c,
249 kprobe_opcode_t *slot, int dirty)
251 struct kprobe_insn_page *kip;
254 mutex_lock(&c->mutex);
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))
262 /* Could not find this slot. */
267 /* Mark and sweep: this may sleep */
269 /* Check double free */
270 WARN_ON(kip->slot_used[idx] != SLOT_USED);
272 kip->slot_used[idx] = SLOT_DIRTY;
274 if (++c->nr_garbage > slots_per_page(c))
275 collect_garbage_slots(c);
277 collect_one_slot(kip, idx);
280 mutex_unlock(&c->mutex);
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.
288 bool __is_insn_slot_addr(struct kprobe_insn_cache *c, unsigned long addr)
290 struct kprobe_insn_page *kip;
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) {
306 #ifdef CONFIG_OPTPROBES
307 /* For optimized_kprobe buffer */
308 struct kprobe_insn_cache kprobe_optinsn_slots = {
309 .mutex = __MUTEX_INITIALIZER(kprobe_optinsn_slots.mutex),
310 .alloc = alloc_insn_page,
311 .free = free_insn_page,
312 .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
313 /* .insn_size is initialized later */
319 /* We have preemption disabled.. so it is safe to use __ versions */
320 static inline void set_kprobe_instance(struct kprobe *kp)
322 __this_cpu_write(kprobe_instance, kp);
325 static inline void reset_kprobe_instance(void)
327 __this_cpu_write(kprobe_instance, NULL);
331 * This routine is called either:
332 * - under the kprobe_mutex - during kprobe_[un]register()
334 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
336 struct kprobe *get_kprobe(void *addr)
338 struct hlist_head *head;
341 head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
342 hlist_for_each_entry_rcu(p, head, hlist) {
349 NOKPROBE_SYMBOL(get_kprobe);
351 static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
353 /* Return true if the kprobe is an aggregator */
354 static inline int kprobe_aggrprobe(struct kprobe *p)
356 return p->pre_handler == aggr_pre_handler;
359 /* Return true(!0) if the kprobe is unused */
360 static inline int kprobe_unused(struct kprobe *p)
362 return kprobe_aggrprobe(p) && kprobe_disabled(p) &&
363 list_empty(&p->list);
367 * Keep all fields in the kprobe consistent
369 static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
371 memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
372 memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
375 #ifdef CONFIG_OPTPROBES
376 /* NOTE: change this value only with kprobe_mutex held */
377 static bool kprobes_allow_optimization;
380 * Call all pre_handler on the list, but ignores its return value.
381 * This must be called from arch-dep optimized caller.
383 void opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
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);
392 reset_kprobe_instance();
395 NOKPROBE_SYMBOL(opt_pre_handler);
397 /* Free optimized instructions and optimized_kprobe */
398 static void free_aggr_kprobe(struct kprobe *p)
400 struct optimized_kprobe *op;
402 op = container_of(p, struct optimized_kprobe, kp);
403 arch_remove_optimized_kprobe(op);
404 arch_remove_kprobe(p);
408 /* Return true(!0) if the kprobe is ready for optimization. */
409 static inline int kprobe_optready(struct kprobe *p)
411 struct optimized_kprobe *op;
413 if (kprobe_aggrprobe(p)) {
414 op = container_of(p, struct optimized_kprobe, kp);
415 return arch_prepared_optinsn(&op->optinsn);
421 /* Return true(!0) if the kprobe is disarmed. Note: p must be on hash list */
422 static inline int kprobe_disarmed(struct kprobe *p)
424 struct optimized_kprobe *op;
426 /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
427 if (!kprobe_aggrprobe(p))
428 return kprobe_disabled(p);
430 op = container_of(p, struct optimized_kprobe, kp);
432 return kprobe_disabled(p) && list_empty(&op->list);
435 /* Return true(!0) if the probe is queued on (un)optimizing lists */
436 static int kprobe_queued(struct kprobe *p)
438 struct optimized_kprobe *op;
440 if (kprobe_aggrprobe(p)) {
441 op = container_of(p, struct optimized_kprobe, kp);
442 if (!list_empty(&op->list))
449 * Return an optimized kprobe whose optimizing code replaces
450 * instructions including addr (exclude breakpoint).
452 static struct kprobe *get_optimized_kprobe(unsigned long addr)
455 struct kprobe *p = NULL;
456 struct optimized_kprobe *op;
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));
462 if (p && kprobe_optready(p)) {
463 op = container_of(p, struct optimized_kprobe, kp);
464 if (arch_within_optimized_kprobe(op, addr))
471 /* Optimization staging list, protected by kprobe_mutex */
472 static LIST_HEAD(optimizing_list);
473 static LIST_HEAD(unoptimizing_list);
474 static LIST_HEAD(freeing_list);
476 static void kprobe_optimizer(struct work_struct *work);
477 static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
478 #define OPTIMIZE_DELAY 5
481 * Optimize (replace a breakpoint with a jump) kprobes listed on
484 static void do_optimize_kprobes(void)
487 * The optimization/unoptimization refers online_cpus via
488 * stop_machine() and cpu-hotplug modifies online_cpus.
489 * And same time, text_mutex will be held in cpu-hotplug and here.
490 * This combination can cause a deadlock (cpu-hotplug try to lock
491 * text_mutex but stop_machine can not be done because online_cpus
493 * To avoid this deadlock, caller must have locked cpu hotplug
494 * for preventing cpu-hotplug outside of text_mutex locking.
496 lockdep_assert_cpus_held();
498 /* Optimization never be done when disarmed */
499 if (kprobes_all_disarmed || !kprobes_allow_optimization ||
500 list_empty(&optimizing_list))
503 mutex_lock(&text_mutex);
504 arch_optimize_kprobes(&optimizing_list);
505 mutex_unlock(&text_mutex);
509 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
510 * if need) kprobes listed on unoptimizing_list.
512 static void do_unoptimize_kprobes(void)
514 struct optimized_kprobe *op, *tmp;
516 /* See comment in do_optimize_kprobes() */
517 lockdep_assert_cpus_held();
519 /* Unoptimization must be done anytime */
520 if (list_empty(&unoptimizing_list))
523 mutex_lock(&text_mutex);
524 arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
525 /* Loop free_list for disarming */
526 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
527 /* Disarm probes if marked disabled */
528 if (kprobe_disabled(&op->kp))
529 arch_disarm_kprobe(&op->kp);
530 if (kprobe_unused(&op->kp)) {
532 * Remove unused probes from hash list. After waiting
533 * for synchronization, these probes are reclaimed.
534 * (reclaiming is done by do_free_cleaned_kprobes.)
536 hlist_del_rcu(&op->kp.hlist);
538 list_del_init(&op->list);
540 mutex_unlock(&text_mutex);
543 /* Reclaim all kprobes on the free_list */
544 static void do_free_cleaned_kprobes(void)
546 struct optimized_kprobe *op, *tmp;
548 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
549 BUG_ON(!kprobe_unused(&op->kp));
550 list_del_init(&op->list);
551 free_aggr_kprobe(&op->kp);
555 /* Start optimizer after OPTIMIZE_DELAY passed */
556 static void kick_kprobe_optimizer(void)
558 schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
561 /* Kprobe jump optimizer */
562 static void kprobe_optimizer(struct work_struct *work)
564 mutex_lock(&kprobe_mutex);
566 /* Lock modules while optimizing kprobes */
567 mutex_lock(&module_mutex);
570 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
571 * kprobes before waiting for quiesence period.
573 do_unoptimize_kprobes();
576 * Step 2: Wait for quiesence period to ensure all potentially
577 * preempted tasks to have normally scheduled. Because optprobe
578 * may modify multiple instructions, there is a chance that Nth
579 * instruction is preempted. In that case, such tasks can return
580 * to 2nd-Nth byte of jump instruction. This wait is for avoiding it.
581 * Note that on non-preemptive kernel, this is transparently converted
582 * to synchronoze_sched() to wait for all interrupts to have completed.
584 synchronize_rcu_tasks();
586 /* Step 3: Optimize kprobes after quiesence period */
587 do_optimize_kprobes();
589 /* Step 4: Free cleaned kprobes after quiesence period */
590 do_free_cleaned_kprobes();
592 mutex_unlock(&module_mutex);
594 mutex_unlock(&kprobe_mutex);
596 /* Step 5: Kick optimizer again if needed */
597 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
598 kick_kprobe_optimizer();
601 /* Wait for completing optimization and unoptimization */
602 void wait_for_kprobe_optimizer(void)
604 mutex_lock(&kprobe_mutex);
606 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
607 mutex_unlock(&kprobe_mutex);
609 /* this will also make optimizing_work execute immmediately */
610 flush_delayed_work(&optimizing_work);
611 /* @optimizing_work might not have been queued yet, relax */
614 mutex_lock(&kprobe_mutex);
617 mutex_unlock(&kprobe_mutex);
620 /* Optimize kprobe if p is ready to be optimized */
621 static void optimize_kprobe(struct kprobe *p)
623 struct optimized_kprobe *op;
625 /* Check if the kprobe is disabled or not ready for optimization. */
626 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
627 (kprobe_disabled(p) || kprobes_all_disarmed))
630 /* Both of break_handler and post_handler are not supported. */
631 if (p->break_handler || p->post_handler)
634 op = container_of(p, struct optimized_kprobe, kp);
636 /* Check there is no other kprobes at the optimized instructions */
637 if (arch_check_optimized_kprobe(op) < 0)
640 /* Check if it is already optimized. */
641 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED)
643 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
645 if (!list_empty(&op->list))
646 /* This is under unoptimizing. Just dequeue the probe */
647 list_del_init(&op->list);
649 list_add(&op->list, &optimizing_list);
650 kick_kprobe_optimizer();
654 /* Short cut to direct unoptimizing */
655 static void force_unoptimize_kprobe(struct optimized_kprobe *op)
657 lockdep_assert_cpus_held();
658 arch_unoptimize_kprobe(op);
659 if (kprobe_disabled(&op->kp))
660 arch_disarm_kprobe(&op->kp);
663 /* Unoptimize a kprobe if p is optimized */
664 static void unoptimize_kprobe(struct kprobe *p, bool force)
666 struct optimized_kprobe *op;
668 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
669 return; /* This is not an optprobe nor optimized */
671 op = container_of(p, struct optimized_kprobe, kp);
672 if (!kprobe_optimized(p)) {
673 /* Unoptimized or unoptimizing case */
674 if (force && !list_empty(&op->list)) {
676 * Only if this is unoptimizing kprobe and forced,
677 * forcibly unoptimize it. (No need to unoptimize
678 * unoptimized kprobe again :)
680 list_del_init(&op->list);
681 force_unoptimize_kprobe(op);
686 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
687 if (!list_empty(&op->list)) {
688 /* Dequeue from the optimization queue */
689 list_del_init(&op->list);
692 /* Optimized kprobe case */
694 /* Forcibly update the code: this is a special case */
695 force_unoptimize_kprobe(op);
697 list_add(&op->list, &unoptimizing_list);
698 kick_kprobe_optimizer();
702 /* Cancel unoptimizing for reusing */
703 static void reuse_unused_kprobe(struct kprobe *ap)
705 struct optimized_kprobe *op;
707 BUG_ON(!kprobe_unused(ap));
709 * Unused kprobe MUST be on the way of delayed unoptimizing (means
710 * there is still a relative jump) and disabled.
712 op = container_of(ap, struct optimized_kprobe, kp);
713 if (unlikely(list_empty(&op->list)))
714 printk(KERN_WARNING "Warning: found a stray unused "
715 "aggrprobe@%p\n", ap->addr);
716 /* Enable the probe again */
717 ap->flags &= ~KPROBE_FLAG_DISABLED;
718 /* Optimize it again (remove from op->list) */
719 BUG_ON(!kprobe_optready(ap));
723 /* Remove optimized instructions */
724 static void kill_optimized_kprobe(struct kprobe *p)
726 struct optimized_kprobe *op;
728 op = container_of(p, struct optimized_kprobe, kp);
729 if (!list_empty(&op->list))
730 /* Dequeue from the (un)optimization queue */
731 list_del_init(&op->list);
732 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
734 if (kprobe_unused(p)) {
735 /* Enqueue if it is unused */
736 list_add(&op->list, &freeing_list);
738 * Remove unused probes from the hash list. After waiting
739 * for synchronization, this probe is reclaimed.
740 * (reclaiming is done by do_free_cleaned_kprobes().)
742 hlist_del_rcu(&op->kp.hlist);
745 /* Don't touch the code, because it is already freed. */
746 arch_remove_optimized_kprobe(op);
750 void __prepare_optimized_kprobe(struct optimized_kprobe *op, struct kprobe *p)
752 if (!kprobe_ftrace(p))
753 arch_prepare_optimized_kprobe(op, p);
756 /* Try to prepare optimized instructions */
757 static void prepare_optimized_kprobe(struct kprobe *p)
759 struct optimized_kprobe *op;
761 op = container_of(p, struct optimized_kprobe, kp);
762 __prepare_optimized_kprobe(op, p);
765 /* Allocate new optimized_kprobe and try to prepare optimized instructions */
766 static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
768 struct optimized_kprobe *op;
770 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
774 INIT_LIST_HEAD(&op->list);
775 op->kp.addr = p->addr;
776 __prepare_optimized_kprobe(op, p);
781 static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
784 * Prepare an optimized_kprobe and optimize it
785 * NOTE: p must be a normal registered kprobe
787 static void try_to_optimize_kprobe(struct kprobe *p)
790 struct optimized_kprobe *op;
792 /* Impossible to optimize ftrace-based kprobe */
793 if (kprobe_ftrace(p))
796 /* For preparing optimization, jump_label_text_reserved() is called */
799 mutex_lock(&text_mutex);
801 ap = alloc_aggr_kprobe(p);
805 op = container_of(ap, struct optimized_kprobe, kp);
806 if (!arch_prepared_optinsn(&op->optinsn)) {
807 /* If failed to setup optimizing, fallback to kprobe */
808 arch_remove_optimized_kprobe(op);
813 init_aggr_kprobe(ap, p);
814 optimize_kprobe(ap); /* This just kicks optimizer thread */
817 mutex_unlock(&text_mutex);
823 static void optimize_all_kprobes(void)
825 struct hlist_head *head;
829 mutex_lock(&kprobe_mutex);
830 /* If optimization is already allowed, just return */
831 if (kprobes_allow_optimization)
835 kprobes_allow_optimization = true;
836 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
837 head = &kprobe_table[i];
838 hlist_for_each_entry_rcu(p, head, hlist)
839 if (!kprobe_disabled(p))
843 printk(KERN_INFO "Kprobes globally optimized\n");
845 mutex_unlock(&kprobe_mutex);
848 static void unoptimize_all_kprobes(void)
850 struct hlist_head *head;
854 mutex_lock(&kprobe_mutex);
855 /* If optimization is already prohibited, just return */
856 if (!kprobes_allow_optimization) {
857 mutex_unlock(&kprobe_mutex);
862 kprobes_allow_optimization = false;
863 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
864 head = &kprobe_table[i];
865 hlist_for_each_entry_rcu(p, head, hlist) {
866 if (!kprobe_disabled(p))
867 unoptimize_kprobe(p, false);
871 mutex_unlock(&kprobe_mutex);
873 /* Wait for unoptimizing completion */
874 wait_for_kprobe_optimizer();
875 printk(KERN_INFO "Kprobes globally unoptimized\n");
878 static DEFINE_MUTEX(kprobe_sysctl_mutex);
879 int sysctl_kprobes_optimization;
880 int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
881 void __user *buffer, size_t *length,
886 mutex_lock(&kprobe_sysctl_mutex);
887 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
888 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
890 if (sysctl_kprobes_optimization)
891 optimize_all_kprobes();
893 unoptimize_all_kprobes();
894 mutex_unlock(&kprobe_sysctl_mutex);
898 #endif /* CONFIG_SYSCTL */
900 /* Put a breakpoint for a probe. Must be called with text_mutex locked */
901 static void __arm_kprobe(struct kprobe *p)
905 /* Check collision with other optimized kprobes */
906 _p = get_optimized_kprobe((unsigned long)p->addr);
908 /* Fallback to unoptimized kprobe */
909 unoptimize_kprobe(_p, true);
912 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
915 /* Remove the breakpoint of a probe. Must be called with text_mutex locked */
916 static void __disarm_kprobe(struct kprobe *p, bool reopt)
920 /* Try to unoptimize */
921 unoptimize_kprobe(p, kprobes_all_disarmed);
923 if (!kprobe_queued(p)) {
924 arch_disarm_kprobe(p);
925 /* If another kprobe was blocked, optimize it. */
926 _p = get_optimized_kprobe((unsigned long)p->addr);
927 if (unlikely(_p) && reopt)
930 /* TODO: reoptimize others after unoptimized this probe */
933 #else /* !CONFIG_OPTPROBES */
935 #define optimize_kprobe(p) do {} while (0)
936 #define unoptimize_kprobe(p, f) do {} while (0)
937 #define kill_optimized_kprobe(p) do {} while (0)
938 #define prepare_optimized_kprobe(p) do {} while (0)
939 #define try_to_optimize_kprobe(p) do {} while (0)
940 #define __arm_kprobe(p) arch_arm_kprobe(p)
941 #define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
942 #define kprobe_disarmed(p) kprobe_disabled(p)
943 #define wait_for_kprobe_optimizer() do {} while (0)
945 /* There should be no unused kprobes can be reused without optimization */
946 static void reuse_unused_kprobe(struct kprobe *ap)
948 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
949 BUG_ON(kprobe_unused(ap));
952 static void free_aggr_kprobe(struct kprobe *p)
954 arch_remove_kprobe(p);
958 static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
960 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
962 #endif /* CONFIG_OPTPROBES */
964 #ifdef CONFIG_KPROBES_ON_FTRACE
965 static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
966 .func = kprobe_ftrace_handler,
967 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
969 static int kprobe_ftrace_enabled;
971 /* Must ensure p->addr is really on ftrace */
972 static int prepare_kprobe(struct kprobe *p)
974 if (!kprobe_ftrace(p))
975 return arch_prepare_kprobe(p);
977 return arch_prepare_kprobe_ftrace(p);
980 /* Caller must lock kprobe_mutex */
981 static void arm_kprobe_ftrace(struct kprobe *p)
985 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
986 (unsigned long)p->addr, 0, 0);
987 WARN(ret < 0, "Failed to arm kprobe-ftrace at %p (%d)\n", p->addr, ret);
988 kprobe_ftrace_enabled++;
989 if (kprobe_ftrace_enabled == 1) {
990 ret = register_ftrace_function(&kprobe_ftrace_ops);
991 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
995 /* Caller must lock kprobe_mutex */
996 static void disarm_kprobe_ftrace(struct kprobe *p)
1000 kprobe_ftrace_enabled--;
1001 if (kprobe_ftrace_enabled == 0) {
1002 ret = unregister_ftrace_function(&kprobe_ftrace_ops);
1003 WARN(ret < 0, "Failed to init kprobe-ftrace (%d)\n", ret);
1005 ret = ftrace_set_filter_ip(&kprobe_ftrace_ops,
1006 (unsigned long)p->addr, 1, 0);
1007 WARN(ret < 0, "Failed to disarm kprobe-ftrace at %p (%d)\n", p->addr, ret);
1009 #else /* !CONFIG_KPROBES_ON_FTRACE */
1010 #define prepare_kprobe(p) arch_prepare_kprobe(p)
1011 #define arm_kprobe_ftrace(p) do {} while (0)
1012 #define disarm_kprobe_ftrace(p) do {} while (0)
1015 /* Arm a kprobe with text_mutex */
1016 static void arm_kprobe(struct kprobe *kp)
1018 if (unlikely(kprobe_ftrace(kp))) {
1019 arm_kprobe_ftrace(kp);
1023 mutex_lock(&text_mutex);
1025 mutex_unlock(&text_mutex);
1029 /* Disarm a kprobe with text_mutex */
1030 static void disarm_kprobe(struct kprobe *kp, bool reopt)
1032 if (unlikely(kprobe_ftrace(kp))) {
1033 disarm_kprobe_ftrace(kp);
1038 mutex_lock(&text_mutex);
1039 __disarm_kprobe(kp, reopt);
1040 mutex_unlock(&text_mutex);
1045 * Aggregate handlers for multiple kprobes support - these handlers
1046 * take care of invoking the individual kprobe handlers on p->list
1048 static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
1052 list_for_each_entry_rcu(kp, &p->list, list) {
1053 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
1054 set_kprobe_instance(kp);
1055 if (kp->pre_handler(kp, regs))
1058 reset_kprobe_instance();
1062 NOKPROBE_SYMBOL(aggr_pre_handler);
1064 static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1065 unsigned long flags)
1069 list_for_each_entry_rcu(kp, &p->list, list) {
1070 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
1071 set_kprobe_instance(kp);
1072 kp->post_handler(kp, regs, flags);
1073 reset_kprobe_instance();
1077 NOKPROBE_SYMBOL(aggr_post_handler);
1079 static int aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
1082 struct kprobe *cur = __this_cpu_read(kprobe_instance);
1085 * if we faulted "during" the execution of a user specified
1086 * probe handler, invoke just that probe's fault handler
1088 if (cur && cur->fault_handler) {
1089 if (cur->fault_handler(cur, regs, trapnr))
1094 NOKPROBE_SYMBOL(aggr_fault_handler);
1096 static int aggr_break_handler(struct kprobe *p, struct pt_regs *regs)
1098 struct kprobe *cur = __this_cpu_read(kprobe_instance);
1101 if (cur && cur->break_handler) {
1102 if (cur->break_handler(cur, regs))
1105 reset_kprobe_instance();
1108 NOKPROBE_SYMBOL(aggr_break_handler);
1110 /* Walks the list and increments nmissed count for multiprobe case */
1111 void kprobes_inc_nmissed_count(struct kprobe *p)
1114 if (!kprobe_aggrprobe(p)) {
1117 list_for_each_entry_rcu(kp, &p->list, list)
1122 NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
1124 void recycle_rp_inst(struct kretprobe_instance *ri,
1125 struct hlist_head *head)
1127 struct kretprobe *rp = ri->rp;
1129 /* remove rp inst off the rprobe_inst_table */
1130 hlist_del(&ri->hlist);
1131 INIT_HLIST_NODE(&ri->hlist);
1133 raw_spin_lock(&rp->lock);
1134 hlist_add_head(&ri->hlist, &rp->free_instances);
1135 raw_spin_unlock(&rp->lock);
1138 hlist_add_head(&ri->hlist, head);
1140 NOKPROBE_SYMBOL(recycle_rp_inst);
1142 void kretprobe_hash_lock(struct task_struct *tsk,
1143 struct hlist_head **head, unsigned long *flags)
1144 __acquires(hlist_lock)
1146 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
1147 raw_spinlock_t *hlist_lock;
1149 *head = &kretprobe_inst_table[hash];
1150 hlist_lock = kretprobe_table_lock_ptr(hash);
1151 raw_spin_lock_irqsave(hlist_lock, *flags);
1153 NOKPROBE_SYMBOL(kretprobe_hash_lock);
1155 static void kretprobe_table_lock(unsigned long hash,
1156 unsigned long *flags)
1157 __acquires(hlist_lock)
1159 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1160 raw_spin_lock_irqsave(hlist_lock, *flags);
1162 NOKPROBE_SYMBOL(kretprobe_table_lock);
1164 void kretprobe_hash_unlock(struct task_struct *tsk,
1165 unsigned long *flags)
1166 __releases(hlist_lock)
1168 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
1169 raw_spinlock_t *hlist_lock;
1171 hlist_lock = kretprobe_table_lock_ptr(hash);
1172 raw_spin_unlock_irqrestore(hlist_lock, *flags);
1174 NOKPROBE_SYMBOL(kretprobe_hash_unlock);
1176 static void kretprobe_table_unlock(unsigned long hash,
1177 unsigned long *flags)
1178 __releases(hlist_lock)
1180 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1181 raw_spin_unlock_irqrestore(hlist_lock, *flags);
1183 NOKPROBE_SYMBOL(kretprobe_table_unlock);
1186 * This function is called from finish_task_switch when task tk becomes dead,
1187 * so that we can recycle any function-return probe instances associated
1188 * with this task. These left over instances represent probed functions
1189 * that have been called but will never return.
1191 void kprobe_flush_task(struct task_struct *tk)
1193 struct kretprobe_instance *ri;
1194 struct hlist_head *head, empty_rp;
1195 struct hlist_node *tmp;
1196 unsigned long hash, flags = 0;
1198 if (unlikely(!kprobes_initialized))
1199 /* Early boot. kretprobe_table_locks not yet initialized. */
1202 INIT_HLIST_HEAD(&empty_rp);
1203 hash = hash_ptr(tk, KPROBE_HASH_BITS);
1204 head = &kretprobe_inst_table[hash];
1205 kretprobe_table_lock(hash, &flags);
1206 hlist_for_each_entry_safe(ri, tmp, head, hlist) {
1208 recycle_rp_inst(ri, &empty_rp);
1210 kretprobe_table_unlock(hash, &flags);
1211 hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
1212 hlist_del(&ri->hlist);
1216 NOKPROBE_SYMBOL(kprobe_flush_task);
1218 static inline void free_rp_inst(struct kretprobe *rp)
1220 struct kretprobe_instance *ri;
1221 struct hlist_node *next;
1223 hlist_for_each_entry_safe(ri, next, &rp->free_instances, hlist) {
1224 hlist_del(&ri->hlist);
1229 static void cleanup_rp_inst(struct kretprobe *rp)
1231 unsigned long flags, hash;
1232 struct kretprobe_instance *ri;
1233 struct hlist_node *next;
1234 struct hlist_head *head;
1237 for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
1238 kretprobe_table_lock(hash, &flags);
1239 head = &kretprobe_inst_table[hash];
1240 hlist_for_each_entry_safe(ri, next, head, hlist) {
1244 kretprobe_table_unlock(hash, &flags);
1248 NOKPROBE_SYMBOL(cleanup_rp_inst);
1251 * Add the new probe to ap->list. Fail if this is the
1252 * second jprobe at the address - two jprobes can't coexist
1254 static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
1256 BUG_ON(kprobe_gone(ap) || kprobe_gone(p));
1258 if (p->break_handler || p->post_handler)
1259 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
1261 if (p->break_handler) {
1262 if (ap->break_handler)
1264 list_add_tail_rcu(&p->list, &ap->list);
1265 ap->break_handler = aggr_break_handler;
1267 list_add_rcu(&p->list, &ap->list);
1268 if (p->post_handler && !ap->post_handler)
1269 ap->post_handler = aggr_post_handler;
1275 * Fill in the required fields of the "manager kprobe". Replace the
1276 * earlier kprobe in the hlist with the manager kprobe
1278 static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
1280 /* Copy p's insn slot to ap */
1282 flush_insn_slot(ap);
1284 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
1285 ap->pre_handler = aggr_pre_handler;
1286 ap->fault_handler = aggr_fault_handler;
1287 /* We don't care the kprobe which has gone. */
1288 if (p->post_handler && !kprobe_gone(p))
1289 ap->post_handler = aggr_post_handler;
1290 if (p->break_handler && !kprobe_gone(p))
1291 ap->break_handler = aggr_break_handler;
1293 INIT_LIST_HEAD(&ap->list);
1294 INIT_HLIST_NODE(&ap->hlist);
1296 list_add_rcu(&p->list, &ap->list);
1297 hlist_replace_rcu(&p->hlist, &ap->hlist);
1301 * This is the second or subsequent kprobe at the address - handle
1304 static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
1307 struct kprobe *ap = orig_p;
1311 /* For preparing optimization, jump_label_text_reserved() is called */
1313 mutex_lock(&text_mutex);
1315 if (!kprobe_aggrprobe(orig_p)) {
1316 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1317 ap = alloc_aggr_kprobe(orig_p);
1322 init_aggr_kprobe(ap, orig_p);
1323 } else if (kprobe_unused(ap))
1324 /* This probe is going to die. Rescue it */
1325 reuse_unused_kprobe(ap);
1327 if (kprobe_gone(ap)) {
1329 * Attempting to insert new probe at the same location that
1330 * had a probe in the module vaddr area which already
1331 * freed. So, the instruction slot has already been
1332 * released. We need a new slot for the new probe.
1334 ret = arch_prepare_kprobe(ap);
1337 * Even if fail to allocate new slot, don't need to
1338 * free aggr_probe. It will be used next time, or
1339 * freed by unregister_kprobe.
1343 /* Prepare optimized instructions if possible. */
1344 prepare_optimized_kprobe(ap);
1347 * Clear gone flag to prevent allocating new slot again, and
1348 * set disabled flag because it is not armed yet.
1350 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1351 | KPROBE_FLAG_DISABLED;
1354 /* Copy ap's insn slot to p */
1356 ret = add_new_kprobe(ap, p);
1359 mutex_unlock(&text_mutex);
1360 jump_label_unlock();
1363 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1364 ap->flags &= ~KPROBE_FLAG_DISABLED;
1365 if (!kprobes_all_disarmed)
1366 /* Arm the breakpoint again. */
1372 bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1374 /* The __kprobes marked functions and entry code must not be probed */
1375 return addr >= (unsigned long)__kprobes_text_start &&
1376 addr < (unsigned long)__kprobes_text_end;
1379 bool within_kprobe_blacklist(unsigned long addr)
1381 struct kprobe_blacklist_entry *ent;
1383 if (arch_within_kprobe_blacklist(addr))
1386 * If there exists a kprobe_blacklist, verify and
1387 * fail any probe registration in the prohibited area
1389 list_for_each_entry(ent, &kprobe_blacklist, list) {
1390 if (addr >= ent->start_addr && addr < ent->end_addr)
1398 * If we have a symbol_name argument, look it up and add the offset field
1399 * to it. This way, we can specify a relative address to a symbol.
1400 * This returns encoded errors if it fails to look up symbol or invalid
1401 * combination of parameters.
1403 static kprobe_opcode_t *_kprobe_addr(kprobe_opcode_t *addr,
1404 const char *symbol_name, unsigned int offset)
1406 if ((symbol_name && addr) || (!symbol_name && !addr))
1410 addr = kprobe_lookup_name(symbol_name, offset);
1412 return ERR_PTR(-ENOENT);
1415 addr = (kprobe_opcode_t *)(((char *)addr) + offset);
1420 return ERR_PTR(-EINVAL);
1423 static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
1425 return _kprobe_addr(p->addr, p->symbol_name, p->offset);
1428 /* Check passed kprobe is valid and return kprobe in kprobe_table. */
1429 static struct kprobe *__get_valid_kprobe(struct kprobe *p)
1431 struct kprobe *ap, *list_p;
1433 ap = get_kprobe(p->addr);
1438 list_for_each_entry_rcu(list_p, &ap->list, list)
1440 /* kprobe p is a valid probe */
1448 /* Return error if the kprobe is being re-registered */
1449 static inline int check_kprobe_rereg(struct kprobe *p)
1453 mutex_lock(&kprobe_mutex);
1454 if (__get_valid_kprobe(p))
1456 mutex_unlock(&kprobe_mutex);
1461 int __weak arch_check_ftrace_location(struct kprobe *p)
1463 unsigned long ftrace_addr;
1465 ftrace_addr = ftrace_location((unsigned long)p->addr);
1467 #ifdef CONFIG_KPROBES_ON_FTRACE
1468 /* Given address is not on the instruction boundary */
1469 if ((unsigned long)p->addr != ftrace_addr)
1471 p->flags |= KPROBE_FLAG_FTRACE;
1472 #else /* !CONFIG_KPROBES_ON_FTRACE */
1479 static int check_kprobe_address_safe(struct kprobe *p,
1480 struct module **probed_mod)
1484 ret = arch_check_ftrace_location(p);
1490 /* Ensure it is not in reserved area nor out of text */
1491 if (!kernel_text_address((unsigned long) p->addr) ||
1492 within_kprobe_blacklist((unsigned long) p->addr) ||
1493 jump_label_text_reserved(p->addr, p->addr)) {
1498 /* Check if are we probing a module */
1499 *probed_mod = __module_text_address((unsigned long) p->addr);
1502 * We must hold a refcount of the probed module while updating
1503 * its code to prohibit unexpected unloading.
1505 if (unlikely(!try_module_get(*probed_mod))) {
1511 * If the module freed .init.text, we couldn't insert
1514 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1515 (*probed_mod)->state != MODULE_STATE_COMING) {
1516 module_put(*probed_mod);
1523 jump_label_unlock();
1528 int register_kprobe(struct kprobe *p)
1531 struct kprobe *old_p;
1532 struct module *probed_mod;
1533 kprobe_opcode_t *addr;
1535 /* Adjust probe address from symbol */
1536 addr = kprobe_addr(p);
1538 return PTR_ERR(addr);
1541 ret = check_kprobe_rereg(p);
1545 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1546 p->flags &= KPROBE_FLAG_DISABLED;
1548 INIT_LIST_HEAD(&p->list);
1550 ret = check_kprobe_address_safe(p, &probed_mod);
1554 mutex_lock(&kprobe_mutex);
1556 old_p = get_kprobe(p->addr);
1558 /* Since this may unoptimize old_p, locking text_mutex. */
1559 ret = register_aggr_kprobe(old_p, p);
1564 /* Prevent text modification */
1565 mutex_lock(&text_mutex);
1566 ret = prepare_kprobe(p);
1567 mutex_unlock(&text_mutex);
1572 INIT_HLIST_NODE(&p->hlist);
1573 hlist_add_head_rcu(&p->hlist,
1574 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1576 if (!kprobes_all_disarmed && !kprobe_disabled(p))
1579 /* Try to optimize kprobe */
1580 try_to_optimize_kprobe(p);
1582 mutex_unlock(&kprobe_mutex);
1585 module_put(probed_mod);
1589 EXPORT_SYMBOL_GPL(register_kprobe);
1591 /* Check if all probes on the aggrprobe are disabled */
1592 static int aggr_kprobe_disabled(struct kprobe *ap)
1596 list_for_each_entry_rcu(kp, &ap->list, list)
1597 if (!kprobe_disabled(kp))
1599 * There is an active probe on the list.
1600 * We can't disable this ap.
1607 /* Disable one kprobe: Make sure called under kprobe_mutex is locked */
1608 static struct kprobe *__disable_kprobe(struct kprobe *p)
1610 struct kprobe *orig_p;
1612 /* Get an original kprobe for return */
1613 orig_p = __get_valid_kprobe(p);
1614 if (unlikely(orig_p == NULL))
1617 if (!kprobe_disabled(p)) {
1618 /* Disable probe if it is a child probe */
1620 p->flags |= KPROBE_FLAG_DISABLED;
1622 /* Try to disarm and disable this/parent probe */
1623 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
1625 * If kprobes_all_disarmed is set, orig_p
1626 * should have already been disarmed, so
1627 * skip unneed disarming process.
1629 if (!kprobes_all_disarmed)
1630 disarm_kprobe(orig_p, true);
1631 orig_p->flags |= KPROBE_FLAG_DISABLED;
1639 * Unregister a kprobe without a scheduler synchronization.
1641 static int __unregister_kprobe_top(struct kprobe *p)
1643 struct kprobe *ap, *list_p;
1645 /* Disable kprobe. This will disarm it if needed. */
1646 ap = __disable_kprobe(p);
1652 * This probe is an independent(and non-optimized) kprobe
1653 * (not an aggrprobe). Remove from the hash list.
1657 /* Following process expects this probe is an aggrprobe */
1658 WARN_ON(!kprobe_aggrprobe(ap));
1660 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1662 * !disarmed could be happen if the probe is under delayed
1667 /* If disabling probe has special handlers, update aggrprobe */
1668 if (p->break_handler && !kprobe_gone(p))
1669 ap->break_handler = NULL;
1670 if (p->post_handler && !kprobe_gone(p)) {
1671 list_for_each_entry_rcu(list_p, &ap->list, list) {
1672 if ((list_p != p) && (list_p->post_handler))
1675 ap->post_handler = NULL;
1679 * Remove from the aggrprobe: this path will do nothing in
1680 * __unregister_kprobe_bottom().
1682 list_del_rcu(&p->list);
1683 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1685 * Try to optimize this probe again, because post
1686 * handler may have been changed.
1688 optimize_kprobe(ap);
1693 BUG_ON(!kprobe_disarmed(ap));
1694 hlist_del_rcu(&ap->hlist);
1698 static void __unregister_kprobe_bottom(struct kprobe *p)
1702 if (list_empty(&p->list))
1703 /* This is an independent kprobe */
1704 arch_remove_kprobe(p);
1705 else if (list_is_singular(&p->list)) {
1706 /* This is the last child of an aggrprobe */
1707 ap = list_entry(p->list.next, struct kprobe, list);
1709 free_aggr_kprobe(ap);
1711 /* Otherwise, do nothing. */
1714 int register_kprobes(struct kprobe **kps, int num)
1720 for (i = 0; i < num; i++) {
1721 ret = register_kprobe(kps[i]);
1724 unregister_kprobes(kps, i);
1730 EXPORT_SYMBOL_GPL(register_kprobes);
1732 void unregister_kprobe(struct kprobe *p)
1734 unregister_kprobes(&p, 1);
1736 EXPORT_SYMBOL_GPL(unregister_kprobe);
1738 void unregister_kprobes(struct kprobe **kps, int num)
1744 mutex_lock(&kprobe_mutex);
1745 for (i = 0; i < num; i++)
1746 if (__unregister_kprobe_top(kps[i]) < 0)
1747 kps[i]->addr = NULL;
1748 mutex_unlock(&kprobe_mutex);
1750 synchronize_sched();
1751 for (i = 0; i < num; i++)
1753 __unregister_kprobe_bottom(kps[i]);
1755 EXPORT_SYMBOL_GPL(unregister_kprobes);
1757 int __weak kprobe_exceptions_notify(struct notifier_block *self,
1758 unsigned long val, void *data)
1762 NOKPROBE_SYMBOL(kprobe_exceptions_notify);
1764 static struct notifier_block kprobe_exceptions_nb = {
1765 .notifier_call = kprobe_exceptions_notify,
1766 .priority = 0x7fffffff /* we need to be notified first */
1769 unsigned long __weak arch_deref_entry_point(void *entry)
1771 return (unsigned long)entry;
1775 int register_jprobes(struct jprobe **jps, int num)
1782 for (i = 0; i < num; i++) {
1783 ret = register_jprobe(jps[i]);
1787 unregister_jprobes(jps, i);
1794 EXPORT_SYMBOL_GPL(register_jprobes);
1796 int register_jprobe(struct jprobe *jp)
1798 unsigned long addr, offset;
1799 struct kprobe *kp = &jp->kp;
1802 * Verify probepoint as well as the jprobe handler are
1803 * valid function entry points.
1805 addr = arch_deref_entry_point(jp->entry);
1807 if (kallsyms_lookup_size_offset(addr, NULL, &offset) && offset == 0 &&
1808 kprobe_on_func_entry(kp->addr, kp->symbol_name, kp->offset)) {
1809 kp->pre_handler = setjmp_pre_handler;
1810 kp->break_handler = longjmp_break_handler;
1811 return register_kprobe(kp);
1816 EXPORT_SYMBOL_GPL(register_jprobe);
1818 void unregister_jprobe(struct jprobe *jp)
1820 unregister_jprobes(&jp, 1);
1822 EXPORT_SYMBOL_GPL(unregister_jprobe);
1824 void unregister_jprobes(struct jprobe **jps, int num)
1830 mutex_lock(&kprobe_mutex);
1831 for (i = 0; i < num; i++)
1832 if (__unregister_kprobe_top(&jps[i]->kp) < 0)
1833 jps[i]->kp.addr = NULL;
1834 mutex_unlock(&kprobe_mutex);
1836 synchronize_sched();
1837 for (i = 0; i < num; i++) {
1838 if (jps[i]->kp.addr)
1839 __unregister_kprobe_bottom(&jps[i]->kp);
1842 EXPORT_SYMBOL_GPL(unregister_jprobes);
1845 #ifdef CONFIG_KRETPROBES
1847 * This kprobe pre_handler is registered with every kretprobe. When probe
1848 * hits it will set up the return probe.
1850 static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
1852 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
1853 unsigned long hash, flags = 0;
1854 struct kretprobe_instance *ri;
1857 * To avoid deadlocks, prohibit return probing in NMI contexts,
1858 * just skip the probe and increase the (inexact) 'nmissed'
1859 * statistical counter, so that the user is informed that
1860 * something happened:
1862 if (unlikely(in_nmi())) {
1867 /* TODO: consider to only swap the RA after the last pre_handler fired */
1868 hash = hash_ptr(current, KPROBE_HASH_BITS);
1869 raw_spin_lock_irqsave(&rp->lock, flags);
1870 if (!hlist_empty(&rp->free_instances)) {
1871 ri = hlist_entry(rp->free_instances.first,
1872 struct kretprobe_instance, hlist);
1873 hlist_del(&ri->hlist);
1874 raw_spin_unlock_irqrestore(&rp->lock, flags);
1879 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1880 raw_spin_lock_irqsave(&rp->lock, flags);
1881 hlist_add_head(&ri->hlist, &rp->free_instances);
1882 raw_spin_unlock_irqrestore(&rp->lock, flags);
1886 arch_prepare_kretprobe(ri, regs);
1888 /* XXX(hch): why is there no hlist_move_head? */
1889 INIT_HLIST_NODE(&ri->hlist);
1890 kretprobe_table_lock(hash, &flags);
1891 hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
1892 kretprobe_table_unlock(hash, &flags);
1895 raw_spin_unlock_irqrestore(&rp->lock, flags);
1899 NOKPROBE_SYMBOL(pre_handler_kretprobe);
1901 bool __weak arch_kprobe_on_func_entry(unsigned long offset)
1906 bool kprobe_on_func_entry(kprobe_opcode_t *addr, const char *sym, unsigned long offset)
1908 kprobe_opcode_t *kp_addr = _kprobe_addr(addr, sym, offset);
1910 if (IS_ERR(kp_addr))
1913 if (!kallsyms_lookup_size_offset((unsigned long)kp_addr, NULL, &offset) ||
1914 !arch_kprobe_on_func_entry(offset))
1920 int register_kretprobe(struct kretprobe *rp)
1923 struct kretprobe_instance *inst;
1927 if (!kprobe_on_func_entry(rp->kp.addr, rp->kp.symbol_name, rp->kp.offset))
1930 if (kretprobe_blacklist_size) {
1931 addr = kprobe_addr(&rp->kp);
1933 return PTR_ERR(addr);
1935 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1936 if (kretprobe_blacklist[i].addr == addr)
1941 rp->kp.pre_handler = pre_handler_kretprobe;
1942 rp->kp.post_handler = NULL;
1943 rp->kp.fault_handler = NULL;
1944 rp->kp.break_handler = NULL;
1946 /* Pre-allocate memory for max kretprobe instances */
1947 if (rp->maxactive <= 0) {
1948 #ifdef CONFIG_PREEMPT
1949 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
1951 rp->maxactive = num_possible_cpus();
1954 raw_spin_lock_init(&rp->lock);
1955 INIT_HLIST_HEAD(&rp->free_instances);
1956 for (i = 0; i < rp->maxactive; i++) {
1957 inst = kmalloc(sizeof(struct kretprobe_instance) +
1958 rp->data_size, GFP_KERNEL);
1963 INIT_HLIST_NODE(&inst->hlist);
1964 hlist_add_head(&inst->hlist, &rp->free_instances);
1968 /* Establish function entry probe point */
1969 ret = register_kprobe(&rp->kp);
1974 EXPORT_SYMBOL_GPL(register_kretprobe);
1976 int register_kretprobes(struct kretprobe **rps, int num)
1982 for (i = 0; i < num; i++) {
1983 ret = register_kretprobe(rps[i]);
1986 unregister_kretprobes(rps, i);
1992 EXPORT_SYMBOL_GPL(register_kretprobes);
1994 void unregister_kretprobe(struct kretprobe *rp)
1996 unregister_kretprobes(&rp, 1);
1998 EXPORT_SYMBOL_GPL(unregister_kretprobe);
2000 void unregister_kretprobes(struct kretprobe **rps, int num)
2006 mutex_lock(&kprobe_mutex);
2007 for (i = 0; i < num; i++)
2008 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
2009 rps[i]->kp.addr = NULL;
2010 mutex_unlock(&kprobe_mutex);
2012 synchronize_sched();
2013 for (i = 0; i < num; i++) {
2014 if (rps[i]->kp.addr) {
2015 __unregister_kprobe_bottom(&rps[i]->kp);
2016 cleanup_rp_inst(rps[i]);
2020 EXPORT_SYMBOL_GPL(unregister_kretprobes);
2022 #else /* CONFIG_KRETPROBES */
2023 int register_kretprobe(struct kretprobe *rp)
2027 EXPORT_SYMBOL_GPL(register_kretprobe);
2029 int register_kretprobes(struct kretprobe **rps, int num)
2033 EXPORT_SYMBOL_GPL(register_kretprobes);
2035 void unregister_kretprobe(struct kretprobe *rp)
2038 EXPORT_SYMBOL_GPL(unregister_kretprobe);
2040 void unregister_kretprobes(struct kretprobe **rps, int num)
2043 EXPORT_SYMBOL_GPL(unregister_kretprobes);
2045 static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
2049 NOKPROBE_SYMBOL(pre_handler_kretprobe);
2051 #endif /* CONFIG_KRETPROBES */
2053 /* Set the kprobe gone and remove its instruction buffer. */
2054 static void kill_kprobe(struct kprobe *p)
2058 p->flags |= KPROBE_FLAG_GONE;
2059 if (kprobe_aggrprobe(p)) {
2061 * If this is an aggr_kprobe, we have to list all the
2062 * chained probes and mark them GONE.
2064 list_for_each_entry_rcu(kp, &p->list, list)
2065 kp->flags |= KPROBE_FLAG_GONE;
2066 p->post_handler = NULL;
2067 p->break_handler = NULL;
2068 kill_optimized_kprobe(p);
2071 * Here, we can remove insn_slot safely, because no thread calls
2072 * the original probed function (which will be freed soon) any more.
2074 arch_remove_kprobe(p);
2077 /* Disable one kprobe */
2078 int disable_kprobe(struct kprobe *kp)
2082 mutex_lock(&kprobe_mutex);
2084 /* Disable this kprobe */
2085 if (__disable_kprobe(kp) == NULL)
2088 mutex_unlock(&kprobe_mutex);
2091 EXPORT_SYMBOL_GPL(disable_kprobe);
2093 /* Enable one kprobe */
2094 int enable_kprobe(struct kprobe *kp)
2099 mutex_lock(&kprobe_mutex);
2101 /* Check whether specified probe is valid. */
2102 p = __get_valid_kprobe(kp);
2103 if (unlikely(p == NULL)) {
2108 if (kprobe_gone(kp)) {
2109 /* This kprobe has gone, we couldn't enable it. */
2115 kp->flags &= ~KPROBE_FLAG_DISABLED;
2117 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2118 p->flags &= ~KPROBE_FLAG_DISABLED;
2122 mutex_unlock(&kprobe_mutex);
2125 EXPORT_SYMBOL_GPL(enable_kprobe);
2127 void dump_kprobe(struct kprobe *kp)
2129 printk(KERN_WARNING "Dumping kprobe:\n");
2130 printk(KERN_WARNING "Name: %s\nAddress: %p\nOffset: %x\n",
2131 kp->symbol_name, kp->addr, kp->offset);
2133 NOKPROBE_SYMBOL(dump_kprobe);
2136 * Lookup and populate the kprobe_blacklist.
2138 * Unlike the kretprobe blacklist, we'll need to determine
2139 * the range of addresses that belong to the said functions,
2140 * since a kprobe need not necessarily be at the beginning
2143 static int __init populate_kprobe_blacklist(unsigned long *start,
2146 unsigned long *iter;
2147 struct kprobe_blacklist_entry *ent;
2148 unsigned long entry, offset = 0, size = 0;
2150 for (iter = start; iter < end; iter++) {
2151 entry = arch_deref_entry_point((void *)*iter);
2153 if (!kernel_text_address(entry) ||
2154 !kallsyms_lookup_size_offset(entry, &size, &offset)) {
2155 pr_err("Failed to find blacklist at %p\n",
2160 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2163 ent->start_addr = entry;
2164 ent->end_addr = entry + size;
2165 INIT_LIST_HEAD(&ent->list);
2166 list_add_tail(&ent->list, &kprobe_blacklist);
2171 /* Module notifier call back, checking kprobes on the module */
2172 static int kprobes_module_callback(struct notifier_block *nb,
2173 unsigned long val, void *data)
2175 struct module *mod = data;
2176 struct hlist_head *head;
2179 int checkcore = (val == MODULE_STATE_GOING);
2181 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
2185 * When MODULE_STATE_GOING was notified, both of module .text and
2186 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2187 * notified, only .init.text section would be freed. We need to
2188 * disable kprobes which have been inserted in the sections.
2190 mutex_lock(&kprobe_mutex);
2191 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2192 head = &kprobe_table[i];
2193 hlist_for_each_entry_rcu(p, head, hlist)
2194 if (within_module_init((unsigned long)p->addr, mod) ||
2196 within_module_core((unsigned long)p->addr, mod))) {
2198 * The vaddr this probe is installed will soon
2199 * be vfreed buy not synced to disk. Hence,
2200 * disarming the breakpoint isn't needed.
2202 * Note, this will also move any optimized probes
2203 * that are pending to be removed from their
2204 * corresponding lists to the freeing_list and
2205 * will not be touched by the delayed
2206 * kprobe_optimizer work handler.
2211 mutex_unlock(&kprobe_mutex);
2215 static struct notifier_block kprobe_module_nb = {
2216 .notifier_call = kprobes_module_callback,
2220 /* Markers of _kprobe_blacklist section */
2221 extern unsigned long __start_kprobe_blacklist[];
2222 extern unsigned long __stop_kprobe_blacklist[];
2224 static int __init init_kprobes(void)
2228 /* FIXME allocate the probe table, currently defined statically */
2229 /* initialize all list heads */
2230 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2231 INIT_HLIST_HEAD(&kprobe_table[i]);
2232 INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
2233 raw_spin_lock_init(&(kretprobe_table_locks[i].lock));
2236 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2237 __stop_kprobe_blacklist);
2239 pr_err("kprobes: failed to populate blacklist: %d\n", err);
2240 pr_err("Please take care of using kprobes.\n");
2243 if (kretprobe_blacklist_size) {
2244 /* lookup the function address from its name */
2245 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
2246 kretprobe_blacklist[i].addr =
2247 kprobe_lookup_name(kretprobe_blacklist[i].name, 0);
2248 if (!kretprobe_blacklist[i].addr)
2249 printk("kretprobe: lookup failed: %s\n",
2250 kretprobe_blacklist[i].name);
2254 #if defined(CONFIG_OPTPROBES)
2255 #if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
2256 /* Init kprobe_optinsn_slots */
2257 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2259 /* By default, kprobes can be optimized */
2260 kprobes_allow_optimization = true;
2263 /* By default, kprobes are armed */
2264 kprobes_all_disarmed = false;
2266 err = arch_init_kprobes();
2268 err = register_die_notifier(&kprobe_exceptions_nb);
2270 err = register_module_notifier(&kprobe_module_nb);
2272 kprobes_initialized = (err == 0);
2279 #ifdef CONFIG_DEBUG_FS
2280 static void report_probe(struct seq_file *pi, struct kprobe *p,
2281 const char *sym, int offset, char *modname, struct kprobe *pp)
2285 if (p->pre_handler == pre_handler_kretprobe)
2287 else if (p->pre_handler == setjmp_pre_handler)
2293 seq_printf(pi, "%p %s %s+0x%x %s ",
2294 p->addr, kprobe_type, sym, offset,
2295 (modname ? modname : " "));
2297 seq_printf(pi, "%p %s %p ",
2298 p->addr, kprobe_type, p->addr);
2302 seq_printf(pi, "%s%s%s%s\n",
2303 (kprobe_gone(p) ? "[GONE]" : ""),
2304 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
2305 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2306 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
2309 static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
2311 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2314 static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
2317 if (*pos >= KPROBE_TABLE_SIZE)
2322 static void kprobe_seq_stop(struct seq_file *f, void *v)
2327 static int show_kprobe_addr(struct seq_file *pi, void *v)
2329 struct hlist_head *head;
2330 struct kprobe *p, *kp;
2331 const char *sym = NULL;
2332 unsigned int i = *(loff_t *) v;
2333 unsigned long offset = 0;
2334 char *modname, namebuf[KSYM_NAME_LEN];
2336 head = &kprobe_table[i];
2338 hlist_for_each_entry_rcu(p, head, hlist) {
2339 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
2340 &offset, &modname, namebuf);
2341 if (kprobe_aggrprobe(p)) {
2342 list_for_each_entry_rcu(kp, &p->list, list)
2343 report_probe(pi, kp, sym, offset, modname, p);
2345 report_probe(pi, p, sym, offset, modname, NULL);
2351 static const struct seq_operations kprobes_seq_ops = {
2352 .start = kprobe_seq_start,
2353 .next = kprobe_seq_next,
2354 .stop = kprobe_seq_stop,
2355 .show = show_kprobe_addr
2358 static int kprobes_open(struct inode *inode, struct file *filp)
2360 return seq_open(filp, &kprobes_seq_ops);
2363 static const struct file_operations debugfs_kprobes_operations = {
2364 .open = kprobes_open,
2366 .llseek = seq_lseek,
2367 .release = seq_release,
2370 /* kprobes/blacklist -- shows which functions can not be probed */
2371 static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2373 return seq_list_start(&kprobe_blacklist, *pos);
2376 static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2378 return seq_list_next(v, &kprobe_blacklist, pos);
2381 static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2383 struct kprobe_blacklist_entry *ent =
2384 list_entry(v, struct kprobe_blacklist_entry, list);
2386 seq_printf(m, "0x%p-0x%p\t%ps\n", (void *)ent->start_addr,
2387 (void *)ent->end_addr, (void *)ent->start_addr);
2391 static const struct seq_operations kprobe_blacklist_seq_ops = {
2392 .start = kprobe_blacklist_seq_start,
2393 .next = kprobe_blacklist_seq_next,
2394 .stop = kprobe_seq_stop, /* Reuse void function */
2395 .show = kprobe_blacklist_seq_show,
2398 static int kprobe_blacklist_open(struct inode *inode, struct file *filp)
2400 return seq_open(filp, &kprobe_blacklist_seq_ops);
2403 static const struct file_operations debugfs_kprobe_blacklist_ops = {
2404 .open = kprobe_blacklist_open,
2406 .llseek = seq_lseek,
2407 .release = seq_release,
2410 static void arm_all_kprobes(void)
2412 struct hlist_head *head;
2416 mutex_lock(&kprobe_mutex);
2418 /* If kprobes are armed, just return */
2419 if (!kprobes_all_disarmed)
2420 goto already_enabled;
2423 * optimize_kprobe() called by arm_kprobe() checks
2424 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2427 kprobes_all_disarmed = false;
2428 /* Arming kprobes doesn't optimize kprobe itself */
2429 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2430 head = &kprobe_table[i];
2431 hlist_for_each_entry_rcu(p, head, hlist)
2432 if (!kprobe_disabled(p))
2436 printk(KERN_INFO "Kprobes globally enabled\n");
2439 mutex_unlock(&kprobe_mutex);
2443 static void disarm_all_kprobes(void)
2445 struct hlist_head *head;
2449 mutex_lock(&kprobe_mutex);
2451 /* If kprobes are already disarmed, just return */
2452 if (kprobes_all_disarmed) {
2453 mutex_unlock(&kprobe_mutex);
2457 kprobes_all_disarmed = true;
2458 printk(KERN_INFO "Kprobes globally disabled\n");
2460 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2461 head = &kprobe_table[i];
2462 hlist_for_each_entry_rcu(p, head, hlist) {
2463 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p))
2464 disarm_kprobe(p, false);
2467 mutex_unlock(&kprobe_mutex);
2469 /* Wait for disarming all kprobes by optimizer */
2470 wait_for_kprobe_optimizer();
2474 * XXX: The debugfs bool file interface doesn't allow for callbacks
2475 * when the bool state is switched. We can reuse that facility when
2478 static ssize_t read_enabled_file_bool(struct file *file,
2479 char __user *user_buf, size_t count, loff_t *ppos)
2483 if (!kprobes_all_disarmed)
2489 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2492 static ssize_t write_enabled_file_bool(struct file *file,
2493 const char __user *user_buf, size_t count, loff_t *ppos)
2498 buf_size = min(count, (sizeof(buf)-1));
2499 if (copy_from_user(buf, user_buf, buf_size))
2502 buf[buf_size] = '\0';
2512 disarm_all_kprobes();
2521 static const struct file_operations fops_kp = {
2522 .read = read_enabled_file_bool,
2523 .write = write_enabled_file_bool,
2524 .llseek = default_llseek,
2527 static int __init debugfs_kprobe_init(void)
2529 struct dentry *dir, *file;
2530 unsigned int value = 1;
2532 dir = debugfs_create_dir("kprobes", NULL);
2536 file = debugfs_create_file("list", 0444, dir, NULL,
2537 &debugfs_kprobes_operations);
2541 file = debugfs_create_file("enabled", 0600, dir,
2546 file = debugfs_create_file("blacklist", 0444, dir, NULL,
2547 &debugfs_kprobe_blacklist_ops);
2554 debugfs_remove(dir);
2558 late_initcall(debugfs_kprobe_init);
2559 #endif /* CONFIG_DEBUG_FS */
2561 module_init(init_kprobes);
2563 /* defined in arch/.../kernel/kprobes.c */
2564 EXPORT_SYMBOL_GPL(jprobe_return);