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>
27 #include <vlibapi/api_common.h>
29 /* A hack. vl_client_get_first_plugin_msg_id depends on it */
30 #include <vlibmemory/socket_client.h>
32 #include <vlibmemory/vl_memory_msg_enum.h>
34 #define vl_typedefs /* define message structures */
35 #include <vlibmemory/vl_memory_api_h.h>
38 #define vl_endianfun /* define message structures */
39 #include <vlibmemory/vl_memory_api_h.h>
42 /* instantiate all the print functions we know about */
43 #define vl_print(handle, ...) clib_warning (__VA_ARGS__)
45 #include <vlibmemory/vl_memory_api_h.h>
48 memory_client_main_t memory_client_main;
49 __thread memory_client_main_t *my_memory_client_main = &memory_client_main;
51 typedef struct rx_thread_fn_arg
54 memory_client_main_t *mm;
58 rx_thread_fn (void *arg)
60 rx_thread_fn_arg_t *a = (rx_thread_fn_arg_t *) arg;
61 memory_client_main_t *mm;
64 vlibapi_set_main (a->am);
65 vlibapi_set_memory_client_main (a->mm);
68 mm = vlibapi_get_memory_client_main ();
69 q = vlibapi_get_main ()->vl_input_queue;
71 /* So we can make the rx thread terminate cleanly */
72 if (setjmp (mm->rx_thread_jmpbuf) == 0)
74 mm->rx_thread_jmpbuf_valid = 1;
75 clib_mem_set_thread_index ();
77 vl_msg_api_queue_handler (q);
83 vl_api_rx_thread_exit_t_handler (vl_api_rx_thread_exit_t * mp)
85 memory_client_main_t *mm = vlibapi_get_memory_client_main ();
86 if (mm->rx_thread_jmpbuf_valid)
87 longjmp (mm->rx_thread_jmpbuf, 1);
91 vl_api_name_and_crc_free (void)
93 api_main_t *am = vlibapi_get_main ();
98 if (!am->msg_index_by_name_and_crc)
102 hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
104 vec_add1 (keys, (u8 *) hp->key);
107 for (i = 0; i < vec_len (keys); i++)
110 hash_free (am->msg_index_by_name_and_crc);
113 CLIB_NOSANITIZE_ADDR static void
114 VL_API_VEC_UNPOISON (const void *v)
116 const vec_header_t *vh = &((vec_header_t *) v)[-1];
117 CLIB_MEM_UNPOISON (vh, sizeof (*vh) + vec_len (v));
121 vl_api_memclnt_create_reply_t_handler (vl_api_memclnt_create_reply_t * mp)
123 serialize_main_t _sm, *sm = &_sm;
124 api_main_t *am = vlibapi_get_main ();
131 am->my_client_index = mp->index;
132 am->my_registration = (vl_api_registration_t *) (uword) mp->handle;
134 /* Clean out any previous hash table (unlikely) */
135 vl_api_name_and_crc_free ();
137 am->msg_index_by_name_and_crc = hash_create_string (0, sizeof (uword));
139 /* Recreate the vnet-side API message handler table */
140 tblv = uword_to_pointer (mp->message_table, u8 *);
141 unserialize_open_data (sm, tblv, vec_len (tblv));
142 unserialize_integer (sm, &nmsgs, sizeof (u32));
144 VL_API_VEC_UNPOISON (tblv);
146 for (i = 0; i < nmsgs; i++)
148 msg_index = unserialize_likely_small_unsigned_integer (sm);
149 unserialize_cstring (sm, (char **) &name_and_crc);
150 hash_set_mem (am->msg_index_by_name_and_crc, name_and_crc, msg_index);
155 noop_handler (void *notused)
159 void vl_msg_api_send_shmem (svm_queue_t * q, u8 * elem);
161 vl_client_connect (const char *name, int ctx_quota, int input_queue_size)
164 vl_api_memclnt_create_t *mp;
165 vl_api_memclnt_create_reply_t *rp;
166 svm_queue_t *vl_input_queue;
167 vl_shmem_hdr_t *shmem_hdr;
170 api_main_t *am = vlibapi_get_main ();
172 if (am->my_registration)
174 clib_warning ("client %s already connected...", name);
178 if (am->vlib_rp == 0)
180 clib_warning ("am->vlib_rp NULL");
185 shmem_hdr = am->shmem_hdr;
187 if (shmem_hdr == 0 || shmem_hdr->vl_input_queue == 0)
189 clib_warning ("shmem_hdr / input queue NULL");
193 CLIB_MEM_UNPOISON (shmem_hdr, sizeof (*shmem_hdr));
194 VL_MSG_API_SVM_QUEUE_UNPOISON (shmem_hdr->vl_input_queue);
196 pthread_mutex_lock (&svm->mutex);
197 oldheap = svm_push_data_heap (svm);
198 vl_input_queue = svm_queue_alloc_and_init (input_queue_size, sizeof (uword),
200 svm_pop_heap (oldheap);
201 pthread_mutex_unlock (&svm->mutex);
203 am->my_client_index = ~0;
204 am->my_registration = 0;
205 am->vl_input_queue = vl_input_queue;
207 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_create_t));
208 clib_memset (mp, 0, sizeof (*mp));
209 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE);
210 mp->ctx_quota = ctx_quota;
211 mp->input_queue = (uword) vl_input_queue;
212 strncpy ((char *) mp->name, name, sizeof (mp->name) - 1);
214 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
219 struct timespec ts, tsrem;
222 /* Wait up to 10 seconds */
223 for (i = 0; i < 1000; i++)
225 qstatus = svm_queue_sub (vl_input_queue, (u8 *) & rp,
230 ts.tv_nsec = 10000 * 1000; /* 10 ms */
231 while (nanosleep (&ts, &tsrem) < 0)
235 clib_warning ("memclnt_create_reply timeout");
239 VL_MSG_API_UNPOISON (rp);
240 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_CREATE_REPLY)
242 clib_warning ("unexpected reply: id %d", ntohs (rp->_vl_msg_id));
245 rv = clib_net_to_host_u32 (rp->response);
247 vl_msg_api_handler ((void *) rp);
254 vl_api_memclnt_delete_reply_t_handler (vl_api_memclnt_delete_reply_t * mp)
257 api_main_t *am = vlibapi_get_main ();
259 pthread_mutex_lock (&am->vlib_rp->mutex);
260 oldheap = svm_push_data_heap (am->vlib_rp);
261 svm_queue_free (am->vl_input_queue);
262 pthread_mutex_unlock (&am->vlib_rp->mutex);
263 svm_pop_heap (oldheap);
265 am->my_client_index = ~0;
266 am->my_registration = 0;
267 am->vl_input_queue = 0;
271 vl_client_send_disconnect (u8 do_cleanup)
273 vl_api_memclnt_delete_t *mp;
274 vl_shmem_hdr_t *shmem_hdr;
275 api_main_t *am = vlibapi_get_main ();
277 ASSERT (am->vlib_rp);
278 shmem_hdr = am->shmem_hdr;
279 ASSERT (shmem_hdr && shmem_hdr->vl_input_queue);
281 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_delete_t));
282 clib_memset (mp, 0, sizeof (*mp));
283 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE);
284 mp->index = am->my_client_index;
285 mp->handle = (uword) am->my_registration;
286 mp->do_cleanup = do_cleanup;
288 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
292 vl_client_disconnect (void)
294 vl_api_memclnt_delete_reply_t *rp;
295 svm_queue_t *vl_input_queue;
296 api_main_t *am = vlibapi_get_main ();
299 vl_input_queue = am->vl_input_queue;
300 vl_client_send_disconnect (0 /* wait for reply */ );
303 * Have to be careful here, in case the client is disconnecting
304 * because e.g. the vlib process died, or is unresponsive.
313 if (now >= (begin + 2))
315 clib_warning ("peer unresponsive, give up");
316 am->my_client_index = ~0;
317 am->my_registration = 0;
321 if (svm_queue_sub (vl_input_queue, (u8 *) & rp, SVM_Q_NOWAIT, 0) < 0)
324 VL_MSG_API_UNPOISON (rp);
326 /* drain the queue */
327 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_DELETE_REPLY)
329 clib_warning ("queue drain: %d", ntohs (rp->_vl_msg_id));
330 vl_msg_api_handler ((void *) rp);
333 vl_msg_api_handler ((void *) rp);
337 vl_api_name_and_crc_free ();
342 * Stave off the binary API dead client reaper
343 * Only sent to inactive clients
346 vl_api_memclnt_keepalive_t_handler (vl_api_memclnt_keepalive_t * mp)
348 vl_api_memclnt_keepalive_reply_t *rmp;
350 vl_shmem_hdr_t *shmem_hdr;
352 am = vlibapi_get_main ();
353 shmem_hdr = am->shmem_hdr;
355 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
356 clib_memset (rmp, 0, sizeof (*rmp));
357 rmp->_vl_msg_id = ntohs (VL_API_MEMCLNT_KEEPALIVE_REPLY);
358 rmp->context = mp->context;
359 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & rmp);
362 #define foreach_api_msg \
363 _(RX_THREAD_EXIT, rx_thread_exit) \
364 _(MEMCLNT_CREATE_REPLY, memclnt_create_reply) \
365 _(MEMCLNT_DELETE_REPLY, memclnt_delete_reply) \
366 _(MEMCLNT_KEEPALIVE, memclnt_keepalive)
369 vl_client_install_client_message_handlers (void)
373 vl_msg_api_set_handlers(VL_API_##N, #n, \
374 vl_api_##n##_t_handler, \
376 vl_api_##n##_t_endian, \
377 vl_api_##n##_t_print, \
378 sizeof(vl_api_##n##_t), 1);
384 vl_client_api_map (const char *region_name)
388 if ((rv = vl_map_shmem (region_name, 0 /* is_vlib */ )) < 0)
391 vl_client_install_client_message_handlers ();
396 vl_client_api_unmap (void)
398 vl_unmap_shmem_client ();
402 vl_mem_client_is_connected (void)
404 return (memory_client_main.connected_to_vlib != 0);
408 connect_to_vlib_internal (const char *svm_name,
409 const char *client_name,
410 int rx_queue_size, void *(*thread_fn) (void *),
411 void *thread_fn_arg, int do_map)
414 memory_client_main_t *mm = vlibapi_get_memory_client_main ();
415 api_main_t *am = vlibapi_get_main ();
417 if (do_map && (rv = vl_client_api_map (svm_name)))
419 clib_warning ("vl_client_api map rv %d", rv);
423 if (vl_client_connect (client_name, 0 /* punt quota */ ,
424 rx_queue_size /* input queue */ ) < 0)
426 vl_client_api_unmap ();
430 /* Start the rx queue thread */
434 if (thread_fn == rx_thread_fn)
436 rx_thread_fn_arg_t *arg;
437 arg = clib_mem_alloc (sizeof (*arg));
438 arg->am = vlibapi_get_main ();
439 arg->mm = vlibapi_get_memory_client_main ();
440 thread_fn_arg = (void *) arg;
443 rv = pthread_create (&mm->rx_thread_handle,
444 NULL /*attr */ , thread_fn, thread_fn_arg);
447 clib_warning ("pthread_create returned %d", rv);
448 am->rx_thread_handle = 0;
452 am->rx_thread_handle = mm->rx_thread_handle;
456 mm->connected_to_vlib = 1;
461 vl_client_connect_to_vlib (const char *svm_name,
462 const char *client_name, int rx_queue_size)
464 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
465 rx_thread_fn, 0 /* thread fn arg */ ,
470 vl_client_connect_to_vlib_no_rx_pthread (const char *svm_name,
471 const char *client_name,
474 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
475 0 /* no rx_thread_fn */ ,
476 0 /* no thread fn arg */ ,
481 vl_client_connect_to_vlib_no_map (const char *svm_name,
482 const char *client_name, int rx_queue_size)
484 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
485 rx_thread_fn, 0 /* no thread fn arg */ ,
490 vl_client_connect_to_vlib_no_rx_pthread_no_map (const char *svm_name,
491 const char *client_name,
494 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
495 0 /* no thread_fn */ ,
496 0 /* no thread fn arg */ ,
501 vl_client_connect_to_vlib_thread_fn (const char *svm_name,
502 const char *client_name,
504 void *(*thread_fn) (void *), void *arg)
506 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
507 thread_fn, arg, 1 /* do map */ );
512 disconnect_from_vlib_internal (u8 do_unmap)
514 memory_client_main_t *mm = vlibapi_get_memory_client_main ();
515 api_main_t *am = vlibapi_get_main ();
518 if (mm->rx_thread_jmpbuf_valid)
520 vl_api_rx_thread_exit_t *ep;
521 ep = vl_msg_api_alloc (sizeof (*ep));
522 ep->_vl_msg_id = ntohs (VL_API_RX_THREAD_EXIT);
523 vl_msg_api_send_shmem (am->vl_input_queue, (u8 *) & ep);
524 pthread_join (mm->rx_thread_handle, (void **) &junk);
526 if (mm->connected_to_vlib)
528 vl_client_disconnect ();
530 vl_client_api_unmap ();
532 clib_memset (mm, 0, sizeof (*mm));
536 vl_client_disconnect_from_vlib (void)
538 disconnect_from_vlib_internal (1);
542 vl_client_disconnect_from_vlib_no_unmap (void)
544 disconnect_from_vlib_internal (0);
547 static void vl_api_get_first_msg_id_reply_t_handler
548 (vl_api_get_first_msg_id_reply_t * mp)
550 memory_client_main_t *mm = vlibapi_get_memory_client_main ();
551 i32 retval = ntohl (mp->retval);
553 mm->first_msg_id_reply = (retval >= 0) ? ntohs (mp->first_msg_id) : ~0;
554 mm->first_msg_id_reply_ready = 1;
558 vl_client_get_first_plugin_msg_id (const char *plugin_name)
560 vl_api_get_first_msg_id_t *mp;
561 api_main_t *am = vlibapi_get_main ();
562 memory_client_main_t *mm = vlibapi_get_memory_client_main ();
565 clib_time_t clib_time;
568 if (strlen (plugin_name) + 1 > sizeof (mp->name))
571 clib_memset (&clib_time, 0, sizeof (clib_time));
572 clib_time_init (&clib_time);
574 /* Push this plugin's first_msg_id_reply handler */
575 old_handler = am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY];
576 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = (void *)
577 vl_api_get_first_msg_id_reply_t_handler;
579 /* Ask the data-plane for the message-ID base of the indicated plugin */
580 mm->first_msg_id_reply_ready = 0;
582 /* Not using shm client */
583 if (!am->my_registration)
585 mp = vl_socket_client_msg_alloc (sizeof (*mp));
586 clib_memset (mp, 0, sizeof (*mp));
587 mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
588 mp->client_index = am->my_client_index;
589 strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
591 if (vl_socket_client_write () <= 0)
593 if (vl_socket_client_read (1))
596 if (mm->first_msg_id_reply_ready == 1)
598 rv = mm->first_msg_id_reply;
603 /* Restore old handler */
604 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
610 mp = vl_msg_api_alloc (sizeof (*mp));
611 clib_memset (mp, 0, sizeof (*mp));
612 mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
613 mp->client_index = am->my_client_index;
614 strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
616 vl_msg_api_send_shmem (am->shmem_hdr->vl_input_queue, (u8 *) & mp);
618 /* Synchronously wait for the answer */
619 timeout = clib_time_now (&clib_time) + 1.0;
620 while (clib_time_now (&clib_time) < timeout)
622 if (mm->first_msg_id_reply_ready == 1)
624 rv = mm->first_msg_id_reply;
628 /* Restore old handler */
629 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
636 /* Restore the old handler */
637 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
640 clib_warning ("plugin '%s' not registered", plugin_name);
646 * fd.io coding-style-patch-verification: ON
649 * eval: (c-set-style "gnu")