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 <vlib/vlib.h>
33 #include <vlib/stats/stats.h>
34 #include <vpp-api/client/stat_client.h>
36 stat_client_main_t stat_client_main;
39 stat_client_get (void)
41 stat_client_main_t *sm;
42 sm = (stat_client_main_t *) malloc (sizeof (stat_client_main_t));
43 clib_memset (sm, 0, sizeof (stat_client_main_t));
48 stat_client_free (stat_client_main_t * sm)
56 struct msghdr msg = { 0 };
60 struct iovec io = {.iov_base = iobuf,.iov_len = sizeof (iobuf) };
63 char buf[CMSG_SPACE (sizeof (fd))];
68 msg.msg_control = u.buf;
69 msg.msg_controllen = sizeof (u.buf);
72 if ((size = recvmsg (sock, &msg, 0)) < 0)
74 perror ("recvmsg failed");
77 cmsg = CMSG_FIRSTHDR (&msg);
78 if (cmsg && cmsg->cmsg_level == SOL_SOCKET && cmsg->cmsg_type == SCM_RIGHTS)
80 memmove (&fd, CMSG_DATA (cmsg), sizeof (fd));
85 static vlib_stats_entry_t *
86 get_stat_vector_r (stat_client_main_t *sm)
88 ASSERT (sm->shared_header);
89 return stat_segment_adjust (sm,
90 (void *) sm->shared_header->directory_vector);
94 stat_segment_connect_r (const char *socket_name, stat_client_main_t * sm)
99 clib_memset (sm, 0, sizeof (*sm));
100 if ((sock = socket (AF_UNIX, SOCK_SEQPACKET, 0)) < 0)
102 perror ("Stat client couldn't open socket");
106 struct sockaddr_un un = { 0 };
107 un.sun_family = AF_UNIX;
108 strncpy ((char *) un.sun_path, socket_name, sizeof (un.sun_path) - 1);
109 if (connect (sock, (struct sockaddr *) &un, sizeof (struct sockaddr_un)) <
116 if ((mfd = recv_fd (sock)) < 0)
119 fprintf (stderr, "Receiving file descriptor failed\n");
124 /* mmap shared memory segment. */
126 struct stat st = { 0 };
128 if (fstat (mfd, &st) == -1)
131 perror ("mmap fstat failed");
135 mmap (NULL, st.st_size, PROT_READ, MAP_SHARED, mfd, 0)) == MAP_FAILED)
138 perror ("mmap map failed");
143 sm->memory_size = st.st_size;
144 sm->shared_header = memaddr;
145 sm->directory_vector =
146 stat_segment_adjust (sm, (void *) sm->shared_header->directory_vector);
152 stat_segment_connect (const char *socket_name)
154 stat_client_main_t *sm = &stat_client_main;
155 return stat_segment_connect_r (socket_name, sm);
159 stat_segment_disconnect_r (stat_client_main_t * sm)
161 munmap (sm->shared_header, sm->memory_size);
166 stat_segment_disconnect (void)
168 stat_client_main_t *sm = &stat_client_main;
169 return stat_segment_disconnect_r (sm);
173 stat_segment_heartbeat_r (stat_client_main_t * sm)
175 stat_segment_access_t sa;
176 vlib_stats_entry_t *ep;
178 /* Has directory been updated? */
179 if (sm->shared_header->epoch != sm->current_epoch)
181 if (stat_segment_access_start (&sa, sm))
183 ep = vec_elt_at_index (sm->directory_vector, STAT_COUNTER_HEARTBEAT);
184 if (!stat_segment_access_end (&sa, sm))
190 stat_segment_heartbeat (void)
192 stat_client_main_t *sm = &stat_client_main;
193 return stat_segment_heartbeat_r (sm);
196 #define stat_vec_dup(S,V) \
198 __typeof__ ((V)[0]) * _v(v) = 0; \
199 if (V && ((void *)V > (void *)S->shared_header) && \
200 (((void*)V + vec_bytes(V)) < \
201 ((void *)S->shared_header + S->memory_size))) \
202 _v(v) = vec_dup(V); \
207 stat_vec_simple_init (counter_t c)
214 static vlib_counter_t *
215 stat_vec_combined_init (vlib_counter_t c)
217 vlib_counter_t *v = 0;
223 * If index2 is specified copy out the column (the indexed value across all
224 * threads), otherwise copy out all values.
226 static stat_segment_data_t
227 copy_data (vlib_stats_entry_t *ep, u32 index2, char *name,
228 stat_client_main_t *sm, bool via_symlink)
230 stat_segment_data_t result = { 0 };
232 vlib_counter_t **combined_c; /* Combined counter */
233 counter_t **simple_c; /* Simple counter */
235 assert (sm->shared_header);
237 result.type = ep->type;
238 result.via_symlink = via_symlink;
239 result.name = strdup (name ? name : ep->name);
243 case STAT_DIR_TYPE_SCALAR_INDEX:
244 result.scalar_value = ep->value;
247 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
248 simple_c = stat_segment_adjust (sm, ep->data);
249 result.simple_counter_vec = stat_vec_dup (sm, simple_c);
250 for (i = 0; i < vec_len (simple_c); i++)
252 counter_t *cb = stat_segment_adjust (sm, simple_c[i]);
254 result.simple_counter_vec[i] = stat_vec_simple_init (cb[index2]);
256 result.simple_counter_vec[i] = stat_vec_dup (sm, cb);
260 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
261 combined_c = stat_segment_adjust (sm, ep->data);
262 result.combined_counter_vec = stat_vec_dup (sm, combined_c);
263 for (i = 0; i < vec_len (combined_c); i++)
265 vlib_counter_t *cb = stat_segment_adjust (sm, combined_c[i]);
267 result.combined_counter_vec[i] =
268 stat_vec_combined_init (cb[index2]);
270 result.combined_counter_vec[i] = stat_vec_dup (sm, cb);
274 case STAT_DIR_TYPE_NAME_VECTOR:
276 uint8_t **name_vector = stat_segment_adjust (sm, ep->data);
277 result.name_vector = stat_vec_dup (sm, name_vector);
278 for (i = 0; i < vec_len (name_vector); i++)
280 u8 *name = stat_segment_adjust (sm, name_vector[i]);
281 result.name_vector[i] = stat_vec_dup (sm, name);
286 case STAT_DIR_TYPE_SYMLINK:
287 /* Gather info from all threads into a vector */
289 vlib_stats_entry_t *ep2;
290 ep2 = vec_elt_at_index (sm->directory_vector, ep->index1);
291 /* We do not intend to return the "result", avoid a leak */
293 return copy_data (ep2, ep->index2, ep->name, sm, true);
296 case STAT_DIR_TYPE_EMPTY:
300 fprintf (stderr, "Unknown type: %d\n", ep->type);
306 stat_segment_data_free (stat_segment_data_t * res)
309 for (i = 0; i < vec_len (res); i++)
313 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
314 for (j = 0; j < vec_len (res[i].simple_counter_vec); j++)
315 vec_free (res[i].simple_counter_vec[j]);
316 vec_free (res[i].simple_counter_vec);
318 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
319 for (j = 0; j < vec_len (res[i].combined_counter_vec); j++)
320 vec_free (res[i].combined_counter_vec[j]);
321 vec_free (res[i].combined_counter_vec);
323 case STAT_DIR_TYPE_NAME_VECTOR:
324 for (j = 0; j < vec_len (res[i].name_vector); j++)
325 vec_free (res[i].name_vector[j]);
326 vec_free (res[i].name_vector);
328 case STAT_DIR_TYPE_SCALAR_INDEX:
329 case STAT_DIR_TYPE_EMPTY:
340 stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm)
342 stat_segment_access_t sa;
345 regex_t regex[vec_len (patterns)];
348 for (i = 0; i < vec_len (patterns); i++)
350 int rv = regcomp (®ex[i], (const char *) patterns[i], 0);
353 fprintf (stderr, "Could not compile regex %s\n", patterns[i]);
358 if (stat_segment_access_start (&sa, sm))
361 vlib_stats_entry_t *counter_vec = get_stat_vector_r (sm);
362 for (j = 0; j < vec_len (counter_vec); j++)
364 for (i = 0; i < vec_len (patterns); i++)
366 int rv = regexec (®ex[i], counter_vec[j].name, 0, NULL, 0);
373 if (vec_len (patterns) == 0)
377 for (i = 0; i < vec_len (patterns); i++)
380 if (!stat_segment_access_end (&sa, sm))
382 /* Failed, clean up */
388 /* Update last version */
389 sm->current_epoch = sa.epoch;
394 stat_segment_ls (uint8_t ** patterns)
396 stat_client_main_t *sm = &stat_client_main;
397 return stat_segment_ls_r ((uint8_t **) patterns, sm);
400 stat_segment_data_t *
401 stat_segment_dump_r (uint32_t * stats, stat_client_main_t * sm)
404 vlib_stats_entry_t *ep;
405 stat_segment_data_t *res = 0;
406 stat_segment_access_t sa;
408 /* Has directory been update? */
409 if (sm->shared_header->epoch != sm->current_epoch)
412 if (stat_segment_access_start (&sa, sm))
415 /* preallocate the elements.
416 * This takes care of a special case where
417 * the vec_len(stats) == 0,
418 * such that we return a vector of
419 * length 0, rather than a null pointer
420 * (since null pointer is an error)
422 vec_alloc (res, vec_len (stats));
424 for (i = 0; i < vec_len (stats); i++)
426 /* Collect counter */
427 ep = vec_elt_at_index (sm->directory_vector, stats[i]);
428 vec_add1 (res, copy_data (ep, ~0, 0, sm, false));
431 if (stat_segment_access_end (&sa, sm))
434 fprintf (stderr, "Epoch changed while reading, invalid results\n");
435 // TODO increase counter
437 stat_segment_data_free (res);
441 stat_segment_data_t *
442 stat_segment_dump (uint32_t * stats)
444 stat_client_main_t *sm = &stat_client_main;
445 return stat_segment_dump_r (stats, sm);
448 /* Wrapper for accessing vectors from other languages */
450 stat_segment_vec_len (void *vec)
452 return vec_len (vec);
456 stat_segment_vec_free (void *vec)
461 /* Create a vector from a string (or add to existing) */
463 stat_segment_string_vector (uint8_t ** string_vector, const char *string)
466 size_t len = strlen (string);
468 vec_validate_init_c_string (name, string, len);
469 vec_add1 (string_vector, name);
470 return string_vector;
473 stat_segment_data_t *
474 stat_segment_dump_entry_r (uint32_t index, stat_client_main_t * sm)
476 vlib_stats_entry_t *ep;
477 stat_segment_data_t *res = 0;
478 stat_segment_access_t sa;
480 /* Has directory been update? */
481 if (sm->shared_header->epoch != sm->current_epoch)
484 if (stat_segment_access_start (&sa, sm))
487 /* Collect counter */
488 ep = vec_elt_at_index (sm->directory_vector, index);
489 vec_add1 (res, copy_data (ep, ~0, 0, sm, false));
491 if (stat_segment_access_end (&sa, sm))
496 stat_segment_data_t *
497 stat_segment_dump_entry (uint32_t index)
499 stat_client_main_t *sm = &stat_client_main;
500 return stat_segment_dump_entry_r (index, sm);
504 stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm)
506 vlib_stats_entry_t *ep;
507 stat_segment_access_t sa;
508 vlib_stats_entry_t *vec;
510 /* Has directory been update? */
511 if (sm->shared_header->epoch != sm->current_epoch)
513 if (stat_segment_access_start (&sa, sm))
515 vec = get_stat_vector_r (sm);
516 ep = vec_elt_at_index (vec, index);
517 if (ep->type == STAT_DIR_TYPE_EMPTY)
519 stat_segment_access_end (&sa, sm);
522 if (!stat_segment_access_end (&sa, sm))
524 return strdup (ep->name);
528 stat_segment_index_to_name (uint32_t index)
530 stat_client_main_t *sm = &stat_client_main;
531 return stat_segment_index_to_name_r (index, sm);
535 stat_segment_version_r (stat_client_main_t * sm)
537 ASSERT (sm->shared_header);
538 return sm->shared_header->version;
542 stat_segment_version (void)
544 stat_client_main_t *sm = &stat_client_main;
545 return stat_segment_version_r (sm);
549 * fd.io coding-style-patch-verification: ON
552 * eval: (c-set-style "gnu")