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