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>
36 uint64_t current_epoch;
37 stat_segment_shared_header_t *shared_header;
38 stat_segment_directory_entry_t *directory_vector;
42 stat_client_main_t stat_client_main;
47 struct msghdr msg = { 0 };
51 struct iovec io = {.iov_base = iobuf,.iov_len = sizeof (iobuf) };
54 char buf[CMSG_SPACE (sizeof (fd))];
59 msg.msg_control = u.buf;
60 msg.msg_controllen = sizeof (u.buf);
63 if ((size = recvmsg (sock, &msg, 0)) < 0)
65 perror ("recvmsg failed");
68 cmsg = CMSG_FIRSTHDR (&msg);
69 if (cmsg && cmsg->cmsg_level == SOL_SOCKET && cmsg->cmsg_type == SCM_RIGHTS)
71 memmove (&fd, CMSG_DATA (cmsg), sizeof (fd));
76 static stat_segment_directory_entry_t *
77 get_stat_vector (void)
79 stat_client_main_t *sm = &stat_client_main;
80 ASSERT (sm->shared_header);
81 return stat_segment_pointer (sm->shared_header,
82 sm->shared_header->directory_offset);
86 stat_segment_connect (char *socket_name)
88 stat_client_main_t *sm = &stat_client_main;
92 memset (sm, 0, sizeof (*sm));
93 if ((sock = socket (AF_UNIX, SOCK_SEQPACKET, 0)) < 0)
95 perror ("Couldn't open socket");
99 struct sockaddr_un un = { 0 };
100 un.sun_family = AF_UNIX;
101 strncpy ((char *) un.sun_path, socket_name, sizeof (un.sun_path) - 1);
102 if (connect (sock, (struct sockaddr *) &un, sizeof (struct sockaddr_un)) <
109 if ((mfd = recv_fd (sock)) < 0)
111 fprintf (stderr, "Receiving file descriptor failed\n");
116 /* mmap shared memory segment. */
118 struct stat st = { 0 };
120 if (fstat (mfd, &st) == -1)
126 mmap (NULL, st.st_size, PROT_READ, MAP_SHARED, mfd, 0)) == MAP_FAILED)
132 sm->memory_size = st.st_size;
133 sm->shared_header = memaddr;
134 sm->directory_vector =
135 stat_segment_pointer (memaddr, sm->shared_header->directory_offset);
141 stat_segment_disconnect (void)
143 stat_client_main_t *sm = &stat_client_main;
144 munmap (sm->shared_header, sm->memory_size);
150 stat_segment_heartbeat (void)
152 stat_client_main_t *sm = &stat_client_main;
153 stat_segment_directory_entry_t *vec = get_stat_vector ();
154 double *hb = stat_segment_pointer (sm->shared_header, vec[4].offset);
159 copy_data (stat_segment_directory_entry_t * ep)
161 stat_client_main_t *sm = &stat_client_main;
162 stat_segment_data_t result = { 0 };
164 vlib_counter_t **combined_c; /* Combined counter */
165 counter_t **simple_c; /* Simple counter */
166 counter_t *error_base;
167 uint64_t *offset_vector;
169 assert (sm->shared_header);
171 result.type = ep->type;
172 result.name = strdup (ep->name);
175 case STAT_DIR_TYPE_SCALAR_INDEX:
176 result.scalar_value = ep->value;
179 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
180 simple_c = stat_segment_pointer (sm->shared_header, ep->offset);
181 result.simple_counter_vec = vec_dup (simple_c);
183 stat_segment_pointer (sm->shared_header, ep->offset_vector);
184 for (i = 0; i < vec_len (simple_c); i++)
187 stat_segment_pointer (sm->shared_header, offset_vector[i]);
188 result.simple_counter_vec[i] = vec_dup (cb);
192 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
193 combined_c = stat_segment_pointer (sm->shared_header, ep->offset);
194 result.combined_counter_vec = vec_dup (combined_c);
196 stat_segment_pointer (sm->shared_header, ep->offset_vector);
197 for (i = 0; i < vec_len (combined_c); i++)
200 stat_segment_pointer (sm->shared_header, offset_vector[i]);
201 result.combined_counter_vec[i] = vec_dup (cb);
205 case STAT_DIR_TYPE_ERROR_INDEX:
207 stat_segment_pointer (sm->shared_header,
208 sm->shared_header->error_offset);
209 result.error_value = error_base[ep->index];
213 fprintf (stderr, "Unknown type: %d", ep->type);
219 stat_segment_data_free (stat_segment_data_t * res)
222 for (i = 0; i < vec_len (res); i++)
226 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
227 for (j = 0; j < vec_len (res[i].simple_counter_vec); j++)
228 vec_free (res[i].simple_counter_vec[j]);
229 vec_free (res[i].simple_counter_vec);
231 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
232 for (j = 0; j < vec_len (res[i].combined_counter_vec); j++)
233 vec_free (res[i].combined_counter_vec[j]);
234 vec_free (res[i].combined_counter_vec);
248 } stat_segment_access_t;
251 stat_segment_access_start (stat_segment_access_t * sa)
253 stat_client_main_t *sm = &stat_client_main;
254 stat_segment_shared_header_t *shared_header = sm->shared_header;
255 sa->epoch = shared_header->epoch;
256 while (shared_header->in_progress != 0)
261 stat_segment_access_end (stat_segment_access_t * sa)
263 stat_client_main_t *sm = &stat_client_main;
264 stat_segment_shared_header_t *shared_header = sm->shared_header;
266 if (shared_header->epoch != sa->epoch || shared_header->in_progress)
272 stat_segment_ls (uint8_t ** patterns)
274 stat_client_main_t *sm = &stat_client_main;
275 stat_segment_access_t sa;
278 regex_t regex[vec_len (patterns)];
281 for (i = 0; i < vec_len (patterns); i++)
283 int rv = regcomp (®ex[i], (char *) patterns[i], 0);
286 fprintf (stderr, "Could not compile regex %s\n", patterns[i]);
291 stat_segment_access_start (&sa);
293 stat_segment_directory_entry_t *counter_vec = get_stat_vector ();
294 for (j = 0; j < vec_len (counter_vec); j++)
296 for (i = 0; i < vec_len (patterns); i++)
298 int rv = regexec (®ex[i], counter_vec[j].name, 0, NULL, 0);
305 if (vec_len (patterns) == 0)
309 for (i = 0; i < vec_len (patterns); i++)
312 if (!stat_segment_access_end (&sa))
314 /* Failed, clean up */
320 /* Update last version */
321 sm->current_epoch = sa.epoch;
325 stat_segment_data_t *
326 stat_segment_dump (uint32_t * stats)
329 stat_client_main_t *sm = &stat_client_main;
330 stat_segment_directory_entry_t *ep;
331 stat_segment_data_t *res = 0;
332 stat_segment_access_t sa;
334 /* Has directory been update? */
335 if (sm->shared_header->epoch != sm->current_epoch)
338 stat_segment_access_start (&sa);
339 for (i = 0; i < vec_len (stats); i++)
341 /* Collect counter */
342 ep = vec_elt_at_index (sm->directory_vector, stats[i]);
343 vec_add1 (res, copy_data (ep));
346 if (stat_segment_access_end (&sa))
349 fprintf (stderr, "Epoch changed while reading, invalid results\n");
350 // TODO increase counter
354 /* Wrapper for accessing vectors from other languages */
356 stat_segment_vec_len (void *vec)
358 return vec_len (vec);
361 /* Create a vector from a string (or add to existing) */
363 stat_segment_string_vector (u8 ** string_vector, char *string)
366 name = vec_dup ((u8 *) string);
367 vec_add1 (string_vector, (u8 *) name);
368 return string_vector;
371 stat_segment_data_t *
372 stat_segment_dump_entry (uint32_t index)
374 stat_client_main_t *sm = &stat_client_main;
375 stat_segment_directory_entry_t *ep;
376 stat_segment_data_t *res = 0;
377 stat_segment_access_t sa;
379 stat_segment_access_start (&sa);
381 /* Collect counter */
382 ep = vec_elt_at_index (sm->directory_vector, index);
383 vec_add1 (res, copy_data (ep));
385 if (stat_segment_access_end (&sa))
391 stat_segment_index_to_name (uint32_t index)
394 stat_segment_directory_entry_t *counter_vec = get_stat_vector ();
395 stat_segment_directory_entry_t *ep;
396 ep = vec_elt_at_index (counter_vec, index);
397 name = strdup (ep->name);
402 * fd.io coding-style-patch-verification: ON
405 * eval: (c-set-style "gnu")