1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Kernel Probes (KProbes)
6 * Copyright (C) IBM Corporation, 2002, 2004
8 * 2002-Oct Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
9 * Probes initial implementation (includes suggestions from
11 * 2004-Aug Updated by Prasanna S Panchamukhi <prasanna@in.ibm.com> with
12 * hlists and exceptions notifier as suggested by Andi Kleen.
13 * 2004-July Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
14 * interface to access function arguments.
15 * 2004-Sep Prasanna S Panchamukhi <prasanna@in.ibm.com> Changed Kprobes
16 * exceptions notifier to be first on the priority list.
17 * 2005-May Hien Nguyen <hien@us.ibm.com>, Jim Keniston
18 * <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
19 * <prasanna@in.ibm.com> added function-return probes.
21 #include <linux/kprobes.h>
22 #include <linux/hash.h>
23 #include <linux/init.h>
24 #include <linux/slab.h>
25 #include <linux/stddef.h>
26 #include <linux/export.h>
27 #include <linux/moduleloader.h>
28 #include <linux/kallsyms.h>
29 #include <linux/freezer.h>
30 #include <linux/seq_file.h>
31 #include <linux/debugfs.h>
32 #include <linux/sysctl.h>
33 #include <linux/kdebug.h>
34 #include <linux/memory.h>
35 #include <linux/ftrace.h>
36 #include <linux/cpu.h>
37 #include <linux/jump_label.h>
39 #include <asm/sections.h>
40 #include <asm/cacheflush.h>
41 #include <asm/errno.h>
42 #include <linux/uaccess.h>
44 #define KPROBE_HASH_BITS 6
45 #define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
48 static int kprobes_initialized;
49 static struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
50 static struct hlist_head kretprobe_inst_table[KPROBE_TABLE_SIZE];
52 /* NOTE: change this value only with kprobe_mutex held */
53 static bool kprobes_all_disarmed;
55 /* This protects kprobe_table and optimizing_list */
56 static DEFINE_MUTEX(kprobe_mutex);
57 static DEFINE_PER_CPU(struct kprobe *, kprobe_instance) = NULL;
59 raw_spinlock_t lock ____cacheline_aligned_in_smp;
60 } kretprobe_table_locks[KPROBE_TABLE_SIZE];
62 kprobe_opcode_t * __weak kprobe_lookup_name(const char *name,
63 unsigned int __unused)
65 return ((kprobe_opcode_t *)(kallsyms_lookup_name(name)));
68 static raw_spinlock_t *kretprobe_table_lock_ptr(unsigned long hash)
70 return &(kretprobe_table_locks[hash].lock);
73 /* Blacklist -- list of struct kprobe_blacklist_entry */
74 static LIST_HEAD(kprobe_blacklist);
76 #ifdef __ARCH_WANT_KPROBES_INSN_SLOT
78 * kprobe->ainsn.insn points to the copy of the instruction to be
79 * single-stepped. x86_64, POWER4 and above have no-exec support and
80 * stepping on the instruction on a vmalloced/kmalloced/data page
81 * is a recipe for disaster
83 struct kprobe_insn_page {
84 struct list_head list;
85 kprobe_opcode_t *insns; /* Page of instruction slots */
86 struct kprobe_insn_cache *cache;
92 #define KPROBE_INSN_PAGE_SIZE(slots) \
93 (offsetof(struct kprobe_insn_page, slot_used) + \
94 (sizeof(char) * (slots)))
96 static int slots_per_page(struct kprobe_insn_cache *c)
98 return PAGE_SIZE/(c->insn_size * sizeof(kprobe_opcode_t));
101 enum kprobe_slot_state {
107 void __weak *alloc_insn_page(void)
109 return module_alloc(PAGE_SIZE);
112 void __weak free_insn_page(void *page)
114 module_memfree(page);
117 struct kprobe_insn_cache kprobe_insn_slots = {
118 .mutex = __MUTEX_INITIALIZER(kprobe_insn_slots.mutex),
119 .alloc = alloc_insn_page,
120 .free = free_insn_page,
121 .pages = LIST_HEAD_INIT(kprobe_insn_slots.pages),
122 .insn_size = MAX_INSN_SIZE,
125 static int collect_garbage_slots(struct kprobe_insn_cache *c);
128 * __get_insn_slot() - Find a slot on an executable page for an instruction.
129 * We allocate an executable page if there's no room on existing ones.
131 kprobe_opcode_t *__get_insn_slot(struct kprobe_insn_cache *c)
133 struct kprobe_insn_page *kip;
134 kprobe_opcode_t *slot = NULL;
136 /* Since the slot array is not protected by rcu, we need a mutex */
137 mutex_lock(&c->mutex);
140 list_for_each_entry_rcu(kip, &c->pages, list) {
141 if (kip->nused < slots_per_page(c)) {
143 for (i = 0; i < slots_per_page(c); i++) {
144 if (kip->slot_used[i] == SLOT_CLEAN) {
145 kip->slot_used[i] = SLOT_USED;
147 slot = kip->insns + (i * c->insn_size);
152 /* kip->nused is broken. Fix it. */
153 kip->nused = slots_per_page(c);
159 /* If there are any garbage slots, collect it and try again. */
160 if (c->nr_garbage && collect_garbage_slots(c) == 0)
163 /* All out of space. Need to allocate a new page. */
164 kip = kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c)), GFP_KERNEL);
169 * Use module_alloc so this page is within +/- 2GB of where the
170 * kernel image and loaded module images reside. This is required
171 * so x86_64 can correctly handle the %rip-relative fixups.
173 kip->insns = c->alloc();
178 INIT_LIST_HEAD(&kip->list);
179 memset(kip->slot_used, SLOT_CLEAN, slots_per_page(c));
180 kip->slot_used[0] = SLOT_USED;
184 list_add_rcu(&kip->list, &c->pages);
187 mutex_unlock(&c->mutex);
191 /* Return 1 if all garbages are collected, otherwise 0. */
192 static int collect_one_slot(struct kprobe_insn_page *kip, int idx)
194 kip->slot_used[idx] = SLOT_CLEAN;
196 if (kip->nused == 0) {
198 * Page is no longer in use. Free it unless
199 * it's the last one. We keep the last one
200 * so as not to have to set it up again the
201 * next time somebody inserts a probe.
203 if (!list_is_singular(&kip->list)) {
204 list_del_rcu(&kip->list);
206 kip->cache->free(kip->insns);
214 static int collect_garbage_slots(struct kprobe_insn_cache *c)
216 struct kprobe_insn_page *kip, *next;
218 /* Ensure no-one is interrupted on the garbages */
221 list_for_each_entry_safe(kip, next, &c->pages, list) {
223 if (kip->ngarbage == 0)
225 kip->ngarbage = 0; /* we will collect all garbages */
226 for (i = 0; i < slots_per_page(c); i++) {
227 if (kip->slot_used[i] == SLOT_DIRTY && collect_one_slot(kip, i))
235 void __free_insn_slot(struct kprobe_insn_cache *c,
236 kprobe_opcode_t *slot, int dirty)
238 struct kprobe_insn_page *kip;
241 mutex_lock(&c->mutex);
243 list_for_each_entry_rcu(kip, &c->pages, list) {
244 idx = ((long)slot - (long)kip->insns) /
245 (c->insn_size * sizeof(kprobe_opcode_t));
246 if (idx >= 0 && idx < slots_per_page(c))
249 /* Could not find this slot. */
254 /* Mark and sweep: this may sleep */
256 /* Check double free */
257 WARN_ON(kip->slot_used[idx] != SLOT_USED);
259 kip->slot_used[idx] = SLOT_DIRTY;
261 if (++c->nr_garbage > slots_per_page(c))
262 collect_garbage_slots(c);
264 collect_one_slot(kip, idx);
267 mutex_unlock(&c->mutex);
271 * Check given address is on the page of kprobe instruction slots.
272 * This will be used for checking whether the address on a stack
273 * is on a text area or not.
275 bool __is_insn_slot_addr(struct kprobe_insn_cache *c, unsigned long addr)
277 struct kprobe_insn_page *kip;
281 list_for_each_entry_rcu(kip, &c->pages, list) {
282 if (addr >= (unsigned long)kip->insns &&
283 addr < (unsigned long)kip->insns + PAGE_SIZE) {
293 #ifdef CONFIG_OPTPROBES
294 /* For optimized_kprobe buffer */
295 struct kprobe_insn_cache kprobe_optinsn_slots = {
296 .mutex = __MUTEX_INITIALIZER(kprobe_optinsn_slots.mutex),
297 .alloc = alloc_insn_page,
298 .free = free_insn_page,
299 .pages = LIST_HEAD_INIT(kprobe_optinsn_slots.pages),
300 /* .insn_size is initialized later */
306 /* We have preemption disabled.. so it is safe to use __ versions */
307 static inline void set_kprobe_instance(struct kprobe *kp)
309 __this_cpu_write(kprobe_instance, kp);
312 static inline void reset_kprobe_instance(void)
314 __this_cpu_write(kprobe_instance, NULL);
318 * This routine is called either:
319 * - under the kprobe_mutex - during kprobe_[un]register()
321 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
323 struct kprobe *get_kprobe(void *addr)
325 struct hlist_head *head;
328 head = &kprobe_table[hash_ptr(addr, KPROBE_HASH_BITS)];
329 hlist_for_each_entry_rcu(p, head, hlist) {
336 NOKPROBE_SYMBOL(get_kprobe);
338 static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs);
340 /* Return true if the kprobe is an aggregator */
341 static inline int kprobe_aggrprobe(struct kprobe *p)
343 return p->pre_handler == aggr_pre_handler;
346 /* Return true(!0) if the kprobe is unused */
347 static inline int kprobe_unused(struct kprobe *p)
349 return kprobe_aggrprobe(p) && kprobe_disabled(p) &&
350 list_empty(&p->list);
354 * Keep all fields in the kprobe consistent
356 static inline void copy_kprobe(struct kprobe *ap, struct kprobe *p)
358 memcpy(&p->opcode, &ap->opcode, sizeof(kprobe_opcode_t));
359 memcpy(&p->ainsn, &ap->ainsn, sizeof(struct arch_specific_insn));
362 #ifdef CONFIG_OPTPROBES
363 /* NOTE: change this value only with kprobe_mutex held */
364 static bool kprobes_allow_optimization;
367 * Call all pre_handler on the list, but ignores its return value.
368 * This must be called from arch-dep optimized caller.
370 void opt_pre_handler(struct kprobe *p, struct pt_regs *regs)
374 list_for_each_entry_rcu(kp, &p->list, list) {
375 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
376 set_kprobe_instance(kp);
377 kp->pre_handler(kp, regs);
379 reset_kprobe_instance();
382 NOKPROBE_SYMBOL(opt_pre_handler);
384 /* Free optimized instructions and optimized_kprobe */
385 static void free_aggr_kprobe(struct kprobe *p)
387 struct optimized_kprobe *op;
389 op = container_of(p, struct optimized_kprobe, kp);
390 arch_remove_optimized_kprobe(op);
391 arch_remove_kprobe(p);
395 /* Return true(!0) if the kprobe is ready for optimization. */
396 static inline int kprobe_optready(struct kprobe *p)
398 struct optimized_kprobe *op;
400 if (kprobe_aggrprobe(p)) {
401 op = container_of(p, struct optimized_kprobe, kp);
402 return arch_prepared_optinsn(&op->optinsn);
408 /* Return true(!0) if the kprobe is disarmed. Note: p must be on hash list */
409 static inline int kprobe_disarmed(struct kprobe *p)
411 struct optimized_kprobe *op;
413 /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
414 if (!kprobe_aggrprobe(p))
415 return kprobe_disabled(p);
417 op = container_of(p, struct optimized_kprobe, kp);
419 return kprobe_disabled(p) && list_empty(&op->list);
422 /* Return true(!0) if the probe is queued on (un)optimizing lists */
423 static int kprobe_queued(struct kprobe *p)
425 struct optimized_kprobe *op;
427 if (kprobe_aggrprobe(p)) {
428 op = container_of(p, struct optimized_kprobe, kp);
429 if (!list_empty(&op->list))
436 * Return an optimized kprobe whose optimizing code replaces
437 * instructions including addr (exclude breakpoint).
439 static struct kprobe *get_optimized_kprobe(unsigned long addr)
442 struct kprobe *p = NULL;
443 struct optimized_kprobe *op;
445 /* Don't check i == 0, since that is a breakpoint case. */
446 for (i = 1; !p && i < MAX_OPTIMIZED_LENGTH; i++)
447 p = get_kprobe((void *)(addr - i));
449 if (p && kprobe_optready(p)) {
450 op = container_of(p, struct optimized_kprobe, kp);
451 if (arch_within_optimized_kprobe(op, addr))
458 /* Optimization staging list, protected by kprobe_mutex */
459 static LIST_HEAD(optimizing_list);
460 static LIST_HEAD(unoptimizing_list);
461 static LIST_HEAD(freeing_list);
463 static void kprobe_optimizer(struct work_struct *work);
464 static DECLARE_DELAYED_WORK(optimizing_work, kprobe_optimizer);
465 #define OPTIMIZE_DELAY 5
468 * Optimize (replace a breakpoint with a jump) kprobes listed on
471 static void do_optimize_kprobes(void)
473 lockdep_assert_held(&text_mutex);
475 * The optimization/unoptimization refers online_cpus via
476 * stop_machine() and cpu-hotplug modifies online_cpus.
477 * And same time, text_mutex will be held in cpu-hotplug and here.
478 * This combination can cause a deadlock (cpu-hotplug try to lock
479 * text_mutex but stop_machine can not be done because online_cpus
481 * To avoid this deadlock, caller must have locked cpu hotplug
482 * for preventing cpu-hotplug outside of text_mutex locking.
484 lockdep_assert_cpus_held();
486 /* Optimization never be done when disarmed */
487 if (kprobes_all_disarmed || !kprobes_allow_optimization ||
488 list_empty(&optimizing_list))
491 arch_optimize_kprobes(&optimizing_list);
495 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
496 * if need) kprobes listed on unoptimizing_list.
498 static void do_unoptimize_kprobes(void)
500 struct optimized_kprobe *op, *tmp;
502 lockdep_assert_held(&text_mutex);
503 /* See comment in do_optimize_kprobes() */
504 lockdep_assert_cpus_held();
506 /* Unoptimization must be done anytime */
507 if (list_empty(&unoptimizing_list))
510 arch_unoptimize_kprobes(&unoptimizing_list, &freeing_list);
511 /* Loop free_list for disarming */
512 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
513 /* Disarm probes if marked disabled */
514 if (kprobe_disabled(&op->kp))
515 arch_disarm_kprobe(&op->kp);
516 if (kprobe_unused(&op->kp)) {
518 * Remove unused probes from hash list. After waiting
519 * for synchronization, these probes are reclaimed.
520 * (reclaiming is done by do_free_cleaned_kprobes.)
522 hlist_del_rcu(&op->kp.hlist);
524 list_del_init(&op->list);
528 /* Reclaim all kprobes on the free_list */
529 static void do_free_cleaned_kprobes(void)
531 struct optimized_kprobe *op, *tmp;
533 list_for_each_entry_safe(op, tmp, &freeing_list, list) {
534 list_del_init(&op->list);
535 if (WARN_ON_ONCE(!kprobe_unused(&op->kp))) {
537 * This must not happen, but if there is a kprobe
538 * still in use, keep it on kprobes hash list.
542 free_aggr_kprobe(&op->kp);
546 /* Start optimizer after OPTIMIZE_DELAY passed */
547 static void kick_kprobe_optimizer(void)
549 schedule_delayed_work(&optimizing_work, OPTIMIZE_DELAY);
552 /* Kprobe jump optimizer */
553 static void kprobe_optimizer(struct work_struct *work)
555 mutex_lock(&kprobe_mutex);
557 mutex_lock(&text_mutex);
558 /* Lock modules while optimizing kprobes */
559 mutex_lock(&module_mutex);
562 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
563 * kprobes before waiting for quiesence period.
565 do_unoptimize_kprobes();
568 * Step 2: Wait for quiesence period to ensure all potentially
569 * preempted tasks to have normally scheduled. Because optprobe
570 * may modify multiple instructions, there is a chance that Nth
571 * instruction is preempted. In that case, such tasks can return
572 * to 2nd-Nth byte of jump instruction. This wait is for avoiding it.
573 * Note that on non-preemptive kernel, this is transparently converted
574 * to synchronoze_sched() to wait for all interrupts to have completed.
576 synchronize_rcu_tasks();
578 /* Step 3: Optimize kprobes after quiesence period */
579 do_optimize_kprobes();
581 /* Step 4: Free cleaned kprobes after quiesence period */
582 do_free_cleaned_kprobes();
584 mutex_unlock(&module_mutex);
585 mutex_unlock(&text_mutex);
587 mutex_unlock(&kprobe_mutex);
589 /* Step 5: Kick optimizer again if needed */
590 if (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list))
591 kick_kprobe_optimizer();
594 /* Wait for completing optimization and unoptimization */
595 void wait_for_kprobe_optimizer(void)
597 mutex_lock(&kprobe_mutex);
599 while (!list_empty(&optimizing_list) || !list_empty(&unoptimizing_list)) {
600 mutex_unlock(&kprobe_mutex);
602 /* this will also make optimizing_work execute immmediately */
603 flush_delayed_work(&optimizing_work);
604 /* @optimizing_work might not have been queued yet, relax */
607 mutex_lock(&kprobe_mutex);
610 mutex_unlock(&kprobe_mutex);
613 /* Optimize kprobe if p is ready to be optimized */
614 static void optimize_kprobe(struct kprobe *p)
616 struct optimized_kprobe *op;
618 /* Check if the kprobe is disabled or not ready for optimization. */
619 if (!kprobe_optready(p) || !kprobes_allow_optimization ||
620 (kprobe_disabled(p) || kprobes_all_disarmed))
623 /* kprobes with post_handler can not be optimized */
627 op = container_of(p, struct optimized_kprobe, kp);
629 /* Check there is no other kprobes at the optimized instructions */
630 if (arch_check_optimized_kprobe(op) < 0)
633 /* Check if it is already optimized. */
634 if (op->kp.flags & KPROBE_FLAG_OPTIMIZED)
636 op->kp.flags |= KPROBE_FLAG_OPTIMIZED;
638 if (!list_empty(&op->list))
639 /* This is under unoptimizing. Just dequeue the probe */
640 list_del_init(&op->list);
642 list_add(&op->list, &optimizing_list);
643 kick_kprobe_optimizer();
647 /* Short cut to direct unoptimizing */
648 static void force_unoptimize_kprobe(struct optimized_kprobe *op)
650 lockdep_assert_cpus_held();
651 arch_unoptimize_kprobe(op);
652 if (kprobe_disabled(&op->kp))
653 arch_disarm_kprobe(&op->kp);
656 /* Unoptimize a kprobe if p is optimized */
657 static void unoptimize_kprobe(struct kprobe *p, bool force)
659 struct optimized_kprobe *op;
661 if (!kprobe_aggrprobe(p) || kprobe_disarmed(p))
662 return; /* This is not an optprobe nor optimized */
664 op = container_of(p, struct optimized_kprobe, kp);
665 if (!kprobe_optimized(p)) {
666 /* Unoptimized or unoptimizing case */
667 if (force && !list_empty(&op->list)) {
669 * Only if this is unoptimizing kprobe and forced,
670 * forcibly unoptimize it. (No need to unoptimize
671 * unoptimized kprobe again :)
673 list_del_init(&op->list);
674 force_unoptimize_kprobe(op);
679 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
680 if (!list_empty(&op->list)) {
681 /* Dequeue from the optimization queue */
682 list_del_init(&op->list);
685 /* Optimized kprobe case */
687 /* Forcibly update the code: this is a special case */
688 force_unoptimize_kprobe(op);
690 list_add(&op->list, &unoptimizing_list);
691 kick_kprobe_optimizer();
695 /* Cancel unoptimizing for reusing */
696 static int reuse_unused_kprobe(struct kprobe *ap)
698 struct optimized_kprobe *op;
701 * Unused kprobe MUST be on the way of delayed unoptimizing (means
702 * there is still a relative jump) and disabled.
704 op = container_of(ap, struct optimized_kprobe, kp);
705 WARN_ON_ONCE(list_empty(&op->list));
706 /* Enable the probe again */
707 ap->flags &= ~KPROBE_FLAG_DISABLED;
708 /* Optimize it again (remove from op->list) */
709 if (!kprobe_optready(ap))
716 /* Remove optimized instructions */
717 static void kill_optimized_kprobe(struct kprobe *p)
719 struct optimized_kprobe *op;
721 op = container_of(p, struct optimized_kprobe, kp);
722 if (!list_empty(&op->list))
723 /* Dequeue from the (un)optimization queue */
724 list_del_init(&op->list);
725 op->kp.flags &= ~KPROBE_FLAG_OPTIMIZED;
727 if (kprobe_unused(p)) {
728 /* Enqueue if it is unused */
729 list_add(&op->list, &freeing_list);
731 * Remove unused probes from the hash list. After waiting
732 * for synchronization, this probe is reclaimed.
733 * (reclaiming is done by do_free_cleaned_kprobes().)
735 hlist_del_rcu(&op->kp.hlist);
738 /* Don't touch the code, because it is already freed. */
739 arch_remove_optimized_kprobe(op);
743 void __prepare_optimized_kprobe(struct optimized_kprobe *op, struct kprobe *p)
745 if (!kprobe_ftrace(p))
746 arch_prepare_optimized_kprobe(op, p);
749 /* Try to prepare optimized instructions */
750 static void prepare_optimized_kprobe(struct kprobe *p)
752 struct optimized_kprobe *op;
754 op = container_of(p, struct optimized_kprobe, kp);
755 __prepare_optimized_kprobe(op, p);
758 /* Allocate new optimized_kprobe and try to prepare optimized instructions */
759 static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
761 struct optimized_kprobe *op;
763 op = kzalloc(sizeof(struct optimized_kprobe), GFP_KERNEL);
767 INIT_LIST_HEAD(&op->list);
768 op->kp.addr = p->addr;
769 __prepare_optimized_kprobe(op, p);
774 static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p);
777 * Prepare an optimized_kprobe and optimize it
778 * NOTE: p must be a normal registered kprobe
780 static void try_to_optimize_kprobe(struct kprobe *p)
783 struct optimized_kprobe *op;
785 /* Impossible to optimize ftrace-based kprobe */
786 if (kprobe_ftrace(p))
789 /* For preparing optimization, jump_label_text_reserved() is called */
792 mutex_lock(&text_mutex);
794 ap = alloc_aggr_kprobe(p);
798 op = container_of(ap, struct optimized_kprobe, kp);
799 if (!arch_prepared_optinsn(&op->optinsn)) {
800 /* If failed to setup optimizing, fallback to kprobe */
801 arch_remove_optimized_kprobe(op);
806 init_aggr_kprobe(ap, p);
807 optimize_kprobe(ap); /* This just kicks optimizer thread */
810 mutex_unlock(&text_mutex);
816 static void optimize_all_kprobes(void)
818 struct hlist_head *head;
822 mutex_lock(&kprobe_mutex);
823 /* If optimization is already allowed, just return */
824 if (kprobes_allow_optimization)
828 kprobes_allow_optimization = true;
829 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
830 head = &kprobe_table[i];
831 hlist_for_each_entry_rcu(p, head, hlist)
832 if (!kprobe_disabled(p))
836 printk(KERN_INFO "Kprobes globally optimized\n");
838 mutex_unlock(&kprobe_mutex);
841 static void unoptimize_all_kprobes(void)
843 struct hlist_head *head;
847 mutex_lock(&kprobe_mutex);
848 /* If optimization is already prohibited, just return */
849 if (!kprobes_allow_optimization) {
850 mutex_unlock(&kprobe_mutex);
855 kprobes_allow_optimization = false;
856 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
857 head = &kprobe_table[i];
858 hlist_for_each_entry_rcu(p, head, hlist) {
859 if (!kprobe_disabled(p))
860 unoptimize_kprobe(p, false);
864 mutex_unlock(&kprobe_mutex);
866 /* Wait for unoptimizing completion */
867 wait_for_kprobe_optimizer();
868 printk(KERN_INFO "Kprobes globally unoptimized\n");
871 static DEFINE_MUTEX(kprobe_sysctl_mutex);
872 int sysctl_kprobes_optimization;
873 int proc_kprobes_optimization_handler(struct ctl_table *table, int write,
874 void __user *buffer, size_t *length,
879 mutex_lock(&kprobe_sysctl_mutex);
880 sysctl_kprobes_optimization = kprobes_allow_optimization ? 1 : 0;
881 ret = proc_dointvec_minmax(table, write, buffer, length, ppos);
883 if (sysctl_kprobes_optimization)
884 optimize_all_kprobes();
886 unoptimize_all_kprobes();
887 mutex_unlock(&kprobe_sysctl_mutex);
891 #endif /* CONFIG_SYSCTL */
893 /* Put a breakpoint for a probe. Must be called with text_mutex locked */
894 static void __arm_kprobe(struct kprobe *p)
898 /* Check collision with other optimized kprobes */
899 _p = get_optimized_kprobe((unsigned long)p->addr);
901 /* Fallback to unoptimized kprobe */
902 unoptimize_kprobe(_p, true);
905 optimize_kprobe(p); /* Try to optimize (add kprobe to a list) */
908 /* Remove the breakpoint of a probe. Must be called with text_mutex locked */
909 static void __disarm_kprobe(struct kprobe *p, bool reopt)
913 /* Try to unoptimize */
914 unoptimize_kprobe(p, kprobes_all_disarmed);
916 if (!kprobe_queued(p)) {
917 arch_disarm_kprobe(p);
918 /* If another kprobe was blocked, optimize it. */
919 _p = get_optimized_kprobe((unsigned long)p->addr);
920 if (unlikely(_p) && reopt)
923 /* TODO: reoptimize others after unoptimized this probe */
926 #else /* !CONFIG_OPTPROBES */
928 #define optimize_kprobe(p) do {} while (0)
929 #define unoptimize_kprobe(p, f) do {} while (0)
930 #define kill_optimized_kprobe(p) do {} while (0)
931 #define prepare_optimized_kprobe(p) do {} while (0)
932 #define try_to_optimize_kprobe(p) do {} while (0)
933 #define __arm_kprobe(p) arch_arm_kprobe(p)
934 #define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
935 #define kprobe_disarmed(p) kprobe_disabled(p)
936 #define wait_for_kprobe_optimizer() do {} while (0)
938 static int reuse_unused_kprobe(struct kprobe *ap)
941 * If the optimized kprobe is NOT supported, the aggr kprobe is
942 * released at the same time that the last aggregated kprobe is
944 * Thus there should be no chance to reuse unused kprobe.
946 printk(KERN_ERR "Error: There should be no unused kprobe here.\n");
950 static void free_aggr_kprobe(struct kprobe *p)
952 arch_remove_kprobe(p);
956 static struct kprobe *alloc_aggr_kprobe(struct kprobe *p)
958 return kzalloc(sizeof(struct kprobe), GFP_KERNEL);
960 #endif /* CONFIG_OPTPROBES */
962 #ifdef CONFIG_KPROBES_ON_FTRACE
963 static struct ftrace_ops kprobe_ftrace_ops __read_mostly = {
964 .func = kprobe_ftrace_handler,
965 .flags = FTRACE_OPS_FL_SAVE_REGS,
968 static struct ftrace_ops kprobe_ipmodify_ops __read_mostly = {
969 .func = kprobe_ftrace_handler,
970 .flags = FTRACE_OPS_FL_SAVE_REGS | FTRACE_OPS_FL_IPMODIFY,
973 static int kprobe_ipmodify_enabled;
974 static int kprobe_ftrace_enabled;
976 /* Must ensure p->addr is really on ftrace */
977 static int prepare_kprobe(struct kprobe *p)
979 if (!kprobe_ftrace(p))
980 return arch_prepare_kprobe(p);
982 return arch_prepare_kprobe_ftrace(p);
985 /* Caller must lock kprobe_mutex */
986 static int __arm_kprobe_ftrace(struct kprobe *p, struct ftrace_ops *ops,
991 ret = ftrace_set_filter_ip(ops, (unsigned long)p->addr, 0, 0);
993 pr_debug("Failed to arm kprobe-ftrace at %pS (%d)\n",
999 ret = register_ftrace_function(ops);
1001 pr_debug("Failed to init kprobe-ftrace (%d)\n", ret);
1011 * At this point, sinec ops is not registered, we should be sefe from
1012 * registering empty filter.
1014 ftrace_set_filter_ip(ops, (unsigned long)p->addr, 1, 0);
1018 static int arm_kprobe_ftrace(struct kprobe *p)
1020 bool ipmodify = (p->post_handler != NULL);
1022 return __arm_kprobe_ftrace(p,
1023 ipmodify ? &kprobe_ipmodify_ops : &kprobe_ftrace_ops,
1024 ipmodify ? &kprobe_ipmodify_enabled : &kprobe_ftrace_enabled);
1027 /* Caller must lock kprobe_mutex */
1028 static int __disarm_kprobe_ftrace(struct kprobe *p, struct ftrace_ops *ops,
1034 ret = unregister_ftrace_function(ops);
1035 if (WARN(ret < 0, "Failed to unregister kprobe-ftrace (%d)\n", ret))
1041 ret = ftrace_set_filter_ip(ops, (unsigned long)p->addr, 1, 0);
1042 WARN_ONCE(ret < 0, "Failed to disarm kprobe-ftrace at %pS (%d)\n",
1047 static int disarm_kprobe_ftrace(struct kprobe *p)
1049 bool ipmodify = (p->post_handler != NULL);
1051 return __disarm_kprobe_ftrace(p,
1052 ipmodify ? &kprobe_ipmodify_ops : &kprobe_ftrace_ops,
1053 ipmodify ? &kprobe_ipmodify_enabled : &kprobe_ftrace_enabled);
1055 #else /* !CONFIG_KPROBES_ON_FTRACE */
1056 #define prepare_kprobe(p) arch_prepare_kprobe(p)
1057 #define arm_kprobe_ftrace(p) (-ENODEV)
1058 #define disarm_kprobe_ftrace(p) (-ENODEV)
1061 /* Arm a kprobe with text_mutex */
1062 static int arm_kprobe(struct kprobe *kp)
1064 if (unlikely(kprobe_ftrace(kp)))
1065 return arm_kprobe_ftrace(kp);
1068 mutex_lock(&text_mutex);
1070 mutex_unlock(&text_mutex);
1076 /* Disarm a kprobe with text_mutex */
1077 static int disarm_kprobe(struct kprobe *kp, bool reopt)
1079 if (unlikely(kprobe_ftrace(kp)))
1080 return disarm_kprobe_ftrace(kp);
1083 mutex_lock(&text_mutex);
1084 __disarm_kprobe(kp, reopt);
1085 mutex_unlock(&text_mutex);
1092 * Aggregate handlers for multiple kprobes support - these handlers
1093 * take care of invoking the individual kprobe handlers on p->list
1095 static int aggr_pre_handler(struct kprobe *p, struct pt_regs *regs)
1099 list_for_each_entry_rcu(kp, &p->list, list) {
1100 if (kp->pre_handler && likely(!kprobe_disabled(kp))) {
1101 set_kprobe_instance(kp);
1102 if (kp->pre_handler(kp, regs))
1105 reset_kprobe_instance();
1109 NOKPROBE_SYMBOL(aggr_pre_handler);
1111 static void aggr_post_handler(struct kprobe *p, struct pt_regs *regs,
1112 unsigned long flags)
1116 list_for_each_entry_rcu(kp, &p->list, list) {
1117 if (kp->post_handler && likely(!kprobe_disabled(kp))) {
1118 set_kprobe_instance(kp);
1119 kp->post_handler(kp, regs, flags);
1120 reset_kprobe_instance();
1124 NOKPROBE_SYMBOL(aggr_post_handler);
1126 static int aggr_fault_handler(struct kprobe *p, struct pt_regs *regs,
1129 struct kprobe *cur = __this_cpu_read(kprobe_instance);
1132 * if we faulted "during" the execution of a user specified
1133 * probe handler, invoke just that probe's fault handler
1135 if (cur && cur->fault_handler) {
1136 if (cur->fault_handler(cur, regs, trapnr))
1141 NOKPROBE_SYMBOL(aggr_fault_handler);
1143 /* Walks the list and increments nmissed count for multiprobe case */
1144 void kprobes_inc_nmissed_count(struct kprobe *p)
1147 if (!kprobe_aggrprobe(p)) {
1150 list_for_each_entry_rcu(kp, &p->list, list)
1155 NOKPROBE_SYMBOL(kprobes_inc_nmissed_count);
1157 void recycle_rp_inst(struct kretprobe_instance *ri,
1158 struct hlist_head *head)
1160 struct kretprobe *rp = ri->rp;
1162 /* remove rp inst off the rprobe_inst_table */
1163 hlist_del(&ri->hlist);
1164 INIT_HLIST_NODE(&ri->hlist);
1166 raw_spin_lock(&rp->lock);
1167 hlist_add_head(&ri->hlist, &rp->free_instances);
1168 raw_spin_unlock(&rp->lock);
1171 hlist_add_head(&ri->hlist, head);
1173 NOKPROBE_SYMBOL(recycle_rp_inst);
1175 void kretprobe_hash_lock(struct task_struct *tsk,
1176 struct hlist_head **head, unsigned long *flags)
1177 __acquires(hlist_lock)
1179 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
1180 raw_spinlock_t *hlist_lock;
1182 *head = &kretprobe_inst_table[hash];
1183 hlist_lock = kretprobe_table_lock_ptr(hash);
1184 raw_spin_lock_irqsave(hlist_lock, *flags);
1186 NOKPROBE_SYMBOL(kretprobe_hash_lock);
1188 static void kretprobe_table_lock(unsigned long hash,
1189 unsigned long *flags)
1190 __acquires(hlist_lock)
1192 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1193 raw_spin_lock_irqsave(hlist_lock, *flags);
1195 NOKPROBE_SYMBOL(kretprobe_table_lock);
1197 void kretprobe_hash_unlock(struct task_struct *tsk,
1198 unsigned long *flags)
1199 __releases(hlist_lock)
1201 unsigned long hash = hash_ptr(tsk, KPROBE_HASH_BITS);
1202 raw_spinlock_t *hlist_lock;
1204 hlist_lock = kretprobe_table_lock_ptr(hash);
1205 raw_spin_unlock_irqrestore(hlist_lock, *flags);
1207 NOKPROBE_SYMBOL(kretprobe_hash_unlock);
1209 static void kretprobe_table_unlock(unsigned long hash,
1210 unsigned long *flags)
1211 __releases(hlist_lock)
1213 raw_spinlock_t *hlist_lock = kretprobe_table_lock_ptr(hash);
1214 raw_spin_unlock_irqrestore(hlist_lock, *flags);
1216 NOKPROBE_SYMBOL(kretprobe_table_unlock);
1219 * This function is called from finish_task_switch when task tk becomes dead,
1220 * so that we can recycle any function-return probe instances associated
1221 * with this task. These left over instances represent probed functions
1222 * that have been called but will never return.
1224 void kprobe_flush_task(struct task_struct *tk)
1226 struct kretprobe_instance *ri;
1227 struct hlist_head *head, empty_rp;
1228 struct hlist_node *tmp;
1229 unsigned long hash, flags = 0;
1231 if (unlikely(!kprobes_initialized))
1232 /* Early boot. kretprobe_table_locks not yet initialized. */
1235 INIT_HLIST_HEAD(&empty_rp);
1236 hash = hash_ptr(tk, KPROBE_HASH_BITS);
1237 head = &kretprobe_inst_table[hash];
1238 kretprobe_table_lock(hash, &flags);
1239 hlist_for_each_entry_safe(ri, tmp, head, hlist) {
1241 recycle_rp_inst(ri, &empty_rp);
1243 kretprobe_table_unlock(hash, &flags);
1244 hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
1245 hlist_del(&ri->hlist);
1249 NOKPROBE_SYMBOL(kprobe_flush_task);
1251 static inline void free_rp_inst(struct kretprobe *rp)
1253 struct kretprobe_instance *ri;
1254 struct hlist_node *next;
1256 hlist_for_each_entry_safe(ri, next, &rp->free_instances, hlist) {
1257 hlist_del(&ri->hlist);
1262 static void cleanup_rp_inst(struct kretprobe *rp)
1264 unsigned long flags, hash;
1265 struct kretprobe_instance *ri;
1266 struct hlist_node *next;
1267 struct hlist_head *head;
1270 for (hash = 0; hash < KPROBE_TABLE_SIZE; hash++) {
1271 kretprobe_table_lock(hash, &flags);
1272 head = &kretprobe_inst_table[hash];
1273 hlist_for_each_entry_safe(ri, next, head, hlist) {
1277 kretprobe_table_unlock(hash, &flags);
1281 NOKPROBE_SYMBOL(cleanup_rp_inst);
1283 /* Add the new probe to ap->list */
1284 static int add_new_kprobe(struct kprobe *ap, struct kprobe *p)
1286 if (p->post_handler)
1287 unoptimize_kprobe(ap, true); /* Fall back to normal kprobe */
1289 list_add_rcu(&p->list, &ap->list);
1290 if (p->post_handler && !ap->post_handler)
1291 ap->post_handler = aggr_post_handler;
1297 * Fill in the required fields of the "manager kprobe". Replace the
1298 * earlier kprobe in the hlist with the manager kprobe
1300 static void init_aggr_kprobe(struct kprobe *ap, struct kprobe *p)
1302 /* Copy p's insn slot to ap */
1304 flush_insn_slot(ap);
1306 ap->flags = p->flags & ~KPROBE_FLAG_OPTIMIZED;
1307 ap->pre_handler = aggr_pre_handler;
1308 ap->fault_handler = aggr_fault_handler;
1309 /* We don't care the kprobe which has gone. */
1310 if (p->post_handler && !kprobe_gone(p))
1311 ap->post_handler = aggr_post_handler;
1313 INIT_LIST_HEAD(&ap->list);
1314 INIT_HLIST_NODE(&ap->hlist);
1316 list_add_rcu(&p->list, &ap->list);
1317 hlist_replace_rcu(&p->hlist, &ap->hlist);
1321 * This is the second or subsequent kprobe at the address - handle
1324 static int register_aggr_kprobe(struct kprobe *orig_p, struct kprobe *p)
1327 struct kprobe *ap = orig_p;
1331 /* For preparing optimization, jump_label_text_reserved() is called */
1333 mutex_lock(&text_mutex);
1335 if (!kprobe_aggrprobe(orig_p)) {
1336 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1337 ap = alloc_aggr_kprobe(orig_p);
1342 init_aggr_kprobe(ap, orig_p);
1343 } else if (kprobe_unused(ap)) {
1344 /* This probe is going to die. Rescue it */
1345 ret = reuse_unused_kprobe(ap);
1350 if (kprobe_gone(ap)) {
1352 * Attempting to insert new probe at the same location that
1353 * had a probe in the module vaddr area which already
1354 * freed. So, the instruction slot has already been
1355 * released. We need a new slot for the new probe.
1357 ret = arch_prepare_kprobe(ap);
1360 * Even if fail to allocate new slot, don't need to
1361 * free aggr_probe. It will be used next time, or
1362 * freed by unregister_kprobe.
1366 /* Prepare optimized instructions if possible. */
1367 prepare_optimized_kprobe(ap);
1370 * Clear gone flag to prevent allocating new slot again, and
1371 * set disabled flag because it is not armed yet.
1373 ap->flags = (ap->flags & ~KPROBE_FLAG_GONE)
1374 | KPROBE_FLAG_DISABLED;
1377 /* Copy ap's insn slot to p */
1379 ret = add_new_kprobe(ap, p);
1382 mutex_unlock(&text_mutex);
1383 jump_label_unlock();
1386 if (ret == 0 && kprobe_disabled(ap) && !kprobe_disabled(p)) {
1387 ap->flags &= ~KPROBE_FLAG_DISABLED;
1388 if (!kprobes_all_disarmed) {
1389 /* Arm the breakpoint again. */
1390 ret = arm_kprobe(ap);
1392 ap->flags |= KPROBE_FLAG_DISABLED;
1393 list_del_rcu(&p->list);
1401 bool __weak arch_within_kprobe_blacklist(unsigned long addr)
1403 /* The __kprobes marked functions and entry code must not be probed */
1404 return addr >= (unsigned long)__kprobes_text_start &&
1405 addr < (unsigned long)__kprobes_text_end;
1408 static bool __within_kprobe_blacklist(unsigned long addr)
1410 struct kprobe_blacklist_entry *ent;
1412 if (arch_within_kprobe_blacklist(addr))
1415 * If there exists a kprobe_blacklist, verify and
1416 * fail any probe registration in the prohibited area
1418 list_for_each_entry(ent, &kprobe_blacklist, list) {
1419 if (addr >= ent->start_addr && addr < ent->end_addr)
1425 bool within_kprobe_blacklist(unsigned long addr)
1427 char symname[KSYM_NAME_LEN], *p;
1429 if (__within_kprobe_blacklist(addr))
1432 /* Check if the address is on a suffixed-symbol */
1433 if (!lookup_symbol_name(addr, symname)) {
1434 p = strchr(symname, '.');
1438 addr = (unsigned long)kprobe_lookup_name(symname, 0);
1440 return __within_kprobe_blacklist(addr);
1446 * If we have a symbol_name argument, look it up and add the offset field
1447 * to it. This way, we can specify a relative address to a symbol.
1448 * This returns encoded errors if it fails to look up symbol or invalid
1449 * combination of parameters.
1451 static kprobe_opcode_t *_kprobe_addr(kprobe_opcode_t *addr,
1452 const char *symbol_name, unsigned int offset)
1454 if ((symbol_name && addr) || (!symbol_name && !addr))
1458 addr = kprobe_lookup_name(symbol_name, offset);
1460 return ERR_PTR(-ENOENT);
1463 addr = (kprobe_opcode_t *)(((char *)addr) + offset);
1468 return ERR_PTR(-EINVAL);
1471 static kprobe_opcode_t *kprobe_addr(struct kprobe *p)
1473 return _kprobe_addr(p->addr, p->symbol_name, p->offset);
1476 /* Check passed kprobe is valid and return kprobe in kprobe_table. */
1477 static struct kprobe *__get_valid_kprobe(struct kprobe *p)
1479 struct kprobe *ap, *list_p;
1481 ap = get_kprobe(p->addr);
1486 list_for_each_entry_rcu(list_p, &ap->list, list)
1488 /* kprobe p is a valid probe */
1496 /* Return error if the kprobe is being re-registered */
1497 static inline int check_kprobe_rereg(struct kprobe *p)
1501 mutex_lock(&kprobe_mutex);
1502 if (__get_valid_kprobe(p))
1504 mutex_unlock(&kprobe_mutex);
1509 int __weak arch_check_ftrace_location(struct kprobe *p)
1511 unsigned long ftrace_addr;
1513 ftrace_addr = ftrace_location((unsigned long)p->addr);
1515 #ifdef CONFIG_KPROBES_ON_FTRACE
1516 /* Given address is not on the instruction boundary */
1517 if ((unsigned long)p->addr != ftrace_addr)
1519 p->flags |= KPROBE_FLAG_FTRACE;
1520 #else /* !CONFIG_KPROBES_ON_FTRACE */
1527 static int check_kprobe_address_safe(struct kprobe *p,
1528 struct module **probed_mod)
1532 ret = arch_check_ftrace_location(p);
1538 /* Ensure it is not in reserved area nor out of text */
1539 if (!kernel_text_address((unsigned long) p->addr) ||
1540 within_kprobe_blacklist((unsigned long) p->addr) ||
1541 jump_label_text_reserved(p->addr, p->addr) ||
1542 find_bug((unsigned long)p->addr)) {
1547 /* Check if are we probing a module */
1548 *probed_mod = __module_text_address((unsigned long) p->addr);
1551 * We must hold a refcount of the probed module while updating
1552 * its code to prohibit unexpected unloading.
1554 if (unlikely(!try_module_get(*probed_mod))) {
1560 * If the module freed .init.text, we couldn't insert
1563 if (within_module_init((unsigned long)p->addr, *probed_mod) &&
1564 (*probed_mod)->state != MODULE_STATE_COMING) {
1565 module_put(*probed_mod);
1572 jump_label_unlock();
1577 int register_kprobe(struct kprobe *p)
1580 struct kprobe *old_p;
1581 struct module *probed_mod;
1582 kprobe_opcode_t *addr;
1584 /* Adjust probe address from symbol */
1585 addr = kprobe_addr(p);
1587 return PTR_ERR(addr);
1590 ret = check_kprobe_rereg(p);
1594 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1595 p->flags &= KPROBE_FLAG_DISABLED;
1597 INIT_LIST_HEAD(&p->list);
1599 ret = check_kprobe_address_safe(p, &probed_mod);
1603 mutex_lock(&kprobe_mutex);
1605 old_p = get_kprobe(p->addr);
1607 /* Since this may unoptimize old_p, locking text_mutex. */
1608 ret = register_aggr_kprobe(old_p, p);
1613 /* Prevent text modification */
1614 mutex_lock(&text_mutex);
1615 ret = prepare_kprobe(p);
1616 mutex_unlock(&text_mutex);
1621 INIT_HLIST_NODE(&p->hlist);
1622 hlist_add_head_rcu(&p->hlist,
1623 &kprobe_table[hash_ptr(p->addr, KPROBE_HASH_BITS)]);
1625 if (!kprobes_all_disarmed && !kprobe_disabled(p)) {
1626 ret = arm_kprobe(p);
1628 hlist_del_rcu(&p->hlist);
1634 /* Try to optimize kprobe */
1635 try_to_optimize_kprobe(p);
1637 mutex_unlock(&kprobe_mutex);
1640 module_put(probed_mod);
1644 EXPORT_SYMBOL_GPL(register_kprobe);
1646 /* Check if all probes on the aggrprobe are disabled */
1647 static int aggr_kprobe_disabled(struct kprobe *ap)
1651 list_for_each_entry_rcu(kp, &ap->list, list)
1652 if (!kprobe_disabled(kp))
1654 * There is an active probe on the list.
1655 * We can't disable this ap.
1662 /* Disable one kprobe: Make sure called under kprobe_mutex is locked */
1663 static struct kprobe *__disable_kprobe(struct kprobe *p)
1665 struct kprobe *orig_p;
1668 /* Get an original kprobe for return */
1669 orig_p = __get_valid_kprobe(p);
1670 if (unlikely(orig_p == NULL))
1671 return ERR_PTR(-EINVAL);
1673 if (!kprobe_disabled(p)) {
1674 /* Disable probe if it is a child probe */
1676 p->flags |= KPROBE_FLAG_DISABLED;
1678 /* Try to disarm and disable this/parent probe */
1679 if (p == orig_p || aggr_kprobe_disabled(orig_p)) {
1681 * If kprobes_all_disarmed is set, orig_p
1682 * should have already been disarmed, so
1683 * skip unneed disarming process.
1685 if (!kprobes_all_disarmed) {
1686 ret = disarm_kprobe(orig_p, true);
1688 p->flags &= ~KPROBE_FLAG_DISABLED;
1689 return ERR_PTR(ret);
1692 orig_p->flags |= KPROBE_FLAG_DISABLED;
1700 * Unregister a kprobe without a scheduler synchronization.
1702 static int __unregister_kprobe_top(struct kprobe *p)
1704 struct kprobe *ap, *list_p;
1706 /* Disable kprobe. This will disarm it if needed. */
1707 ap = __disable_kprobe(p);
1713 * This probe is an independent(and non-optimized) kprobe
1714 * (not an aggrprobe). Remove from the hash list.
1718 /* Following process expects this probe is an aggrprobe */
1719 WARN_ON(!kprobe_aggrprobe(ap));
1721 if (list_is_singular(&ap->list) && kprobe_disarmed(ap))
1723 * !disarmed could be happen if the probe is under delayed
1728 /* If disabling probe has special handlers, update aggrprobe */
1729 if (p->post_handler && !kprobe_gone(p)) {
1730 list_for_each_entry_rcu(list_p, &ap->list, list) {
1731 if ((list_p != p) && (list_p->post_handler))
1734 ap->post_handler = NULL;
1738 * Remove from the aggrprobe: this path will do nothing in
1739 * __unregister_kprobe_bottom().
1741 list_del_rcu(&p->list);
1742 if (!kprobe_disabled(ap) && !kprobes_all_disarmed)
1744 * Try to optimize this probe again, because post
1745 * handler may have been changed.
1747 optimize_kprobe(ap);
1752 hlist_del_rcu(&ap->hlist);
1756 static void __unregister_kprobe_bottom(struct kprobe *p)
1760 if (list_empty(&p->list))
1761 /* This is an independent kprobe */
1762 arch_remove_kprobe(p);
1763 else if (list_is_singular(&p->list)) {
1764 /* This is the last child of an aggrprobe */
1765 ap = list_entry(p->list.next, struct kprobe, list);
1767 free_aggr_kprobe(ap);
1769 /* Otherwise, do nothing. */
1772 int register_kprobes(struct kprobe **kps, int num)
1778 for (i = 0; i < num; i++) {
1779 ret = register_kprobe(kps[i]);
1782 unregister_kprobes(kps, i);
1788 EXPORT_SYMBOL_GPL(register_kprobes);
1790 void unregister_kprobe(struct kprobe *p)
1792 unregister_kprobes(&p, 1);
1794 EXPORT_SYMBOL_GPL(unregister_kprobe);
1796 void unregister_kprobes(struct kprobe **kps, int num)
1802 mutex_lock(&kprobe_mutex);
1803 for (i = 0; i < num; i++)
1804 if (__unregister_kprobe_top(kps[i]) < 0)
1805 kps[i]->addr = NULL;
1806 mutex_unlock(&kprobe_mutex);
1809 for (i = 0; i < num; i++)
1811 __unregister_kprobe_bottom(kps[i]);
1813 EXPORT_SYMBOL_GPL(unregister_kprobes);
1815 int __weak kprobe_exceptions_notify(struct notifier_block *self,
1816 unsigned long val, void *data)
1820 NOKPROBE_SYMBOL(kprobe_exceptions_notify);
1822 static struct notifier_block kprobe_exceptions_nb = {
1823 .notifier_call = kprobe_exceptions_notify,
1824 .priority = 0x7fffffff /* we need to be notified first */
1827 unsigned long __weak arch_deref_entry_point(void *entry)
1829 return (unsigned long)entry;
1832 #ifdef CONFIG_KRETPROBES
1834 * This kprobe pre_handler is registered with every kretprobe. When probe
1835 * hits it will set up the return probe.
1837 static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
1839 struct kretprobe *rp = container_of(p, struct kretprobe, kp);
1840 unsigned long hash, flags = 0;
1841 struct kretprobe_instance *ri;
1844 * To avoid deadlocks, prohibit return probing in NMI contexts,
1845 * just skip the probe and increase the (inexact) 'nmissed'
1846 * statistical counter, so that the user is informed that
1847 * something happened:
1849 if (unlikely(in_nmi())) {
1854 /* TODO: consider to only swap the RA after the last pre_handler fired */
1855 hash = hash_ptr(current, KPROBE_HASH_BITS);
1856 raw_spin_lock_irqsave(&rp->lock, flags);
1857 if (!hlist_empty(&rp->free_instances)) {
1858 ri = hlist_entry(rp->free_instances.first,
1859 struct kretprobe_instance, hlist);
1860 hlist_del(&ri->hlist);
1861 raw_spin_unlock_irqrestore(&rp->lock, flags);
1866 if (rp->entry_handler && rp->entry_handler(ri, regs)) {
1867 raw_spin_lock_irqsave(&rp->lock, flags);
1868 hlist_add_head(&ri->hlist, &rp->free_instances);
1869 raw_spin_unlock_irqrestore(&rp->lock, flags);
1873 arch_prepare_kretprobe(ri, regs);
1875 /* XXX(hch): why is there no hlist_move_head? */
1876 INIT_HLIST_NODE(&ri->hlist);
1877 kretprobe_table_lock(hash, &flags);
1878 hlist_add_head(&ri->hlist, &kretprobe_inst_table[hash]);
1879 kretprobe_table_unlock(hash, &flags);
1882 raw_spin_unlock_irqrestore(&rp->lock, flags);
1886 NOKPROBE_SYMBOL(pre_handler_kretprobe);
1888 bool __weak arch_kprobe_on_func_entry(unsigned long offset)
1893 bool kprobe_on_func_entry(kprobe_opcode_t *addr, const char *sym, unsigned long offset)
1895 kprobe_opcode_t *kp_addr = _kprobe_addr(addr, sym, offset);
1897 if (IS_ERR(kp_addr))
1900 if (!kallsyms_lookup_size_offset((unsigned long)kp_addr, NULL, &offset) ||
1901 !arch_kprobe_on_func_entry(offset))
1907 int register_kretprobe(struct kretprobe *rp)
1910 struct kretprobe_instance *inst;
1914 if (!kprobe_on_func_entry(rp->kp.addr, rp->kp.symbol_name, rp->kp.offset))
1917 if (kretprobe_blacklist_size) {
1918 addr = kprobe_addr(&rp->kp);
1920 return PTR_ERR(addr);
1922 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
1923 if (kretprobe_blacklist[i].addr == addr)
1928 rp->kp.pre_handler = pre_handler_kretprobe;
1929 rp->kp.post_handler = NULL;
1930 rp->kp.fault_handler = NULL;
1932 /* Pre-allocate memory for max kretprobe instances */
1933 if (rp->maxactive <= 0) {
1934 #ifdef CONFIG_PREEMPTION
1935 rp->maxactive = max_t(unsigned int, 10, 2*num_possible_cpus());
1937 rp->maxactive = num_possible_cpus();
1940 raw_spin_lock_init(&rp->lock);
1941 INIT_HLIST_HEAD(&rp->free_instances);
1942 for (i = 0; i < rp->maxactive; i++) {
1943 inst = kmalloc(sizeof(struct kretprobe_instance) +
1944 rp->data_size, GFP_KERNEL);
1949 INIT_HLIST_NODE(&inst->hlist);
1950 hlist_add_head(&inst->hlist, &rp->free_instances);
1954 /* Establish function entry probe point */
1955 ret = register_kprobe(&rp->kp);
1960 EXPORT_SYMBOL_GPL(register_kretprobe);
1962 int register_kretprobes(struct kretprobe **rps, int num)
1968 for (i = 0; i < num; i++) {
1969 ret = register_kretprobe(rps[i]);
1972 unregister_kretprobes(rps, i);
1978 EXPORT_SYMBOL_GPL(register_kretprobes);
1980 void unregister_kretprobe(struct kretprobe *rp)
1982 unregister_kretprobes(&rp, 1);
1984 EXPORT_SYMBOL_GPL(unregister_kretprobe);
1986 void unregister_kretprobes(struct kretprobe **rps, int num)
1992 mutex_lock(&kprobe_mutex);
1993 for (i = 0; i < num; i++)
1994 if (__unregister_kprobe_top(&rps[i]->kp) < 0)
1995 rps[i]->kp.addr = NULL;
1996 mutex_unlock(&kprobe_mutex);
1999 for (i = 0; i < num; i++) {
2000 if (rps[i]->kp.addr) {
2001 __unregister_kprobe_bottom(&rps[i]->kp);
2002 cleanup_rp_inst(rps[i]);
2006 EXPORT_SYMBOL_GPL(unregister_kretprobes);
2008 #else /* CONFIG_KRETPROBES */
2009 int register_kretprobe(struct kretprobe *rp)
2013 EXPORT_SYMBOL_GPL(register_kretprobe);
2015 int register_kretprobes(struct kretprobe **rps, int num)
2019 EXPORT_SYMBOL_GPL(register_kretprobes);
2021 void unregister_kretprobe(struct kretprobe *rp)
2024 EXPORT_SYMBOL_GPL(unregister_kretprobe);
2026 void unregister_kretprobes(struct kretprobe **rps, int num)
2029 EXPORT_SYMBOL_GPL(unregister_kretprobes);
2031 static int pre_handler_kretprobe(struct kprobe *p, struct pt_regs *regs)
2035 NOKPROBE_SYMBOL(pre_handler_kretprobe);
2037 #endif /* CONFIG_KRETPROBES */
2039 /* Set the kprobe gone and remove its instruction buffer. */
2040 static void kill_kprobe(struct kprobe *p)
2044 p->flags |= KPROBE_FLAG_GONE;
2045 if (kprobe_aggrprobe(p)) {
2047 * If this is an aggr_kprobe, we have to list all the
2048 * chained probes and mark them GONE.
2050 list_for_each_entry_rcu(kp, &p->list, list)
2051 kp->flags |= KPROBE_FLAG_GONE;
2052 p->post_handler = NULL;
2053 kill_optimized_kprobe(p);
2056 * Here, we can remove insn_slot safely, because no thread calls
2057 * the original probed function (which will be freed soon) any more.
2059 arch_remove_kprobe(p);
2062 /* Disable one kprobe */
2063 int disable_kprobe(struct kprobe *kp)
2068 mutex_lock(&kprobe_mutex);
2070 /* Disable this kprobe */
2071 p = __disable_kprobe(kp);
2075 mutex_unlock(&kprobe_mutex);
2078 EXPORT_SYMBOL_GPL(disable_kprobe);
2080 /* Enable one kprobe */
2081 int enable_kprobe(struct kprobe *kp)
2086 mutex_lock(&kprobe_mutex);
2088 /* Check whether specified probe is valid. */
2089 p = __get_valid_kprobe(kp);
2090 if (unlikely(p == NULL)) {
2095 if (kprobe_gone(kp)) {
2096 /* This kprobe has gone, we couldn't enable it. */
2102 kp->flags &= ~KPROBE_FLAG_DISABLED;
2104 if (!kprobes_all_disarmed && kprobe_disabled(p)) {
2105 p->flags &= ~KPROBE_FLAG_DISABLED;
2106 ret = arm_kprobe(p);
2108 p->flags |= KPROBE_FLAG_DISABLED;
2111 mutex_unlock(&kprobe_mutex);
2114 EXPORT_SYMBOL_GPL(enable_kprobe);
2116 /* Caller must NOT call this in usual path. This is only for critical case */
2117 void dump_kprobe(struct kprobe *kp)
2119 pr_err("Dumping kprobe:\n");
2120 pr_err("Name: %s\nOffset: %x\nAddress: %pS\n",
2121 kp->symbol_name, kp->offset, kp->addr);
2123 NOKPROBE_SYMBOL(dump_kprobe);
2125 int kprobe_add_ksym_blacklist(unsigned long entry)
2127 struct kprobe_blacklist_entry *ent;
2128 unsigned long offset = 0, size = 0;
2130 if (!kernel_text_address(entry) ||
2131 !kallsyms_lookup_size_offset(entry, &size, &offset))
2134 ent = kmalloc(sizeof(*ent), GFP_KERNEL);
2137 ent->start_addr = entry;
2138 ent->end_addr = entry + size;
2139 INIT_LIST_HEAD(&ent->list);
2140 list_add_tail(&ent->list, &kprobe_blacklist);
2145 /* Add all symbols in given area into kprobe blacklist */
2146 int kprobe_add_area_blacklist(unsigned long start, unsigned long end)
2148 unsigned long entry;
2151 for (entry = start; entry < end; entry += ret) {
2152 ret = kprobe_add_ksym_blacklist(entry);
2155 if (ret == 0) /* In case of alias symbol */
2161 int __init __weak arch_populate_kprobe_blacklist(void)
2167 * Lookup and populate the kprobe_blacklist.
2169 * Unlike the kretprobe blacklist, we'll need to determine
2170 * the range of addresses that belong to the said functions,
2171 * since a kprobe need not necessarily be at the beginning
2174 static int __init populate_kprobe_blacklist(unsigned long *start,
2177 unsigned long entry;
2178 unsigned long *iter;
2181 for (iter = start; iter < end; iter++) {
2182 entry = arch_deref_entry_point((void *)*iter);
2183 ret = kprobe_add_ksym_blacklist(entry);
2190 /* Symbols in __kprobes_text are blacklisted */
2191 ret = kprobe_add_area_blacklist((unsigned long)__kprobes_text_start,
2192 (unsigned long)__kprobes_text_end);
2194 return ret ? : arch_populate_kprobe_blacklist();
2197 /* Module notifier call back, checking kprobes on the module */
2198 static int kprobes_module_callback(struct notifier_block *nb,
2199 unsigned long val, void *data)
2201 struct module *mod = data;
2202 struct hlist_head *head;
2205 int checkcore = (val == MODULE_STATE_GOING);
2207 if (val != MODULE_STATE_GOING && val != MODULE_STATE_LIVE)
2211 * When MODULE_STATE_GOING was notified, both of module .text and
2212 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2213 * notified, only .init.text section would be freed. We need to
2214 * disable kprobes which have been inserted in the sections.
2216 mutex_lock(&kprobe_mutex);
2217 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2218 head = &kprobe_table[i];
2219 hlist_for_each_entry_rcu(p, head, hlist)
2220 if (within_module_init((unsigned long)p->addr, mod) ||
2222 within_module_core((unsigned long)p->addr, mod))) {
2224 * The vaddr this probe is installed will soon
2225 * be vfreed buy not synced to disk. Hence,
2226 * disarming the breakpoint isn't needed.
2228 * Note, this will also move any optimized probes
2229 * that are pending to be removed from their
2230 * corresponding lists to the freeing_list and
2231 * will not be touched by the delayed
2232 * kprobe_optimizer work handler.
2237 mutex_unlock(&kprobe_mutex);
2241 static struct notifier_block kprobe_module_nb = {
2242 .notifier_call = kprobes_module_callback,
2246 /* Markers of _kprobe_blacklist section */
2247 extern unsigned long __start_kprobe_blacklist[];
2248 extern unsigned long __stop_kprobe_blacklist[];
2250 static int __init init_kprobes(void)
2254 /* FIXME allocate the probe table, currently defined statically */
2255 /* initialize all list heads */
2256 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2257 INIT_HLIST_HEAD(&kprobe_table[i]);
2258 INIT_HLIST_HEAD(&kretprobe_inst_table[i]);
2259 raw_spin_lock_init(&(kretprobe_table_locks[i].lock));
2262 err = populate_kprobe_blacklist(__start_kprobe_blacklist,
2263 __stop_kprobe_blacklist);
2265 pr_err("kprobes: failed to populate blacklist: %d\n", err);
2266 pr_err("Please take care of using kprobes.\n");
2269 if (kretprobe_blacklist_size) {
2270 /* lookup the function address from its name */
2271 for (i = 0; kretprobe_blacklist[i].name != NULL; i++) {
2272 kretprobe_blacklist[i].addr =
2273 kprobe_lookup_name(kretprobe_blacklist[i].name, 0);
2274 if (!kretprobe_blacklist[i].addr)
2275 printk("kretprobe: lookup failed: %s\n",
2276 kretprobe_blacklist[i].name);
2280 #if defined(CONFIG_OPTPROBES)
2281 #if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
2282 /* Init kprobe_optinsn_slots */
2283 kprobe_optinsn_slots.insn_size = MAX_OPTINSN_SIZE;
2285 /* By default, kprobes can be optimized */
2286 kprobes_allow_optimization = true;
2289 /* By default, kprobes are armed */
2290 kprobes_all_disarmed = false;
2292 err = arch_init_kprobes();
2294 err = register_die_notifier(&kprobe_exceptions_nb);
2296 err = register_module_notifier(&kprobe_module_nb);
2298 kprobes_initialized = (err == 0);
2304 subsys_initcall(init_kprobes);
2306 #ifdef CONFIG_DEBUG_FS
2307 static void report_probe(struct seq_file *pi, struct kprobe *p,
2308 const char *sym, int offset, char *modname, struct kprobe *pp)
2311 void *addr = p->addr;
2313 if (p->pre_handler == pre_handler_kretprobe)
2318 if (!kallsyms_show_value())
2322 seq_printf(pi, "%px %s %s+0x%x %s ",
2323 addr, kprobe_type, sym, offset,
2324 (modname ? modname : " "));
2325 else /* try to use %pS */
2326 seq_printf(pi, "%px %s %pS ",
2327 addr, kprobe_type, p->addr);
2331 seq_printf(pi, "%s%s%s%s\n",
2332 (kprobe_gone(p) ? "[GONE]" : ""),
2333 ((kprobe_disabled(p) && !kprobe_gone(p)) ? "[DISABLED]" : ""),
2334 (kprobe_optimized(pp) ? "[OPTIMIZED]" : ""),
2335 (kprobe_ftrace(pp) ? "[FTRACE]" : ""));
2338 static void *kprobe_seq_start(struct seq_file *f, loff_t *pos)
2340 return (*pos < KPROBE_TABLE_SIZE) ? pos : NULL;
2343 static void *kprobe_seq_next(struct seq_file *f, void *v, loff_t *pos)
2346 if (*pos >= KPROBE_TABLE_SIZE)
2351 static void kprobe_seq_stop(struct seq_file *f, void *v)
2356 static int show_kprobe_addr(struct seq_file *pi, void *v)
2358 struct hlist_head *head;
2359 struct kprobe *p, *kp;
2360 const char *sym = NULL;
2361 unsigned int i = *(loff_t *) v;
2362 unsigned long offset = 0;
2363 char *modname, namebuf[KSYM_NAME_LEN];
2365 head = &kprobe_table[i];
2367 hlist_for_each_entry_rcu(p, head, hlist) {
2368 sym = kallsyms_lookup((unsigned long)p->addr, NULL,
2369 &offset, &modname, namebuf);
2370 if (kprobe_aggrprobe(p)) {
2371 list_for_each_entry_rcu(kp, &p->list, list)
2372 report_probe(pi, kp, sym, offset, modname, p);
2374 report_probe(pi, p, sym, offset, modname, NULL);
2380 static const struct seq_operations kprobes_seq_ops = {
2381 .start = kprobe_seq_start,
2382 .next = kprobe_seq_next,
2383 .stop = kprobe_seq_stop,
2384 .show = show_kprobe_addr
2387 static int kprobes_open(struct inode *inode, struct file *filp)
2389 return seq_open(filp, &kprobes_seq_ops);
2392 static const struct file_operations debugfs_kprobes_operations = {
2393 .open = kprobes_open,
2395 .llseek = seq_lseek,
2396 .release = seq_release,
2399 /* kprobes/blacklist -- shows which functions can not be probed */
2400 static void *kprobe_blacklist_seq_start(struct seq_file *m, loff_t *pos)
2402 return seq_list_start(&kprobe_blacklist, *pos);
2405 static void *kprobe_blacklist_seq_next(struct seq_file *m, void *v, loff_t *pos)
2407 return seq_list_next(v, &kprobe_blacklist, pos);
2410 static int kprobe_blacklist_seq_show(struct seq_file *m, void *v)
2412 struct kprobe_blacklist_entry *ent =
2413 list_entry(v, struct kprobe_blacklist_entry, list);
2416 * If /proc/kallsyms is not showing kernel address, we won't
2417 * show them here either.
2419 if (!kallsyms_show_value())
2420 seq_printf(m, "0x%px-0x%px\t%ps\n", NULL, NULL,
2421 (void *)ent->start_addr);
2423 seq_printf(m, "0x%px-0x%px\t%ps\n", (void *)ent->start_addr,
2424 (void *)ent->end_addr, (void *)ent->start_addr);
2428 static const struct seq_operations kprobe_blacklist_seq_ops = {
2429 .start = kprobe_blacklist_seq_start,
2430 .next = kprobe_blacklist_seq_next,
2431 .stop = kprobe_seq_stop, /* Reuse void function */
2432 .show = kprobe_blacklist_seq_show,
2435 static int kprobe_blacklist_open(struct inode *inode, struct file *filp)
2437 return seq_open(filp, &kprobe_blacklist_seq_ops);
2440 static const struct file_operations debugfs_kprobe_blacklist_ops = {
2441 .open = kprobe_blacklist_open,
2443 .llseek = seq_lseek,
2444 .release = seq_release,
2447 static int arm_all_kprobes(void)
2449 struct hlist_head *head;
2451 unsigned int i, total = 0, errors = 0;
2454 mutex_lock(&kprobe_mutex);
2456 /* If kprobes are armed, just return */
2457 if (!kprobes_all_disarmed)
2458 goto already_enabled;
2461 * optimize_kprobe() called by arm_kprobe() checks
2462 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2465 kprobes_all_disarmed = false;
2466 /* Arming kprobes doesn't optimize kprobe itself */
2467 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2468 head = &kprobe_table[i];
2469 /* Arm all kprobes on a best-effort basis */
2470 hlist_for_each_entry_rcu(p, head, hlist) {
2471 if (!kprobe_disabled(p)) {
2472 err = arm_kprobe(p);
2483 pr_warn("Kprobes globally enabled, but failed to arm %d out of %d probes\n",
2486 pr_info("Kprobes globally enabled\n");
2489 mutex_unlock(&kprobe_mutex);
2493 static int disarm_all_kprobes(void)
2495 struct hlist_head *head;
2497 unsigned int i, total = 0, errors = 0;
2500 mutex_lock(&kprobe_mutex);
2502 /* If kprobes are already disarmed, just return */
2503 if (kprobes_all_disarmed) {
2504 mutex_unlock(&kprobe_mutex);
2508 kprobes_all_disarmed = true;
2510 for (i = 0; i < KPROBE_TABLE_SIZE; i++) {
2511 head = &kprobe_table[i];
2512 /* Disarm all kprobes on a best-effort basis */
2513 hlist_for_each_entry_rcu(p, head, hlist) {
2514 if (!arch_trampoline_kprobe(p) && !kprobe_disabled(p)) {
2515 err = disarm_kprobe(p, false);
2526 pr_warn("Kprobes globally disabled, but failed to disarm %d out of %d probes\n",
2529 pr_info("Kprobes globally disabled\n");
2531 mutex_unlock(&kprobe_mutex);
2533 /* Wait for disarming all kprobes by optimizer */
2534 wait_for_kprobe_optimizer();
2540 * XXX: The debugfs bool file interface doesn't allow for callbacks
2541 * when the bool state is switched. We can reuse that facility when
2544 static ssize_t read_enabled_file_bool(struct file *file,
2545 char __user *user_buf, size_t count, loff_t *ppos)
2549 if (!kprobes_all_disarmed)
2555 return simple_read_from_buffer(user_buf, count, ppos, buf, 2);
2558 static ssize_t write_enabled_file_bool(struct file *file,
2559 const char __user *user_buf, size_t count, loff_t *ppos)
2565 buf_size = min(count, (sizeof(buf)-1));
2566 if (copy_from_user(buf, user_buf, buf_size))
2569 buf[buf_size] = '\0';
2574 ret = arm_all_kprobes();
2579 ret = disarm_all_kprobes();
2591 static const struct file_operations fops_kp = {
2592 .read = read_enabled_file_bool,
2593 .write = write_enabled_file_bool,
2594 .llseek = default_llseek,
2597 static int __init debugfs_kprobe_init(void)
2600 unsigned int value = 1;
2602 dir = debugfs_create_dir("kprobes", NULL);
2604 debugfs_create_file("list", 0400, dir, NULL,
2605 &debugfs_kprobes_operations);
2607 debugfs_create_file("enabled", 0600, dir, &value, &fops_kp);
2609 debugfs_create_file("blacklist", 0400, dir, NULL,
2610 &debugfs_kprobe_blacklist_ops);
2615 late_initcall(debugfs_kprobe_init);
2616 #endif /* CONFIG_DEBUG_FS */