src/vpp-api/vapi/vapi.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2017 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #include <stdlib.h>
  19 #include <stdio.h>
  20 #include <stdint.h>
  21 #include <arpa/inet.h>
  22 #include <stddef.h>
  23 #include <assert.h>
  24
  25 #include <vpp-api/vapi/vapi_dbg.h>
  26 #include <vpp-api/vapi/vapi.h>
  27 #include <vpp-api/vapi/vapi_internal.h>
  28 #include <vppinfra/types.h>
  29 #include <vppinfra/pool.h>
  30 #include <vlib/vlib.h>
  31 #include <vlibapi/api_common.h>
  32 #include <vlibmemory/memory_client.h>
  33
  34 /* we need to use control pings for some stuff and because we're forced to put
  35  * the code in headers, we need a way to be able to grab the ids of these
  36  * messages - so declare them here as extern */
  37 vapi_msg_id_t vapi_msg_id_control_ping = 0;
  38 vapi_msg_id_t vapi_msg_id_control_ping_reply = 0;
  39
  40 struct
  41 {
  42   size_t count;
  43   vapi_message_desc_t **msgs;
  44   size_t max_len_name_with_crc;
  45 } __vapi_metadata;
  46
  47 typedef struct
  48 {
  49   u32 context;
  50   vapi_cb_t callback;
  51   void *callback_ctx;
  52   bool is_dump;
  53 } vapi_req_t;
  54
  55 static const u32 context_counter_mask = (1 << 31);
  56
  57 typedef struct
  58 {
  59   vapi_error_e (*cb) (vapi_ctx_t ctx, void *callback_ctx, vapi_msg_id_t id,
  60                       void *payload);
  61   void *ctx;
  62 } vapi_generic_cb_with_ctx;
  63
  64 typedef struct
  65 {
  66   vapi_error_e (*cb) (vapi_ctx_t ctx, void *callback_ctx, void *payload);
  67   void *ctx;
  68 } vapi_event_cb_with_ctx;
  69
  70 struct vapi_ctx_s
  71 {
  72   vapi_mode_e mode;
  73   int requests_size;            /* size of the requests array (circular queue) */
  74   int requests_start;           /* index of first request */
  75   int requests_count;           /* number of used slots */
  76   vapi_req_t *requests;
  77   u32 context_counter;
  78   vapi_generic_cb_with_ctx generic_cb;
  79   vapi_event_cb_with_ctx *event_cbs;
  80   u16 *vapi_msg_id_t_to_vl_msg_id;
  81   u16 vl_msg_id_max;
  82   vapi_msg_id_t *vl_msg_id_to_vapi_msg_t;
  83   bool connected;
  84   pthread_mutex_t requests_mutex;
  85 };
  86
  87 u32
  88 vapi_gen_req_context (vapi_ctx_t ctx)
  89 {
  90   ++ctx->context_counter;
  91   ctx->context_counter %= context_counter_mask;
  92   return ctx->context_counter | context_counter_mask;
  93 }
  94
  95 size_t
  96 vapi_get_request_count (vapi_ctx_t ctx)
  97 {
  98   return ctx->requests_count;
  99 }
 100
 101 bool
 102 vapi_requests_full (vapi_ctx_t ctx)
 103 {
 104   return (ctx->requests_count == ctx->requests_size);
 105 }
 106
 107 bool
 108 vapi_requests_empty (vapi_ctx_t ctx)
 109 {
 110   return (0 == ctx->requests_count);
 111 }
 112
 113 static int
 114 vapi_requests_end (vapi_ctx_t ctx)
 115 {
 116   return (ctx->requests_start + ctx->requests_count) % ctx->requests_size;
 117 }
 118
 119 void
 120 vapi_store_request (vapi_ctx_t ctx, u32 context, bool is_dump,
 121                     vapi_cb_t callback, void *callback_ctx)
 122 {
 123   assert (!vapi_requests_full (ctx));
 124   /* if the mutex is not held, bad things will happen */
 125   assert (0 != pthread_mutex_trylock (&ctx->requests_mutex));
 126   const int requests_end = vapi_requests_end (ctx);
 127   vapi_req_t *slot = &ctx->requests[requests_end];
 128   slot->is_dump = is_dump;
 129   slot->context = context;
 130   slot->callback = callback;
 131   slot->callback_ctx = callback_ctx;
 132   VAPI_DBG ("stored@%d: context:%x (start is @%d)", requests_end, context,
 133             ctx->requests_start);
 134   ++ctx->requests_count;
 135   assert (!vapi_requests_empty (ctx));
 136 }
 137
 138 #if VAPI_DEBUG_ALLOC
 139 struct to_be_freed_s;
 140 struct to_be_freed_s
 141 {
 142   void *v;
 143   struct to_be_freed_s *next;
 144 };
 145
 146 static struct to_be_freed_s *to_be_freed = NULL;
 147
 148 void
 149 vapi_add_to_be_freed (void *v)
 150 {
 151   struct to_be_freed_s *prev = NULL;
 152   struct to_be_freed_s *tmp;
 153   tmp = to_be_freed;
 154   while (tmp && tmp->v)
 155     {
 156       prev = tmp;
 157       tmp = tmp->next;
 158     }
 159   if (!tmp)
 160     {
 161       if (!prev)
 162         {
 163           tmp = to_be_freed = calloc (1, sizeof (*to_be_freed));
 164         }
 165       else
 166         {
 167           tmp = prev->next = calloc (1, sizeof (*to_be_freed));
 168         }
 169     }
 170   VAPI_DBG ("To be freed %p", v);
 171   tmp->v = v;
 172 }
 173
 174 void
 175 vapi_trace_free (void *v)
 176 {
 177   struct to_be_freed_s *tmp = to_be_freed;
 178   while (tmp && tmp->v != v)
 179     {
 180       tmp = tmp->next;
 181     }
 182   if (tmp && tmp->v == v)
 183     {
 184       VAPI_DBG ("Freed %p", v);
 185       tmp->v = NULL;
 186     }
 187   else
 188     {
 189       VAPI_ERR ("Trying to free untracked pointer %p", v);
 190       abort ();
 191     }
 192 }
 193
 194 void
 195 vapi_to_be_freed_validate ()
 196 {
 197   struct to_be_freed_s *tmp = to_be_freed;
 198   while (tmp)
 199     {
 200       if (tmp->v)
 201         {
 202           VAPI_ERR ("Unfreed msg %p!", tmp->v);
 203         }
 204       tmp = tmp->next;
 205     }
 206 }
 207
 208 #endif
 209
 210 void *
 211 vapi_msg_alloc (vapi_ctx_t ctx, size_t size)
 212 {
 213   if (!ctx->connected)
 214     {
 215       return NULL;
 216     }
 217   void *rv = vl_msg_api_alloc_or_null (size);
 218   return rv;
 219 }
 220
 221 void
 222 vapi_msg_free (vapi_ctx_t ctx, void *msg)
 223 {
 224   if (!ctx->connected)
 225     {
 226       return;
 227     }
 228 #if VAPI_DEBUG_ALLOC
 229   vapi_trace_free (msg);
 230 #endif
 231   vl_msg_api_free (msg);
 232 }
 233
 234 vapi_msg_id_t
 235 vapi_lookup_vapi_msg_id_t (vapi_ctx_t ctx, u16 vl_msg_id)
 236 {
 237   if (vl_msg_id <= ctx->vl_msg_id_max)
 238     {
 239       return ctx->vl_msg_id_to_vapi_msg_t[vl_msg_id];
 240     }
 241   return INVALID_MSG_ID;
 242 }
 243
 244 vapi_error_e
 245 vapi_ctx_alloc (vapi_ctx_t * result)
 246 {
 247   vapi_ctx_t ctx = calloc (1, sizeof (struct vapi_ctx_s));
 248   if (!ctx)
 249     {
 250       return VAPI_ENOMEM;
 251     }
 252   ctx->context_counter = 0;
 253   ctx->vapi_msg_id_t_to_vl_msg_id =
 254     malloc (__vapi_metadata.count *
 255             sizeof (*ctx->vapi_msg_id_t_to_vl_msg_id));
 256   if (!ctx->vapi_msg_id_t_to_vl_msg_id)
 257     {
 258       goto fail;
 259     }
 260   ctx->event_cbs = calloc (__vapi_metadata.count, sizeof (*ctx->event_cbs));
 261   if (!ctx->event_cbs)
 262     {
 263       goto fail;
 264     }
 265   pthread_mutex_init (&ctx->requests_mutex, NULL);
 266   *result = ctx;
 267   return VAPI_OK;
 268 fail:
 269   vapi_ctx_free (ctx);
 270   return VAPI_ENOMEM;
 271 }
 272
 273 void
 274 vapi_ctx_free (vapi_ctx_t ctx)
 275 {
 276   assert (!ctx->connected);
 277   free (ctx->requests);
 278   free (ctx->vapi_msg_id_t_to_vl_msg_id);
 279   free (ctx->event_cbs);
 280   free (ctx->vl_msg_id_to_vapi_msg_t);
 281   pthread_mutex_destroy (&ctx->requests_mutex);
 282   free (ctx);
 283 }
 284
 285 bool
 286 vapi_is_msg_available (vapi_ctx_t ctx, vapi_msg_id_t id)
 287 {
 288   return vapi_lookup_vl_msg_id (ctx, id) != UINT16_MAX;
 289 }
 290
 291 vapi_error_e
 292 vapi_connect (vapi_ctx_t ctx, const char *name,
 293               const char *chroot_prefix,
 294               int max_outstanding_requests,
 295               int response_queue_size, vapi_mode_e mode)
 296 {
 297   if (response_queue_size <= 0 || max_outstanding_requests <= 0)
 298     {
 299       return VAPI_EINVAL;
 300     }
 301   ctx->requests_size = max_outstanding_requests;
 302   const size_t size = ctx->requests_size * sizeof (*ctx->requests);
 303   void *tmp = realloc (ctx->requests, size);
 304   if (!tmp)
 305     {
 306       return VAPI_ENOMEM;
 307     }
 308   ctx->requests = tmp;
 309   memset (ctx->requests, 0, size);
 310   /* coverity[MISSING_LOCK] - 177211 requests_mutex is not needed here */
 311   ctx->requests_start = ctx->requests_count = 0;
 312   if (chroot_prefix)
 313     {
 314       VAPI_DBG ("set memory root path `%s'", chroot_prefix);
 315       vl_set_memory_root_path ((char *) chroot_prefix);
 316     }
 317   static char api_map[] = "/vpe-api";
 318   VAPI_DBG ("client api map `%s'", api_map);
 319   if ((vl_client_api_map (api_map)) < 0)
 320     {
 321       return VAPI_EMAP_FAIL;
 322     }
 323   VAPI_DBG ("connect client `%s'", name);
 324   if (vl_client_connect ((char *) name, 0, response_queue_size) < 0)
 325     {
 326       vl_client_api_unmap ();
 327       return VAPI_ECON_FAIL;
 328     }
 329 #if VAPI_DEBUG_CONNECT
 330   VAPI_DBG ("start probing messages");
 331 #endif
 332   int rv;
 333   int i;
 334   for (i = 0; i < __vapi_metadata.count; ++i)
 335     {
 336       vapi_message_desc_t *m = __vapi_metadata.msgs[i];
 337       u8 scratch[m->name_with_crc_len + 1];
 338       memcpy (scratch, m->name_with_crc, m->name_with_crc_len + 1);
 339       u32 id = vl_msg_api_get_msg_index (scratch);
 340       if (INVALID_MSG_ID != id)
 341         {
 342           if (id > UINT16_MAX)
 343             {
 344               VAPI_ERR ("Returned vl_msg_id `%u' > UINT16MAX `%u'!", id,
 345                         UINT16_MAX);
 346               rv = VAPI_EINVAL;
 347               goto fail;
 348             }
 349           if (id > ctx->vl_msg_id_max)
 350             {
 351               vapi_msg_id_t *tmp = realloc (ctx->vl_msg_id_to_vapi_msg_t,
 352                                             sizeof
 353                                             (*ctx->vl_msg_id_to_vapi_msg_t) *
 354                                             (id + 1));
 355               if (!tmp)
 356                 {
 357                   rv = VAPI_ENOMEM;
 358                   goto fail;
 359                 }
 360               ctx->vl_msg_id_to_vapi_msg_t = tmp;
 361               ctx->vl_msg_id_max = id;
 362             }
 363           ctx->vl_msg_id_to_vapi_msg_t[id] = m->id;
 364           ctx->vapi_msg_id_t_to_vl_msg_id[m->id] = id;
 365 #if VAPI_DEBUG_CONNECT
 366           VAPI_DBG ("Message `%s' has vl_msg_id `%u'", m->name_with_crc,
 367                     (unsigned) id);
 368 #endif
 369         }
 370       else
 371         {
 372           ctx->vapi_msg_id_t_to_vl_msg_id[m->id] = UINT16_MAX;
 373           VAPI_DBG ("Message `%s' not available", m->name_with_crc);
 374         }
 375     }
 376 #if VAPI_DEBUG_CONNECT
 377   VAPI_DBG ("finished probing messages");
 378 #endif
 379   if (!vapi_is_msg_available (ctx, vapi_msg_id_control_ping) ||
 380       !vapi_is_msg_available (ctx, vapi_msg_id_control_ping_reply))
 381     {
 382       VAPI_ERR
 383         ("control ping or control ping reply not available, cannot connect");
 384       rv = VAPI_EINCOMPATIBLE;
 385       goto fail;
 386     }
 387   ctx->mode = mode;
 388   ctx->connected = true;
 389   return VAPI_OK;
 390 fail:
 391   vl_client_disconnect ();
 392   vl_client_api_unmap ();
 393   return rv;
 394 }
 395
 396 vapi_error_e
 397 vapi_disconnect (vapi_ctx_t ctx)
 398 {
 399   if (!ctx->connected)
 400     {
 401       return VAPI_EINVAL;
 402     }
 403   vl_client_disconnect ();
 404   vl_client_api_unmap ();
 405 #if VAPI_DEBUG_ALLOC
 406   vapi_to_be_freed_validate ();
 407 #endif
 408   ctx->connected = false;
 409   return VAPI_OK;
 410 }
 411
 412 vapi_error_e
 413 vapi_get_fd (vapi_ctx_t ctx, int *fd)
 414 {
 415   return VAPI_ENOTSUP;
 416 }
 417
 418 vapi_error_e
 419 vapi_send (vapi_ctx_t ctx, void *msg)
 420 {
 421   vapi_error_e rv = VAPI_OK;
 422   if (!ctx || !msg || !ctx->connected)
 423     {
 424       rv = VAPI_EINVAL;
 425       goto out;
 426     }
 427   int tmp;
 428   svm_queue_t *q = api_main.shmem_hdr->vl_input_queue;
 429 #if VAPI_DEBUG
 430   unsigned msgid = be16toh (*(u16 *) msg);
 431   if (msgid <= ctx->vl_msg_id_max)
 432     {
 433       vapi_msg_id_t id = ctx->vl_msg_id_to_vapi_msg_t[msgid];
 434       if (id < __vapi_metadata.count)
 435         {
 436           VAPI_DBG ("send msg@%p:%u[%s]", msg, msgid,
 437                     __vapi_metadata.msgs[id]->name);
 438         }
 439       else
 440         {
 441           VAPI_DBG ("send msg@%p:%u[UNKNOWN]", msg, msgid);
 442         }
 443     }
 444   else
 445     {
 446       VAPI_DBG ("send msg@%p:%u[UNKNOWN]", msg, msgid);
 447     }
 448 #endif
 449   tmp = svm_queue_add (q, (u8 *) & msg,
 450                        VAPI_MODE_BLOCKING == ctx->mode ? 0 : 1);
 451   if (tmp < 0)
 452     {
 453       rv = VAPI_EAGAIN;
 454     }
 455 out:
 456   VAPI_DBG ("vapi_send() rv = %d", rv);
 457   return rv;
 458 }
 459
 460 vapi_error_e
 461 vapi_send2 (vapi_ctx_t ctx, void *msg1, void *msg2)
 462 {
 463   vapi_error_e rv = VAPI_OK;
 464   if (!ctx || !msg1 || !msg2 || !ctx->connected)
 465     {
 466       rv = VAPI_EINVAL;
 467       goto out;
 468     }
 469   svm_queue_t *q = api_main.shmem_hdr->vl_input_queue;
 470 #if VAPI_DEBUG
 471   unsigned msgid1 = be16toh (*(u16 *) msg1);
 472   unsigned msgid2 = be16toh (*(u16 *) msg2);
 473   const char *name1 = "UNKNOWN";
 474   const char *name2 = "UNKNOWN";
 475   if (msgid1 <= ctx->vl_msg_id_max)
 476     {
 477       vapi_msg_id_t id = ctx->vl_msg_id_to_vapi_msg_t[msgid1];
 478       if (id < __vapi_metadata.count)
 479         {
 480           name1 = __vapi_metadata.msgs[id]->name;
 481         }
 482     }
 483   if (msgid2 <= ctx->vl_msg_id_max)
 484     {
 485       vapi_msg_id_t id = ctx->vl_msg_id_to_vapi_msg_t[msgid2];
 486       if (id < __vapi_metadata.count)
 487         {
 488           name2 = __vapi_metadata.msgs[id]->name;
 489         }
 490     }
 491   VAPI_DBG ("send two: %u[%s], %u[%s]", msgid1, name1, msgid2, name2);
 492 #endif
 493   int tmp = svm_queue_add2 (q, (u8 *) & msg1, (u8 *) & msg2,
 494                             VAPI_MODE_BLOCKING == ctx->mode ? 0 : 1);
 495   if (tmp < 0)
 496     {
 497       rv = VAPI_EAGAIN;
 498     }
 499 out:
 500   VAPI_DBG ("vapi_send() rv = %d", rv);
 501   return rv;
 502 }
 503
 504 vapi_error_e
 505 vapi_recv (vapi_ctx_t ctx, void **msg, size_t * msg_size)
 506 {
 507   if (!ctx || !ctx->connected || !msg || !msg_size)
 508     {
 509       return VAPI_EINVAL;
 510     }
 511   vapi_error_e rv = VAPI_OK;
 512   api_main_t *am = &api_main;
 513   uword data;
 514
 515   if (am->our_pid == 0)
 516     {
 517       return VAPI_EINVAL;
 518     }
 519
 520   svm_queue_t *q = am->vl_input_queue;
 521   VAPI_DBG ("doing shm queue sub");
 522   int tmp = svm_queue_sub (q, (u8 *) & data, 0);
 523   if (tmp == 0)
 524     {
 525 #if VAPI_DEBUG_ALLOC
 526       vapi_add_to_be_freed ((void *) data);
 527 #endif
 528       msgbuf_t *msgbuf =
 529         (msgbuf_t *) ((u8 *) data - offsetof (msgbuf_t, data));
 530       if (!msgbuf->data_len)
 531         {
 532           vapi_msg_free (ctx, (u8 *) data);
 533           return VAPI_EAGAIN;
 534         }
 535       *msg = (u8 *) data;
 536       *msg_size = ntohl (msgbuf->data_len);
 537 #if VAPI_DEBUG
 538       unsigned msgid = be16toh (*(u16 *) * msg);
 539       if (msgid <= ctx->vl_msg_id_max)
 540         {
 541           vapi_msg_id_t id = ctx->vl_msg_id_to_vapi_msg_t[msgid];
 542           if (id < __vapi_metadata.count)
 543             {
 544               VAPI_DBG ("recv msg@%p:%u[%s]", *msg, msgid,
 545                         __vapi_metadata.msgs[id]->name);
 546             }
 547           else
 548             {
 549               VAPI_DBG ("recv msg@%p:%u[UNKNOWN]", *msg, msgid);
 550             }
 551         }
 552       else
 553         {
 554           VAPI_DBG ("recv msg@%p:%u[UNKNOWN]", *msg, msgid);
 555         }
 556 #endif
 557     }
 558   else
 559     {
 560       rv = VAPI_EAGAIN;
 561     }
 562   return rv;
 563 }
 564
 565 vapi_error_e
 566 vapi_wait (vapi_ctx_t ctx, vapi_wait_mode_e mode)
 567 {
 568   return VAPI_ENOTSUP;
 569 }
 570
 571 static vapi_error_e
 572 vapi_dispatch_response (vapi_ctx_t ctx, vapi_msg_id_t id,
 573                         u32 context, void *msg)
 574 {
 575   int mrv;
 576   if (0 != (mrv = pthread_mutex_lock (&ctx->requests_mutex)))
 577     {
 578       VAPI_DBG ("pthread_mutex_lock() failed, rv=%d:%s", mrv, strerror (mrv));
 579       return VAPI_MUTEX_FAILURE;
 580     }
 581   int tmp = ctx->requests_start;
 582   const int requests_end = vapi_requests_end (ctx);
 583   while (ctx->requests[tmp].context != context && tmp != requests_end)
 584     {
 585       ++tmp;
 586       if (tmp == ctx->requests_size)
 587         {
 588           tmp = 0;
 589         }
 590     }
 591   VAPI_DBG ("dispatch, search from %d, %s at %d", ctx->requests_start,
 592             ctx->requests[tmp].context == context ? "matched" : "stopped",
 593             tmp);
 594   vapi_error_e rv = VAPI_OK;
 595   if (ctx->requests[tmp].context == context)
 596     {
 597       while (ctx->requests_start != tmp)
 598         {
 599           VAPI_ERR ("No response to req with context=%u",
 600                     (unsigned) ctx->requests[tmp].context);
 601           ctx->requests[ctx->requests_start].callback (ctx,
 602                                                        ctx->requests
 603                                                        [ctx->
 604                                                         requests_start].callback_ctx,
 605                                                        VAPI_ENORESP, true,
 606                                                        NULL);
 607           memset (&ctx->requests[ctx->requests_start], 0,
 608                   sizeof (ctx->requests[ctx->requests_start]));
 609           ++ctx->requests_start;
 610           --ctx->requests_count;
 611           if (ctx->requests_start == ctx->requests_size)
 612             {
 613               ctx->requests_start = 0;
 614             }
 615         }
 616       // now ctx->requests_start == tmp
 617       int payload_offset = vapi_get_payload_offset (id);
 618       void *payload = ((u8 *) msg) + payload_offset;
 619       bool is_last = true;
 620       if (ctx->requests[tmp].is_dump)
 621         {
 622           if (vapi_msg_id_control_ping_reply == id)
 623             {
 624               payload = NULL;
 625             }
 626           else
 627             {
 628               is_last = false;
 629             }
 630         }
 631       if (payload_offset != -1)
 632         {
 633           rv =
 634             ctx->requests[tmp].callback (ctx, ctx->requests[tmp].callback_ctx,
 635                                          VAPI_OK, is_last, payload);
 636         }
 637       else
 638         {
 639           /* this is a message without payload, so bend the callback a little
 640            */
 641           rv =
 642             ((vapi_error_e (*)(vapi_ctx_t, void *, vapi_error_e, bool))
 643              ctx->requests[tmp].callback) (ctx,
 644                                            ctx->requests[tmp].callback_ctx,
 645                                            VAPI_OK, is_last);
 646         }
 647       if (is_last)
 648         {
 649           memset (&ctx->requests[ctx->requests_start], 0,
 650                   sizeof (ctx->requests[ctx->requests_start]));
 651           ++ctx->requests_start;
 652           --ctx->requests_count;
 653           if (ctx->requests_start == ctx->requests_size)
 654             {
 655               ctx->requests_start = 0;
 656             }
 657         }
 658       VAPI_DBG ("after dispatch, req start = %d, end = %d, count = %d",
 659                 ctx->requests_start, requests_end, ctx->requests_count);
 660     }
 661   if (0 != (mrv = pthread_mutex_unlock (&ctx->requests_mutex)))
 662     {
 663       VAPI_DBG ("pthread_mutex_unlock() failed, rv=%d:%s", mrv,
 664                 strerror (mrv));
 665       abort ();                 /* this really shouldn't happen */
 666     }
 667   return rv;
 668 }
 669
 670 static vapi_error_e
 671 vapi_dispatch_event (vapi_ctx_t ctx, vapi_msg_id_t id, void *msg)
 672 {
 673   if (ctx->event_cbs[id].cb)
 674     {
 675       return ctx->event_cbs[id].cb (ctx, ctx->event_cbs[id].ctx, msg);
 676     }
 677   else if (ctx->generic_cb.cb)
 678     {
 679       return ctx->generic_cb.cb (ctx, ctx->generic_cb.ctx, id, msg);
 680     }
 681   else
 682     {
 683       VAPI_DBG
 684         ("No handler/generic handler for msg id %u[%s], message ignored",
 685          (unsigned) id, __vapi_metadata.msgs[id]->name);
 686     }
 687   return VAPI_OK;
 688 }
 689
 690 bool
 691 vapi_msg_is_with_context (vapi_msg_id_t id)
 692 {
 693   assert (id <= __vapi_metadata.count);
 694   return __vapi_metadata.msgs[id]->has_context;
 695 }
 696
 697 vapi_error_e
 698 vapi_dispatch_one (vapi_ctx_t ctx)
 699 {
 700   VAPI_DBG ("vapi_dispatch_one()");
 701   void *msg;
 702   size_t size;
 703   vapi_error_e rv = vapi_recv (ctx, &msg, &size);
 704   if (VAPI_OK != rv)
 705     {
 706       VAPI_DBG ("vapi_recv failed with rv=%d", rv);
 707       return rv;
 708     }
 709   u16 vpp_id = be16toh (*(u16 *) msg);
 710   if (vpp_id > ctx->vl_msg_id_max)
 711     {
 712       VAPI_ERR ("Unknown msg ID received, id `%u', out of range <0,%u>",
 713                 (unsigned) vpp_id, (unsigned) ctx->vl_msg_id_max);
 714       vapi_msg_free (ctx, msg);
 715       return VAPI_EINVAL;
 716     }
 717   if (INVALID_MSG_ID == (unsigned) ctx->vl_msg_id_to_vapi_msg_t[vpp_id])
 718     {
 719       VAPI_ERR ("Unknown msg ID received, id `%u' marked as not supported",
 720                 (unsigned) vpp_id);
 721       vapi_msg_free (ctx, msg);
 722       return VAPI_EINVAL;
 723     }
 724   const vapi_msg_id_t id = ctx->vl_msg_id_to_vapi_msg_t[vpp_id];
 725   const size_t expect_size = vapi_get_message_size (id);
 726   if (size < expect_size)
 727     {
 728       VAPI_ERR
 729         ("Invalid msg received, unexpected size `%zu' < expected min `%zu'",
 730          size, expect_size);
 731       vapi_msg_free (ctx, msg);
 732       return VAPI_EINVAL;
 733     }
 734   u32 context;
 735   vapi_get_swap_to_host_func (id) (msg);
 736   if (vapi_msg_is_with_context (id))
 737     {
 738       context = *(u32 *) (((u8 *) msg) + vapi_get_context_offset (id));
 739       /* is this a message originating from VAPI? */
 740       VAPI_DBG ("dispatch, context is %x", context);
 741       if (context & context_counter_mask)
 742         {
 743           rv = vapi_dispatch_response (ctx, id, context, msg);
 744           goto done;
 745         }
 746     }
 747   rv = vapi_dispatch_event (ctx, id, msg);
 748
 749 done:
 750   vapi_msg_free (ctx, msg);
 751   return rv;
 752 }
 753
 754 vapi_error_e
 755 vapi_dispatch (vapi_ctx_t ctx)
 756 {
 757   vapi_error_e rv = VAPI_OK;
 758   while (!vapi_requests_empty (ctx))
 759     {
 760       rv = vapi_dispatch_one (ctx);
 761       if (VAPI_OK != rv)
 762         {
 763           return rv;
 764         }
 765     }
 766   return rv;
 767 }
 768
 769 void
 770 vapi_set_event_cb (vapi_ctx_t ctx, vapi_msg_id_t id,
 771                    vapi_event_cb callback, void *callback_ctx)
 772 {
 773   vapi_event_cb_with_ctx *c = &ctx->event_cbs[id];
 774   c->cb = callback;
 775   c->ctx = callback_ctx;
 776 }
 777
 778 void
 779 vapi_clear_event_cb (vapi_ctx_t ctx, vapi_msg_id_t id)
 780 {
 781   vapi_set_event_cb (ctx, id, NULL, NULL);
 782 }
 783
 784 void
 785 vapi_set_generic_event_cb (vapi_ctx_t ctx, vapi_generic_event_cb callback,
 786                            void *callback_ctx)
 787 {
 788   ctx->generic_cb.cb = callback;
 789   ctx->generic_cb.ctx = callback_ctx;
 790 }
 791
 792 void
 793 vapi_clear_generic_event_cb (vapi_ctx_t ctx)
 794 {
 795   ctx->generic_cb.cb = NULL;
 796   ctx->generic_cb.ctx = NULL;
 797 }
 798
 799 u16
 800 vapi_lookup_vl_msg_id (vapi_ctx_t ctx, vapi_msg_id_t id)
 801 {
 802   assert (id < __vapi_metadata.count);
 803   return ctx->vapi_msg_id_t_to_vl_msg_id[id];
 804 }
 805
 806 int
 807 vapi_get_client_index (vapi_ctx_t ctx)
 808 {
 809   return api_main.my_client_index;
 810 }
 811
 812 bool
 813 vapi_is_nonblocking (vapi_ctx_t ctx)
 814 {
 815   return (VAPI_MODE_NONBLOCKING == ctx->mode);
 816 }
 817
 818 size_t
 819 vapi_get_max_request_count (vapi_ctx_t ctx)
 820 {
 821   return ctx->requests_size - 1;
 822 }
 823
 824 int
 825 vapi_get_payload_offset (vapi_msg_id_t id)
 826 {
 827   assert (id < __vapi_metadata.count);
 828   return __vapi_metadata.msgs[id]->payload_offset;
 829 }
 830
 831 void (*vapi_get_swap_to_host_func (vapi_msg_id_t id)) (void *msg)
 832 {
 833   assert (id < __vapi_metadata.count);
 834   return __vapi_metadata.msgs[id]->swap_to_host;
 835 }
 836
 837 void (*vapi_get_swap_to_be_func (vapi_msg_id_t id)) (void *msg)
 838 {
 839   assert (id < __vapi_metadata.count);
 840   return __vapi_metadata.msgs[id]->swap_to_be;
 841 }
 842
 843 size_t
 844 vapi_get_message_size (vapi_msg_id_t id)
 845 {
 846   assert (id < __vapi_metadata.count);
 847   return __vapi_metadata.msgs[id]->size;
 848 }
 849
 850 size_t
 851 vapi_get_context_offset (vapi_msg_id_t id)
 852 {
 853   assert (id < __vapi_metadata.count);
 854   return __vapi_metadata.msgs[id]->context_offset;
 855 }
 856
 857 vapi_msg_id_t
 858 vapi_register_msg (vapi_message_desc_t * msg)
 859 {
 860   int i = 0;
 861   for (i = 0; i < __vapi_metadata.count; ++i)
 862     {
 863       if (!strcmp
 864           (msg->name_with_crc, __vapi_metadata.msgs[i]->name_with_crc))
 865         {
 866           /* this happens if somebody is linking together several objects while
 867            * using the static inline headers, just fill in the already
 868            * assigned id here so that all the objects are in sync */
 869           msg->id = __vapi_metadata.msgs[i]->id;
 870           return msg->id;
 871         }
 872     }
 873   vapi_msg_id_t id = __vapi_metadata.count;
 874   ++__vapi_metadata.count;
 875   __vapi_metadata.msgs =
 876     realloc (__vapi_metadata.msgs,
 877              sizeof (*__vapi_metadata.msgs) * __vapi_metadata.count);
 878   __vapi_metadata.msgs[id] = msg;
 879   size_t s = strlen (msg->name_with_crc);
 880   if (s > __vapi_metadata.max_len_name_with_crc)
 881     {
 882       __vapi_metadata.max_len_name_with_crc = s;
 883     }
 884   msg->id = id;
 885   return id;
 886 }
 887
 888 vapi_error_e
 889 vapi_producer_lock (vapi_ctx_t ctx)
 890 {
 891   int mrv;
 892   if (0 != (mrv = pthread_mutex_lock (&ctx->requests_mutex)))
 893     {
 894       VAPI_DBG ("pthread_mutex_lock() failed, rv=%d:%s", mrv, strerror (mrv));
 895       (void) mrv;               /* avoid warning if the above debug is not enabled */
 896       return VAPI_MUTEX_FAILURE;
 897     }
 898   return VAPI_OK;
 899 }
 900
 901 vapi_error_e
 902 vapi_producer_unlock (vapi_ctx_t ctx)
 903 {
 904   int mrv;
 905   if (0 != (mrv = pthread_mutex_unlock (&ctx->requests_mutex)))
 906     {
 907       VAPI_DBG ("pthread_mutex_unlock() failed, rv=%d:%s", mrv,
 908                 strerror (mrv));
 909       (void) mrv;               /* avoid warning if the above debug is not enabled */
 910       return VAPI_MUTEX_FAILURE;
 911     }
 912   return VAPI_OK;
 913 }
 914
 915 size_t
 916 vapi_get_message_count ()
 917 {
 918   return __vapi_metadata.count;
 919 }
 920
 921 const char *
 922 vapi_get_msg_name (vapi_msg_id_t id)
 923 {
 924   return __vapi_metadata.msgs[id]->name;
 925 }
 926
 927 /*
 928  * fd.io coding-style-patch-verification: ON
 929  *
 930  * Local Variables:
 931  * eval: (c-set-style "gnu")
 932  * End:
 933  */