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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include <sys/types.h>
19 #include <sys/socket.h>
22 #include <netinet/in.h>
26 #include <vnet/vnet.h>
27 #include <vlib/vlib.h>
28 #include <vlib/unix/unix.h>
29 #include <vlibapi/api.h>
30 #include <vlibmemory/api.h>
32 #include <vpp/api/vpe_msg_enum.h>
34 #include "vppapiclient.h"
38 * Client registers a callback. All messages are sent to the callback.
40 * Client calls blocking read().
41 * Clients are expected to collate events on a queue.
42 * vac_write() -> suspends RX thread
43 * vac_read() -> resumes RX thread
46 #define vl_typedefs /* define message structures */
47 #include <vpp/api/vpe_all_api_h.h>
50 #define vl_endianfun /* define message structures */
51 #include <vpp/api/vpe_all_api_h.h>
54 vlib_main_t vlib_global_main;
55 vlib_main_t **vlib_mains;
59 pthread_t rx_thread_handle;
60 pthread_t timeout_thread_handle;
61 pthread_mutex_t queue_lock;
62 pthread_cond_t suspend_cv;
63 pthread_cond_t resume_cv;
64 pthread_mutex_t timeout_lock;
65 pthread_cond_t timeout_cv;
66 pthread_cond_t timeout_cancel_cv;
67 pthread_cond_t terminate_cv;
71 vac_callback_t vac_callback;
73 bool rx_is_running = false;
78 vac_main_t *pm = &vac_main;
79 memset(pm, 0, sizeof(*pm));
80 pthread_mutex_init(&pm->queue_lock, NULL);
81 pthread_cond_init(&pm->suspend_cv, NULL);
82 pthread_cond_init(&pm->resume_cv, NULL);
83 pthread_mutex_init(&pm->timeout_lock, NULL);
84 pthread_cond_init(&pm->timeout_cv, NULL);
85 pthread_cond_init(&pm->timeout_cancel_cv, NULL);
86 pthread_cond_init(&pm->terminate_cv, NULL);
92 vac_main_t *pm = &vac_main;
93 pthread_cond_destroy(&pm->suspend_cv);
94 pthread_cond_destroy(&pm->resume_cv);
95 pthread_cond_destroy(&pm->timeout_cv);
96 pthread_cond_destroy(&pm->timeout_cancel_cv);
97 pthread_cond_destroy(&pm->terminate_cv);
98 pthread_mutex_destroy(&pm->queue_lock);
99 pthread_mutex_destroy(&pm->timeout_lock);
100 memset (pm, 0, sizeof (*pm));
104 * Satisfy external references when -lvlib is not available.
106 void vlib_cli_output (struct vlib_main_t * vm, char * fmt, ...)
108 clib_warning ("vlib_cli_output called...");
112 vac_free (void * msg)
114 vl_msg_api_free (msg);
118 vac_api_handler (void *msg)
120 u16 id = ntohs(*((u16 *)msg));
121 msgbuf_t *msgbuf = (msgbuf_t *)(((u8 *)msg) - offsetof(msgbuf_t, data));
122 int l = ntohl(msgbuf->data_len);
124 clib_warning("Message ID %d has wrong length: %d\n", id, l);
126 /* Call Python callback */
127 ASSERT(vac_callback);
128 (vac_callback)(msg, l);
133 vac_rx_thread_fn (void *arg)
135 unix_shared_memory_queue_t *q;
136 vl_api_memclnt_keepalive_t *mp;
137 vl_api_memclnt_keepalive_reply_t *rmp;
138 vac_main_t *pm = &vac_main;
139 api_main_t *am = &api_main;
140 vl_shmem_hdr_t *shmem_hdr;
143 q = am->vl_input_queue;
146 while (!unix_shared_memory_queue_sub(q, (u8 *)&msg, 0))
148 u16 id = ntohs(*((u16 *)msg));
150 case VL_API_RX_THREAD_EXIT:
151 vl_msg_api_free((void *) msg);
152 /* signal waiting threads that this thread is about to terminate */
153 pthread_mutex_lock(&pm->queue_lock);
154 pthread_cond_signal(&pm->terminate_cv);
155 pthread_mutex_unlock(&pm->queue_lock);
160 case VL_API_MEMCLNT_RX_THREAD_SUSPEND:
161 vl_msg_api_free((void * )msg);
162 /* Suspend thread and signal reader */
163 pthread_mutex_lock(&pm->queue_lock);
164 pthread_cond_signal(&pm->suspend_cv);
165 /* Wait for the resume signal */
166 pthread_cond_wait (&pm->resume_cv, &pm->queue_lock);
167 pthread_mutex_unlock(&pm->queue_lock);
170 case VL_API_MEMCLNT_READ_TIMEOUT:
171 clib_warning("Received read timeout in async thread\n");
172 vl_msg_api_free((void *) msg);
175 case VL_API_MEMCLNT_KEEPALIVE:
177 rmp = vl_msg_api_alloc (sizeof (*rmp));
178 memset (rmp, 0, sizeof (*rmp));
179 rmp->_vl_msg_id = ntohs(VL_API_MEMCLNT_KEEPALIVE_REPLY);
180 rmp->context = mp->context;
181 shmem_hdr = am->shmem_hdr;
182 vl_msg_api_send_shmem(shmem_hdr->vl_input_queue, (u8 *)&rmp);
183 vl_msg_api_free((void *) msg);
187 vac_api_handler((void *)msg);
193 vac_timeout_thread_fn (void *arg)
195 vl_api_memclnt_read_timeout_t *ep;
196 vac_main_t *pm = &vac_main;
197 api_main_t *am = &api_main;
206 pthread_mutex_lock(&pm->timeout_lock);
207 pthread_cond_wait (&pm->timeout_cv, &pm->timeout_lock);
208 timeout = read_timeout;
209 gettimeofday(&tv, NULL);
210 ts.tv_sec = tv.tv_sec + timeout;
212 rv = pthread_cond_timedwait (&pm->timeout_cancel_cv,
213 &pm->timeout_lock, &ts);
214 pthread_mutex_unlock(&pm->timeout_lock);
217 ep = vl_msg_api_alloc (sizeof (*ep));
218 ep->_vl_msg_id = ntohs(VL_API_MEMCLNT_READ_TIMEOUT);
219 vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
226 vac_rx_suspend (void)
228 api_main_t *am = &api_main;
229 vac_main_t *pm = &vac_main;
230 vl_api_memclnt_rx_thread_suspend_t *ep;
232 if (!pm->rx_thread_handle) return;
233 pthread_mutex_lock(&pm->queue_lock);
236 ep = vl_msg_api_alloc (sizeof (*ep));
237 ep->_vl_msg_id = ntohs(VL_API_MEMCLNT_RX_THREAD_SUSPEND);
238 vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
239 /* Wait for RX thread to tell us it has suspendend */
240 pthread_cond_wait(&pm->suspend_cv, &pm->queue_lock);
241 rx_is_running = false;
243 pthread_mutex_unlock(&pm->queue_lock);
249 vac_main_t *pm = &vac_main;
250 if (!pm->rx_thread_handle) return;
251 pthread_mutex_lock(&pm->queue_lock);
252 if (rx_is_running) goto unlock;
253 pthread_cond_signal(&pm->resume_cv);
254 rx_is_running = true;
256 pthread_mutex_unlock(&pm->queue_lock);
260 vac_msg_table_get_hash (void)
262 api_main_t *am = &api_main;
263 return (am->msg_index_by_name_and_crc);
267 vac_msg_table_size(void)
269 api_main_t *am = &api_main;
270 return hash_elts(am->msg_index_by_name_and_crc);
274 vac_connect (char * name, char * chroot_prefix, vac_callback_t cb,
278 vac_main_t *pm = &vac_main;
281 if (chroot_prefix != NULL)
282 vl_set_memory_root_path (chroot_prefix);
284 if ((rv = vl_client_api_map("/vpe-api"))) {
285 clib_warning ("vl_client_api map rv %d", rv);
289 if (vl_client_connect(name, 0, rx_qlen) < 0) {
290 vl_client_api_unmap();
295 /* Start the rx queue thread */
296 rv = pthread_create(&pm->rx_thread_handle, NULL, vac_rx_thread_fn, 0);
298 clib_warning("pthread_create returned %d", rv);
299 vl_client_api_unmap();
303 rx_is_running = true;
306 /* Start read timeout thread */
307 rv = pthread_create(&pm->timeout_thread_handle, NULL,
308 vac_timeout_thread_fn, 0);
310 clib_warning("pthread_create returned %d", rv);
311 vl_client_api_unmap();
315 pm->connected_to_vlib = 1;
321 vac_disconnect (void)
323 api_main_t *am = &api_main;
324 vac_main_t *pm = &vac_main;
326 if (!pm->connected_to_vlib) return 0;
328 if (pm->rx_thread_handle) {
329 vl_api_rx_thread_exit_t *ep;
331 ep = vl_msg_api_alloc (sizeof (*ep));
332 ep->_vl_msg_id = ntohs(VL_API_RX_THREAD_EXIT);
333 vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
335 /* wait (with timeout) until RX thread has finished */
338 gettimeofday(&tv, NULL);
339 ts.tv_sec = tv.tv_sec + 5;
341 pthread_mutex_lock(&pm->queue_lock);
342 int rv = pthread_cond_timedwait(&pm->terminate_cv, &pm->queue_lock, &ts);
343 pthread_mutex_unlock(&pm->queue_lock);
344 /* now join so we wait until thread has -really- finished */
346 pthread_cancel(pm->rx_thread_handle);
348 pthread_join(pm->rx_thread_handle, (void **) &junk);
350 if (pm->timeout_thread_handle)
351 pthread_cancel(pm->timeout_thread_handle);
353 vl_client_disconnect();
354 vl_client_api_unmap();
363 set_timeout (unsigned short timeout)
365 vac_main_t *pm = &vac_main;
366 pthread_mutex_lock(&pm->timeout_lock);
367 read_timeout = timeout;
368 pthread_cond_signal(&pm->timeout_cv);
369 pthread_mutex_unlock(&pm->timeout_lock);
375 vac_main_t *pm = &vac_main;
376 pthread_mutex_lock(&pm->timeout_lock);
377 pthread_cond_signal(&pm->timeout_cancel_cv);
378 pthread_mutex_unlock(&pm->timeout_lock);
382 vac_read (char **p, int *l, u16 timeout)
384 unix_shared_memory_queue_t *q;
385 api_main_t *am = &api_main;
386 vac_main_t *pm = &vac_main;
387 vl_api_memclnt_keepalive_t *mp;
388 vl_api_memclnt_keepalive_reply_t *rmp;
392 vl_shmem_hdr_t *shmem_hdr;
394 if (!pm->connected_to_vlib) return -1;
398 if (am->our_pid == 0) return (-1);
400 /* Poke timeout thread */
402 set_timeout(timeout);
404 q = am->vl_input_queue;
407 rv = unix_shared_memory_queue_sub(q, (u8 *)&msg, 0);
409 u16 msg_id = ntohs(*((u16 *)msg));
411 case VL_API_RX_THREAD_EXIT:
412 printf("Received thread exit\n");
414 case VL_API_MEMCLNT_RX_THREAD_SUSPEND:
415 printf("Received thread suspend\n");
417 case VL_API_MEMCLNT_READ_TIMEOUT:
418 printf("Received read timeout %ds\n", timeout);
420 case VL_API_MEMCLNT_KEEPALIVE:
421 /* Handle an alive-check ping from vpp. */
423 rmp = vl_msg_api_alloc (sizeof (*rmp));
424 memset (rmp, 0, sizeof (*rmp));
425 rmp->_vl_msg_id = ntohs(VL_API_MEMCLNT_KEEPALIVE_REPLY);
426 rmp->context = mp->context;
427 shmem_hdr = am->shmem_hdr;
428 vl_msg_api_send_shmem(shmem_hdr->vl_input_queue, (u8 *)&rmp);
429 vl_msg_api_free((void *) msg);
431 * Python code is blissfully unaware of these pings, so
432 * act as if it never happened...
437 msgbuf = (msgbuf_t *)(((u8 *)msg) - offsetof(msgbuf_t, data));
438 *l = ntohl(msgbuf->data_len);
440 printf("Unregistered API message: %d\n", msg_id);
446 /* Let timeout notification thread know we're done */
450 printf("Read failed with %d\n", rv);
455 vl_msg_api_free((void *) msg);
456 /* Client might forget to resume RX thread on failure */
462 * XXX: Makes the assumption that client_index is the first member
464 typedef VL_API_PACKED(struct _vl_api_header {
470 vac_client_index (void)
472 return (api_main.my_client_index);
476 vac_write (char *p, int l)
479 api_main_t *am = &api_main;
480 vl_api_header_t *mp = vl_msg_api_alloc(l);
481 unix_shared_memory_queue_t *q;
482 vac_main_t *pm = &vac_main;
484 if (!pm->connected_to_vlib) return -1;
485 if (!mp) return (-1);
488 mp->client_index = vac_client_index();
489 q = am->shmem_hdr->vl_input_queue;
490 rv = unix_shared_memory_queue_add(q, (u8 *)&mp, 0);
492 clib_warning("vpe_api_write fails: %d\n", rv);
500 vac_get_msg_index (unsigned char * name)
502 return vl_api_get_msg_index (name);
506 vac_msg_table_max_index(void)
510 uword *h = vac_msg_table_get_hash();
511 hash_foreach_pair (hp, h,
513 if (hp->value[0] > max)
521 vac_set_error_handler (vac_error_callback_t cb)
523 if (cb) clib_error_register_handler (cb, 0);