[STYLE] Uprobe: doxygen comments
[kernel/swap-modules.git] / uprobe / arch / asm-arm / swap_uprobes.h
1 /**
2  * @file uprobe/arch/asm-arm/swap_uprobes.h
3  * @author Alexey Gerenkov <a.gerenkov@samsung.com> User-Space Probes initial
4  * implementation; Support x86/ARM/MIPS for both user and kernel spaces.
5  * @author Ekaterina Gorelkina <e.gorelkina@samsung.com>: redesign module for
6  * separating core and arch parts
7  *
8  * @section LICENSE
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23  *
24  * @section COPYRIGHT
25  *
26  * Copyright (C) Samsung Electronics, 2006-2010
27  *
28  * @section DESCRIPTION
29  *
30  * Arch-dependent uprobe interface declaration.
31  */
32
33
34 #ifndef _ARM_SWAP_UPROBES_H
35 #define _ARM_SWAP_UPROBES_H
36
37
38 struct kprobe;
39 struct task_struct;
40 struct uprobe;
41 struct uretprobe;
42 struct uretprobe_instance;
43
44 /**
45  * @struct arch_specific_tramp
46  * @brief Stores arch-dependent trampolines.
47  */
48 struct arch_specific_tramp {
49         unsigned long tramp_arm[UPROBES_TRAMP_LEN];     /**< ARM trampoline */
50         unsigned long tramp_thumb[UPROBES_TRAMP_LEN];   /**< Thumb trampoline */
51         void *utramp;                               /**< Pointer to trampoline */
52 };
53
54
55 static inline u32 swap_get_urp_float(struct pt_regs *regs)
56 {
57         return regs->ARM_r0;
58 }
59
60 static inline u64 swap_get_urp_double(struct pt_regs *regs)
61 {
62
63         return regs->ARM_r0 | (u64)regs->ARM_r1 << 32;
64 }
65
66 static inline void arch_ujprobe_return(void)
67 {
68 }
69
70 int arch_prepare_uprobe(struct uprobe *up);
71
72 int setjmp_upre_handler(struct kprobe *p, struct pt_regs *regs);
73 static inline int longjmp_break_uhandler(struct kprobe *p, struct pt_regs *regs)
74 {
75         return 0;
76 }
77
78 void arch_opcode_analysis_uretprobe(struct uretprobe *rp);
79 void arch_prepare_uretprobe(struct uretprobe_instance *ri, struct pt_regs *regs);
80 int arch_disarm_urp_inst(struct uretprobe_instance *ri,
81                          struct task_struct *task);
82
83 unsigned long arch_get_trampoline_addr(struct kprobe *p, struct pt_regs *regs);
84 void arch_set_orig_ret_addr(unsigned long orig_ret_addr, struct pt_regs *regs);
85 void arch_remove_uprobe(struct uprobe *up);
86
87 static inline unsigned long swap_get_uarg(struct pt_regs *regs, unsigned long n)
88 {
89         u32 *ptr, addr = 0;
90
91         switch (n) {
92         case 0:
93                 return regs->ARM_r0;
94         case 1:
95                 return regs->ARM_r1;
96         case 2:
97                 return regs->ARM_r2;
98         case 3:
99                 return regs->ARM_r3;
100         }
101
102         ptr = (u32 *)regs->ARM_sp + n - 4;
103         if (get_user(addr, ptr))
104                 printk("failed to dereference a pointer, ptr=%p\n", ptr);
105
106         return addr;
107 }
108
109 int swap_arch_init_uprobes(void);
110 void swap_arch_exit_uprobes(void);
111
112 #endif /* _ARM_SWAP_UPROBES_H */