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_pointer (sm->shared_header,
89 sm->shared_header->directory_offset);
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_pointer (memaddr, sm->shared_header->directory_offset);
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 stat_segment_access_start (&sa, sm);
181 ep = vec_elt_at_index (sm->directory_vector, STAT_COUNTER_HEARTBEAT);
182 if (!stat_segment_access_end (&sa, sm))
188 stat_segment_heartbeat (void)
190 stat_client_main_t *sm = &stat_client_main;
191 return stat_segment_heartbeat_r (sm);
194 static stat_segment_data_t
195 copy_data (stat_segment_directory_entry_t * ep, stat_client_main_t * sm)
197 stat_segment_data_t result = { 0 };
199 vlib_counter_t **combined_c; /* Combined counter */
200 counter_t **simple_c; /* Simple counter */
201 uint64_t *offset_vector;
203 assert (sm->shared_header);
205 result.type = ep->type;
206 result.name = strdup (ep->name);
209 case STAT_DIR_TYPE_SCALAR_INDEX:
210 result.scalar_value = ep->value;
213 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
216 simple_c = stat_segment_pointer (sm->shared_header, ep->offset);
217 result.simple_counter_vec = vec_dup (simple_c);
219 stat_segment_pointer (sm->shared_header, ep->offset_vector);
220 for (i = 0; i < vec_len (simple_c); i++)
223 stat_segment_pointer (sm->shared_header, offset_vector[i]);
224 result.simple_counter_vec[i] = vec_dup (cb);
228 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
231 combined_c = stat_segment_pointer (sm->shared_header, ep->offset);
232 result.combined_counter_vec = vec_dup (combined_c);
234 stat_segment_pointer (sm->shared_header, ep->offset_vector);
235 for (i = 0; i < vec_len (combined_c); i++)
238 stat_segment_pointer (sm->shared_header, offset_vector[i]);
239 result.combined_counter_vec[i] = vec_dup (cb);
243 case STAT_DIR_TYPE_ERROR_INDEX:
244 /* Gather errors from all threads into a vector */
245 offset_vector = stat_segment_pointer (sm->shared_header,
246 sm->shared_header->error_offset);
247 vec_validate (result.error_vector, vec_len (offset_vector) - 1);
248 for (i = 0; i < vec_len (offset_vector); i++)
251 stat_segment_pointer (sm->shared_header, offset_vector[i]);
252 result.error_vector[i] = cb[ep->index];
256 case STAT_DIR_TYPE_NAME_VECTOR:
259 uint8_t **name_vector =
260 stat_segment_pointer (sm->shared_header, ep->offset);
261 result.name_vector = vec_dup (name_vector);
263 stat_segment_pointer (sm->shared_header, ep->offset_vector);
264 for (i = 0; i < vec_len (name_vector); i++)
266 if (offset_vector[i])
269 stat_segment_pointer (sm->shared_header, offset_vector[i]);
270 result.name_vector[i] = vec_dup (name);
273 result.name_vector[i] = 0;
277 case STAT_DIR_TYPE_EMPTY:
281 fprintf (stderr, "Unknown type: %d\n", ep->type);
287 stat_segment_data_free (stat_segment_data_t * res)
290 for (i = 0; i < vec_len (res); i++)
294 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
295 for (j = 0; j < vec_len (res[i].simple_counter_vec); j++)
296 vec_free (res[i].simple_counter_vec[j]);
297 vec_free (res[i].simple_counter_vec);
299 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
300 for (j = 0; j < vec_len (res[i].combined_counter_vec); j++)
301 vec_free (res[i].combined_counter_vec[j]);
302 vec_free (res[i].combined_counter_vec);
313 stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm)
315 stat_segment_access_t sa;
318 regex_t regex[vec_len (patterns)];
321 for (i = 0; i < vec_len (patterns); i++)
323 int rv = regcomp (®ex[i], (const char *) patterns[i], 0);
326 fprintf (stderr, "Could not compile regex %s\n", patterns[i]);
331 stat_segment_access_start (&sa, sm);
333 stat_segment_directory_entry_t *counter_vec = get_stat_vector_r (sm);
334 for (j = 0; j < vec_len (counter_vec); j++)
336 for (i = 0; i < vec_len (patterns); i++)
338 int rv = regexec (®ex[i], counter_vec[j].name, 0, NULL, 0);
345 if (vec_len (patterns) == 0)
349 for (i = 0; i < vec_len (patterns); i++)
352 if (!stat_segment_access_end (&sa, sm))
354 /* Failed, clean up */
360 /* Update last version */
361 sm->current_epoch = sa.epoch;
366 stat_segment_ls (uint8_t ** patterns)
368 stat_client_main_t *sm = &stat_client_main;
369 return stat_segment_ls_r ((uint8_t **) patterns, sm);
372 stat_segment_data_t *
373 stat_segment_dump_r (uint32_t * stats, stat_client_main_t * sm)
376 stat_segment_directory_entry_t *ep;
377 stat_segment_data_t *res = 0;
378 stat_segment_access_t sa;
380 /* Has directory been update? */
381 if (sm->shared_header->epoch != sm->current_epoch)
384 stat_segment_access_start (&sa, sm);
385 for (i = 0; i < vec_len (stats); i++)
387 /* Collect counter */
388 ep = vec_elt_at_index (sm->directory_vector, stats[i]);
389 vec_add1 (res, copy_data (ep, sm));
392 if (stat_segment_access_end (&sa, sm))
395 fprintf (stderr, "Epoch changed while reading, invalid results\n");
396 // TODO increase counter
400 stat_segment_data_t *
401 stat_segment_dump (uint32_t * stats)
403 stat_client_main_t *sm = &stat_client_main;
404 return stat_segment_dump_r (stats, sm);
407 /* Wrapper for accessing vectors from other languages */
409 stat_segment_vec_len (void *vec)
411 return vec_len (vec);
415 stat_segment_vec_free (void *vec)
420 /* Create a vector from a string (or add to existing) */
422 stat_segment_string_vector (uint8_t ** string_vector, const char *string)
425 size_t len = strlen (string);
427 vec_validate_init_c_string (name, string, len);
428 vec_add1 (string_vector, name);
429 return string_vector;
432 stat_segment_data_t *
433 stat_segment_dump_entry_r (uint32_t index, stat_client_main_t * sm)
435 stat_segment_directory_entry_t *ep;
436 stat_segment_data_t *res = 0;
437 stat_segment_access_t sa;
439 stat_segment_access_start (&sa, sm);
441 /* Collect counter */
442 ep = vec_elt_at_index (sm->directory_vector, index);
443 vec_add1 (res, copy_data (ep, sm));
445 if (stat_segment_access_end (&sa, sm))
450 stat_segment_data_t *
451 stat_segment_dump_entry (uint32_t index)
453 stat_client_main_t *sm = &stat_client_main;
454 return stat_segment_dump_entry_r (index, sm);
458 stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm)
460 stat_segment_directory_entry_t *ep;
461 stat_segment_access_t sa;
462 stat_segment_directory_entry_t *vec;
464 /* Has directory been update? */
465 if (sm->shared_header->epoch != sm->current_epoch)
467 stat_segment_access_start (&sa, sm);
468 vec = get_stat_vector_r (sm);
469 ep = vec_elt_at_index (vec, index);
470 if (!stat_segment_access_end (&sa, sm))
472 return strdup (ep->name);
476 stat_segment_index_to_name (uint32_t index)
478 stat_client_main_t *sm = &stat_client_main;
479 return stat_segment_index_to_name_r (index, sm);
483 stat_segment_version_r (stat_client_main_t * sm)
485 ASSERT (sm->shared_header);
486 return sm->shared_header->version;
490 stat_segment_version (void)
492 stat_client_main_t *sm = &stat_client_main;
493 return stat_segment_version_r (sm);
497 * fd.io coding-style-patch-verification: ON
500 * eval: (c-set-style "gnu")