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