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>
49 u8 rx_thread_jmpbuf_valid;
51 jmp_buf rx_thread_jmpbuf;
52 pthread_t rx_thread_handle;
53 /* Plugin message base lookup scheme */
54 volatile u8 first_msg_id_reply_ready;
55 u16 first_msg_id_reply;
56 } memory_client_main_t;
58 memory_client_main_t memory_client_main;
61 rx_thread_fn (void *arg)
64 memory_client_main_t *mm = &memory_client_main;
65 api_main_t *am = &api_main;
68 q = am->vl_input_queue;
70 /* So we can make the rx thread terminate cleanly */
71 if (setjmp (mm->rx_thread_jmpbuf) == 0)
73 mm->rx_thread_jmpbuf_valid = 1;
75 * Find an unused slot in the per-cpu-mheaps array,
76 * and grab it for this thread. We need to be able to
77 * push/pop the thread heap without affecting other thread(s).
79 if (__os_thread_index == 0)
81 for (i = 0; i < ARRAY_LEN (clib_per_cpu_mheaps); i++)
83 if (clib_per_cpu_mheaps[i] == 0)
85 /* Copy the main thread mheap pointer */
86 clib_per_cpu_mheaps[i] = clib_per_cpu_mheaps[0];
87 __os_thread_index = i;
91 ASSERT (__os_thread_index > 0);
94 vl_msg_api_queue_handler (q);
100 vl_api_rx_thread_exit_t_handler (vl_api_rx_thread_exit_t * mp)
102 memory_client_main_t *mm = &memory_client_main;
103 vl_msg_api_free (mp);
104 longjmp (mm->rx_thread_jmpbuf, 1);
108 vl_api_name_and_crc_free (void)
110 api_main_t *am = &api_main;
115 if (!am->msg_index_by_name_and_crc)
119 hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
121 vec_add1 (keys, (u8 *) hp->key);
124 for (i = 0; i < vec_len (keys); i++)
127 hash_free (am->msg_index_by_name_and_crc);
131 vl_api_memclnt_create_reply_t_handler (vl_api_memclnt_create_reply_t * mp)
133 serialize_main_t _sm, *sm = &_sm;
134 api_main_t *am = &api_main;
141 am->my_client_index = mp->index;
142 am->my_registration = (vl_api_registration_t *) (uword) mp->handle;
144 /* Clean out any previous hash table (unlikely) */
145 vl_api_name_and_crc_free ();
147 am->msg_index_by_name_and_crc = hash_create_string (0, sizeof (uword));
149 /* Recreate the vnet-side API message handler table */
150 tblv = uword_to_pointer (mp->message_table, u8 *);
151 unserialize_open_data (sm, tblv, vec_len (tblv));
152 unserialize_integer (sm, &nmsgs, sizeof (u32));
154 for (i = 0; i < nmsgs; i++)
156 msg_index = unserialize_likely_small_unsigned_integer (sm);
157 unserialize_cstring (sm, (char **) &name_and_crc);
158 hash_set_mem (am->msg_index_by_name_and_crc, name_and_crc, msg_index);
163 noop_handler (void *notused)
168 vl_client_connect (const char *name, int ctx_quota, int input_queue_size)
171 vl_api_memclnt_create_t *mp;
172 vl_api_memclnt_create_reply_t *rp;
173 svm_queue_t *vl_input_queue;
174 vl_shmem_hdr_t *shmem_hdr;
177 api_main_t *am = &api_main;
179 if (am->my_registration)
181 clib_warning ("client %s already connected...", name);
185 if (am->vlib_rp == 0)
187 clib_warning ("am->vlib_rp NULL");
192 shmem_hdr = am->shmem_hdr;
194 if (shmem_hdr == 0 || shmem_hdr->vl_input_queue == 0)
196 clib_warning ("shmem_hdr / input queue NULL");
200 pthread_mutex_lock (&svm->mutex);
201 oldheap = svm_push_data_heap (svm);
202 vl_input_queue = svm_queue_alloc_and_init (input_queue_size, sizeof (uword),
204 svm_pop_heap (oldheap);
205 pthread_mutex_unlock (&svm->mutex);
207 am->my_client_index = ~0;
208 am->my_registration = 0;
209 am->vl_input_queue = vl_input_queue;
211 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_create_t));
212 clib_memset (mp, 0, sizeof (*mp));
213 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE);
214 mp->ctx_quota = ctx_quota;
215 mp->input_queue = (uword) vl_input_queue;
216 strncpy ((char *) mp->name, name, sizeof (mp->name) - 1);
218 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
223 struct timespec ts, tsrem;
226 /* Wait up to 10 seconds */
227 for (i = 0; i < 1000; i++)
229 qstatus = svm_queue_sub (vl_input_queue, (u8 *) & rp,
234 ts.tv_nsec = 10000 * 1000; /* 10 ms */
235 while (nanosleep (&ts, &tsrem) < 0)
239 clib_warning ("memclnt_create_reply timeout");
243 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_CREATE_REPLY)
245 clib_warning ("unexpected reply: id %d", ntohs (rp->_vl_msg_id));
248 rv = clib_net_to_host_u32 (rp->response);
250 vl_msg_api_handler ((void *) rp);
257 vl_api_memclnt_delete_reply_t_handler (vl_api_memclnt_delete_reply_t * mp)
260 api_main_t *am = &api_main;
262 pthread_mutex_lock (&am->vlib_rp->mutex);
263 oldheap = svm_push_data_heap (am->vlib_rp);
264 svm_queue_free (am->vl_input_queue);
265 pthread_mutex_unlock (&am->vlib_rp->mutex);
266 svm_pop_heap (oldheap);
268 am->my_client_index = ~0;
269 am->my_registration = 0;
270 am->vl_input_queue = 0;
274 vl_client_send_disconnect (u8 do_cleanup)
276 vl_api_memclnt_delete_t *mp;
277 vl_shmem_hdr_t *shmem_hdr;
278 api_main_t *am = &api_main;
280 ASSERT (am->vlib_rp);
281 shmem_hdr = am->shmem_hdr;
282 ASSERT (shmem_hdr && shmem_hdr->vl_input_queue);
284 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_delete_t));
285 clib_memset (mp, 0, sizeof (*mp));
286 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE);
287 mp->index = am->my_client_index;
288 mp->handle = (uword) am->my_registration;
289 mp->do_cleanup = do_cleanup;
291 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
295 vl_client_disconnect (void)
297 vl_api_memclnt_delete_reply_t *rp;
298 svm_queue_t *vl_input_queue;
299 api_main_t *am = &api_main;
302 vl_input_queue = am->vl_input_queue;
303 vl_client_send_disconnect (0 /* wait for reply */ );
306 * Have to be careful here, in case the client is disconnecting
307 * because e.g. the vlib process died, or is unresponsive.
316 if (now >= (begin + 2))
318 clib_warning ("peer unresponsive, give up");
319 am->my_client_index = ~0;
320 am->my_registration = 0;
324 if (svm_queue_sub (vl_input_queue, (u8 *) & rp, SVM_Q_NOWAIT, 0) < 0)
327 /* drain the queue */
328 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_DELETE_REPLY)
330 clib_warning ("queue drain: %d", ntohs (rp->_vl_msg_id));
331 vl_msg_api_handler ((void *) rp);
334 vl_msg_api_handler ((void *) rp);
338 vl_api_name_and_crc_free ();
343 * Stave off the binary API dead client reaper
344 * Only sent to inactive clients
347 vl_api_memclnt_keepalive_t_handler (vl_api_memclnt_keepalive_t * mp)
349 vl_api_memclnt_keepalive_reply_t *rmp;
351 vl_shmem_hdr_t *shmem_hdr;
354 shmem_hdr = am->shmem_hdr;
356 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
357 clib_memset (rmp, 0, sizeof (*rmp));
358 rmp->_vl_msg_id = ntohs (VL_API_MEMCLNT_KEEPALIVE_REPLY);
359 rmp->context = mp->context;
360 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & rmp);
363 #define foreach_api_msg \
364 _(RX_THREAD_EXIT, rx_thread_exit) \
365 _(MEMCLNT_CREATE_REPLY, memclnt_create_reply) \
366 _(MEMCLNT_DELETE_REPLY, memclnt_delete_reply) \
367 _(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);
385 vl_client_api_map (const char *region_name)
389 if ((rv = vl_map_shmem (region_name, 0 /* is_vlib */ )) < 0)
392 vl_client_install_client_message_handlers ();
397 vl_client_api_unmap (void)
399 vl_unmap_shmem_client ();
403 vl_mem_client_is_connected (void)
405 return (memory_client_main.connected_to_vlib != 0);
409 connect_to_vlib_internal (const char *svm_name,
410 const char *client_name,
411 int rx_queue_size, int want_pthread, int do_map)
414 memory_client_main_t *mm = &memory_client_main;
416 if (do_map && (rv = vl_client_api_map (svm_name)))
418 clib_warning ("vl_client_api map rv %d", rv);
422 if (vl_client_connect (client_name, 0 /* punt quota */ ,
423 rx_queue_size /* input queue */ ) < 0)
425 vl_client_api_unmap ();
429 /* Start the rx queue thread */
433 rv = pthread_create (&mm->rx_thread_handle,
434 NULL /*attr */ , rx_thread_fn, 0);
436 clib_warning ("pthread_create returned %d", rv);
439 mm->connected_to_vlib = 1;
444 vl_client_connect_to_vlib (const char *svm_name,
445 const char *client_name, int rx_queue_size)
447 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
448 1 /* want pthread */ ,
453 vl_client_connect_to_vlib_no_rx_pthread (const char *svm_name,
454 const char *client_name,
457 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
458 0 /* want pthread */ ,
463 vl_client_connect_to_vlib_no_map (const char *svm_name,
464 const char *client_name, int rx_queue_size)
466 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
467 1 /* want pthread */ ,
472 disconnect_from_vlib_internal (u8 do_unmap)
474 memory_client_main_t *mm = &memory_client_main;
475 api_main_t *am = &api_main;
478 if (mm->rx_thread_jmpbuf_valid)
480 vl_api_rx_thread_exit_t *ep;
481 ep = vl_msg_api_alloc (sizeof (*ep));
482 ep->_vl_msg_id = ntohs (VL_API_RX_THREAD_EXIT);
483 vl_msg_api_send_shmem (am->vl_input_queue, (u8 *) & ep);
484 pthread_join (mm->rx_thread_handle, (void **) &junk);
486 if (mm->connected_to_vlib)
488 vl_client_disconnect ();
490 vl_client_api_unmap ();
492 clib_memset (mm, 0, sizeof (*mm));
496 vl_client_disconnect_from_vlib (void)
498 disconnect_from_vlib_internal (1);
502 vl_client_disconnect_from_vlib_no_unmap (void)
504 disconnect_from_vlib_internal (0);
507 static void vl_api_get_first_msg_id_reply_t_handler
508 (vl_api_get_first_msg_id_reply_t * mp)
510 memory_client_main_t *mm = &memory_client_main;
511 i32 retval = ntohl (mp->retval);
513 mm->first_msg_id_reply = (retval >= 0) ? ntohs (mp->first_msg_id) : ~0;
514 mm->first_msg_id_reply_ready = 1;
518 vl_client_get_first_plugin_msg_id (const char *plugin_name)
520 vl_api_get_first_msg_id_t *mp;
521 api_main_t *am = &api_main;
522 memory_client_main_t *mm = &memory_client_main;
525 clib_time_t clib_time;
528 if (strlen (plugin_name) + 1 > sizeof (mp->name))
531 clib_memset (&clib_time, 0, sizeof (clib_time));
532 clib_time_init (&clib_time);
534 /* Push this plugin's first_msg_id_reply handler */
535 old_handler = am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY];
536 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = (void *)
537 vl_api_get_first_msg_id_reply_t_handler;
539 /* Ask the data-plane for the message-ID base of the indicated plugin */
540 mm->first_msg_id_reply_ready = 0;
542 /* Not using shm client */
543 if (!am->my_registration)
545 mp = vl_socket_client_msg_alloc (sizeof (*mp));
546 clib_memset (mp, 0, sizeof (*mp));
547 mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
548 mp->client_index = am->my_client_index;
549 strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
551 if (vl_socket_client_write () <= 0)
553 if (vl_socket_client_read (1))
556 if (mm->first_msg_id_reply_ready == 1)
558 rv = mm->first_msg_id_reply;
563 /* Restore old handler */
564 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
570 mp = vl_msg_api_alloc (sizeof (*mp));
571 clib_memset (mp, 0, sizeof (*mp));
572 mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
573 mp->client_index = am->my_client_index;
574 strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
576 vl_msg_api_send_shmem (am->shmem_hdr->vl_input_queue, (u8 *) & mp);
578 /* Synchronously wait for the answer */
579 timeout = clib_time_now (&clib_time) + 1.0;
580 while (clib_time_now (&clib_time) < timeout)
582 if (mm->first_msg_id_reply_ready == 1)
584 rv = mm->first_msg_id_reply;
588 /* Restore old handler */
589 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
596 /* Restore the old handler */
597 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
600 clib_warning ("plugin '%s' not registered", plugin_name);
606 * fd.io coding-style-patch-verification: ON
609 * eval: (c-set-style "gnu")