src/vpp-api/client/client.c

   1 /*
   2  * Copyright (c) 2016 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #include <assert.h>
  16 #include <stdio.h>
  17 #include <stdlib.h>
  18 #include <stddef.h>
  19 #include <sys/types.h>
  20 #include <sys/socket.h>
  21 #include <sys/mman.h>
  22 #include <sys/stat.h>
  23 #include <netinet/in.h>
  24 #include <netdb.h>
  25 #include <signal.h>
  26 #include <stdbool.h>
  27 #include <vnet/vnet.h>
  28 #include <vlib/vlib.h>
  29 #include <vlib/unix/unix.h>
  30 #include <vlibapi/api.h>
  31 #include <vlibmemory/api.h>
  32
  33 #include <vpp/api/vpe_msg_enum.h>
  34
  35 #include "vppapiclient.h"
  36
  37 bool timeout_cancelled;
  38 bool timeout_in_progress;
  39 bool rx_thread_done;
  40
  41 /*
  42  * Asynchronous mode:
  43  *  Client registers a callback. All messages are sent to the callback.
  44  * Synchronous mode:
  45  *  Client calls blocking read().
  46  *  Clients are expected to collate events on a queue.
  47  *  vac_write() -> suspends RX thread
  48  *  vac_read() -> resumes RX thread
  49  */
  50
  51 #define vl_typedefs             /* define message structures */
  52 #include <vpp/api/vpe_all_api_h.h>
  53 #undef vl_typedefs
  54
  55 #define vl_endianfun             /* define message structures */
  56 #include <vpp/api/vpe_all_api_h.h>
  57 #undef vl_endianfun
  58
  59 vlib_main_t vlib_global_main;
  60 vlib_main_t **vlib_mains;
  61
  62 typedef struct {
  63   u8 connected_to_vlib;
  64   pthread_t rx_thread_handle;
  65   pthread_t timeout_thread_handle;
  66   pthread_mutex_t queue_lock;
  67   pthread_cond_t suspend_cv;
  68   pthread_cond_t resume_cv;
  69   pthread_mutex_t timeout_lock;
  70   u8 timeout_loop;
  71   pthread_cond_t timeout_cv;
  72   pthread_cond_t timeout_cancel_cv;
  73   pthread_cond_t terminate_cv;
  74 } vac_main_t;
  75
  76 vac_main_t vac_main;
  77 vac_callback_t vac_callback;
  78 u16 read_timeout = 0;
  79 bool rx_is_running = false;
  80 bool timeout_thread_cancelled = false;
  81
  82 static void
  83 init (void)
  84 {
  85   vac_main_t *pm = &vac_main;
  86   clib_memset(pm, 0, sizeof(*pm));
  87   pthread_mutex_init(&pm->queue_lock, NULL);
  88   pthread_cond_init(&pm->suspend_cv, NULL);
  89   pthread_cond_init(&pm->resume_cv, NULL);
  90   pthread_mutex_init(&pm->timeout_lock, NULL);
  91   pm->timeout_loop = 1;
  92   pthread_cond_init(&pm->timeout_cv, NULL);
  93   pthread_cond_init(&pm->timeout_cancel_cv, NULL);
  94   pthread_cond_init(&pm->terminate_cv, NULL);
  95 }
  96
  97 static void
  98 cleanup (void)
  99 {
 100   vac_main_t *pm = &vac_main;
 101   pthread_mutex_destroy(&pm->queue_lock);
 102   pthread_cond_destroy(&pm->suspend_cv);
 103   pthread_cond_destroy(&pm->resume_cv);
 104   pthread_mutex_destroy(&pm->timeout_lock);
 105   pthread_cond_destroy(&pm->timeout_cv);
 106   pthread_cond_destroy(&pm->timeout_cancel_cv);
 107   pthread_cond_destroy(&pm->terminate_cv);
 108   clib_memset(pm, 0, sizeof(*pm));
 109 }
 110
 111 /*
 112  * Satisfy external references when -lvlib is not available.
 113  */
 114 void vlib_cli_output (struct vlib_main_t * vm, char * fmt, ...)
 115 {
 116   clib_warning ("vlib_cli_output called...");
 117 }
 118
 119 void
 120 vac_free (void * msg)
 121 {
 122   vl_msg_api_free (msg);
 123 }
 124
 125 static void
 126 vac_api_handler (void *msg)
 127 {
 128   u16 id = ntohs(*((u16 *)msg));
 129   msgbuf_t *msgbuf = (msgbuf_t *)(((u8 *)msg) - offsetof(msgbuf_t, data));
 130   int l = ntohl(msgbuf->data_len);
 131   if (l == 0)
 132     clib_warning("Message ID %d has wrong length: %d\n", id, l);
 133
 134   /* Call Python callback */
 135   ASSERT(vac_callback);
 136   (vac_callback)(msg, l);
 137   vac_free(msg);
 138 }
 139
 140 static void *
 141 vac_rx_thread_fn (void *arg)
 142 {
 143   svm_queue_t *q;
 144   vl_api_memclnt_keepalive_t *mp;
 145   vl_api_memclnt_keepalive_reply_t *rmp;
 146   vac_main_t *pm = &vac_main;
 147   api_main_t *am = vlibapi_get_main();
 148   vl_shmem_hdr_t *shmem_hdr;
 149   uword msg;
 150
 151   q = am->vl_input_queue;
 152
 153   while (1)
 154     while (!svm_queue_sub(q, (u8 *)&msg, SVM_Q_WAIT, 0))
 155       {
 156         VL_MSG_API_UNPOISON((void *)msg);
 157         u16 id = ntohs(*((u16 *)msg));
 158         switch (id) {
 159         case VL_API_RX_THREAD_EXIT:
 160           vl_msg_api_free((void *) msg);
 161           /* signal waiting threads that this thread is about to terminate */
 162           pthread_mutex_lock(&pm->queue_lock);
 163           rx_thread_done = true;
 164           pthread_cond_signal(&pm->terminate_cv);
 165           pthread_mutex_unlock(&pm->queue_lock);
 166           pthread_exit(0);
 167           return 0;
 168           break;
 169
 170         case VL_API_MEMCLNT_RX_THREAD_SUSPEND:
 171           vl_msg_api_free((void * )msg);
 172           /* Suspend thread and signal reader */
 173           pthread_mutex_lock(&pm->queue_lock);
 174           pthread_cond_signal(&pm->suspend_cv);
 175           /* Wait for the resume signal */
 176           pthread_cond_wait (&pm->resume_cv, &pm->queue_lock);
 177           pthread_mutex_unlock(&pm->queue_lock);
 178           break;
 179
 180         case VL_API_MEMCLNT_READ_TIMEOUT:
 181           clib_warning("Received read timeout in async thread\n");
 182           vl_msg_api_free((void *) msg);
 183           break;
 184
 185         case VL_API_MEMCLNT_KEEPALIVE:
 186           mp = (void *)msg;
 187           rmp = vl_msg_api_alloc (sizeof (*rmp));
 188           clib_memset (rmp, 0, sizeof (*rmp));
 189           rmp->_vl_msg_id = ntohs(VL_API_MEMCLNT_KEEPALIVE_REPLY);
 190           rmp->context = mp->context;
 191           shmem_hdr = am->shmem_hdr;
 192           vl_msg_api_send_shmem(shmem_hdr->vl_input_queue, (u8 *)&rmp);
 193           vl_msg_api_free((void *) msg);
 194           break;
 195
 196         default:
 197           vac_api_handler((void *)msg);
 198         }
 199       }
 200 }
 201
 202 static void *
 203 vac_timeout_thread_fn (void *arg)
 204 {
 205   vl_api_memclnt_read_timeout_t *ep;
 206   vac_main_t *pm = &vac_main;
 207   api_main_t *am = vlibapi_get_main();
 208   struct timespec ts;
 209   struct timeval tv;
 210   int rv;
 211
 212   while (pm->timeout_loop)
 213     {
 214       /* Wait for poke */
 215       pthread_mutex_lock(&pm->timeout_lock);
 216       while (!timeout_in_progress)
 217         pthread_cond_wait (&pm->timeout_cv, &pm->timeout_lock);
 218
 219       /* Starting timer */
 220       gettimeofday(&tv, NULL);
 221       ts.tv_sec = tv.tv_sec + read_timeout;
 222       ts.tv_nsec = 0;
 223
 224       if (!timeout_cancelled) {
 225         rv = pthread_cond_timedwait (&pm->timeout_cancel_cv,
 226                                      &pm->timeout_lock, &ts);
 227         if (rv == ETIMEDOUT && !timeout_thread_cancelled) {
 228           ep = vl_msg_api_alloc (sizeof (*ep));
 229           ep->_vl_msg_id = ntohs(VL_API_MEMCLNT_READ_TIMEOUT);
 230           vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
 231         }
 232       }
 233
 234       pthread_mutex_unlock(&pm->timeout_lock);
 235     }
 236   pthread_exit(0);
 237 }
 238
 239 void
 240 vac_rx_suspend (void)
 241 {
 242   api_main_t *am = vlibapi_get_main();
 243   vac_main_t *pm = &vac_main;
 244   vl_api_memclnt_rx_thread_suspend_t *ep;
 245
 246   if (!pm->rx_thread_handle) return;
 247   pthread_mutex_lock(&pm->queue_lock);
 248   if (rx_is_running)
 249     {
 250       ep = vl_msg_api_alloc (sizeof (*ep));
 251       ep->_vl_msg_id = ntohs(VL_API_MEMCLNT_RX_THREAD_SUSPEND);
 252       vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
 253       /* Wait for RX thread to tell us it has suspended */
 254       pthread_cond_wait(&pm->suspend_cv, &pm->queue_lock);
 255       rx_is_running = false;
 256     }
 257   pthread_mutex_unlock(&pm->queue_lock);
 258 }
 259
 260 void
 261 vac_rx_resume (void)
 262 {
 263   vac_main_t *pm = &vac_main;
 264   if (!pm->rx_thread_handle) return;
 265   pthread_mutex_lock(&pm->queue_lock);
 266   if (rx_is_running) goto unlock;
 267   pthread_cond_signal(&pm->resume_cv);
 268   rx_is_running = true;
 269  unlock:
 270   pthread_mutex_unlock(&pm->queue_lock);
 271 }
 272
 273 static uword *
 274 vac_msg_table_get_hash (void)
 275 {
 276   api_main_t *am = vlibapi_get_main();
 277   return (am->msg_index_by_name_and_crc);
 278 }
 279
 280 int
 281 vac_msg_table_size(void)
 282 {
 283   api_main_t *am = vlibapi_get_main();
 284   return hash_elts(am->msg_index_by_name_and_crc);
 285 }
 286
 287 int
 288 vac_connect (char * name, char * chroot_prefix, vac_callback_t cb,
 289              int rx_qlen)
 290 {
 291   rx_thread_done = false;
 292   int rv = 0;
 293   vac_main_t *pm = &vac_main;
 294
 295   assert (clib_mem_get_heap ());
 296   init();
 297   if (chroot_prefix != NULL)
 298     vl_set_memory_root_path (chroot_prefix);
 299
 300   if ((rv = vl_client_api_map("/vpe-api"))) {
 301     clib_warning ("vl_client_api_map returned %d", rv);
 302     return rv;
 303   }
 304
 305   if (vl_client_connect(name, 0, rx_qlen) < 0) {
 306     vl_client_api_unmap();
 307     return (-1);
 308   }
 309
 310   if (cb) {
 311     /* Start the rx queue thread */
 312     rv = pthread_create(&pm->rx_thread_handle, NULL, vac_rx_thread_fn, 0);
 313     if (rv) {
 314       clib_warning("pthread_create returned %d", rv);
 315       vl_client_api_unmap();
 316       return (-1);
 317     }
 318     vac_callback = cb;
 319     rx_is_running = true;
 320   }
 321
 322   /* Start read timeout thread */
 323   rv = pthread_create(&pm->timeout_thread_handle, NULL,
 324                       vac_timeout_thread_fn, 0);
 325   if (rv) {
 326     clib_warning("pthread_create returned %d", rv);
 327     vl_client_api_unmap();
 328     return (-1);
 329   }
 330
 331   pm->connected_to_vlib = 1;
 332
 333   return (0);
 334 }
 335 static void
 336 set_timeout (unsigned short timeout)
 337 {
 338   vac_main_t *pm = &vac_main;
 339   pthread_mutex_lock(&pm->timeout_lock);
 340   read_timeout = timeout;
 341   timeout_in_progress = true;
 342   timeout_cancelled = false;
 343   pthread_cond_signal(&pm->timeout_cv);
 344   pthread_mutex_unlock(&pm->timeout_lock);
 345 }
 346
 347 static void
 348 unset_timeout (void)
 349 {
 350   vac_main_t *pm = &vac_main;
 351   pthread_mutex_lock(&pm->timeout_lock);
 352   timeout_in_progress = false;
 353   timeout_cancelled = true;
 354   pthread_cond_signal(&pm->timeout_cancel_cv);
 355   pthread_mutex_unlock(&pm->timeout_lock);
 356 }
 357
 358 int
 359 vac_disconnect (void)
 360 {
 361   api_main_t *am = vlibapi_get_main();
 362   vac_main_t *pm = &vac_main;
 363   uword junk;
 364   int rv = 0;
 365
 366   if (!pm->connected_to_vlib) return 0;
 367
 368   if (pm->rx_thread_handle) {
 369     vl_api_rx_thread_exit_t *ep;
 370     ep = vl_msg_api_alloc (sizeof (*ep));
 371     ep->_vl_msg_id = ntohs(VL_API_RX_THREAD_EXIT);
 372     vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
 373
 374     /* wait (with timeout) until RX thread has finished */
 375     struct timespec ts;
 376     struct timeval tv;
 377     gettimeofday(&tv, NULL);
 378     ts.tv_sec = tv.tv_sec + 5;
 379     ts.tv_nsec = 0;
 380
 381     pthread_mutex_lock(&pm->queue_lock);
 382     if (rx_thread_done == false)
 383       rv = pthread_cond_timedwait(&pm->terminate_cv, &pm->queue_lock, &ts);
 384     pthread_mutex_unlock(&pm->queue_lock);
 385
 386     /* now join so we wait until thread has -really- finished */
 387     if (rv == ETIMEDOUT)
 388       pthread_cancel(pm->rx_thread_handle);
 389     else
 390       pthread_join(pm->rx_thread_handle, (void **) &junk);
 391   }
 392   if (pm->timeout_thread_handle) {
 393     /* cancel, wake then join the timeout thread */
 394     pm->timeout_loop = 0;
 395     timeout_thread_cancelled = true;
 396     set_timeout(0);
 397     pthread_join(pm->timeout_thread_handle, (void **) &junk);
 398   }
 399
 400   vl_client_disconnect();
 401   vl_client_api_unmap();
 402   vac_callback = 0;
 403
 404   cleanup();
 405
 406   return (0);
 407 }
 408
 409 int
 410 vac_read (char **p, int *l, u16 timeout)
 411 {
 412   svm_queue_t *q;
 413   api_main_t *am = vlibapi_get_main();
 414   vac_main_t *pm = &vac_main;
 415   vl_api_memclnt_keepalive_t *mp;
 416   vl_api_memclnt_keepalive_reply_t *rmp;
 417   uword msg;
 418   msgbuf_t *msgbuf;
 419   int rv;
 420   vl_shmem_hdr_t *shmem_hdr;
 421
 422   /* svm_queue_sub(below) returns {-1, -2} */
 423   if (!pm->connected_to_vlib) return -3;
 424
 425   *l = 0;
 426
 427   /* svm_queue_sub(below) returns {-1, -2} */
 428   if (am->our_pid == 0) return (-4);
 429
 430   /* Poke timeout thread */
 431   if (timeout)
 432     set_timeout(timeout);
 433
 434   q = am->vl_input_queue;
 435
 436  again:
 437   rv = svm_queue_sub(q, (u8 *)&msg, SVM_Q_WAIT, 0);
 438
 439   if (rv == 0) {
 440     VL_MSG_API_UNPOISON((void *)msg);
 441     u16 msg_id = ntohs(*((u16 *)msg));
 442     switch (msg_id) {
 443     case VL_API_RX_THREAD_EXIT:
 444       vl_msg_api_free((void *) msg);
 445       goto error;
 446     case VL_API_MEMCLNT_RX_THREAD_SUSPEND:
 447       goto error;
 448     case VL_API_MEMCLNT_READ_TIMEOUT:
 449       goto error;
 450     case VL_API_MEMCLNT_KEEPALIVE:
 451       /* Handle an alive-check ping from vpp. */
 452       mp = (void *)msg;
 453       rmp = vl_msg_api_alloc (sizeof (*rmp));
 454       clib_memset (rmp, 0, sizeof (*rmp));
 455       rmp->_vl_msg_id = ntohs(VL_API_MEMCLNT_KEEPALIVE_REPLY);
 456       rmp->context = mp->context;
 457       shmem_hdr = am->shmem_hdr;
 458       vl_msg_api_send_shmem(shmem_hdr->vl_input_queue, (u8 *)&rmp);
 459       vl_msg_api_free((void *) msg);
 460       /*
 461        * Python code is blissfully unaware of these pings, so
 462        * act as if it never happened...
 463        */
 464       goto again;
 465
 466     default:
 467       msgbuf = (msgbuf_t *)(((u8 *)msg) - offsetof(msgbuf_t, data));
 468       *l = ntohl(msgbuf->data_len);
 469       if (*l == 0) {
 470         fprintf(stderr, "Unregistered API message: %d\n", msg_id);
 471         goto error;
 472       }
 473     }
 474     *p = (char *)msg;
 475
 476
 477   } else {
 478     fprintf(stderr, "Read failed with %d\n", rv);
 479   }
 480   /* Let timeout notification thread know we're done */
 481   if (timeout)
 482     unset_timeout();
 483
 484   return (rv);
 485
 486  error:
 487   if (timeout)
 488     unset_timeout();
 489   vl_msg_api_free((void *) msg);
 490   /* Client might forget to resume RX thread on failure */
 491   vac_rx_resume ();
 492   return -1;
 493 }
 494
 495 /*
 496  * XXX: Makes the assumption that client_index is the first member
 497  */
 498 typedef VL_API_PACKED(struct _vl_api_header {
 499   u16 _vl_msg_id;
 500   u32 client_index;
 501 }) vl_api_header_t;
 502
 503 static u32
 504 vac_client_index (void)
 505 {
 506   return (vlibapi_get_main()->my_client_index);
 507 }
 508
 509 int
 510 vac_write (char *p, int l)
 511 {
 512   int rv = -1;
 513   api_main_t *am = vlibapi_get_main();
 514   vl_api_header_t *mp = vl_msg_api_alloc(l);
 515   svm_queue_t *q;
 516   vac_main_t *pm = &vac_main;
 517
 518   if (!pm->connected_to_vlib) return -1;
 519   if (!mp) return (-1);
 520
 521   memcpy(mp, p, l);
 522   mp->client_index = vac_client_index();
 523   q = am->shmem_hdr->vl_input_queue;
 524   rv = svm_queue_add(q, (u8 *)&mp, 0);
 525   if (rv != 0) {
 526     fprintf(stderr, "vpe_api_write fails: %d\n", rv);
 527     /* Clear message */
 528     vac_free(mp);
 529   }
 530   return (rv);
 531 }
 532
 533 int
 534 vac_get_msg_index (unsigned char * name)
 535 {
 536   return vl_msg_api_get_msg_index (name);
 537 }
 538
 539 int
 540 vac_msg_table_max_index(void)
 541 {
 542   int max = 0;
 543   hash_pair_t *hp;
 544   uword *h = vac_msg_table_get_hash();
 545   hash_foreach_pair (hp, h,
 546   ({
 547     if (hp->value[0] > max)
 548       max = hp->value[0];
 549   }));
 550
 551   return max;
 552 }
 553
 554 void
 555 vac_set_error_handler (vac_error_callback_t cb)
 556 {
 557   assert (clib_mem_get_heap ());
 558   if (cb) clib_error_register_handler (cb, 0);
 559 }
 560
 561 /*
 562  * Required if application doesn't use a VPP heap.
 563  */
 564 void
 565 vac_mem_init (size_t size)
 566 {
 567   if (size == 0)
 568     clib_mem_init (0, 1 << 30);  // default
 569   else
 570     clib_mem_init (0, size);
 571 }