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 // event mask
 123 extern int event_mask;
 124
 125 // process pid to instrument
 126 extern unsigned int inst_pid;
 127
 128 typedef struct
 129 {
 130         char *name;
 131         int installed;
 132         struct jprobe jprobe;
 133         struct kretprobe retprobe;
 134         unsigned long offset;
 135 } us_proc_ip_t;
 136
 137 typedef struct
 138 {
 139         int installed;
 140         struct jprobe jprobe;
 141         unsigned long addr;
 142         struct list_head list;
 143 } us_proc_vtp_t;
 144
 145 typedef struct
 146 {
 147         //char *name;
 148         char type;
 149         unsigned long size;
 150         signed char reg;        // -1 - memory, 0..127 - register number
 151         long off;
 152         struct list_head list;
 153 } us_proc_vtp_data_t;
 154
 155 typedef struct dentry *STRUCT_DENTRY_PTR;
 156 typedef struct vfsmount *STRUCT_VFSMOUNT_PTR;
 157
 158 typedef struct
 159 {
 160         char *path;
 161         STRUCT_DENTRY_PTR m_f_dentry;
 162         STRUCT_VFSMOUNT_PTR m_vfs_mount;
 163         unsigned ips_count;
 164         us_proc_ip_t *p_ips;
 165         unsigned vtps_count;
 166         us_proc_vtp_t *p_vtps;
 167         int loaded;
 168 } us_proc_lib_t;
 169
 170 typedef struct
 171 {
 172         char *path;
 173         STRUCT_DENTRY_PTR m_f_dentry;
 174         pid_t tgid;
 175         unsigned unres_ips_count;
 176         unsigned unres_vtps_count;
 177         //kprobe_opcode_t *mapped_codelets;
 178         unsigned libs_count;
 179         us_proc_lib_t *p_libs;
 180 } inst_us_proc_t;
 181
 182 struct cond {
 183         /* cond data itself */
 184         struct event_tmpl tmpl;
 185         /* linked list */
 186         struct list_head list;
 187         /* has been applied (for start and stop conditions) */
 188         int applied;
 189 };
 190
 191 extern struct cond cond_list;
 192
 193 /* macros for testing flags */
 194 #define ET_FIELD_CLR(flags, field) (flags &= ~field)
 195 #define ET_FIELD_SET(flags, field) (flags |= field)
 196 #define ET_FIELD_ISSET(flags, field) ((flags & field) != 0)
 197
 198 extern inst_us_proc_t us_proc_info;
 199
 200
 201 #endif /* !defined(__STORAGE_H__) */