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);
100 static stat_segment_directory_entry_t *
101 get_stat_vector (void)
103 stat_client_main_t *sm = &stat_client_main;
104 return get_stat_vector_r (sm);
108 stat_segment_connect_r (const char *socket_name, stat_client_main_t * sm)
113 clib_memset (sm, 0, sizeof (*sm));
114 if ((sock = socket (AF_UNIX, SOCK_SEQPACKET, 0)) < 0)
116 perror ("Stat client couldn't open socket");
120 struct sockaddr_un un = { 0 };
121 un.sun_family = AF_UNIX;
122 strncpy ((char *) un.sun_path, socket_name, sizeof (un.sun_path) - 1);
123 if (connect (sock, (struct sockaddr *) &un, sizeof (struct sockaddr_un)) <
130 if ((mfd = recv_fd (sock)) < 0)
133 fprintf (stderr, "Receiving file descriptor failed\n");
138 /* mmap shared memory segment. */
140 struct stat st = { 0 };
142 if (fstat (mfd, &st) == -1)
144 perror ("mmap fstat failed");
148 mmap (NULL, st.st_size, PROT_READ, MAP_SHARED, mfd, 0)) == MAP_FAILED)
150 perror ("mmap map failed");
154 sm->memory_size = st.st_size;
155 sm->shared_header = memaddr;
156 sm->directory_vector =
157 stat_segment_pointer (memaddr, sm->shared_header->directory_offset);
163 stat_segment_connect (const char *socket_name)
165 stat_client_main_t *sm = &stat_client_main;
166 return stat_segment_connect_r (socket_name, sm);
170 stat_segment_disconnect_r (stat_client_main_t * sm)
172 munmap (sm->shared_header, sm->memory_size);
177 stat_segment_disconnect (void)
179 stat_client_main_t *sm = &stat_client_main;
180 return stat_segment_disconnect_r (sm);
184 stat_segment_heartbeat_r (stat_client_main_t * sm)
186 stat_segment_directory_entry_t *vec = get_stat_vector_r (sm);
187 double *hb = stat_segment_pointer (sm->shared_header, vec[4].offset);
192 stat_segment_heartbeat (void)
194 stat_client_main_t *sm = &stat_client_main;
195 return stat_segment_heartbeat_r (sm);
199 copy_data (stat_segment_directory_entry_t * ep, stat_client_main_t * sm)
201 stat_segment_data_t result = { 0 };
203 vlib_counter_t **combined_c; /* Combined counter */
204 counter_t **simple_c; /* Simple counter */
205 counter_t *error_base;
206 uint64_t *offset_vector;
208 assert (sm->shared_header);
210 result.type = ep->type;
211 result.name = strdup (ep->name);
214 case STAT_DIR_TYPE_SCALAR_INDEX:
215 result.scalar_value = ep->value;
218 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
221 simple_c = stat_segment_pointer (sm->shared_header, ep->offset);
222 result.simple_counter_vec = vec_dup (simple_c);
224 stat_segment_pointer (sm->shared_header, ep->offset_vector);
225 for (i = 0; i < vec_len (simple_c); i++)
228 stat_segment_pointer (sm->shared_header, offset_vector[i]);
229 result.simple_counter_vec[i] = vec_dup (cb);
233 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
236 combined_c = stat_segment_pointer (sm->shared_header, ep->offset);
237 result.combined_counter_vec = vec_dup (combined_c);
239 stat_segment_pointer (sm->shared_header, ep->offset_vector);
240 for (i = 0; i < vec_len (combined_c); i++)
243 stat_segment_pointer (sm->shared_header, offset_vector[i]);
244 result.combined_counter_vec[i] = vec_dup (cb);
248 case STAT_DIR_TYPE_ERROR_INDEX:
250 stat_segment_pointer (sm->shared_header,
251 sm->shared_header->error_offset);
252 result.error_value = error_base[ep->index];
255 case STAT_DIR_TYPE_NAME_VECTOR:
258 uint8_t **name_vector =
259 stat_segment_pointer (sm->shared_header, ep->offset);
260 result.name_vector = vec_dup (name_vector);
262 stat_segment_pointer (sm->shared_header, ep->offset_vector);
263 for (i = 0; i < vec_len (name_vector); i++)
265 if (offset_vector[i])
268 stat_segment_pointer (sm->shared_header, offset_vector[i]);
269 result.name_vector[i] = vec_dup (name);
272 result.name_vector[i] = 0;
277 fprintf (stderr, "Unknown type: %d\n", ep->type);
283 stat_segment_data_free (stat_segment_data_t * res)
286 for (i = 0; i < vec_len (res); i++)
290 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
291 for (j = 0; j < vec_len (res[i].simple_counter_vec); j++)
292 vec_free (res[i].simple_counter_vec[j]);
293 vec_free (res[i].simple_counter_vec);
295 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
296 for (j = 0; j < vec_len (res[i].combined_counter_vec); j++)
297 vec_free (res[i].combined_counter_vec[j]);
298 vec_free (res[i].combined_counter_vec);
312 } stat_segment_access_t;
315 stat_segment_access_start (stat_segment_access_t * sa,
316 stat_client_main_t * sm)
318 stat_segment_shared_header_t *shared_header = sm->shared_header;
319 sa->epoch = shared_header->epoch;
320 while (shared_header->in_progress != 0)
325 stat_segment_access_end (stat_segment_access_t * sa, stat_client_main_t * sm)
327 stat_segment_shared_header_t *shared_header = sm->shared_header;
329 if (shared_header->epoch != sa->epoch || shared_header->in_progress)
335 stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm)
337 stat_segment_access_t sa;
340 regex_t regex[vec_len (patterns)];
343 for (i = 0; i < vec_len (patterns); i++)
345 int rv = regcomp (®ex[i], (const char *) patterns[i], 0);
348 fprintf (stderr, "Could not compile regex %s\n", patterns[i]);
353 stat_segment_access_start (&sa, sm);
355 stat_segment_directory_entry_t *counter_vec = get_stat_vector_r (sm);
356 for (j = 0; j < vec_len (counter_vec); j++)
358 for (i = 0; i < vec_len (patterns); i++)
360 int rv = regexec (®ex[i], counter_vec[j].name, 0, NULL, 0);
367 if (vec_len (patterns) == 0)
371 for (i = 0; i < vec_len (patterns); i++)
374 if (!stat_segment_access_end (&sa, sm))
376 /* Failed, clean up */
382 /* Update last version */
383 sm->current_epoch = sa.epoch;
388 stat_segment_ls (uint8_t ** patterns)
390 stat_client_main_t *sm = &stat_client_main;
391 return stat_segment_ls_r ((uint8_t **) patterns, sm);
394 stat_segment_data_t *
395 stat_segment_dump_r (uint32_t * stats, stat_client_main_t * sm)
398 stat_segment_directory_entry_t *ep;
399 stat_segment_data_t *res = 0;
400 stat_segment_access_t sa;
402 /* Has directory been update? */
403 if (sm->shared_header->epoch != sm->current_epoch)
406 stat_segment_access_start (&sa, sm);
407 for (i = 0; i < vec_len (stats); i++)
409 /* Collect counter */
410 ep = vec_elt_at_index (sm->directory_vector, stats[i]);
411 vec_add1 (res, copy_data (ep, sm));
414 if (stat_segment_access_end (&sa, sm))
417 fprintf (stderr, "Epoch changed while reading, invalid results\n");
418 // TODO increase counter
422 stat_segment_data_t *
423 stat_segment_dump (uint32_t * stats)
425 stat_client_main_t *sm = &stat_client_main;
426 return stat_segment_dump_r (stats, sm);
429 /* Wrapper for accessing vectors from other languages */
431 stat_segment_vec_len (void *vec)
433 return vec_len (vec);
437 stat_segment_vec_free (void *vec)
442 /* Create a vector from a string (or add to existing) */
444 stat_segment_string_vector (uint8_t ** string_vector, const char *string)
447 size_t len = strlen (string);
449 vec_validate_init_c_string (name, string, len);
450 vec_add1 (string_vector, name);
451 return string_vector;
454 stat_segment_data_t *
455 stat_segment_dump_entry_r (uint32_t index, stat_client_main_t * sm)
457 stat_segment_directory_entry_t *ep;
458 stat_segment_data_t *res = 0;
459 stat_segment_access_t sa;
461 stat_segment_access_start (&sa, sm);
463 /* Collect counter */
464 ep = vec_elt_at_index (sm->directory_vector, index);
465 vec_add1 (res, copy_data (ep, sm));
467 if (stat_segment_access_end (&sa, sm))
472 stat_segment_data_t *
473 stat_segment_dump_entry (uint32_t index)
475 stat_client_main_t *sm = &stat_client_main;
476 return stat_segment_dump_entry_r (index, sm);
480 stat_segment_index_to_name (uint32_t index)
483 stat_segment_directory_entry_t *counter_vec = get_stat_vector ();
484 stat_segment_directory_entry_t *ep;
485 ep = vec_elt_at_index (counter_vec, index);
486 name = strdup (ep->name);
491 * fd.io coding-style-patch-verification: ON
494 * eval: (c-set-style "gnu")