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>
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);
92 static stat_segment_directory_entry_t *
93 get_stat_vector (void)
95 stat_client_main_t *sm = &stat_client_main;
96 return get_stat_vector_r (sm);
100 stat_segment_connect_r (char *socket_name, stat_client_main_t * sm)
105 clib_memset (sm, 0, sizeof (*sm));
106 if ((sock = socket (AF_UNIX, SOCK_SEQPACKET, 0)) < 0)
108 perror ("Stat client couldn't open socket");
112 struct sockaddr_un un = { 0 };
113 un.sun_family = AF_UNIX;
114 strncpy ((char *) un.sun_path, socket_name, sizeof (un.sun_path) - 1);
115 if (connect (sock, (struct sockaddr *) &un, sizeof (struct sockaddr_un)) <
122 if ((mfd = recv_fd (sock)) < 0)
125 fprintf (stderr, "Receiving file descriptor failed\n");
130 /* mmap shared memory segment. */
132 struct stat st = { 0 };
134 if (fstat (mfd, &st) == -1)
136 perror ("mmap fstat failed");
140 mmap (NULL, st.st_size, PROT_READ, MAP_SHARED, mfd, 0)) == MAP_FAILED)
142 perror ("mmap map failed");
146 sm->memory_size = st.st_size;
147 sm->shared_header = memaddr;
148 sm->directory_vector =
149 stat_segment_pointer (memaddr, sm->shared_header->directory_offset);
155 stat_segment_connect (char *socket_name)
157 stat_client_main_t *sm = &stat_client_main;
158 return stat_segment_connect_r (socket_name, sm);
162 stat_segment_disconnect_r (stat_client_main_t * sm)
164 munmap (sm->shared_header, sm->memory_size);
169 stat_segment_disconnect (void)
171 stat_client_main_t *sm = &stat_client_main;
172 return stat_segment_disconnect_r (sm);
176 stat_segment_heartbeat_r (stat_client_main_t * sm)
178 stat_segment_directory_entry_t *vec = get_stat_vector_r (sm);
179 double *hb = stat_segment_pointer (sm->shared_header, vec[4].offset);
184 stat_segment_heartbeat (void)
186 stat_client_main_t *sm = &stat_client_main;
187 return stat_segment_heartbeat_r (sm);
191 copy_data (stat_segment_directory_entry_t * ep, stat_client_main_t * sm)
193 stat_segment_data_t result = { 0 };
195 vlib_counter_t **combined_c; /* Combined counter */
196 counter_t **simple_c; /* Simple counter */
197 counter_t *error_base;
198 uint64_t *offset_vector;
200 assert (sm->shared_header);
202 result.type = ep->type;
203 result.name = strdup (ep->name);
206 case STAT_DIR_TYPE_SCALAR_INDEX:
207 result.scalar_value = ep->value;
210 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
213 simple_c = stat_segment_pointer (sm->shared_header, ep->offset);
214 result.simple_counter_vec = vec_dup (simple_c);
216 stat_segment_pointer (sm->shared_header, ep->offset_vector);
217 for (i = 0; i < vec_len (simple_c); i++)
220 stat_segment_pointer (sm->shared_header, offset_vector[i]);
221 result.simple_counter_vec[i] = vec_dup (cb);
225 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
228 combined_c = stat_segment_pointer (sm->shared_header, ep->offset);
229 result.combined_counter_vec = vec_dup (combined_c);
231 stat_segment_pointer (sm->shared_header, ep->offset_vector);
232 for (i = 0; i < vec_len (combined_c); i++)
235 stat_segment_pointer (sm->shared_header, offset_vector[i]);
236 result.combined_counter_vec[i] = vec_dup (cb);
240 case STAT_DIR_TYPE_ERROR_INDEX:
242 stat_segment_pointer (sm->shared_header,
243 sm->shared_header->error_offset);
244 result.error_value = error_base[ep->index];
248 fprintf (stderr, "Unknown type: %d", ep->type);
254 stat_segment_data_free (stat_segment_data_t * res)
257 for (i = 0; i < vec_len (res); i++)
261 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
262 for (j = 0; j < vec_len (res[i].simple_counter_vec); j++)
263 vec_free (res[i].simple_counter_vec[j]);
264 vec_free (res[i].simple_counter_vec);
266 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
267 for (j = 0; j < vec_len (res[i].combined_counter_vec); j++)
268 vec_free (res[i].combined_counter_vec[j]);
269 vec_free (res[i].combined_counter_vec);
283 } stat_segment_access_t;
286 stat_segment_access_start (stat_segment_access_t * sa,
287 stat_client_main_t * sm)
289 stat_segment_shared_header_t *shared_header = sm->shared_header;
290 sa->epoch = shared_header->epoch;
291 while (shared_header->in_progress != 0)
296 stat_segment_access_end (stat_segment_access_t * sa, stat_client_main_t * sm)
298 stat_segment_shared_header_t *shared_header = sm->shared_header;
300 if (shared_header->epoch != sa->epoch || shared_header->in_progress)
306 stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm)
308 stat_segment_access_t sa;
311 regex_t regex[vec_len (patterns)];
314 for (i = 0; i < vec_len (patterns); i++)
316 int rv = regcomp (®ex[i], (char *) patterns[i], 0);
319 fprintf (stderr, "Could not compile regex %s\n", patterns[i]);
324 stat_segment_access_start (&sa, sm);
326 stat_segment_directory_entry_t *counter_vec = get_stat_vector_r (sm);
327 for (j = 0; j < vec_len (counter_vec); j++)
329 for (i = 0; i < vec_len (patterns); i++)
331 int rv = regexec (®ex[i], counter_vec[j].name, 0, NULL, 0);
338 if (vec_len (patterns) == 0)
342 for (i = 0; i < vec_len (patterns); i++)
345 if (!stat_segment_access_end (&sa, sm))
347 /* Failed, clean up */
353 /* Update last version */
354 sm->current_epoch = sa.epoch;
359 stat_segment_ls (uint8_t ** patterns)
361 stat_client_main_t *sm = &stat_client_main;
362 return stat_segment_ls_r ((uint8_t **) patterns, sm);
365 stat_segment_data_t *
366 stat_segment_dump_r (uint32_t * stats, stat_client_main_t * sm)
369 stat_segment_directory_entry_t *ep;
370 stat_segment_data_t *res = 0;
371 stat_segment_access_t sa;
373 /* Has directory been update? */
374 if (sm->shared_header->epoch != sm->current_epoch)
377 stat_segment_access_start (&sa, sm);
378 for (i = 0; i < vec_len (stats); i++)
380 /* Collect counter */
381 ep = vec_elt_at_index (sm->directory_vector, stats[i]);
382 vec_add1 (res, copy_data (ep, sm));
385 if (stat_segment_access_end (&sa, sm))
388 fprintf (stderr, "Epoch changed while reading, invalid results\n");
389 // TODO increase counter
393 stat_segment_data_t *
394 stat_segment_dump (uint32_t * stats)
396 stat_client_main_t *sm = &stat_client_main;
397 return stat_segment_dump_r (stats, sm);
400 /* Wrapper for accessing vectors from other languages */
402 stat_segment_vec_len (void *vec)
404 return vec_len (vec);
408 stat_segment_vec_free (void *vec)
413 /* Create a vector from a string (or add to existing) */
415 stat_segment_string_vector (u8 ** string_vector, char *string)
418 name = vec_dup ((u8 *) string);
419 vec_add1 (string_vector, (u8 *) name);
420 return string_vector;
423 stat_segment_data_t *
424 stat_segment_dump_entry_r (uint32_t index, stat_client_main_t * sm)
426 stat_segment_directory_entry_t *ep;
427 stat_segment_data_t *res = 0;
428 stat_segment_access_t sa;
430 stat_segment_access_start (&sa, sm);
432 /* Collect counter */
433 ep = vec_elt_at_index (sm->directory_vector, index);
434 vec_add1 (res, copy_data (ep, sm));
436 if (stat_segment_access_end (&sa, sm))
441 stat_segment_data_t *
442 stat_segment_dump_entry (uint32_t index)
444 stat_client_main_t *sm = &stat_client_main;
445 return stat_segment_dump_entry_r (index, sm);
449 stat_segment_index_to_name (uint32_t index)
452 stat_segment_directory_entry_t *counter_vec = get_stat_vector ();
453 stat_segment_directory_entry_t *ep;
454 ep = vec_elt_at_index (counter_vec, index);
455 name = strdup (ep->name);
460 * fd.io coding-style-patch-verification: ON
463 * eval: (c-set-style "gnu")