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);
94 heap = clib_mem_get_per_cpu_heap ();
95 h = mheap_header (heap);
96 /* make the main heap thread-safe */
97 h->flags |= MHEAP_FLAG_THREAD_SAFE;
104 __attribute__((destructor))
106 vac_client_destructor (void)
109 fformat(stderr, "TRACE: %s",
111 format_mheap, clib_mem_get_heap (), 1));
118 vac_main_t *pm = &vac_main;
119 clib_memset(pm, 0, sizeof(*pm));
120 pthread_mutex_init(&pm->queue_lock, NULL);
121 pthread_cond_init(&pm->suspend_cv, NULL);
122 pthread_cond_init(&pm->resume_cv, NULL);
123 pthread_mutex_init(&pm->timeout_lock, NULL);
124 pm->timeout_loop = 1;
125 pthread_cond_init(&pm->timeout_cv, NULL);
126 pthread_cond_init(&pm->timeout_cancel_cv, NULL);
127 pthread_cond_init(&pm->terminate_cv, NULL);
133 vac_main_t *pm = &vac_main;
134 pthread_mutex_destroy(&pm->queue_lock);
135 pthread_cond_destroy(&pm->suspend_cv);
136 pthread_cond_destroy(&pm->resume_cv);
137 pthread_mutex_destroy(&pm->timeout_lock);
138 pthread_cond_destroy(&pm->timeout_cv);
139 pthread_cond_destroy(&pm->timeout_cancel_cv);
140 pthread_cond_destroy(&pm->terminate_cv);
141 clib_memset(pm, 0, sizeof(*pm));
145 * Satisfy external references when -lvlib is not available.
147 void vlib_cli_output (struct vlib_main_t * vm, char * fmt, ...)
149 clib_warning ("vlib_cli_output called...");
153 vac_free (void * msg)
155 vl_msg_api_free (msg);
159 vac_api_handler (void *msg)
161 u16 id = ntohs(*((u16 *)msg));
162 msgbuf_t *msgbuf = (msgbuf_t *)(((u8 *)msg) - offsetof(msgbuf_t, data));
163 int l = ntohl(msgbuf->data_len);
165 clib_warning("Message ID %d has wrong length: %d\n", id, l);
167 /* Call Python callback */
168 ASSERT(vac_callback);
169 (vac_callback)(msg, l);
174 vac_rx_thread_fn (void *arg)
177 vl_api_memclnt_keepalive_t *mp;
178 vl_api_memclnt_keepalive_reply_t *rmp;
179 vac_main_t *pm = &vac_main;
180 api_main_t *am = &api_main;
181 vl_shmem_hdr_t *shmem_hdr;
184 q = am->vl_input_queue;
187 while (!svm_queue_sub(q, (u8 *)&msg, SVM_Q_WAIT, 0))
189 u16 id = ntohs(*((u16 *)msg));
191 case VL_API_RX_THREAD_EXIT:
192 vl_msg_api_free((void *) msg);
193 /* signal waiting threads that this thread is about to terminate */
194 pthread_mutex_lock(&pm->queue_lock);
195 rx_thread_done = true;
196 pthread_cond_signal(&pm->terminate_cv);
197 pthread_mutex_unlock(&pm->queue_lock);
202 case VL_API_MEMCLNT_RX_THREAD_SUSPEND:
203 vl_msg_api_free((void * )msg);
204 /* Suspend thread and signal reader */
205 pthread_mutex_lock(&pm->queue_lock);
206 pthread_cond_signal(&pm->suspend_cv);
207 /* Wait for the resume signal */
208 pthread_cond_wait (&pm->resume_cv, &pm->queue_lock);
209 pthread_mutex_unlock(&pm->queue_lock);
212 case VL_API_MEMCLNT_READ_TIMEOUT:
213 clib_warning("Received read timeout in async thread\n");
214 vl_msg_api_free((void *) msg);
217 case VL_API_MEMCLNT_KEEPALIVE:
219 rmp = vl_msg_api_alloc (sizeof (*rmp));
220 clib_memset (rmp, 0, sizeof (*rmp));
221 rmp->_vl_msg_id = ntohs(VL_API_MEMCLNT_KEEPALIVE_REPLY);
222 rmp->context = mp->context;
223 shmem_hdr = am->shmem_hdr;
224 vl_msg_api_send_shmem(shmem_hdr->vl_input_queue, (u8 *)&rmp);
225 vl_msg_api_free((void *) msg);
229 vac_api_handler((void *)msg);
235 vac_timeout_thread_fn (void *arg)
237 vl_api_memclnt_read_timeout_t *ep;
238 vac_main_t *pm = &vac_main;
239 api_main_t *am = &api_main;
244 while (pm->timeout_loop)
247 pthread_mutex_lock(&pm->timeout_lock);
248 while (!timeout_in_progress)
249 pthread_cond_wait (&pm->timeout_cv, &pm->timeout_lock);
252 gettimeofday(&tv, NULL);
253 ts.tv_sec = tv.tv_sec + read_timeout;
256 if (!timeout_cancelled) {
257 rv = pthread_cond_timedwait (&pm->timeout_cancel_cv,
258 &pm->timeout_lock, &ts);
259 if (rv == ETIMEDOUT && !timeout_thread_cancelled) {
260 ep = vl_msg_api_alloc (sizeof (*ep));
261 ep->_vl_msg_id = ntohs(VL_API_MEMCLNT_READ_TIMEOUT);
262 vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
266 pthread_mutex_unlock(&pm->timeout_lock);
272 vac_rx_suspend (void)
274 api_main_t *am = &api_main;
275 vac_main_t *pm = &vac_main;
276 vl_api_memclnt_rx_thread_suspend_t *ep;
278 if (!pm->rx_thread_handle) return;
279 pthread_mutex_lock(&pm->queue_lock);
282 ep = vl_msg_api_alloc (sizeof (*ep));
283 ep->_vl_msg_id = ntohs(VL_API_MEMCLNT_RX_THREAD_SUSPEND);
284 vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
285 /* Wait for RX thread to tell us it has suspended */
286 pthread_cond_wait(&pm->suspend_cv, &pm->queue_lock);
287 rx_is_running = false;
289 pthread_mutex_unlock(&pm->queue_lock);
295 vac_main_t *pm = &vac_main;
296 if (!pm->rx_thread_handle) return;
297 pthread_mutex_lock(&pm->queue_lock);
298 if (rx_is_running) goto unlock;
299 pthread_cond_signal(&pm->resume_cv);
300 rx_is_running = true;
302 pthread_mutex_unlock(&pm->queue_lock);
306 vac_msg_table_get_hash (void)
308 api_main_t *am = &api_main;
309 return (am->msg_index_by_name_and_crc);
313 vac_msg_table_size(void)
315 api_main_t *am = &api_main;
316 return hash_elts(am->msg_index_by_name_and_crc);
320 vac_connect (char * name, char * chroot_prefix, vac_callback_t cb,
323 rx_thread_done = false;
325 vac_main_t *pm = &vac_main;
328 if (chroot_prefix != NULL)
329 vl_set_memory_root_path (chroot_prefix);
331 if ((rv = vl_client_api_map("/vpe-api"))) {
332 clib_warning ("vl_client_api_map returned %d", rv);
336 if (vl_client_connect(name, 0, rx_qlen) < 0) {
337 vl_client_api_unmap();
342 /* Start the rx queue thread */
343 rv = pthread_create(&pm->rx_thread_handle, NULL, vac_rx_thread_fn, 0);
345 clib_warning("pthread_create returned %d", rv);
346 vl_client_api_unmap();
350 rx_is_running = true;
353 /* Start read timeout thread */
354 rv = pthread_create(&pm->timeout_thread_handle, NULL,
355 vac_timeout_thread_fn, 0);
357 clib_warning("pthread_create returned %d", rv);
358 vl_client_api_unmap();
362 pm->connected_to_vlib = 1;
367 set_timeout (unsigned short timeout)
369 vac_main_t *pm = &vac_main;
370 pthread_mutex_lock(&pm->timeout_lock);
371 read_timeout = timeout;
372 timeout_in_progress = true;
373 timeout_cancelled = false;
374 pthread_cond_signal(&pm->timeout_cv);
375 pthread_mutex_unlock(&pm->timeout_lock);
381 vac_main_t *pm = &vac_main;
382 pthread_mutex_lock(&pm->timeout_lock);
383 timeout_in_progress = false;
384 timeout_cancelled = true;
385 pthread_cond_signal(&pm->timeout_cancel_cv);
386 pthread_mutex_unlock(&pm->timeout_lock);
390 vac_disconnect (void)
392 api_main_t *am = &api_main;
393 vac_main_t *pm = &vac_main;
397 if (!pm->connected_to_vlib) return 0;
399 if (pm->rx_thread_handle) {
400 vl_api_rx_thread_exit_t *ep;
401 ep = vl_msg_api_alloc (sizeof (*ep));
402 ep->_vl_msg_id = ntohs(VL_API_RX_THREAD_EXIT);
403 vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
405 /* wait (with timeout) until RX thread has finished */
408 gettimeofday(&tv, NULL);
409 ts.tv_sec = tv.tv_sec + 5;
412 pthread_mutex_lock(&pm->queue_lock);
413 if (rx_thread_done == false)
414 rv = pthread_cond_timedwait(&pm->terminate_cv, &pm->queue_lock, &ts);
415 pthread_mutex_unlock(&pm->queue_lock);
417 /* now join so we wait until thread has -really- finished */
419 pthread_cancel(pm->rx_thread_handle);
421 pthread_join(pm->rx_thread_handle, (void **) &junk);
423 if (pm->timeout_thread_handle) {
424 /* cancel, wake then join the timeout thread */
425 pm->timeout_loop = 0;
426 timeout_thread_cancelled = true;
428 pthread_join(pm->timeout_thread_handle, (void **) &junk);
431 vl_client_disconnect();
432 vl_client_api_unmap();
441 vac_read (char **p, int *l, u16 timeout)
444 api_main_t *am = &api_main;
445 vac_main_t *pm = &vac_main;
446 vl_api_memclnt_keepalive_t *mp;
447 vl_api_memclnt_keepalive_reply_t *rmp;
451 vl_shmem_hdr_t *shmem_hdr;
453 if (!pm->connected_to_vlib) return -1;
457 if (am->our_pid == 0) return (-1);
459 /* Poke timeout thread */
461 set_timeout(timeout);
463 q = am->vl_input_queue;
466 rv = svm_queue_sub(q, (u8 *)&msg, SVM_Q_WAIT, 0);
469 u16 msg_id = ntohs(*((u16 *)msg));
471 case VL_API_RX_THREAD_EXIT:
472 vl_msg_api_free((void *) msg);
474 case VL_API_MEMCLNT_RX_THREAD_SUSPEND:
476 case VL_API_MEMCLNT_READ_TIMEOUT:
478 case VL_API_MEMCLNT_KEEPALIVE:
479 /* Handle an alive-check ping from vpp. */
481 rmp = vl_msg_api_alloc (sizeof (*rmp));
482 clib_memset (rmp, 0, sizeof (*rmp));
483 rmp->_vl_msg_id = ntohs(VL_API_MEMCLNT_KEEPALIVE_REPLY);
484 rmp->context = mp->context;
485 shmem_hdr = am->shmem_hdr;
486 vl_msg_api_send_shmem(shmem_hdr->vl_input_queue, (u8 *)&rmp);
487 vl_msg_api_free((void *) msg);
489 * Python code is blissfully unaware of these pings, so
490 * act as if it never happened...
495 msgbuf = (msgbuf_t *)(((u8 *)msg) - offsetof(msgbuf_t, data));
496 *l = ntohl(msgbuf->data_len);
498 fprintf(stderr, "Unregistered API message: %d\n", msg_id);
506 fprintf(stderr, "Read failed with %d\n", rv);
508 /* Let timeout notification thread know we're done */
517 vl_msg_api_free((void *) msg);
518 /* Client might forget to resume RX thread on failure */
524 * XXX: Makes the assumption that client_index is the first member
526 typedef VL_API_PACKED(struct _vl_api_header {
532 vac_client_index (void)
534 return (api_main.my_client_index);
538 vac_write (char *p, int l)
541 api_main_t *am = &api_main;
542 vl_api_header_t *mp = vl_msg_api_alloc(l);
544 vac_main_t *pm = &vac_main;
546 if (!pm->connected_to_vlib) return -1;
547 if (!mp) return (-1);
550 mp->client_index = vac_client_index();
551 q = am->shmem_hdr->vl_input_queue;
552 rv = svm_queue_add(q, (u8 *)&mp, 0);
554 fprintf(stderr, "vpe_api_write fails: %d\n", rv);
562 vac_get_msg_index (unsigned char * name)
564 return vl_msg_api_get_msg_index (name);
568 vac_msg_table_max_index(void)
572 uword *h = vac_msg_table_get_hash();
573 hash_foreach_pair (hp, h,
575 if (hp->value[0] > max)
583 vac_set_error_handler (vac_error_callback_t cb)
585 if (cb) clib_error_register_handler (cb, 0);