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