2 *------------------------------------------------------------------
3 * memory_client.c - API message handling, client code.
5 * Copyright (c) 2010 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
24 #include <vppinfra/serialize.h>
25 #include <vppinfra/hash.h>
26 #include <vlibmemory/memory_client.h>
28 /* A hack. vl_client_get_first_plugin_msg_id depends on it */
29 #include <vlibmemory/socket_client.h>
31 #include <vlibmemory/vl_memory_msg_enum.h>
33 #define vl_typedefs /* define message structures */
34 #include <vlibmemory/vl_memory_api_h.h>
37 #define vl_endianfun /* define message structures */
38 #include <vlibmemory/vl_memory_api_h.h>
41 /* instantiate all the print functions we know about */
42 #define vl_print(handle, ...) clib_warning (__VA_ARGS__)
44 #include <vlibmemory/vl_memory_api_h.h>
47 memory_client_main_t memory_client_main;
50 rx_thread_fn (void *arg)
53 memory_client_main_t *mm = &memory_client_main;
54 api_main_t *am = &api_main;
56 q = am->vl_input_queue;
58 /* So we can make the rx thread terminate cleanly */
59 if (setjmp (mm->rx_thread_jmpbuf) == 0)
61 mm->rx_thread_jmpbuf_valid = 1;
62 clib_mem_set_thread_index ();
64 vl_msg_api_queue_handler (q);
70 vl_api_rx_thread_exit_t_handler (vl_api_rx_thread_exit_t * mp)
72 memory_client_main_t *mm = &memory_client_main;
73 if (mm->rx_thread_jmpbuf_valid)
74 longjmp (mm->rx_thread_jmpbuf, 1);
78 vl_api_name_and_crc_free (void)
80 api_main_t *am = &api_main;
85 if (!am->msg_index_by_name_and_crc)
89 hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
91 vec_add1 (keys, (u8 *) hp->key);
94 for (i = 0; i < vec_len (keys); i++)
97 hash_free (am->msg_index_by_name_and_crc);
101 vl_api_memclnt_create_reply_t_handler (vl_api_memclnt_create_reply_t * mp)
103 serialize_main_t _sm, *sm = &_sm;
104 api_main_t *am = &api_main;
111 am->my_client_index = mp->index;
112 am->my_registration = (vl_api_registration_t *) (uword) mp->handle;
114 /* Clean out any previous hash table (unlikely) */
115 vl_api_name_and_crc_free ();
117 am->msg_index_by_name_and_crc = hash_create_string (0, sizeof (uword));
119 /* Recreate the vnet-side API message handler table */
120 tblv = uword_to_pointer (mp->message_table, u8 *);
121 unserialize_open_data (sm, tblv, vec_len (tblv));
122 unserialize_integer (sm, &nmsgs, sizeof (u32));
124 for (i = 0; i < nmsgs; i++)
126 msg_index = unserialize_likely_small_unsigned_integer (sm);
127 unserialize_cstring (sm, (char **) &name_and_crc);
128 hash_set_mem (am->msg_index_by_name_and_crc, name_and_crc, msg_index);
133 noop_handler (void *notused)
137 void vl_msg_api_send_shmem (svm_queue_t * q, u8 * elem);
139 vl_client_connect (const char *name, int ctx_quota, int input_queue_size)
142 vl_api_memclnt_create_t *mp;
143 vl_api_memclnt_create_reply_t *rp;
144 svm_queue_t *vl_input_queue;
145 vl_shmem_hdr_t *shmem_hdr;
148 api_main_t *am = &api_main;
150 if (am->my_registration)
152 clib_warning ("client %s already connected...", name);
156 if (am->vlib_rp == 0)
158 clib_warning ("am->vlib_rp NULL");
163 shmem_hdr = am->shmem_hdr;
165 if (shmem_hdr == 0 || shmem_hdr->vl_input_queue == 0)
167 clib_warning ("shmem_hdr / input queue NULL");
171 pthread_mutex_lock (&svm->mutex);
172 oldheap = svm_push_data_heap (svm);
173 vl_input_queue = svm_queue_alloc_and_init (input_queue_size, sizeof (uword),
175 svm_pop_heap (oldheap);
176 pthread_mutex_unlock (&svm->mutex);
178 am->my_client_index = ~0;
179 am->my_registration = 0;
180 am->vl_input_queue = vl_input_queue;
182 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_create_t));
183 clib_memset (mp, 0, sizeof (*mp));
184 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE);
185 mp->ctx_quota = ctx_quota;
186 mp->input_queue = (uword) vl_input_queue;
187 strncpy ((char *) mp->name, name, sizeof (mp->name) - 1);
189 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
194 struct timespec ts, tsrem;
197 /* Wait up to 10 seconds */
198 for (i = 0; i < 1000; i++)
200 qstatus = svm_queue_sub (vl_input_queue, (u8 *) & rp,
205 ts.tv_nsec = 10000 * 1000; /* 10 ms */
206 while (nanosleep (&ts, &tsrem) < 0)
210 clib_warning ("memclnt_create_reply timeout");
214 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_CREATE_REPLY)
216 clib_warning ("unexpected reply: id %d", ntohs (rp->_vl_msg_id));
219 rv = clib_net_to_host_u32 (rp->response);
221 vl_msg_api_handler ((void *) rp);
228 vl_api_memclnt_delete_reply_t_handler (vl_api_memclnt_delete_reply_t * mp)
231 api_main_t *am = &api_main;
233 pthread_mutex_lock (&am->vlib_rp->mutex);
234 oldheap = svm_push_data_heap (am->vlib_rp);
235 svm_queue_free (am->vl_input_queue);
236 pthread_mutex_unlock (&am->vlib_rp->mutex);
237 svm_pop_heap (oldheap);
239 am->my_client_index = ~0;
240 am->my_registration = 0;
241 am->vl_input_queue = 0;
245 vl_client_send_disconnect (u8 do_cleanup)
247 vl_api_memclnt_delete_t *mp;
248 vl_shmem_hdr_t *shmem_hdr;
249 api_main_t *am = &api_main;
251 ASSERT (am->vlib_rp);
252 shmem_hdr = am->shmem_hdr;
253 ASSERT (shmem_hdr && shmem_hdr->vl_input_queue);
255 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_delete_t));
256 clib_memset (mp, 0, sizeof (*mp));
257 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE);
258 mp->index = am->my_client_index;
259 mp->handle = (uword) am->my_registration;
260 mp->do_cleanup = do_cleanup;
262 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
266 vl_client_disconnect (void)
268 vl_api_memclnt_delete_reply_t *rp;
269 svm_queue_t *vl_input_queue;
270 api_main_t *am = &api_main;
273 vl_input_queue = am->vl_input_queue;
274 vl_client_send_disconnect (0 /* wait for reply */ );
277 * Have to be careful here, in case the client is disconnecting
278 * because e.g. the vlib process died, or is unresponsive.
287 if (now >= (begin + 2))
289 clib_warning ("peer unresponsive, give up");
290 am->my_client_index = ~0;
291 am->my_registration = 0;
295 if (svm_queue_sub (vl_input_queue, (u8 *) & rp, SVM_Q_NOWAIT, 0) < 0)
298 /* drain the queue */
299 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_DELETE_REPLY)
301 clib_warning ("queue drain: %d", ntohs (rp->_vl_msg_id));
302 vl_msg_api_handler ((void *) rp);
305 vl_msg_api_handler ((void *) rp);
309 vl_api_name_and_crc_free ();
314 * Stave off the binary API dead client reaper
315 * Only sent to inactive clients
318 vl_api_memclnt_keepalive_t_handler (vl_api_memclnt_keepalive_t * mp)
320 vl_api_memclnt_keepalive_reply_t *rmp;
322 vl_shmem_hdr_t *shmem_hdr;
325 shmem_hdr = am->shmem_hdr;
327 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
328 clib_memset (rmp, 0, sizeof (*rmp));
329 rmp->_vl_msg_id = ntohs (VL_API_MEMCLNT_KEEPALIVE_REPLY);
330 rmp->context = mp->context;
331 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & rmp);
334 #define foreach_api_msg \
335 _(RX_THREAD_EXIT, rx_thread_exit) \
336 _(MEMCLNT_CREATE_REPLY, memclnt_create_reply) \
337 _(MEMCLNT_DELETE_REPLY, memclnt_delete_reply) \
338 _(MEMCLNT_KEEPALIVE, memclnt_keepalive)
341 vl_client_install_client_message_handlers (void)
345 vl_msg_api_set_handlers(VL_API_##N, #n, \
346 vl_api_##n##_t_handler, \
348 vl_api_##n##_t_endian, \
349 vl_api_##n##_t_print, \
350 sizeof(vl_api_##n##_t), 1);
356 vl_client_api_map (const char *region_name)
360 if ((rv = vl_map_shmem (region_name, 0 /* is_vlib */ )) < 0)
363 vl_client_install_client_message_handlers ();
368 vl_client_api_unmap (void)
370 vl_unmap_shmem_client ();
374 vl_mem_client_is_connected (void)
376 return (memory_client_main.connected_to_vlib != 0);
380 connect_to_vlib_internal (const char *svm_name,
381 const char *client_name,
382 int rx_queue_size, void *(*thread_fn) (void *),
386 memory_client_main_t *mm = &memory_client_main;
387 api_main_t *am = &api_main;
389 if (do_map && (rv = vl_client_api_map (svm_name)))
391 clib_warning ("vl_client_api map rv %d", rv);
395 if (vl_client_connect (client_name, 0 /* punt quota */ ,
396 rx_queue_size /* input queue */ ) < 0)
398 vl_client_api_unmap ();
402 /* Start the rx queue thread */
406 rv = pthread_create (&mm->rx_thread_handle,
407 NULL /*attr */ , thread_fn, 0);
410 clib_warning ("pthread_create returned %d", rv);
411 am->rx_thread_handle = 0;
415 am->rx_thread_handle = mm->rx_thread_handle;
419 mm->connected_to_vlib = 1;
424 vl_client_connect_to_vlib (const char *svm_name,
425 const char *client_name, int rx_queue_size)
427 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
428 rx_thread_fn, 1 /* do map */ );
432 vl_client_connect_to_vlib_no_rx_pthread (const char *svm_name,
433 const char *client_name,
436 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
437 0 /* no rx_thread_fn */ ,
442 vl_client_connect_to_vlib_no_map (const char *svm_name,
443 const char *client_name, int rx_queue_size)
445 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
446 rx_thread_fn, 0 /* dont map */ );
450 vl_client_connect_to_vlib_no_rx_pthread_no_map (const char *svm_name,
451 const char *client_name,
454 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
455 0 /* want pthread */ ,
460 vl_client_connect_to_vlib_thread_fn (const char *svm_name,
461 const char *client_name,
463 void *(*thread_fn) (void *))
465 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
466 thread_fn, 1 /* do map */ );
471 disconnect_from_vlib_internal (u8 do_unmap)
473 memory_client_main_t *mm = &memory_client_main;
474 api_main_t *am = &api_main;
477 if (mm->rx_thread_jmpbuf_valid)
479 vl_api_rx_thread_exit_t *ep;
480 ep = vl_msg_api_alloc (sizeof (*ep));
481 ep->_vl_msg_id = ntohs (VL_API_RX_THREAD_EXIT);
482 vl_msg_api_send_shmem (am->vl_input_queue, (u8 *) & ep);
483 pthread_join (mm->rx_thread_handle, (void **) &junk);
485 if (mm->connected_to_vlib)
487 vl_client_disconnect ();
489 vl_client_api_unmap ();
491 clib_memset (mm, 0, sizeof (*mm));
495 vl_client_disconnect_from_vlib (void)
497 disconnect_from_vlib_internal (1);
501 vl_client_disconnect_from_vlib_no_unmap (void)
503 disconnect_from_vlib_internal (0);
506 static void vl_api_get_first_msg_id_reply_t_handler
507 (vl_api_get_first_msg_id_reply_t * mp)
509 memory_client_main_t *mm = &memory_client_main;
510 i32 retval = ntohl (mp->retval);
512 mm->first_msg_id_reply = (retval >= 0) ? ntohs (mp->first_msg_id) : ~0;
513 mm->first_msg_id_reply_ready = 1;
517 vl_client_get_first_plugin_msg_id (const char *plugin_name)
519 vl_api_get_first_msg_id_t *mp;
520 api_main_t *am = &api_main;
521 memory_client_main_t *mm = &memory_client_main;
524 clib_time_t clib_time;
527 if (strlen (plugin_name) + 1 > sizeof (mp->name))
530 clib_memset (&clib_time, 0, sizeof (clib_time));
531 clib_time_init (&clib_time);
533 /* Push this plugin's first_msg_id_reply handler */
534 old_handler = am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY];
535 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = (void *)
536 vl_api_get_first_msg_id_reply_t_handler;
538 /* Ask the data-plane for the message-ID base of the indicated plugin */
539 mm->first_msg_id_reply_ready = 0;
541 /* Not using shm client */
542 if (!am->my_registration)
544 mp = vl_socket_client_msg_alloc (sizeof (*mp));
545 clib_memset (mp, 0, sizeof (*mp));
546 mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
547 mp->client_index = am->my_client_index;
548 strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
550 if (vl_socket_client_write () <= 0)
552 if (vl_socket_client_read (1))
555 if (mm->first_msg_id_reply_ready == 1)
557 rv = mm->first_msg_id_reply;
562 /* Restore old handler */
563 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
569 mp = vl_msg_api_alloc (sizeof (*mp));
570 clib_memset (mp, 0, sizeof (*mp));
571 mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
572 mp->client_index = am->my_client_index;
573 strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
575 vl_msg_api_send_shmem (am->shmem_hdr->vl_input_queue, (u8 *) & mp);
577 /* Synchronously wait for the answer */
578 timeout = clib_time_now (&clib_time) + 1.0;
579 while (clib_time_now (&clib_time) < timeout)
581 if (mm->first_msg_id_reply_ready == 1)
583 rv = mm->first_msg_id_reply;
587 /* Restore old handler */
588 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
595 /* Restore the old handler */
596 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
599 clib_warning ("plugin '%s' not registered", plugin_name);
605 * fd.io coding-style-patch-verification: ON
608 * eval: (c-set-style "gnu")