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)) <
110 if ((mfd = recv_fd (sock)) < 0)
113 fprintf (stderr, "Receiving file descriptor failed\n");
118 /* mmap shared memory segment. */
120 struct stat st = { 0 };
122 if (fstat (mfd, &st) == -1)
128 mmap (NULL, st.st_size, PROT_READ, MAP_SHARED, mfd, 0)) == MAP_FAILED)
134 sm->memory_size = st.st_size;
135 sm->shared_header = memaddr;
136 sm->directory_vector =
137 stat_segment_pointer (memaddr, sm->shared_header->directory_offset);
143 stat_segment_disconnect (void)
145 stat_client_main_t *sm = &stat_client_main;
146 munmap (sm->shared_header, sm->memory_size);
152 stat_segment_heartbeat (void)
154 stat_client_main_t *sm = &stat_client_main;
155 stat_segment_directory_entry_t *vec = get_stat_vector ();
156 double *hb = stat_segment_pointer (sm->shared_header, vec[4].offset);
161 copy_data (stat_segment_directory_entry_t * ep)
163 stat_client_main_t *sm = &stat_client_main;
164 stat_segment_data_t result = { 0 };
166 vlib_counter_t **combined_c; /* Combined counter */
167 counter_t **simple_c; /* Simple counter */
168 counter_t *error_base;
169 uint64_t *offset_vector;
171 assert (sm->shared_header);
173 result.type = ep->type;
174 result.name = strdup (ep->name);
177 case STAT_DIR_TYPE_SCALAR_INDEX:
178 result.scalar_value = ep->value;
181 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
184 simple_c = stat_segment_pointer (sm->shared_header, ep->offset);
185 result.simple_counter_vec = vec_dup (simple_c);
187 stat_segment_pointer (sm->shared_header, ep->offset_vector);
188 for (i = 0; i < vec_len (simple_c); i++)
191 stat_segment_pointer (sm->shared_header, offset_vector[i]);
192 result.simple_counter_vec[i] = vec_dup (cb);
196 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
199 combined_c = stat_segment_pointer (sm->shared_header, ep->offset);
200 result.combined_counter_vec = vec_dup (combined_c);
202 stat_segment_pointer (sm->shared_header, ep->offset_vector);
203 for (i = 0; i < vec_len (combined_c); i++)
206 stat_segment_pointer (sm->shared_header, offset_vector[i]);
207 result.combined_counter_vec[i] = vec_dup (cb);
211 case STAT_DIR_TYPE_ERROR_INDEX:
213 stat_segment_pointer (sm->shared_header,
214 sm->shared_header->error_offset);
215 result.error_value = error_base[ep->index];
219 fprintf (stderr, "Unknown type: %d", ep->type);
225 stat_segment_data_free (stat_segment_data_t * res)
228 for (i = 0; i < vec_len (res); i++)
232 case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
233 for (j = 0; j < vec_len (res[i].simple_counter_vec); j++)
234 vec_free (res[i].simple_counter_vec[j]);
235 vec_free (res[i].simple_counter_vec);
237 case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
238 for (j = 0; j < vec_len (res[i].combined_counter_vec); j++)
239 vec_free (res[i].combined_counter_vec[j]);
240 vec_free (res[i].combined_counter_vec);
254 } stat_segment_access_t;
257 stat_segment_access_start (stat_segment_access_t * sa)
259 stat_client_main_t *sm = &stat_client_main;
260 stat_segment_shared_header_t *shared_header = sm->shared_header;
261 sa->epoch = shared_header->epoch;
262 while (shared_header->in_progress != 0)
267 stat_segment_access_end (stat_segment_access_t * sa)
269 stat_client_main_t *sm = &stat_client_main;
270 stat_segment_shared_header_t *shared_header = sm->shared_header;
272 if (shared_header->epoch != sa->epoch || shared_header->in_progress)
278 stat_segment_ls (uint8_t ** patterns)
280 stat_client_main_t *sm = &stat_client_main;
281 stat_segment_access_t sa;
284 regex_t regex[vec_len (patterns)];
287 for (i = 0; i < vec_len (patterns); i++)
289 int rv = regcomp (®ex[i], (char *) patterns[i], 0);
292 fprintf (stderr, "Could not compile regex %s\n", patterns[i]);
297 stat_segment_access_start (&sa);
299 stat_segment_directory_entry_t *counter_vec = get_stat_vector ();
300 for (j = 0; j < vec_len (counter_vec); j++)
302 for (i = 0; i < vec_len (patterns); i++)
304 int rv = regexec (®ex[i], counter_vec[j].name, 0, NULL, 0);
311 if (vec_len (patterns) == 0)
315 for (i = 0; i < vec_len (patterns); i++)
318 if (!stat_segment_access_end (&sa))
320 /* Failed, clean up */
326 /* Update last version */
327 sm->current_epoch = sa.epoch;
331 stat_segment_data_t *
332 stat_segment_dump (uint32_t * stats)
335 stat_client_main_t *sm = &stat_client_main;
336 stat_segment_directory_entry_t *ep;
337 stat_segment_data_t *res = 0;
338 stat_segment_access_t sa;
340 /* Has directory been update? */
341 if (sm->shared_header->epoch != sm->current_epoch)
344 stat_segment_access_start (&sa);
345 for (i = 0; i < vec_len (stats); i++)
347 /* Collect counter */
348 ep = vec_elt_at_index (sm->directory_vector, stats[i]);
349 vec_add1 (res, copy_data (ep));
352 if (stat_segment_access_end (&sa))
355 fprintf (stderr, "Epoch changed while reading, invalid results\n");
356 // TODO increase counter
360 /* Wrapper for accessing vectors from other languages */
362 stat_segment_vec_len (void *vec)
364 return vec_len (vec);
367 /* Create a vector from a string (or add to existing) */
369 stat_segment_string_vector (u8 ** string_vector, char *string)
372 name = vec_dup ((u8 *) string);
373 vec_add1 (string_vector, (u8 *) name);
374 return string_vector;
377 stat_segment_data_t *
378 stat_segment_dump_entry (uint32_t index)
380 stat_client_main_t *sm = &stat_client_main;
381 stat_segment_directory_entry_t *ep;
382 stat_segment_data_t *res = 0;
383 stat_segment_access_t sa;
385 stat_segment_access_start (&sa);
387 /* Collect counter */
388 ep = vec_elt_at_index (sm->directory_vector, index);
389 vec_add1 (res, copy_data (ep));
391 if (stat_segment_access_end (&sa))
397 stat_segment_index_to_name (uint32_t index)
400 stat_segment_directory_entry_t *counter_vec = get_stat_vector ();
401 stat_segment_directory_entry_t *ep;
402 ep = vec_elt_at_index (counter_vec, index);
403 name = strdup (ep->name);
408 * fd.io coding-style-patch-verification: ON
411 * eval: (c-set-style "gnu")