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