Merge branch 'swap_rename' into dev
[kernel/swap-modules.git] / driver / storage.h
1 ////////////////////////////////////////////////////////////////////////////////////
2 //
3 //      FILE:           storage.h
4 //
5 //      DESCRIPTION:
6 //      This file is C source for SWAP.
7 //
8 //      SEE ALSO:       storage.c
9 //      AUTHOR:         L.Komkov, S.Dianov, A.Gerenkov
10 //      COMPANY NAME:   Samsung Research Center in Moscow
11 //      DEPT NAME:      Advanced Software Group 
12 //      CREATED:        2008.02.15
13 //      VERSION:        1.0
14 //      REVISION DATE:  2008.12.03
15 //
16 ////////////////////////////////////////////////////////////////////////////////////
17
18 #if !defined(__STORAGE_H__)
19 #define __STORAGE_H__
20
21 #include <linux/mount.h>
22 #include "picl.h"
23 #include "ec_ioctl.h"
24 #include "ec_probe.h"
25 #include "probes_manager.h"
26 #include "probes.h"
27 #include "event_tmpl.h"
28
29 ///////////////////////////////////////////////////////////////////////////////////////////////////
30
31 #ifndef __DISABLE_RELAYFS
32 extern struct rchan* GetRelayChannel(void);
33 extern struct dentry* GetRelayDir(void);
34 #endif //__DISABLE_RELAYFS
35
36 extern int EnableMultipleBuffer(void);
37 extern int DisableMultipleBuffer(void);
38 extern int EnableContinuousRetrieval(void);
39 extern int DisableContinuousRetrieval(void);
40
41 ///////////////////////////////////////////////////////////////////////////////////////////////////
42
43 extern unsigned int GetBufferSize(void);
44 extern int SetBufferSize(unsigned int nSize);
45 extern int ResetBuffer(void);
46
47 extern int SetPid(unsigned int pid);
48
49 //extern spinlock_t buffer_spinlock;
50
51 ///////////////////////////////////////////////////////////////////////////////////////////////////
52
53 /*
54     Functions "storage_init()" and "storage_down()" are for initialization and
55     shutdown respectively.
56 */
57 extern int storage_init (void);
58 extern void storage_down (void);
59
60 /*
61     Function "pack_event_info()" saves information about event into buffer. It
62     is used in 'probes' to pack and save event data.
63 */
64 extern void pack_event_info (probe_id_t probe_id, record_type_t record_type, const char *fmt, ...);
65
66 /* Set most links from us_proc_info to data in the bundle */
67 int link_bundle(void);
68
69 /* Undo the actions of link_bundle() */
70 void unlink_bundle(void);
71
72 /*
73     Adds non-predefined kernel probe to the list.
74 */
75 extern int add_probe_to_list (unsigned long addr, kernel_probe_t ** pprobe);
76
77 /*
78     Removes non-predefined kernel probe from the list.
79 */
80 extern int remove_probe_from_list (unsigned long addr);
81
82 /*
83     Searches non-predefined kernel probe in the list.
84 */
85 extern kernel_probe_t *find_probe (unsigned long addr);
86
87 /*
88     Copies event from user space to buffer and updates its pid/tid/cpu/time.
89 */
90 extern int put_us_event (char *data, unsigned long len);
91
92 /*
93     Sets event mask.
94 */
95 extern int set_event_mask (int new_mask);
96
97 /*
98     Gets event mask.
99 */
100 extern int get_event_mask (int *mask);
101
102 /*
103     Sets predefined user space probes info.
104 */
105 extern int set_predef_uprobes (ioctl_predef_uprobes_info_t *data);
106 /*
107     Gets predefined user space probes info length.
108 */
109 extern int get_predef_uprobes_size(int *size);
110 /*
111     Gets predefined user space probes info.
112 */
113 extern int get_predef_uprobes(ioctl_predef_uprobes_info_t *data);
114
115
116 // internal bookkeeping of storage
117 extern char *p_buffer;
118
119 // list of selected non-predefined kernel probes
120 extern struct hlist_head kernel_probes;
121
122 extern struct list_head otg_us_proc_info;
123
124 // event mask
125 extern int event_mask;
126
127 // process pid to instrument
128 extern unsigned int inst_pid;
129
130 typedef struct
131 {
132         char *name;
133         int installed;
134         struct jprobe jprobe;
135         struct kretprobe retprobe;
136         unsigned long offset;
137 } us_proc_ip_t;
138
139 typedef struct
140 {
141         us_proc_ip_t ip;
142         pid_t tgid;
143         struct list_head list;
144 } us_proc_otg_ip_t;
145
146 typedef struct
147 {
148         int installed;
149         struct jprobe jprobe;
150         unsigned long addr;
151         struct list_head list;
152 } us_proc_vtp_t;
153
154 typedef struct
155 {
156         //char *name;
157         char type;
158         unsigned long size;
159         signed char reg;        // -1 - memory, 0..127 - register number  
160         long off;
161         struct list_head list;
162 } us_proc_vtp_data_t;
163
164 typedef struct dentry *STRUCT_DENTRY_PTR;
165 typedef struct vfsmount *STRUCT_VFSMOUNT_PTR;
166
167 typedef struct
168 {
169         char *path;
170         STRUCT_DENTRY_PTR m_f_dentry;
171         STRUCT_VFSMOUNT_PTR m_vfs_mount;
172         unsigned ips_count;
173         us_proc_ip_t *p_ips;
174         unsigned vtps_count;
175         us_proc_vtp_t *p_vtps;
176         int loaded;
177 } us_proc_lib_t;
178
179 typedef struct
180 {
181         char *path;
182         STRUCT_DENTRY_PTR m_f_dentry;
183         pid_t tgid;
184         unsigned unres_ips_count;
185         unsigned unres_vtps_count;
186         //kprobe_opcode_t *mapped_codelets;
187         unsigned libs_count;
188         us_proc_lib_t *p_libs;
189 } inst_us_proc_t;
190
191 typedef struct
192 {
193         unsigned int addr;
194         unsigned int inst_type;
195         char *name;
196         char *class_name;
197         char *method_name;
198         char *prototype;
199
200 }dex_proc_ip_t;
201
202 typedef struct
203 {
204         char *path;
205         unsigned ips_count;
206         dex_proc_ip_t *p_ips;
207
208 }inst_dex_proc_t;
209
210
211 struct cond {
212         /* cond data itself */
213         struct event_tmpl tmpl;
214         /* linked list */
215         struct list_head list;
216         /* has been applied (for start and stop conditions) */
217         int applied;
218 };
219
220 extern struct cond cond_list;
221
222 /* macros for testing flags */
223 #define ET_FIELD_CLR(flags, field) (flags &= ~field)
224 #define ET_FIELD_SET(flags, field) (flags |= field)
225 #define ET_FIELD_ISSET(flags, field) ((flags & field) != 0)
226
227 extern inst_us_proc_t us_proc_info;
228 extern inst_dex_proc_t dex_proc_info;
229
230 #endif /* !defined(__STORAGE_H__) */