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 *------------------------------------------------------------------
23 #include <sys/types.h>
26 #include <netinet/in.h>
33 #include <vppinfra/clib.h>
34 #include <vppinfra/vec.h>
35 #include <vppinfra/hash.h>
36 #include <vppinfra/bitmap.h>
37 #include <vppinfra/fifo.h>
38 #include <vppinfra/time.h>
39 #include <vppinfra/mheap.h>
40 #include <vppinfra/heap.h>
41 #include <vppinfra/pool.h>
42 #include <vppinfra/format.h>
44 #include <vlib/vlib.h>
45 #include <vlib/unix/unix.h>
46 #include <vlibmemory/api.h>
48 #include <vlibmemory/vl_memory_msg_enum.h>
50 #define vl_typedefs /* define message structures */
51 #include <vlibmemory/vl_memory_api_h.h>
54 #define vl_endianfun /* define message structures */
55 #include <vlibmemory/vl_memory_api_h.h>
58 /* instantiate all the print functions we know about */
59 #define vl_print(handle, ...) clib_warning (__VA_ARGS__)
61 #include <vlibmemory/vl_memory_api_h.h>
66 u8 rx_thread_jmpbuf_valid;
68 jmp_buf rx_thread_jmpbuf;
69 pthread_t rx_thread_handle;
70 /* Plugin message base lookup scheme */
71 volatile u8 first_msg_id_reply_ready;
72 u16 first_msg_id_reply;
73 } memory_client_main_t;
75 memory_client_main_t memory_client_main;
78 rx_thread_fn (void *arg)
80 unix_shared_memory_queue_t *q;
81 memory_client_main_t *mm = &memory_client_main;
82 api_main_t *am = &api_main;
85 q = am->vl_input_queue;
87 /* So we can make the rx thread terminate cleanly */
88 if (setjmp (mm->rx_thread_jmpbuf) == 0)
90 mm->rx_thread_jmpbuf_valid = 1;
92 * Find an unused slot in the per-cpu-mheaps array,
93 * and grab it for this thread. We need to be able to
94 * push/pop the thread heap without affecting other thread(s).
96 if (__os_thread_index == 0)
98 for (i = 0; i < ARRAY_LEN (clib_per_cpu_mheaps); i++)
100 if (clib_per_cpu_mheaps[i] == 0)
102 /* Copy the main thread mheap pointer */
103 clib_per_cpu_mheaps[i] = clib_per_cpu_mheaps[0];
104 __os_thread_index = i;
108 ASSERT (__os_thread_index > 0);
111 vl_msg_api_queue_handler (q);
117 vl_api_rx_thread_exit_t_handler (vl_api_rx_thread_exit_t * mp)
119 memory_client_main_t *mm = &memory_client_main;
120 vl_msg_api_free (mp);
121 longjmp (mm->rx_thread_jmpbuf, 1);
125 vl_api_memclnt_create_reply_t_handler (vl_api_memclnt_create_reply_t * mp)
127 serialize_main_t _sm, *sm = &_sm;
128 api_main_t *am = &api_main;
135 am->my_client_index = mp->index;
136 am->my_registration = (vl_api_registration_t *) (uword) mp->handle;
138 /* Clean out any previous hash table (unlikely) */
139 if (am->msg_index_by_name_and_crc)
145 hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
147 vec_add1 (keys, (u8 *) hp->key);
150 for (i = 0; i < vec_len (keys); i++)
155 am->msg_index_by_name_and_crc = hash_create_string (0, sizeof (uword));
157 /* Recreate the vnet-side API message handler table */
158 tblv = uword_to_pointer (mp->message_table, u8 *);
159 unserialize_open_data (sm, tblv, vec_len (tblv));
160 unserialize_integer (sm, &nmsgs, sizeof (u32));
162 for (i = 0; i < nmsgs; i++)
164 msg_index = unserialize_likely_small_unsigned_integer (sm);
165 unserialize_cstring (sm, (char **) &name_and_crc);
166 hash_set_mem (am->msg_index_by_name_and_crc, name_and_crc, msg_index);
171 noop_handler (void *notused)
176 vl_client_connect (const char *name, int ctx_quota, int input_queue_size)
179 vl_api_memclnt_create_t *mp;
180 vl_api_memclnt_create_reply_t *rp;
181 unix_shared_memory_queue_t *vl_input_queue;
182 vl_shmem_hdr_t *shmem_hdr;
185 api_main_t *am = &api_main;
187 if (am->my_registration)
189 clib_warning ("client %s already connected...", name);
193 if (am->vlib_rp == 0)
195 clib_warning ("am->vlib_rp NULL");
200 shmem_hdr = am->shmem_hdr;
202 if (shmem_hdr == 0 || shmem_hdr->vl_input_queue == 0)
204 clib_warning ("shmem_hdr / input queue NULL");
208 pthread_mutex_lock (&svm->mutex);
209 oldheap = svm_push_data_heap (svm);
211 unix_shared_memory_queue_init (input_queue_size, sizeof (uword),
213 pthread_mutex_unlock (&svm->mutex);
214 svm_pop_heap (oldheap);
216 am->my_client_index = ~0;
217 am->my_registration = 0;
218 am->vl_input_queue = vl_input_queue;
220 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_create_t));
221 memset (mp, 0, sizeof (*mp));
222 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE);
223 mp->ctx_quota = ctx_quota;
224 mp->input_queue = (uword) vl_input_queue;
225 strncpy ((char *) mp->name, name, sizeof (mp->name) - 1);
227 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
232 struct timespec ts, tsrem;
235 /* Wait up to 10 seconds */
236 for (i = 0; i < 1000; i++)
238 qstatus = unix_shared_memory_queue_sub (vl_input_queue, (u8 *) & rp,
243 ts.tv_nsec = 10000 * 1000; /* 10 ms */
244 while (nanosleep (&ts, &tsrem) < 0)
248 clib_warning ("memclnt_create_reply timeout");
252 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_CREATE_REPLY)
254 clib_warning ("unexpected reply: id %d", ntohs (rp->_vl_msg_id));
257 rv = clib_net_to_host_u32 (rp->response);
259 vl_msg_api_handler ((void *) rp);
266 vl_api_memclnt_delete_reply_t_handler (vl_api_memclnt_delete_reply_t * mp)
269 api_main_t *am = &api_main;
271 pthread_mutex_lock (&am->vlib_rp->mutex);
272 oldheap = svm_push_data_heap (am->vlib_rp);
273 unix_shared_memory_queue_free (am->vl_input_queue);
274 pthread_mutex_unlock (&am->vlib_rp->mutex);
275 svm_pop_heap (oldheap);
277 am->my_client_index = ~0;
278 am->my_registration = 0;
279 am->vl_input_queue = 0;
283 vl_client_disconnect (void)
285 vl_api_memclnt_delete_t *mp;
286 vl_api_memclnt_delete_reply_t *rp;
287 unix_shared_memory_queue_t *vl_input_queue;
288 vl_shmem_hdr_t *shmem_hdr;
290 api_main_t *am = &api_main;
292 ASSERT (am->vlib_rp);
293 shmem_hdr = am->shmem_hdr;
294 ASSERT (shmem_hdr && shmem_hdr->vl_input_queue);
296 vl_input_queue = am->vl_input_queue;
298 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_delete_t));
299 memset (mp, 0, sizeof (*mp));
300 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE);
301 mp->index = am->my_client_index;
302 mp->handle = (uword) am->my_registration;
304 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
307 * Have to be careful here, in case the client is disconnecting
308 * because e.g. the vlib process died, or is unresponsive.
318 if (now >= (begin + 2))
320 clib_warning ("peer unresponsive, give up");
321 am->my_client_index = ~0;
322 am->my_registration = 0;
326 if (unix_shared_memory_queue_sub (vl_input_queue, (u8 *) & rp, 1) < 0)
329 /* drain the queue */
330 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_DELETE_REPLY)
332 clib_warning ("queue drain: %d", ntohs (rp->_vl_msg_id));
333 vl_msg_api_handler ((void *) rp);
336 vl_msg_api_handler ((void *) rp);
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;
353 shmem_hdr = am->shmem_hdr;
355 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
356 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)
370 vl_client_install_client_message_handlers (void)
374 vl_msg_api_set_handlers(VL_API_##N, #n, \
375 vl_api_##n##_t_handler, \
377 vl_api_##n##_t_endian, \
378 vl_api_##n##_t_print, \
379 sizeof(vl_api_##n##_t), 1);
386 vl_client_api_map (const char *region_name)
390 if ((rv = vl_map_shmem (region_name, 0 /* is_vlib */ )) < 0)
393 vl_client_install_client_message_handlers ();
398 vl_client_api_unmap (void)
404 connect_to_vlib_internal (const char *svm_name,
405 const char *client_name,
406 int rx_queue_size, int want_pthread, int do_map)
409 memory_client_main_t *mm = &memory_client_main;
411 if (do_map && (rv = vl_client_api_map (svm_name)))
413 clib_warning ("vl_client_api map rv %d", rv);
417 if (vl_client_connect (client_name, 0 /* punt quota */ ,
418 rx_queue_size /* input queue */ ) < 0)
420 vl_client_api_unmap ();
424 /* Start the rx queue thread */
428 rv = pthread_create (&mm->rx_thread_handle,
429 NULL /*attr */ , rx_thread_fn, 0);
431 clib_warning ("pthread_create returned %d", rv);
434 mm->connected_to_vlib = 1;
439 vl_client_connect_to_vlib (const char *svm_name,
440 const char *client_name, int rx_queue_size)
442 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
443 1 /* want pthread */ ,
448 vl_client_connect_to_vlib_no_rx_pthread (const char *svm_name,
449 const char *client_name,
452 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
453 0 /* want pthread */ ,
458 vl_client_connect_to_vlib_no_map (const char *svm_name,
459 const char *client_name, int rx_queue_size)
461 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
462 1 /* want pthread */ ,
467 vl_client_disconnect_from_vlib (void)
469 memory_client_main_t *mm = &memory_client_main;
470 api_main_t *am = &api_main;
473 if (mm->rx_thread_jmpbuf_valid)
475 vl_api_rx_thread_exit_t *ep;
476 ep = vl_msg_api_alloc (sizeof (*ep));
477 ep->_vl_msg_id = ntohs (VL_API_RX_THREAD_EXIT);
478 vl_msg_api_send_shmem (am->vl_input_queue, (u8 *) & ep);
479 pthread_join (mm->rx_thread_handle, (void **) &junk);
481 if (mm->connected_to_vlib)
483 vl_client_disconnect ();
484 vl_client_api_unmap ();
486 memset (mm, 0, sizeof (*mm));
489 static void vl_api_get_first_msg_id_reply_t_handler
490 (vl_api_get_first_msg_id_reply_t * mp)
492 memory_client_main_t *mm = &memory_client_main;
493 i32 retval = ntohl (mp->retval);
495 mm->first_msg_id_reply = (retval >= 0) ? ntohs (mp->first_msg_id) : ~0;
496 mm->first_msg_id_reply_ready = 1;
500 vl_client_get_first_plugin_msg_id (const char *plugin_name)
502 vl_api_get_first_msg_id_t *mp;
503 api_main_t *am = &api_main;
504 memory_client_main_t *mm = &memory_client_main;
507 clib_time_t clib_time;
510 if (strlen (plugin_name) + 1 > sizeof (mp->name))
513 memset (&clib_time, 0, sizeof (clib_time));
514 clib_time_init (&clib_time);
516 /* Push this plugin's first_msg_id_reply handler */
517 old_handler = am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY];
518 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = (void *)
519 vl_api_get_first_msg_id_reply_t_handler;
521 /* Ask the data-plane for the message-ID base of the indicated plugin */
522 mm->first_msg_id_reply_ready = 0;
524 mp = vl_msg_api_alloc (sizeof (*mp));
525 memset (mp, 0, sizeof (*mp));
526 mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
527 mp->client_index = am->my_client_index;
528 strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
530 vl_msg_api_send_shmem (am->shmem_hdr->vl_input_queue, (u8 *) & mp);
532 /* Synchronously wait for the answer */
535 timeout = clib_time_now (&clib_time) + 1.0;
537 while (clib_time_now (&clib_time) < timeout)
539 if (mm->first_msg_id_reply_ready == 1)
541 rv = mm->first_msg_id_reply;
545 /* Restore old handler */
546 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
554 /* Restore the old handler */
555 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
558 clib_warning ("plugin '%s' not registered", plugin_name);
564 * fd.io coding-style-patch-verification: ON
567 * eval: (c-set-style "gnu")