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 update? */
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 static stat_segment_data_t
196 copy_data (stat_segment_directory_entry_t * ep, stat_client_main_t * sm)
198 stat_segment_data_t result = { 0 };
200 vlib_counter_t **combined_c; /* Combined counter */
201 counter_t **simple_c; /* Simple counter */
202 uint64_t *error_vector;
204 assert (sm->shared_header);
206 result.type = ep->type;
207 result.name = strdup (ep->name);
210 case STAT_DIR_TYPE_SCALAR_INDEX:
211 result.scalar_value = ep->value;
214 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
215 simple_c = stat_segment_adjust (sm, ep->data);
216 result.simple_counter_vec = vec_dup (simple_c);
217 for (i = 0; i < vec_len (simple_c); i++)
219 counter_t *cb = stat_segment_adjust (sm, simple_c[i]);
220 result.simple_counter_vec[i] = vec_dup (cb);
224 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
225 combined_c = stat_segment_adjust (sm, ep->data);
226 result.combined_counter_vec = vec_dup (combined_c);
227 for (i = 0; i < vec_len (combined_c); i++)
229 vlib_counter_t *cb = stat_segment_adjust (sm, combined_c[i]);
230 result.combined_counter_vec[i] = vec_dup (cb);
234 case STAT_DIR_TYPE_ERROR_INDEX:
235 /* Gather errors from all threads into a vector */
237 stat_segment_adjust (sm, (void *) sm->shared_header->error_vector);
238 vec_validate (result.error_vector, vec_len (error_vector) - 1);
239 for (i = 0; i < vec_len (error_vector); i++)
241 counter_t *cb = stat_segment_adjust (sm, (void *) error_vector[i]);
242 result.error_vector[i] = cb[ep->index];
246 case STAT_DIR_TYPE_NAME_VECTOR:
248 uint8_t **name_vector = stat_segment_adjust (sm, ep->data);
249 result.name_vector = vec_dup (name_vector);
250 for (i = 0; i < vec_len (name_vector); i++)
252 u8 *name = stat_segment_adjust (sm, name_vector[i]);
253 result.name_vector[i] = vec_dup (name);
258 case STAT_DIR_TYPE_EMPTY:
262 fprintf (stderr, "Unknown type: %d\n", ep->type);
268 stat_segment_data_free (stat_segment_data_t * res)
271 for (i = 0; i < vec_len (res); i++)
275 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
276 for (j = 0; j < vec_len (res[i].simple_counter_vec); j++)
277 vec_free (res[i].simple_counter_vec[j]);
278 vec_free (res[i].simple_counter_vec);
280 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
281 for (j = 0; j < vec_len (res[i].combined_counter_vec); j++)
282 vec_free (res[i].combined_counter_vec[j]);
283 vec_free (res[i].combined_counter_vec);
285 case STAT_DIR_TYPE_NAME_VECTOR:
286 for (j = 0; j < vec_len (res[i].name_vector); j++)
287 vec_free (res[i].name_vector[j]);
288 vec_free (res[i].name_vector);
290 case STAT_DIR_TYPE_ERROR_INDEX:
291 vec_free (res[i].error_vector);
302 stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm)
304 stat_segment_access_t sa;
307 regex_t regex[vec_len (patterns)];
310 for (i = 0; i < vec_len (patterns); i++)
312 int rv = regcomp (®ex[i], (const char *) patterns[i], 0);
315 fprintf (stderr, "Could not compile regex %s\n", patterns[i]);
320 if (stat_segment_access_start (&sa, sm))
323 stat_segment_directory_entry_t *counter_vec = get_stat_vector_r (sm);
324 for (j = 0; j < vec_len (counter_vec); j++)
326 for (i = 0; i < vec_len (patterns); i++)
328 int rv = regexec (®ex[i], counter_vec[j].name, 0, NULL, 0);
335 if (vec_len (patterns) == 0)
339 for (i = 0; i < vec_len (patterns); i++)
342 if (!stat_segment_access_end (&sa, sm))
344 /* Failed, clean up */
350 /* Update last version */
351 sm->current_epoch = sa.epoch;
356 stat_segment_ls (uint8_t ** patterns)
358 stat_client_main_t *sm = &stat_client_main;
359 return stat_segment_ls_r ((uint8_t **) patterns, sm);
362 stat_segment_data_t *
363 stat_segment_dump_r (uint32_t * stats, stat_client_main_t * sm)
366 stat_segment_directory_entry_t *ep;
367 stat_segment_data_t *res = 0;
368 stat_segment_access_t sa;
370 /* Has directory been update? */
371 if (sm->shared_header->epoch != sm->current_epoch)
374 if (stat_segment_access_start (&sa, sm))
377 for (i = 0; i < vec_len (stats); i++)
379 /* Collect counter */
380 ep = vec_elt_at_index (sm->directory_vector, stats[i]);
381 vec_add1 (res, copy_data (ep, sm));
384 if (stat_segment_access_end (&sa, sm))
387 fprintf (stderr, "Epoch changed while reading, invalid results\n");
388 // TODO increase counter
392 stat_segment_data_t *
393 stat_segment_dump (uint32_t * stats)
395 stat_client_main_t *sm = &stat_client_main;
396 return stat_segment_dump_r (stats, sm);
399 /* Wrapper for accessing vectors from other languages */
401 stat_segment_vec_len (void *vec)
403 return vec_len (vec);
407 stat_segment_vec_free (void *vec)
412 /* Create a vector from a string (or add to existing) */
414 stat_segment_string_vector (uint8_t ** string_vector, const char *string)
417 size_t len = strlen (string);
419 vec_validate_init_c_string (name, string, len);
420 vec_add1 (string_vector, name);
421 return string_vector;
424 stat_segment_data_t *
425 stat_segment_dump_entry_r (uint32_t index, stat_client_main_t * sm)
427 stat_segment_directory_entry_t *ep;
428 stat_segment_data_t *res = 0;
429 stat_segment_access_t sa;
431 if (stat_segment_access_start (&sa, sm))
434 /* Collect counter */
435 ep = vec_elt_at_index (sm->directory_vector, index);
436 vec_add1 (res, copy_data (ep, sm));
438 if (stat_segment_access_end (&sa, sm))
443 stat_segment_data_t *
444 stat_segment_dump_entry (uint32_t index)
446 stat_client_main_t *sm = &stat_client_main;
447 return stat_segment_dump_entry_r (index, sm);
451 stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm)
453 stat_segment_directory_entry_t *ep;
454 stat_segment_access_t sa;
455 stat_segment_directory_entry_t *vec;
457 /* Has directory been update? */
458 if (sm->shared_header->epoch != sm->current_epoch)
460 if (stat_segment_access_start (&sa, sm))
462 vec = get_stat_vector_r (sm);
463 ep = vec_elt_at_index (vec, index);
464 if (!stat_segment_access_end (&sa, sm))
466 return strdup (ep->name);
470 stat_segment_index_to_name (uint32_t index)
472 stat_client_main_t *sm = &stat_client_main;
473 return stat_segment_index_to_name_r (index, sm);
477 stat_segment_version_r (stat_client_main_t * sm)
479 ASSERT (sm->shared_header);
480 return sm->shared_header->version;
484 stat_segment_version (void)
486 stat_client_main_t *sm = &stat_client_main;
487 return stat_segment_version_r (sm);
491 * fd.io coding-style-patch-verification: ON
494 * eval: (c-set-style "gnu")