[REFACTOR] create pre_handler_uretprobe()
[kernel/swap-modules.git] / kprobe / arch / asm-arm / dbi_kprobes.c
1 /*
2  *  Dynamic Binary Instrumentation Module based on KProbes
3  *  modules/kprobe/arch/asm-arm/dbi_kprobes.c
4  *
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.
9  *
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.
14  *
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.
18  *
19  * Copyright (C) Samsung Electronics, 2006-2010
20  *
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
30  */
31
32 #include <linux/module.h>
33 #include <linux/mm.h>
34
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"
40
41 #include "../../dbi_kdebug.h"
42 #include "../../dbi_insn_slots.h"
43 #include "../../dbi_kprobes_deps.h"
44 #include <ksyms.h>
45
46 #include <asm/cacheflush.h>
47
48 #ifdef TRAP_OVERHEAD_DEBUG
49 #include <linux/pid.h>
50 #include <linux/signal.h>
51 #endif
52
53 #ifdef OVERHEAD_DEBUG
54 #include <linux/time.h>
55 #endif
56
57 #include <asm/traps.h>
58 #include <asm/ptrace.h>
59 #include <linux/list.h>
60 #include <linux/hash.h>
61
62 #define SUPRESS_BUG_MESSAGES
63
64 extern struct kprobe * per_cpu__current_kprobe;
65 extern struct hlist_head kprobe_table[KPROBE_TABLE_SIZE];
66
67 static void (*__swap_register_undef_hook)(struct undef_hook *hook);
68 static void (*__swap_unregister_undef_hook)(struct undef_hook *hook);
69
70 #ifdef OVERHEAD_DEBUG
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);
75 #endif
76
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
81                 0x00000000,    // b
82                 0xe3500000,    // cmp          r0, #0  ; 0x0
83                 0xe89da800,    // ldmia        sp, {fp, sp, pc}
84                 0x00000000,    // nop
85                 0xffffffff     // end
86 };
87
88
89 static struct kprobe trampoline_p =
90 {
91         .addr = (kprobe_opcode_t *) & kretprobe_trampoline,
92         .pre_handler = trampoline_probe_handler
93 };
94
95 int prep_pc_dep_insn_execbuf(kprobe_opcode_t *insns, kprobe_opcode_t insn, int uregs)
96 {
97         int i;
98
99         if (uregs & 0x10)
100         {
101                 int reg_mask = 0x1;
102                 //search in reg list
103                 for (i = 0; i < 13; i++, reg_mask <<= 1)
104                 {
105                         if (!(insn & reg_mask))
106                                 break;
107                 }
108         }
109         else
110         {
111                 for (i = 0; i < 13; i++)
112                 {
113                         if ((uregs & 0x1) && (ARM_INSN_REG_RN (insn) == i))
114                                 continue;
115                         if ((uregs & 0x2) && (ARM_INSN_REG_RD (insn) == i))
116                                 continue;
117                         if ((uregs & 0x4) && (ARM_INSN_REG_RS (insn) == i))
118                                 continue;
119                         if ((uregs & 0x8) && (ARM_INSN_REG_RM (insn) == i))
120                                 continue;
121                         break;
122                 }
123         }
124         if (i == 13)
125         {
126                 DBPRINTF ("there are no free register %x in insn %lx!", uregs, insn);
127                 return -EINVAL;
128         }
129         DBPRINTF ("prep_pc_dep_insn_execbuf: using R%d, changing regs %x", i, uregs);
130
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
136         if (uregs & 0x10)
137         {
138                 ARM_INSN_REG_CLEAR_MR (insn, 15);
139                 ARM_INSN_REG_SET_MR (insn, i);
140         }
141         else
142         {
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);
151         }
152         insns[UPROBES_TRAMP_INSN_IDX] = insn;
153         // set register to restore
154         ARM_INSN_REG_SET_RD (insns[3], i);
155         return 0;
156 }
157 EXPORT_SYMBOL_GPL(prep_pc_dep_insn_execbuf);
158
159 int arch_check_insn_arm(struct arch_specific_insn *ainsn)
160 {
161         int ret = 0;
162
163         // check instructions that can change PC by nature
164         if (
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]))
174         {
175                 DBPRINTF ("Bad insn arch_check_insn_arm: %lx\n", ainsn->insn_arm[0]);
176                 ret = -EFAULT;
177         }
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))
186         {
187                 DBPRINTF ("Bad arch_check_insn_arm: %lx\n", ainsn->insn_arm[0]);
188                 ret = -EFAULT;
189         }
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))))
197         {
198                 DBPRINTF ("Bad insn arch_check_insn_arm: %lx\n", ainsn->insn_arm[0]);
199                 ret = -EFAULT;
200         }
201         return ret;
202 }
203 EXPORT_SYMBOL_GPL(arch_check_insn_arm);
204
205 int arch_prepare_kretprobe (struct kretprobe *p)
206 {
207         DBPRINTF("Warrning: arch_prepare_kretprobe is not implemented\n");
208         return 0;
209 }
210
211 int arch_prepare_kprobe (struct kprobe *p)
212 {
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;
217
218     /* insn: must be on special executable page on i386. */
219     p->ainsn.insn = get_insn_slot(NULL, &kprobe_insn_pages, 0);
220     if (!p->ainsn.insn)
221         return -ENOMEM;
222
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);
226     if (!ret)
227     {
228         p->opcode = *p->addr;
229         uregs = pc_dep = 0;
230
231         // Rn, Rm ,Rd
232         if(ARM_INSN_MATCH (DPIS, insn[0]) || ARM_INSN_MATCH (LRO, insn[0]) ||
233            ARM_INSN_MATCH (SRO, insn[0]))
234         {
235             uregs = 0xb;
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)) )
238             {
239                 DBPRINTF ("Unboostable insn %lx, DPIS/LRO/SRO\n", insn[0]);
240                 pc_dep = 1;
241             }
242         }
243         // Rn ,Rd
244         else if(ARM_INSN_MATCH (DPI, insn[0]) || ARM_INSN_MATCH (LIO, insn[0]) ||
245                 ARM_INSN_MATCH (SIO, insn[0]))
246         {
247             uregs = 0x3;
248             if ((ARM_INSN_REG_RN (insn[0]) == 15) || (ARM_INSN_MATCH (SIO, insn[0]) &&
249                         (ARM_INSN_REG_RD (insn[0]) == 15)))
250             {
251                 pc_dep = 1;
252                 DBPRINTF ("Unboostable insn %lx/%p, DPI/LIO/SIO\n", insn[0], p);
253             }
254         }
255         // Rn, Rm, Rs
256         else if(ARM_INSN_MATCH (DPRS, insn[0]))
257         {
258             uregs = 0xd;
259             if ((ARM_INSN_REG_RN (insn[0]) == 15) || (ARM_INSN_REG_RM (insn[0]) == 15) ||
260                 (ARM_INSN_REG_RS (insn[0]) == 15))
261             {
262                 pc_dep = 1;
263                 DBPRINTF ("Unboostable insn %lx, DPRS\n", insn[0]);
264             }
265         }
266         // register list
267         else if(ARM_INSN_MATCH (SM, insn[0]))
268         {
269             uregs = 0x10;
270             if (ARM_INSN_REG_MR (insn[0], 15))
271             {
272                 DBPRINTF ("Unboostable insn %lx, SM\n", insn[0]);
273                 pc_dep = 1;
274             }
275         }
276         // check instructions that can write result to SP andu uses PC
277         if (pc_dep  && (ARM_INSN_REG_RD (ainsn.insn[0]) == 13))
278         {
279             free_insn_slot(&kprobe_insn_pages, NULL, p->ainsn.insn);
280             ret = -EFAULT;
281         }
282         else
283         {
284             if (uregs && pc_dep)
285             {
286                 memcpy (insns, pc_dep_insn_execbuf, sizeof (insns));
287                 if (prep_pc_dep_insn_execbuf (insns, insn[0], uregs) != 0)
288                 {
289                     DBPRINTF ("failed to prepare exec buffer for insn %lx!", insn[0]);
290                     free_insn_slot(&kprobe_insn_pages, NULL, p->ainsn.insn);
291                     return -EINVAL;
292                 }
293                 insns[6] = (kprobe_opcode_t) (p->addr + 2);
294             }
295             else
296             {
297                 memcpy (insns, gen_insn_execbuf, sizeof (insns));
298                 insns[KPROBES_TRAMP_INSN_IDX] = insn[0];
299             }
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));
307 #ifdef BOARD_tegra
308             flush_cache_all();
309 #endif
310         }
311     }
312     else
313     {
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);
316     }
317
318     return ret;
319 }
320
321 static unsigned int arch_construct_brunch (unsigned int base, unsigned int addr, int link)
322 {
323         kprobe_opcode_t insn;
324         unsigned int bpi = (unsigned int) base - (unsigned int) addr - 8;
325
326         insn = bpi >> 2;
327         DBPRINTF ("base=%x addr=%x base-addr-8=%x\n", base, addr, bpi);
328         if (abs (insn & 0xffffff) > 0xffffff)
329         {
330                 DBPRINTF ("ERROR: kprobe address out of range\n");
331                 BUG ();
332         }
333         insn = insn & 0xffffff;
334         insn = insn | ((link != 0) ? 0xeb000000 : 0xea000000);
335         DBPRINTF ("insn=%lX\n", insn);
336         return (unsigned int) insn;
337 }
338
339 int arch_prepare_uretprobe (struct kretprobe *p, struct task_struct *task)
340 {
341         DBPRINTF("Warrning: arch_prepare_uretprobe is not implemented\n");
342         return 0;
343 }
344 EXPORT_SYMBOL_GPL(arch_prepare_uretprobe);
345
346 void prepare_singlestep (struct kprobe *p, struct pt_regs *regs)
347 {
348         if (p->ss_addr) {
349                 regs->ARM_pc = (unsigned long)p->ss_addr;
350                 p->ss_addr = NULL;
351         } else {
352                 regs->ARM_pc = (unsigned long)p->ainsn.insn;
353         }
354 }
355 EXPORT_SYMBOL_GPL(prepare_singlestep);
356
357 void save_previous_kprobe(struct kprobe_ctlblk *kcb, struct kprobe *p_run)
358 {
359         kcb->prev_kprobe.kp = kprobe_running();
360         kcb->prev_kprobe.status = kcb->kprobe_status;
361 }
362
363 void restore_previous_kprobe(struct kprobe_ctlblk *kcb)
364 {
365         __get_cpu_var(current_kprobe) = kcb->prev_kprobe.kp;
366         kcb->kprobe_status = kcb->prev_kprobe.status;
367 }
368
369 void set_current_kprobe(struct kprobe *p, struct pt_regs *regs, struct kprobe_ctlblk *kcb)
370 {
371         __get_cpu_var(current_kprobe) = p;
372         DBPRINTF ("set_current_kprobe: p=%p addr=%p\n", p, p->addr);
373 }
374 EXPORT_SYMBOL_GPL(set_current_kprobe);
375
376 #ifdef TRAP_OVERHEAD_DEBUG
377 static unsigned long trap_handler_counter_debug = 0;
378 #define SAMPLING_COUNTER                               100000
379 #endif
380
381 static int kprobe_handler(struct pt_regs *regs)
382 {
383         struct kprobe *p, *cur;
384         struct kprobe_ctlblk *kcb;
385
386         kcb = get_kprobe_ctlblk();
387         cur = kprobe_running();
388         p = get_kprobe((kprobe_opcode_t *)regs->ARM_pc, 0);
389
390         if (p) {
391                 if (cur) {
392                         /* Kprobe is pending, so we're recursing. */
393                         switch (kcb->kprobe_status) {
394                         case KPROBE_HIT_ACTIVE:
395                         case KPROBE_HIT_SSDONE:
396                                 /* A pre- or post-handler probe got us here. */
397                                 kprobes_inc_nmissed_count(p);
398                                 save_previous_kprobe(kcb, NULL);
399                                 set_current_kprobe(p, 0, 0);
400                                 kcb->kprobe_status = KPROBE_REENTER;
401                                 prepare_singlestep(p, regs);
402                                 restore_previous_kprobe(kcb);
403                                 break;
404                         default:
405                                 /* impossible cases */
406                                 BUG();
407                         }
408                 } else {
409                         set_current_kprobe(p, 0, 0);
410                         kcb->kprobe_status = KPROBE_HIT_ACTIVE;
411
412                         if (!p->pre_handler || !p->pre_handler(p, regs)) {
413                                 kcb->kprobe_status = KPROBE_HIT_SS;
414                                 prepare_singlestep(p, regs);
415                                 reset_current_kprobe();
416                         }
417                 }
418         } else {
419                 goto no_kprobe;
420         }
421
422         return 0;
423
424 no_kprobe:
425         printk("no_kprobe\n");
426         return 1;
427 }
428
429 int kprobe_trap_handler(struct pt_regs *regs, unsigned int instr)
430 {
431         int ret;
432         unsigned long flags;
433         local_irq_save(flags);
434
435         preempt_disable();
436         ret = kprobe_handler(regs);
437         preempt_enable_no_resched();
438
439         local_irq_restore(flags);
440         return ret;
441 }
442
443 int setjmp_pre_handler(struct kprobe *p, struct pt_regs *regs)
444 {
445         struct jprobe *jp = container_of(p, struct jprobe, kp);
446         kprobe_pre_entry_handler_t pre_entry = (kprobe_pre_entry_handler_t)jp->pre_entry;
447         entry_point_t entry = (entry_point_t)jp->entry;
448         pre_entry = (kprobe_pre_entry_handler_t)jp->pre_entry;
449
450         if (p->tgid) {
451                 panic("setjmp_pre_handler: p->tgid == 0");
452         }
453
454         if (((unsigned long)p->addr == sched_addr) && sched_rp) {
455                 struct thread_info *tinfo = (struct thread_info *)regs->ARM_r2;
456                 patch_suspended_task(sched_rp, tinfo->task);
457         }
458
459         if (pre_entry) {
460                 p->ss_addr = (void *)pre_entry (jp->priv_arg, regs);
461         }
462
463         if (entry) {
464                 entry(regs->ARM_r0, regs->ARM_r1, regs->ARM_r2,
465                       regs->ARM_r3, regs->ARM_r4, regs->ARM_r5);
466         } else {
467                 dbi_jprobe_return();
468         }
469
470         return 0;
471 }
472
473 void dbi_jprobe_return (void)
474 {
475 }
476
477 void dbi_arch_uprobe_return (void)
478 {
479 }
480 EXPORT_SYMBOL_GPL(dbi_arch_uprobe_return);
481
482 int longjmp_break_handler (struct kprobe *p, struct pt_regs *regs)
483 {
484 # ifndef REENTER
485         //kprobe_opcode_t insn = BREAKPOINT_INSTRUCTION;
486         kprobe_opcode_t insns[2];
487
488         if (p->pid)
489         {
490                 insns[0] = BREAKPOINT_INSTRUCTION;
491                 insns[1] = p->opcode;
492                 //p->opcode = *p->addr;
493                 if (read_proc_vm_atomic (current, (unsigned long) (p->addr), &(p->opcode), sizeof (p->opcode)) < sizeof (p->opcode))
494                 {
495                         printk ("ERROR[%lu]: failed to read vm of proc %s/%u addr %p.", nCount, current->comm, current->pid, p->addr);
496                         return -1;
497                 }
498                 //*p->addr = BREAKPOINT_INSTRUCTION;
499                 //*(p->addr+1) = p->opcode;
500                 if (write_proc_vm_atomic (current, (unsigned long) (p->addr), insns, sizeof (insns)) < sizeof (insns))
501                 {
502                         printk ("ERROR[%lu]: failed to write vm of proc %s/%u addr %p.", nCount, current->comm, current->pid, p->addr);
503                         return -1;
504                 }
505         }
506         else
507         {
508                 DBPRINTF ("p->opcode = 0x%lx *p->addr = 0x%lx p->addr = 0x%p\n", p->opcode, *p->addr, p->addr);
509                 *(p->addr + 1) = p->opcode;
510                 p->opcode = *p->addr;
511                 *p->addr = BREAKPOINT_INSTRUCTION;
512
513                 flush_icache_range ((unsigned int) p->addr, (unsigned int) (((unsigned int) p->addr) + (sizeof (kprobe_opcode_t) * 2)));
514         }
515
516         reset_current_kprobe();
517
518 #endif //REENTER
519
520         return 0;
521 }
522 EXPORT_SYMBOL_GPL(longjmp_break_handler);
523
524 void arch_arm_kprobe (struct kprobe *p)
525 {
526         *p->addr = BREAKPOINT_INSTRUCTION;
527         flush_icache_range ((unsigned long) p->addr, (unsigned long) p->addr + sizeof (kprobe_opcode_t));
528 }
529
530 void arch_disarm_kprobe (struct kprobe *p)
531 {
532         *p->addr = p->opcode;
533         flush_icache_range ((unsigned long) p->addr, (unsigned long) p->addr + sizeof (kprobe_opcode_t));
534 }
535
536
537 int trampoline_probe_handler (struct kprobe *p, struct pt_regs *regs)
538 {
539         struct kretprobe_instance *ri = NULL;
540         struct hlist_head *head;
541         struct hlist_node *node, *tmp;
542         unsigned long flags, orig_ret_address = 0;
543         unsigned long trampoline_address = (unsigned long) &kretprobe_trampoline;
544
545         struct kretprobe *crp = NULL;
546         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk ();
547
548         DBPRINTF ("start");
549
550         if (p && p->tgid){
551                 // in case of user space retprobe trampoline is at the Nth instruction of US tramp
552                 if (!thumb_mode( regs ))
553                         trampoline_address = (unsigned long)(p->ainsn.insn + UPROBES_TRAMP_RET_BREAK_IDX);
554                 else
555                         trampoline_address = (unsigned long)(p->ainsn.insn) + 0x1b;
556         }
557
558         spin_lock_irqsave (&kretprobe_lock, flags);
559
560         /*
561          * We are using different hash keys (current and mm) for finding kernel
562          * space and user space probes.  Kernel space probes can change mm field in
563          * task_struct.  User space probes can be shared between threads of one
564          * process so they have different current but same mm.
565          */
566         if (p && p->tgid) {
567                 head = kretprobe_inst_table_head(current->mm);
568         } else {
569                 head = kretprobe_inst_table_head(current);
570         }
571
572         /*
573          * It is possible to have multiple instances associated with a given
574          * task either because an multiple functions in the call path
575          * have a return probe installed on them, and/or more then one
576          * return probe was registered for a target function.
577          *
578          * We can handle this because:
579          *     - instances are always inserted at the head of the list
580          *     - when multiple return probes are registered for the same
581          *       function, the first instance's ret_addr will point to the
582          *       real return address, and all the rest will point to
583          *       kretprobe_trampoline
584          */
585         hlist_for_each_entry_safe (ri, node, tmp, head, hlist)
586         {
587                 if (ri->task != current)
588                         /* another task is sharing our hash bucket */
589                         continue;
590                 if (ri->rp && ri->rp->handler){
591                         ri->rp->handler (ri, regs, ri->rp->priv_arg);
592                 }
593
594                 orig_ret_address = (unsigned long) ri->ret_addr;
595                 recycle_rp_inst (ri);
596                 if (orig_ret_address != trampoline_address)
597                         /*
598                          * This is the real return address. Any other
599                          * instances associated with this task are for
600                          * other calls deeper on the call stack
601                          */
602                         break;
603         }
604         kretprobe_assert (ri, orig_ret_address, trampoline_address);
605         //BUG_ON(!orig_ret_address || (orig_ret_address == trampoline_address));
606         //E.G. Check this code in case of __switch_to function instrumentation -- currently this code generates dump in this case
607         //if (trampoline_address != (unsigned long) &kretprobe_trampoline){
608         //if (ri->rp2) BUG_ON (ri->rp2->kp.tgid == 0);
609         //if (ri->rp) BUG_ON (ri->rp->kp.tgid == 0);
610         //else if (ri->rp2) BUG_ON (ri->rp2->kp.tgid == 0);
611         //}
612         if ((ri->rp && ri->rp->kp.tgid) || (ri->rp2 && ri->rp2->kp.tgid))
613                 BUG_ON (trampoline_address == (unsigned long) &kretprobe_trampoline);
614
615         regs->uregs[14] = orig_ret_address;
616         DBPRINTF ("regs->uregs[14] = 0x%lx\n", regs->uregs[14]);
617         DBPRINTF ("regs->uregs[15] = 0x%lx\n", regs->uregs[15]);
618
619         if (trampoline_address != (unsigned long) &kretprobe_trampoline)
620         {
621                 regs->uregs[15] = orig_ret_address;
622         }else{
623                 if (!thumb_mode( regs )) regs->uregs[15] += 4;
624                 else regs->uregs[15] += 2;
625         }
626
627         DBPRINTF ("regs->uregs[15] = 0x%lx\n", regs->uregs[15]);
628
629         if(p){ // ARM, MIPS, X86 user space
630                 if (thumb_mode( regs ) && !(regs->uregs[14] & 0x01))
631                 {
632                         regs->ARM_cpsr &= 0xFFFFFFDF;
633                 }else{
634                         if (user_mode( regs ) && (regs->uregs[14] & 0x01))
635                         {
636                                 regs->ARM_cpsr |= 0x20;
637                         }
638                 }
639
640                 //TODO: test - enter function, delete us retprobe, exit function
641                 // for user space retprobes only - deferred deletion
642
643                 if (trampoline_address != (unsigned long) &kretprobe_trampoline)
644                 {
645                         // if we are not at the end of the list and current retprobe should be disarmed
646                         if (node && ri->rp2)
647                         {
648                                 struct hlist_node *current_node = node;
649                                 crp = ri->rp2;
650                                 /*sprintf(die_msg, "deferred disarm p->addr = %p [%lx %lx %lx]\n",
651                                   crp->kp.addr, *kaddrs[0], *kaddrs[1], *kaddrs[2]);
652                                   DIE(die_msg, regs); */
653                                 // look for other instances for the same retprobe
654                                 hlist_for_each_entry_safe (ri, node, tmp, head, hlist)
655                                 {
656                                         /*
657                                          * Trying to find another retprobe instance associated with
658                                          * the same retprobe.
659                                          */
660                                         if (ri->rp2 == crp && node != current_node)
661                                                 break;
662                                 }
663
664                                 if (!node)
665                                 {
666                                         // if there are no more instances for this retprobe
667                                         // delete retprobe
668                                         struct kprobe *is_p = &crp->kp;
669                                         DBPRINTF ("defered retprobe deletion p->addr = %p", crp->kp.addr);
670                                         /*
671                                           If there is no any retprobe instances of this retprobe
672                                           we can free the resources related to the probe.
673                                          */
674                                         if (!(hlist_unhashed(&is_p->is_hlist_arm))) {
675                                                 hlist_del_rcu(&is_p->is_hlist_arm);
676                                         }
677                                         if (!(hlist_unhashed(&is_p->is_hlist_thumb))) {
678                                                 hlist_del_rcu(&is_p->is_hlist_thumb);
679                                         }
680
681                                         dbi_unregister_kprobe(&crp->kp, current);
682                                         kfree (crp);
683                                 }
684                                 hlist_del(current_node);
685                         }
686                 }
687
688                 if (kcb->kprobe_status == KPROBE_REENTER) {
689                         restore_previous_kprobe(kcb);
690                 } else {
691                         reset_current_kprobe();
692                 }
693         }
694
695         spin_unlock_irqrestore (&kretprobe_lock, flags);
696
697         /*
698          * By returning a non-zero value, we are telling
699          * kprobe_handler() that we don't want the post_handler
700          * to run (and have re-enabled preemption)
701          */
702
703         return 1;
704 }
705 EXPORT_SYMBOL_GPL(trampoline_probe_handler);
706
707 void  __arch_prepare_kretprobe (struct kretprobe *rp, struct pt_regs *regs)
708 {
709         struct kretprobe_instance *ri;
710
711         DBPRINTF ("start\n");
712         //TODO: test - remove retprobe after func entry but before its exit
713         if ((ri = get_free_rp_inst (rp)) != NULL)
714         {
715                 ri->rp = rp;
716                 ri->rp2 = NULL;
717                 ri->task = current;
718                 ri->ret_addr = (kprobe_opcode_t *) regs->uregs[14];
719                 ri->sp = (kprobe_opcode_t *)regs->ARM_sp; //uregs[13];
720
721                 if (rp->kp.tgid) {
722                         panic("__arch_prepare_kretprobe: rp->kp.tgid != 0");
723                 }
724
725                 /* Replace the return addr with trampoline addr */
726                 regs->uregs[14] = (unsigned long) &kretprobe_trampoline;
727
728 //              DBPRINTF ("ret addr set to %p->%lx\n", ri->ret_addr, regs->uregs[14]);
729                 add_rp_inst (ri);
730         }
731         else {
732                 DBPRINTF ("WARNING: missed retprobe %p\n", rp->kp.addr);
733                 rp->nmissed++;
734         }
735 }
736
737
738 int asm_init_module_dependencies(void)
739 {
740         //No module dependencies
741         return 0;
742 }
743
744 void swap_register_undef_hook(struct undef_hook *hook)
745 {
746         __swap_register_undef_hook(hook);
747 }
748 EXPORT_SYMBOL_GPL(swap_register_undef_hook);
749
750 void swap_unregister_undef_hook(struct undef_hook *hook)
751 {
752         __swap_unregister_undef_hook(hook);
753 }
754 EXPORT_SYMBOL_GPL(swap_unregister_undef_hook);
755
756 // kernel probes hook
757 static struct undef_hook undef_ho_k = {
758     .instr_mask = 0xffffffff,
759     .instr_val  = BREAKPOINT_INSTRUCTION,
760     .cpsr_mask  = MODE_MASK,
761     .cpsr_val   = SVC_MODE,
762     .fn         = kprobe_trap_handler
763 };
764
765 int __init arch_init_kprobes (void)
766 {
767         unsigned int do_bp_handler = 0;
768         int ret = 0;
769
770         if (arch_init_module_dependencies())
771         {
772                 DBPRINTF ("Unable to init module dependencies\n");
773                 return -1;
774         }
775
776         do_bp_handler = swap_ksyms("do_undefinstr");
777         if (do_bp_handler == 0) {
778                 DBPRINTF("no do_undefinstr symbol found!");
779                 return -1;
780         }
781         arr_traps_template[NOTIFIER_CALL_CHAIN_INDEX] = arch_construct_brunch ((unsigned int)kprobe_handler, do_bp_handler + NOTIFIER_CALL_CHAIN_INDEX * 4, 1);
782         // Register hooks (kprobe_handler)
783         __swap_register_undef_hook = swap_ksyms("register_undef_hook");
784         if (__swap_register_undef_hook == NULL) {
785                 printk("no register_undef_hook symbol found!\n");
786                 return -1;
787         }
788
789         // Unregister hooks (kprobe_handler)
790         __swap_unregister_undef_hook = swap_ksyms("unregister_undef_hook");
791         if (__swap_unregister_undef_hook == NULL) {
792                 printk("no unregister_undef_hook symbol found!\n");
793                 return -1;
794         }
795
796         swap_register_undef_hook(&undef_ho_k);
797         if ((ret = dbi_register_kprobe (&trampoline_p)) != 0) {
798                 //dbi_unregister_jprobe(&do_exit_p, 0);
799                 return ret;
800         }
801         return ret;
802 }
803
804 void __exit dbi_arch_exit_kprobes (void)
805 {
806         swap_unregister_undef_hook(&undef_ho_k);
807 }
808
809 //EXPORT_SYMBOL_GPL (dbi_arch_uprobe_return);
810 //EXPORT_SYMBOL_GPL (dbi_arch_exit_kprobes);