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/module.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/kdebug.h>
47 #include <asm-generic/sections.h>
48 #include <asm/cacheflush.h>
49 #include <asm/errno.h>
50 #include <asm/uaccess.h>
52 #define KPROBE_HASH_BITS 6
53 #define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
57 * Some oddball architectures like 64bit powerpc have function descriptors
58 * so this must be overridable.
60 #ifndef kprobe_lookup_name
61 #define kprobe_lookup_name(name, addr) \
62 addr = ((kprobe_opcode_t *)(kallsyms_lookup_name(name)))
65 static int kprobes_initialized
;
66 static struct hlist_head kprobe_table
[KPROBE_TABLE_SIZE
];
67 static struct hlist_head kretprobe_inst_table
[KPROBE_TABLE_SIZE
];
69 /* NOTE: change this value only with kprobe_mutex held */
70 static bool kprobe_enabled
;
72 static DEFINE_MUTEX(kprobe_mutex
); /* Protects kprobe_table */
73 static DEFINE_PER_CPU(struct kprobe
*, kprobe_instance
) = NULL
;
75 spinlock_t lock ____cacheline_aligned_in_smp
;
76 } kretprobe_table_locks
[KPROBE_TABLE_SIZE
];
78 static spinlock_t
*kretprobe_table_lock_ptr(unsigned long hash
)
80 return &(kretprobe_table_locks
[hash
].lock
);
84 * Normally, functions that we'd want to prohibit kprobes in, are marked
85 * __kprobes. But, there are cases where such functions already belong to
86 * a different section (__sched for preempt_schedule)
88 * For such cases, we now have a blacklist
90 static struct kprobe_blackpoint kprobe_blacklist
[] = {
91 {"preempt_schedule",},
92 {NULL
} /* Terminator */
95 #ifdef __ARCH_WANT_KPROBES_INSN_SLOT
97 * kprobe->ainsn.insn points to the copy of the instruction to be
98 * single-stepped. x86_64, POWER4 and above have no-exec support and
99 * stepping on the instruction on a vmalloced/kmalloced/data page
100 * is a recipe for disaster
102 #define INSNS_PER_PAGE (PAGE_SIZE/(MAX_INSN_SIZE * sizeof(kprobe_opcode_t)))
104 struct kprobe_insn_page
{
105 struct hlist_node hlist
;
106 kprobe_opcode_t
*insns
; /* Page of instruction slots */
107 char slot_used
[INSNS_PER_PAGE
];
112 enum kprobe_slot_state
{
118 static DEFINE_MUTEX(kprobe_insn_mutex
); /* Protects kprobe_insn_pages */
119 static struct hlist_head kprobe_insn_pages
;
120 static int kprobe_garbage_slots
;
121 static int collect_garbage_slots(void);
123 static int __kprobes
check_safety(void)
126 #if defined(CONFIG_PREEMPT) && defined(CONFIG_FREEZER)
127 ret
= freeze_processes();
129 struct task_struct
*p
, *q
;
130 do_each_thread(p
, q
) {
131 if (p
!= current
&& p
->state
== TASK_RUNNING
&&
133 printk("Check failed: %s is running\n",p
->comm
);
137 } while_each_thread(p
, q
);
148 * __get_insn_slot() - Find a slot on an executable page for an instruction.
149 * We allocate an executable page if there's no room on existing ones.
151 static kprobe_opcode_t __kprobes
*__get_insn_slot(void)
153 struct kprobe_insn_page
*kip
;
154 struct hlist_node
*pos
;
157 hlist_for_each_entry(kip
, pos
, &kprobe_insn_pages
, hlist
) {
158 if (kip
->nused
< INSNS_PER_PAGE
) {
160 for (i
= 0; i
< INSNS_PER_PAGE
; i
++) {
161 if (kip
->slot_used
[i
] == SLOT_CLEAN
) {
162 kip
->slot_used
[i
] = SLOT_USED
;
164 return kip
->insns
+ (i
* MAX_INSN_SIZE
);
167 /* Surprise! No unused slots. Fix kip->nused. */
168 kip
->nused
= INSNS_PER_PAGE
;
172 /* If there are any garbage slots, collect it and try again. */
173 if (kprobe_garbage_slots
&& collect_garbage_slots() == 0) {
176 /* All out of space. Need to allocate a new page. Use slot 0. */
177 kip
= kmalloc(sizeof(struct kprobe_insn_page
), 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
= module_alloc(PAGE_SIZE
);
191 INIT_HLIST_NODE(&kip
->hlist
);
192 hlist_add_head(&kip
->hlist
, &kprobe_insn_pages
);
193 memset(kip
->slot_used
, SLOT_CLEAN
, INSNS_PER_PAGE
);
194 kip
->slot_used
[0] = SLOT_USED
;
200 kprobe_opcode_t __kprobes
*get_insn_slot(void)
202 kprobe_opcode_t
*ret
;
203 mutex_lock(&kprobe_insn_mutex
);
204 ret
= __get_insn_slot();
205 mutex_unlock(&kprobe_insn_mutex
);
209 /* Return 1 if all garbages are collected, otherwise 0. */
210 static int __kprobes
collect_one_slot(struct kprobe_insn_page
*kip
, int idx
)
212 kip
->slot_used
[idx
] = SLOT_CLEAN
;
214 if (kip
->nused
== 0) {
216 * Page is no longer in use. Free it unless
217 * it's the last one. We keep the last one
218 * so as not to have to set it up again the
219 * next time somebody inserts a probe.
221 hlist_del(&kip
->hlist
);
222 if (hlist_empty(&kprobe_insn_pages
)) {
223 INIT_HLIST_NODE(&kip
->hlist
);
224 hlist_add_head(&kip
->hlist
,
227 module_free(NULL
, kip
->insns
);
235 static int __kprobes
collect_garbage_slots(void)
237 struct kprobe_insn_page
*kip
;
238 struct hlist_node
*pos
, *next
;
241 /* Ensure no-one is preepmted on the garbages */
242 mutex_unlock(&kprobe_insn_mutex
);
243 safety
= check_safety();
244 mutex_lock(&kprobe_insn_mutex
);
248 hlist_for_each_entry_safe(kip
, pos
, next
, &kprobe_insn_pages
, hlist
) {
250 if (kip
->ngarbage
== 0)
252 kip
->ngarbage
= 0; /* we will collect all garbages */
253 for (i
= 0; i
< INSNS_PER_PAGE
; i
++) {
254 if (kip
->slot_used
[i
] == SLOT_DIRTY
&&
255 collect_one_slot(kip
, i
))
259 kprobe_garbage_slots
= 0;
263 void __kprobes
free_insn_slot(kprobe_opcode_t
* slot
, int dirty
)
265 struct kprobe_insn_page
*kip
;
266 struct hlist_node
*pos
;
268 mutex_lock(&kprobe_insn_mutex
);
269 hlist_for_each_entry(kip
, pos
, &kprobe_insn_pages
, hlist
) {
270 if (kip
->insns
<= slot
&&
271 slot
< kip
->insns
+ (INSNS_PER_PAGE
* MAX_INSN_SIZE
)) {
272 int i
= (slot
- kip
->insns
) / MAX_INSN_SIZE
;
274 kip
->slot_used
[i
] = SLOT_DIRTY
;
277 collect_one_slot(kip
, i
);
283 if (dirty
&& ++kprobe_garbage_slots
> INSNS_PER_PAGE
)
284 collect_garbage_slots();
286 mutex_unlock(&kprobe_insn_mutex
);
290 /* We have preemption disabled.. so it is safe to use __ versions */
291 static inline void set_kprobe_instance(struct kprobe
*kp
)
293 __get_cpu_var(kprobe_instance
) = kp
;
296 static inline void reset_kprobe_instance(void)
298 __get_cpu_var(kprobe_instance
) = NULL
;
302 * This routine is called either:
303 * - under the kprobe_mutex - during kprobe_[un]register()
305 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
307 struct kprobe __kprobes
*get_kprobe(void *addr
)
309 struct hlist_head
*head
;
310 struct hlist_node
*node
;
313 head
= &kprobe_table
[hash_ptr(addr
, KPROBE_HASH_BITS
)];
314 hlist_for_each_entry_rcu(p
, node
, head
, hlist
) {
322 * Aggregate handlers for multiple kprobes support - these handlers
323 * take care of invoking the individual kprobe handlers on p->list
325 static int __kprobes
aggr_pre_handler(struct kprobe
*p
, struct pt_regs
*regs
)
329 list_for_each_entry_rcu(kp
, &p
->list
, list
) {
330 if (kp
->pre_handler
&& !kprobe_gone(kp
)) {
331 set_kprobe_instance(kp
);
332 if (kp
->pre_handler(kp
, regs
))
335 reset_kprobe_instance();
340 static void __kprobes
aggr_post_handler(struct kprobe
*p
, struct pt_regs
*regs
,
345 list_for_each_entry_rcu(kp
, &p
->list
, list
) {
346 if (kp
->post_handler
&& !kprobe_gone(kp
)) {
347 set_kprobe_instance(kp
);
348 kp
->post_handler(kp
, regs
, flags
);
349 reset_kprobe_instance();
354 static int __kprobes
aggr_fault_handler(struct kprobe
*p
, struct pt_regs
*regs
,
357 struct kprobe
*cur
= __get_cpu_var(kprobe_instance
);
360 * if we faulted "during" the execution of a user specified
361 * probe handler, invoke just that probe's fault handler
363 if (cur
&& cur
->fault_handler
) {
364 if (cur
->fault_handler(cur
, regs
, trapnr
))
370 static int __kprobes
aggr_break_handler(struct kprobe
*p
, struct pt_regs
*regs
)
372 struct kprobe
*cur
= __get_cpu_var(kprobe_instance
);
375 if (cur
&& cur
->break_handler
) {
376 if (cur
->break_handler(cur
, regs
))
379 reset_kprobe_instance();
383 /* Walks the list and increments nmissed count for multiprobe case */
384 void __kprobes
kprobes_inc_nmissed_count(struct kprobe
*p
)
387 if (p
->pre_handler
!= aggr_pre_handler
) {
390 list_for_each_entry_rcu(kp
, &p
->list
, list
)
396 void __kprobes
recycle_rp_inst(struct kretprobe_instance
*ri
,
397 struct hlist_head
*head
)
399 struct kretprobe
*rp
= ri
->rp
;
401 /* remove rp inst off the rprobe_inst_table */
402 hlist_del(&ri
->hlist
);
403 INIT_HLIST_NODE(&ri
->hlist
);
405 spin_lock(&rp
->lock
);
406 hlist_add_head(&ri
->hlist
, &rp
->free_instances
);
407 spin_unlock(&rp
->lock
);
410 hlist_add_head(&ri
->hlist
, head
);
413 void __kprobes
kretprobe_hash_lock(struct task_struct
*tsk
,
414 struct hlist_head
**head
, unsigned long *flags
)
416 unsigned long hash
= hash_ptr(tsk
, KPROBE_HASH_BITS
);
417 spinlock_t
*hlist_lock
;
419 *head
= &kretprobe_inst_table
[hash
];
420 hlist_lock
= kretprobe_table_lock_ptr(hash
);
421 spin_lock_irqsave(hlist_lock
, *flags
);
424 static void __kprobes
kretprobe_table_lock(unsigned long hash
,
425 unsigned long *flags
)
427 spinlock_t
*hlist_lock
= kretprobe_table_lock_ptr(hash
);
428 spin_lock_irqsave(hlist_lock
, *flags
);
431 void __kprobes
kretprobe_hash_unlock(struct task_struct
*tsk
,
432 unsigned long *flags
)
434 unsigned long hash
= hash_ptr(tsk
, KPROBE_HASH_BITS
);
435 spinlock_t
*hlist_lock
;
437 hlist_lock
= kretprobe_table_lock_ptr(hash
);
438 spin_unlock_irqrestore(hlist_lock
, *flags
);
441 void __kprobes
kretprobe_table_unlock(unsigned long hash
, unsigned long *flags
)
443 spinlock_t
*hlist_lock
= kretprobe_table_lock_ptr(hash
);
444 spin_unlock_irqrestore(hlist_lock
, *flags
);
448 * This function is called from finish_task_switch when task tk becomes dead,
449 * so that we can recycle any function-return probe instances associated
450 * with this task. These left over instances represent probed functions
451 * that have been called but will never return.
453 void __kprobes
kprobe_flush_task(struct task_struct
*tk
)
455 struct kretprobe_instance
*ri
;
456 struct hlist_head
*head
, empty_rp
;
457 struct hlist_node
*node
, *tmp
;
458 unsigned long hash
, flags
= 0;
460 if (unlikely(!kprobes_initialized
))
461 /* Early boot. kretprobe_table_locks not yet initialized. */
464 hash
= hash_ptr(tk
, KPROBE_HASH_BITS
);
465 head
= &kretprobe_inst_table
[hash
];
466 kretprobe_table_lock(hash
, &flags
);
467 hlist_for_each_entry_safe(ri
, node
, tmp
, head
, hlist
) {
469 recycle_rp_inst(ri
, &empty_rp
);
471 kretprobe_table_unlock(hash
, &flags
);
472 INIT_HLIST_HEAD(&empty_rp
);
473 hlist_for_each_entry_safe(ri
, node
, tmp
, &empty_rp
, hlist
) {
474 hlist_del(&ri
->hlist
);
479 static inline void free_rp_inst(struct kretprobe
*rp
)
481 struct kretprobe_instance
*ri
;
482 struct hlist_node
*pos
, *next
;
484 hlist_for_each_entry_safe(ri
, pos
, next
, &rp
->free_instances
, hlist
) {
485 hlist_del(&ri
->hlist
);
490 static void __kprobes
cleanup_rp_inst(struct kretprobe
*rp
)
492 unsigned long flags
, hash
;
493 struct kretprobe_instance
*ri
;
494 struct hlist_node
*pos
, *next
;
495 struct hlist_head
*head
;
498 for (hash
= 0; hash
< KPROBE_TABLE_SIZE
; hash
++) {
499 kretprobe_table_lock(hash
, &flags
);
500 head
= &kretprobe_inst_table
[hash
];
501 hlist_for_each_entry_safe(ri
, pos
, next
, head
, hlist
) {
505 kretprobe_table_unlock(hash
, &flags
);
511 * Keep all fields in the kprobe consistent
513 static inline void copy_kprobe(struct kprobe
*old_p
, struct kprobe
*p
)
515 memcpy(&p
->opcode
, &old_p
->opcode
, sizeof(kprobe_opcode_t
));
516 memcpy(&p
->ainsn
, &old_p
->ainsn
, sizeof(struct arch_specific_insn
));
520 * Add the new probe to old_p->list. Fail if this is the
521 * second jprobe at the address - two jprobes can't coexist
523 static int __kprobes
add_new_kprobe(struct kprobe
*old_p
, struct kprobe
*p
)
525 if (p
->break_handler
) {
526 if (old_p
->break_handler
)
528 list_add_tail_rcu(&p
->list
, &old_p
->list
);
529 old_p
->break_handler
= aggr_break_handler
;
531 list_add_rcu(&p
->list
, &old_p
->list
);
532 if (p
->post_handler
&& !old_p
->post_handler
)
533 old_p
->post_handler
= aggr_post_handler
;
538 * Fill in the required fields of the "manager kprobe". Replace the
539 * earlier kprobe in the hlist with the manager kprobe
541 static inline void add_aggr_kprobe(struct kprobe
*ap
, struct kprobe
*p
)
546 ap
->pre_handler
= aggr_pre_handler
;
547 ap
->fault_handler
= aggr_fault_handler
;
548 /* We don't care the kprobe which has gone. */
549 if (p
->post_handler
&& !kprobe_gone(p
))
550 ap
->post_handler
= aggr_post_handler
;
551 if (p
->break_handler
&& !kprobe_gone(p
))
552 ap
->break_handler
= aggr_break_handler
;
554 INIT_LIST_HEAD(&ap
->list
);
555 list_add_rcu(&p
->list
, &ap
->list
);
557 hlist_replace_rcu(&p
->hlist
, &ap
->hlist
);
561 * This is the second or subsequent kprobe at the address - handle
564 static int __kprobes
register_aggr_kprobe(struct kprobe
*old_p
,
570 if (kprobe_gone(old_p
)) {
572 * Attempting to insert new probe at the same location that
573 * had a probe in the module vaddr area which already
574 * freed. So, the instruction slot has already been
575 * released. We need a new slot for the new probe.
577 ret
= arch_prepare_kprobe(old_p
);
581 if (old_p
->pre_handler
== aggr_pre_handler
) {
582 copy_kprobe(old_p
, p
);
583 ret
= add_new_kprobe(old_p
, p
);
586 ap
= kzalloc(sizeof(struct kprobe
), GFP_KERNEL
);
588 if (kprobe_gone(old_p
))
589 arch_remove_kprobe(old_p
);
592 add_aggr_kprobe(ap
, old_p
);
594 ret
= add_new_kprobe(ap
, p
);
596 if (kprobe_gone(old_p
)) {
598 * If the old_p has gone, its breakpoint has been disarmed.
599 * We have to arm it again after preparing real kprobes.
601 ap
->flags
&= ~KPROBE_FLAG_GONE
;
608 static int __kprobes
in_kprobes_functions(unsigned long addr
)
610 struct kprobe_blackpoint
*kb
;
612 if (addr
>= (unsigned long)__kprobes_text_start
&&
613 addr
< (unsigned long)__kprobes_text_end
)
616 * If there exists a kprobe_blacklist, verify and
617 * fail any probe registration in the prohibited area
619 for (kb
= kprobe_blacklist
; kb
->name
!= NULL
; kb
++) {
620 if (kb
->start_addr
) {
621 if (addr
>= kb
->start_addr
&&
622 addr
< (kb
->start_addr
+ kb
->range
))
630 * If we have a symbol_name argument, look it up and add the offset field
631 * to it. This way, we can specify a relative address to a symbol.
633 static kprobe_opcode_t __kprobes
*kprobe_addr(struct kprobe
*p
)
635 kprobe_opcode_t
*addr
= p
->addr
;
636 if (p
->symbol_name
) {
639 kprobe_lookup_name(p
->symbol_name
, addr
);
644 return (kprobe_opcode_t
*)(((char *)addr
) + p
->offset
);
647 int __kprobes
register_kprobe(struct kprobe
*p
)
650 struct kprobe
*old_p
;
651 struct module
*probed_mod
;
652 kprobe_opcode_t
*addr
;
654 addr
= kprobe_addr(p
);
660 if (!__kernel_text_address((unsigned long) p
->addr
) ||
661 in_kprobes_functions((unsigned long) p
->addr
)) {
668 * Check if are we probing a module.
670 probed_mod
= __module_text_address((unsigned long) p
->addr
);
673 * We must hold a refcount of the probed module while updating
674 * its code to prohibit unexpected unloading.
676 if (unlikely(!try_module_get(probed_mod
))) {
681 * If the module freed .init.text, we couldn't insert
684 if (within_module_init((unsigned long)p
->addr
, probed_mod
) &&
685 probed_mod
->state
!= MODULE_STATE_COMING
) {
686 module_put(probed_mod
);
694 INIT_LIST_HEAD(&p
->list
);
695 mutex_lock(&kprobe_mutex
);
696 old_p
= get_kprobe(p
->addr
);
698 ret
= register_aggr_kprobe(old_p
, p
);
702 ret
= arch_prepare_kprobe(p
);
706 INIT_HLIST_NODE(&p
->hlist
);
707 hlist_add_head_rcu(&p
->hlist
,
708 &kprobe_table
[hash_ptr(p
->addr
, KPROBE_HASH_BITS
)]);
714 mutex_unlock(&kprobe_mutex
);
717 module_put(probed_mod
);
723 * Unregister a kprobe without a scheduler synchronization.
725 static int __kprobes
__unregister_kprobe_top(struct kprobe
*p
)
727 struct kprobe
*old_p
, *list_p
;
729 old_p
= get_kprobe(p
->addr
);
730 if (unlikely(!old_p
))
734 list_for_each_entry_rcu(list_p
, &old_p
->list
, list
)
736 /* kprobe p is a valid probe */
742 (old_p
->pre_handler
== aggr_pre_handler
&&
743 list_is_singular(&old_p
->list
))) {
745 * Only probe on the hash list. Disarm only if kprobes are
746 * enabled and not gone - otherwise, the breakpoint would
747 * already have been removed. We save on flushing icache.
749 if (kprobe_enabled
&& !kprobe_gone(old_p
))
750 arch_disarm_kprobe(p
);
751 hlist_del_rcu(&old_p
->hlist
);
753 if (p
->break_handler
&& !kprobe_gone(p
))
754 old_p
->break_handler
= NULL
;
755 if (p
->post_handler
&& !kprobe_gone(p
)) {
756 list_for_each_entry_rcu(list_p
, &old_p
->list
, list
) {
757 if ((list_p
!= p
) && (list_p
->post_handler
))
760 old_p
->post_handler
= NULL
;
763 list_del_rcu(&p
->list
);
768 static void __kprobes
__unregister_kprobe_bottom(struct kprobe
*p
)
770 struct kprobe
*old_p
;
772 if (list_empty(&p
->list
))
773 arch_remove_kprobe(p
);
774 else if (list_is_singular(&p
->list
)) {
775 /* "p" is the last child of an aggr_kprobe */
776 old_p
= list_entry(p
->list
.next
, struct kprobe
, list
);
778 arch_remove_kprobe(old_p
);
783 int __kprobes
register_kprobes(struct kprobe
**kps
, int num
)
789 for (i
= 0; i
< num
; i
++) {
790 ret
= register_kprobe(kps
[i
]);
793 unregister_kprobes(kps
, i
);
800 void __kprobes
unregister_kprobe(struct kprobe
*p
)
802 unregister_kprobes(&p
, 1);
805 void __kprobes
unregister_kprobes(struct kprobe
**kps
, int num
)
811 mutex_lock(&kprobe_mutex
);
812 for (i
= 0; i
< num
; i
++)
813 if (__unregister_kprobe_top(kps
[i
]) < 0)
815 mutex_unlock(&kprobe_mutex
);
818 for (i
= 0; i
< num
; i
++)
820 __unregister_kprobe_bottom(kps
[i
]);
823 static struct notifier_block kprobe_exceptions_nb
= {
824 .notifier_call
= kprobe_exceptions_notify
,
825 .priority
= 0x7fffffff /* we need to be notified first */
828 unsigned long __weak
arch_deref_entry_point(void *entry
)
830 return (unsigned long)entry
;
833 int __kprobes
register_jprobes(struct jprobe
**jps
, int num
)
840 for (i
= 0; i
< num
; i
++) {
843 addr
= arch_deref_entry_point(jp
->entry
);
845 if (!kernel_text_address(addr
))
848 /* Todo: Verify probepoint is a function entry point */
849 jp
->kp
.pre_handler
= setjmp_pre_handler
;
850 jp
->kp
.break_handler
= longjmp_break_handler
;
851 ret
= register_kprobe(&jp
->kp
);
855 unregister_jprobes(jps
, i
);
862 int __kprobes
register_jprobe(struct jprobe
*jp
)
864 return register_jprobes(&jp
, 1);
867 void __kprobes
unregister_jprobe(struct jprobe
*jp
)
869 unregister_jprobes(&jp
, 1);
872 void __kprobes
unregister_jprobes(struct jprobe
**jps
, int num
)
878 mutex_lock(&kprobe_mutex
);
879 for (i
= 0; i
< num
; i
++)
880 if (__unregister_kprobe_top(&jps
[i
]->kp
) < 0)
881 jps
[i
]->kp
.addr
= NULL
;
882 mutex_unlock(&kprobe_mutex
);
885 for (i
= 0; i
< num
; i
++) {
887 __unregister_kprobe_bottom(&jps
[i
]->kp
);
891 #ifdef CONFIG_KRETPROBES
893 * This kprobe pre_handler is registered with every kretprobe. When probe
894 * hits it will set up the return probe.
896 static int __kprobes
pre_handler_kretprobe(struct kprobe
*p
,
897 struct pt_regs
*regs
)
899 struct kretprobe
*rp
= container_of(p
, struct kretprobe
, kp
);
900 unsigned long hash
, flags
= 0;
901 struct kretprobe_instance
*ri
;
903 /*TODO: consider to only swap the RA after the last pre_handler fired */
904 hash
= hash_ptr(current
, KPROBE_HASH_BITS
);
905 spin_lock_irqsave(&rp
->lock
, flags
);
906 if (!hlist_empty(&rp
->free_instances
)) {
907 ri
= hlist_entry(rp
->free_instances
.first
,
908 struct kretprobe_instance
, hlist
);
909 hlist_del(&ri
->hlist
);
910 spin_unlock_irqrestore(&rp
->lock
, flags
);
915 if (rp
->entry_handler
&& rp
->entry_handler(ri
, regs
))
918 arch_prepare_kretprobe(ri
, regs
);
920 /* XXX(hch): why is there no hlist_move_head? */
921 INIT_HLIST_NODE(&ri
->hlist
);
922 kretprobe_table_lock(hash
, &flags
);
923 hlist_add_head(&ri
->hlist
, &kretprobe_inst_table
[hash
]);
924 kretprobe_table_unlock(hash
, &flags
);
927 spin_unlock_irqrestore(&rp
->lock
, flags
);
932 int __kprobes
register_kretprobe(struct kretprobe
*rp
)
935 struct kretprobe_instance
*inst
;
939 if (kretprobe_blacklist_size
) {
940 addr
= kprobe_addr(&rp
->kp
);
944 for (i
= 0; kretprobe_blacklist
[i
].name
!= NULL
; i
++) {
945 if (kretprobe_blacklist
[i
].addr
== addr
)
950 rp
->kp
.pre_handler
= pre_handler_kretprobe
;
951 rp
->kp
.post_handler
= NULL
;
952 rp
->kp
.fault_handler
= NULL
;
953 rp
->kp
.break_handler
= NULL
;
955 /* Pre-allocate memory for max kretprobe instances */
956 if (rp
->maxactive
<= 0) {
957 #ifdef CONFIG_PREEMPT
958 rp
->maxactive
= max(10, 2 * NR_CPUS
);
960 rp
->maxactive
= NR_CPUS
;
963 spin_lock_init(&rp
->lock
);
964 INIT_HLIST_HEAD(&rp
->free_instances
);
965 for (i
= 0; i
< rp
->maxactive
; i
++) {
966 inst
= kmalloc(sizeof(struct kretprobe_instance
) +
967 rp
->data_size
, GFP_KERNEL
);
972 INIT_HLIST_NODE(&inst
->hlist
);
973 hlist_add_head(&inst
->hlist
, &rp
->free_instances
);
977 /* Establish function entry probe point */
978 ret
= register_kprobe(&rp
->kp
);
984 int __kprobes
register_kretprobes(struct kretprobe
**rps
, int num
)
990 for (i
= 0; i
< num
; i
++) {
991 ret
= register_kretprobe(rps
[i
]);
994 unregister_kretprobes(rps
, i
);
1001 void __kprobes
unregister_kretprobe(struct kretprobe
*rp
)
1003 unregister_kretprobes(&rp
, 1);
1006 void __kprobes
unregister_kretprobes(struct kretprobe
**rps
, int num
)
1012 mutex_lock(&kprobe_mutex
);
1013 for (i
= 0; i
< num
; i
++)
1014 if (__unregister_kprobe_top(&rps
[i
]->kp
) < 0)
1015 rps
[i
]->kp
.addr
= NULL
;
1016 mutex_unlock(&kprobe_mutex
);
1018 synchronize_sched();
1019 for (i
= 0; i
< num
; i
++) {
1020 if (rps
[i
]->kp
.addr
) {
1021 __unregister_kprobe_bottom(&rps
[i
]->kp
);
1022 cleanup_rp_inst(rps
[i
]);
1027 #else /* CONFIG_KRETPROBES */
1028 int __kprobes
register_kretprobe(struct kretprobe
*rp
)
1033 int __kprobes
register_kretprobes(struct kretprobe
**rps
, int num
)
1037 void __kprobes
unregister_kretprobe(struct kretprobe
*rp
)
1041 void __kprobes
unregister_kretprobes(struct kretprobe
**rps
, int num
)
1045 static int __kprobes
pre_handler_kretprobe(struct kprobe
*p
,
1046 struct pt_regs
*regs
)
1051 #endif /* CONFIG_KRETPROBES */
1053 /* Set the kprobe gone and remove its instruction buffer. */
1054 static void __kprobes
kill_kprobe(struct kprobe
*p
)
1057 p
->flags
|= KPROBE_FLAG_GONE
;
1058 if (p
->pre_handler
== aggr_pre_handler
) {
1060 * If this is an aggr_kprobe, we have to list all the
1061 * chained probes and mark them GONE.
1063 list_for_each_entry_rcu(kp
, &p
->list
, list
)
1064 kp
->flags
|= KPROBE_FLAG_GONE
;
1065 p
->post_handler
= NULL
;
1066 p
->break_handler
= NULL
;
1069 * Here, we can remove insn_slot safely, because no thread calls
1070 * the original probed function (which will be freed soon) any more.
1072 arch_remove_kprobe(p
);
1075 /* Module notifier call back, checking kprobes on the module */
1076 static int __kprobes
kprobes_module_callback(struct notifier_block
*nb
,
1077 unsigned long val
, void *data
)
1079 struct module
*mod
= data
;
1080 struct hlist_head
*head
;
1081 struct hlist_node
*node
;
1084 int checkcore
= (val
== MODULE_STATE_GOING
);
1086 if (val
!= MODULE_STATE_GOING
&& val
!= MODULE_STATE_LIVE
)
1090 * When MODULE_STATE_GOING was notified, both of module .text and
1091 * .init.text sections would be freed. When MODULE_STATE_LIVE was
1092 * notified, only .init.text section would be freed. We need to
1093 * disable kprobes which have been inserted in the sections.
1095 mutex_lock(&kprobe_mutex
);
1096 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
1097 head
= &kprobe_table
[i
];
1098 hlist_for_each_entry_rcu(p
, node
, head
, hlist
)
1099 if (within_module_init((unsigned long)p
->addr
, mod
) ||
1101 within_module_core((unsigned long)p
->addr
, mod
))) {
1103 * The vaddr this probe is installed will soon
1104 * be vfreed buy not synced to disk. Hence,
1105 * disarming the breakpoint isn't needed.
1110 mutex_unlock(&kprobe_mutex
);
1114 static struct notifier_block kprobe_module_nb
= {
1115 .notifier_call
= kprobes_module_callback
,
1119 static int __init
init_kprobes(void)
1122 unsigned long offset
= 0, size
= 0;
1123 char *modname
, namebuf
[128];
1124 const char *symbol_name
;
1126 struct kprobe_blackpoint
*kb
;
1128 /* FIXME allocate the probe table, currently defined statically */
1129 /* initialize all list heads */
1130 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
1131 INIT_HLIST_HEAD(&kprobe_table
[i
]);
1132 INIT_HLIST_HEAD(&kretprobe_inst_table
[i
]);
1133 spin_lock_init(&(kretprobe_table_locks
[i
].lock
));
1137 * Lookup and populate the kprobe_blacklist.
1139 * Unlike the kretprobe blacklist, we'll need to determine
1140 * the range of addresses that belong to the said functions,
1141 * since a kprobe need not necessarily be at the beginning
1144 for (kb
= kprobe_blacklist
; kb
->name
!= NULL
; kb
++) {
1145 kprobe_lookup_name(kb
->name
, addr
);
1149 kb
->start_addr
= (unsigned long)addr
;
1150 symbol_name
= kallsyms_lookup(kb
->start_addr
,
1151 &size
, &offset
, &modname
, namebuf
);
1158 if (kretprobe_blacklist_size
) {
1159 /* lookup the function address from its name */
1160 for (i
= 0; kretprobe_blacklist
[i
].name
!= NULL
; i
++) {
1161 kprobe_lookup_name(kretprobe_blacklist
[i
].name
,
1162 kretprobe_blacklist
[i
].addr
);
1163 if (!kretprobe_blacklist
[i
].addr
)
1164 printk("kretprobe: lookup failed: %s\n",
1165 kretprobe_blacklist
[i
].name
);
1169 /* By default, kprobes are enabled */
1170 kprobe_enabled
= true;
1172 err
= arch_init_kprobes();
1174 err
= register_die_notifier(&kprobe_exceptions_nb
);
1176 err
= register_module_notifier(&kprobe_module_nb
);
1178 kprobes_initialized
= (err
== 0);
1185 #ifdef CONFIG_DEBUG_FS
1186 static void __kprobes
report_probe(struct seq_file
*pi
, struct kprobe
*p
,
1187 const char *sym
, int offset
,char *modname
)
1191 if (p
->pre_handler
== pre_handler_kretprobe
)
1193 else if (p
->pre_handler
== setjmp_pre_handler
)
1198 seq_printf(pi
, "%p %s %s+0x%x %s %s\n", p
->addr
, kprobe_type
,
1199 sym
, offset
, (modname
? modname
: " "),
1200 (kprobe_gone(p
) ? "[GONE]" : ""));
1202 seq_printf(pi
, "%p %s %p %s\n", p
->addr
, kprobe_type
, p
->addr
,
1203 (kprobe_gone(p
) ? "[GONE]" : ""));
1206 static void __kprobes
*kprobe_seq_start(struct seq_file
*f
, loff_t
*pos
)
1208 return (*pos
< KPROBE_TABLE_SIZE
) ? pos
: NULL
;
1211 static void __kprobes
*kprobe_seq_next(struct seq_file
*f
, void *v
, loff_t
*pos
)
1214 if (*pos
>= KPROBE_TABLE_SIZE
)
1219 static void __kprobes
kprobe_seq_stop(struct seq_file
*f
, void *v
)
1224 static int __kprobes
show_kprobe_addr(struct seq_file
*pi
, void *v
)
1226 struct hlist_head
*head
;
1227 struct hlist_node
*node
;
1228 struct kprobe
*p
, *kp
;
1229 const char *sym
= NULL
;
1230 unsigned int i
= *(loff_t
*) v
;
1231 unsigned long offset
= 0;
1232 char *modname
, namebuf
[128];
1234 head
= &kprobe_table
[i
];
1236 hlist_for_each_entry_rcu(p
, node
, head
, hlist
) {
1237 sym
= kallsyms_lookup((unsigned long)p
->addr
, NULL
,
1238 &offset
, &modname
, namebuf
);
1239 if (p
->pre_handler
== aggr_pre_handler
) {
1240 list_for_each_entry_rcu(kp
, &p
->list
, list
)
1241 report_probe(pi
, kp
, sym
, offset
, modname
);
1243 report_probe(pi
, p
, sym
, offset
, modname
);
1249 static struct seq_operations kprobes_seq_ops
= {
1250 .start
= kprobe_seq_start
,
1251 .next
= kprobe_seq_next
,
1252 .stop
= kprobe_seq_stop
,
1253 .show
= show_kprobe_addr
1256 static int __kprobes
kprobes_open(struct inode
*inode
, struct file
*filp
)
1258 return seq_open(filp
, &kprobes_seq_ops
);
1261 static struct file_operations debugfs_kprobes_operations
= {
1262 .open
= kprobes_open
,
1264 .llseek
= seq_lseek
,
1265 .release
= seq_release
,
1268 static void __kprobes
enable_all_kprobes(void)
1270 struct hlist_head
*head
;
1271 struct hlist_node
*node
;
1275 mutex_lock(&kprobe_mutex
);
1277 /* If kprobes are already enabled, just return */
1279 goto already_enabled
;
1281 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
1282 head
= &kprobe_table
[i
];
1283 hlist_for_each_entry_rcu(p
, node
, head
, hlist
)
1284 if (!kprobe_gone(p
))
1288 kprobe_enabled
= true;
1289 printk(KERN_INFO
"Kprobes globally enabled\n");
1292 mutex_unlock(&kprobe_mutex
);
1296 static void __kprobes
disable_all_kprobes(void)
1298 struct hlist_head
*head
;
1299 struct hlist_node
*node
;
1303 mutex_lock(&kprobe_mutex
);
1305 /* If kprobes are already disabled, just return */
1306 if (!kprobe_enabled
)
1307 goto already_disabled
;
1309 kprobe_enabled
= false;
1310 printk(KERN_INFO
"Kprobes globally disabled\n");
1311 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
1312 head
= &kprobe_table
[i
];
1313 hlist_for_each_entry_rcu(p
, node
, head
, hlist
) {
1314 if (!arch_trampoline_kprobe(p
) && !kprobe_gone(p
))
1315 arch_disarm_kprobe(p
);
1319 mutex_unlock(&kprobe_mutex
);
1320 /* Allow all currently running kprobes to complete */
1321 synchronize_sched();
1325 mutex_unlock(&kprobe_mutex
);
1330 * XXX: The debugfs bool file interface doesn't allow for callbacks
1331 * when the bool state is switched. We can reuse that facility when
1334 static ssize_t
read_enabled_file_bool(struct file
*file
,
1335 char __user
*user_buf
, size_t count
, loff_t
*ppos
)
1345 return simple_read_from_buffer(user_buf
, count
, ppos
, buf
, 2);
1348 static ssize_t
write_enabled_file_bool(struct file
*file
,
1349 const char __user
*user_buf
, size_t count
, loff_t
*ppos
)
1354 buf_size
= min(count
, (sizeof(buf
)-1));
1355 if (copy_from_user(buf
, user_buf
, buf_size
))
1362 enable_all_kprobes();
1367 disable_all_kprobes();
1374 static struct file_operations fops_kp
= {
1375 .read
= read_enabled_file_bool
,
1376 .write
= write_enabled_file_bool
,
1379 static int __kprobes
debugfs_kprobe_init(void)
1381 struct dentry
*dir
, *file
;
1382 unsigned int value
= 1;
1384 dir
= debugfs_create_dir("kprobes", NULL
);
1388 file
= debugfs_create_file("list", 0444, dir
, NULL
,
1389 &debugfs_kprobes_operations
);
1391 debugfs_remove(dir
);
1395 file
= debugfs_create_file("enabled", 0600, dir
,
1398 debugfs_remove(dir
);
1405 late_initcall(debugfs_kprobe_init
);
1406 #endif /* CONFIG_DEBUG_FS */
1408 module_init(init_kprobes
);
1410 EXPORT_SYMBOL_GPL(register_kprobe
);
1411 EXPORT_SYMBOL_GPL(unregister_kprobe
);
1412 EXPORT_SYMBOL_GPL(register_kprobes
);
1413 EXPORT_SYMBOL_GPL(unregister_kprobes
);
1414 EXPORT_SYMBOL_GPL(register_jprobe
);
1415 EXPORT_SYMBOL_GPL(unregister_jprobe
);
1416 EXPORT_SYMBOL_GPL(register_jprobes
);
1417 EXPORT_SYMBOL_GPL(unregister_jprobes
);
1418 EXPORT_SYMBOL_GPL(jprobe_return
);
1419 EXPORT_SYMBOL_GPL(register_kretprobe
);
1420 EXPORT_SYMBOL_GPL(unregister_kretprobe
);
1421 EXPORT_SYMBOL_GPL(register_kretprobes
);
1422 EXPORT_SYMBOL_GPL(unregister_kretprobes
);