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/sysctl.h>
46 #include <linux/kdebug.h>
47 #include <linux/memory.h>
48 #include <linux/ftrace.h>
49 #include <linux/cpu.h>
51 #include <asm-generic/sections.h>
52 #include <asm/cacheflush.h>
53 #include <asm/errno.h>
54 #include <asm/uaccess.h>
56 #define KPROBE_HASH_BITS 6
57 #define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
61 * Some oddball architectures like 64bit powerpc have function descriptors
62 * so this must be overridable.
64 #ifndef kprobe_lookup_name
65 #define kprobe_lookup_name(name, addr) \
66 addr = ((kprobe_opcode_t *)(kallsyms_lookup_name(name)))
69 static int kprobes_initialized
;
70 static struct hlist_head kprobe_table
[KPROBE_TABLE_SIZE
];
71 static struct hlist_head kretprobe_inst_table
[KPROBE_TABLE_SIZE
];
73 /* NOTE: change this value only with kprobe_mutex held */
74 static bool kprobes_all_disarmed
;
76 static DEFINE_MUTEX(kprobe_mutex
); /* Protects kprobe_table */
77 static DEFINE_PER_CPU(struct kprobe
*, kprobe_instance
) = NULL
;
79 spinlock_t lock ____cacheline_aligned_in_smp
;
80 } kretprobe_table_locks
[KPROBE_TABLE_SIZE
];
82 static spinlock_t
*kretprobe_table_lock_ptr(unsigned long hash
)
84 return &(kretprobe_table_locks
[hash
].lock
);
88 * Normally, functions that we'd want to prohibit kprobes in, are marked
89 * __kprobes. But, there are cases where such functions already belong to
90 * a different section (__sched for preempt_schedule)
92 * For such cases, we now have a blacklist
94 static struct kprobe_blackpoint kprobe_blacklist
[] = {
95 {"preempt_schedule",},
96 {"native_get_debugreg",},
97 {"irq_entries_start",},
98 {"common_interrupt",},
99 {"mcount",}, /* mcount can be called from everywhere */
100 {NULL
} /* Terminator */
103 #ifdef __ARCH_WANT_KPROBES_INSN_SLOT
105 * kprobe->ainsn.insn points to the copy of the instruction to be
106 * single-stepped. x86_64, POWER4 and above have no-exec support and
107 * stepping on the instruction on a vmalloced/kmalloced/data page
108 * is a recipe for disaster
110 struct kprobe_insn_page
{
111 struct list_head list
;
112 kprobe_opcode_t
*insns
; /* Page of instruction slots */
118 #define KPROBE_INSN_PAGE_SIZE(slots) \
119 (offsetof(struct kprobe_insn_page, slot_used) + \
120 (sizeof(char) * (slots)))
122 struct kprobe_insn_cache
{
123 struct list_head pages
; /* list of kprobe_insn_page */
124 size_t insn_size
; /* size of instruction slot */
128 static int slots_per_page(struct kprobe_insn_cache
*c
)
130 return PAGE_SIZE
/(c
->insn_size
* sizeof(kprobe_opcode_t
));
133 enum kprobe_slot_state
{
139 static DEFINE_MUTEX(kprobe_insn_mutex
); /* Protects kprobe_insn_slots */
140 static struct kprobe_insn_cache kprobe_insn_slots
= {
141 .pages
= LIST_HEAD_INIT(kprobe_insn_slots
.pages
),
142 .insn_size
= MAX_INSN_SIZE
,
145 static int __kprobes
collect_garbage_slots(struct kprobe_insn_cache
*c
);
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(struct kprobe_insn_cache
*c
)
153 struct kprobe_insn_page
*kip
;
156 list_for_each_entry(kip
, &c
->pages
, list
) {
157 if (kip
->nused
< slots_per_page(c
)) {
159 for (i
= 0; i
< slots_per_page(c
); i
++) {
160 if (kip
->slot_used
[i
] == SLOT_CLEAN
) {
161 kip
->slot_used
[i
] = SLOT_USED
;
163 return kip
->insns
+ (i
* c
->insn_size
);
166 /* kip->nused is broken. Fix it. */
167 kip
->nused
= slots_per_page(c
);
172 /* If there are any garbage slots, collect it and try again. */
173 if (c
->nr_garbage
&& collect_garbage_slots(c
) == 0)
176 /* All out of space. Need to allocate a new page. */
177 kip
= kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c
)), GFP_KERNEL
);
182 * Use module_alloc so this page is within +/- 2GB of where the
183 * kernel image and loaded module images reside. This is required
184 * so x86_64 can correctly handle the %rip-relative fixups.
186 kip
->insns
= module_alloc(PAGE_SIZE
);
191 INIT_LIST_HEAD(&kip
->list
);
192 memset(kip
->slot_used
, SLOT_CLEAN
, slots_per_page(c
));
193 kip
->slot_used
[0] = SLOT_USED
;
196 list_add(&kip
->list
, &c
->pages
);
201 kprobe_opcode_t __kprobes
*get_insn_slot(void)
203 kprobe_opcode_t
*ret
= NULL
;
205 mutex_lock(&kprobe_insn_mutex
);
206 ret
= __get_insn_slot(&kprobe_insn_slots
);
207 mutex_unlock(&kprobe_insn_mutex
);
212 /* Return 1 if all garbages are collected, otherwise 0. */
213 static int __kprobes
collect_one_slot(struct kprobe_insn_page
*kip
, int idx
)
215 kip
->slot_used
[idx
] = SLOT_CLEAN
;
217 if (kip
->nused
== 0) {
219 * Page is no longer in use. Free it unless
220 * it's the last one. We keep the last one
221 * so as not to have to set it up again the
222 * next time somebody inserts a probe.
224 if (!list_is_singular(&kip
->list
)) {
225 list_del(&kip
->list
);
226 module_free(NULL
, kip
->insns
);
234 static int __kprobes
collect_garbage_slots(struct kprobe_insn_cache
*c
)
236 struct kprobe_insn_page
*kip
, *next
;
238 /* Ensure no-one is interrupted on the garbages */
241 list_for_each_entry_safe(kip
, next
, &c
->pages
, list
) {
243 if (kip
->ngarbage
== 0)
245 kip
->ngarbage
= 0; /* we will collect all garbages */
246 for (i
= 0; i
< slots_per_page(c
); i
++) {
247 if (kip
->slot_used
[i
] == SLOT_DIRTY
&&
248 collect_one_slot(kip
, i
))
256 static void __kprobes
__free_insn_slot(struct kprobe_insn_cache
*c
,
257 kprobe_opcode_t
*slot
, int dirty
)
259 struct kprobe_insn_page
*kip
;
261 list_for_each_entry(kip
, &c
->pages
, list
) {
262 long idx
= ((long)slot
- (long)kip
->insns
) /
263 (c
->insn_size
* sizeof(kprobe_opcode_t
));
264 if (idx
>= 0 && idx
< slots_per_page(c
)) {
265 WARN_ON(kip
->slot_used
[idx
] != SLOT_USED
);
267 kip
->slot_used
[idx
] = SLOT_DIRTY
;
269 if (++c
->nr_garbage
> slots_per_page(c
))
270 collect_garbage_slots(c
);
272 collect_one_slot(kip
, idx
);
276 /* Could not free this slot. */
280 void __kprobes
free_insn_slot(kprobe_opcode_t
* slot
, int dirty
)
282 mutex_lock(&kprobe_insn_mutex
);
283 __free_insn_slot(&kprobe_insn_slots
, slot
, dirty
);
284 mutex_unlock(&kprobe_insn_mutex
);
286 #ifdef CONFIG_OPTPROBES
287 /* For optimized_kprobe buffer */
288 static DEFINE_MUTEX(kprobe_optinsn_mutex
); /* Protects kprobe_optinsn_slots */
289 static struct kprobe_insn_cache kprobe_optinsn_slots
= {
290 .pages
= LIST_HEAD_INIT(kprobe_optinsn_slots
.pages
),
291 /* .insn_size is initialized later */
294 /* Get a slot for optimized_kprobe buffer */
295 kprobe_opcode_t __kprobes
*get_optinsn_slot(void)
297 kprobe_opcode_t
*ret
= NULL
;
299 mutex_lock(&kprobe_optinsn_mutex
);
300 ret
= __get_insn_slot(&kprobe_optinsn_slots
);
301 mutex_unlock(&kprobe_optinsn_mutex
);
306 void __kprobes
free_optinsn_slot(kprobe_opcode_t
* slot
, int dirty
)
308 mutex_lock(&kprobe_optinsn_mutex
);
309 __free_insn_slot(&kprobe_optinsn_slots
, slot
, dirty
);
310 mutex_unlock(&kprobe_optinsn_mutex
);
315 /* We have preemption disabled.. so it is safe to use __ versions */
316 static inline void set_kprobe_instance(struct kprobe
*kp
)
318 __get_cpu_var(kprobe_instance
) = kp
;
321 static inline void reset_kprobe_instance(void)
323 __get_cpu_var(kprobe_instance
) = NULL
;
327 * This routine is called either:
328 * - under the kprobe_mutex - during kprobe_[un]register()
330 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
332 struct kprobe __kprobes
*get_kprobe(void *addr
)
334 struct hlist_head
*head
;
335 struct hlist_node
*node
;
338 head
= &kprobe_table
[hash_ptr(addr
, KPROBE_HASH_BITS
)];
339 hlist_for_each_entry_rcu(p
, node
, head
, hlist
) {
347 static int __kprobes
aggr_pre_handler(struct kprobe
*p
, struct pt_regs
*regs
);
349 /* Return true if the kprobe is an aggregator */
350 static inline int kprobe_aggrprobe(struct kprobe
*p
)
352 return p
->pre_handler
== aggr_pre_handler
;
356 * Keep all fields in the kprobe consistent
358 static inline void copy_kprobe(struct kprobe
*old_p
, struct kprobe
*p
)
360 memcpy(&p
->opcode
, &old_p
->opcode
, sizeof(kprobe_opcode_t
));
361 memcpy(&p
->ainsn
, &old_p
->ainsn
, sizeof(struct arch_specific_insn
));
364 #ifdef CONFIG_OPTPROBES
365 /* NOTE: change this value only with kprobe_mutex held */
366 static bool kprobes_allow_optimization
;
369 * Call all pre_handler on the list, but ignores its return value.
370 * This must be called from arch-dep optimized caller.
372 void __kprobes
opt_pre_handler(struct kprobe
*p
, struct pt_regs
*regs
)
376 list_for_each_entry_rcu(kp
, &p
->list
, list
) {
377 if (kp
->pre_handler
&& likely(!kprobe_disabled(kp
))) {
378 set_kprobe_instance(kp
);
379 kp
->pre_handler(kp
, regs
);
381 reset_kprobe_instance();
385 /* Return true(!0) if the kprobe is ready for optimization. */
386 static inline int kprobe_optready(struct kprobe
*p
)
388 struct optimized_kprobe
*op
;
390 if (kprobe_aggrprobe(p
)) {
391 op
= container_of(p
, struct optimized_kprobe
, kp
);
392 return arch_prepared_optinsn(&op
->optinsn
);
399 * Return an optimized kprobe whose optimizing code replaces
400 * instructions including addr (exclude breakpoint).
402 struct kprobe
*__kprobes
get_optimized_kprobe(unsigned long addr
)
405 struct kprobe
*p
= NULL
;
406 struct optimized_kprobe
*op
;
408 /* Don't check i == 0, since that is a breakpoint case. */
409 for (i
= 1; !p
&& i
< MAX_OPTIMIZED_LENGTH
; i
++)
410 p
= get_kprobe((void *)(addr
- i
));
412 if (p
&& kprobe_optready(p
)) {
413 op
= container_of(p
, struct optimized_kprobe
, kp
);
414 if (arch_within_optimized_kprobe(op
, addr
))
421 /* Optimization staging list, protected by kprobe_mutex */
422 static LIST_HEAD(optimizing_list
);
424 static void kprobe_optimizer(struct work_struct
*work
);
425 static DECLARE_DELAYED_WORK(optimizing_work
, kprobe_optimizer
);
426 #define OPTIMIZE_DELAY 5
428 /* Kprobe jump optimizer */
429 static __kprobes
void kprobe_optimizer(struct work_struct
*work
)
431 struct optimized_kprobe
*op
, *tmp
;
433 /* Lock modules while optimizing kprobes */
434 mutex_lock(&module_mutex
);
435 mutex_lock(&kprobe_mutex
);
436 if (kprobes_all_disarmed
|| !kprobes_allow_optimization
)
440 * Wait for quiesence period to ensure all running interrupts
441 * are done. Because optprobe may modify multiple instructions
442 * there is a chance that Nth instruction is interrupted. In that
443 * case, running interrupt can return to 2nd-Nth byte of jump
444 * instruction. This wait is for avoiding it.
449 * The optimization/unoptimization refers online_cpus via
450 * stop_machine() and cpu-hotplug modifies online_cpus.
451 * And same time, text_mutex will be held in cpu-hotplug and here.
452 * This combination can cause a deadlock (cpu-hotplug try to lock
453 * text_mutex but stop_machine can not be done because online_cpus
455 * To avoid this deadlock, we need to call get_online_cpus()
456 * for preventing cpu-hotplug outside of text_mutex locking.
459 mutex_lock(&text_mutex
);
460 list_for_each_entry_safe(op
, tmp
, &optimizing_list
, list
) {
461 WARN_ON(kprobe_disabled(&op
->kp
));
462 if (arch_optimize_kprobe(op
) < 0)
463 op
->kp
.flags
&= ~KPROBE_FLAG_OPTIMIZED
;
464 list_del_init(&op
->list
);
466 mutex_unlock(&text_mutex
);
469 mutex_unlock(&kprobe_mutex
);
470 mutex_unlock(&module_mutex
);
473 /* Optimize kprobe if p is ready to be optimized */
474 static __kprobes
void optimize_kprobe(struct kprobe
*p
)
476 struct optimized_kprobe
*op
;
478 /* Check if the kprobe is disabled or not ready for optimization. */
479 if (!kprobe_optready(p
) || !kprobes_allow_optimization
||
480 (kprobe_disabled(p
) || kprobes_all_disarmed
))
483 /* Both of break_handler and post_handler are not supported. */
484 if (p
->break_handler
|| p
->post_handler
)
487 op
= container_of(p
, struct optimized_kprobe
, kp
);
489 /* Check there is no other kprobes at the optimized instructions */
490 if (arch_check_optimized_kprobe(op
) < 0)
493 /* Check if it is already optimized. */
494 if (op
->kp
.flags
& KPROBE_FLAG_OPTIMIZED
)
497 op
->kp
.flags
|= KPROBE_FLAG_OPTIMIZED
;
498 list_add(&op
->list
, &optimizing_list
);
499 if (!delayed_work_pending(&optimizing_work
))
500 schedule_delayed_work(&optimizing_work
, OPTIMIZE_DELAY
);
503 /* Unoptimize a kprobe if p is optimized */
504 static __kprobes
void unoptimize_kprobe(struct kprobe
*p
)
506 struct optimized_kprobe
*op
;
508 if ((p
->flags
& KPROBE_FLAG_OPTIMIZED
) && kprobe_aggrprobe(p
)) {
509 op
= container_of(p
, struct optimized_kprobe
, kp
);
510 if (!list_empty(&op
->list
))
511 /* Dequeue from the optimization queue */
512 list_del_init(&op
->list
);
514 /* Replace jump with break */
515 arch_unoptimize_kprobe(op
);
516 op
->kp
.flags
&= ~KPROBE_FLAG_OPTIMIZED
;
520 /* Remove optimized instructions */
521 static void __kprobes
kill_optimized_kprobe(struct kprobe
*p
)
523 struct optimized_kprobe
*op
;
525 op
= container_of(p
, struct optimized_kprobe
, kp
);
526 if (!list_empty(&op
->list
)) {
527 /* Dequeue from the optimization queue */
528 list_del_init(&op
->list
);
529 op
->kp
.flags
&= ~KPROBE_FLAG_OPTIMIZED
;
531 /* Don't unoptimize, because the target code will be freed. */
532 arch_remove_optimized_kprobe(op
);
535 /* Try to prepare optimized instructions */
536 static __kprobes
void prepare_optimized_kprobe(struct kprobe
*p
)
538 struct optimized_kprobe
*op
;
540 op
= container_of(p
, struct optimized_kprobe
, kp
);
541 arch_prepare_optimized_kprobe(op
);
544 /* Free optimized instructions and optimized_kprobe */
545 static __kprobes
void free_aggr_kprobe(struct kprobe
*p
)
547 struct optimized_kprobe
*op
;
549 op
= container_of(p
, struct optimized_kprobe
, kp
);
550 arch_remove_optimized_kprobe(op
);
554 /* Allocate new optimized_kprobe and try to prepare optimized instructions */
555 static __kprobes
struct kprobe
*alloc_aggr_kprobe(struct kprobe
*p
)
557 struct optimized_kprobe
*op
;
559 op
= kzalloc(sizeof(struct optimized_kprobe
), GFP_KERNEL
);
563 INIT_LIST_HEAD(&op
->list
);
564 op
->kp
.addr
= p
->addr
;
565 arch_prepare_optimized_kprobe(op
);
570 static void __kprobes
init_aggr_kprobe(struct kprobe
*ap
, struct kprobe
*p
);
573 * Prepare an optimized_kprobe and optimize it
574 * NOTE: p must be a normal registered kprobe
576 static __kprobes
void try_to_optimize_kprobe(struct kprobe
*p
)
579 struct optimized_kprobe
*op
;
581 ap
= alloc_aggr_kprobe(p
);
585 op
= container_of(ap
, struct optimized_kprobe
, kp
);
586 if (!arch_prepared_optinsn(&op
->optinsn
)) {
587 /* If failed to setup optimizing, fallback to kprobe */
588 free_aggr_kprobe(ap
);
592 init_aggr_kprobe(ap
, p
);
597 static void __kprobes
optimize_all_kprobes(void)
599 struct hlist_head
*head
;
600 struct hlist_node
*node
;
604 /* If optimization is already allowed, just return */
605 if (kprobes_allow_optimization
)
608 kprobes_allow_optimization
= true;
609 mutex_lock(&text_mutex
);
610 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
611 head
= &kprobe_table
[i
];
612 hlist_for_each_entry_rcu(p
, node
, head
, hlist
)
613 if (!kprobe_disabled(p
))
616 mutex_unlock(&text_mutex
);
617 printk(KERN_INFO
"Kprobes globally optimized\n");
620 static void __kprobes
unoptimize_all_kprobes(void)
622 struct hlist_head
*head
;
623 struct hlist_node
*node
;
627 /* If optimization is already prohibited, just return */
628 if (!kprobes_allow_optimization
)
631 kprobes_allow_optimization
= false;
632 printk(KERN_INFO
"Kprobes globally unoptimized\n");
633 get_online_cpus(); /* For avoiding text_mutex deadlock */
634 mutex_lock(&text_mutex
);
635 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
636 head
= &kprobe_table
[i
];
637 hlist_for_each_entry_rcu(p
, node
, head
, hlist
) {
638 if (!kprobe_disabled(p
))
639 unoptimize_kprobe(p
);
643 mutex_unlock(&text_mutex
);
645 /* Allow all currently running kprobes to complete */
649 int sysctl_kprobes_optimization
;
650 int proc_kprobes_optimization_handler(struct ctl_table
*table
, int write
,
651 void __user
*buffer
, size_t *length
,
656 mutex_lock(&kprobe_mutex
);
657 sysctl_kprobes_optimization
= kprobes_allow_optimization
? 1 : 0;
658 ret
= proc_dointvec_minmax(table
, write
, buffer
, length
, ppos
);
660 if (sysctl_kprobes_optimization
)
661 optimize_all_kprobes();
663 unoptimize_all_kprobes();
664 mutex_unlock(&kprobe_mutex
);
668 #endif /* CONFIG_SYSCTL */
670 static void __kprobes
__arm_kprobe(struct kprobe
*p
)
672 struct kprobe
*old_p
;
674 /* Check collision with other optimized kprobes */
675 old_p
= get_optimized_kprobe((unsigned long)p
->addr
);
677 unoptimize_kprobe(old_p
); /* Fallback to unoptimized kprobe */
680 optimize_kprobe(p
); /* Try to optimize (add kprobe to a list) */
683 static void __kprobes
__disarm_kprobe(struct kprobe
*p
)
685 struct kprobe
*old_p
;
687 unoptimize_kprobe(p
); /* Try to unoptimize */
688 arch_disarm_kprobe(p
);
690 /* If another kprobe was blocked, optimize it. */
691 old_p
= get_optimized_kprobe((unsigned long)p
->addr
);
693 optimize_kprobe(old_p
);
696 #else /* !CONFIG_OPTPROBES */
698 #define optimize_kprobe(p) do {} while (0)
699 #define unoptimize_kprobe(p) do {} while (0)
700 #define kill_optimized_kprobe(p) do {} while (0)
701 #define prepare_optimized_kprobe(p) do {} while (0)
702 #define try_to_optimize_kprobe(p) do {} while (0)
703 #define __arm_kprobe(p) arch_arm_kprobe(p)
704 #define __disarm_kprobe(p) arch_disarm_kprobe(p)
706 static __kprobes
void free_aggr_kprobe(struct kprobe
*p
)
711 static __kprobes
struct kprobe
*alloc_aggr_kprobe(struct kprobe
*p
)
713 return kzalloc(sizeof(struct kprobe
), GFP_KERNEL
);
715 #endif /* CONFIG_OPTPROBES */
717 /* Arm a kprobe with text_mutex */
718 static void __kprobes
arm_kprobe(struct kprobe
*kp
)
721 * Here, since __arm_kprobe() doesn't use stop_machine(),
722 * this doesn't cause deadlock on text_mutex. So, we don't
723 * need get_online_cpus().
725 mutex_lock(&text_mutex
);
727 mutex_unlock(&text_mutex
);
730 /* Disarm a kprobe with text_mutex */
731 static void __kprobes
disarm_kprobe(struct kprobe
*kp
)
733 get_online_cpus(); /* For avoiding text_mutex deadlock */
734 mutex_lock(&text_mutex
);
736 mutex_unlock(&text_mutex
);
741 * Aggregate handlers for multiple kprobes support - these handlers
742 * take care of invoking the individual kprobe handlers on p->list
744 static int __kprobes
aggr_pre_handler(struct kprobe
*p
, struct pt_regs
*regs
)
748 list_for_each_entry_rcu(kp
, &p
->list
, list
) {
749 if (kp
->pre_handler
&& likely(!kprobe_disabled(kp
))) {
750 set_kprobe_instance(kp
);
751 if (kp
->pre_handler(kp
, regs
))
754 reset_kprobe_instance();
759 static void __kprobes
aggr_post_handler(struct kprobe
*p
, struct pt_regs
*regs
,
764 list_for_each_entry_rcu(kp
, &p
->list
, list
) {
765 if (kp
->post_handler
&& likely(!kprobe_disabled(kp
))) {
766 set_kprobe_instance(kp
);
767 kp
->post_handler(kp
, regs
, flags
);
768 reset_kprobe_instance();
773 static int __kprobes
aggr_fault_handler(struct kprobe
*p
, struct pt_regs
*regs
,
776 struct kprobe
*cur
= __get_cpu_var(kprobe_instance
);
779 * if we faulted "during" the execution of a user specified
780 * probe handler, invoke just that probe's fault handler
782 if (cur
&& cur
->fault_handler
) {
783 if (cur
->fault_handler(cur
, regs
, trapnr
))
789 static int __kprobes
aggr_break_handler(struct kprobe
*p
, struct pt_regs
*regs
)
791 struct kprobe
*cur
= __get_cpu_var(kprobe_instance
);
794 if (cur
&& cur
->break_handler
) {
795 if (cur
->break_handler(cur
, regs
))
798 reset_kprobe_instance();
802 /* Walks the list and increments nmissed count for multiprobe case */
803 void __kprobes
kprobes_inc_nmissed_count(struct kprobe
*p
)
806 if (!kprobe_aggrprobe(p
)) {
809 list_for_each_entry_rcu(kp
, &p
->list
, list
)
815 void __kprobes
recycle_rp_inst(struct kretprobe_instance
*ri
,
816 struct hlist_head
*head
)
818 struct kretprobe
*rp
= ri
->rp
;
820 /* remove rp inst off the rprobe_inst_table */
821 hlist_del(&ri
->hlist
);
822 INIT_HLIST_NODE(&ri
->hlist
);
824 spin_lock(&rp
->lock
);
825 hlist_add_head(&ri
->hlist
, &rp
->free_instances
);
826 spin_unlock(&rp
->lock
);
829 hlist_add_head(&ri
->hlist
, head
);
832 void __kprobes
kretprobe_hash_lock(struct task_struct
*tsk
,
833 struct hlist_head
**head
, unsigned long *flags
)
835 unsigned long hash
= hash_ptr(tsk
, KPROBE_HASH_BITS
);
836 spinlock_t
*hlist_lock
;
838 *head
= &kretprobe_inst_table
[hash
];
839 hlist_lock
= kretprobe_table_lock_ptr(hash
);
840 spin_lock_irqsave(hlist_lock
, *flags
);
843 static void __kprobes
kretprobe_table_lock(unsigned long hash
,
844 unsigned long *flags
)
846 spinlock_t
*hlist_lock
= kretprobe_table_lock_ptr(hash
);
847 spin_lock_irqsave(hlist_lock
, *flags
);
850 void __kprobes
kretprobe_hash_unlock(struct task_struct
*tsk
,
851 unsigned long *flags
)
853 unsigned long hash
= hash_ptr(tsk
, KPROBE_HASH_BITS
);
854 spinlock_t
*hlist_lock
;
856 hlist_lock
= kretprobe_table_lock_ptr(hash
);
857 spin_unlock_irqrestore(hlist_lock
, *flags
);
860 void __kprobes
kretprobe_table_unlock(unsigned long hash
, unsigned long *flags
)
862 spinlock_t
*hlist_lock
= kretprobe_table_lock_ptr(hash
);
863 spin_unlock_irqrestore(hlist_lock
, *flags
);
867 * This function is called from finish_task_switch when task tk becomes dead,
868 * so that we can recycle any function-return probe instances associated
869 * with this task. These left over instances represent probed functions
870 * that have been called but will never return.
872 void __kprobes
kprobe_flush_task(struct task_struct
*tk
)
874 struct kretprobe_instance
*ri
;
875 struct hlist_head
*head
, empty_rp
;
876 struct hlist_node
*node
, *tmp
;
877 unsigned long hash
, flags
= 0;
879 if (unlikely(!kprobes_initialized
))
880 /* Early boot. kretprobe_table_locks not yet initialized. */
883 hash
= hash_ptr(tk
, KPROBE_HASH_BITS
);
884 head
= &kretprobe_inst_table
[hash
];
885 kretprobe_table_lock(hash
, &flags
);
886 hlist_for_each_entry_safe(ri
, node
, tmp
, head
, hlist
) {
888 recycle_rp_inst(ri
, &empty_rp
);
890 kretprobe_table_unlock(hash
, &flags
);
891 INIT_HLIST_HEAD(&empty_rp
);
892 hlist_for_each_entry_safe(ri
, node
, tmp
, &empty_rp
, hlist
) {
893 hlist_del(&ri
->hlist
);
898 static inline void free_rp_inst(struct kretprobe
*rp
)
900 struct kretprobe_instance
*ri
;
901 struct hlist_node
*pos
, *next
;
903 hlist_for_each_entry_safe(ri
, pos
, next
, &rp
->free_instances
, hlist
) {
904 hlist_del(&ri
->hlist
);
909 static void __kprobes
cleanup_rp_inst(struct kretprobe
*rp
)
911 unsigned long flags
, hash
;
912 struct kretprobe_instance
*ri
;
913 struct hlist_node
*pos
, *next
;
914 struct hlist_head
*head
;
917 for (hash
= 0; hash
< KPROBE_TABLE_SIZE
; hash
++) {
918 kretprobe_table_lock(hash
, &flags
);
919 head
= &kretprobe_inst_table
[hash
];
920 hlist_for_each_entry_safe(ri
, pos
, next
, head
, hlist
) {
924 kretprobe_table_unlock(hash
, &flags
);
930 * Add the new probe to ap->list. Fail if this is the
931 * second jprobe at the address - two jprobes can't coexist
933 static int __kprobes
add_new_kprobe(struct kprobe
*ap
, struct kprobe
*p
)
935 BUG_ON(kprobe_gone(ap
) || kprobe_gone(p
));
937 if (p
->break_handler
|| p
->post_handler
)
938 unoptimize_kprobe(ap
); /* Fall back to normal kprobe */
940 if (p
->break_handler
) {
941 if (ap
->break_handler
)
943 list_add_tail_rcu(&p
->list
, &ap
->list
);
944 ap
->break_handler
= aggr_break_handler
;
946 list_add_rcu(&p
->list
, &ap
->list
);
947 if (p
->post_handler
&& !ap
->post_handler
)
948 ap
->post_handler
= aggr_post_handler
;
950 if (kprobe_disabled(ap
) && !kprobe_disabled(p
)) {
951 ap
->flags
&= ~KPROBE_FLAG_DISABLED
;
952 if (!kprobes_all_disarmed
)
953 /* Arm the breakpoint again. */
960 * Fill in the required fields of the "manager kprobe". Replace the
961 * earlier kprobe in the hlist with the manager kprobe
963 static void __kprobes
init_aggr_kprobe(struct kprobe
*ap
, struct kprobe
*p
)
965 /* Copy p's insn slot to ap */
969 ap
->flags
= p
->flags
& ~KPROBE_FLAG_OPTIMIZED
;
970 ap
->pre_handler
= aggr_pre_handler
;
971 ap
->fault_handler
= aggr_fault_handler
;
972 /* We don't care the kprobe which has gone. */
973 if (p
->post_handler
&& !kprobe_gone(p
))
974 ap
->post_handler
= aggr_post_handler
;
975 if (p
->break_handler
&& !kprobe_gone(p
))
976 ap
->break_handler
= aggr_break_handler
;
978 INIT_LIST_HEAD(&ap
->list
);
979 INIT_HLIST_NODE(&ap
->hlist
);
981 list_add_rcu(&p
->list
, &ap
->list
);
982 hlist_replace_rcu(&p
->hlist
, &ap
->hlist
);
986 * This is the second or subsequent kprobe at the address - handle
989 static int __kprobes
register_aggr_kprobe(struct kprobe
*old_p
,
993 struct kprobe
*ap
= old_p
;
995 if (!kprobe_aggrprobe(old_p
)) {
996 /* If old_p is not an aggr_kprobe, create new aggr_kprobe. */
997 ap
= alloc_aggr_kprobe(old_p
);
1000 init_aggr_kprobe(ap
, old_p
);
1003 if (kprobe_gone(ap
)) {
1005 * Attempting to insert new probe at the same location that
1006 * had a probe in the module vaddr area which already
1007 * freed. So, the instruction slot has already been
1008 * released. We need a new slot for the new probe.
1010 ret
= arch_prepare_kprobe(ap
);
1013 * Even if fail to allocate new slot, don't need to
1014 * free aggr_probe. It will be used next time, or
1015 * freed by unregister_kprobe.
1019 /* Prepare optimized instructions if possible. */
1020 prepare_optimized_kprobe(ap
);
1023 * Clear gone flag to prevent allocating new slot again, and
1024 * set disabled flag because it is not armed yet.
1026 ap
->flags
= (ap
->flags
& ~KPROBE_FLAG_GONE
)
1027 | KPROBE_FLAG_DISABLED
;
1030 /* Copy ap's insn slot to p */
1032 return add_new_kprobe(ap
, p
);
1035 /* Try to disable aggr_kprobe, and return 1 if succeeded.*/
1036 static int __kprobes
try_to_disable_aggr_kprobe(struct kprobe
*p
)
1040 list_for_each_entry_rcu(kp
, &p
->list
, list
) {
1041 if (!kprobe_disabled(kp
))
1043 * There is an active probe on the list.
1044 * We can't disable aggr_kprobe.
1048 p
->flags
|= KPROBE_FLAG_DISABLED
;
1052 static int __kprobes
in_kprobes_functions(unsigned long addr
)
1054 struct kprobe_blackpoint
*kb
;
1056 if (addr
>= (unsigned long)__kprobes_text_start
&&
1057 addr
< (unsigned long)__kprobes_text_end
)
1060 * If there exists a kprobe_blacklist, verify and
1061 * fail any probe registration in the prohibited area
1063 for (kb
= kprobe_blacklist
; kb
->name
!= NULL
; kb
++) {
1064 if (kb
->start_addr
) {
1065 if (addr
>= kb
->start_addr
&&
1066 addr
< (kb
->start_addr
+ kb
->range
))
1074 * If we have a symbol_name argument, look it up and add the offset field
1075 * to it. This way, we can specify a relative address to a symbol.
1077 static kprobe_opcode_t __kprobes
*kprobe_addr(struct kprobe
*p
)
1079 kprobe_opcode_t
*addr
= p
->addr
;
1080 if (p
->symbol_name
) {
1083 kprobe_lookup_name(p
->symbol_name
, addr
);
1088 return (kprobe_opcode_t
*)(((char *)addr
) + p
->offset
);
1091 /* Check passed kprobe is valid and return kprobe in kprobe_table. */
1092 static struct kprobe
* __kprobes
__get_valid_kprobe(struct kprobe
*p
)
1094 struct kprobe
*old_p
, *list_p
;
1096 old_p
= get_kprobe(p
->addr
);
1097 if (unlikely(!old_p
))
1101 list_for_each_entry_rcu(list_p
, &old_p
->list
, list
)
1103 /* kprobe p is a valid probe */
1111 /* Return error if the kprobe is being re-registered */
1112 static inline int check_kprobe_rereg(struct kprobe
*p
)
1115 struct kprobe
*old_p
;
1117 mutex_lock(&kprobe_mutex
);
1118 old_p
= __get_valid_kprobe(p
);
1121 mutex_unlock(&kprobe_mutex
);
1125 int __kprobes
register_kprobe(struct kprobe
*p
)
1128 struct kprobe
*old_p
;
1129 struct module
*probed_mod
;
1130 kprobe_opcode_t
*addr
;
1132 addr
= kprobe_addr(p
);
1137 ret
= check_kprobe_rereg(p
);
1142 if (!kernel_text_address((unsigned long) p
->addr
) ||
1143 in_kprobes_functions((unsigned long) p
->addr
) ||
1144 ftrace_text_reserved(p
->addr
, p
->addr
)) {
1149 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1150 p
->flags
&= KPROBE_FLAG_DISABLED
;
1153 * Check if are we probing a module.
1155 probed_mod
= __module_text_address((unsigned long) p
->addr
);
1158 * We must hold a refcount of the probed module while updating
1159 * its code to prohibit unexpected unloading.
1161 if (unlikely(!try_module_get(probed_mod
))) {
1166 * If the module freed .init.text, we couldn't insert
1169 if (within_module_init((unsigned long)p
->addr
, probed_mod
) &&
1170 probed_mod
->state
!= MODULE_STATE_COMING
) {
1171 module_put(probed_mod
);
1179 INIT_LIST_HEAD(&p
->list
);
1180 mutex_lock(&kprobe_mutex
);
1182 get_online_cpus(); /* For avoiding text_mutex deadlock. */
1183 mutex_lock(&text_mutex
);
1185 old_p
= get_kprobe(p
->addr
);
1187 /* Since this may unoptimize old_p, locking text_mutex. */
1188 ret
= register_aggr_kprobe(old_p
, p
);
1192 ret
= arch_prepare_kprobe(p
);
1196 INIT_HLIST_NODE(&p
->hlist
);
1197 hlist_add_head_rcu(&p
->hlist
,
1198 &kprobe_table
[hash_ptr(p
->addr
, KPROBE_HASH_BITS
)]);
1200 if (!kprobes_all_disarmed
&& !kprobe_disabled(p
))
1203 /* Try to optimize kprobe */
1204 try_to_optimize_kprobe(p
);
1207 mutex_unlock(&text_mutex
);
1209 mutex_unlock(&kprobe_mutex
);
1212 module_put(probed_mod
);
1216 EXPORT_SYMBOL_GPL(register_kprobe
);
1219 * Unregister a kprobe without a scheduler synchronization.
1221 static int __kprobes
__unregister_kprobe_top(struct kprobe
*p
)
1223 struct kprobe
*old_p
, *list_p
;
1225 old_p
= __get_valid_kprobe(p
);
1230 (kprobe_aggrprobe(old_p
) &&
1231 list_is_singular(&old_p
->list
))) {
1233 * Only probe on the hash list. Disarm only if kprobes are
1234 * enabled and not gone - otherwise, the breakpoint would
1235 * already have been removed. We save on flushing icache.
1237 if (!kprobes_all_disarmed
&& !kprobe_disabled(old_p
))
1238 disarm_kprobe(old_p
);
1239 hlist_del_rcu(&old_p
->hlist
);
1241 if (p
->break_handler
&& !kprobe_gone(p
))
1242 old_p
->break_handler
= NULL
;
1243 if (p
->post_handler
&& !kprobe_gone(p
)) {
1244 list_for_each_entry_rcu(list_p
, &old_p
->list
, list
) {
1245 if ((list_p
!= p
) && (list_p
->post_handler
))
1248 old_p
->post_handler
= NULL
;
1251 list_del_rcu(&p
->list
);
1252 if (!kprobe_disabled(old_p
)) {
1253 try_to_disable_aggr_kprobe(old_p
);
1254 if (!kprobes_all_disarmed
) {
1255 if (kprobe_disabled(old_p
))
1256 disarm_kprobe(old_p
);
1258 /* Try to optimize this probe again */
1259 optimize_kprobe(old_p
);
1266 static void __kprobes
__unregister_kprobe_bottom(struct kprobe
*p
)
1268 struct kprobe
*old_p
;
1270 if (list_empty(&p
->list
))
1271 arch_remove_kprobe(p
);
1272 else if (list_is_singular(&p
->list
)) {
1273 /* "p" is the last child of an aggr_kprobe */
1274 old_p
= list_entry(p
->list
.next
, struct kprobe
, list
);
1276 arch_remove_kprobe(old_p
);
1277 free_aggr_kprobe(old_p
);
1281 int __kprobes
register_kprobes(struct kprobe
**kps
, int num
)
1287 for (i
= 0; i
< num
; i
++) {
1288 ret
= register_kprobe(kps
[i
]);
1291 unregister_kprobes(kps
, i
);
1297 EXPORT_SYMBOL_GPL(register_kprobes
);
1299 void __kprobes
unregister_kprobe(struct kprobe
*p
)
1301 unregister_kprobes(&p
, 1);
1303 EXPORT_SYMBOL_GPL(unregister_kprobe
);
1305 void __kprobes
unregister_kprobes(struct kprobe
**kps
, int num
)
1311 mutex_lock(&kprobe_mutex
);
1312 for (i
= 0; i
< num
; i
++)
1313 if (__unregister_kprobe_top(kps
[i
]) < 0)
1314 kps
[i
]->addr
= NULL
;
1315 mutex_unlock(&kprobe_mutex
);
1317 synchronize_sched();
1318 for (i
= 0; i
< num
; i
++)
1320 __unregister_kprobe_bottom(kps
[i
]);
1322 EXPORT_SYMBOL_GPL(unregister_kprobes
);
1324 static struct notifier_block kprobe_exceptions_nb
= {
1325 .notifier_call
= kprobe_exceptions_notify
,
1326 .priority
= 0x7fffffff /* we need to be notified first */
1329 unsigned long __weak
arch_deref_entry_point(void *entry
)
1331 return (unsigned long)entry
;
1334 int __kprobes
register_jprobes(struct jprobe
**jps
, int num
)
1341 for (i
= 0; i
< num
; i
++) {
1344 addr
= arch_deref_entry_point(jp
->entry
);
1346 if (!kernel_text_address(addr
))
1349 /* Todo: Verify probepoint is a function entry point */
1350 jp
->kp
.pre_handler
= setjmp_pre_handler
;
1351 jp
->kp
.break_handler
= longjmp_break_handler
;
1352 ret
= register_kprobe(&jp
->kp
);
1356 unregister_jprobes(jps
, i
);
1362 EXPORT_SYMBOL_GPL(register_jprobes
);
1364 int __kprobes
register_jprobe(struct jprobe
*jp
)
1366 return register_jprobes(&jp
, 1);
1368 EXPORT_SYMBOL_GPL(register_jprobe
);
1370 void __kprobes
unregister_jprobe(struct jprobe
*jp
)
1372 unregister_jprobes(&jp
, 1);
1374 EXPORT_SYMBOL_GPL(unregister_jprobe
);
1376 void __kprobes
unregister_jprobes(struct jprobe
**jps
, int num
)
1382 mutex_lock(&kprobe_mutex
);
1383 for (i
= 0; i
< num
; i
++)
1384 if (__unregister_kprobe_top(&jps
[i
]->kp
) < 0)
1385 jps
[i
]->kp
.addr
= NULL
;
1386 mutex_unlock(&kprobe_mutex
);
1388 synchronize_sched();
1389 for (i
= 0; i
< num
; i
++) {
1390 if (jps
[i
]->kp
.addr
)
1391 __unregister_kprobe_bottom(&jps
[i
]->kp
);
1394 EXPORT_SYMBOL_GPL(unregister_jprobes
);
1396 #ifdef CONFIG_KRETPROBES
1398 * This kprobe pre_handler is registered with every kretprobe. When probe
1399 * hits it will set up the return probe.
1401 static int __kprobes
pre_handler_kretprobe(struct kprobe
*p
,
1402 struct pt_regs
*regs
)
1404 struct kretprobe
*rp
= container_of(p
, struct kretprobe
, kp
);
1405 unsigned long hash
, flags
= 0;
1406 struct kretprobe_instance
*ri
;
1408 /*TODO: consider to only swap the RA after the last pre_handler fired */
1409 hash
= hash_ptr(current
, KPROBE_HASH_BITS
);
1410 spin_lock_irqsave(&rp
->lock
, flags
);
1411 if (!hlist_empty(&rp
->free_instances
)) {
1412 ri
= hlist_entry(rp
->free_instances
.first
,
1413 struct kretprobe_instance
, hlist
);
1414 hlist_del(&ri
->hlist
);
1415 spin_unlock_irqrestore(&rp
->lock
, flags
);
1420 if (rp
->entry_handler
&& rp
->entry_handler(ri
, regs
))
1423 arch_prepare_kretprobe(ri
, regs
);
1425 /* XXX(hch): why is there no hlist_move_head? */
1426 INIT_HLIST_NODE(&ri
->hlist
);
1427 kretprobe_table_lock(hash
, &flags
);
1428 hlist_add_head(&ri
->hlist
, &kretprobe_inst_table
[hash
]);
1429 kretprobe_table_unlock(hash
, &flags
);
1432 spin_unlock_irqrestore(&rp
->lock
, flags
);
1437 int __kprobes
register_kretprobe(struct kretprobe
*rp
)
1440 struct kretprobe_instance
*inst
;
1444 if (kretprobe_blacklist_size
) {
1445 addr
= kprobe_addr(&rp
->kp
);
1449 for (i
= 0; kretprobe_blacklist
[i
].name
!= NULL
; i
++) {
1450 if (kretprobe_blacklist
[i
].addr
== addr
)
1455 rp
->kp
.pre_handler
= pre_handler_kretprobe
;
1456 rp
->kp
.post_handler
= NULL
;
1457 rp
->kp
.fault_handler
= NULL
;
1458 rp
->kp
.break_handler
= NULL
;
1460 /* Pre-allocate memory for max kretprobe instances */
1461 if (rp
->maxactive
<= 0) {
1462 #ifdef CONFIG_PREEMPT
1463 rp
->maxactive
= max_t(unsigned int, 10, 2*num_possible_cpus());
1465 rp
->maxactive
= num_possible_cpus();
1468 spin_lock_init(&rp
->lock
);
1469 INIT_HLIST_HEAD(&rp
->free_instances
);
1470 for (i
= 0; i
< rp
->maxactive
; i
++) {
1471 inst
= kmalloc(sizeof(struct kretprobe_instance
) +
1472 rp
->data_size
, GFP_KERNEL
);
1477 INIT_HLIST_NODE(&inst
->hlist
);
1478 hlist_add_head(&inst
->hlist
, &rp
->free_instances
);
1482 /* Establish function entry probe point */
1483 ret
= register_kprobe(&rp
->kp
);
1488 EXPORT_SYMBOL_GPL(register_kretprobe
);
1490 int __kprobes
register_kretprobes(struct kretprobe
**rps
, int num
)
1496 for (i
= 0; i
< num
; i
++) {
1497 ret
= register_kretprobe(rps
[i
]);
1500 unregister_kretprobes(rps
, i
);
1506 EXPORT_SYMBOL_GPL(register_kretprobes
);
1508 void __kprobes
unregister_kretprobe(struct kretprobe
*rp
)
1510 unregister_kretprobes(&rp
, 1);
1512 EXPORT_SYMBOL_GPL(unregister_kretprobe
);
1514 void __kprobes
unregister_kretprobes(struct kretprobe
**rps
, int num
)
1520 mutex_lock(&kprobe_mutex
);
1521 for (i
= 0; i
< num
; i
++)
1522 if (__unregister_kprobe_top(&rps
[i
]->kp
) < 0)
1523 rps
[i
]->kp
.addr
= NULL
;
1524 mutex_unlock(&kprobe_mutex
);
1526 synchronize_sched();
1527 for (i
= 0; i
< num
; i
++) {
1528 if (rps
[i
]->kp
.addr
) {
1529 __unregister_kprobe_bottom(&rps
[i
]->kp
);
1530 cleanup_rp_inst(rps
[i
]);
1534 EXPORT_SYMBOL_GPL(unregister_kretprobes
);
1536 #else /* CONFIG_KRETPROBES */
1537 int __kprobes
register_kretprobe(struct kretprobe
*rp
)
1541 EXPORT_SYMBOL_GPL(register_kretprobe
);
1543 int __kprobes
register_kretprobes(struct kretprobe
**rps
, int num
)
1547 EXPORT_SYMBOL_GPL(register_kretprobes
);
1549 void __kprobes
unregister_kretprobe(struct kretprobe
*rp
)
1552 EXPORT_SYMBOL_GPL(unregister_kretprobe
);
1554 void __kprobes
unregister_kretprobes(struct kretprobe
**rps
, int num
)
1557 EXPORT_SYMBOL_GPL(unregister_kretprobes
);
1559 static int __kprobes
pre_handler_kretprobe(struct kprobe
*p
,
1560 struct pt_regs
*regs
)
1565 #endif /* CONFIG_KRETPROBES */
1567 /* Set the kprobe gone and remove its instruction buffer. */
1568 static void __kprobes
kill_kprobe(struct kprobe
*p
)
1572 p
->flags
|= KPROBE_FLAG_GONE
;
1573 if (kprobe_aggrprobe(p
)) {
1575 * If this is an aggr_kprobe, we have to list all the
1576 * chained probes and mark them GONE.
1578 list_for_each_entry_rcu(kp
, &p
->list
, list
)
1579 kp
->flags
|= KPROBE_FLAG_GONE
;
1580 p
->post_handler
= NULL
;
1581 p
->break_handler
= NULL
;
1582 kill_optimized_kprobe(p
);
1585 * Here, we can remove insn_slot safely, because no thread calls
1586 * the original probed function (which will be freed soon) any more.
1588 arch_remove_kprobe(p
);
1591 void __kprobes
dump_kprobe(struct kprobe
*kp
)
1593 printk(KERN_WARNING
"Dumping kprobe:\n");
1594 printk(KERN_WARNING
"Name: %s\nAddress: %p\nOffset: %x\n",
1595 kp
->symbol_name
, kp
->addr
, kp
->offset
);
1598 /* Module notifier call back, checking kprobes on the module */
1599 static int __kprobes
kprobes_module_callback(struct notifier_block
*nb
,
1600 unsigned long val
, void *data
)
1602 struct module
*mod
= data
;
1603 struct hlist_head
*head
;
1604 struct hlist_node
*node
;
1607 int checkcore
= (val
== MODULE_STATE_GOING
);
1609 if (val
!= MODULE_STATE_GOING
&& val
!= MODULE_STATE_LIVE
)
1613 * When MODULE_STATE_GOING was notified, both of module .text and
1614 * .init.text sections would be freed. When MODULE_STATE_LIVE was
1615 * notified, only .init.text section would be freed. We need to
1616 * disable kprobes which have been inserted in the sections.
1618 mutex_lock(&kprobe_mutex
);
1619 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
1620 head
= &kprobe_table
[i
];
1621 hlist_for_each_entry_rcu(p
, node
, head
, hlist
)
1622 if (within_module_init((unsigned long)p
->addr
, mod
) ||
1624 within_module_core((unsigned long)p
->addr
, mod
))) {
1626 * The vaddr this probe is installed will soon
1627 * be vfreed buy not synced to disk. Hence,
1628 * disarming the breakpoint isn't needed.
1633 mutex_unlock(&kprobe_mutex
);
1637 static struct notifier_block kprobe_module_nb
= {
1638 .notifier_call
= kprobes_module_callback
,
1642 static int __init
init_kprobes(void)
1645 unsigned long offset
= 0, size
= 0;
1646 char *modname
, namebuf
[128];
1647 const char *symbol_name
;
1649 struct kprobe_blackpoint
*kb
;
1651 /* FIXME allocate the probe table, currently defined statically */
1652 /* initialize all list heads */
1653 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
1654 INIT_HLIST_HEAD(&kprobe_table
[i
]);
1655 INIT_HLIST_HEAD(&kretprobe_inst_table
[i
]);
1656 spin_lock_init(&(kretprobe_table_locks
[i
].lock
));
1660 * Lookup and populate the kprobe_blacklist.
1662 * Unlike the kretprobe blacklist, we'll need to determine
1663 * the range of addresses that belong to the said functions,
1664 * since a kprobe need not necessarily be at the beginning
1667 for (kb
= kprobe_blacklist
; kb
->name
!= NULL
; kb
++) {
1668 kprobe_lookup_name(kb
->name
, addr
);
1672 kb
->start_addr
= (unsigned long)addr
;
1673 symbol_name
= kallsyms_lookup(kb
->start_addr
,
1674 &size
, &offset
, &modname
, namebuf
);
1681 if (kretprobe_blacklist_size
) {
1682 /* lookup the function address from its name */
1683 for (i
= 0; kretprobe_blacklist
[i
].name
!= NULL
; i
++) {
1684 kprobe_lookup_name(kretprobe_blacklist
[i
].name
,
1685 kretprobe_blacklist
[i
].addr
);
1686 if (!kretprobe_blacklist
[i
].addr
)
1687 printk("kretprobe: lookup failed: %s\n",
1688 kretprobe_blacklist
[i
].name
);
1692 #if defined(CONFIG_OPTPROBES)
1693 #if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
1694 /* Init kprobe_optinsn_slots */
1695 kprobe_optinsn_slots
.insn_size
= MAX_OPTINSN_SIZE
;
1697 /* By default, kprobes can be optimized */
1698 kprobes_allow_optimization
= true;
1701 /* By default, kprobes are armed */
1702 kprobes_all_disarmed
= false;
1704 err
= arch_init_kprobes();
1706 err
= register_die_notifier(&kprobe_exceptions_nb
);
1708 err
= register_module_notifier(&kprobe_module_nb
);
1710 kprobes_initialized
= (err
== 0);
1717 #ifdef CONFIG_DEBUG_FS
1718 static void __kprobes
report_probe(struct seq_file
*pi
, struct kprobe
*p
,
1719 const char *sym
, int offset
, char *modname
, struct kprobe
*pp
)
1723 if (p
->pre_handler
== pre_handler_kretprobe
)
1725 else if (p
->pre_handler
== setjmp_pre_handler
)
1731 seq_printf(pi
, "%p %s %s+0x%x %s ",
1732 p
->addr
, kprobe_type
, sym
, offset
,
1733 (modname
? modname
: " "));
1735 seq_printf(pi
, "%p %s %p ",
1736 p
->addr
, kprobe_type
, p
->addr
);
1740 seq_printf(pi
, "%s%s%s\n",
1741 (kprobe_gone(p
) ? "[GONE]" : ""),
1742 ((kprobe_disabled(p
) && !kprobe_gone(p
)) ? "[DISABLED]" : ""),
1743 (kprobe_optimized(pp
) ? "[OPTIMIZED]" : ""));
1746 static void __kprobes
*kprobe_seq_start(struct seq_file
*f
, loff_t
*pos
)
1748 return (*pos
< KPROBE_TABLE_SIZE
) ? pos
: NULL
;
1751 static void __kprobes
*kprobe_seq_next(struct seq_file
*f
, void *v
, loff_t
*pos
)
1754 if (*pos
>= KPROBE_TABLE_SIZE
)
1759 static void __kprobes
kprobe_seq_stop(struct seq_file
*f
, void *v
)
1764 static int __kprobes
show_kprobe_addr(struct seq_file
*pi
, void *v
)
1766 struct hlist_head
*head
;
1767 struct hlist_node
*node
;
1768 struct kprobe
*p
, *kp
;
1769 const char *sym
= NULL
;
1770 unsigned int i
= *(loff_t
*) v
;
1771 unsigned long offset
= 0;
1772 char *modname
, namebuf
[128];
1774 head
= &kprobe_table
[i
];
1776 hlist_for_each_entry_rcu(p
, node
, head
, hlist
) {
1777 sym
= kallsyms_lookup((unsigned long)p
->addr
, NULL
,
1778 &offset
, &modname
, namebuf
);
1779 if (kprobe_aggrprobe(p
)) {
1780 list_for_each_entry_rcu(kp
, &p
->list
, list
)
1781 report_probe(pi
, kp
, sym
, offset
, modname
, p
);
1783 report_probe(pi
, p
, sym
, offset
, modname
, NULL
);
1789 static const struct seq_operations kprobes_seq_ops
= {
1790 .start
= kprobe_seq_start
,
1791 .next
= kprobe_seq_next
,
1792 .stop
= kprobe_seq_stop
,
1793 .show
= show_kprobe_addr
1796 static int __kprobes
kprobes_open(struct inode
*inode
, struct file
*filp
)
1798 return seq_open(filp
, &kprobes_seq_ops
);
1801 static const struct file_operations debugfs_kprobes_operations
= {
1802 .open
= kprobes_open
,
1804 .llseek
= seq_lseek
,
1805 .release
= seq_release
,
1808 /* Disable one kprobe */
1809 int __kprobes
disable_kprobe(struct kprobe
*kp
)
1814 mutex_lock(&kprobe_mutex
);
1816 /* Check whether specified probe is valid. */
1817 p
= __get_valid_kprobe(kp
);
1818 if (unlikely(p
== NULL
)) {
1823 /* If the probe is already disabled (or gone), just return */
1824 if (kprobe_disabled(kp
))
1827 kp
->flags
|= KPROBE_FLAG_DISABLED
;
1829 /* When kp != p, p is always enabled. */
1830 try_to_disable_aggr_kprobe(p
);
1832 if (!kprobes_all_disarmed
&& kprobe_disabled(p
))
1835 mutex_unlock(&kprobe_mutex
);
1838 EXPORT_SYMBOL_GPL(disable_kprobe
);
1840 /* Enable one kprobe */
1841 int __kprobes
enable_kprobe(struct kprobe
*kp
)
1846 mutex_lock(&kprobe_mutex
);
1848 /* Check whether specified probe is valid. */
1849 p
= __get_valid_kprobe(kp
);
1850 if (unlikely(p
== NULL
)) {
1855 if (kprobe_gone(kp
)) {
1856 /* This kprobe has gone, we couldn't enable it. */
1862 kp
->flags
&= ~KPROBE_FLAG_DISABLED
;
1864 if (!kprobes_all_disarmed
&& kprobe_disabled(p
)) {
1865 p
->flags
&= ~KPROBE_FLAG_DISABLED
;
1869 mutex_unlock(&kprobe_mutex
);
1872 EXPORT_SYMBOL_GPL(enable_kprobe
);
1874 static void __kprobes
arm_all_kprobes(void)
1876 struct hlist_head
*head
;
1877 struct hlist_node
*node
;
1881 mutex_lock(&kprobe_mutex
);
1883 /* If kprobes are armed, just return */
1884 if (!kprobes_all_disarmed
)
1885 goto already_enabled
;
1887 /* Arming kprobes doesn't optimize kprobe itself */
1888 mutex_lock(&text_mutex
);
1889 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
1890 head
= &kprobe_table
[i
];
1891 hlist_for_each_entry_rcu(p
, node
, head
, hlist
)
1892 if (!kprobe_disabled(p
))
1895 mutex_unlock(&text_mutex
);
1897 kprobes_all_disarmed
= false;
1898 printk(KERN_INFO
"Kprobes globally enabled\n");
1901 mutex_unlock(&kprobe_mutex
);
1905 static void __kprobes
disarm_all_kprobes(void)
1907 struct hlist_head
*head
;
1908 struct hlist_node
*node
;
1912 mutex_lock(&kprobe_mutex
);
1914 /* If kprobes are already disarmed, just return */
1915 if (kprobes_all_disarmed
)
1916 goto already_disabled
;
1918 kprobes_all_disarmed
= true;
1919 printk(KERN_INFO
"Kprobes globally disabled\n");
1922 * Here we call get_online_cpus() for avoiding text_mutex deadlock,
1923 * because disarming may also unoptimize kprobes.
1926 mutex_lock(&text_mutex
);
1927 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
1928 head
= &kprobe_table
[i
];
1929 hlist_for_each_entry_rcu(p
, node
, head
, hlist
) {
1930 if (!arch_trampoline_kprobe(p
) && !kprobe_disabled(p
))
1935 mutex_unlock(&text_mutex
);
1937 mutex_unlock(&kprobe_mutex
);
1938 /* Allow all currently running kprobes to complete */
1939 synchronize_sched();
1943 mutex_unlock(&kprobe_mutex
);
1948 * XXX: The debugfs bool file interface doesn't allow for callbacks
1949 * when the bool state is switched. We can reuse that facility when
1952 static ssize_t
read_enabled_file_bool(struct file
*file
,
1953 char __user
*user_buf
, size_t count
, loff_t
*ppos
)
1957 if (!kprobes_all_disarmed
)
1963 return simple_read_from_buffer(user_buf
, count
, ppos
, buf
, 2);
1966 static ssize_t
write_enabled_file_bool(struct file
*file
,
1967 const char __user
*user_buf
, size_t count
, loff_t
*ppos
)
1972 buf_size
= min(count
, (sizeof(buf
)-1));
1973 if (copy_from_user(buf
, user_buf
, buf_size
))
1985 disarm_all_kprobes();
1992 static const struct file_operations fops_kp
= {
1993 .read
= read_enabled_file_bool
,
1994 .write
= write_enabled_file_bool
,
1997 static int __kprobes
debugfs_kprobe_init(void)
1999 struct dentry
*dir
, *file
;
2000 unsigned int value
= 1;
2002 dir
= debugfs_create_dir("kprobes", NULL
);
2006 file
= debugfs_create_file("list", 0444, dir
, NULL
,
2007 &debugfs_kprobes_operations
);
2009 debugfs_remove(dir
);
2013 file
= debugfs_create_file("enabled", 0600, dir
,
2016 debugfs_remove(dir
);
2023 late_initcall(debugfs_kprobe_init
);
2024 #endif /* CONFIG_DEBUG_FS */
2026 module_init(init_kprobes
);
2028 /* defined in arch/.../kernel/kprobes.c */
2029 EXPORT_SYMBOL_GPL(jprobe_return
);