2 * Dynamic Binary Instrumentation Module based on KProbes
3 * modules/kprobe/arch/asm-arm/dbi_kprobes.c
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) Samsung Electronics, 2006-2010
21 * 2006-2007 Ekaterina Gorelkina <e.gorelkina@samsung.com>: initial implementation for ARM/MIPS
22 * 2008-2009 Alexey Gerenkov <a.gerenkov@samsung.com> User-Space
23 * Probes initial implementation; Support x86.
24 * 2010 Ekaterina Gorelkina <e.gorelkina@samsung.com>: redesign module for separating core and arch parts
25 * 2010-2011 Alexander Shirshikov <a.shirshikov@samsung.com>: initial implementation for Thumb
26 * 2012 Stanislav Andreev <s.andreev@samsung.com>: added time debug profiling support; BUG() message fix
27 * 2012 Stanislav Andreev <s.andreev@samsung.com>: redesign of kprobe functionality -
28 * kprobe_handler() now called via undefined instruction hooks
29 * 2012 Stanislav Andreev <s.andreev@samsung.com>: hash tables search implemented for uprobes
32 #include <linux/module.h>
35 #include "dbi_kprobes.h"
36 #include "dbi_kprobes_arm.h"
37 #include "dbi_kprobes_thumb.h"
38 #include "../dbi_kprobes.h"
39 #include "../../dbi_kprobes.h"
41 #include "../../dbi_kdebug.h"
42 #include "../../dbi_insn_slots.h"
43 #include "../../dbi_kprobes_deps.h"
46 #include <asm/cacheflush.h>
48 #ifdef TRAP_OVERHEAD_DEBUG
49 #include <linux/pid.h>
50 #include <linux/signal.h>
54 #include <linux/time.h>
57 #include <asm/traps.h>
58 #include <asm/ptrace.h>
59 #include <linux/list.h>
60 #include <linux/hash.h>
62 #define SUPRESS_BUG_MESSAGES
64 extern struct kprobe * per_cpu__current_kprobe;
65 extern struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
67 static void (*__swap_register_undef_hook)(struct undef_hook *hook);
68 static void (*__swap_unregister_undef_hook)(struct undef_hook *hook);
71 unsigned long swap_sum_time = 0;
72 unsigned long swap_sum_hit = 0;
73 EXPORT_SYMBOL_GPL (swap_sum_time);
74 EXPORT_SYMBOL_GPL (swap_sum_hit);
77 static unsigned int arr_traps_template[] = {
78 0xe1a0c00d, // mov ip, sp
79 0xe92dd800, // stmdb sp!, {fp, ip, lr, pc}
80 0xe24cb004, // sub fp, ip, #4 ; 0x4
82 0xe3500000, // cmp r0, #0 ; 0x0
83 0xe89da800, // ldmia sp, {fp, sp, pc}
89 static struct kprobe trampoline_p =
91 .addr = (kprobe_opcode_t *) & kretprobe_trampoline,
92 .pre_handler = trampoline_probe_handler
95 int prep_pc_dep_insn_execbuf(kprobe_opcode_t *insns, kprobe_opcode_t insn, int uregs)
103 for (i = 0; i < 13; i++, reg_mask <<= 1)
105 if (!(insn & reg_mask))
111 for (i = 0; i < 13; i++)
113 if ((uregs & 0x1) && (ARM_INSN_REG_RN (insn) == i))
115 if ((uregs & 0x2) && (ARM_INSN_REG_RD (insn) == i))
117 if ((uregs & 0x4) && (ARM_INSN_REG_RS (insn) == i))
119 if ((uregs & 0x8) && (ARM_INSN_REG_RM (insn) == i))
126 DBPRINTF ("there are no free register %x in insn %lx!", uregs, insn);
129 DBPRINTF ("prep_pc_dep_insn_execbuf: using R%d, changing regs %x", i, uregs);
131 // set register to save
132 ARM_INSN_REG_SET_RD (insns[0], i);
133 // set register to load address to
134 ARM_INSN_REG_SET_RD (insns[1], i);
135 // set instruction to execute and patch it
138 ARM_INSN_REG_CLEAR_MR (insn, 15);
139 ARM_INSN_REG_SET_MR (insn, i);
143 if ((uregs & 0x1) && (ARM_INSN_REG_RN (insn) == 15))
144 ARM_INSN_REG_SET_RN (insn, i);
145 if ((uregs & 0x2) && (ARM_INSN_REG_RD (insn) == 15))
146 ARM_INSN_REG_SET_RD (insn, i);
147 if ((uregs & 0x4) && (ARM_INSN_REG_RS (insn) == 15))
148 ARM_INSN_REG_SET_RS (insn, i);
149 if ((uregs & 0x8) && (ARM_INSN_REG_RM (insn) == 15))
150 ARM_INSN_REG_SET_RM (insn, i);
152 insns[UPROBES_TRAMP_INSN_IDX] = insn;
153 // set register to restore
154 ARM_INSN_REG_SET_RD (insns[3], i);
157 EXPORT_SYMBOL_GPL(prep_pc_dep_insn_execbuf);
159 int arch_check_insn_arm(struct arch_specific_insn *ainsn)
163 // check instructions that can change PC by nature
165 // ARM_INSN_MATCH (UNDEF, ainsn->insn_arm[0]) ||
166 ARM_INSN_MATCH (AUNDEF, ainsn->insn_arm[0]) ||
167 ARM_INSN_MATCH (SWI, ainsn->insn_arm[0]) ||
168 ARM_INSN_MATCH (BREAK, ainsn->insn_arm[0]) ||
169 ARM_INSN_MATCH (BL, ainsn->insn_arm[0]) ||
170 ARM_INSN_MATCH (BLX1, ainsn->insn_arm[0]) ||
171 ARM_INSN_MATCH (BLX2, ainsn->insn_arm[0]) ||
172 ARM_INSN_MATCH (BX, ainsn->insn_arm[0]) ||
173 ARM_INSN_MATCH (BXJ, ainsn->insn_arm[0]))
175 DBPRINTF ("Bad insn arch_check_insn_arm: %lx\n", ainsn->insn_arm[0]);
178 #ifndef CONFIG_CPU_V7
179 // check instructions that can write result to PC
180 else if ((ARM_INSN_MATCH (DPIS, ainsn->insn_arm[0]) ||
181 ARM_INSN_MATCH (DPRS, ainsn->insn_arm[0]) ||
182 ARM_INSN_MATCH (DPI, ainsn->insn_arm[0]) ||
183 ARM_INSN_MATCH (LIO, ainsn->insn_arm[0]) ||
184 ARM_INSN_MATCH (LRO, ainsn->insn_arm[0])) &&
185 (ARM_INSN_REG_RD (ainsn->insn_arm[0]) == 15))
187 DBPRINTF ("Bad arch_check_insn_arm: %lx\n", ainsn->insn_arm[0]);
190 #endif // CONFIG_CPU_V7
191 // check special instruction loads store multiple registers
192 else if ((ARM_INSN_MATCH (LM, ainsn->insn_arm[0]) || ARM_INSN_MATCH (SM, ainsn->insn_arm[0])) &&
193 // store pc or load to pc
194 (ARM_INSN_REG_MR (ainsn->insn_arm[0], 15) ||
195 // store/load with pc update
196 ((ARM_INSN_REG_RN (ainsn->insn_arm[0]) == 15) && (ainsn->insn_arm[0] & 0x200000))))
198 DBPRINTF ("Bad insn arch_check_insn_arm: %lx\n", ainsn->insn_arm[0]);
203 EXPORT_SYMBOL_GPL(arch_check_insn_arm);
205 int arch_prepare_kretprobe (struct kretprobe *p)
207 DBPRINTF("Warrning: arch_prepare_kretprobe is not implemented\n");
211 int arch_prepare_kprobe (struct kprobe *p)
213 kprobe_opcode_t insns[KPROBES_TRAMP_LEN];
214 int uregs, pc_dep, ret = 0;
215 kprobe_opcode_t insn[MAX_INSN_SIZE];
216 struct arch_specific_insn ainsn;
218 /* insn: must be on special executable page on i386. */
219 p->ainsn.insn = get_insn_slot(NULL, &kprobe_insn_pages, 0);
223 memcpy (insn, p->addr, MAX_INSN_SIZE * sizeof (kprobe_opcode_t));
224 ainsn.insn_arm = ainsn.insn = insn;
225 ret = arch_check_insn_arm (&ainsn);
228 p->opcode = *p->addr;
232 if(ARM_INSN_MATCH (DPIS, insn[0]) || ARM_INSN_MATCH (LRO, insn[0]) ||
233 ARM_INSN_MATCH (SRO, insn[0]))
236 if( (ARM_INSN_REG_RN (insn[0]) == 15) || (ARM_INSN_REG_RM (insn[0]) == 15) ||
237 (ARM_INSN_MATCH (SRO, insn[0]) && (ARM_INSN_REG_RD (insn[0]) == 15)) )
239 DBPRINTF ("Unboostable insn %lx, DPIS/LRO/SRO\n", insn[0]);
244 else if(ARM_INSN_MATCH (DPI, insn[0]) || ARM_INSN_MATCH (LIO, insn[0]) ||
245 ARM_INSN_MATCH (SIO, insn[0]))
248 if ((ARM_INSN_REG_RN (insn[0]) == 15) || (ARM_INSN_MATCH (SIO, insn[0]) &&
249 (ARM_INSN_REG_RD (insn[0]) == 15)))
252 DBPRINTF ("Unboostable insn %lx/%p, DPI/LIO/SIO\n", insn[0], p);
256 else if(ARM_INSN_MATCH (DPRS, insn[0]))
259 if ((ARM_INSN_REG_RN (insn[0]) == 15) || (ARM_INSN_REG_RM (insn[0]) == 15) ||
260 (ARM_INSN_REG_RS (insn[0]) == 15))
263 DBPRINTF ("Unboostable insn %lx, DPRS\n", insn[0]);
267 else if(ARM_INSN_MATCH (SM, insn[0]))
270 if (ARM_INSN_REG_MR (insn[0], 15))
272 DBPRINTF ("Unboostable insn %lx, SM\n", insn[0]);
276 // check instructions that can write result to SP andu uses PC
277 if (pc_dep && (ARM_INSN_REG_RD (ainsn.insn[0]) == 13))
279 free_insn_slot(&kprobe_insn_pages, NULL, p->ainsn.insn);
286 memcpy (insns, pc_dep_insn_execbuf, sizeof (insns));
287 if (prep_pc_dep_insn_execbuf (insns, insn[0], uregs) != 0)
289 DBPRINTF ("failed to prepare exec buffer for insn %lx!", insn[0]);
290 free_insn_slot(&kprobe_insn_pages, NULL, p->ainsn.insn);
293 insns[6] = (kprobe_opcode_t) (p->addr + 2);
297 memcpy (insns, gen_insn_execbuf, sizeof (insns));
298 insns[KPROBES_TRAMP_INSN_IDX] = insn[0];
300 insns[7] = (kprobe_opcode_t) (p->addr + 1);
301 DBPRINTF ("arch_prepare_kprobe: insn %lx", insn[0]);
302 DBPRINTF ("arch_prepare_kprobe: to %p - %lx %lx %lx %lx %lx %lx %lx %lx %lx",
303 p->ainsn.insn, insns[0], insns[1], insns[2], insns[3], insns[4],
304 insns[5], insns[6], insns[7], insns[8]);
305 memcpy (p->ainsn.insn, insns, sizeof(insns));
306 flush_icache_range((long unsigned)p->ainsn.insn, (long unsigned)(p->ainsn.insn) + sizeof(insns));
314 free_insn_slot(&kprobe_insn_pages, NULL, p->ainsn.insn);
315 printk("arch_prepare_kprobe: instruction 0x%lx not instrumentation, addr=0x%p\n", insn[0], p->addr);
321 static unsigned int arch_construct_brunch (unsigned int base, unsigned int addr, int link)
323 kprobe_opcode_t insn;
324 unsigned int bpi = (unsigned int) base - (unsigned int) addr - 8;
327 DBPRINTF ("base=%x addr=%x base-addr-8=%x\n", base, addr, bpi);
328 if (abs (insn & 0xffffff) > 0xffffff)
330 DBPRINTF ("ERROR: kprobe address out of range\n");
333 insn = insn & 0xffffff;
334 insn = insn | ((link != 0) ? 0xeb000000 : 0xea000000);
335 DBPRINTF ("insn=%lX\n", insn);
336 return (unsigned int) insn;
339 int arch_prepare_uretprobe (struct kretprobe *p, struct task_struct *task)
341 DBPRINTF("Warrning: arch_prepare_uretprobe is not implemented\n");
344 EXPORT_SYMBOL_GPL(arch_prepare_uretprobe);
346 void prepare_singlestep (struct kprobe *p, struct pt_regs *regs)
349 regs->ARM_pc = (unsigned long)p->ss_addr;
352 regs->ARM_pc = (unsigned long)p->ainsn.insn;
356 void save_previous_kprobe(struct kprobe_ctlblk *kcb, struct kprobe *p_run)
359 panic("arm_save_previous_kprobe: p_run == NULL\n");
362 if (kcb->prev_kprobe.kp != NULL) {
363 DBPRINTF ("no space to save new probe[]: task = %d/%s", current->pid, current->comm);
366 kcb->prev_kprobe.kp = p_run;
367 kcb->prev_kprobe.status = kcb->kprobe_status;
370 void restore_previous_kprobe(struct kprobe_ctlblk *kcb)
372 set_current_kprobe(kcb->prev_kprobe.kp, NULL, NULL);
373 kcb->kprobe_status = kcb->prev_kprobe.status;
374 kcb->prev_kprobe.kp = NULL;
375 kcb->prev_kprobe.status = 0;
378 void set_current_kprobe(struct kprobe *p, struct pt_regs *regs, struct kprobe_ctlblk *kcb)
380 __get_cpu_var(current_kprobe) = p;
381 DBPRINTF ("set_current_kprobe: p=%p addr=%p\n", p, p->addr);
383 EXPORT_SYMBOL_GPL(set_current_kprobe);
385 #ifdef TRAP_OVERHEAD_DEBUG
386 static unsigned long trap_handler_counter_debug = 0;
387 #define SAMPLING_COUNTER 100000
390 static int kprobe_handler(struct pt_regs *regs)
393 char *msg_out = NULL;
394 kprobe_opcode_t *addr = (kprobe_opcode_t *) (regs->ARM_pc);
396 struct kprobe *p = NULL, *p_run = NULL;
397 int ret = 0, reenter = 0;
398 kprobe_opcode_t *ssaddr = NULL;
399 struct kprobe_ctlblk *kcb;
401 #ifdef SUPRESS_BUG_MESSAGES
402 int swap_oops_in_progress;
403 // oops_in_progress used to avoid BUG() messages that slow down kprobe_handler() execution
404 swap_oops_in_progress = oops_in_progress;
405 oops_in_progress = 1;
407 #ifdef TRAP_OVERHEAD_DEBUG
408 trap_handler_counter_debug++;
409 if ( trap_handler_counter_debug < SAMPLING_COUNTER ) {
413 // XXX NOTE - user must care about catching signal via signal handler to avoid hanging!
414 printk("Trap %ld reached - send SIGUSR1\n", trap_handler_counter_debug);
415 kill_pid(get_task_pid(current, PIDTYPE_PID), SIGUSR1, 1);
416 trap_handler_counter_debug = 0;
421 #ifdef OVERHEAD_DEBUG
422 struct timeval swap_tv1;
423 struct timeval swap_tv2;
424 #define USEC_IN_SEC_NUM 1000000
425 do_gettimeofday(&swap_tv1);
429 p = get_kprobe(addr, 0);
431 /* We're in an interrupt, but this is clear and BUG()-safe. */
432 kcb = get_kprobe_ctlblk ();
434 /* Check we're not actually recursing */
435 // TODO: event is not saving in trace
436 p_run = kprobe_running();
442 if (addr == (kprobe_opcode_t *)kretprobe_trampoline) {
443 save_previous_kprobe(kcb, p_run);
444 kcb->kprobe_status = KPROBE_REENTER;
447 /* We have reentered the kprobe_handler(), since
448 * another probe was hit while within the handler.
449 * We here save the original kprobes variables and
450 * just single step on the instruction of the new probe
451 * without calling any user handlers.
453 kprobes_inc_nmissed_count (p);
454 prepare_singlestep (p, regs);
462 DBPRINTF ("kprobe_running !!! p = 0x%p p->break_handler = 0x%p", p, p->break_handler);
463 /*if (p->break_handler && p->break_handler(p, regs)) {
464 DBPRINTF("kprobe_running !!! goto ss");
467 DBPRINTF ("unknown uprobe at %p cur at %p/%p\n", addr, p->addr, p->ainsn.insn);
468 ssaddr = p->ainsn.insn + KPROBES_TRAMP_SS_BREAK_IDX;
469 if (addr == ssaddr) {
470 regs->ARM_pc = (unsigned long) (p->addr + 1);
471 DBPRINTF ("finish step at %p cur at %p/%p, redirect to %lx\n", addr, p->addr, p->ainsn.insn, regs->ARM_pc);
472 if (kcb->kprobe_status == KPROBE_REENTER) {
473 restore_previous_kprobe(kcb);
475 reset_current_kprobe();
478 DBPRINTF ("kprobe_running !!! goto no");
480 /* If it's not ours, can't be delete race, (we hold lock). */
481 DBPRINTF ("no_kprobe");
488 /* Not one of ours: let kernel handle it */
489 DBPRINTF ("no_kprobe");
493 set_current_kprobe(p, NULL, NULL);
495 kcb->kprobe_status = KPROBE_HIT_ACTIVE;
497 if (p->pre_handler) {
498 ret = p->pre_handler (p, regs);
499 if(p->pre_handler != trampoline_probe_handler) {
500 reset_current_kprobe();
505 /* handler has already set things up, so skip ss setup */
511 msg_out = "no_kprobe\n";
512 err_out = 1; // return with death
516 preempt_enable_no_resched();
517 #ifdef OVERHEAD_DEBUG
518 do_gettimeofday(&swap_tv2);
520 swap_sum_time += ((swap_tv2.tv_sec - swap_tv1.tv_sec) * USEC_IN_SEC_NUM +
521 (swap_tv2.tv_usec - swap_tv1.tv_usec));
523 #ifdef SUPRESS_BUG_MESSAGES
524 oops_in_progress = swap_oops_in_progress;
534 int kprobe_trap_handler(struct pt_regs *regs, unsigned int instr)
538 local_irq_save(flags);
539 ret = kprobe_handler(regs);
540 local_irq_restore(flags);
544 int setjmp_pre_handler (struct kprobe *p, struct pt_regs *regs)
546 struct jprobe *jp = container_of (p, struct jprobe, kp);
547 kprobe_pre_entry_handler_t pre_entry;
551 // p = kprobe_running(regs);
554 DBPRINTF ("pjp = 0x%p jp->entry = 0x%p", jp, jp->entry);
555 entry = (entry_point_t) jp->entry;
556 pre_entry = (kprobe_pre_entry_handler_t) jp->pre_entry;
558 // DIE("entry NULL", regs)
559 DBPRINTF ("entry = 0x%p jp->entry = 0x%p", entry, jp->entry);
561 //call handler for all kernel probes and user space ones which belong to current tgid
562 if (!p->tgid || (p->tgid == current->tgid))
564 if(!p->tgid && ((unsigned int)p->addr == sched_addr) && sched_rp) {
565 struct thread_info *tinfo = (struct thread_info *)regs->ARM_r2;
566 patch_suspended_task(sched_rp, tinfo->task);
569 p->ss_addr = (void *)pre_entry (jp->priv_arg, regs);
571 entry (regs->ARM_r0, regs->ARM_r1, regs->ARM_r2, regs->ARM_r3, regs->ARM_r4, regs->ARM_r5);
575 dbi_arch_uprobe_return ();
577 dbi_jprobe_return ();
581 dbi_arch_uprobe_return ();
583 prepare_singlestep (p, regs);
587 EXPORT_SYMBOL_GPL(setjmp_pre_handler);
589 void dbi_jprobe_return (void)
593 void dbi_arch_uprobe_return (void)
596 EXPORT_SYMBOL_GPL(dbi_arch_uprobe_return);
598 int longjmp_break_handler (struct kprobe *p, struct pt_regs *regs)
601 //kprobe_opcode_t insn = BREAKPOINT_INSTRUCTION;
602 kprobe_opcode_t insns[2];
606 insns[0] = BREAKPOINT_INSTRUCTION;
607 insns[1] = p->opcode;
608 //p->opcode = *p->addr;
609 if (read_proc_vm_atomic (current, (unsigned long) (p->addr), &(p->opcode), sizeof (p->opcode)) < sizeof (p->opcode))
611 printk ("ERROR[%lu]: failed to read vm of proc %s/%u addr %p.", nCount, current->comm, current->pid, p->addr);
614 //*p->addr = BREAKPOINT_INSTRUCTION;
615 //*(p->addr+1) = p->opcode;
616 if (write_proc_vm_atomic (current, (unsigned long) (p->addr), insns, sizeof (insns)) < sizeof (insns))
618 printk ("ERROR[%lu]: failed to write vm of proc %s/%u addr %p.", nCount, current->comm, current->pid, p->addr);
624 DBPRINTF ("p->opcode = 0x%lx *p->addr = 0x%lx p->addr = 0x%p\n", p->opcode, *p->addr, p->addr);
625 *(p->addr + 1) = p->opcode;
626 p->opcode = *p->addr;
627 *p->addr = BREAKPOINT_INSTRUCTION;
629 flush_icache_range ((unsigned int) p->addr, (unsigned int) (((unsigned int) p->addr) + (sizeof (kprobe_opcode_t) * 2)));
632 reset_current_kprobe();
638 EXPORT_SYMBOL_GPL(longjmp_break_handler);
640 void arch_arm_kprobe (struct kprobe *p)
642 *p->addr = BREAKPOINT_INSTRUCTION;
643 flush_icache_range ((unsigned long) p->addr, (unsigned long) p->addr + sizeof (kprobe_opcode_t));
646 void arch_disarm_kprobe (struct kprobe *p)
648 *p->addr = p->opcode;
649 flush_icache_range ((unsigned long) p->addr, (unsigned long) p->addr + sizeof (kprobe_opcode_t));
653 int trampoline_probe_handler (struct kprobe *p, struct pt_regs *regs)
655 struct kretprobe_instance *ri = NULL;
656 struct hlist_head *head;
657 struct hlist_node *node, *tmp;
658 unsigned long flags, orig_ret_address = 0;
659 unsigned long trampoline_address = (unsigned long) &kretprobe_trampoline;
661 struct kretprobe *crp = NULL;
662 struct kprobe_ctlblk *kcb = get_kprobe_ctlblk ();
667 // in case of user space retprobe trampoline is at the Nth instruction of US tramp
668 if (!thumb_mode( regs ))
669 trampoline_address = (unsigned long)(p->ainsn.insn + UPROBES_TRAMP_RET_BREAK_IDX);
671 trampoline_address = (unsigned long)(p->ainsn.insn) + 0x1b;
674 spin_lock_irqsave (&kretprobe_lock, flags);
677 * We are using different hash keys (current and mm) for finding kernel
678 * space and user space probes. Kernel space probes can change mm field in
679 * task_struct. User space probes can be shared between threads of one
680 * process so they have different current but same mm.
683 head = kretprobe_inst_table_head(current->mm);
685 head = kretprobe_inst_table_head(current);
689 * It is possible to have multiple instances associated with a given
690 * task either because an multiple functions in the call path
691 * have a return probe installed on them, and/or more then one
692 * return probe was registered for a target function.
694 * We can handle this because:
695 * - instances are always inserted at the head of the list
696 * - when multiple return probes are registered for the same
697 * function, the first instance's ret_addr will point to the
698 * real return address, and all the rest will point to
699 * kretprobe_trampoline
701 hlist_for_each_entry_safe (ri, node, tmp, head, hlist)
703 if (ri->task != current)
704 /* another task is sharing our hash bucket */
706 if (ri->rp && ri->rp->handler){
707 ri->rp->handler (ri, regs, ri->rp->priv_arg);
710 orig_ret_address = (unsigned long) ri->ret_addr;
711 recycle_rp_inst (ri);
712 if (orig_ret_address != trampoline_address)
714 * This is the real return address. Any other
715 * instances associated with this task are for
716 * other calls deeper on the call stack
720 kretprobe_assert (ri, orig_ret_address, trampoline_address);
721 //BUG_ON(!orig_ret_address || (orig_ret_address == trampoline_address));
722 //E.G. Check this code in case of __switch_to function instrumentation -- currently this code generates dump in this case
723 //if (trampoline_address != (unsigned long) &kretprobe_trampoline){
724 //if (ri->rp2) BUG_ON (ri->rp2->kp.tgid == 0);
725 //if (ri->rp) BUG_ON (ri->rp->kp.tgid == 0);
726 //else if (ri->rp2) BUG_ON (ri->rp2->kp.tgid == 0);
728 if ((ri->rp && ri->rp->kp.tgid) || (ri->rp2 && ri->rp2->kp.tgid))
729 BUG_ON (trampoline_address == (unsigned long) &kretprobe_trampoline);
731 regs->uregs[14] = orig_ret_address;
732 DBPRINTF ("regs->uregs[14] = 0x%lx\n", regs->uregs[14]);
733 DBPRINTF ("regs->uregs[15] = 0x%lx\n", regs->uregs[15]);
735 if (trampoline_address != (unsigned long) &kretprobe_trampoline)
737 regs->uregs[15] = orig_ret_address;
739 if (!thumb_mode( regs )) regs->uregs[15] += 4;
740 else regs->uregs[15] += 2;
743 DBPRINTF ("regs->uregs[15] = 0x%lx\n", regs->uregs[15]);
745 if(p){ // ARM, MIPS, X86 user space
746 if (thumb_mode( regs ) && !(regs->uregs[14] & 0x01))
748 regs->ARM_cpsr &= 0xFFFFFFDF;
750 if (user_mode( regs ) && (regs->uregs[14] & 0x01))
752 regs->ARM_cpsr |= 0x20;
756 //TODO: test - enter function, delete us retprobe, exit function
757 // for user space retprobes only - deferred deletion
759 if (trampoline_address != (unsigned long) &kretprobe_trampoline)
761 // if we are not at the end of the list and current retprobe should be disarmed
764 struct hlist_node *current_node = node;
766 /*sprintf(die_msg, "deferred disarm p->addr = %p [%lx %lx %lx]\n",
767 crp->kp.addr, *kaddrs[0], *kaddrs[1], *kaddrs[2]);
768 DIE(die_msg, regs); */
769 // look for other instances for the same retprobe
770 hlist_for_each_entry_safe (ri, node, tmp, head, hlist)
773 * Trying to find another retprobe instance associated with
776 if (ri->rp2 == crp && node != current_node)
782 // if there are no more instances for this retprobe
784 struct kprobe *is_p = &crp->kp;
785 DBPRINTF ("defered retprobe deletion p->addr = %p", crp->kp.addr);
787 If there is no any retprobe instances of this retprobe
788 we can free the resources related to the probe.
790 if (!(hlist_unhashed(&is_p->is_hlist_arm))) {
791 hlist_del_rcu(&is_p->is_hlist_arm);
793 if (!(hlist_unhashed(&is_p->is_hlist_thumb))) {
794 hlist_del_rcu(&is_p->is_hlist_thumb);
797 dbi_unregister_kprobe(&crp->kp, current);
800 hlist_del(current_node);
804 if (kcb->kprobe_status == KPROBE_REENTER) {
805 restore_previous_kprobe(kcb);
807 reset_current_kprobe();
811 spin_unlock_irqrestore (&kretprobe_lock, flags);
814 * By returning a non-zero value, we are telling
815 * kprobe_handler() that we don't want the post_handler
816 * to run (and have re-enabled preemption)
821 EXPORT_SYMBOL_GPL(trampoline_probe_handler);
823 void __arch_prepare_kretprobe (struct kretprobe *rp, struct pt_regs *regs)
825 struct kretprobe_instance *ri;
827 DBPRINTF ("start\n");
828 //TODO: test - remove retprobe after func entry but before its exit
829 if ((ri = get_free_rp_inst (rp)) != NULL)
834 ri->ret_addr = (kprobe_opcode_t *) regs->uregs[14];
835 ri->sp = (kprobe_opcode_t *)regs->ARM_sp; //uregs[13];
838 if (!thumb_mode( regs ))
839 regs->uregs[14] = (unsigned long) (rp->kp.ainsn.insn + UPROBES_TRAMP_RET_BREAK_IDX);
841 regs->uregs[14] = (unsigned long) (rp->kp.ainsn.insn) + 0x1b;
843 else /* Replace the return addr with trampoline addr */
844 regs->uregs[14] = (unsigned long) &kretprobe_trampoline;
846 // DBPRINTF ("ret addr set to %p->%lx\n", ri->ret_addr, regs->uregs[14]);
850 DBPRINTF ("WARNING: missed retprobe %p\n", rp->kp.addr);
856 int asm_init_module_dependencies(void)
858 //No module dependencies
862 void swap_register_undef_hook(struct undef_hook *hook)
864 __swap_register_undef_hook(hook);
866 EXPORT_SYMBOL_GPL(swap_register_undef_hook);
868 void swap_unregister_undef_hook(struct undef_hook *hook)
870 __swap_unregister_undef_hook(hook);
872 EXPORT_SYMBOL_GPL(swap_unregister_undef_hook);
874 // kernel probes hook
875 static struct undef_hook undef_ho_k = {
876 .instr_mask = 0xffffffff,
877 .instr_val = BREAKPOINT_INSTRUCTION,
878 .cpsr_mask = MODE_MASK,
879 .cpsr_val = SVC_MODE,
880 .fn = kprobe_trap_handler
883 int __init arch_init_kprobes (void)
885 unsigned int do_bp_handler = 0;
888 if (arch_init_module_dependencies())
890 DBPRINTF ("Unable to init module dependencies\n");
894 do_bp_handler = swap_ksyms("do_undefinstr");
895 if (do_bp_handler == 0) {
896 DBPRINTF("no do_undefinstr symbol found!");
899 arr_traps_template[NOTIFIER_CALL_CHAIN_INDEX] = arch_construct_brunch ((unsigned int)kprobe_handler, do_bp_handler + NOTIFIER_CALL_CHAIN_INDEX * 4, 1);
900 // Register hooks (kprobe_handler)
901 __swap_register_undef_hook = swap_ksyms("register_undef_hook");
902 if (__swap_register_undef_hook == NULL) {
903 printk("no register_undef_hook symbol found!\n");
907 // Unregister hooks (kprobe_handler)
908 __swap_unregister_undef_hook = swap_ksyms("unregister_undef_hook");
909 if (__swap_unregister_undef_hook == NULL) {
910 printk("no unregister_undef_hook symbol found!\n");
914 swap_register_undef_hook(&undef_ho_k);
915 if ((ret = dbi_register_kprobe (&trampoline_p)) != 0) {
916 //dbi_unregister_jprobe(&do_exit_p, 0);
922 void __exit dbi_arch_exit_kprobes (void)
924 swap_unregister_undef_hook(&undef_ho_k);
927 //EXPORT_SYMBOL_GPL (dbi_arch_uprobe_return);
928 //EXPORT_SYMBOL_GPL (dbi_arch_exit_kprobes);