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_adjust (sm,
  89                               (void *) sm->shared_header->directory_vector);
  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_adjust (sm, (void *) sm->shared_header->directory_vector);
 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   if (stat_segment_access_start (&sa, sm))
 181     return 0;
 182   ep = vec_elt_at_index (sm->directory_vector, STAT_COUNTER_HEARTBEAT);
 183   if (!stat_segment_access_end (&sa, sm))
 184     return 0.0;
 185   return ep->value;
 186 }
 187
 188 double
 189 stat_segment_heartbeat (void)
 190 {
 191   stat_client_main_t *sm = &stat_client_main;
 192   return stat_segment_heartbeat_r (sm);
 193 }
 194
 195 static stat_segment_data_t
 196 copy_data (stat_segment_directory_entry_t * ep, stat_client_main_t * sm)
 197 {
 198   stat_segment_data_t result = { 0 };
 199   int i;
 200   vlib_counter_t **combined_c;  /* Combined counter */
 201   counter_t **simple_c;         /* Simple counter */
 202   uint64_t *error_vector;
 203
 204   assert (sm->shared_header);
 205
 206   result.type = ep->type;
 207   result.name = strdup (ep->name);
 208   switch (ep->type)
 209     {
 210     case STAT_DIR_TYPE_SCALAR_INDEX:
 211       result.scalar_value = ep->value;
 212       break;
 213
 214     case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
 215       simple_c = stat_segment_adjust (sm, ep->data);
 216       result.simple_counter_vec = vec_dup (simple_c);
 217       for (i = 0; i < vec_len (simple_c); i++)
 218         {
 219           counter_t *cb = stat_segment_adjust (sm, simple_c[i]);
 220           result.simple_counter_vec[i] = vec_dup (cb);
 221         }
 222       break;
 223
 224     case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
 225       combined_c = stat_segment_adjust (sm, ep->data);
 226       result.combined_counter_vec = vec_dup (combined_c);
 227       for (i = 0; i < vec_len (combined_c); i++)
 228         {
 229           vlib_counter_t *cb = stat_segment_adjust (sm, combined_c[i]);
 230           result.combined_counter_vec[i] = vec_dup (cb);
 231         }
 232       break;
 233
 234     case STAT_DIR_TYPE_ERROR_INDEX:
 235       /* Gather errors from all threads into a vector */
 236       error_vector =
 237         stat_segment_adjust (sm, (void *) sm->shared_header->error_vector);
 238       vec_validate (result.error_vector, vec_len (error_vector) - 1);
 239       for (i = 0; i < vec_len (error_vector); i++)
 240         {
 241           counter_t *cb = stat_segment_adjust (sm, (void *) error_vector[i]);
 242           result.error_vector[i] = cb[ep->index];
 243         }
 244       break;
 245
 246     case STAT_DIR_TYPE_NAME_VECTOR:
 247       {
 248         uint8_t **name_vector = stat_segment_adjust (sm, ep->data);
 249         result.name_vector = vec_dup (name_vector);
 250         for (i = 0; i < vec_len (name_vector); i++)
 251           {
 252             u8 *name = stat_segment_adjust (sm, name_vector[i]);
 253             result.name_vector[i] = vec_dup (name);
 254           }
 255       }
 256       break;
 257
 258     case STAT_DIR_TYPE_EMPTY:
 259       break;
 260
 261     default:
 262       fprintf (stderr, "Unknown type: %d\n", ep->type);
 263     }
 264   return result;
 265 }
 266
 267 void
 268 stat_segment_data_free (stat_segment_data_t * res)
 269 {
 270   int i, j;
 271   for (i = 0; i < vec_len (res); i++)
 272     {
 273       switch (res[i].type)
 274         {
 275         case STAT_DIR_TYPE_COUNTER_VECTOR_SIMPLE:
 276           for (j = 0; j < vec_len (res[i].simple_counter_vec); j++)
 277             vec_free (res[i].simple_counter_vec[j]);
 278           vec_free (res[i].simple_counter_vec);
 279           break;
 280         case STAT_DIR_TYPE_COUNTER_VECTOR_COMBINED:
 281           for (j = 0; j < vec_len (res[i].combined_counter_vec); j++)
 282             vec_free (res[i].combined_counter_vec[j]);
 283           vec_free (res[i].combined_counter_vec);
 284           break;
 285         case STAT_DIR_TYPE_NAME_VECTOR:
 286           for (j = 0; j < vec_len (res[i].name_vector); j++)
 287             vec_free (res[i].name_vector[j]);
 288           vec_free (res[i].name_vector);
 289           break;
 290         case STAT_DIR_TYPE_ERROR_INDEX:
 291           vec_free (res[i].error_vector);
 292           break;
 293         default:
 294           assert (0);
 295         }
 296       free (res[i].name);
 297     }
 298   vec_free (res);
 299 }
 300
 301 uint32_t *
 302 stat_segment_ls_r (uint8_t ** patterns, stat_client_main_t * sm)
 303 {
 304   stat_segment_access_t sa;
 305
 306   uint32_t *dir = 0;
 307   regex_t regex[vec_len (patterns)];
 308
 309   int i, j;
 310   for (i = 0; i < vec_len (patterns); i++)
 311     {
 312       int rv = regcomp (&regex[i], (const char *) patterns[i], 0);
 313       if (rv)
 314         {
 315           fprintf (stderr, "Could not compile regex %s\n", patterns[i]);
 316           return dir;
 317         }
 318     }
 319
 320   if (stat_segment_access_start (&sa, sm))
 321     return 0;
 322
 323   stat_segment_directory_entry_t *counter_vec = get_stat_vector_r (sm);
 324   for (j = 0; j < vec_len (counter_vec); j++)
 325     {
 326       for (i = 0; i < vec_len (patterns); i++)
 327         {
 328           int rv = regexec (&regex[i], counter_vec[j].name, 0, NULL, 0);
 329           if (rv == 0)
 330             {
 331               vec_add1 (dir, j);
 332               break;
 333             }
 334         }
 335       if (vec_len (patterns) == 0)
 336         vec_add1 (dir, j);
 337     }
 338
 339   for (i = 0; i < vec_len (patterns); i++)
 340     regfree (&regex[i]);
 341
 342   if (!stat_segment_access_end (&sa, sm))
 343     {
 344       /* Failed, clean up */
 345       vec_free (dir);
 346       return 0;
 347
 348     }
 349
 350   /* Update last version */
 351   sm->current_epoch = sa.epoch;
 352   return dir;
 353 }
 354
 355 uint32_t *
 356 stat_segment_ls (uint8_t ** patterns)
 357 {
 358   stat_client_main_t *sm = &stat_client_main;
 359   return stat_segment_ls_r ((uint8_t **) patterns, sm);
 360 }
 361
 362 stat_segment_data_t *
 363 stat_segment_dump_r (uint32_t * stats, stat_client_main_t * sm)
 364 {
 365   int i;
 366   stat_segment_directory_entry_t *ep;
 367   stat_segment_data_t *res = 0;
 368   stat_segment_access_t sa;
 369
 370   /* Has directory been update? */
 371   if (sm->shared_header->epoch != sm->current_epoch)
 372     return 0;
 373
 374   if (stat_segment_access_start (&sa, sm))
 375     return 0;
 376
 377   for (i = 0; i < vec_len (stats); i++)
 378     {
 379       /* Collect counter */
 380       ep = vec_elt_at_index (sm->directory_vector, stats[i]);
 381       vec_add1 (res, copy_data (ep, sm));
 382     }
 383
 384   if (stat_segment_access_end (&sa, sm))
 385     return res;
 386
 387   fprintf (stderr, "Epoch changed while reading, invalid results\n");
 388   // TODO increase counter
 389   return 0;
 390 }
 391
 392 stat_segment_data_t *
 393 stat_segment_dump (uint32_t * stats)
 394 {
 395   stat_client_main_t *sm = &stat_client_main;
 396   return stat_segment_dump_r (stats, sm);
 397 }
 398
 399 /* Wrapper for accessing vectors from other languages */
 400 int
 401 stat_segment_vec_len (void *vec)
 402 {
 403   return vec_len (vec);
 404 }
 405
 406 void
 407 stat_segment_vec_free (void *vec)
 408 {
 409   vec_free (vec);
 410 }
 411
 412 /* Create a vector from a string (or add to existing) */
 413 uint8_t **
 414 stat_segment_string_vector (uint8_t ** string_vector, const char *string)
 415 {
 416   uint8_t *name = 0;
 417   size_t len = strlen (string);
 418
 419   vec_validate_init_c_string (name, string, len);
 420   vec_add1 (string_vector, name);
 421   return string_vector;
 422 }
 423
 424 stat_segment_data_t *
 425 stat_segment_dump_entry_r (uint32_t index, stat_client_main_t * sm)
 426 {
 427   stat_segment_directory_entry_t *ep;
 428   stat_segment_data_t *res = 0;
 429   stat_segment_access_t sa;
 430
 431   if (stat_segment_access_start (&sa, sm))
 432     return 0;
 433
 434   /* Collect counter */
 435   ep = vec_elt_at_index (sm->directory_vector, index);
 436   vec_add1 (res, copy_data (ep, sm));
 437
 438   if (stat_segment_access_end (&sa, sm))
 439     return res;
 440   return 0;
 441 }
 442
 443 stat_segment_data_t *
 444 stat_segment_dump_entry (uint32_t index)
 445 {
 446   stat_client_main_t *sm = &stat_client_main;
 447   return stat_segment_dump_entry_r (index, sm);
 448 }
 449
 450 char *
 451 stat_segment_index_to_name_r (uint32_t index, stat_client_main_t * sm)
 452 {
 453   stat_segment_directory_entry_t *ep;
 454   stat_segment_access_t sa;
 455   stat_segment_directory_entry_t *vec;
 456
 457   /* Has directory been update? */
 458   if (sm->shared_header->epoch != sm->current_epoch)
 459     return 0;
 460   if (stat_segment_access_start (&sa, sm))
 461     return 0;
 462   vec = get_stat_vector_r (sm);
 463   ep = vec_elt_at_index (vec, index);
 464   if (!stat_segment_access_end (&sa, sm))
 465     return 0;
 466   return strdup (ep->name);
 467 }
 468
 469 char *
 470 stat_segment_index_to_name (uint32_t index)
 471 {
 472   stat_client_main_t *sm = &stat_client_main;
 473   return stat_segment_index_to_name_r (index, sm);
 474 }
 475
 476 uint64_t
 477 stat_segment_version_r (stat_client_main_t * sm)
 478 {
 479   ASSERT (sm->shared_header);
 480   return sm->shared_header->version;
 481 }
 482
 483 uint64_t
 484 stat_segment_version (void)
 485 {
 486   stat_client_main_t *sm = &stat_client_main;
 487   return stat_segment_version_r (sm);
 488 }
 489
 490 /*
 491  * fd.io coding-style-patch-verification: ON
 492  *
 493  * Local Variables:
 494  * eval: (c-set-style "gnu")
 495  * End:
 496  */