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 "stat_client.h"
32 #include <stdatomic.h>
33 #include <vpp/stats/stat_segment.h>
35 struct stat_client_main_t
37 uint64_t current_epoch;
38 stat_segment_shared_header_t *shared_header;
39 stat_segment_directory_entry_t *directory_vector;
43 stat_client_main_t stat_client_main;
46 stat_client_get (void)
48 stat_client_main_t *sm;
49 sm = (stat_client_main_t *) malloc (sizeof (stat_client_main_t));
50 clib_memset (sm, 0, sizeof (stat_client_main_t));
55 stat_client_free (stat_client_main_t * sm)
63 struct msghdr msg = { 0 };
67 struct iovec io = {.iov_base = iobuf,.iov_len = sizeof (iobuf) };
70 char buf[CMSG_SPACE (sizeof (fd))];
75 msg.msg_control = u.buf;
76 msg.msg_controllen = sizeof (u.buf);
79 if ((size = recvmsg (sock, &msg, 0)) < 0)
81 perror ("recvmsg failed");
84 cmsg = CMSG_FIRSTHDR (&msg);
85 if (cmsg && cmsg->cmsg_level == SOL_SOCKET && cmsg->cmsg_type == SCM_RIGHTS)
87 memmove (&fd, CMSG_DATA (cmsg), sizeof (fd));
92 static stat_segment_directory_entry_t *
93 get_stat_vector_r (stat_client_main_t * sm)
95 ASSERT (sm->shared_header);
96 return stat_segment_pointer (sm->shared_header,
97 sm->shared_header->directory_offset);
101 stat_segment_connect_r (const char *socket_name, stat_client_main_t * sm)
106 clib_memset (sm, 0, sizeof (*sm));
107 if ((sock = socket (AF_UNIX, SOCK_SEQPACKET, 0)) < 0)
109 perror ("Stat client couldn't open socket");
113 struct sockaddr_un un = { 0 };
114 un.sun_family = AF_UNIX;
115 strncpy ((char *) un.sun_path, socket_name, sizeof (un.sun_path) - 1);
116 if (connect (sock, (struct sockaddr *) &un, sizeof (struct sockaddr_un)) <
123 if ((mfd = recv_fd (sock)) < 0)
126 fprintf (stderr, "Receiving file descriptor failed\n");
131 /* mmap shared memory segment. */
133 struct stat st = { 0 };
135 if (fstat (mfd, &st) == -1)
138 perror ("mmap fstat failed");
142 mmap (NULL, st.st_size, PROT_READ, MAP_SHARED, mfd, 0)) == MAP_FAILED)
145 perror ("mmap map failed");
150 sm->memory_size = st.st_size;
151 sm->shared_header = memaddr;
152 sm->directory_vector =
153 stat_segment_pointer (memaddr, sm->shared_header->directory_offset);
159 stat_segment_connect (const char *socket_name)
161 stat_client_main_t *sm = &stat_client_main;
162 return stat_segment_connect_r (socket_name, sm);
166 stat_segment_disconnect_r (stat_client_main_t * sm)
168 munmap (sm->shared_header, sm->memory_size);
175 } stat_segment_access_t;
178 stat_segment_access_start (stat_segment_access_t * sa,
179 stat_client_main_t * sm)
181 stat_segment_shared_header_t *shared_header = sm->shared_header;
182 sa->epoch = shared_header->epoch;
183 while (shared_header->in_progress != 0)
188 stat_segment_access_end (stat_segment_access_t * sa, stat_client_main_t * sm)
190 stat_segment_shared_header_t *shared_header = sm->shared_header;
192 if (shared_header->epoch != sa->epoch || shared_header->in_progress)
198 stat_segment_disconnect (void)
200 stat_client_main_t *sm = &stat_client_main;
201 return stat_segment_disconnect_r (sm);
205 stat_segment_heartbeat_r (stat_client_main_t * sm)
207 stat_segment_access_t sa;
208 stat_segment_directory_entry_t *ep;
210 /* Has directory been update? */
211 if (sm->shared_header->epoch != sm->current_epoch)
213 stat_segment_access_start (&sa, sm);
214 ep = vec_elt_at_index (sm->directory_vector, STAT_COUNTER_HEARTBEAT);
215 if (!stat_segment_access_end (&sa, sm))
221 stat_segment_heartbeat (void)
223 stat_client_main_t *sm = &stat_client_main;
224 return stat_segment_heartbeat_r (sm);
227 static stat_segment_data_t
228 copy_data (stat_segment_directory_entry_t * ep, stat_client_main_t * sm)
230 stat_segment_data_t result = { 0 };
232 vlib_counter_t **combined_c; /* Combined counter */
233 counter_t **simple_c; /* Simple counter */
234 counter_t *error_base;
235 uint64_t *offset_vector;
237 assert (sm->shared_header);
239 result.type = ep->type;
240 result.name = strdup (ep->name);
243 case STAT_DIR_TYPE_SCALAR_INDEX:
244 result.scalar_value = ep->value;
247 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
250 simple_c = stat_segment_pointer (sm->shared_header, ep->offset);
251 result.simple_counter_vec = vec_dup (simple_c);
253 stat_segment_pointer (sm->shared_header, ep->offset_vector);
254 for (i = 0; i < vec_len (simple_c); i++)
257 stat_segment_pointer (sm->shared_header, offset_vector[i]);
258 result.simple_counter_vec[i] = vec_dup (cb);
262 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
265 combined_c = stat_segment_pointer (sm->shared_header, ep->offset);
266 result.combined_counter_vec = vec_dup (combined_c);
268 stat_segment_pointer (sm->shared_header, ep->offset_vector);
269 for (i = 0; i < vec_len (combined_c); i++)
272 stat_segment_pointer (sm->shared_header, offset_vector[i]);
273 result.combined_counter_vec[i] = vec_dup (cb);
277 case STAT_DIR_TYPE_ERROR_INDEX:
279 stat_segment_pointer (sm->shared_header,
280 sm->shared_header->error_offset);
281 result.error_value = error_base[ep->index];
284 case STAT_DIR_TYPE_NAME_VECTOR:
287 uint8_t **name_vector =
288 stat_segment_pointer (sm->shared_header, ep->offset);
289 result.name_vector = vec_dup (name_vector);
291 stat_segment_pointer (sm->shared_header, ep->offset_vector);
292 for (i = 0; i < vec_len (name_vector); i++)
294 if (offset_vector[i])
297 stat_segment_pointer (sm->shared_header, offset_vector[i]);
298 result.name_vector[i] = vec_dup (name);
301 result.name_vector[i] = 0;
306 fprintf (stderr, "Unknown type: %d\n", ep->type);
312 stat_segment_data_free (stat_segment_data_t * res)
315 for (i = 0; i < vec_len (res); i++)
319 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
320 for (j = 0; j < vec_len (res[i].simple_counter_vec); j++)
321 vec_free (res[i].simple_counter_vec[j]);
322 vec_free (res[i].simple_counter_vec);
324 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
325 for (j = 0; j < vec_len (res[i].combined_counter_vec); j++)
326 vec_free (res[i].combined_counter_vec[j]);
327 vec_free (res[i].combined_counter_vec);
338 stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm)
340 stat_segment_access_t sa;
343 regex_t regex[vec_len (patterns)];
346 for (i = 0; i < vec_len (patterns); i++)
348 int rv = regcomp (®ex[i], (const char *) patterns[i], 0);
351 fprintf (stderr, "Could not compile regex %s\n", patterns[i]);
356 stat_segment_access_start (&sa, sm);
358 stat_segment_directory_entry_t *counter_vec = get_stat_vector_r (sm);
359 for (j = 0; j < vec_len (counter_vec); j++)
361 for (i = 0; i < vec_len (patterns); i++)
363 int rv = regexec (®ex[i], counter_vec[j].name, 0, NULL, 0);
370 if (vec_len (patterns) == 0)
374 for (i = 0; i < vec_len (patterns); i++)
377 if (!stat_segment_access_end (&sa, sm))
379 /* Failed, clean up */
385 /* Update last version */
386 sm->current_epoch = sa.epoch;
391 stat_segment_ls (uint8_t ** patterns)
393 stat_client_main_t *sm = &stat_client_main;
394 return stat_segment_ls_r ((uint8_t **) patterns, sm);
397 stat_segment_data_t *
398 stat_segment_dump_r (uint32_t * stats, stat_client_main_t * sm)
401 stat_segment_directory_entry_t *ep;
402 stat_segment_data_t *res = 0;
403 stat_segment_access_t sa;
405 /* Has directory been update? */
406 if (sm->shared_header->epoch != sm->current_epoch)
409 stat_segment_access_start (&sa, sm);
410 for (i = 0; i < vec_len (stats); i++)
412 /* Collect counter */
413 ep = vec_elt_at_index (sm->directory_vector, stats[i]);
414 vec_add1 (res, copy_data (ep, sm));
417 if (stat_segment_access_end (&sa, sm))
420 fprintf (stderr, "Epoch changed while reading, invalid results\n");
421 // TODO increase counter
425 stat_segment_data_t *
426 stat_segment_dump (uint32_t * stats)
428 stat_client_main_t *sm = &stat_client_main;
429 return stat_segment_dump_r (stats, sm);
432 /* Wrapper for accessing vectors from other languages */
434 stat_segment_vec_len (void *vec)
436 return vec_len (vec);
440 stat_segment_vec_free (void *vec)
445 /* Create a vector from a string (or add to existing) */
447 stat_segment_string_vector (uint8_t ** string_vector, const char *string)
450 size_t len = strlen (string);
452 vec_validate_init_c_string (name, string, len);
453 vec_add1 (string_vector, name);
454 return string_vector;
457 stat_segment_data_t *
458 stat_segment_dump_entry_r (uint32_t index, stat_client_main_t * sm)
460 stat_segment_directory_entry_t *ep;
461 stat_segment_data_t *res = 0;
462 stat_segment_access_t sa;
464 stat_segment_access_start (&sa, sm);
466 /* Collect counter */
467 ep = vec_elt_at_index (sm->directory_vector, index);
468 vec_add1 (res, copy_data (ep, sm));
470 if (stat_segment_access_end (&sa, sm))
475 stat_segment_data_t *
476 stat_segment_dump_entry (uint32_t index)
478 stat_client_main_t *sm = &stat_client_main;
479 return stat_segment_dump_entry_r (index, sm);
483 stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm)
485 stat_segment_directory_entry_t *ep;
486 stat_segment_access_t sa;
487 stat_segment_directory_entry_t *vec;
489 /* Has directory been update? */
490 if (sm->shared_header->epoch != sm->current_epoch)
492 stat_segment_access_start (&sa, sm);
493 vec = get_stat_vector_r (sm);
494 ep = vec_elt_at_index (vec, index);
495 if (!stat_segment_access_end (&sa, sm))
497 return strdup (ep->name);
501 stat_segment_index_to_name (uint32_t index)
503 stat_client_main_t *sm = &stat_client_main;
504 return stat_segment_index_to_name_r (index, sm);
508 * fd.io coding-style-patch-verification: ON
511 * eval: (c-set-style "gnu")