3 from __future__ import print_function
9 typedef uint64_t counter_t;
16 STAT_DIR_TYPE_ILLEGAL = 0,
17 STAT_DIR_TYPE_SCALAR_INDEX,
18 STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE,
19 STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED,
20 STAT_DIR_TYPE_ERROR_INDEX,
21 STAT_DIR_TYPE_NAME_VECTOR,
22 } stat_directory_type_t;
26 stat_directory_type_t type;
32 uint64_t offset_vector;
33 char name[128]; // TODO change this to pointer to "somewhere"
34 } stat_segment_directory_entry_t;
39 stat_directory_type_t type;
43 counter_t *error_vector;
44 counter_t **simple_counter_vec;
45 vlib_counter_t **combined_counter_vec;
46 uint8_t **name_vector;
48 } stat_segment_data_t;
54 uint64_t directory_offset;
55 uint64_t error_offset;
56 uint64_t stats_offset;
57 } stat_segment_shared_header_t;
61 uint64_t current_epoch;
62 stat_segment_shared_header_t *shared_header;
63 stat_segment_directory_entry_t *directory_vector;
67 stat_client_main_t * stat_client_get(void);
68 void stat_client_free(stat_client_main_t * sm);
69 int stat_segment_connect_r (char *socket_name, stat_client_main_t * sm);
70 int stat_segment_connect (char *socket_name);
71 void stat_segment_disconnect_r (stat_client_main_t * sm);
72 void stat_segment_disconnect (void);
74 uint32_t *stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm);
75 uint32_t *stat_segment_ls (uint8_t ** pattern);
76 stat_segment_data_t *stat_segment_dump_r (uint32_t * stats, stat_client_main_t * sm);
77 stat_segment_data_t *stat_segment_dump (uint32_t * counter_vec);
78 void stat_segment_data_free (stat_segment_data_t * res);
80 double stat_segment_heartbeat_r (stat_client_main_t * sm);
81 int stat_segment_vec_len(void *vec);
82 uint8_t **stat_segment_string_vector(uint8_t **string_vector, char *string);
83 char *stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm);
89 def make_string_vector(api, strings):
91 if type(strings) is not list:
94 vec = api.stat_segment_string_vector(vec, ffi.new("char []",
99 def make_string_list(api, vec):
100 vec_len = api.stat_segment_vec_len(vec)
101 return [ffi.string(vec[i]) for i in range(vec_len)]
104 # 2-dimensonal array of thread, index
105 def simple_counter_vec_list(api, e):
107 for thread in range(api.stat_segment_vec_len(e)):
108 len_interfaces = api.stat_segment_vec_len(e[thread])
109 if_per_thread = [e[thread][interfaces]
110 for interfaces in range(len_interfaces)]
111 vec.append(if_per_thread)
115 def vlib_counter_dict(c):
116 return {'packets': c.packets,
120 def combined_counter_vec_list(api, e):
122 for thread in range(api.stat_segment_vec_len(e)):
123 len_interfaces = api.stat_segment_vec_len(e[thread])
124 if_per_thread = [vlib_counter_dict(e[thread][interfaces])
125 for interfaces in range(len_interfaces)]
126 vec.append(if_per_thread)
129 def error_vec_list(api, e):
131 for thread in range(api.stat_segment_vec_len(e)):
132 vec.append(e[thread])
135 def name_vec_list(api, e):
136 return [ffi.string(e[i]).decode('utf-8') for i in range(api.stat_segment_vec_len(e)) if e[i] != ffi.NULL]
138 def stat_entry_to_python(api, e):
141 return e.scalar_value
143 return simple_counter_vec_list(api, e.simple_counter_vec)
145 return combined_counter_vec_list(api, e.combined_counter_vec)
147 return error_vec_list(api, e.error_vector)
149 return name_vec_list(api, e.name_vector)
150 raise NotImplementedError()
153 class VPPStatsIOError(IOError):
154 message = "Stat segment client connection returned: " \
155 "%(retval)s %(strerror)s."
157 strerror = {-1: "Stat client couldn't open socket",
158 -2: "Stat client socket open but couldn't connect",
159 -3: "Receiving file descriptor failed",
160 -4: "mmap fstat failed",
161 -5: "mmap map failed"
164 def __init__(self, message=None, **kwargs):
165 if 'retval' in kwargs:
166 self.retval = kwargs['retval']
167 kwargs['strerror'] = self.strerror[int(self.retval)]
171 message = self.message % kwargs
172 except Exception as e:
173 message = self.message
175 message = message % kwargs
177 super(VPPStatsIOError, self).__init__(message)
180 class VPPStatsClientLoadError(RuntimeError):
184 class VPPStats(object):
185 VPPStatsIOError = VPPStatsIOError
187 default_socketname = '/var/run/vpp/stats.sock'
188 sharedlib_name = 'libvppapiclient.so'
190 def __init__(self, socketname=default_socketname, timeout=10):
192 self.api = ffi.dlopen(VPPStats.sharedlib_name)
194 raise VPPStatsClientLoadError("Could not open: %s" %
195 VPPStats.sharedlib_name)
196 self.client = self.api.stat_client_get()
198 poll_end_time = time.time() + timeout
199 while time.time() < poll_end_time:
200 rv = self.api.stat_segment_connect_r(socketname.encode('utf-8'),
202 # Break out if success or any other error than "no such file"
203 # (indicating that VPP hasn't started yet)
204 if rv == 0 or ffi.errno != 2:
208 raise VPPStatsIOError(retval=rv)
211 return self.api.stat_segment_heartbeat_r(self.client)
213 def ls(self, patterns):
214 return self.api.stat_segment_ls_r(make_string_vector(self.api,
218 def lsstr(self, patterns):
219 rv = self.api.stat_segment_ls_r(make_string_vector(self.api,
224 raise VPPStatsIOError()
225 return [ffi.string(self.api.stat_segment_index_to_name_r(rv[i], self.client)).decode('utf-8')
226 for i in range(self.api.stat_segment_vec_len(rv))]
228 def dump(self, counters):
230 rv = self.api.stat_segment_dump_r(counters, self.client)
231 # Raise exception and retry
233 raise VPPStatsIOError()
234 rv_len = self.api.stat_segment_vec_len(rv)
236 for i in range(rv_len):
237 n = ffi.string(rv[i].name).decode('utf-8')
238 e = stat_entry_to_python(self.api, rv[i])
243 def get_counter(self, name):
250 raise AttributeError('Matches multiple counters {}'
254 except VPPStatsIOError as e:
259 def get_err_counter(self, name):
260 """Get an error counter. The errors from each worker thread
262 return sum(self.get_counter(name))
264 def disconnect(self):
265 self.api.stat_segment_disconnect_r(self.client)
266 self.api.stat_client_free(self.client)
268 def set_errors(self):
269 '''Return all errors counters > 0'''
273 error_names = self.ls(['/err/'])
274 error_counters = self.dump(error_names)
276 except VPPStatsIOError as e:
281 return {k: sum(error_counters[k])
282 for k in error_counters.keys() if sum(error_counters[k])}
284 def set_errors_str(self):
285 '''Return all errors counters > 0 pretty printed'''
287 error_counters = self.set_errors()
288 for k in sorted(error_counters):
289 s += '{:<60}{:>10}\n'.format(k, error_counters[k])