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;
66 pthread_cond_t timeout_cv;
67 pthread_cond_t timeout_cancel_cv;
68 pthread_cond_t terminate_cv;
72 vac_callback_t vac_callback;
74 bool rx_is_running = false;
76 /* Set to true to enable memory tracing */
77 bool mem_trace = false;
79 __attribute__((constructor))
81 vac_client_constructor (void)
83 clib_mem_init (0, 1 << 30);
89 heap = clib_mem_get_per_cpu_heap ();
90 h = mheap_header (heap);
91 /* make the main heap thread-safe */
92 h->flags |= MHEAP_FLAG_THREAD_SAFE;
99 __attribute__((destructor))
101 vac_client_destructor (void)
104 fformat(stderr, "TRACE: %s",
106 format_mheap, clib_mem_get_heap (), 1));
113 vac_main_t *pm = &vac_main;
114 memset(pm, 0, sizeof(*pm));
115 pthread_mutex_init(&pm->queue_lock, NULL);
116 pthread_cond_init(&pm->suspend_cv, NULL);
117 pthread_cond_init(&pm->resume_cv, NULL);
118 pthread_mutex_init(&pm->timeout_lock, NULL);
119 pm->timeout_loop = 1;
120 pthread_cond_init(&pm->timeout_cv, NULL);
121 pthread_cond_init(&pm->timeout_cancel_cv, NULL);
122 pthread_cond_init(&pm->terminate_cv, NULL);
128 vac_main_t *pm = &vac_main;
129 pthread_mutex_destroy(&pm->queue_lock);
130 pthread_cond_destroy(&pm->suspend_cv);
131 pthread_cond_destroy(&pm->resume_cv);
132 pthread_mutex_destroy(&pm->timeout_lock);
133 pthread_cond_destroy(&pm->timeout_cv);
134 pthread_cond_destroy(&pm->timeout_cancel_cv);
135 pthread_cond_destroy(&pm->terminate_cv);
136 memset(pm, 0, sizeof(*pm));
140 * Satisfy external references when -lvlib is not available.
142 void vlib_cli_output (struct vlib_main_t * vm, char * fmt, ...)
144 clib_warning ("vlib_cli_output called...");
148 vac_free (void * msg)
150 vl_msg_api_free (msg);
154 vac_api_handler (void *msg)
156 u16 id = ntohs(*((u16 *)msg));
157 msgbuf_t *msgbuf = (msgbuf_t *)(((u8 *)msg) - offsetof(msgbuf_t, data));
158 int l = ntohl(msgbuf->data_len);
160 clib_warning("Message ID %d has wrong length: %d\n", id, l);
162 /* Call Python callback */
163 ASSERT(vac_callback);
164 (vac_callback)(msg, l);
169 vac_rx_thread_fn (void *arg)
172 vl_api_memclnt_keepalive_t *mp;
173 vl_api_memclnt_keepalive_reply_t *rmp;
174 vac_main_t *pm = &vac_main;
175 api_main_t *am = &api_main;
176 vl_shmem_hdr_t *shmem_hdr;
179 q = am->vl_input_queue;
182 while (!svm_queue_sub(q, (u8 *)&msg, SVM_Q_WAIT, 0))
184 u16 id = ntohs(*((u16 *)msg));
186 case VL_API_RX_THREAD_EXIT:
187 vl_msg_api_free((void *) msg);
188 /* signal waiting threads that this thread is about to terminate */
189 pthread_mutex_lock(&pm->queue_lock);
190 pthread_cond_signal(&pm->terminate_cv);
191 pthread_mutex_unlock(&pm->queue_lock);
196 case VL_API_MEMCLNT_RX_THREAD_SUSPEND:
197 vl_msg_api_free((void * )msg);
198 /* Suspend thread and signal reader */
199 pthread_mutex_lock(&pm->queue_lock);
200 pthread_cond_signal(&pm->suspend_cv);
201 /* Wait for the resume signal */
202 pthread_cond_wait (&pm->resume_cv, &pm->queue_lock);
203 pthread_mutex_unlock(&pm->queue_lock);
206 case VL_API_MEMCLNT_READ_TIMEOUT:
207 clib_warning("Received read timeout in async thread\n");
208 vl_msg_api_free((void *) msg);
211 case VL_API_MEMCLNT_KEEPALIVE:
213 rmp = vl_msg_api_alloc (sizeof (*rmp));
214 memset (rmp, 0, sizeof (*rmp));
215 rmp->_vl_msg_id = ntohs(VL_API_MEMCLNT_KEEPALIVE_REPLY);
216 rmp->context = mp->context;
217 shmem_hdr = am->shmem_hdr;
218 vl_msg_api_send_shmem(shmem_hdr->vl_input_queue, (u8 *)&rmp);
219 vl_msg_api_free((void *) msg);
223 vac_api_handler((void *)msg);
229 vac_timeout_thread_fn (void *arg)
231 vl_api_memclnt_read_timeout_t *ep;
232 vac_main_t *pm = &vac_main;
233 api_main_t *am = &api_main;
239 while (pm->timeout_loop)
242 pthread_mutex_lock(&pm->timeout_lock);
243 pthread_cond_wait (&pm->timeout_cv, &pm->timeout_lock);
244 timeout = read_timeout;
245 gettimeofday(&tv, NULL);
246 ts.tv_sec = tv.tv_sec + timeout;
248 rv = pthread_cond_timedwait (&pm->timeout_cancel_cv,
249 &pm->timeout_lock, &ts);
250 pthread_mutex_unlock(&pm->timeout_lock);
253 ep = vl_msg_api_alloc (sizeof (*ep));
254 ep->_vl_msg_id = ntohs(VL_API_MEMCLNT_READ_TIMEOUT);
255 vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
262 vac_rx_suspend (void)
264 api_main_t *am = &api_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 suspendend */
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 = &api_main;
299 return (am->msg_index_by_name_and_crc);
303 vac_msg_table_size(void)
305 api_main_t *am = &api_main;
306 return hash_elts(am->msg_index_by_name_and_crc);
310 vac_connect (char * name, char * chroot_prefix, vac_callback_t cb,
314 vac_main_t *pm = &vac_main;
317 if (chroot_prefix != NULL)
318 vl_set_memory_root_path (chroot_prefix);
320 if ((rv = vl_client_api_map("/vpe-api"))) {
321 clib_warning ("vl_client_api_map returned %d", rv);
325 if (vl_client_connect(name, 0, rx_qlen) < 0) {
326 vl_client_api_unmap();
331 /* Start the rx queue thread */
332 rv = pthread_create(&pm->rx_thread_handle, NULL, vac_rx_thread_fn, 0);
334 clib_warning("pthread_create returned %d", rv);
335 vl_client_api_unmap();
339 rx_is_running = true;
342 /* Start read timeout thread */
343 rv = pthread_create(&pm->timeout_thread_handle, NULL,
344 vac_timeout_thread_fn, 0);
346 clib_warning("pthread_create returned %d", rv);
347 vl_client_api_unmap();
351 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 pthread_cond_signal(&pm->timeout_cv);
363 pthread_mutex_unlock(&pm->timeout_lock);
369 vac_main_t *pm = &vac_main;
370 pthread_mutex_lock(&pm->timeout_lock);
371 pthread_cond_signal(&pm->timeout_cancel_cv);
372 pthread_mutex_unlock(&pm->timeout_lock);
376 vac_disconnect (void)
378 api_main_t *am = &api_main;
379 vac_main_t *pm = &vac_main;
382 if (!pm->connected_to_vlib) return 0;
384 if (pm->rx_thread_handle) {
385 vl_api_rx_thread_exit_t *ep;
386 ep = vl_msg_api_alloc (sizeof (*ep));
387 ep->_vl_msg_id = ntohs(VL_API_RX_THREAD_EXIT);
388 vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
390 /* wait (with timeout) until RX thread has finished */
393 gettimeofday(&tv, NULL);
394 ts.tv_sec = tv.tv_sec + 5;
396 pthread_mutex_lock(&pm->queue_lock);
397 int rv = pthread_cond_timedwait(&pm->terminate_cv, &pm->queue_lock, &ts);
398 pthread_mutex_unlock(&pm->queue_lock);
399 /* now join so we wait until thread has -really- finished */
401 pthread_cancel(pm->rx_thread_handle);
403 pthread_join(pm->rx_thread_handle, (void **) &junk);
405 if (pm->timeout_thread_handle) {
406 /* cancel, wake then join the timeout thread */
407 clib_warning("vac_disconnect cancel");
408 pm->timeout_loop = 0;
410 pthread_join(pm->timeout_thread_handle, (void **) &junk);
413 vl_client_disconnect();
414 vl_client_api_unmap();
423 vac_read (char **p, int *l, u16 timeout)
426 api_main_t *am = &api_main;
427 vac_main_t *pm = &vac_main;
428 vl_api_memclnt_keepalive_t *mp;
429 vl_api_memclnt_keepalive_reply_t *rmp;
433 vl_shmem_hdr_t *shmem_hdr;
435 if (!pm->connected_to_vlib) return -1;
439 if (am->our_pid == 0) return (-1);
441 /* Poke timeout thread */
443 set_timeout(timeout);
445 q = am->vl_input_queue;
448 rv = svm_queue_sub(q, (u8 *)&msg, SVM_Q_WAIT, 0);
451 u16 msg_id = ntohs(*((u16 *)msg));
453 case VL_API_RX_THREAD_EXIT:
454 printf("Received thread exit\n");
455 vl_msg_api_free((void *) msg);
457 case VL_API_MEMCLNT_RX_THREAD_SUSPEND:
458 printf("Received thread suspend\n");
460 case VL_API_MEMCLNT_READ_TIMEOUT:
461 printf("Received read timeout %ds\n", timeout);
463 case VL_API_MEMCLNT_KEEPALIVE:
464 /* Handle an alive-check ping from vpp. */
466 rmp = vl_msg_api_alloc (sizeof (*rmp));
467 memset (rmp, 0, sizeof (*rmp));
468 rmp->_vl_msg_id = ntohs(VL_API_MEMCLNT_KEEPALIVE_REPLY);
469 rmp->context = mp->context;
470 shmem_hdr = am->shmem_hdr;
471 vl_msg_api_send_shmem(shmem_hdr->vl_input_queue, (u8 *)&rmp);
472 vl_msg_api_free((void *) msg);
474 * Python code is blissfully unaware of these pings, so
475 * act as if it never happened...
480 msgbuf = (msgbuf_t *)(((u8 *)msg) - offsetof(msgbuf_t, data));
481 *l = ntohl(msgbuf->data_len);
483 printf("Unregistered API message: %d\n", msg_id);
489 /* Let timeout notification thread know we're done */
493 printf("Read failed with %d\n", rv);
498 vl_msg_api_free((void *) msg);
499 /* Client might forget to resume RX thread on failure */
505 * XXX: Makes the assumption that client_index is the first member
507 typedef VL_API_PACKED(struct _vl_api_header {
513 vac_client_index (void)
515 return (api_main.my_client_index);
519 vac_write (char *p, int l)
522 api_main_t *am = &api_main;
523 vl_api_header_t *mp = vl_msg_api_alloc(l);
525 vac_main_t *pm = &vac_main;
527 if (!pm->connected_to_vlib) return -1;
528 if (!mp) return (-1);
531 mp->client_index = vac_client_index();
532 q = am->shmem_hdr->vl_input_queue;
533 rv = svm_queue_add(q, (u8 *)&mp, 0);
535 clib_warning("vpe_api_write fails: %d\n", rv);
543 vac_get_msg_index (unsigned char * name)
545 return vl_msg_api_get_msg_index (name);
549 vac_msg_table_max_index(void)
553 uword *h = vac_msg_table_get_hash();
554 hash_foreach_pair (hp, h,
556 if (hp->value[0] > max)
564 vac_set_error_handler (vac_error_callback_t cb)
566 if (cb) clib_error_register_handler (cb, 0);