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 "picl.h"
  22 #include "ec_ioctl.h"
  23 #include "ec_probe.h"
  24 #include "probes_manager.h"
  25 #include "probes.h"
  26 #include "event_tmpl.h"
  27
  28 ///////////////////////////////////////////////////////////////////////////////////////////////////
  29
  30 #ifndef __DISABLE_RELAYFS
  31 extern struct rchan* GetRelayChannel(void);
  32 extern struct dentry* GetRelayDir(void);
  33 #endif //__DISABLE_RELAYFS
  34
  35 extern int EnableMultipleBuffer(void);
  36 extern int DisableMultipleBuffer(void);
  37 extern int EnableContinuousRetrieval(void);
  38 extern int DisableContinuousRetrieval(void);
  39
  40 ///////////////////////////////////////////////////////////////////////////////////////////////////
  41
  42 extern unsigned int GetBufferSize(void);
  43 extern int SetBufferSize(unsigned int nSize);
  44 extern int ResetBuffer(void);
  45
  46 //extern spinlock_t buffer_spinlock;
  47
  48 ///////////////////////////////////////////////////////////////////////////////////////////////////
  49
  50 /*
  51     Functions "storage_init()" and "storage_down()" are for initialization and
  52     shutdown respectively.
  53 */
  54 extern int storage_init (void);
  55 extern void storage_down (void);
  56
  57 /*
  58     Function "pack_event_info()" saves information about event into buffer. It
  59     is used in 'probes' to pack and save event data.
  60 */
  61 extern void pack_event_info (probe_id_t probe_id, record_type_t record_type, const char *fmt, ...);
  62
  63 /* Set most links from us_proc_info to data in the bundle */
  64 int link_bundle();
  65
  66 /* Undo the actions of link_bundle() */
  67 void unlink_bundle();
  68
  69 /*
  70     Adds non-predefined kernel probe to the list.
  71 */
  72 extern int add_probe_to_list (unsigned long addr, kernel_probe_t ** pprobe);
  73
  74 /*
  75     Removes non-predefined kernel probe from the list.
  76 */
  77 extern int remove_probe_from_list (unsigned long addr);
  78
  79 /*
  80     Searches non-predefined kernel probe in the list.
  81 */
  82 extern kernel_probe_t *find_probe (unsigned long addr);
  83
  84 /*
  85     Copies event from user space to buffer and updates its pid/tid/cpu/time.
  86 */
  87 extern int put_us_event (char *data, unsigned long len);
  88
  89 /*
  90     Sets event mask.
  91 */
  92 extern int set_event_mask (int new_mask);
  93
  94 /*
  95     Gets event mask.
  96 */
  97 extern int get_event_mask (int *mask);
  98
  99 /*
 100     Sets predefined user space probes info.
 101 */
 102 extern int set_predef_uprobes (ioctl_predef_uprobes_info_t *data);
 103 /*
 104     Gets predefined user space probes info length.
 105 */
 106 extern int get_predef_uprobes_size(int *size);
 107 /*
 108     Gets predefined user space probes info.
 109 */
 110 extern int get_predef_uprobes(ioctl_predef_uprobes_info_t *data);
 111
 112
 113 // internal bookkeeping of storage
 114 extern char *p_buffer;
 115
 116 // list of selected non-predefined kernel probes
 117 extern struct hlist_head kernel_probes;
 118
 119 // event mask
 120 extern int event_mask;
 121
 122 typedef struct
 123 {
 124         char *name;
 125         int installed;
 126         struct jprobe jprobe;
 127         struct kretprobe retprobe;
 128         unsigned long offset;
 129 } us_proc_ip_t;
 130
 131 typedef struct
 132 {
 133         int installed;
 134         struct jprobe jprobe;
 135         unsigned long addr;
 136         struct list_head list;
 137 } us_proc_vtp_t;
 138
 139 typedef struct
 140 {
 141         //char *name;
 142         char type;
 143         unsigned long size;
 144         signed char reg;        // -1 - memory, 0..127 - register number
 145         long off;
 146         struct list_head list;
 147 } us_proc_vtp_data_t;
 148
 149 typedef struct dentry *STRUCT_DENTRY_PTR;
 150
 151 typedef struct
 152 {
 153         char *path;
 154         STRUCT_DENTRY_PTR m_f_dentry;
 155         unsigned ips_count;
 156         us_proc_ip_t *p_ips;
 157         unsigned vtps_count;
 158         us_proc_vtp_t *p_vtps;
 159         int loaded;
 160 } us_proc_lib_t;
 161
 162 typedef struct
 163 {
 164         char *path;
 165         STRUCT_DENTRY_PTR m_f_dentry;
 166         pid_t tgid;
 167         unsigned unres_ips_count;
 168         unsigned unres_vtps_count;
 169         //kprobe_opcode_t *mapped_codelets;
 170         unsigned libs_count;
 171         us_proc_lib_t *p_libs;
 172 } inst_us_proc_t;
 173
 174 struct cond {
 175         /* cond data itself */
 176         struct event_tmpl tmpl;
 177         /* linked list */
 178         struct list_head list;
 179         /* has been applied (for start and stop conditions) */
 180         int applied;
 181 };
 182
 183 extern struct cond cond_list;
 184
 185 /* macros for testing flags */
 186 #define ET_FIELD_CLR(flags, field) (flags &= ~field)
 187 #define ET_FIELD_SET(flags, field) (flags |= field)
 188 #define ET_FIELD_ISSET(flags, field) ((flags & field) != 0)
 189
 190 extern inst_us_proc_t us_proc_info;
 191
 192
 193 #endif /* !defined(__STORAGE_H__) */