2 *------------------------------------------------------------------
3 * stat_client.c - Library for access to VPP statistics segment
5 * Copyright (c) 2018 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
22 #include <sys/types.h>
23 #include <sys/socket.h>
29 #include <vppinfra/vec.h>
30 #include <vppinfra/lock.h>
31 #include <stdatomic.h>
32 #include <vpp/stats/stat_segment.h>
33 #include <vpp-api/client/stat_client.h>
35 stat_client_main_t stat_client_main;
38 stat_client_get (void)
40 stat_client_main_t *sm;
41 sm = (stat_client_main_t *) malloc (sizeof (stat_client_main_t));
42 clib_memset (sm, 0, sizeof (stat_client_main_t));
47 stat_client_free (stat_client_main_t * sm)
55 struct msghdr msg = { 0 };
59 struct iovec io = {.iov_base = iobuf,.iov_len = sizeof (iobuf) };
62 char buf[CMSG_SPACE (sizeof (fd))];
67 msg.msg_control = u.buf;
68 msg.msg_controllen = sizeof (u.buf);
71 if ((size = recvmsg (sock, &msg, 0)) < 0)
73 perror ("recvmsg failed");
76 cmsg = CMSG_FIRSTHDR (&msg);
77 if (cmsg && cmsg->cmsg_level == SOL_SOCKET && cmsg->cmsg_type == SCM_RIGHTS)
79 memmove (&fd, CMSG_DATA (cmsg), sizeof (fd));
84 static stat_segment_directory_entry_t *
85 get_stat_vector_r (stat_client_main_t * sm)
87 ASSERT (sm->shared_header);
88 return stat_segment_adjust (sm,
89 (void *) sm->shared_header->directory_vector);
93 stat_segment_connect_r (const char *socket_name, stat_client_main_t * sm)
98 clib_memset (sm, 0, sizeof (*sm));
99 if ((sock = socket (AF_UNIX, SOCK_SEQPACKET, 0)) < 0)
101 perror ("Stat client couldn't open socket");
105 struct sockaddr_un un = { 0 };
106 un.sun_family = AF_UNIX;
107 strncpy ((char *) un.sun_path, socket_name, sizeof (un.sun_path) - 1);
108 if (connect (sock, (struct sockaddr *) &un, sizeof (struct sockaddr_un)) <
115 if ((mfd = recv_fd (sock)) < 0)
118 fprintf (stderr, "Receiving file descriptor failed\n");
123 /* mmap shared memory segment. */
125 struct stat st = { 0 };
127 if (fstat (mfd, &st) == -1)
130 perror ("mmap fstat failed");
134 mmap (NULL, st.st_size, PROT_READ, MAP_SHARED, mfd, 0)) == MAP_FAILED)
137 perror ("mmap map failed");
142 sm->memory_size = st.st_size;
143 sm->shared_header = memaddr;
144 sm->directory_vector =
145 stat_segment_adjust (sm, (void *) sm->shared_header->directory_vector);
151 stat_segment_connect (const char *socket_name)
153 stat_client_main_t *sm = &stat_client_main;
154 return stat_segment_connect_r (socket_name, sm);
158 stat_segment_disconnect_r (stat_client_main_t * sm)
160 munmap (sm->shared_header, sm->memory_size);
165 stat_segment_disconnect (void)
167 stat_client_main_t *sm = &stat_client_main;
168 return stat_segment_disconnect_r (sm);
172 stat_segment_heartbeat_r (stat_client_main_t * sm)
174 stat_segment_access_t sa;
175 stat_segment_directory_entry_t *ep;
177 /* Has directory been update? */
178 if (sm->shared_header->epoch != sm->current_epoch)
180 if (stat_segment_access_start (&sa, sm))
182 ep = vec_elt_at_index (sm->directory_vector, STAT_COUNTER_HEARTBEAT);
183 if (!stat_segment_access_end (&sa, sm))
189 stat_segment_heartbeat (void)
191 stat_client_main_t *sm = &stat_client_main;
192 return stat_segment_heartbeat_r (sm);
195 #define stat_vec_dup(S,V) \
197 __typeof__ ((V)[0]) * _v(v) = 0; \
198 if (V && ((void *)V > (void *)S->shared_header) && \
199 (((void*)V + vec_bytes(V)) < \
200 ((void *)S->shared_header + S->memory_size))) \
201 _v(v) = vec_dup(V); \
205 static stat_segment_data_t
206 copy_data (stat_segment_directory_entry_t * ep, stat_client_main_t * sm)
208 stat_segment_data_t result = { 0 };
210 vlib_counter_t **combined_c; /* Combined counter */
211 counter_t **simple_c; /* Simple counter */
212 uint64_t *error_vector;
214 assert (sm->shared_header);
216 result.type = ep->type;
217 result.name = strdup (ep->name);
220 case STAT_DIR_TYPE_SCALAR_INDEX:
221 result.scalar_value = ep->value;
224 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
225 simple_c = stat_segment_adjust (sm, ep->data);
226 result.simple_counter_vec = stat_vec_dup (sm, simple_c);
227 for (i = 0; i < vec_len (simple_c); i++)
229 counter_t *cb = stat_segment_adjust (sm, simple_c[i]);
230 result.simple_counter_vec[i] = stat_vec_dup (sm, cb);
234 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
235 combined_c = stat_segment_adjust (sm, ep->data);
236 result.combined_counter_vec = stat_vec_dup (sm, combined_c);
237 for (i = 0; i < vec_len (combined_c); i++)
239 vlib_counter_t *cb = stat_segment_adjust (sm, combined_c[i]);
240 result.combined_counter_vec[i] = stat_vec_dup (sm, cb);
244 case STAT_DIR_TYPE_ERROR_INDEX:
245 /* Gather errors from all threads into a vector */
247 stat_segment_adjust (sm, (void *) sm->shared_header->error_vector);
248 vec_validate (result.error_vector, vec_len (error_vector) - 1);
249 for (i = 0; i < vec_len (error_vector); i++)
251 counter_t *cb = stat_segment_adjust (sm, (void *) error_vector[i]);
252 result.error_vector[i] = cb[ep->index];
256 case STAT_DIR_TYPE_NAME_VECTOR:
258 uint8_t **name_vector = stat_segment_adjust (sm, ep->data);
259 result.name_vector = stat_vec_dup (sm, name_vector);
260 for (i = 0; i < vec_len (name_vector); i++)
262 u8 *name = stat_segment_adjust (sm, name_vector[i]);
263 result.name_vector[i] = stat_vec_dup (sm, name);
268 case STAT_DIR_TYPE_EMPTY:
272 fprintf (stderr, "Unknown type: %d\n", ep->type);
278 stat_segment_data_free (stat_segment_data_t * res)
281 for (i = 0; i < vec_len (res); i++)
285 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
286 for (j = 0; j < vec_len (res[i].simple_counter_vec); j++)
287 vec_free (res[i].simple_counter_vec[j]);
288 vec_free (res[i].simple_counter_vec);
290 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
291 for (j = 0; j < vec_len (res[i].combined_counter_vec); j++)
292 vec_free (res[i].combined_counter_vec[j]);
293 vec_free (res[i].combined_counter_vec);
295 case STAT_DIR_TYPE_NAME_VECTOR:
296 for (j = 0; j < vec_len (res[i].name_vector); j++)
297 vec_free (res[i].name_vector[j]);
298 vec_free (res[i].name_vector);
300 case STAT_DIR_TYPE_ERROR_INDEX:
301 vec_free (res[i].error_vector);
303 case STAT_DIR_TYPE_SCALAR_INDEX:
314 stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm)
316 stat_segment_access_t sa;
319 regex_t regex[vec_len (patterns)];
322 for (i = 0; i < vec_len (patterns); i++)
324 int rv = regcomp (®ex[i], (const char *) patterns[i], 0);
327 fprintf (stderr, "Could not compile regex %s\n", patterns[i]);
332 if (stat_segment_access_start (&sa, sm))
335 stat_segment_directory_entry_t *counter_vec = get_stat_vector_r (sm);
336 for (j = 0; j < vec_len (counter_vec); j++)
338 for (i = 0; i < vec_len (patterns); i++)
340 int rv = regexec (®ex[i], counter_vec[j].name, 0, NULL, 0);
347 if (vec_len (patterns) == 0)
351 for (i = 0; i < vec_len (patterns); i++)
354 if (!stat_segment_access_end (&sa, sm))
356 /* Failed, clean up */
362 /* Update last version */
363 sm->current_epoch = sa.epoch;
368 stat_segment_ls (uint8_t ** patterns)
370 stat_client_main_t *sm = &stat_client_main;
371 return stat_segment_ls_r ((uint8_t **) patterns, sm);
374 stat_segment_data_t *
375 stat_segment_dump_r (uint32_t * stats, stat_client_main_t * sm)
378 stat_segment_directory_entry_t *ep;
379 stat_segment_data_t *res = 0;
380 stat_segment_access_t sa;
382 /* Has directory been update? */
383 if (sm->shared_header->epoch != sm->current_epoch)
386 if (stat_segment_access_start (&sa, sm))
389 for (i = 0; i < vec_len (stats); i++)
391 /* Collect counter */
392 ep = vec_elt_at_index (sm->directory_vector, stats[i]);
393 vec_add1 (res, copy_data (ep, sm));
396 if (stat_segment_access_end (&sa, sm))
399 fprintf (stderr, "Epoch changed while reading, invalid results\n");
400 // TODO increase counter
404 stat_segment_data_t *
405 stat_segment_dump (uint32_t * stats)
407 stat_client_main_t *sm = &stat_client_main;
408 return stat_segment_dump_r (stats, sm);
411 /* Wrapper for accessing vectors from other languages */
413 stat_segment_vec_len (void *vec)
415 return vec_len (vec);
419 stat_segment_vec_free (void *vec)
424 /* Create a vector from a string (or add to existing) */
426 stat_segment_string_vector (uint8_t ** string_vector, const char *string)
429 size_t len = strlen (string);
431 vec_validate_init_c_string (name, string, len);
432 vec_add1 (string_vector, name);
433 return string_vector;
436 stat_segment_data_t *
437 stat_segment_dump_entry_r (uint32_t index, stat_client_main_t * sm)
439 stat_segment_directory_entry_t *ep;
440 stat_segment_data_t *res = 0;
441 stat_segment_access_t sa;
443 if (stat_segment_access_start (&sa, sm))
446 /* Collect counter */
447 ep = vec_elt_at_index (sm->directory_vector, index);
448 vec_add1 (res, copy_data (ep, sm));
450 if (stat_segment_access_end (&sa, sm))
455 stat_segment_data_t *
456 stat_segment_dump_entry (uint32_t index)
458 stat_client_main_t *sm = &stat_client_main;
459 return stat_segment_dump_entry_r (index, sm);
463 stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm)
465 stat_segment_directory_entry_t *ep;
466 stat_segment_access_t sa;
467 stat_segment_directory_entry_t *vec;
469 /* Has directory been update? */
470 if (sm->shared_header->epoch != sm->current_epoch)
472 if (stat_segment_access_start (&sa, sm))
474 vec = get_stat_vector_r (sm);
475 ep = vec_elt_at_index (vec, index);
476 if (!stat_segment_access_end (&sa, sm))
478 return strdup (ep->name);
482 stat_segment_index_to_name (uint32_t index)
484 stat_client_main_t *sm = &stat_client_main;
485 return stat_segment_index_to_name_r (index, sm);
489 stat_segment_version_r (stat_client_main_t * sm)
491 ASSERT (sm->shared_header);
492 return sm->shared_header->version;
496 stat_segment_version (void)
498 stat_client_main_t *sm = &stat_client_main;
499 return stat_segment_version_r (sm);
503 * fd.io coding-style-patch-verification: ON
506 * eval: (c-set-style "gnu")