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"
36 bool timeout_cancelled;
37 bool timeout_in_progress;
42 * Client registers a callback. All messages are sent to the callback.
44 * Client calls blocking read().
45 * Clients are expected to collate events on a queue.
46 * vac_write() -> suspends RX thread
47 * vac_read() -> resumes RX thread
50 #define vl_typedefs /* define message structures */
51 #include <vpp/api/vpe_all_api_h.h>
54 #define vl_endianfun /* define message structures */
55 #include <vpp/api/vpe_all_api_h.h>
58 vlib_main_t vlib_global_main;
59 vlib_main_t **vlib_mains;
63 pthread_t rx_thread_handle;
64 pthread_t timeout_thread_handle;
65 pthread_mutex_t queue_lock;
66 pthread_cond_t suspend_cv;
67 pthread_cond_t resume_cv;
68 pthread_mutex_t timeout_lock;
70 pthread_cond_t timeout_cv;
71 pthread_cond_t timeout_cancel_cv;
72 pthread_cond_t terminate_cv;
76 vac_callback_t vac_callback;
78 bool rx_is_running = false;
79 bool timeout_thread_cancelled = false;
81 /* Set to true to enable memory tracing */
82 bool mem_trace = false;
84 __attribute__((constructor))
86 vac_client_constructor (void)
88 clib_mem_init (0, 1 << 30);
93 __attribute__((destructor))
95 vac_client_destructor (void)
98 fformat(stderr, "TRACE: %s",
100 format_mheap, clib_mem_get_heap (), 1));
107 vac_main_t *pm = &vac_main;
108 clib_memset(pm, 0, sizeof(*pm));
109 pthread_mutex_init(&pm->queue_lock, NULL);
110 pthread_cond_init(&pm->suspend_cv, NULL);
111 pthread_cond_init(&pm->resume_cv, NULL);
112 pthread_mutex_init(&pm->timeout_lock, NULL);
113 pm->timeout_loop = 1;
114 pthread_cond_init(&pm->timeout_cv, NULL);
115 pthread_cond_init(&pm->timeout_cancel_cv, NULL);
116 pthread_cond_init(&pm->terminate_cv, NULL);
122 vac_main_t *pm = &vac_main;
123 pthread_mutex_destroy(&pm->queue_lock);
124 pthread_cond_destroy(&pm->suspend_cv);
125 pthread_cond_destroy(&pm->resume_cv);
126 pthread_mutex_destroy(&pm->timeout_lock);
127 pthread_cond_destroy(&pm->timeout_cv);
128 pthread_cond_destroy(&pm->timeout_cancel_cv);
129 pthread_cond_destroy(&pm->terminate_cv);
130 clib_memset(pm, 0, sizeof(*pm));
134 * Satisfy external references when -lvlib is not available.
136 void vlib_cli_output (struct vlib_main_t * vm, char * fmt, ...)
138 clib_warning ("vlib_cli_output called...");
142 vac_free (void * msg)
144 vl_msg_api_free (msg);
148 vac_api_handler (void *msg)
150 u16 id = ntohs(*((u16 *)msg));
151 msgbuf_t *msgbuf = (msgbuf_t *)(((u8 *)msg) - offsetof(msgbuf_t, data));
152 int l = ntohl(msgbuf->data_len);
154 clib_warning("Message ID %d has wrong length: %d\n", id, l);
156 /* Call Python callback */
157 ASSERT(vac_callback);
158 (vac_callback)(msg, l);
163 vac_rx_thread_fn (void *arg)
166 vl_api_memclnt_keepalive_t *mp;
167 vl_api_memclnt_keepalive_reply_t *rmp;
168 vac_main_t *pm = &vac_main;
169 api_main_t *am = vlibapi_get_main();
170 vl_shmem_hdr_t *shmem_hdr;
173 q = am->vl_input_queue;
176 while (!svm_queue_sub(q, (u8 *)&msg, SVM_Q_WAIT, 0))
178 VL_MSG_API_UNPOISON((void *)msg);
179 u16 id = ntohs(*((u16 *)msg));
181 case VL_API_RX_THREAD_EXIT:
182 vl_msg_api_free((void *) msg);
183 /* signal waiting threads that this thread is about to terminate */
184 pthread_mutex_lock(&pm->queue_lock);
185 rx_thread_done = true;
186 pthread_cond_signal(&pm->terminate_cv);
187 pthread_mutex_unlock(&pm->queue_lock);
192 case VL_API_MEMCLNT_RX_THREAD_SUSPEND:
193 vl_msg_api_free((void * )msg);
194 /* Suspend thread and signal reader */
195 pthread_mutex_lock(&pm->queue_lock);
196 pthread_cond_signal(&pm->suspend_cv);
197 /* Wait for the resume signal */
198 pthread_cond_wait (&pm->resume_cv, &pm->queue_lock);
199 pthread_mutex_unlock(&pm->queue_lock);
202 case VL_API_MEMCLNT_READ_TIMEOUT:
203 clib_warning("Received read timeout in async thread\n");
204 vl_msg_api_free((void *) msg);
207 case VL_API_MEMCLNT_KEEPALIVE:
209 rmp = vl_msg_api_alloc (sizeof (*rmp));
210 clib_memset (rmp, 0, sizeof (*rmp));
211 rmp->_vl_msg_id = ntohs(VL_API_MEMCLNT_KEEPALIVE_REPLY);
212 rmp->context = mp->context;
213 shmem_hdr = am->shmem_hdr;
214 vl_msg_api_send_shmem(shmem_hdr->vl_input_queue, (u8 *)&rmp);
215 vl_msg_api_free((void *) msg);
219 vac_api_handler((void *)msg);
225 vac_timeout_thread_fn (void *arg)
227 vl_api_memclnt_read_timeout_t *ep;
228 vac_main_t *pm = &vac_main;
229 api_main_t *am = vlibapi_get_main();
234 while (pm->timeout_loop)
237 pthread_mutex_lock(&pm->timeout_lock);
238 while (!timeout_in_progress)
239 pthread_cond_wait (&pm->timeout_cv, &pm->timeout_lock);
242 gettimeofday(&tv, NULL);
243 ts.tv_sec = tv.tv_sec + read_timeout;
246 if (!timeout_cancelled) {
247 rv = pthread_cond_timedwait (&pm->timeout_cancel_cv,
248 &pm->timeout_lock, &ts);
249 if (rv == ETIMEDOUT && !timeout_thread_cancelled) {
250 ep = vl_msg_api_alloc (sizeof (*ep));
251 ep->_vl_msg_id = ntohs(VL_API_MEMCLNT_READ_TIMEOUT);
252 vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
256 pthread_mutex_unlock(&pm->timeout_lock);
262 vac_rx_suspend (void)
264 api_main_t *am = vlibapi_get_main();
265 vac_main_t *pm = &vac_main;
266 vl_api_memclnt_rx_thread_suspend_t *ep;
268 if (!pm->rx_thread_handle) return;
269 pthread_mutex_lock(&pm->queue_lock);
272 ep = vl_msg_api_alloc (sizeof (*ep));
273 ep->_vl_msg_id = ntohs(VL_API_MEMCLNT_RX_THREAD_SUSPEND);
274 vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
275 /* Wait for RX thread to tell us it has suspended */
276 pthread_cond_wait(&pm->suspend_cv, &pm->queue_lock);
277 rx_is_running = false;
279 pthread_mutex_unlock(&pm->queue_lock);
285 vac_main_t *pm = &vac_main;
286 if (!pm->rx_thread_handle) return;
287 pthread_mutex_lock(&pm->queue_lock);
288 if (rx_is_running) goto unlock;
289 pthread_cond_signal(&pm->resume_cv);
290 rx_is_running = true;
292 pthread_mutex_unlock(&pm->queue_lock);
296 vac_msg_table_get_hash (void)
298 api_main_t *am = vlibapi_get_main();
299 return (am->msg_index_by_name_and_crc);
303 vac_msg_table_size(void)
305 api_main_t *am = vlibapi_get_main();
306 return hash_elts(am->msg_index_by_name_and_crc);
310 vac_connect (char * name, char * chroot_prefix, vac_callback_t cb,
313 rx_thread_done = false;
315 vac_main_t *pm = &vac_main;
318 if (chroot_prefix != NULL)
319 vl_set_memory_root_path (chroot_prefix);
321 if ((rv = vl_client_api_map("/vpe-api"))) {
322 clib_warning ("vl_client_api_map returned %d", rv);
326 if (vl_client_connect(name, 0, rx_qlen) < 0) {
327 vl_client_api_unmap();
332 /* Start the rx queue thread */
333 rv = pthread_create(&pm->rx_thread_handle, NULL, vac_rx_thread_fn, 0);
335 clib_warning("pthread_create returned %d", rv);
336 vl_client_api_unmap();
340 rx_is_running = true;
343 /* Start read timeout thread */
344 rv = pthread_create(&pm->timeout_thread_handle, NULL,
345 vac_timeout_thread_fn, 0);
347 clib_warning("pthread_create returned %d", rv);
348 vl_client_api_unmap();
352 pm->connected_to_vlib = 1;
357 set_timeout (unsigned short timeout)
359 vac_main_t *pm = &vac_main;
360 pthread_mutex_lock(&pm->timeout_lock);
361 read_timeout = timeout;
362 timeout_in_progress = true;
363 timeout_cancelled = false;
364 pthread_cond_signal(&pm->timeout_cv);
365 pthread_mutex_unlock(&pm->timeout_lock);
371 vac_main_t *pm = &vac_main;
372 pthread_mutex_lock(&pm->timeout_lock);
373 timeout_in_progress = false;
374 timeout_cancelled = true;
375 pthread_cond_signal(&pm->timeout_cancel_cv);
376 pthread_mutex_unlock(&pm->timeout_lock);
380 vac_disconnect (void)
382 api_main_t *am = vlibapi_get_main();
383 vac_main_t *pm = &vac_main;
387 if (!pm->connected_to_vlib) return 0;
389 if (pm->rx_thread_handle) {
390 vl_api_rx_thread_exit_t *ep;
391 ep = vl_msg_api_alloc (sizeof (*ep));
392 ep->_vl_msg_id = ntohs(VL_API_RX_THREAD_EXIT);
393 vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
395 /* wait (with timeout) until RX thread has finished */
398 gettimeofday(&tv, NULL);
399 ts.tv_sec = tv.tv_sec + 5;
402 pthread_mutex_lock(&pm->queue_lock);
403 if (rx_thread_done == false)
404 rv = pthread_cond_timedwait(&pm->terminate_cv, &pm->queue_lock, &ts);
405 pthread_mutex_unlock(&pm->queue_lock);
407 /* now join so we wait until thread has -really- finished */
409 pthread_cancel(pm->rx_thread_handle);
411 pthread_join(pm->rx_thread_handle, (void **) &junk);
413 if (pm->timeout_thread_handle) {
414 /* cancel, wake then join the timeout thread */
415 pm->timeout_loop = 0;
416 timeout_thread_cancelled = true;
418 pthread_join(pm->timeout_thread_handle, (void **) &junk);
421 vl_client_disconnect();
422 vl_client_api_unmap();
431 vac_read (char **p, int *l, u16 timeout)
434 api_main_t *am = vlibapi_get_main();
435 vac_main_t *pm = &vac_main;
436 vl_api_memclnt_keepalive_t *mp;
437 vl_api_memclnt_keepalive_reply_t *rmp;
441 vl_shmem_hdr_t *shmem_hdr;
443 /* svm_queue_sub(below) returns {-1, -2} */
444 if (!pm->connected_to_vlib) return -3;
448 /* svm_queue_sub(below) returns {-1, -2} */
449 if (am->our_pid == 0) return (-4);
451 /* Poke timeout thread */
453 set_timeout(timeout);
455 q = am->vl_input_queue;
458 rv = svm_queue_sub(q, (u8 *)&msg, SVM_Q_WAIT, 0);
461 VL_MSG_API_UNPOISON((void *)msg);
462 u16 msg_id = ntohs(*((u16 *)msg));
464 case VL_API_RX_THREAD_EXIT:
465 vl_msg_api_free((void *) msg);
467 case VL_API_MEMCLNT_RX_THREAD_SUSPEND:
469 case VL_API_MEMCLNT_READ_TIMEOUT:
471 case VL_API_MEMCLNT_KEEPALIVE:
472 /* Handle an alive-check ping from vpp. */
474 rmp = vl_msg_api_alloc (sizeof (*rmp));
475 clib_memset (rmp, 0, sizeof (*rmp));
476 rmp->_vl_msg_id = ntohs(VL_API_MEMCLNT_KEEPALIVE_REPLY);
477 rmp->context = mp->context;
478 shmem_hdr = am->shmem_hdr;
479 vl_msg_api_send_shmem(shmem_hdr->vl_input_queue, (u8 *)&rmp);
480 vl_msg_api_free((void *) msg);
482 * Python code is blissfully unaware of these pings, so
483 * act as if it never happened...
488 msgbuf = (msgbuf_t *)(((u8 *)msg) - offsetof(msgbuf_t, data));
489 *l = ntohl(msgbuf->data_len);
491 fprintf(stderr, "Unregistered API message: %d\n", msg_id);
499 fprintf(stderr, "Read failed with %d\n", rv);
501 /* Let timeout notification thread know we're done */
510 vl_msg_api_free((void *) msg);
511 /* Client might forget to resume RX thread on failure */
517 * XXX: Makes the assumption that client_index is the first member
519 typedef VL_API_PACKED(struct _vl_api_header {
525 vac_client_index (void)
527 return (vlibapi_get_main()->my_client_index);
531 vac_write (char *p, int l)
534 api_main_t *am = vlibapi_get_main();
535 vl_api_header_t *mp = vl_msg_api_alloc(l);
537 vac_main_t *pm = &vac_main;
539 if (!pm->connected_to_vlib) return -1;
540 if (!mp) return (-1);
543 mp->client_index = vac_client_index();
544 q = am->shmem_hdr->vl_input_queue;
545 rv = svm_queue_add(q, (u8 *)&mp, 0);
547 fprintf(stderr, "vpe_api_write fails: %d\n", rv);
555 vac_get_msg_index (unsigned char * name)
557 return vl_msg_api_get_msg_index (name);
561 vac_msg_table_max_index(void)
565 uword *h = vac_msg_table_get_hash();
566 hash_foreach_pair (hp, h,
568 if (hp->value[0] > max)
576 vac_set_error_handler (vac_error_callback_t cb)
578 if (cb) clib_error_register_handler (cb, 0);