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 updated? */
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); \
206 stat_vec_simple_init (counter_t c)
213 static vlib_counter_t *
214 stat_vec_combined_init (vlib_counter_t c)
216 vlib_counter_t *v = 0;
222 * If index2 is specified copy out the column (the indexed value across all
223 * threads), otherwise copy out all values.
225 static stat_segment_data_t
226 copy_data (stat_segment_directory_entry_t *ep, u32 index2, char *name,
227 stat_client_main_t *sm)
229 stat_segment_data_t result = { 0 };
231 vlib_counter_t **combined_c; /* Combined counter */
232 counter_t **simple_c; /* Simple counter */
233 uint64_t *error_vector;
235 assert (sm->shared_header);
237 result.type = ep->type;
238 result.name = strdup (name ? name : ep->name);
242 case STAT_DIR_TYPE_SCALAR_INDEX:
243 result.scalar_value = ep->value;
246 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
247 simple_c = stat_segment_adjust (sm, ep->data);
248 result.simple_counter_vec = stat_vec_dup (sm, simple_c);
249 for (i = 0; i < vec_len (simple_c); i++)
251 counter_t *cb = stat_segment_adjust (sm, simple_c[i]);
253 result.simple_counter_vec[i] = stat_vec_simple_init (cb[index2]);
255 result.simple_counter_vec[i] = stat_vec_dup (sm, cb);
259 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
260 combined_c = stat_segment_adjust (sm, ep->data);
261 result.combined_counter_vec = stat_vec_dup (sm, combined_c);
262 for (i = 0; i < vec_len (combined_c); i++)
264 vlib_counter_t *cb = stat_segment_adjust (sm, combined_c[i]);
266 result.combined_counter_vec[i] =
267 stat_vec_combined_init (cb[index2]);
269 result.combined_counter_vec[i] = stat_vec_dup (sm, cb);
273 case STAT_DIR_TYPE_ERROR_INDEX:
274 /* Gather errors from all threads into a vector */
276 stat_segment_adjust (sm, (void *) sm->shared_header->error_vector);
277 vec_validate (result.error_vector, vec_len (error_vector) - 1);
278 for (i = 0; i < vec_len (error_vector); i++)
280 counter_t *cb = stat_segment_adjust (sm, (void *) error_vector[i]);
281 result.error_vector[i] = cb[ep->index];
285 case STAT_DIR_TYPE_NAME_VECTOR:
287 uint8_t **name_vector = stat_segment_adjust (sm, ep->data);
288 result.name_vector = stat_vec_dup (sm, name_vector);
289 for (i = 0; i < vec_len (name_vector); i++)
291 u8 *name = stat_segment_adjust (sm, name_vector[i]);
292 result.name_vector[i] = stat_vec_dup (sm, name);
297 case STAT_DIR_TYPE_SYMLINK:
298 /* Gather info from all threads into a vector */
300 stat_segment_directory_entry_t *ep2;
301 ep2 = vec_elt_at_index (sm->directory_vector, ep->index1);
302 return copy_data (ep2, ep->index2, ep->name, sm);
305 case STAT_DIR_TYPE_EMPTY:
309 fprintf (stderr, "Unknown type: %d\n", ep->type);
315 stat_segment_data_free (stat_segment_data_t * res)
318 for (i = 0; i < vec_len (res); i++)
322 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
323 for (j = 0; j < vec_len (res[i].simple_counter_vec); j++)
324 vec_free (res[i].simple_counter_vec[j]);
325 vec_free (res[i].simple_counter_vec);
327 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
328 for (j = 0; j < vec_len (res[i].combined_counter_vec); j++)
329 vec_free (res[i].combined_counter_vec[j]);
330 vec_free (res[i].combined_counter_vec);
332 case STAT_DIR_TYPE_NAME_VECTOR:
333 for (j = 0; j < vec_len (res[i].name_vector); j++)
334 vec_free (res[i].name_vector[j]);
335 vec_free (res[i].name_vector);
337 case STAT_DIR_TYPE_ERROR_INDEX:
338 vec_free (res[i].error_vector);
340 case STAT_DIR_TYPE_SCALAR_INDEX:
341 case STAT_DIR_TYPE_EMPTY:
352 stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm)
354 stat_segment_access_t sa;
357 regex_t regex[vec_len (patterns)];
360 for (i = 0; i < vec_len (patterns); i++)
362 int rv = regcomp (®ex[i], (const char *) patterns[i], 0);
365 fprintf (stderr, "Could not compile regex %s\n", patterns[i]);
370 if (stat_segment_access_start (&sa, sm))
373 stat_segment_directory_entry_t *counter_vec = get_stat_vector_r (sm);
374 for (j = 0; j < vec_len (counter_vec); j++)
376 for (i = 0; i < vec_len (patterns); i++)
378 int rv = regexec (®ex[i], counter_vec[j].name, 0, NULL, 0);
385 if (vec_len (patterns) == 0)
389 for (i = 0; i < vec_len (patterns); i++)
392 if (!stat_segment_access_end (&sa, sm))
394 /* Failed, clean up */
400 /* Update last version */
401 sm->current_epoch = sa.epoch;
406 stat_segment_ls (uint8_t ** patterns)
408 stat_client_main_t *sm = &stat_client_main;
409 return stat_segment_ls_r ((uint8_t **) patterns, sm);
412 stat_segment_data_t *
413 stat_segment_dump_r (uint32_t * stats, stat_client_main_t * sm)
416 stat_segment_directory_entry_t *ep;
417 stat_segment_data_t *res = 0;
418 stat_segment_access_t sa;
420 /* Has directory been update? */
421 if (sm->shared_header->epoch != sm->current_epoch)
424 if (stat_segment_access_start (&sa, sm))
427 for (i = 0; i < vec_len (stats); i++)
429 /* Collect counter */
430 ep = vec_elt_at_index (sm->directory_vector, stats[i]);
431 vec_add1 (res, copy_data (ep, ~0, 0, sm));
434 if (stat_segment_access_end (&sa, sm))
437 fprintf (stderr, "Epoch changed while reading, invalid results\n");
438 // TODO increase counter
442 stat_segment_data_t *
443 stat_segment_dump (uint32_t * stats)
445 stat_client_main_t *sm = &stat_client_main;
446 return stat_segment_dump_r (stats, sm);
449 /* Wrapper for accessing vectors from other languages */
451 stat_segment_vec_len (void *vec)
453 return vec_len (vec);
457 stat_segment_vec_free (void *vec)
462 /* Create a vector from a string (or add to existing) */
464 stat_segment_string_vector (uint8_t ** string_vector, const char *string)
467 size_t len = strlen (string);
469 vec_validate_init_c_string (name, string, len);
470 vec_add1 (string_vector, name);
471 return string_vector;
474 stat_segment_data_t *
475 stat_segment_dump_entry_r (uint32_t index, stat_client_main_t * sm)
477 stat_segment_directory_entry_t *ep;
478 stat_segment_data_t *res = 0;
479 stat_segment_access_t sa;
481 /* Has directory been update? */
482 if (sm->shared_header->epoch != sm->current_epoch)
485 if (stat_segment_access_start (&sa, sm))
488 /* Collect counter */
489 ep = vec_elt_at_index (sm->directory_vector, index);
490 vec_add1 (res, copy_data (ep, ~0, 0, sm));
492 if (stat_segment_access_end (&sa, sm))
497 stat_segment_data_t *
498 stat_segment_dump_entry (uint32_t index)
500 stat_client_main_t *sm = &stat_client_main;
501 return stat_segment_dump_entry_r (index, sm);
505 stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm)
507 stat_segment_directory_entry_t *ep;
508 stat_segment_access_t sa;
509 stat_segment_directory_entry_t *vec;
511 /* Has directory been update? */
512 if (sm->shared_header->epoch != sm->current_epoch)
514 if (stat_segment_access_start (&sa, sm))
516 vec = get_stat_vector_r (sm);
517 ep = vec_elt_at_index (vec, index);
518 if (!stat_segment_access_end (&sa, sm))
520 return strdup (ep->name);
524 stat_segment_index_to_name (uint32_t index)
526 stat_client_main_t *sm = &stat_client_main;
527 return stat_segment_index_to_name_r (index, sm);
531 stat_segment_version_r (stat_client_main_t * sm)
533 ASSERT (sm->shared_header);
534 return sm->shared_header->version;
538 stat_segment_version (void)
540 stat_client_main_t *sm = &stat_client_main;
541 return stat_segment_version_r (sm);
545 * fd.io coding-style-patch-verification: ON
548 * eval: (c-set-style "gnu")