[REFACTOR] remove current_kprobe from swap_uprobe module
[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
375 #ifdef TRAP_OVERHEAD_DEBUG
376 static unsigned long trap_handler_counter_debug = 0;
377 #define SAMPLING_COUNTER                               100000
378 #endif
379
380 static int kprobe_handler(struct pt_regs *regs)
381 {
382         struct kprobe *p, *cur;
383         struct kprobe_ctlblk *kcb;
384
385         kcb = get_kprobe_ctlblk();
386         cur = kprobe_running();
387         p = get_kprobe((kprobe_opcode_t *)regs->ARM_pc, 0);
388
389         if (p) {
390                 if (cur) {
391                         /* Kprobe is pending, so we're recursing. */
392                         switch (kcb->kprobe_status) {
393                         case KPROBE_HIT_ACTIVE:
394                         case KPROBE_HIT_SSDONE:
395                                 /* A pre- or post-handler probe got us here. */
396                                 kprobes_inc_nmissed_count(p);
397                                 save_previous_kprobe(kcb, NULL);
398                                 set_current_kprobe(p, 0, 0);
399                                 kcb->kprobe_status = KPROBE_REENTER;
400                                 prepare_singlestep(p, regs);
401                                 restore_previous_kprobe(kcb);
402                                 break;
403                         default:
404                                 /* impossible cases */
405                                 BUG();
406                         }
407                 } else {
408                         set_current_kprobe(p, 0, 0);
409                         kcb->kprobe_status = KPROBE_HIT_ACTIVE;
410
411                         if (!p->pre_handler || !p->pre_handler(p, regs)) {
412                                 kcb->kprobe_status = KPROBE_HIT_SS;
413                                 prepare_singlestep(p, regs);
414                                 reset_current_kprobe();
415                         }
416                 }
417         } else {
418                 goto no_kprobe;
419         }
420
421         return 0;
422
423 no_kprobe:
424         printk("no_kprobe\n");
425         return 1;
426 }
427
428 int kprobe_trap_handler(struct pt_regs *regs, unsigned int instr)
429 {
430         int ret;
431         unsigned long flags;
432         local_irq_save(flags);
433
434         preempt_disable();
435         ret = kprobe_handler(regs);
436         preempt_enable_no_resched();
437
438         local_irq_restore(flags);
439         return ret;
440 }
441
442 int setjmp_pre_handler(struct kprobe *p, struct pt_regs *regs)
443 {
444         struct jprobe *jp = container_of(p, struct jprobe, kp);
445         kprobe_pre_entry_handler_t pre_entry = (kprobe_pre_entry_handler_t)jp->pre_entry;
446         entry_point_t entry = (entry_point_t)jp->entry;
447         pre_entry = (kprobe_pre_entry_handler_t)jp->pre_entry;
448
449         if (p->tgid) {
450                 panic("setjmp_pre_handler: p->tgid == 0");
451         }
452
453         if (((unsigned long)p->addr == sched_addr) && sched_rp) {
454                 struct thread_info *tinfo = (struct thread_info *)regs->ARM_r2;
455                 patch_suspended_task(sched_rp, tinfo->task);
456         }
457
458         if (pre_entry) {
459                 p->ss_addr = (void *)pre_entry (jp->priv_arg, regs);
460         }
461
462         if (entry) {
463                 entry(regs->ARM_r0, regs->ARM_r1, regs->ARM_r2,
464                       regs->ARM_r3, regs->ARM_r4, regs->ARM_r5);
465         } else {
466                 dbi_jprobe_return();
467         }
468
469         return 0;
470 }
471
472 void dbi_jprobe_return (void)
473 {
474 }
475
476 void dbi_arch_uprobe_return (void)
477 {
478 }
479 EXPORT_SYMBOL_GPL(dbi_arch_uprobe_return);
480
481 int longjmp_break_handler (struct kprobe *p, struct pt_regs *regs)
482 {
483 # ifndef REENTER
484         //kprobe_opcode_t insn = BREAKPOINT_INSTRUCTION;
485         kprobe_opcode_t insns[2];
486
487         if (p->pid)
488         {
489                 insns[0] = BREAKPOINT_INSTRUCTION;
490                 insns[1] = p->opcode;
491                 //p->opcode = *p->addr;
492                 if (read_proc_vm_atomic (current, (unsigned long) (p->addr), &(p->opcode), sizeof (p->opcode)) < sizeof (p->opcode))
493                 {
494                         printk ("ERROR[%lu]: failed to read vm of proc %s/%u addr %p.", nCount, current->comm, current->pid, p->addr);
495                         return -1;
496                 }
497                 //*p->addr = BREAKPOINT_INSTRUCTION;
498                 //*(p->addr+1) = p->opcode;
499                 if (write_proc_vm_atomic (current, (unsigned long) (p->addr), insns, sizeof (insns)) < sizeof (insns))
500                 {
501                         printk ("ERROR[%lu]: failed to write vm of proc %s/%u addr %p.", nCount, current->comm, current->pid, p->addr);
502                         return -1;
503                 }
504         }
505         else
506         {
507                 DBPRINTF ("p->opcode = 0x%lx *p->addr = 0x%lx p->addr = 0x%p\n", p->opcode, *p->addr, p->addr);
508                 *(p->addr + 1) = p->opcode;
509                 p->opcode = *p->addr;
510                 *p->addr = BREAKPOINT_INSTRUCTION;
511
512                 flush_icache_range ((unsigned int) p->addr, (unsigned int) (((unsigned int) p->addr) + (sizeof (kprobe_opcode_t) * 2)));
513         }
514
515         reset_current_kprobe();
516
517 #endif //REENTER
518
519         return 0;
520 }
521 EXPORT_SYMBOL_GPL(longjmp_break_handler);
522
523 void arch_arm_kprobe (struct kprobe *p)
524 {
525         *p->addr = BREAKPOINT_INSTRUCTION;
526         flush_icache_range ((unsigned long) p->addr, (unsigned long) p->addr + sizeof (kprobe_opcode_t));
527 }
528
529 void arch_disarm_kprobe (struct kprobe *p)
530 {
531         *p->addr = p->opcode;
532         flush_icache_range ((unsigned long) p->addr, (unsigned long) p->addr + sizeof (kprobe_opcode_t));
533 }
534
535
536 int trampoline_probe_handler (struct kprobe *p, struct pt_regs *regs)
537 {
538         struct kretprobe_instance *ri = NULL;
539         struct hlist_head *head;
540         struct hlist_node *node, *tmp;
541         unsigned long flags, orig_ret_address = 0;
542         unsigned long trampoline_address = (unsigned long) &kretprobe_trampoline;
543
544         struct kretprobe *crp = NULL;
545         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk ();
546
547         DBPRINTF ("start");
548
549         if (p && p->tgid){
550                 // in case of user space retprobe trampoline is at the Nth instruction of US tramp
551                 if (!thumb_mode( regs ))
552                         trampoline_address = (unsigned long)(p->ainsn.insn + UPROBES_TRAMP_RET_BREAK_IDX);
553                 else
554                         trampoline_address = (unsigned long)(p->ainsn.insn) + 0x1b;
555         }
556
557         spin_lock_irqsave (&kretprobe_lock, flags);
558
559         /*
560          * We are using different hash keys (current and mm) for finding kernel
561          * space and user space probes.  Kernel space probes can change mm field in
562          * task_struct.  User space probes can be shared between threads of one
563          * process so they have different current but same mm.
564          */
565         if (p && p->tgid) {
566                 head = kretprobe_inst_table_head(current->mm);
567         } else {
568                 head = kretprobe_inst_table_head(current);
569         }
570
571         /*
572          * It is possible to have multiple instances associated with a given
573          * task either because an multiple functions in the call path
574          * have a return probe installed on them, and/or more then one
575          * return probe was registered for a target function.
576          *
577          * We can handle this because:
578          *     - instances are always inserted at the head of the list
579          *     - when multiple return probes are registered for the same
580          *       function, the first instance's ret_addr will point to the
581          *       real return address, and all the rest will point to
582          *       kretprobe_trampoline
583          */
584         hlist_for_each_entry_safe (ri, node, tmp, head, hlist)
585         {
586                 if (ri->task != current)
587                         /* another task is sharing our hash bucket */
588                         continue;
589                 if (ri->rp && ri->rp->handler){
590                         ri->rp->handler (ri, regs, ri->rp->priv_arg);
591                 }
592
593                 orig_ret_address = (unsigned long) ri->ret_addr;
594                 recycle_rp_inst (ri);
595                 if (orig_ret_address != trampoline_address)
596                         /*
597                          * This is the real return address. Any other
598                          * instances associated with this task are for
599                          * other calls deeper on the call stack
600                          */
601                         break;
602         }
603         kretprobe_assert (ri, orig_ret_address, trampoline_address);
604         //BUG_ON(!orig_ret_address || (orig_ret_address == trampoline_address));
605         //E.G. Check this code in case of __switch_to function instrumentation -- currently this code generates dump in this case
606         //if (trampoline_address != (unsigned long) &kretprobe_trampoline){
607         //if (ri->rp2) BUG_ON (ri->rp2->kp.tgid == 0);
608         //if (ri->rp) BUG_ON (ri->rp->kp.tgid == 0);
609         //else if (ri->rp2) BUG_ON (ri->rp2->kp.tgid == 0);
610         //}
611         if ((ri->rp && ri->rp->kp.tgid) || (ri->rp2 && ri->rp2->kp.tgid))
612                 BUG_ON (trampoline_address == (unsigned long) &kretprobe_trampoline);
613
614         regs->uregs[14] = orig_ret_address;
615         DBPRINTF ("regs->uregs[14] = 0x%lx\n", regs->uregs[14]);
616         DBPRINTF ("regs->uregs[15] = 0x%lx\n", regs->uregs[15]);
617
618         if (trampoline_address != (unsigned long) &kretprobe_trampoline)
619         {
620                 regs->uregs[15] = orig_ret_address;
621         }else{
622                 if (!thumb_mode( regs )) regs->uregs[15] += 4;
623                 else regs->uregs[15] += 2;
624         }
625
626         DBPRINTF ("regs->uregs[15] = 0x%lx\n", regs->uregs[15]);
627
628         if(p){ // ARM, MIPS, X86 user space
629                 if (thumb_mode( regs ) && !(regs->uregs[14] & 0x01))
630                 {
631                         regs->ARM_cpsr &= 0xFFFFFFDF;
632                 }else{
633                         if (user_mode( regs ) && (regs->uregs[14] & 0x01))
634                         {
635                                 regs->ARM_cpsr |= 0x20;
636                         }
637                 }
638
639                 //TODO: test - enter function, delete us retprobe, exit function
640                 // for user space retprobes only - deferred deletion
641
642                 if (trampoline_address != (unsigned long) &kretprobe_trampoline)
643                 {
644                         // if we are not at the end of the list and current retprobe should be disarmed
645                         if (node && ri->rp2)
646                         {
647                                 struct hlist_node *current_node = node;
648                                 crp = ri->rp2;
649                                 /*sprintf(die_msg, "deferred disarm p->addr = %p [%lx %lx %lx]\n",
650                                   crp->kp.addr, *kaddrs[0], *kaddrs[1], *kaddrs[2]);
651                                   DIE(die_msg, regs); */
652                                 // look for other instances for the same retprobe
653                                 hlist_for_each_entry_safe (ri, node, tmp, head, hlist)
654                                 {
655                                         /*
656                                          * Trying to find another retprobe instance associated with
657                                          * the same retprobe.
658                                          */
659                                         if (ri->rp2 == crp && node != current_node)
660                                                 break;
661                                 }
662
663                                 if (!node)
664                                 {
665                                         // if there are no more instances for this retprobe
666                                         // delete retprobe
667                                         struct kprobe *is_p = &crp->kp;
668                                         DBPRINTF ("defered retprobe deletion p->addr = %p", crp->kp.addr);
669                                         /*
670                                           If there is no any retprobe instances of this retprobe
671                                           we can free the resources related to the probe.
672                                          */
673                                         if (!(hlist_unhashed(&is_p->is_hlist_arm))) {
674                                                 hlist_del_rcu(&is_p->is_hlist_arm);
675                                         }
676                                         if (!(hlist_unhashed(&is_p->is_hlist_thumb))) {
677                                                 hlist_del_rcu(&is_p->is_hlist_thumb);
678                                         }
679
680                                         dbi_unregister_kprobe(&crp->kp, current);
681                                         kfree (crp);
682                                 }
683                                 hlist_del(current_node);
684                         }
685                 }
686
687                 if (kcb->kprobe_status == KPROBE_REENTER) {
688                         restore_previous_kprobe(kcb);
689                 } else {
690                         reset_current_kprobe();
691                 }
692         }
693
694         spin_unlock_irqrestore (&kretprobe_lock, flags);
695
696         /*
697          * By returning a non-zero value, we are telling
698          * kprobe_handler() that we don't want the post_handler
699          * to run (and have re-enabled preemption)
700          */
701
702         return 1;
703 }
704 EXPORT_SYMBOL_GPL(trampoline_probe_handler);
705
706 void  __arch_prepare_kretprobe (struct kretprobe *rp, struct pt_regs *regs)
707 {
708         struct kretprobe_instance *ri;
709
710         DBPRINTF ("start\n");
711         //TODO: test - remove retprobe after func entry but before its exit
712         if ((ri = get_free_rp_inst (rp)) != NULL)
713         {
714                 ri->rp = rp;
715                 ri->rp2 = NULL;
716                 ri->task = current;
717                 ri->ret_addr = (kprobe_opcode_t *) regs->uregs[14];
718                 ri->sp = (kprobe_opcode_t *)regs->ARM_sp; //uregs[13];
719
720                 /* Set flag of current mode */
721                 ri->sp = (kprobe_opcode_t *)((long)ri->sp | !!thumb_mode(regs));
722
723                 if (rp->kp.tgid) {
724                         panic("__arch_prepare_kretprobe: rp->kp.tgid != 0");
725                 }
726
727                 /* Replace the return addr with trampoline addr */
728                 regs->uregs[14] = (unsigned long) &kretprobe_trampoline;
729
730 //              DBPRINTF ("ret addr set to %p->%lx\n", ri->ret_addr, regs->uregs[14]);
731                 add_rp_inst (ri);
732         }
733         else {
734                 DBPRINTF ("WARNING: missed retprobe %p\n", rp->kp.addr);
735                 rp->nmissed++;
736         }
737 }
738
739
740 int asm_init_module_dependencies(void)
741 {
742         //No module dependencies
743         return 0;
744 }
745
746 void swap_register_undef_hook(struct undef_hook *hook)
747 {
748         __swap_register_undef_hook(hook);
749 }
750 EXPORT_SYMBOL_GPL(swap_register_undef_hook);
751
752 void swap_unregister_undef_hook(struct undef_hook *hook)
753 {
754         __swap_unregister_undef_hook(hook);
755 }
756 EXPORT_SYMBOL_GPL(swap_unregister_undef_hook);
757
758 // kernel probes hook
759 static struct undef_hook undef_ho_k = {
760     .instr_mask = 0xffffffff,
761     .instr_val  = BREAKPOINT_INSTRUCTION,
762     .cpsr_mask  = MODE_MASK,
763     .cpsr_val   = SVC_MODE,
764     .fn         = kprobe_trap_handler
765 };
766
767 int __init arch_init_kprobes (void)
768 {
769         unsigned int do_bp_handler = 0;
770         int ret = 0;
771
772         if (arch_init_module_dependencies())
773         {
774                 DBPRINTF ("Unable to init module dependencies\n");
775                 return -1;
776         }
777
778         do_bp_handler = swap_ksyms("do_undefinstr");
779         if (do_bp_handler == 0) {
780                 DBPRINTF("no do_undefinstr symbol found!");
781                 return -1;
782         }
783         arr_traps_template[NOTIFIER_CALL_CHAIN_INDEX] = arch_construct_brunch ((unsigned int)kprobe_handler, do_bp_handler + NOTIFIER_CALL_CHAIN_INDEX * 4, 1);
784         // Register hooks (kprobe_handler)
785         __swap_register_undef_hook = swap_ksyms("register_undef_hook");
786         if (__swap_register_undef_hook == NULL) {
787                 printk("no register_undef_hook symbol found!\n");
788                 return -1;
789         }
790
791         // Unregister hooks (kprobe_handler)
792         __swap_unregister_undef_hook = swap_ksyms("unregister_undef_hook");
793         if (__swap_unregister_undef_hook == NULL) {
794                 printk("no unregister_undef_hook symbol found!\n");
795                 return -1;
796         }
797
798         swap_register_undef_hook(&undef_ho_k);
799         if ((ret = dbi_register_kprobe (&trampoline_p)) != 0) {
800                 //dbi_unregister_jprobe(&do_exit_p, 0);
801                 return ret;
802         }
803         return ret;
804 }
805
806 void __exit dbi_arch_exit_kprobes (void)
807 {
808         swap_unregister_undef_hook(&undef_ho_k);
809 }
810
811 //EXPORT_SYMBOL_GPL (dbi_arch_uprobe_return);
812 //EXPORT_SYMBOL_GPL (dbi_arch_exit_kprobes);