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.
19 #include <sys/types.h>
20 #include <sys/socket.h>
23 #include <netinet/in.h>
27 #include <vnet/vnet.h>
28 #include <vlib/vlib.h>
29 #include <vlib/unix/unix.h>
30 #include <vlibapi/api.h>
31 #include <vlibmemory/api.h>
33 #include <vlibmemory/memclnt.api_enum.h>
34 #include <vlibmemory/memclnt.api_types.h>
36 #include "vppapiclient.h"
38 bool timeout_cancelled;
39 bool timeout_in_progress;
44 * Client registers a callback. All messages are sent to the callback.
46 * Client calls blocking read().
47 * Clients are expected to collate events on a queue.
48 * vac_write() -> suspends RX thread
49 * vac_read() -> resumes RX thread
54 pthread_t rx_thread_handle;
55 pthread_t timeout_thread_handle;
56 pthread_mutex_t queue_lock;
57 pthread_cond_t suspend_cv;
58 pthread_cond_t resume_cv;
59 pthread_mutex_t timeout_lock;
61 pthread_cond_t timeout_cv;
62 pthread_cond_t timeout_cancel_cv;
63 pthread_cond_t terminate_cv;
67 vac_callback_t vac_callback;
69 bool rx_is_running = false;
70 bool timeout_thread_cancelled = false;
72 /* Only ever allocate one heap */
73 bool mem_initialized = false;
78 vac_main_t *pm = &vac_main;
79 clib_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);
85 pthread_cond_init(&pm->timeout_cv, NULL);
86 pthread_cond_init(&pm->timeout_cancel_cv, NULL);
87 pthread_cond_init(&pm->terminate_cv, NULL);
93 vac_main_t *pm = &vac_main;
94 pthread_mutex_destroy(&pm->queue_lock);
95 pthread_cond_destroy(&pm->suspend_cv);
96 pthread_cond_destroy(&pm->resume_cv);
97 pthread_mutex_destroy(&pm->timeout_lock);
98 pthread_cond_destroy(&pm->timeout_cv);
99 pthread_cond_destroy(&pm->timeout_cancel_cv);
100 pthread_cond_destroy(&pm->terminate_cv);
101 clib_memset(pm, 0, sizeof(*pm));
105 vac_free (void * msg)
107 vl_msg_api_free (msg);
111 vac_api_handler (void *msg)
113 u16 id = ntohs(*((u16 *)msg));
114 msgbuf_t *msgbuf = (msgbuf_t *)(((u8 *)msg) - offsetof(msgbuf_t, data));
115 int l = ntohl(msgbuf->data_len);
117 clib_warning("Message ID %d has wrong length: %d\n", id, l);
119 /* Call Python callback */
120 ASSERT(vac_callback);
121 (vac_callback)(msg, l);
126 vac_rx_thread_fn (void *arg)
129 vl_api_memclnt_keepalive_t *mp;
130 vl_api_memclnt_keepalive_reply_t *rmp;
131 vac_main_t *pm = &vac_main;
132 api_main_t *am = vlibapi_get_main();
133 vl_shmem_hdr_t *shmem_hdr;
136 q = am->vl_input_queue;
139 while (!svm_queue_sub(q, (u8 *)&msg, SVM_Q_WAIT, 0))
141 VL_MSG_API_UNPOISON((void *)msg);
142 u16 id = ntohs(*((u16 *)msg));
144 case VL_API_RX_THREAD_EXIT:
145 vl_msg_api_free((void *) msg);
146 /* signal waiting threads that this thread is about to terminate */
147 pthread_mutex_lock(&pm->queue_lock);
148 rx_thread_done = true;
149 pthread_cond_signal(&pm->terminate_cv);
150 pthread_mutex_unlock(&pm->queue_lock);
155 case VL_API_MEMCLNT_RX_THREAD_SUSPEND:
156 vl_msg_api_free((void * )msg);
157 /* Suspend thread and signal reader */
158 pthread_mutex_lock(&pm->queue_lock);
159 pthread_cond_signal(&pm->suspend_cv);
160 /* Wait for the resume signal */
161 pthread_cond_wait (&pm->resume_cv, &pm->queue_lock);
162 pthread_mutex_unlock(&pm->queue_lock);
165 case VL_API_MEMCLNT_READ_TIMEOUT:
166 clib_warning("Received read timeout in async thread\n");
167 vl_msg_api_free((void *) msg);
170 case VL_API_MEMCLNT_KEEPALIVE:
172 rmp = vl_msg_api_alloc (sizeof (*rmp));
173 clib_memset (rmp, 0, sizeof (*rmp));
174 rmp->_vl_msg_id = ntohs(VL_API_MEMCLNT_KEEPALIVE_REPLY);
175 rmp->context = mp->context;
176 shmem_hdr = am->shmem_hdr;
177 vl_msg_api_send_shmem(shmem_hdr->vl_input_queue, (u8 *)&rmp);
178 vl_msg_api_free((void *) msg);
182 vac_api_handler((void *)msg);
188 vac_timeout_thread_fn (void *arg)
190 vl_api_memclnt_read_timeout_t *ep;
191 vac_main_t *pm = &vac_main;
192 api_main_t *am = vlibapi_get_main();
197 while (pm->timeout_loop)
200 pthread_mutex_lock(&pm->timeout_lock);
201 while (!timeout_in_progress)
202 pthread_cond_wait (&pm->timeout_cv, &pm->timeout_lock);
205 gettimeofday(&tv, NULL);
206 ts.tv_sec = tv.tv_sec + read_timeout;
209 if (!timeout_cancelled) {
210 rv = pthread_cond_timedwait (&pm->timeout_cancel_cv,
211 &pm->timeout_lock, &ts);
212 if (rv == ETIMEDOUT && !timeout_thread_cancelled) {
213 ep = vl_msg_api_alloc (sizeof (*ep));
214 ep->_vl_msg_id = ntohs(VL_API_MEMCLNT_READ_TIMEOUT);
215 vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
219 pthread_mutex_unlock(&pm->timeout_lock);
225 vac_rx_suspend (void)
227 api_main_t *am = vlibapi_get_main();
228 vac_main_t *pm = &vac_main;
229 vl_api_memclnt_rx_thread_suspend_t *ep;
231 if (!pm->rx_thread_handle) return;
232 pthread_mutex_lock(&pm->queue_lock);
235 ep = vl_msg_api_alloc (sizeof (*ep));
236 ep->_vl_msg_id = ntohs(VL_API_MEMCLNT_RX_THREAD_SUSPEND);
237 vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
238 /* Wait for RX thread to tell us it has suspended */
239 pthread_cond_wait(&pm->suspend_cv, &pm->queue_lock);
240 rx_is_running = false;
242 pthread_mutex_unlock(&pm->queue_lock);
248 vac_main_t *pm = &vac_main;
249 if (!pm->rx_thread_handle) return;
250 pthread_mutex_lock(&pm->queue_lock);
251 if (rx_is_running) goto unlock;
252 pthread_cond_signal(&pm->resume_cv);
253 rx_is_running = true;
255 pthread_mutex_unlock(&pm->queue_lock);
259 vac_msg_table_get_hash (void)
261 api_main_t *am = vlibapi_get_main();
262 return (am->msg_index_by_name_and_crc);
266 vac_msg_table_size(void)
268 api_main_t *am = vlibapi_get_main();
269 return hash_elts(am->msg_index_by_name_and_crc);
273 vac_connect (char * name, char * chroot_prefix, vac_callback_t cb,
276 rx_thread_done = false;
278 vac_main_t *pm = &vac_main;
280 assert (clib_mem_get_heap ());
282 if (chroot_prefix != NULL)
283 vl_set_memory_root_path (chroot_prefix);
285 if ((rv = vl_client_api_map("/vpe-api"))) {
286 clib_warning ("vl_client_api_map returned %d", rv);
290 if (vl_client_connect(name, 0, rx_qlen) < 0) {
291 vl_client_api_unmap();
296 /* Start the rx queue thread */
297 rv = pthread_create(&pm->rx_thread_handle, NULL, vac_rx_thread_fn, 0);
299 clib_warning("pthread_create returned %d", rv);
300 vl_client_api_unmap();
304 rx_is_running = true;
307 /* Start read timeout thread */
308 rv = pthread_create(&pm->timeout_thread_handle, NULL,
309 vac_timeout_thread_fn, 0);
311 clib_warning("pthread_create returned %d", rv);
312 vl_client_api_unmap();
316 pm->connected_to_vlib = 1;
321 set_timeout (unsigned short timeout)
323 vac_main_t *pm = &vac_main;
324 pthread_mutex_lock(&pm->timeout_lock);
325 read_timeout = timeout;
326 timeout_in_progress = true;
327 timeout_cancelled = false;
328 pthread_cond_signal(&pm->timeout_cv);
329 pthread_mutex_unlock(&pm->timeout_lock);
335 vac_main_t *pm = &vac_main;
336 pthread_mutex_lock(&pm->timeout_lock);
337 timeout_in_progress = false;
338 timeout_cancelled = true;
339 pthread_cond_signal(&pm->timeout_cancel_cv);
340 pthread_mutex_unlock(&pm->timeout_lock);
344 vac_disconnect (void)
346 api_main_t *am = vlibapi_get_main();
347 vac_main_t *pm = &vac_main;
351 if (!pm->connected_to_vlib) return 0;
353 if (pm->rx_thread_handle) {
354 vl_api_rx_thread_exit_t *ep;
355 ep = vl_msg_api_alloc (sizeof (*ep));
356 ep->_vl_msg_id = ntohs(VL_API_RX_THREAD_EXIT);
357 vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
359 /* wait (with timeout) until RX thread has finished */
362 gettimeofday(&tv, NULL);
363 ts.tv_sec = tv.tv_sec + 5;
366 pthread_mutex_lock(&pm->queue_lock);
367 if (rx_thread_done == false)
368 rv = pthread_cond_timedwait(&pm->terminate_cv, &pm->queue_lock, &ts);
369 pthread_mutex_unlock(&pm->queue_lock);
371 /* now join so we wait until thread has -really- finished */
373 pthread_cancel(pm->rx_thread_handle);
375 pthread_join(pm->rx_thread_handle, (void **) &junk);
377 if (pm->timeout_thread_handle) {
378 /* cancel, wake then join the timeout thread */
379 pm->timeout_loop = 0;
380 timeout_thread_cancelled = true;
382 pthread_join(pm->timeout_thread_handle, (void **) &junk);
385 vl_client_disconnect();
386 vl_client_api_unmap();
395 vac_read (char **p, int *l, u16 timeout)
398 api_main_t *am = vlibapi_get_main();
399 vac_main_t *pm = &vac_main;
400 vl_api_memclnt_keepalive_t *mp;
401 vl_api_memclnt_keepalive_reply_t *rmp;
405 vl_shmem_hdr_t *shmem_hdr;
407 /* svm_queue_sub(below) returns {-1, -2} */
408 if (!pm->connected_to_vlib)
409 return VAC_NOT_CONNECTED;
413 /* svm_queue_sub(below) returns {-1, -2} */
414 if (am->our_pid == 0)
415 return (VAC_SHM_NOT_READY);
417 /* Poke timeout thread */
419 set_timeout(timeout);
421 q = am->vl_input_queue;
424 rv = svm_queue_sub(q, (u8 *)&msg, SVM_Q_WAIT, 0);
427 VL_MSG_API_UNPOISON((void *)msg);
428 u16 msg_id = ntohs(*((u16 *)msg));
430 case VL_API_RX_THREAD_EXIT:
431 vl_msg_api_free((void *) msg);
433 case VL_API_MEMCLNT_RX_THREAD_SUSPEND:
435 case VL_API_MEMCLNT_READ_TIMEOUT:
437 case VL_API_MEMCLNT_KEEPALIVE:
438 /* Handle an alive-check ping from vpp. */
440 rmp = vl_msg_api_alloc (sizeof (*rmp));
441 clib_memset (rmp, 0, sizeof (*rmp));
442 rmp->_vl_msg_id = ntohs(VL_API_MEMCLNT_KEEPALIVE_REPLY);
443 rmp->context = mp->context;
444 shmem_hdr = am->shmem_hdr;
445 vl_msg_api_send_shmem(shmem_hdr->vl_input_queue, (u8 *)&rmp);
446 vl_msg_api_free((void *) msg);
448 * Python code is blissfully unaware of these pings, so
449 * act as if it never happened...
454 msgbuf = (msgbuf_t *)(((u8 *)msg) - offsetof(msgbuf_t, data));
455 *l = ntohl(msgbuf->data_len);
457 fprintf(stderr, "Unregistered API message: %d\n", msg_id);
465 fprintf(stderr, "Read failed with %d\n", rv);
467 /* Let timeout notification thread know we're done */
476 vl_msg_api_free((void *) msg);
477 /* Client might forget to resume RX thread on failure */
483 * XXX: Makes the assumption that client_index is the first member
485 typedef struct _vl_api_header
489 } __attribute__ ((packed)) vl_api_header_t;
492 vac_client_index (void)
494 return (vlibapi_get_main()->my_client_index);
498 vac_write (char *p, int l)
501 api_main_t *am = vlibapi_get_main();
502 vl_api_header_t *mp = vl_msg_api_alloc(l);
504 vac_main_t *pm = &vac_main;
506 if (!pm->connected_to_vlib)
507 return VAC_NOT_CONNECTED;
508 if (!mp) return (-1);
511 mp->client_index = vac_client_index();
512 q = am->shmem_hdr->vl_input_queue;
513 rv = svm_queue_add(q, (u8 *)&mp, 0);
515 fprintf(stderr, "vpe_api_write fails: %d\n", rv);
523 vac_get_msg_index (char * name)
525 return vl_msg_api_get_msg_index ((u8 *)name);
529 vac_msg_table_max_index(void)
533 uword *h = vac_msg_table_get_hash();
534 hash_foreach_pair (hp, h,
536 if (hp->value[0] > max)
544 vac_set_error_handler (vac_error_callback_t cb)
546 assert (clib_mem_get_heap ());
547 if (cb) clib_error_register_handler (cb, 0);
551 * Required if application doesn't use a VPP heap.
554 vac_mem_init (size_t size)
559 clib_mem_init (0, 1 << 30); // default
561 clib_mem_init (0, size);
562 mem_initialized = true;