2 * Kernel Probes (KProbes)
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 * Copyright (C) IBM Corporation, 2002, 2004
21 * 2002-Oct Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
22 * Probes initial implementation (includes suggestions from
24 * 2004-Aug Updated by Prasanna S Panchamukhi <prasanna@in.ibm.com> with
25 * hlists and exceptions notifier as suggested by Andi Kleen.
26 * 2004-July Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
27 * interface to access function arguments.
28 * 2004-Sep Prasanna S Panchamukhi <prasanna@in.ibm.com> Changed Kprobes
29 * exceptions notifier to be first on the priority list.
30 * 2005-May Hien Nguyen <hien@us.ibm.com>, Jim Keniston
31 * <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
32 * <prasanna@in.ibm.com> added function-return probes.
34 #include <linux/kprobes.h>
35 #include <linux/hash.h>
36 #include <linux/init.h>
37 #include <linux/slab.h>
38 #include <linux/stddef.h>
39 #include <linux/export.h>
40 #include <linux/moduleloader.h>
41 #include <linux/kallsyms.h>
42 #include <linux/freezer.h>
43 #include <linux/seq_file.h>
44 #include <linux/debugfs.h>
45 #include <linux/sysctl.h>
46 #include <linux/kdebug.h>
47 #include <linux/memory.h>
48 #include <linux/ftrace.h>
49 #include <linux/cpu.h>
50 #include <linux/jump_label.h>
52 #include <asm/sections.h>
53 #include <asm/cacheflush.h>
54 #include <asm/errno.h>
55 #include <linux/uaccess.h>
57 #define KPROBE_HASH_BITS 6
58 #define KPROBE_TABLE_SIZE (1 << KPROBE_HASH_BITS)
61 static int kprobes_initialized
;
62 static struct hlist_head kprobe_table
[KPROBE_TABLE_SIZE
];
63 static struct hlist_head kretprobe_inst_table
[KPROBE_TABLE_SIZE
];
65 /* NOTE: change this value only with kprobe_mutex held */
66 static bool kprobes_all_disarmed
;
68 /* This protects kprobe_table and optimizing_list */
69 static DEFINE_MUTEX(kprobe_mutex
);
70 static DEFINE_PER_CPU(struct kprobe
*, kprobe_instance
) = NULL
;
72 raw_spinlock_t lock ____cacheline_aligned_in_smp
;
73 } kretprobe_table_locks
[KPROBE_TABLE_SIZE
];
75 kprobe_opcode_t
* __weak
kprobe_lookup_name(const char *name
,
76 unsigned int __unused
)
78 return ((kprobe_opcode_t
*)(kallsyms_lookup_name(name
)));
81 static raw_spinlock_t
*kretprobe_table_lock_ptr(unsigned long hash
)
83 return &(kretprobe_table_locks
[hash
].lock
);
86 /* Blacklist -- list of struct kprobe_blacklist_entry */
87 static LIST_HEAD(kprobe_blacklist
);
89 #ifdef __ARCH_WANT_KPROBES_INSN_SLOT
91 * kprobe->ainsn.insn points to the copy of the instruction to be
92 * single-stepped. x86_64, POWER4 and above have no-exec support and
93 * stepping on the instruction on a vmalloced/kmalloced/data page
94 * is a recipe for disaster
96 struct kprobe_insn_page
{
97 struct list_head list
;
98 kprobe_opcode_t
*insns
; /* Page of instruction slots */
99 struct kprobe_insn_cache
*cache
;
105 #define KPROBE_INSN_PAGE_SIZE(slots) \
106 (offsetof(struct kprobe_insn_page, slot_used) + \
107 (sizeof(char) * (slots)))
109 static int slots_per_page(struct kprobe_insn_cache
*c
)
111 return PAGE_SIZE
/(c
->insn_size
* sizeof(kprobe_opcode_t
));
114 enum kprobe_slot_state
{
120 static void *alloc_insn_page(void)
122 return module_alloc(PAGE_SIZE
);
125 void __weak
free_insn_page(void *page
)
127 module_memfree(page
);
130 struct kprobe_insn_cache kprobe_insn_slots
= {
131 .mutex
= __MUTEX_INITIALIZER(kprobe_insn_slots
.mutex
),
132 .alloc
= alloc_insn_page
,
133 .free
= free_insn_page
,
134 .pages
= LIST_HEAD_INIT(kprobe_insn_slots
.pages
),
135 .insn_size
= MAX_INSN_SIZE
,
138 static int collect_garbage_slots(struct kprobe_insn_cache
*c
);
141 * __get_insn_slot() - Find a slot on an executable page for an instruction.
142 * We allocate an executable page if there's no room on existing ones.
144 kprobe_opcode_t
*__get_insn_slot(struct kprobe_insn_cache
*c
)
146 struct kprobe_insn_page
*kip
;
147 kprobe_opcode_t
*slot
= NULL
;
149 /* Since the slot array is not protected by rcu, we need a mutex */
150 mutex_lock(&c
->mutex
);
153 list_for_each_entry_rcu(kip
, &c
->pages
, list
) {
154 if (kip
->nused
< slots_per_page(c
)) {
156 for (i
= 0; i
< slots_per_page(c
); i
++) {
157 if (kip
->slot_used
[i
] == SLOT_CLEAN
) {
158 kip
->slot_used
[i
] = SLOT_USED
;
160 slot
= kip
->insns
+ (i
* c
->insn_size
);
165 /* kip->nused is broken. Fix it. */
166 kip
->nused
= slots_per_page(c
);
172 /* If there are any garbage slots, collect it and try again. */
173 if (c
->nr_garbage
&& collect_garbage_slots(c
) == 0)
176 /* All out of space. Need to allocate a new page. */
177 kip
= kmalloc(KPROBE_INSN_PAGE_SIZE(slots_per_page(c
)), GFP_KERNEL
);
182 * Use module_alloc so this page is within +/- 2GB of where the
183 * kernel image and loaded module images reside. This is required
184 * so x86_64 can correctly handle the %rip-relative fixups.
186 kip
->insns
= c
->alloc();
191 INIT_LIST_HEAD(&kip
->list
);
192 memset(kip
->slot_used
, SLOT_CLEAN
, slots_per_page(c
));
193 kip
->slot_used
[0] = SLOT_USED
;
197 list_add_rcu(&kip
->list
, &c
->pages
);
200 mutex_unlock(&c
->mutex
);
204 /* Return 1 if all garbages are collected, otherwise 0. */
205 static int collect_one_slot(struct kprobe_insn_page
*kip
, int idx
)
207 kip
->slot_used
[idx
] = SLOT_CLEAN
;
209 if (kip
->nused
== 0) {
211 * Page is no longer in use. Free it unless
212 * it's the last one. We keep the last one
213 * so as not to have to set it up again the
214 * next time somebody inserts a probe.
216 if (!list_is_singular(&kip
->list
)) {
217 list_del_rcu(&kip
->list
);
219 kip
->cache
->free(kip
->insns
);
227 static int collect_garbage_slots(struct kprobe_insn_cache
*c
)
229 struct kprobe_insn_page
*kip
, *next
;
231 /* Ensure no-one is interrupted on the garbages */
234 list_for_each_entry_safe(kip
, next
, &c
->pages
, list
) {
236 if (kip
->ngarbage
== 0)
238 kip
->ngarbage
= 0; /* we will collect all garbages */
239 for (i
= 0; i
< slots_per_page(c
); i
++) {
240 if (kip
->slot_used
[i
] == SLOT_DIRTY
&& collect_one_slot(kip
, i
))
248 void __free_insn_slot(struct kprobe_insn_cache
*c
,
249 kprobe_opcode_t
*slot
, int dirty
)
251 struct kprobe_insn_page
*kip
;
254 mutex_lock(&c
->mutex
);
256 list_for_each_entry_rcu(kip
, &c
->pages
, list
) {
257 idx
= ((long)slot
- (long)kip
->insns
) /
258 (c
->insn_size
* sizeof(kprobe_opcode_t
));
259 if (idx
>= 0 && idx
< slots_per_page(c
))
262 /* Could not find this slot. */
267 /* Mark and sweep: this may sleep */
269 /* Check double free */
270 WARN_ON(kip
->slot_used
[idx
] != SLOT_USED
);
272 kip
->slot_used
[idx
] = SLOT_DIRTY
;
274 if (++c
->nr_garbage
> slots_per_page(c
))
275 collect_garbage_slots(c
);
277 collect_one_slot(kip
, idx
);
280 mutex_unlock(&c
->mutex
);
284 * Check given address is on the page of kprobe instruction slots.
285 * This will be used for checking whether the address on a stack
286 * is on a text area or not.
288 bool __is_insn_slot_addr(struct kprobe_insn_cache
*c
, unsigned long addr
)
290 struct kprobe_insn_page
*kip
;
294 list_for_each_entry_rcu(kip
, &c
->pages
, list
) {
295 if (addr
>= (unsigned long)kip
->insns
&&
296 addr
< (unsigned long)kip
->insns
+ PAGE_SIZE
) {
306 #ifdef CONFIG_OPTPROBES
307 /* For optimized_kprobe buffer */
308 struct kprobe_insn_cache kprobe_optinsn_slots
= {
309 .mutex
= __MUTEX_INITIALIZER(kprobe_optinsn_slots
.mutex
),
310 .alloc
= alloc_insn_page
,
311 .free
= free_insn_page
,
312 .pages
= LIST_HEAD_INIT(kprobe_optinsn_slots
.pages
),
313 /* .insn_size is initialized later */
319 /* We have preemption disabled.. so it is safe to use __ versions */
320 static inline void set_kprobe_instance(struct kprobe
*kp
)
322 __this_cpu_write(kprobe_instance
, kp
);
325 static inline void reset_kprobe_instance(void)
327 __this_cpu_write(kprobe_instance
, NULL
);
331 * This routine is called either:
332 * - under the kprobe_mutex - during kprobe_[un]register()
334 * - with preemption disabled - from arch/xxx/kernel/kprobes.c
336 struct kprobe
*get_kprobe(void *addr
)
338 struct hlist_head
*head
;
341 head
= &kprobe_table
[hash_ptr(addr
, KPROBE_HASH_BITS
)];
342 hlist_for_each_entry_rcu(p
, head
, hlist
) {
349 NOKPROBE_SYMBOL(get_kprobe
);
351 static int aggr_pre_handler(struct kprobe
*p
, struct pt_regs
*regs
);
353 /* Return true if the kprobe is an aggregator */
354 static inline int kprobe_aggrprobe(struct kprobe
*p
)
356 return p
->pre_handler
== aggr_pre_handler
;
359 /* Return true(!0) if the kprobe is unused */
360 static inline int kprobe_unused(struct kprobe
*p
)
362 return kprobe_aggrprobe(p
) && kprobe_disabled(p
) &&
363 list_empty(&p
->list
);
367 * Keep all fields in the kprobe consistent
369 static inline void copy_kprobe(struct kprobe
*ap
, struct kprobe
*p
)
371 memcpy(&p
->opcode
, &ap
->opcode
, sizeof(kprobe_opcode_t
));
372 memcpy(&p
->ainsn
, &ap
->ainsn
, sizeof(struct arch_specific_insn
));
375 #ifdef CONFIG_OPTPROBES
376 /* NOTE: change this value only with kprobe_mutex held */
377 static bool kprobes_allow_optimization
;
380 * Call all pre_handler on the list, but ignores its return value.
381 * This must be called from arch-dep optimized caller.
383 void opt_pre_handler(struct kprobe
*p
, struct pt_regs
*regs
)
387 list_for_each_entry_rcu(kp
, &p
->list
, list
) {
388 if (kp
->pre_handler
&& likely(!kprobe_disabled(kp
))) {
389 set_kprobe_instance(kp
);
390 kp
->pre_handler(kp
, regs
);
392 reset_kprobe_instance();
395 NOKPROBE_SYMBOL(opt_pre_handler
);
397 /* Free optimized instructions and optimized_kprobe */
398 static void free_aggr_kprobe(struct kprobe
*p
)
400 struct optimized_kprobe
*op
;
402 op
= container_of(p
, struct optimized_kprobe
, kp
);
403 arch_remove_optimized_kprobe(op
);
404 arch_remove_kprobe(p
);
408 /* Return true(!0) if the kprobe is ready for optimization. */
409 static inline int kprobe_optready(struct kprobe
*p
)
411 struct optimized_kprobe
*op
;
413 if (kprobe_aggrprobe(p
)) {
414 op
= container_of(p
, struct optimized_kprobe
, kp
);
415 return arch_prepared_optinsn(&op
->optinsn
);
421 /* Return true(!0) if the kprobe is disarmed. Note: p must be on hash list */
422 static inline int kprobe_disarmed(struct kprobe
*p
)
424 struct optimized_kprobe
*op
;
426 /* If kprobe is not aggr/opt probe, just return kprobe is disabled */
427 if (!kprobe_aggrprobe(p
))
428 return kprobe_disabled(p
);
430 op
= container_of(p
, struct optimized_kprobe
, kp
);
432 return kprobe_disabled(p
) && list_empty(&op
->list
);
435 /* Return true(!0) if the probe is queued on (un)optimizing lists */
436 static int kprobe_queued(struct kprobe
*p
)
438 struct optimized_kprobe
*op
;
440 if (kprobe_aggrprobe(p
)) {
441 op
= container_of(p
, struct optimized_kprobe
, kp
);
442 if (!list_empty(&op
->list
))
449 * Return an optimized kprobe whose optimizing code replaces
450 * instructions including addr (exclude breakpoint).
452 static struct kprobe
*get_optimized_kprobe(unsigned long addr
)
455 struct kprobe
*p
= NULL
;
456 struct optimized_kprobe
*op
;
458 /* Don't check i == 0, since that is a breakpoint case. */
459 for (i
= 1; !p
&& i
< MAX_OPTIMIZED_LENGTH
; i
++)
460 p
= get_kprobe((void *)(addr
- i
));
462 if (p
&& kprobe_optready(p
)) {
463 op
= container_of(p
, struct optimized_kprobe
, kp
);
464 if (arch_within_optimized_kprobe(op
, addr
))
471 /* Optimization staging list, protected by kprobe_mutex */
472 static LIST_HEAD(optimizing_list
);
473 static LIST_HEAD(unoptimizing_list
);
474 static LIST_HEAD(freeing_list
);
476 static void kprobe_optimizer(struct work_struct
*work
);
477 static DECLARE_DELAYED_WORK(optimizing_work
, kprobe_optimizer
);
478 #define OPTIMIZE_DELAY 5
481 * Optimize (replace a breakpoint with a jump) kprobes listed on
484 static void do_optimize_kprobes(void)
487 * The optimization/unoptimization refers online_cpus via
488 * stop_machine() and cpu-hotplug modifies online_cpus.
489 * And same time, text_mutex will be held in cpu-hotplug and here.
490 * This combination can cause a deadlock (cpu-hotplug try to lock
491 * text_mutex but stop_machine can not be done because online_cpus
493 * To avoid this deadlock, caller must have locked cpu hotplug
494 * for preventing cpu-hotplug outside of text_mutex locking.
496 lockdep_assert_cpus_held();
498 /* Optimization never be done when disarmed */
499 if (kprobes_all_disarmed
|| !kprobes_allow_optimization
||
500 list_empty(&optimizing_list
))
503 mutex_lock(&text_mutex
);
504 arch_optimize_kprobes(&optimizing_list
);
505 mutex_unlock(&text_mutex
);
509 * Unoptimize (replace a jump with a breakpoint and remove the breakpoint
510 * if need) kprobes listed on unoptimizing_list.
512 static void do_unoptimize_kprobes(void)
514 struct optimized_kprobe
*op
, *tmp
;
516 /* See comment in do_optimize_kprobes() */
517 lockdep_assert_cpus_held();
519 /* Unoptimization must be done anytime */
520 if (list_empty(&unoptimizing_list
))
523 mutex_lock(&text_mutex
);
524 arch_unoptimize_kprobes(&unoptimizing_list
, &freeing_list
);
525 /* Loop free_list for disarming */
526 list_for_each_entry_safe(op
, tmp
, &freeing_list
, list
) {
527 /* Disarm probes if marked disabled */
528 if (kprobe_disabled(&op
->kp
))
529 arch_disarm_kprobe(&op
->kp
);
530 if (kprobe_unused(&op
->kp
)) {
532 * Remove unused probes from hash list. After waiting
533 * for synchronization, these probes are reclaimed.
534 * (reclaiming is done by do_free_cleaned_kprobes.)
536 hlist_del_rcu(&op
->kp
.hlist
);
538 list_del_init(&op
->list
);
540 mutex_unlock(&text_mutex
);
543 /* Reclaim all kprobes on the free_list */
544 static void do_free_cleaned_kprobes(void)
546 struct optimized_kprobe
*op
, *tmp
;
548 list_for_each_entry_safe(op
, tmp
, &freeing_list
, list
) {
549 BUG_ON(!kprobe_unused(&op
->kp
));
550 list_del_init(&op
->list
);
551 free_aggr_kprobe(&op
->kp
);
555 /* Start optimizer after OPTIMIZE_DELAY passed */
556 static void kick_kprobe_optimizer(void)
558 schedule_delayed_work(&optimizing_work
, OPTIMIZE_DELAY
);
561 /* Kprobe jump optimizer */
562 static void kprobe_optimizer(struct work_struct
*work
)
564 mutex_lock(&kprobe_mutex
);
566 /* Lock modules while optimizing kprobes */
567 mutex_lock(&module_mutex
);
570 * Step 1: Unoptimize kprobes and collect cleaned (unused and disarmed)
571 * kprobes before waiting for quiesence period.
573 do_unoptimize_kprobes();
576 * Step 2: Wait for quiesence period to ensure all potentially
577 * preempted tasks to have normally scheduled. Because optprobe
578 * may modify multiple instructions, there is a chance that Nth
579 * instruction is preempted. In that case, such tasks can return
580 * to 2nd-Nth byte of jump instruction. This wait is for avoiding it.
581 * Note that on non-preemptive kernel, this is transparently converted
582 * to synchronoze_sched() to wait for all interrupts to have completed.
584 synchronize_rcu_tasks();
586 /* Step 3: Optimize kprobes after quiesence period */
587 do_optimize_kprobes();
589 /* Step 4: Free cleaned kprobes after quiesence period */
590 do_free_cleaned_kprobes();
592 mutex_unlock(&module_mutex
);
594 mutex_unlock(&kprobe_mutex
);
596 /* Step 5: Kick optimizer again if needed */
597 if (!list_empty(&optimizing_list
) || !list_empty(&unoptimizing_list
))
598 kick_kprobe_optimizer();
601 /* Wait for completing optimization and unoptimization */
602 void wait_for_kprobe_optimizer(void)
604 mutex_lock(&kprobe_mutex
);
606 while (!list_empty(&optimizing_list
) || !list_empty(&unoptimizing_list
)) {
607 mutex_unlock(&kprobe_mutex
);
609 /* this will also make optimizing_work execute immmediately */
610 flush_delayed_work(&optimizing_work
);
611 /* @optimizing_work might not have been queued yet, relax */
614 mutex_lock(&kprobe_mutex
);
617 mutex_unlock(&kprobe_mutex
);
620 /* Optimize kprobe if p is ready to be optimized */
621 static void optimize_kprobe(struct kprobe
*p
)
623 struct optimized_kprobe
*op
;
625 /* Check if the kprobe is disabled or not ready for optimization. */
626 if (!kprobe_optready(p
) || !kprobes_allow_optimization
||
627 (kprobe_disabled(p
) || kprobes_all_disarmed
))
630 /* Both of break_handler and post_handler are not supported. */
631 if (p
->break_handler
|| p
->post_handler
)
634 op
= container_of(p
, struct optimized_kprobe
, kp
);
636 /* Check there is no other kprobes at the optimized instructions */
637 if (arch_check_optimized_kprobe(op
) < 0)
640 /* Check if it is already optimized. */
641 if (op
->kp
.flags
& KPROBE_FLAG_OPTIMIZED
)
643 op
->kp
.flags
|= KPROBE_FLAG_OPTIMIZED
;
645 if (!list_empty(&op
->list
))
646 /* This is under unoptimizing. Just dequeue the probe */
647 list_del_init(&op
->list
);
649 list_add(&op
->list
, &optimizing_list
);
650 kick_kprobe_optimizer();
654 /* Short cut to direct unoptimizing */
655 static void force_unoptimize_kprobe(struct optimized_kprobe
*op
)
657 lockdep_assert_cpus_held();
658 arch_unoptimize_kprobe(op
);
659 if (kprobe_disabled(&op
->kp
))
660 arch_disarm_kprobe(&op
->kp
);
663 /* Unoptimize a kprobe if p is optimized */
664 static void unoptimize_kprobe(struct kprobe
*p
, bool force
)
666 struct optimized_kprobe
*op
;
668 if (!kprobe_aggrprobe(p
) || kprobe_disarmed(p
))
669 return; /* This is not an optprobe nor optimized */
671 op
= container_of(p
, struct optimized_kprobe
, kp
);
672 if (!kprobe_optimized(p
)) {
673 /* Unoptimized or unoptimizing case */
674 if (force
&& !list_empty(&op
->list
)) {
676 * Only if this is unoptimizing kprobe and forced,
677 * forcibly unoptimize it. (No need to unoptimize
678 * unoptimized kprobe again :)
680 list_del_init(&op
->list
);
681 force_unoptimize_kprobe(op
);
686 op
->kp
.flags
&= ~KPROBE_FLAG_OPTIMIZED
;
687 if (!list_empty(&op
->list
)) {
688 /* Dequeue from the optimization queue */
689 list_del_init(&op
->list
);
692 /* Optimized kprobe case */
694 /* Forcibly update the code: this is a special case */
695 force_unoptimize_kprobe(op
);
697 list_add(&op
->list
, &unoptimizing_list
);
698 kick_kprobe_optimizer();
702 /* Cancel unoptimizing for reusing */
703 static int reuse_unused_kprobe(struct kprobe
*ap
)
705 struct optimized_kprobe
*op
;
708 BUG_ON(!kprobe_unused(ap
));
710 * Unused kprobe MUST be on the way of delayed unoptimizing (means
711 * there is still a relative jump) and disabled.
713 op
= container_of(ap
, struct optimized_kprobe
, kp
);
714 if (unlikely(list_empty(&op
->list
)))
715 printk(KERN_WARNING
"Warning: found a stray unused "
716 "aggrprobe@%p\n", ap
->addr
);
717 /* Enable the probe again */
718 ap
->flags
&= ~KPROBE_FLAG_DISABLED
;
719 /* Optimize it again (remove from op->list) */
720 ret
= kprobe_optready(ap
);
728 /* Remove optimized instructions */
729 static void kill_optimized_kprobe(struct kprobe
*p
)
731 struct optimized_kprobe
*op
;
733 op
= container_of(p
, struct optimized_kprobe
, kp
);
734 if (!list_empty(&op
->list
))
735 /* Dequeue from the (un)optimization queue */
736 list_del_init(&op
->list
);
737 op
->kp
.flags
&= ~KPROBE_FLAG_OPTIMIZED
;
739 if (kprobe_unused(p
)) {
740 /* Enqueue if it is unused */
741 list_add(&op
->list
, &freeing_list
);
743 * Remove unused probes from the hash list. After waiting
744 * for synchronization, this probe is reclaimed.
745 * (reclaiming is done by do_free_cleaned_kprobes().)
747 hlist_del_rcu(&op
->kp
.hlist
);
750 /* Don't touch the code, because it is already freed. */
751 arch_remove_optimized_kprobe(op
);
755 void __prepare_optimized_kprobe(struct optimized_kprobe
*op
, struct kprobe
*p
)
757 if (!kprobe_ftrace(p
))
758 arch_prepare_optimized_kprobe(op
, p
);
761 /* Try to prepare optimized instructions */
762 static void prepare_optimized_kprobe(struct kprobe
*p
)
764 struct optimized_kprobe
*op
;
766 op
= container_of(p
, struct optimized_kprobe
, kp
);
767 __prepare_optimized_kprobe(op
, p
);
770 /* Allocate new optimized_kprobe and try to prepare optimized instructions */
771 static struct kprobe
*alloc_aggr_kprobe(struct kprobe
*p
)
773 struct optimized_kprobe
*op
;
775 op
= kzalloc(sizeof(struct optimized_kprobe
), GFP_KERNEL
);
779 INIT_LIST_HEAD(&op
->list
);
780 op
->kp
.addr
= p
->addr
;
781 __prepare_optimized_kprobe(op
, p
);
786 static void init_aggr_kprobe(struct kprobe
*ap
, struct kprobe
*p
);
789 * Prepare an optimized_kprobe and optimize it
790 * NOTE: p must be a normal registered kprobe
792 static void try_to_optimize_kprobe(struct kprobe
*p
)
795 struct optimized_kprobe
*op
;
797 /* Impossible to optimize ftrace-based kprobe */
798 if (kprobe_ftrace(p
))
801 /* For preparing optimization, jump_label_text_reserved() is called */
804 mutex_lock(&text_mutex
);
806 ap
= alloc_aggr_kprobe(p
);
810 op
= container_of(ap
, struct optimized_kprobe
, kp
);
811 if (!arch_prepared_optinsn(&op
->optinsn
)) {
812 /* If failed to setup optimizing, fallback to kprobe */
813 arch_remove_optimized_kprobe(op
);
818 init_aggr_kprobe(ap
, p
);
819 optimize_kprobe(ap
); /* This just kicks optimizer thread */
822 mutex_unlock(&text_mutex
);
828 static void optimize_all_kprobes(void)
830 struct hlist_head
*head
;
834 mutex_lock(&kprobe_mutex
);
835 /* If optimization is already allowed, just return */
836 if (kprobes_allow_optimization
)
840 kprobes_allow_optimization
= true;
841 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
842 head
= &kprobe_table
[i
];
843 hlist_for_each_entry_rcu(p
, head
, hlist
)
844 if (!kprobe_disabled(p
))
848 printk(KERN_INFO
"Kprobes globally optimized\n");
850 mutex_unlock(&kprobe_mutex
);
853 static void unoptimize_all_kprobes(void)
855 struct hlist_head
*head
;
859 mutex_lock(&kprobe_mutex
);
860 /* If optimization is already prohibited, just return */
861 if (!kprobes_allow_optimization
) {
862 mutex_unlock(&kprobe_mutex
);
867 kprobes_allow_optimization
= false;
868 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
869 head
= &kprobe_table
[i
];
870 hlist_for_each_entry_rcu(p
, head
, hlist
) {
871 if (!kprobe_disabled(p
))
872 unoptimize_kprobe(p
, false);
876 mutex_unlock(&kprobe_mutex
);
878 /* Wait for unoptimizing completion */
879 wait_for_kprobe_optimizer();
880 printk(KERN_INFO
"Kprobes globally unoptimized\n");
883 static DEFINE_MUTEX(kprobe_sysctl_mutex
);
884 int sysctl_kprobes_optimization
;
885 int proc_kprobes_optimization_handler(struct ctl_table
*table
, int write
,
886 void __user
*buffer
, size_t *length
,
891 mutex_lock(&kprobe_sysctl_mutex
);
892 sysctl_kprobes_optimization
= kprobes_allow_optimization
? 1 : 0;
893 ret
= proc_dointvec_minmax(table
, write
, buffer
, length
, ppos
);
895 if (sysctl_kprobes_optimization
)
896 optimize_all_kprobes();
898 unoptimize_all_kprobes();
899 mutex_unlock(&kprobe_sysctl_mutex
);
903 #endif /* CONFIG_SYSCTL */
905 /* Put a breakpoint for a probe. Must be called with text_mutex locked */
906 static void __arm_kprobe(struct kprobe
*p
)
910 /* Check collision with other optimized kprobes */
911 _p
= get_optimized_kprobe((unsigned long)p
->addr
);
913 /* Fallback to unoptimized kprobe */
914 unoptimize_kprobe(_p
, true);
917 optimize_kprobe(p
); /* Try to optimize (add kprobe to a list) */
920 /* Remove the breakpoint of a probe. Must be called with text_mutex locked */
921 static void __disarm_kprobe(struct kprobe
*p
, bool reopt
)
925 /* Try to unoptimize */
926 unoptimize_kprobe(p
, kprobes_all_disarmed
);
928 if (!kprobe_queued(p
)) {
929 arch_disarm_kprobe(p
);
930 /* If another kprobe was blocked, optimize it. */
931 _p
= get_optimized_kprobe((unsigned long)p
->addr
);
932 if (unlikely(_p
) && reopt
)
935 /* TODO: reoptimize others after unoptimized this probe */
938 #else /* !CONFIG_OPTPROBES */
940 #define optimize_kprobe(p) do {} while (0)
941 #define unoptimize_kprobe(p, f) do {} while (0)
942 #define kill_optimized_kprobe(p) do {} while (0)
943 #define prepare_optimized_kprobe(p) do {} while (0)
944 #define try_to_optimize_kprobe(p) do {} while (0)
945 #define __arm_kprobe(p) arch_arm_kprobe(p)
946 #define __disarm_kprobe(p, o) arch_disarm_kprobe(p)
947 #define kprobe_disarmed(p) kprobe_disabled(p)
948 #define wait_for_kprobe_optimizer() do {} while (0)
950 static int reuse_unused_kprobe(struct kprobe
*ap
)
953 * If the optimized kprobe is NOT supported, the aggr kprobe is
954 * released at the same time that the last aggregated kprobe is
956 * Thus there should be no chance to reuse unused kprobe.
958 printk(KERN_ERR
"Error: There should be no unused kprobe here.\n");
962 static void free_aggr_kprobe(struct kprobe
*p
)
964 arch_remove_kprobe(p
);
968 static struct kprobe
*alloc_aggr_kprobe(struct kprobe
*p
)
970 return kzalloc(sizeof(struct kprobe
), GFP_KERNEL
);
972 #endif /* CONFIG_OPTPROBES */
974 #ifdef CONFIG_KPROBES_ON_FTRACE
975 static struct ftrace_ops kprobe_ftrace_ops __read_mostly
= {
976 .func
= kprobe_ftrace_handler
,
977 .flags
= FTRACE_OPS_FL_SAVE_REGS
| FTRACE_OPS_FL_IPMODIFY
,
979 static int kprobe_ftrace_enabled
;
981 /* Must ensure p->addr is really on ftrace */
982 static int prepare_kprobe(struct kprobe
*p
)
984 if (!kprobe_ftrace(p
))
985 return arch_prepare_kprobe(p
);
987 return arch_prepare_kprobe_ftrace(p
);
990 /* Caller must lock kprobe_mutex */
991 static void arm_kprobe_ftrace(struct kprobe
*p
)
995 ret
= ftrace_set_filter_ip(&kprobe_ftrace_ops
,
996 (unsigned long)p
->addr
, 0, 0);
997 WARN(ret
< 0, "Failed to arm kprobe-ftrace at %p (%d)\n", p
->addr
, ret
);
998 kprobe_ftrace_enabled
++;
999 if (kprobe_ftrace_enabled
== 1) {
1000 ret
= register_ftrace_function(&kprobe_ftrace_ops
);
1001 WARN(ret
< 0, "Failed to init kprobe-ftrace (%d)\n", ret
);
1005 /* Caller must lock kprobe_mutex */
1006 static void disarm_kprobe_ftrace(struct kprobe
*p
)
1010 kprobe_ftrace_enabled
--;
1011 if (kprobe_ftrace_enabled
== 0) {
1012 ret
= unregister_ftrace_function(&kprobe_ftrace_ops
);
1013 WARN(ret
< 0, "Failed to init kprobe-ftrace (%d)\n", ret
);
1015 ret
= ftrace_set_filter_ip(&kprobe_ftrace_ops
,
1016 (unsigned long)p
->addr
, 1, 0);
1017 WARN(ret
< 0, "Failed to disarm kprobe-ftrace at %p (%d)\n", p
->addr
, ret
);
1019 #else /* !CONFIG_KPROBES_ON_FTRACE */
1020 #define prepare_kprobe(p) arch_prepare_kprobe(p)
1021 #define arm_kprobe_ftrace(p) do {} while (0)
1022 #define disarm_kprobe_ftrace(p) do {} while (0)
1025 /* Arm a kprobe with text_mutex */
1026 static void arm_kprobe(struct kprobe
*kp
)
1028 if (unlikely(kprobe_ftrace(kp
))) {
1029 arm_kprobe_ftrace(kp
);
1033 mutex_lock(&text_mutex
);
1035 mutex_unlock(&text_mutex
);
1039 /* Disarm a kprobe with text_mutex */
1040 static void disarm_kprobe(struct kprobe
*kp
, bool reopt
)
1042 if (unlikely(kprobe_ftrace(kp
))) {
1043 disarm_kprobe_ftrace(kp
);
1048 mutex_lock(&text_mutex
);
1049 __disarm_kprobe(kp
, reopt
);
1050 mutex_unlock(&text_mutex
);
1055 * Aggregate handlers for multiple kprobes support - these handlers
1056 * take care of invoking the individual kprobe handlers on p->list
1058 static int aggr_pre_handler(struct kprobe
*p
, struct pt_regs
*regs
)
1062 list_for_each_entry_rcu(kp
, &p
->list
, list
) {
1063 if (kp
->pre_handler
&& likely(!kprobe_disabled(kp
))) {
1064 set_kprobe_instance(kp
);
1065 if (kp
->pre_handler(kp
, regs
))
1068 reset_kprobe_instance();
1072 NOKPROBE_SYMBOL(aggr_pre_handler
);
1074 static void aggr_post_handler(struct kprobe
*p
, struct pt_regs
*regs
,
1075 unsigned long flags
)
1079 list_for_each_entry_rcu(kp
, &p
->list
, list
) {
1080 if (kp
->post_handler
&& likely(!kprobe_disabled(kp
))) {
1081 set_kprobe_instance(kp
);
1082 kp
->post_handler(kp
, regs
, flags
);
1083 reset_kprobe_instance();
1087 NOKPROBE_SYMBOL(aggr_post_handler
);
1089 static int aggr_fault_handler(struct kprobe
*p
, struct pt_regs
*regs
,
1092 struct kprobe
*cur
= __this_cpu_read(kprobe_instance
);
1095 * if we faulted "during" the execution of a user specified
1096 * probe handler, invoke just that probe's fault handler
1098 if (cur
&& cur
->fault_handler
) {
1099 if (cur
->fault_handler(cur
, regs
, trapnr
))
1104 NOKPROBE_SYMBOL(aggr_fault_handler
);
1106 static int aggr_break_handler(struct kprobe
*p
, struct pt_regs
*regs
)
1108 struct kprobe
*cur
= __this_cpu_read(kprobe_instance
);
1111 if (cur
&& cur
->break_handler
) {
1112 if (cur
->break_handler(cur
, regs
))
1115 reset_kprobe_instance();
1118 NOKPROBE_SYMBOL(aggr_break_handler
);
1120 /* Walks the list and increments nmissed count for multiprobe case */
1121 void kprobes_inc_nmissed_count(struct kprobe
*p
)
1124 if (!kprobe_aggrprobe(p
)) {
1127 list_for_each_entry_rcu(kp
, &p
->list
, list
)
1132 NOKPROBE_SYMBOL(kprobes_inc_nmissed_count
);
1134 void recycle_rp_inst(struct kretprobe_instance
*ri
,
1135 struct hlist_head
*head
)
1137 struct kretprobe
*rp
= ri
->rp
;
1139 /* remove rp inst off the rprobe_inst_table */
1140 hlist_del(&ri
->hlist
);
1141 INIT_HLIST_NODE(&ri
->hlist
);
1143 raw_spin_lock(&rp
->lock
);
1144 hlist_add_head(&ri
->hlist
, &rp
->free_instances
);
1145 raw_spin_unlock(&rp
->lock
);
1148 hlist_add_head(&ri
->hlist
, head
);
1150 NOKPROBE_SYMBOL(recycle_rp_inst
);
1152 void kretprobe_hash_lock(struct task_struct
*tsk
,
1153 struct hlist_head
**head
, unsigned long *flags
)
1154 __acquires(hlist_lock
)
1156 unsigned long hash
= hash_ptr(tsk
, KPROBE_HASH_BITS
);
1157 raw_spinlock_t
*hlist_lock
;
1159 *head
= &kretprobe_inst_table
[hash
];
1160 hlist_lock
= kretprobe_table_lock_ptr(hash
);
1161 raw_spin_lock_irqsave(hlist_lock
, *flags
);
1163 NOKPROBE_SYMBOL(kretprobe_hash_lock
);
1165 static void kretprobe_table_lock(unsigned long hash
,
1166 unsigned long *flags
)
1167 __acquires(hlist_lock
)
1169 raw_spinlock_t
*hlist_lock
= kretprobe_table_lock_ptr(hash
);
1170 raw_spin_lock_irqsave(hlist_lock
, *flags
);
1172 NOKPROBE_SYMBOL(kretprobe_table_lock
);
1174 void kretprobe_hash_unlock(struct task_struct
*tsk
,
1175 unsigned long *flags
)
1176 __releases(hlist_lock
)
1178 unsigned long hash
= hash_ptr(tsk
, KPROBE_HASH_BITS
);
1179 raw_spinlock_t
*hlist_lock
;
1181 hlist_lock
= kretprobe_table_lock_ptr(hash
);
1182 raw_spin_unlock_irqrestore(hlist_lock
, *flags
);
1184 NOKPROBE_SYMBOL(kretprobe_hash_unlock
);
1186 static void kretprobe_table_unlock(unsigned long hash
,
1187 unsigned long *flags
)
1188 __releases(hlist_lock
)
1190 raw_spinlock_t
*hlist_lock
= kretprobe_table_lock_ptr(hash
);
1191 raw_spin_unlock_irqrestore(hlist_lock
, *flags
);
1193 NOKPROBE_SYMBOL(kretprobe_table_unlock
);
1196 * This function is called from finish_task_switch when task tk becomes dead,
1197 * so that we can recycle any function-return probe instances associated
1198 * with this task. These left over instances represent probed functions
1199 * that have been called but will never return.
1201 void kprobe_flush_task(struct task_struct
*tk
)
1203 struct kretprobe_instance
*ri
;
1204 struct hlist_head
*head
, empty_rp
;
1205 struct hlist_node
*tmp
;
1206 unsigned long hash
, flags
= 0;
1208 if (unlikely(!kprobes_initialized
))
1209 /* Early boot. kretprobe_table_locks not yet initialized. */
1212 INIT_HLIST_HEAD(&empty_rp
);
1213 hash
= hash_ptr(tk
, KPROBE_HASH_BITS
);
1214 head
= &kretprobe_inst_table
[hash
];
1215 kretprobe_table_lock(hash
, &flags
);
1216 hlist_for_each_entry_safe(ri
, tmp
, head
, hlist
) {
1218 recycle_rp_inst(ri
, &empty_rp
);
1220 kretprobe_table_unlock(hash
, &flags
);
1221 hlist_for_each_entry_safe(ri
, tmp
, &empty_rp
, hlist
) {
1222 hlist_del(&ri
->hlist
);
1226 NOKPROBE_SYMBOL(kprobe_flush_task
);
1228 static inline void free_rp_inst(struct kretprobe
*rp
)
1230 struct kretprobe_instance
*ri
;
1231 struct hlist_node
*next
;
1233 hlist_for_each_entry_safe(ri
, next
, &rp
->free_instances
, hlist
) {
1234 hlist_del(&ri
->hlist
);
1239 static void cleanup_rp_inst(struct kretprobe
*rp
)
1241 unsigned long flags
, hash
;
1242 struct kretprobe_instance
*ri
;
1243 struct hlist_node
*next
;
1244 struct hlist_head
*head
;
1247 for (hash
= 0; hash
< KPROBE_TABLE_SIZE
; hash
++) {
1248 kretprobe_table_lock(hash
, &flags
);
1249 head
= &kretprobe_inst_table
[hash
];
1250 hlist_for_each_entry_safe(ri
, next
, head
, hlist
) {
1254 kretprobe_table_unlock(hash
, &flags
);
1258 NOKPROBE_SYMBOL(cleanup_rp_inst
);
1261 * Add the new probe to ap->list. Fail if this is the
1262 * second jprobe at the address - two jprobes can't coexist
1264 static int add_new_kprobe(struct kprobe
*ap
, struct kprobe
*p
)
1266 BUG_ON(kprobe_gone(ap
) || kprobe_gone(p
));
1268 if (p
->break_handler
|| p
->post_handler
)
1269 unoptimize_kprobe(ap
, true); /* Fall back to normal kprobe */
1271 if (p
->break_handler
) {
1272 if (ap
->break_handler
)
1274 list_add_tail_rcu(&p
->list
, &ap
->list
);
1275 ap
->break_handler
= aggr_break_handler
;
1277 list_add_rcu(&p
->list
, &ap
->list
);
1278 if (p
->post_handler
&& !ap
->post_handler
)
1279 ap
->post_handler
= aggr_post_handler
;
1285 * Fill in the required fields of the "manager kprobe". Replace the
1286 * earlier kprobe in the hlist with the manager kprobe
1288 static void init_aggr_kprobe(struct kprobe
*ap
, struct kprobe
*p
)
1290 /* Copy p's insn slot to ap */
1292 flush_insn_slot(ap
);
1294 ap
->flags
= p
->flags
& ~KPROBE_FLAG_OPTIMIZED
;
1295 ap
->pre_handler
= aggr_pre_handler
;
1296 ap
->fault_handler
= aggr_fault_handler
;
1297 /* We don't care the kprobe which has gone. */
1298 if (p
->post_handler
&& !kprobe_gone(p
))
1299 ap
->post_handler
= aggr_post_handler
;
1300 if (p
->break_handler
&& !kprobe_gone(p
))
1301 ap
->break_handler
= aggr_break_handler
;
1303 INIT_LIST_HEAD(&ap
->list
);
1304 INIT_HLIST_NODE(&ap
->hlist
);
1306 list_add_rcu(&p
->list
, &ap
->list
);
1307 hlist_replace_rcu(&p
->hlist
, &ap
->hlist
);
1311 * This is the second or subsequent kprobe at the address - handle
1314 static int register_aggr_kprobe(struct kprobe
*orig_p
, struct kprobe
*p
)
1317 struct kprobe
*ap
= orig_p
;
1321 /* For preparing optimization, jump_label_text_reserved() is called */
1323 mutex_lock(&text_mutex
);
1325 if (!kprobe_aggrprobe(orig_p
)) {
1326 /* If orig_p is not an aggr_kprobe, create new aggr_kprobe. */
1327 ap
= alloc_aggr_kprobe(orig_p
);
1332 init_aggr_kprobe(ap
, orig_p
);
1333 } else if (kprobe_unused(ap
)) {
1334 /* This probe is going to die. Rescue it */
1335 ret
= reuse_unused_kprobe(ap
);
1340 if (kprobe_gone(ap
)) {
1342 * Attempting to insert new probe at the same location that
1343 * had a probe in the module vaddr area which already
1344 * freed. So, the instruction slot has already been
1345 * released. We need a new slot for the new probe.
1347 ret
= arch_prepare_kprobe(ap
);
1350 * Even if fail to allocate new slot, don't need to
1351 * free aggr_probe. It will be used next time, or
1352 * freed by unregister_kprobe.
1356 /* Prepare optimized instructions if possible. */
1357 prepare_optimized_kprobe(ap
);
1360 * Clear gone flag to prevent allocating new slot again, and
1361 * set disabled flag because it is not armed yet.
1363 ap
->flags
= (ap
->flags
& ~KPROBE_FLAG_GONE
)
1364 | KPROBE_FLAG_DISABLED
;
1367 /* Copy ap's insn slot to p */
1369 ret
= add_new_kprobe(ap
, p
);
1372 mutex_unlock(&text_mutex
);
1373 jump_label_unlock();
1376 if (ret
== 0 && kprobe_disabled(ap
) && !kprobe_disabled(p
)) {
1377 ap
->flags
&= ~KPROBE_FLAG_DISABLED
;
1378 if (!kprobes_all_disarmed
)
1379 /* Arm the breakpoint again. */
1385 bool __weak
arch_within_kprobe_blacklist(unsigned long addr
)
1387 /* The __kprobes marked functions and entry code must not be probed */
1388 return addr
>= (unsigned long)__kprobes_text_start
&&
1389 addr
< (unsigned long)__kprobes_text_end
;
1392 bool within_kprobe_blacklist(unsigned long addr
)
1394 struct kprobe_blacklist_entry
*ent
;
1396 if (arch_within_kprobe_blacklist(addr
))
1399 * If there exists a kprobe_blacklist, verify and
1400 * fail any probe registration in the prohibited area
1402 list_for_each_entry(ent
, &kprobe_blacklist
, list
) {
1403 if (addr
>= ent
->start_addr
&& addr
< ent
->end_addr
)
1411 * If we have a symbol_name argument, look it up and add the offset field
1412 * to it. This way, we can specify a relative address to a symbol.
1413 * This returns encoded errors if it fails to look up symbol or invalid
1414 * combination of parameters.
1416 static kprobe_opcode_t
*_kprobe_addr(kprobe_opcode_t
*addr
,
1417 const char *symbol_name
, unsigned int offset
)
1419 if ((symbol_name
&& addr
) || (!symbol_name
&& !addr
))
1423 addr
= kprobe_lookup_name(symbol_name
, offset
);
1425 return ERR_PTR(-ENOENT
);
1428 addr
= (kprobe_opcode_t
*)(((char *)addr
) + offset
);
1433 return ERR_PTR(-EINVAL
);
1436 static kprobe_opcode_t
*kprobe_addr(struct kprobe
*p
)
1438 return _kprobe_addr(p
->addr
, p
->symbol_name
, p
->offset
);
1441 /* Check passed kprobe is valid and return kprobe in kprobe_table. */
1442 static struct kprobe
*__get_valid_kprobe(struct kprobe
*p
)
1444 struct kprobe
*ap
, *list_p
;
1446 ap
= get_kprobe(p
->addr
);
1451 list_for_each_entry_rcu(list_p
, &ap
->list
, list
)
1453 /* kprobe p is a valid probe */
1461 /* Return error if the kprobe is being re-registered */
1462 static inline int check_kprobe_rereg(struct kprobe
*p
)
1466 mutex_lock(&kprobe_mutex
);
1467 if (__get_valid_kprobe(p
))
1469 mutex_unlock(&kprobe_mutex
);
1474 int __weak
arch_check_ftrace_location(struct kprobe
*p
)
1476 unsigned long ftrace_addr
;
1478 ftrace_addr
= ftrace_location((unsigned long)p
->addr
);
1480 #ifdef CONFIG_KPROBES_ON_FTRACE
1481 /* Given address is not on the instruction boundary */
1482 if ((unsigned long)p
->addr
!= ftrace_addr
)
1484 p
->flags
|= KPROBE_FLAG_FTRACE
;
1485 #else /* !CONFIG_KPROBES_ON_FTRACE */
1492 static int check_kprobe_address_safe(struct kprobe
*p
,
1493 struct module
**probed_mod
)
1497 ret
= arch_check_ftrace_location(p
);
1503 /* Ensure it is not in reserved area nor out of text */
1504 if (!kernel_text_address((unsigned long) p
->addr
) ||
1505 within_kprobe_blacklist((unsigned long) p
->addr
) ||
1506 jump_label_text_reserved(p
->addr
, p
->addr
)) {
1511 /* Check if are we probing a module */
1512 *probed_mod
= __module_text_address((unsigned long) p
->addr
);
1515 * We must hold a refcount of the probed module while updating
1516 * its code to prohibit unexpected unloading.
1518 if (unlikely(!try_module_get(*probed_mod
))) {
1524 * If the module freed .init.text, we couldn't insert
1527 if (within_module_init((unsigned long)p
->addr
, *probed_mod
) &&
1528 (*probed_mod
)->state
!= MODULE_STATE_COMING
) {
1529 module_put(*probed_mod
);
1536 jump_label_unlock();
1541 int register_kprobe(struct kprobe
*p
)
1544 struct kprobe
*old_p
;
1545 struct module
*probed_mod
;
1546 kprobe_opcode_t
*addr
;
1548 /* Adjust probe address from symbol */
1549 addr
= kprobe_addr(p
);
1551 return PTR_ERR(addr
);
1554 ret
= check_kprobe_rereg(p
);
1558 /* User can pass only KPROBE_FLAG_DISABLED to register_kprobe */
1559 p
->flags
&= KPROBE_FLAG_DISABLED
;
1561 INIT_LIST_HEAD(&p
->list
);
1563 ret
= check_kprobe_address_safe(p
, &probed_mod
);
1567 mutex_lock(&kprobe_mutex
);
1569 old_p
= get_kprobe(p
->addr
);
1571 /* Since this may unoptimize old_p, locking text_mutex. */
1572 ret
= register_aggr_kprobe(old_p
, p
);
1577 /* Prevent text modification */
1578 mutex_lock(&text_mutex
);
1579 ret
= prepare_kprobe(p
);
1580 mutex_unlock(&text_mutex
);
1585 INIT_HLIST_NODE(&p
->hlist
);
1586 hlist_add_head_rcu(&p
->hlist
,
1587 &kprobe_table
[hash_ptr(p
->addr
, KPROBE_HASH_BITS
)]);
1589 if (!kprobes_all_disarmed
&& !kprobe_disabled(p
))
1592 /* Try to optimize kprobe */
1593 try_to_optimize_kprobe(p
);
1595 mutex_unlock(&kprobe_mutex
);
1598 module_put(probed_mod
);
1602 EXPORT_SYMBOL_GPL(register_kprobe
);
1604 /* Check if all probes on the aggrprobe are disabled */
1605 static int aggr_kprobe_disabled(struct kprobe
*ap
)
1609 list_for_each_entry_rcu(kp
, &ap
->list
, list
)
1610 if (!kprobe_disabled(kp
))
1612 * There is an active probe on the list.
1613 * We can't disable this ap.
1620 /* Disable one kprobe: Make sure called under kprobe_mutex is locked */
1621 static struct kprobe
*__disable_kprobe(struct kprobe
*p
)
1623 struct kprobe
*orig_p
;
1625 /* Get an original kprobe for return */
1626 orig_p
= __get_valid_kprobe(p
);
1627 if (unlikely(orig_p
== NULL
))
1630 if (!kprobe_disabled(p
)) {
1631 /* Disable probe if it is a child probe */
1633 p
->flags
|= KPROBE_FLAG_DISABLED
;
1635 /* Try to disarm and disable this/parent probe */
1636 if (p
== orig_p
|| aggr_kprobe_disabled(orig_p
)) {
1638 * If kprobes_all_disarmed is set, orig_p
1639 * should have already been disarmed, so
1640 * skip unneed disarming process.
1642 if (!kprobes_all_disarmed
)
1643 disarm_kprobe(orig_p
, true);
1644 orig_p
->flags
|= KPROBE_FLAG_DISABLED
;
1652 * Unregister a kprobe without a scheduler synchronization.
1654 static int __unregister_kprobe_top(struct kprobe
*p
)
1656 struct kprobe
*ap
, *list_p
;
1658 /* Disable kprobe. This will disarm it if needed. */
1659 ap
= __disable_kprobe(p
);
1665 * This probe is an independent(and non-optimized) kprobe
1666 * (not an aggrprobe). Remove from the hash list.
1670 /* Following process expects this probe is an aggrprobe */
1671 WARN_ON(!kprobe_aggrprobe(ap
));
1673 if (list_is_singular(&ap
->list
) && kprobe_disarmed(ap
))
1675 * !disarmed could be happen if the probe is under delayed
1680 /* If disabling probe has special handlers, update aggrprobe */
1681 if (p
->break_handler
&& !kprobe_gone(p
))
1682 ap
->break_handler
= NULL
;
1683 if (p
->post_handler
&& !kprobe_gone(p
)) {
1684 list_for_each_entry_rcu(list_p
, &ap
->list
, list
) {
1685 if ((list_p
!= p
) && (list_p
->post_handler
))
1688 ap
->post_handler
= NULL
;
1692 * Remove from the aggrprobe: this path will do nothing in
1693 * __unregister_kprobe_bottom().
1695 list_del_rcu(&p
->list
);
1696 if (!kprobe_disabled(ap
) && !kprobes_all_disarmed
)
1698 * Try to optimize this probe again, because post
1699 * handler may have been changed.
1701 optimize_kprobe(ap
);
1706 BUG_ON(!kprobe_disarmed(ap
));
1707 hlist_del_rcu(&ap
->hlist
);
1711 static void __unregister_kprobe_bottom(struct kprobe
*p
)
1715 if (list_empty(&p
->list
))
1716 /* This is an independent kprobe */
1717 arch_remove_kprobe(p
);
1718 else if (list_is_singular(&p
->list
)) {
1719 /* This is the last child of an aggrprobe */
1720 ap
= list_entry(p
->list
.next
, struct kprobe
, list
);
1722 free_aggr_kprobe(ap
);
1724 /* Otherwise, do nothing. */
1727 int register_kprobes(struct kprobe
**kps
, int num
)
1733 for (i
= 0; i
< num
; i
++) {
1734 ret
= register_kprobe(kps
[i
]);
1737 unregister_kprobes(kps
, i
);
1743 EXPORT_SYMBOL_GPL(register_kprobes
);
1745 void unregister_kprobe(struct kprobe
*p
)
1747 unregister_kprobes(&p
, 1);
1749 EXPORT_SYMBOL_GPL(unregister_kprobe
);
1751 void unregister_kprobes(struct kprobe
**kps
, int num
)
1757 mutex_lock(&kprobe_mutex
);
1758 for (i
= 0; i
< num
; i
++)
1759 if (__unregister_kprobe_top(kps
[i
]) < 0)
1760 kps
[i
]->addr
= NULL
;
1761 mutex_unlock(&kprobe_mutex
);
1763 synchronize_sched();
1764 for (i
= 0; i
< num
; i
++)
1766 __unregister_kprobe_bottom(kps
[i
]);
1768 EXPORT_SYMBOL_GPL(unregister_kprobes
);
1770 int __weak
kprobe_exceptions_notify(struct notifier_block
*self
,
1771 unsigned long val
, void *data
)
1775 NOKPROBE_SYMBOL(kprobe_exceptions_notify
);
1777 static struct notifier_block kprobe_exceptions_nb
= {
1778 .notifier_call
= kprobe_exceptions_notify
,
1779 .priority
= 0x7fffffff /* we need to be notified first */
1782 unsigned long __weak
arch_deref_entry_point(void *entry
)
1784 return (unsigned long)entry
;
1787 int register_jprobes(struct jprobe
**jps
, int num
)
1794 for (i
= 0; i
< num
; i
++) {
1795 ret
= register_jprobe(jps
[i
]);
1799 unregister_jprobes(jps
, i
);
1806 EXPORT_SYMBOL_GPL(register_jprobes
);
1808 int register_jprobe(struct jprobe
*jp
)
1810 unsigned long addr
, offset
;
1811 struct kprobe
*kp
= &jp
->kp
;
1814 * Verify probepoint as well as the jprobe handler are
1815 * valid function entry points.
1817 addr
= arch_deref_entry_point(jp
->entry
);
1819 if (kallsyms_lookup_size_offset(addr
, NULL
, &offset
) && offset
== 0 &&
1820 kprobe_on_func_entry(kp
->addr
, kp
->symbol_name
, kp
->offset
)) {
1821 kp
->pre_handler
= setjmp_pre_handler
;
1822 kp
->break_handler
= longjmp_break_handler
;
1823 return register_kprobe(kp
);
1828 EXPORT_SYMBOL_GPL(register_jprobe
);
1830 void unregister_jprobe(struct jprobe
*jp
)
1832 unregister_jprobes(&jp
, 1);
1834 EXPORT_SYMBOL_GPL(unregister_jprobe
);
1836 void unregister_jprobes(struct jprobe
**jps
, int num
)
1842 mutex_lock(&kprobe_mutex
);
1843 for (i
= 0; i
< num
; i
++)
1844 if (__unregister_kprobe_top(&jps
[i
]->kp
) < 0)
1845 jps
[i
]->kp
.addr
= NULL
;
1846 mutex_unlock(&kprobe_mutex
);
1848 synchronize_sched();
1849 for (i
= 0; i
< num
; i
++) {
1850 if (jps
[i
]->kp
.addr
)
1851 __unregister_kprobe_bottom(&jps
[i
]->kp
);
1854 EXPORT_SYMBOL_GPL(unregister_jprobes
);
1856 #ifdef CONFIG_KRETPROBES
1858 * This kprobe pre_handler is registered with every kretprobe. When probe
1859 * hits it will set up the return probe.
1861 static int pre_handler_kretprobe(struct kprobe
*p
, struct pt_regs
*regs
)
1863 struct kretprobe
*rp
= container_of(p
, struct kretprobe
, kp
);
1864 unsigned long hash
, flags
= 0;
1865 struct kretprobe_instance
*ri
;
1868 * To avoid deadlocks, prohibit return probing in NMI contexts,
1869 * just skip the probe and increase the (inexact) 'nmissed'
1870 * statistical counter, so that the user is informed that
1871 * something happened:
1873 if (unlikely(in_nmi())) {
1878 /* TODO: consider to only swap the RA after the last pre_handler fired */
1879 hash
= hash_ptr(current
, KPROBE_HASH_BITS
);
1880 raw_spin_lock_irqsave(&rp
->lock
, flags
);
1881 if (!hlist_empty(&rp
->free_instances
)) {
1882 ri
= hlist_entry(rp
->free_instances
.first
,
1883 struct kretprobe_instance
, hlist
);
1884 hlist_del(&ri
->hlist
);
1885 raw_spin_unlock_irqrestore(&rp
->lock
, flags
);
1890 if (rp
->entry_handler
&& rp
->entry_handler(ri
, regs
)) {
1891 raw_spin_lock_irqsave(&rp
->lock
, flags
);
1892 hlist_add_head(&ri
->hlist
, &rp
->free_instances
);
1893 raw_spin_unlock_irqrestore(&rp
->lock
, flags
);
1897 arch_prepare_kretprobe(ri
, regs
);
1899 /* XXX(hch): why is there no hlist_move_head? */
1900 INIT_HLIST_NODE(&ri
->hlist
);
1901 kretprobe_table_lock(hash
, &flags
);
1902 hlist_add_head(&ri
->hlist
, &kretprobe_inst_table
[hash
]);
1903 kretprobe_table_unlock(hash
, &flags
);
1906 raw_spin_unlock_irqrestore(&rp
->lock
, flags
);
1910 NOKPROBE_SYMBOL(pre_handler_kretprobe
);
1912 bool __weak
arch_kprobe_on_func_entry(unsigned long offset
)
1917 bool kprobe_on_func_entry(kprobe_opcode_t
*addr
, const char *sym
, unsigned long offset
)
1919 kprobe_opcode_t
*kp_addr
= _kprobe_addr(addr
, sym
, offset
);
1921 if (IS_ERR(kp_addr
))
1924 if (!kallsyms_lookup_size_offset((unsigned long)kp_addr
, NULL
, &offset
) ||
1925 !arch_kprobe_on_func_entry(offset
))
1931 int register_kretprobe(struct kretprobe
*rp
)
1934 struct kretprobe_instance
*inst
;
1938 if (!kprobe_on_func_entry(rp
->kp
.addr
, rp
->kp
.symbol_name
, rp
->kp
.offset
))
1941 if (kretprobe_blacklist_size
) {
1942 addr
= kprobe_addr(&rp
->kp
);
1944 return PTR_ERR(addr
);
1946 for (i
= 0; kretprobe_blacklist
[i
].name
!= NULL
; i
++) {
1947 if (kretprobe_blacklist
[i
].addr
== addr
)
1952 rp
->kp
.pre_handler
= pre_handler_kretprobe
;
1953 rp
->kp
.post_handler
= NULL
;
1954 rp
->kp
.fault_handler
= NULL
;
1955 rp
->kp
.break_handler
= NULL
;
1957 /* Pre-allocate memory for max kretprobe instances */
1958 if (rp
->maxactive
<= 0) {
1959 #ifdef CONFIG_PREEMPT
1960 rp
->maxactive
= max_t(unsigned int, 10, 2*num_possible_cpus());
1962 rp
->maxactive
= num_possible_cpus();
1965 raw_spin_lock_init(&rp
->lock
);
1966 INIT_HLIST_HEAD(&rp
->free_instances
);
1967 for (i
= 0; i
< rp
->maxactive
; i
++) {
1968 inst
= kmalloc(sizeof(struct kretprobe_instance
) +
1969 rp
->data_size
, GFP_KERNEL
);
1974 INIT_HLIST_NODE(&inst
->hlist
);
1975 hlist_add_head(&inst
->hlist
, &rp
->free_instances
);
1979 /* Establish function entry probe point */
1980 ret
= register_kprobe(&rp
->kp
);
1985 EXPORT_SYMBOL_GPL(register_kretprobe
);
1987 int register_kretprobes(struct kretprobe
**rps
, int num
)
1993 for (i
= 0; i
< num
; i
++) {
1994 ret
= register_kretprobe(rps
[i
]);
1997 unregister_kretprobes(rps
, i
);
2003 EXPORT_SYMBOL_GPL(register_kretprobes
);
2005 void unregister_kretprobe(struct kretprobe
*rp
)
2007 unregister_kretprobes(&rp
, 1);
2009 EXPORT_SYMBOL_GPL(unregister_kretprobe
);
2011 void unregister_kretprobes(struct kretprobe
**rps
, int num
)
2017 mutex_lock(&kprobe_mutex
);
2018 for (i
= 0; i
< num
; i
++)
2019 if (__unregister_kprobe_top(&rps
[i
]->kp
) < 0)
2020 rps
[i
]->kp
.addr
= NULL
;
2021 mutex_unlock(&kprobe_mutex
);
2023 synchronize_sched();
2024 for (i
= 0; i
< num
; i
++) {
2025 if (rps
[i
]->kp
.addr
) {
2026 __unregister_kprobe_bottom(&rps
[i
]->kp
);
2027 cleanup_rp_inst(rps
[i
]);
2031 EXPORT_SYMBOL_GPL(unregister_kretprobes
);
2033 #else /* CONFIG_KRETPROBES */
2034 int register_kretprobe(struct kretprobe
*rp
)
2038 EXPORT_SYMBOL_GPL(register_kretprobe
);
2040 int register_kretprobes(struct kretprobe
**rps
, int num
)
2044 EXPORT_SYMBOL_GPL(register_kretprobes
);
2046 void unregister_kretprobe(struct kretprobe
*rp
)
2049 EXPORT_SYMBOL_GPL(unregister_kretprobe
);
2051 void unregister_kretprobes(struct kretprobe
**rps
, int num
)
2054 EXPORT_SYMBOL_GPL(unregister_kretprobes
);
2056 static int pre_handler_kretprobe(struct kprobe
*p
, struct pt_regs
*regs
)
2060 NOKPROBE_SYMBOL(pre_handler_kretprobe
);
2062 #endif /* CONFIG_KRETPROBES */
2064 /* Set the kprobe gone and remove its instruction buffer. */
2065 static void kill_kprobe(struct kprobe
*p
)
2069 p
->flags
|= KPROBE_FLAG_GONE
;
2070 if (kprobe_aggrprobe(p
)) {
2072 * If this is an aggr_kprobe, we have to list all the
2073 * chained probes and mark them GONE.
2075 list_for_each_entry_rcu(kp
, &p
->list
, list
)
2076 kp
->flags
|= KPROBE_FLAG_GONE
;
2077 p
->post_handler
= NULL
;
2078 p
->break_handler
= NULL
;
2079 kill_optimized_kprobe(p
);
2082 * Here, we can remove insn_slot safely, because no thread calls
2083 * the original probed function (which will be freed soon) any more.
2085 arch_remove_kprobe(p
);
2088 /* Disable one kprobe */
2089 int disable_kprobe(struct kprobe
*kp
)
2093 mutex_lock(&kprobe_mutex
);
2095 /* Disable this kprobe */
2096 if (__disable_kprobe(kp
) == NULL
)
2099 mutex_unlock(&kprobe_mutex
);
2102 EXPORT_SYMBOL_GPL(disable_kprobe
);
2104 /* Enable one kprobe */
2105 int enable_kprobe(struct kprobe
*kp
)
2110 mutex_lock(&kprobe_mutex
);
2112 /* Check whether specified probe is valid. */
2113 p
= __get_valid_kprobe(kp
);
2114 if (unlikely(p
== NULL
)) {
2119 if (kprobe_gone(kp
)) {
2120 /* This kprobe has gone, we couldn't enable it. */
2126 kp
->flags
&= ~KPROBE_FLAG_DISABLED
;
2128 if (!kprobes_all_disarmed
&& kprobe_disabled(p
)) {
2129 p
->flags
&= ~KPROBE_FLAG_DISABLED
;
2133 mutex_unlock(&kprobe_mutex
);
2136 EXPORT_SYMBOL_GPL(enable_kprobe
);
2138 void dump_kprobe(struct kprobe
*kp
)
2140 printk(KERN_WARNING
"Dumping kprobe:\n");
2141 printk(KERN_WARNING
"Name: %s\nAddress: %p\nOffset: %x\n",
2142 kp
->symbol_name
, kp
->addr
, kp
->offset
);
2144 NOKPROBE_SYMBOL(dump_kprobe
);
2147 * Lookup and populate the kprobe_blacklist.
2149 * Unlike the kretprobe blacklist, we'll need to determine
2150 * the range of addresses that belong to the said functions,
2151 * since a kprobe need not necessarily be at the beginning
2154 static int __init
populate_kprobe_blacklist(unsigned long *start
,
2157 unsigned long *iter
;
2158 struct kprobe_blacklist_entry
*ent
;
2159 unsigned long entry
, offset
= 0, size
= 0;
2161 for (iter
= start
; iter
< end
; iter
++) {
2162 entry
= arch_deref_entry_point((void *)*iter
);
2164 if (!kernel_text_address(entry
) ||
2165 !kallsyms_lookup_size_offset(entry
, &size
, &offset
)) {
2166 pr_err("Failed to find blacklist at %p\n",
2171 ent
= kmalloc(sizeof(*ent
), GFP_KERNEL
);
2174 ent
->start_addr
= entry
;
2175 ent
->end_addr
= entry
+ size
;
2176 INIT_LIST_HEAD(&ent
->list
);
2177 list_add_tail(&ent
->list
, &kprobe_blacklist
);
2182 /* Module notifier call back, checking kprobes on the module */
2183 static int kprobes_module_callback(struct notifier_block
*nb
,
2184 unsigned long val
, void *data
)
2186 struct module
*mod
= data
;
2187 struct hlist_head
*head
;
2190 int checkcore
= (val
== MODULE_STATE_GOING
);
2192 if (val
!= MODULE_STATE_GOING
&& val
!= MODULE_STATE_LIVE
)
2196 * When MODULE_STATE_GOING was notified, both of module .text and
2197 * .init.text sections would be freed. When MODULE_STATE_LIVE was
2198 * notified, only .init.text section would be freed. We need to
2199 * disable kprobes which have been inserted in the sections.
2201 mutex_lock(&kprobe_mutex
);
2202 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
2203 head
= &kprobe_table
[i
];
2204 hlist_for_each_entry_rcu(p
, head
, hlist
)
2205 if (within_module_init((unsigned long)p
->addr
, mod
) ||
2207 within_module_core((unsigned long)p
->addr
, mod
))) {
2209 * The vaddr this probe is installed will soon
2210 * be vfreed buy not synced to disk. Hence,
2211 * disarming the breakpoint isn't needed.
2213 * Note, this will also move any optimized probes
2214 * that are pending to be removed from their
2215 * corresponding lists to the freeing_list and
2216 * will not be touched by the delayed
2217 * kprobe_optimizer work handler.
2222 mutex_unlock(&kprobe_mutex
);
2226 static struct notifier_block kprobe_module_nb
= {
2227 .notifier_call
= kprobes_module_callback
,
2231 /* Markers of _kprobe_blacklist section */
2232 extern unsigned long __start_kprobe_blacklist
[];
2233 extern unsigned long __stop_kprobe_blacklist
[];
2235 static int __init
init_kprobes(void)
2239 /* FIXME allocate the probe table, currently defined statically */
2240 /* initialize all list heads */
2241 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
2242 INIT_HLIST_HEAD(&kprobe_table
[i
]);
2243 INIT_HLIST_HEAD(&kretprobe_inst_table
[i
]);
2244 raw_spin_lock_init(&(kretprobe_table_locks
[i
].lock
));
2247 err
= populate_kprobe_blacklist(__start_kprobe_blacklist
,
2248 __stop_kprobe_blacklist
);
2250 pr_err("kprobes: failed to populate blacklist: %d\n", err
);
2251 pr_err("Please take care of using kprobes.\n");
2254 if (kretprobe_blacklist_size
) {
2255 /* lookup the function address from its name */
2256 for (i
= 0; kretprobe_blacklist
[i
].name
!= NULL
; i
++) {
2257 kretprobe_blacklist
[i
].addr
=
2258 kprobe_lookup_name(kretprobe_blacklist
[i
].name
, 0);
2259 if (!kretprobe_blacklist
[i
].addr
)
2260 printk("kretprobe: lookup failed: %s\n",
2261 kretprobe_blacklist
[i
].name
);
2265 #if defined(CONFIG_OPTPROBES)
2266 #if defined(__ARCH_WANT_KPROBES_INSN_SLOT)
2267 /* Init kprobe_optinsn_slots */
2268 kprobe_optinsn_slots
.insn_size
= MAX_OPTINSN_SIZE
;
2270 /* By default, kprobes can be optimized */
2271 kprobes_allow_optimization
= true;
2274 /* By default, kprobes are armed */
2275 kprobes_all_disarmed
= false;
2277 err
= arch_init_kprobes();
2279 err
= register_die_notifier(&kprobe_exceptions_nb
);
2281 err
= register_module_notifier(&kprobe_module_nb
);
2283 kprobes_initialized
= (err
== 0);
2290 #ifdef CONFIG_DEBUG_FS
2291 static void report_probe(struct seq_file
*pi
, struct kprobe
*p
,
2292 const char *sym
, int offset
, char *modname
, struct kprobe
*pp
)
2296 if (p
->pre_handler
== pre_handler_kretprobe
)
2298 else if (p
->pre_handler
== setjmp_pre_handler
)
2304 seq_printf(pi
, "%p %s %s+0x%x %s ",
2305 p
->addr
, kprobe_type
, sym
, offset
,
2306 (modname
? modname
: " "));
2308 seq_printf(pi
, "%p %s %p ",
2309 p
->addr
, kprobe_type
, p
->addr
);
2313 seq_printf(pi
, "%s%s%s%s\n",
2314 (kprobe_gone(p
) ? "[GONE]" : ""),
2315 ((kprobe_disabled(p
) && !kprobe_gone(p
)) ? "[DISABLED]" : ""),
2316 (kprobe_optimized(pp
) ? "[OPTIMIZED]" : ""),
2317 (kprobe_ftrace(pp
) ? "[FTRACE]" : ""));
2320 static void *kprobe_seq_start(struct seq_file
*f
, loff_t
*pos
)
2322 return (*pos
< KPROBE_TABLE_SIZE
) ? pos
: NULL
;
2325 static void *kprobe_seq_next(struct seq_file
*f
, void *v
, loff_t
*pos
)
2328 if (*pos
>= KPROBE_TABLE_SIZE
)
2333 static void kprobe_seq_stop(struct seq_file
*f
, void *v
)
2338 static int show_kprobe_addr(struct seq_file
*pi
, void *v
)
2340 struct hlist_head
*head
;
2341 struct kprobe
*p
, *kp
;
2342 const char *sym
= NULL
;
2343 unsigned int i
= *(loff_t
*) v
;
2344 unsigned long offset
= 0;
2345 char *modname
, namebuf
[KSYM_NAME_LEN
];
2347 head
= &kprobe_table
[i
];
2349 hlist_for_each_entry_rcu(p
, head
, hlist
) {
2350 sym
= kallsyms_lookup((unsigned long)p
->addr
, NULL
,
2351 &offset
, &modname
, namebuf
);
2352 if (kprobe_aggrprobe(p
)) {
2353 list_for_each_entry_rcu(kp
, &p
->list
, list
)
2354 report_probe(pi
, kp
, sym
, offset
, modname
, p
);
2356 report_probe(pi
, p
, sym
, offset
, modname
, NULL
);
2362 static const struct seq_operations kprobes_seq_ops
= {
2363 .start
= kprobe_seq_start
,
2364 .next
= kprobe_seq_next
,
2365 .stop
= kprobe_seq_stop
,
2366 .show
= show_kprobe_addr
2369 static int kprobes_open(struct inode
*inode
, struct file
*filp
)
2371 return seq_open(filp
, &kprobes_seq_ops
);
2374 static const struct file_operations debugfs_kprobes_operations
= {
2375 .open
= kprobes_open
,
2377 .llseek
= seq_lseek
,
2378 .release
= seq_release
,
2381 /* kprobes/blacklist -- shows which functions can not be probed */
2382 static void *kprobe_blacklist_seq_start(struct seq_file
*m
, loff_t
*pos
)
2384 return seq_list_start(&kprobe_blacklist
, *pos
);
2387 static void *kprobe_blacklist_seq_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
2389 return seq_list_next(v
, &kprobe_blacklist
, pos
);
2392 static int kprobe_blacklist_seq_show(struct seq_file
*m
, void *v
)
2394 struct kprobe_blacklist_entry
*ent
=
2395 list_entry(v
, struct kprobe_blacklist_entry
, list
);
2397 seq_printf(m
, "0x%p-0x%p\t%ps\n", (void *)ent
->start_addr
,
2398 (void *)ent
->end_addr
, (void *)ent
->start_addr
);
2402 static const struct seq_operations kprobe_blacklist_seq_ops
= {
2403 .start
= kprobe_blacklist_seq_start
,
2404 .next
= kprobe_blacklist_seq_next
,
2405 .stop
= kprobe_seq_stop
, /* Reuse void function */
2406 .show
= kprobe_blacklist_seq_show
,
2409 static int kprobe_blacklist_open(struct inode
*inode
, struct file
*filp
)
2411 return seq_open(filp
, &kprobe_blacklist_seq_ops
);
2414 static const struct file_operations debugfs_kprobe_blacklist_ops
= {
2415 .open
= kprobe_blacklist_open
,
2417 .llseek
= seq_lseek
,
2418 .release
= seq_release
,
2421 static void arm_all_kprobes(void)
2423 struct hlist_head
*head
;
2427 mutex_lock(&kprobe_mutex
);
2429 /* If kprobes are armed, just return */
2430 if (!kprobes_all_disarmed
)
2431 goto already_enabled
;
2434 * optimize_kprobe() called by arm_kprobe() checks
2435 * kprobes_all_disarmed, so set kprobes_all_disarmed before
2438 kprobes_all_disarmed
= false;
2439 /* Arming kprobes doesn't optimize kprobe itself */
2440 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
2441 head
= &kprobe_table
[i
];
2442 hlist_for_each_entry_rcu(p
, head
, hlist
)
2443 if (!kprobe_disabled(p
))
2447 printk(KERN_INFO
"Kprobes globally enabled\n");
2450 mutex_unlock(&kprobe_mutex
);
2454 static void disarm_all_kprobes(void)
2456 struct hlist_head
*head
;
2460 mutex_lock(&kprobe_mutex
);
2462 /* If kprobes are already disarmed, just return */
2463 if (kprobes_all_disarmed
) {
2464 mutex_unlock(&kprobe_mutex
);
2468 kprobes_all_disarmed
= true;
2469 printk(KERN_INFO
"Kprobes globally disabled\n");
2471 for (i
= 0; i
< KPROBE_TABLE_SIZE
; i
++) {
2472 head
= &kprobe_table
[i
];
2473 hlist_for_each_entry_rcu(p
, head
, hlist
) {
2474 if (!arch_trampoline_kprobe(p
) && !kprobe_disabled(p
))
2475 disarm_kprobe(p
, false);
2478 mutex_unlock(&kprobe_mutex
);
2480 /* Wait for disarming all kprobes by optimizer */
2481 wait_for_kprobe_optimizer();
2485 * XXX: The debugfs bool file interface doesn't allow for callbacks
2486 * when the bool state is switched. We can reuse that facility when
2489 static ssize_t
read_enabled_file_bool(struct file
*file
,
2490 char __user
*user_buf
, size_t count
, loff_t
*ppos
)
2494 if (!kprobes_all_disarmed
)
2500 return simple_read_from_buffer(user_buf
, count
, ppos
, buf
, 2);
2503 static ssize_t
write_enabled_file_bool(struct file
*file
,
2504 const char __user
*user_buf
, size_t count
, loff_t
*ppos
)
2509 buf_size
= min(count
, (sizeof(buf
)-1));
2510 if (copy_from_user(buf
, user_buf
, buf_size
))
2513 buf
[buf_size
] = '\0';
2523 disarm_all_kprobes();
2532 static const struct file_operations fops_kp
= {
2533 .read
= read_enabled_file_bool
,
2534 .write
= write_enabled_file_bool
,
2535 .llseek
= default_llseek
,
2538 static int __init
debugfs_kprobe_init(void)
2540 struct dentry
*dir
, *file
;
2541 unsigned int value
= 1;
2543 dir
= debugfs_create_dir("kprobes", NULL
);
2547 file
= debugfs_create_file("list", 0400, dir
, NULL
,
2548 &debugfs_kprobes_operations
);
2552 file
= debugfs_create_file("enabled", 0600, dir
,
2557 file
= debugfs_create_file("blacklist", 0400, dir
, NULL
,
2558 &debugfs_kprobe_blacklist_ops
);
2565 debugfs_remove(dir
);
2569 late_initcall(debugfs_kprobe_init
);
2570 #endif /* CONFIG_DEBUG_FS */
2572 module_init(init_kprobes
);
2574 /* defined in arch/.../kernel/kprobes.c */
2575 EXPORT_SYMBOL_GPL(jprobe_return
);