src/vpp-api/client/stat_client.c

   1 /*
   2  *------------------------------------------------------------------
   3  * stat_client.c - Library for access to VPP statistics segment
   4  *
   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:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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  *------------------------------------------------------------------
  18  */
  19
  20 #include <stdio.h>
  21 #include <errno.h>
  22 #include <sys/types.h>
  23 #include <sys/socket.h>
  24 #include <sys/un.h>
  25 #include <stdbool.h>
  26 #include <sys/stat.h>
  27 #include <regex.h>
  28 #include <assert.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>
  34
  35 struct stat_client_main_t
  36 {
  37   uint64_t current_epoch;
  38   stat_segment_shared_header_t *shared_header;
  39   stat_segment_directory_entry_t *directory_vector;
  40   ssize_t memory_size;
  41 };
  42
  43 stat_client_main_t stat_client_main;
  44
  45 stat_client_main_t *
  46 stat_client_get (void)
  47 {
  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));
  51   return sm;
  52 }
  53
  54 void
  55 stat_client_free (stat_client_main_t * sm)
  56 {
  57   free (sm);
  58 }
  59
  60 static int
  61 recv_fd (int sock)
  62 {
  63   struct msghdr msg = { 0 };
  64   struct cmsghdr *cmsg;
  65   int fd = -1;
  66   char iobuf[1];
  67   struct iovec io = {.iov_base = iobuf,.iov_len = sizeof (iobuf) };
  68   union
  69   {
  70     char buf[CMSG_SPACE (sizeof (fd))];
  71     struct cmsghdr align;
  72   } u;
  73   msg.msg_iov = &io;
  74   msg.msg_iovlen = 1;
  75   msg.msg_control = u.buf;
  76   msg.msg_controllen = sizeof (u.buf);
  77
  78   ssize_t size;
  79   if ((size = recvmsg (sock, &msg, 0)) < 0)
  80     {
  81       perror ("recvmsg failed");
  82       return -1;
  83     }
  84   cmsg = CMSG_FIRSTHDR (&msg);
  85   if (cmsg && cmsg->cmsg_level == SOL_SOCKET && cmsg->cmsg_type == SCM_RIGHTS)
  86     {
  87       memmove (&fd, CMSG_DATA (cmsg), sizeof (fd));
  88     }
  89   return fd;
  90 }
  91
  92 static stat_segment_directory_entry_t *
  93 get_stat_vector_r (stat_client_main_t * sm)
  94 {
  95   ASSERT (sm->shared_header);
  96   return stat_segment_pointer (sm->shared_header,
  97                                sm->shared_header->directory_offset);
  98 }
  99
 100 int
 101 stat_segment_connect_r (const char *socket_name, stat_client_main_t * sm)
 102 {
 103   int mfd = -1;
 104   int sock;
 105
 106   clib_memset (sm, 0, sizeof (*sm));
 107   if ((sock = socket (AF_UNIX, SOCK_SEQPACKET, 0)) < 0)
 108     {
 109       perror ("Stat client couldn't open socket");
 110       return -1;
 111     }
 112
 113   struct sockaddr_un un = { 0 };
 114   un.sun_family = AF_UNIX;
 115   strncpy ((char *) un.sun_path, socket_name, sizeof (un.sun_path) - 1);
 116   if (connect (sock, (struct sockaddr *) &un, sizeof (struct sockaddr_un)) <
 117       0)
 118     {
 119       close (sock);
 120       return -2;
 121     }
 122
 123   if ((mfd = recv_fd (sock)) < 0)
 124     {
 125       close (sock);
 126       fprintf (stderr, "Receiving file descriptor failed\n");
 127       return -3;
 128     }
 129   close (sock);
 130
 131   /* mmap shared memory segment. */
 132   void *memaddr;
 133   struct stat st = { 0 };
 134
 135   if (fstat (mfd, &st) == -1)
 136     {
 137       close (mfd);
 138       perror ("mmap fstat failed");
 139       return -4;
 140     }
 141   if ((memaddr =
 142        mmap (NULL, st.st_size, PROT_READ, MAP_SHARED, mfd, 0)) == MAP_FAILED)
 143     {
 144       close (mfd);
 145       perror ("mmap map failed");
 146       return -5;
 147     }
 148
 149   close (mfd);
 150   sm->memory_size = st.st_size;
 151   sm->shared_header = memaddr;
 152   sm->directory_vector =
 153     stat_segment_pointer (memaddr, sm->shared_header->directory_offset);
 154
 155   return 0;
 156 }
 157
 158 int
 159 stat_segment_connect (const char *socket_name)
 160 {
 161   stat_client_main_t *sm = &stat_client_main;
 162   return stat_segment_connect_r (socket_name, sm);
 163 }
 164
 165 void
 166 stat_segment_disconnect_r (stat_client_main_t * sm)
 167 {
 168   munmap (sm->shared_header, sm->memory_size);
 169   return;
 170 }
 171
 172 typedef struct
 173 {
 174   uint64_t epoch;
 175 } stat_segment_access_t;
 176
 177 static void
 178 stat_segment_access_start (stat_segment_access_t * sa,
 179                            stat_client_main_t * sm)
 180 {
 181   stat_segment_shared_header_t *shared_header = sm->shared_header;
 182   sa->epoch = shared_header->epoch;
 183   while (shared_header->in_progress != 0)
 184     ;
 185 }
 186
 187 static bool
 188 stat_segment_access_end (stat_segment_access_t * sa, stat_client_main_t * sm)
 189 {
 190   stat_segment_shared_header_t *shared_header = sm->shared_header;
 191
 192   if (shared_header->epoch != sa->epoch || shared_header->in_progress)
 193     return false;
 194   return true;
 195 }
 196
 197 void
 198 stat_segment_disconnect (void)
 199 {
 200   stat_client_main_t *sm = &stat_client_main;
 201   return stat_segment_disconnect_r (sm);
 202 }
 203
 204 double
 205 stat_segment_heartbeat_r (stat_client_main_t * sm)
 206 {
 207   stat_segment_access_t sa;
 208   stat_segment_directory_entry_t *ep;
 209
 210   /* Has directory been update? */
 211   if (sm->shared_header->epoch != sm->current_epoch)
 212     return 0;
 213   stat_segment_access_start (&sa, sm);
 214   ep = vec_elt_at_index (sm->directory_vector, STAT_COUNTER_HEARTBEAT);
 215   if (!stat_segment_access_end (&sa, sm))
 216     return 0.0;
 217   return ep->value;
 218 }
 219
 220 double
 221 stat_segment_heartbeat (void)
 222 {
 223   stat_client_main_t *sm = &stat_client_main;
 224   return stat_segment_heartbeat_r (sm);
 225 }
 226
 227 static stat_segment_data_t
 228 copy_data (stat_segment_directory_entry_t * ep, stat_client_main_t * sm)
 229 {
 230   stat_segment_data_t result = { 0 };
 231   int i;
 232   vlib_counter_t **combined_c;  /* Combined counter */
 233   counter_t **simple_c;         /* Simple counter */
 234   counter_t *error_base;
 235   uint64_t *offset_vector;
 236
 237   assert (sm->shared_header);
 238
 239   result.type = ep->type;
 240   result.name = strdup (ep->name);
 241   switch (ep->type)
 242     {
 243     case STAT_DIR_TYPE_SCALAR_INDEX:
 244       result.scalar_value = ep->value;
 245       break;
 246
 247     case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
 248       if (ep->offset == 0)
 249         return result;
 250       simple_c = stat_segment_pointer (sm->shared_header, ep->offset);
 251       result.simple_counter_vec = vec_dup (simple_c);
 252       offset_vector =
 253         stat_segment_pointer (sm->shared_header, ep->offset_vector);
 254       for (i = 0; i < vec_len (simple_c); i++)
 255         {
 256           counter_t *cb =
 257             stat_segment_pointer (sm->shared_header, offset_vector[i]);
 258           result.simple_counter_vec[i] = vec_dup (cb);
 259         }
 260       break;
 261
 262     case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
 263       if (ep->offset == 0)
 264         return result;
 265       combined_c = stat_segment_pointer (sm->shared_header, ep->offset);
 266       result.combined_counter_vec = vec_dup (combined_c);
 267       offset_vector =
 268         stat_segment_pointer (sm->shared_header, ep->offset_vector);
 269       for (i = 0; i < vec_len (combined_c); i++)
 270         {
 271           vlib_counter_t *cb =
 272             stat_segment_pointer (sm->shared_header, offset_vector[i]);
 273           result.combined_counter_vec[i] = vec_dup (cb);
 274         }
 275       break;
 276
 277     case STAT_DIR_TYPE_ERROR_INDEX:
 278       error_base =
 279         stat_segment_pointer (sm->shared_header,
 280                               sm->shared_header->error_offset);
 281       result.error_value = error_base[ep->index];
 282       break;
 283
 284     case STAT_DIR_TYPE_NAME_VECTOR:
 285       if (ep->offset == 0)
 286         return result;
 287       uint8_t **name_vector =
 288         stat_segment_pointer (sm->shared_header, ep->offset);
 289       result.name_vector = vec_dup (name_vector);
 290       offset_vector =
 291         stat_segment_pointer (sm->shared_header, ep->offset_vector);
 292       for (i = 0; i < vec_len (name_vector); i++)
 293         {
 294           if (offset_vector[i])
 295             {
 296               u8 *name =
 297                 stat_segment_pointer (sm->shared_header, offset_vector[i]);
 298               result.name_vector[i] = vec_dup (name);
 299             }
 300           else
 301             result.name_vector[i] = 0;
 302         }
 303       break;
 304
 305     default:
 306       fprintf (stderr, "Unknown type: %d\n", ep->type);
 307     }
 308   return result;
 309 }
 310
 311 void
 312 stat_segment_data_free (stat_segment_data_t * res)
 313 {
 314   int i, j;
 315   for (i = 0; i < vec_len (res); i++)
 316     {
 317       switch (res[i].type)
 318         {
 319         case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
 320           for (j = 0; j < vec_len (res[i].simple_counter_vec); j++)
 321             vec_free (res[i].simple_counter_vec[j]);
 322           vec_free (res[i].simple_counter_vec);
 323           break;
 324         case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
 325           for (j = 0; j < vec_len (res[i].combined_counter_vec); j++)
 326             vec_free (res[i].combined_counter_vec[j]);
 327           vec_free (res[i].combined_counter_vec);
 328           break;
 329         default:
 330           ;
 331         }
 332       free (res[i].name);
 333     }
 334   vec_free (res);
 335 }
 336
 337 uint32_t *
 338 stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm)
 339 {
 340   stat_segment_access_t sa;
 341
 342   uint32_t *dir = 0;
 343   regex_t regex[vec_len (patterns)];
 344
 345   int i, j;
 346   for (i = 0; i < vec_len (patterns); i++)
 347     {
 348       int rv = regcomp (&regex[i], (const char *) patterns[i], 0);
 349       if (rv)
 350         {
 351           fprintf (stderr, "Could not compile regex %s\n", patterns[i]);
 352           return dir;
 353         }
 354     }
 355
 356   stat_segment_access_start (&sa, sm);
 357
 358   stat_segment_directory_entry_t *counter_vec = get_stat_vector_r (sm);
 359   for (j = 0; j < vec_len (counter_vec); j++)
 360     {
 361       for (i = 0; i < vec_len (patterns); i++)
 362         {
 363           int rv = regexec (&regex[i], counter_vec[j].name, 0, NULL, 0);
 364           if (rv == 0)
 365             {
 366               vec_add1 (dir, j);
 367               break;
 368             }
 369         }
 370       if (vec_len (patterns) == 0)
 371         vec_add1 (dir, j);
 372     }
 373
 374   for (i = 0; i < vec_len (patterns); i++)
 375     regfree (&regex[i]);
 376
 377   if (!stat_segment_access_end (&sa, sm))
 378     {
 379       /* Failed, clean up */
 380       vec_free (dir);
 381       return 0;
 382
 383     }
 384
 385   /* Update last version */
 386   sm->current_epoch = sa.epoch;
 387   return dir;
 388 }
 389
 390 uint32_t *
 391 stat_segment_ls (uint8_t ** patterns)
 392 {
 393   stat_client_main_t *sm = &stat_client_main;
 394   return stat_segment_ls_r ((uint8_t **) patterns, sm);
 395 }
 396
 397 stat_segment_data_t *
 398 stat_segment_dump_r (uint32_t * stats, stat_client_main_t * sm)
 399 {
 400   int i;
 401   stat_segment_directory_entry_t *ep;
 402   stat_segment_data_t *res = 0;
 403   stat_segment_access_t sa;
 404
 405   /* Has directory been update? */
 406   if (sm->shared_header->epoch != sm->current_epoch)
 407     return 0;
 408
 409   stat_segment_access_start (&sa, sm);
 410   for (i = 0; i < vec_len (stats); i++)
 411     {
 412       /* Collect counter */
 413       ep = vec_elt_at_index (sm->directory_vector, stats[i]);
 414       vec_add1 (res, copy_data (ep, sm));
 415     }
 416
 417   if (stat_segment_access_end (&sa, sm))
 418     return res;
 419
 420   fprintf (stderr, "Epoch changed while reading, invalid results\n");
 421   // TODO increase counter
 422   return 0;
 423 }
 424
 425 stat_segment_data_t *
 426 stat_segment_dump (uint32_t * stats)
 427 {
 428   stat_client_main_t *sm = &stat_client_main;
 429   return stat_segment_dump_r (stats, sm);
 430 }
 431
 432 /* Wrapper for accessing vectors from other languages */
 433 int
 434 stat_segment_vec_len (void *vec)
 435 {
 436   return vec_len (vec);
 437 }
 438
 439 void
 440 stat_segment_vec_free (void *vec)
 441 {
 442   vec_free (vec);
 443 }
 444
 445 /* Create a vector from a string (or add to existing) */
 446 uint8_t **
 447 stat_segment_string_vector (uint8_t ** string_vector, const char *string)
 448 {
 449   uint8_t *name = 0;
 450   size_t len = strlen (string);
 451
 452   vec_validate_init_c_string (name, string, len);
 453   vec_add1 (string_vector, name);
 454   return string_vector;
 455 }
 456
 457 stat_segment_data_t *
 458 stat_segment_dump_entry_r (uint32_t index, stat_client_main_t * sm)
 459 {
 460   stat_segment_directory_entry_t *ep;
 461   stat_segment_data_t *res = 0;
 462   stat_segment_access_t sa;
 463
 464   stat_segment_access_start (&sa, sm);
 465
 466   /* Collect counter */
 467   ep = vec_elt_at_index (sm->directory_vector, index);
 468   vec_add1 (res, copy_data (ep, sm));
 469
 470   if (stat_segment_access_end (&sa, sm))
 471     return res;
 472   return 0;
 473 }
 474
 475 stat_segment_data_t *
 476 stat_segment_dump_entry (uint32_t index)
 477 {
 478   stat_client_main_t *sm = &stat_client_main;
 479   return stat_segment_dump_entry_r (index, sm);
 480 }
 481
 482 char *
 483 stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm)
 484 {
 485   stat_segment_directory_entry_t *ep;
 486   stat_segment_access_t sa;
 487   stat_segment_directory_entry_t *vec;
 488
 489   /* Has directory been update? */
 490   if (sm->shared_header->epoch != sm->current_epoch)
 491     return 0;
 492   stat_segment_access_start (&sa, sm);
 493   vec = get_stat_vector_r (sm);
 494   ep = vec_elt_at_index (vec, index);
 495   if (!stat_segment_access_end (&sa, sm))
 496     return 0;
 497   return strdup (ep->name);
 498 }
 499
 500 char *
 501 stat_segment_index_to_name (uint32_t index)
 502 {
 503   stat_client_main_t *sm = &stat_client_main;
 504   return stat_segment_index_to_name_r (index, sm);
 505 }
 506
 507 /*
 508  * fd.io coding-style-patch-verification: ON
 509  *
 510  * Local Variables:
 511  * eval: (c-set-style "gnu")
 512  * End:
 513  */