FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
vapi.c
Go to the documentation of this file.
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>
28 #include <vppinfra/types.h>
29 #include <vppinfra/pool.h>
30 #include <vlib/vlib.h>
31 #include <vlibapi/api_common.h>
32 #include <vlibmemory/api_common.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 */
39 
40 struct
41 {
42  size_t count;
45 } __vapi_metadata;
46 
47 typedef struct
48 {
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;
63 
64 typedef struct
65 {
66  vapi_error_e (*cb) (vapi_ctx_t ctx, void *callback_ctx, void *payload);
67  void *ctx;
69 
70 struct vapi_ctx_s
71 {
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 */
83  bool connected;
84  pthread_mutex_t requests_mutex;
85 };
86 
87 u32
89 {
90  ++ctx->context_counter;
93 }
94 
95 size_t
97 {
98  return ctx->requests_count;
99 }
100 
101 bool
103 {
104  return (ctx->requests_count == ctx->requests_size);
105 }
106 
107 bool
109 {
110  return (0 == ctx->requests_count);
111 }
112 
113 static int
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 *
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
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 
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 
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;
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
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
287 {
288  return vapi_lookup_vl_msg_id (ctx, id) != UINT16_MAX;
289 }
290 
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  {
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_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:
393  return rv;
394 }
395 
398 {
399  if (!ctx->connected)
400  {
401  return VAPI_EINVAL;
402  }
405 #if VAPI_DEBUG_ALLOC
406  vapi_to_be_freed_validate ();
407 #endif
408  ctx->connected = false;
409  return VAPI_OK;
410 }
411 
414 {
415  return VAPI_ENOTSUP;
416 }
417 
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;
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 = unix_shared_memory_queue_add (q, (u8 *) & msg,
451  ctx->mode ? 0 : 1);
452  if (tmp < 0)
453  {
454  rv = VAPI_EAGAIN;
455  }
456 out:
457  VAPI_DBG ("vapi_send() rv = %d", rv);
458  return rv;
459 }
460 
462 vapi_send2 (vapi_ctx_t ctx, void *msg1, void *msg2)
463 {
464  vapi_error_e rv = VAPI_OK;
465  if (!ctx || !msg1 || !msg2 || !ctx->connected)
466  {
467  rv = VAPI_EINVAL;
468  goto out;
469  }
471 #if VAPI_DEBUG
472  unsigned msgid1 = be16toh (*(u16 *) msg1);
473  unsigned msgid2 = be16toh (*(u16 *) msg2);
474  const char *name1 = "UNKNOWN";
475  const char *name2 = "UNKNOWN";
476  if (msgid1 <= ctx->vl_msg_id_max)
477  {
478  vapi_msg_id_t id = ctx->vl_msg_id_to_vapi_msg_t[msgid1];
479  if (id < __vapi_metadata.count)
480  {
481  name1 = __vapi_metadata.msgs[id]->name;
482  }
483  }
484  if (msgid2 <= ctx->vl_msg_id_max)
485  {
486  vapi_msg_id_t id = ctx->vl_msg_id_to_vapi_msg_t[msgid2];
487  if (id < __vapi_metadata.count)
488  {
489  name2 = __vapi_metadata.msgs[id]->name;
490  }
491  }
492  VAPI_DBG ("send two: %u[%s], %u[%s]", msgid1, name1, msgid2, name2);
493 #endif
494  int tmp = unix_shared_memory_queue_add2 (q, (u8 *) & msg1, (u8 *) & msg2,
496  ctx->mode ? 0 : 1);
497  if (tmp < 0)
498  {
499  rv = VAPI_EAGAIN;
500  }
501 out:
502  VAPI_DBG ("vapi_send() rv = %d", rv);
503  return rv;
504 }
505 
507 vapi_recv (vapi_ctx_t ctx, void **msg, size_t * msg_size)
508 {
509  if (!ctx || !ctx->connected || !msg || !msg_size)
510  {
511  return VAPI_EINVAL;
512  }
513  vapi_error_e rv = VAPI_OK;
514  api_main_t *am = &api_main;
515  uword data;
516 
517  if (am->our_pid == 0)
518  {
519  return VAPI_EINVAL;
520  }
521 
523  VAPI_DBG ("doing shm queue sub");
524  int tmp = unix_shared_memory_queue_sub (q, (u8 *) & data, 0);
525  if (tmp == 0)
526  {
527 #if VAPI_DEBUG_ALLOC
528  vapi_add_to_be_freed ((void *) data);
529 #endif
530  msgbuf_t *msgbuf =
531  (msgbuf_t *) ((u8 *) data - offsetof (msgbuf_t, data));
532  if (!msgbuf->data_len)
533  {
534  vapi_msg_free (ctx, (u8 *) data);
535  return VAPI_EAGAIN;
536  }
537  *msg = (u8 *) data;
538  *msg_size = ntohl (msgbuf->data_len);
539 #if VAPI_DEBUG
540  unsigned msgid = be16toh (*(u16 *) * msg);
541  if (msgid <= ctx->vl_msg_id_max)
542  {
543  vapi_msg_id_t id = ctx->vl_msg_id_to_vapi_msg_t[msgid];
544  if (id < __vapi_metadata.count)
545  {
546  VAPI_DBG ("recv msg@%p:%u[%s]", *msg, msgid,
547  __vapi_metadata.msgs[id]->name);
548  }
549  else
550  {
551  VAPI_DBG ("recv msg@%p:%u[UNKNOWN]", *msg, msgid);
552  }
553  }
554  else
555  {
556  VAPI_DBG ("recv msg@%p:%u[UNKNOWN]", *msg, msgid);
557  }
558 #endif
559  }
560  else
561  {
562  rv = VAPI_EAGAIN;
563  }
564  return rv;
565 }
566 
569 {
570  return VAPI_ENOTSUP;
571 }
572 
573 static vapi_error_e
575  u32 context, void *msg)
576 {
577  int mrv;
578  if (0 != (mrv = pthread_mutex_lock (&ctx->requests_mutex)))
579  {
580  VAPI_DBG ("pthread_mutex_lock() failed, rv=%d:%s", mrv, strerror (mrv));
581  return VAPI_MUTEX_FAILURE;
582  }
583  int tmp = ctx->requests_start;
584  const int requests_end = vapi_requests_end (ctx);
585  while (ctx->requests[tmp].context != context && tmp != requests_end)
586  {
587  ++tmp;
588  if (tmp == ctx->requests_size)
589  {
590  tmp = 0;
591  }
592  }
593  VAPI_DBG ("dispatch, search from %d, %s at %d", ctx->requests_start,
594  ctx->requests[tmp].context == context ? "matched" : "stopped",
595  tmp);
596  vapi_error_e rv = VAPI_OK;
597  if (ctx->requests[tmp].context == context)
598  {
599  while (ctx->requests_start != tmp)
600  {
601  VAPI_ERR ("No response to req with context=%u",
602  (unsigned) ctx->requests[tmp].context);
603  ctx->requests[ctx->requests_start].callback (ctx,
604  ctx->requests
605  [ctx->
607  VAPI_ENORESP, true,
608  NULL);
609  memset (&ctx->requests[ctx->requests_start], 0,
610  sizeof (ctx->requests[ctx->requests_start]));
611  ++ctx->requests_start;
612  --ctx->requests_count;
613  if (ctx->requests_start == ctx->requests_size)
614  {
615  ctx->requests_start = 0;
616  }
617  }
618  // now ctx->requests_start == tmp
619  int payload_offset = vapi_get_payload_offset (id);
620  void *payload = ((u8 *) msg) + payload_offset;
621  bool is_last = true;
622  if (ctx->requests[tmp].is_dump)
623  {
624  if (vapi_msg_id_control_ping_reply == id)
625  {
626  payload = NULL;
627  }
628  else
629  {
630  is_last = false;
631  }
632  }
633  if (payload_offset != -1)
634  {
635  rv =
636  ctx->requests[tmp].callback (ctx, ctx->requests[tmp].callback_ctx,
637  VAPI_OK, is_last, payload);
638  }
639  else
640  {
641  /* this is a message without payload, so bend the callback a little
642  */
643  rv =
644  ((vapi_error_e (*)(vapi_ctx_t, void *, vapi_error_e, bool))
645  ctx->requests[tmp].callback) (ctx,
646  ctx->requests[tmp].callback_ctx,
647  VAPI_OK, is_last);
648  }
649  if (is_last)
650  {
651  memset (&ctx->requests[ctx->requests_start], 0,
652  sizeof (ctx->requests[ctx->requests_start]));
653  ++ctx->requests_start;
654  --ctx->requests_count;
655  if (ctx->requests_start == ctx->requests_size)
656  {
657  ctx->requests_start = 0;
658  }
659  }
660  VAPI_DBG ("after dispatch, req start = %d, end = %d, count = %d",
661  ctx->requests_start, requests_end, ctx->requests_count);
662  }
663  if (0 != (mrv = pthread_mutex_unlock (&ctx->requests_mutex)))
664  {
665  VAPI_DBG ("pthread_mutex_unlock() failed, rv=%d:%s", mrv,
666  strerror (mrv));
667  abort (); /* this really shouldn't happen */
668  }
669  return rv;
670 }
671 
672 static vapi_error_e
674 {
675  if (ctx->event_cbs[id].cb)
676  {
677  return ctx->event_cbs[id].cb (ctx, ctx->event_cbs[id].ctx, msg);
678  }
679  else if (ctx->generic_cb.cb)
680  {
681  return ctx->generic_cb.cb (ctx, ctx->generic_cb.ctx, id, msg);
682  }
683  else
684  {
685  VAPI_DBG
686  ("No handler/generic handler for msg id %u[%s], message ignored",
687  (unsigned) id, __vapi_metadata.msgs[id]->name);
688  }
689  return VAPI_OK;
690 }
691 
692 bool
694 {
695  assert (id <= __vapi_metadata.count);
696  return __vapi_metadata.msgs[id]->has_context;
697 }
698 
701 {
702  VAPI_DBG ("vapi_dispatch_one()");
703  void *msg;
704  size_t size;
705  vapi_error_e rv = vapi_recv (ctx, &msg, &size);
706  if (VAPI_OK != rv)
707  {
708  VAPI_DBG ("vapi_recv failed with rv=%d", rv);
709  return rv;
710  }
711  u16 vpp_id = be16toh (*(u16 *) msg);
712  if (vpp_id > ctx->vl_msg_id_max)
713  {
714  VAPI_ERR ("Unknown msg ID received, id `%u', out of range <0,%u>",
715  (unsigned) vpp_id, (unsigned) ctx->vl_msg_id_max);
716  vapi_msg_free (ctx, msg);
717  return VAPI_EINVAL;
718  }
719  if (INVALID_MSG_ID == (unsigned) ctx->vl_msg_id_to_vapi_msg_t[vpp_id])
720  {
721  VAPI_ERR ("Unknown msg ID received, id `%u' marked as not supported",
722  (unsigned) vpp_id);
723  vapi_msg_free (ctx, msg);
724  return VAPI_EINVAL;
725  }
726  const vapi_msg_id_t id = ctx->vl_msg_id_to_vapi_msg_t[vpp_id];
727  const size_t expect_size = vapi_get_message_size (id);
728  if (size < expect_size)
729  {
730  VAPI_ERR
731  ("Invalid msg received, unexpected size `%zu' < expected min `%zu'",
732  size, expect_size);
733  vapi_msg_free (ctx, msg);
734  return VAPI_EINVAL;
735  }
736  u32 context;
737  vapi_get_swap_to_host_func (id) (msg);
738  if (vapi_msg_is_with_context (id))
739  {
740  context = *(u32 *) (((u8 *) msg) + vapi_get_context_offset (id));
741  /* is this a message originating from VAPI? */
742  VAPI_DBG ("dispatch, context is %x", context);
743  if (context & context_counter_mask)
744  {
745  rv = vapi_dispatch_response (ctx, id, context, msg);
746  goto done;
747  }
748  }
749  rv = vapi_dispatch_event (ctx, id, msg);
750 
751 done:
752  vapi_msg_free (ctx, msg);
753  return rv;
754 }
755 
758 {
759  vapi_error_e rv = VAPI_OK;
760  while (!vapi_requests_empty (ctx))
761  {
762  rv = vapi_dispatch_one (ctx);
763  if (VAPI_OK != rv)
764  {
765  return rv;
766  }
767  }
768  return rv;
769 }
770 
771 void
773  vapi_event_cb callback, void *callback_ctx)
774 {
775  vapi_event_cb_with_ctx *c = &ctx->event_cbs[id];
776  c->cb = callback;
777  c->ctx = callback_ctx;
778 }
779 
780 void
782 {
783  vapi_set_event_cb (ctx, id, NULL, NULL);
784 }
785 
786 void
788  void *callback_ctx)
789 {
790  ctx->generic_cb.cb = callback;
791  ctx->generic_cb.ctx = callback_ctx;
792 }
793 
794 void
796 {
797  ctx->generic_cb.cb = NULL;
798  ctx->generic_cb.ctx = NULL;
799 }
800 
801 u16
803 {
804  assert (id < __vapi_metadata.count);
805  return ctx->vapi_msg_id_t_to_vl_msg_id[id];
806 }
807 
808 int
810 {
811  return api_main.my_client_index;
812 }
813 
814 bool
816 {
817  return (VAPI_MODE_NONBLOCKING == ctx->mode);
818 }
819 
820 size_t
822 {
823  return ctx->requests_size - 1;
824 }
825 
826 int
828 {
829  assert (id < __vapi_metadata.count);
830  return __vapi_metadata.msgs[id]->payload_offset;
831 }
832 
834 {
835  assert (id < __vapi_metadata.count);
836  return __vapi_metadata.msgs[id]->swap_to_host;
837 }
838 
839 void (*vapi_get_swap_to_be_func (vapi_msg_id_t id)) (void *msg)
840 {
841  assert (id < __vapi_metadata.count);
842  return __vapi_metadata.msgs[id]->swap_to_be;
843 }
844 
845 size_t
847 {
848  assert (id < __vapi_metadata.count);
849  return __vapi_metadata.msgs[id]->size;
850 }
851 
852 size_t
854 {
855  assert (id < __vapi_metadata.count);
856  return __vapi_metadata.msgs[id]->context_offset;
857 }
858 
861 {
862  int i = 0;
863  for (i = 0; i < __vapi_metadata.count; ++i)
864  {
865  if (!strcmp
866  (msg->name_with_crc, __vapi_metadata.msgs[i]->name_with_crc))
867  {
868  /* this happens if somebody is linking together several objects while
869  * using the static inline headers, just fill in the already
870  * assigned id here so that all the objects are in sync */
871  msg->id = __vapi_metadata.msgs[i]->id;
872  return msg->id;
873  }
874  }
875  vapi_msg_id_t id = __vapi_metadata.count;
876  ++__vapi_metadata.count;
877  __vapi_metadata.msgs =
878  realloc (__vapi_metadata.msgs,
879  sizeof (*__vapi_metadata.msgs) * __vapi_metadata.count);
880  __vapi_metadata.msgs[id] = msg;
881  size_t s = strlen (msg->name_with_crc);
882  if (s > __vapi_metadata.max_len_name_with_crc)
883  {
884  __vapi_metadata.max_len_name_with_crc = s;
885  }
886  msg->id = id;
887  return id;
888 }
889 
892 {
893  int mrv;
894  if (0 != (mrv = pthread_mutex_lock (&ctx->requests_mutex)))
895  {
896  VAPI_DBG ("pthread_mutex_lock() failed, rv=%d:%s", mrv, strerror (mrv));
897  (void) mrv; /* avoid warning if the above debug is not enabled */
898  return VAPI_MUTEX_FAILURE;
899  }
900  return VAPI_OK;
901 }
902 
905 {
906  int mrv;
907  if (0 != (mrv = pthread_mutex_unlock (&ctx->requests_mutex)))
908  {
909  VAPI_DBG ("pthread_mutex_unlock() failed, rv=%d:%s", mrv,
910  strerror (mrv));
911  (void) mrv; /* avoid warning if the above debug is not enabled */
912  return VAPI_MUTEX_FAILURE;
913  }
914  return VAPI_OK;
915 }
916 
917 size_t
919 {
920  return __vapi_metadata.count;
921 }
922 
923 const char *
925 {
926  return __vapi_metadata.msgs[id]->name;
927 }
928 
929 /*
930  * fd.io coding-style-patch-verification: ON
931  *
932  * Local Variables:
933  * eval: (c-set-style "gnu")
934  * End:
935  */
failure manipulating internal mutex(es)
Definition: vapi_common.h:37
sll srl srl sll sra u16x4 i
Definition: vector_sse2.h:337
vapi_msg_id_t id
Definition: vapi_internal.h:98
operations block until response received
Definition: vapi_common.h:44
void vl_client_disconnect(void)
operations never block
Definition: vapi_common.h:45
size_t vapi_get_message_count()
Definition: vapi.c:918
void * callback_ctx
Definition: vapi.c:51
Fixed length block allocator.
unix_shared_memory_queue_t * vl_input_queue
Definition: api_common.h:68
int my_client_index
All VLIB-side message handlers use my_client_index to identify the queue / client.
Definition: api_common.h:306
u32 context
Definition: vapi.c:49
#define NULL
Definition: clib.h:55
u16 vl_msg_id_max
Definition: vapi.c:81
operation would block
Definition: vapi_common.h:29
vapi_error_e(* cb)(vapi_ctx_t ctx, void *callback_ctx, vapi_msg_id_t id, void *payload)
Definition: vapi.c:59
vapi_error_e vapi_send(vapi_ctx_t ctx, void *msg)
low-level api for sending messages to vpp
Definition: vapi.c:419
vapi_mode_e
Definition: vapi_common.h:42
int requests_start
Definition: vapi.c:74
bool connected
Definition: vapi.c:83
int requests_size
Definition: vapi.c:73
vapi_cb_t callback
Definition: vapi.c:50
void * vapi_msg_alloc(vapi_ctx_t ctx, size_t size)
allocate vapi message of given size
Definition: vapi.c:211
void vapi_store_request(vapi_ctx_t ctx, u32 context, bool is_dump, vapi_cb_t callback, void *callback_ctx)
Definition: vapi.c:120
vapi_msg_id_t * vl_msg_id_to_vapi_msg_t
Definition: vapi.c:82
#define vl_msg_id(n, h)
out of memory
Definition: vapi_common.h:31
unix_shared_memory_queue_t * vl_input_queue
Peer input queue pointer.
Definition: api_common.h:300
int our_pid
Current process PID.
Definition: api_common.h:248
vapi_req_t * requests
Definition: vapi.c:76
vapi_msg_id_t vapi_register_msg(vapi_message_desc_t *msg)
Definition: vapi.c:860
vapi_error_e(* vapi_generic_event_cb)(vapi_ctx_t ctx, void *callback_ctx, vapi_msg_id_t id, void *msg)
generic vapi event callback
Definition: vapi.h:227
vapi_error_e vapi_send2(vapi_ctx_t ctx, void *msg1, void *msg2)
low-level api for atomically sending two messages to vpp - either both messages are sent or neither o...
Definition: vapi.c:462
size_t vapi_get_message_size(vapi_msg_id_t id)
Definition: vapi.c:846
int vl_client_connect(const char *name, int ctx_quota, int input_queue_size)
fundamental incompatibility while connecting to vpp (control ping/control ping reply mismatch) ...
Definition: vapi_common.h:35
vapi_error_e vapi_recv(vapi_ctx_t ctx, void **msg, size_t *msg_size)
low-level api for reading messages from vpp
Definition: vapi.c:507
size_t vapi_get_request_count(vapi_ctx_t ctx)
Definition: vapi.c:96
operation not supported
Definition: vapi_common.h:30
void vl_client_api_unmap(void)
vapi_error_e vapi_disconnect(vapi_ctx_t ctx)
disconnect from vpp
Definition: vapi.c:397
static vapi_error_e vapi_dispatch_event(vapi_ctx_t ctx, vapi_msg_id_t id, void *msg)
Definition: vapi.c:673
int unix_shared_memory_queue_add2(unix_shared_memory_queue_t *q, u8 *elem, u8 *elem2, int nowait)
bool vapi_is_nonblocking(vapi_ctx_t ctx)
Definition: vapi.c:815
struct vl_shmem_hdr_ * shmem_hdr
Binary API shared-memory segment header pointer.
Definition: api_common.h:261
vapi_message_desc_t ** msgs
Definition: vapi.c:43
int vapi_get_payload_offset(vapi_msg_id_t id)
Definition: vapi.c:827
u32 vl_api_get_msg_index(u8 *name_and_crc)
size_t vapi_get_context_offset(vapi_msg_id_t id)
Definition: vapi.c:853
vapi_event_cb_with_ctx * event_cbs
Definition: vapi.c:79
size_t vapi_get_max_request_count(vapi_ctx_t ctx)
Definition: vapi.c:821
int unix_shared_memory_queue_add(unix_shared_memory_queue_t *q, u8 *elem, int nowait)
vapi_msg_id_t vapi_msg_id_control_ping_reply
Definition: vapi.c:38
const char * vapi_get_msg_name(vapi_msg_id_t id)
Definition: vapi.c:924
int requests_count
Definition: vapi.c:75
const char * name_with_crc
Definition: vapi_internal.h:90
u32 vapi_gen_req_context(vapi_ctx_t ctx)
Definition: vapi.c:88
void vapi_set_generic_event_cb(vapi_ctx_t ctx, vapi_generic_event_cb callback, void *callback_ctx)
set generic event callback
Definition: vapi.c:787
bool vapi_requests_empty(vapi_ctx_t ctx)
Definition: vapi.c:108
#define v
Definition: acl.c:341
void(*)(void *msg) vapi_get_swap_to_host_func(vapi_msg_id_t id)
Definition: vapi.c:833
void(*)(void *msg) vapi_get_swap_to_be_func(vapi_msg_id_t id)
Definition: vapi.c:839
void vl_msg_api_free(void *)
invalid value encountered
Definition: vapi_common.h:28
common vpp api C declarations
size_t max_len_name_with_crc
Definition: vapi.c:44
#define INVALID_MSG_ID
Definition: vapi_common.h:57
#define VAPI_DBG(...)
Definition: vapi_dbg.h:65
vapi_error_e vapi_dispatch(vapi_ctx_t ctx)
loop vapi_dispatch_one until responses to all currently outstanding requests have been received and t...
Definition: vapi.c:757
no response to request
Definition: vapi_common.h:32
bool is_dump
Definition: vapi.c:52
failure while mapping api
Definition: vapi_common.h:33
vapi_error_e(* vapi_cb_t)(struct vapi_ctx_s *, void *, vapi_error_e, bool, void *)
Definition: vapi_internal.h:81
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:198
bool vapi_msg_is_with_context(vapi_msg_id_t id)
Definition: vapi.c:693
int unix_shared_memory_queue_sub(unix_shared_memory_queue_t *q, u8 *elem, int nowait)
static vapi_error_e vapi_dispatch_response(vapi_ctx_t ctx, vapi_msg_id_t id, u32 context, void *msg)
Definition: vapi.c:574
api_main_t api_main
Definition: api_shared.c:35
vapi_msg_id_t vapi_lookup_vapi_msg_id_t(vapi_ctx_t ctx, u16 vl_msg_id)
Definition: vapi.c:235
svmdb_client_t * c
struct vapi_ctx_s * vapi_ctx_t
Definition: vapi.h:45
static const u32 context_counter_mask
Definition: vapi.c:55
vapi_wait_mode_e
Definition: vapi_common.h:48
pthread_mutex_t requests_mutex
Definition: vapi.c:84
internal vpp api C declarations
vapi_msg_id_t vapi_msg_id_control_ping
Definition: vapi.c:37
u16 vapi_lookup_vl_msg_id(vapi_ctx_t ctx, vapi_msg_id_t id)
Definition: vapi.c:802
bool vapi_is_msg_available(vapi_ctx_t ctx, vapi_msg_id_t id)
check if message identified by it&#39;s message id is known by the vpp to which the connection is open ...
Definition: vapi.c:286
success
Definition: vapi_common.h:27
unsigned int u32
Definition: types.h:88
long ctx[MAX_CONNS]
Definition: main.c:122
u32 data_len
message length not including header
Definition: api_common.h:137
Message header structure.
Definition: api_common.h:134
u64 size
Definition: vhost-user.h:76
#define bool
Definition: radix.c:95
size_t count
Definition: vapi.c:42
int vapi_get_client_index(vapi_ctx_t ctx)
Definition: vapi.c:809
u64 uword
Definition: types.h:112
void vapi_ctx_free(vapi_ctx_t ctx)
free vapi context
Definition: vapi.c:274
u32 context_counter
Definition: vapi.c:77
unsigned short u16
Definition: types.h:57
void vapi_clear_generic_event_cb(vapi_ctx_t ctx)
clear generic event callback
Definition: vapi.c:795
vapi_error_e(* vapi_event_cb)(vapi_ctx_t ctx, void *callback_ctx, void *payload)
generic vapi event callback
Definition: vapi.h:204
vapi_error_e vapi_dispatch_one(vapi_ctx_t ctx)
pick next message sent by vpp and call the appropriate callback
Definition: vapi.c:700
unsigned char u8
Definition: types.h:56
vapi_error_e vapi_producer_unlock(vapi_ctx_t ctx)
Definition: vapi.c:904
bool vapi_requests_full(vapi_ctx_t ctx)
Definition: vapi.c:102
vapi_error_e vapi_get_fd(vapi_ctx_t ctx, int *fd)
get event file descriptor
Definition: vapi.c:413
vapi_error_e(* cb)(vapi_ctx_t ctx, void *callback_ctx, void *payload)
Definition: vapi.c:66
void vapi_msg_free(vapi_ctx_t ctx, void *msg)
free a vapi message
Definition: vapi.c:222
vapi_error_e vapi_producer_lock(vapi_ctx_t ctx)
Definition: vapi.c:891
u16 * vapi_msg_id_t_to_vl_msg_id
Definition: vapi.c:80
int vl_client_api_map(const char *region_name)
vapi_error_e vapi_connect(vapi_ctx_t ctx, const char *name, const char *chroot_prefix, int max_outstanding_requests, int response_queue_size, vapi_mode_e mode)
connect to vpp
Definition: vapi.c:292
void vl_set_memory_root_path(const char *root_path)
vapi_mode_e mode
Definition: vapi.c:72
vapi_error_e vapi_ctx_alloc(vapi_ctx_t *result)
allocate vapi context
Definition: vapi.c:245
unsigned int vapi_msg_id_t
Definition: vapi_common.h:55
void vapi_set_event_cb(vapi_ctx_t ctx, vapi_msg_id_t id, vapi_event_cb callback, void *callback_ctx)
set event callback to call when message with given id is dispatched
Definition: vapi.c:772
void * vl_msg_api_alloc_or_null(int nbytes)
void vapi_clear_event_cb(vapi_ctx_t ctx, vapi_msg_id_t id)
clear event callback for given message id
Definition: vapi.c:781
vapi_generic_cb_with_ctx generic_cb
Definition: vapi.c:78
static int vapi_requests_end(vapi_ctx_t ctx)
Definition: vapi.c:114
vapi_error_e
Definition: vapi_common.h:25
struct _unix_shared_memory_queue unix_shared_memory_queue_t
#define VAPI_ERR(...)
Definition: vapi_dbg.h:66
vapi_error_e vapi_wait(vapi_ctx_t ctx, vapi_wait_mode_e mode)
wait for connection to become readable or writable
Definition: vapi.c:568
failure while connecting to vpp
Definition: vapi_common.h:34