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);
100 CLIB_NOSANITIZE_ADDR static void
101 VL_API_VEC_UNPOISON (const void *v)
103 const vec_header_t *vh = &((vec_header_t *) v)[-1];
104 CLIB_MEM_UNPOISON (vh, sizeof (*vh) + vec_len (v));
108 vl_api_memclnt_create_reply_t_handler (vl_api_memclnt_create_reply_t * mp)
110 serialize_main_t _sm, *sm = &_sm;
111 api_main_t *am = &api_main;
118 am->my_client_index = mp->index;
119 am->my_registration = (vl_api_registration_t *) (uword) mp->handle;
121 /* Clean out any previous hash table (unlikely) */
122 vl_api_name_and_crc_free ();
124 am->msg_index_by_name_and_crc = hash_create_string (0, sizeof (uword));
126 /* Recreate the vnet-side API message handler table */
127 tblv = uword_to_pointer (mp->message_table, u8 *);
128 unserialize_open_data (sm, tblv, vec_len (tblv));
129 unserialize_integer (sm, &nmsgs, sizeof (u32));
131 VL_API_VEC_UNPOISON (tblv);
133 for (i = 0; i < nmsgs; i++)
135 msg_index = unserialize_likely_small_unsigned_integer (sm);
136 unserialize_cstring (sm, (char **) &name_and_crc);
137 hash_set_mem (am->msg_index_by_name_and_crc, name_and_crc, msg_index);
142 noop_handler (void *notused)
146 void vl_msg_api_send_shmem (svm_queue_t * q, u8 * elem);
148 vl_client_connect (const char *name, int ctx_quota, int input_queue_size)
151 vl_api_memclnt_create_t *mp;
152 vl_api_memclnt_create_reply_t *rp;
153 svm_queue_t *vl_input_queue;
154 vl_shmem_hdr_t *shmem_hdr;
157 api_main_t *am = &api_main;
159 if (am->my_registration)
161 clib_warning ("client %s already connected...", name);
165 if (am->vlib_rp == 0)
167 clib_warning ("am->vlib_rp NULL");
172 shmem_hdr = am->shmem_hdr;
174 if (shmem_hdr == 0 || shmem_hdr->vl_input_queue == 0)
176 clib_warning ("shmem_hdr / input queue NULL");
180 CLIB_MEM_UNPOISON (shmem_hdr, sizeof (*shmem_hdr));
181 VL_MSG_API_SVM_QUEUE_UNPOISON (shmem_hdr->vl_input_queue);
183 pthread_mutex_lock (&svm->mutex);
184 oldheap = svm_push_data_heap (svm);
185 vl_input_queue = svm_queue_alloc_and_init (input_queue_size, sizeof (uword),
187 svm_pop_heap (oldheap);
188 pthread_mutex_unlock (&svm->mutex);
190 am->my_client_index = ~0;
191 am->my_registration = 0;
192 am->vl_input_queue = vl_input_queue;
194 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_create_t));
195 clib_memset (mp, 0, sizeof (*mp));
196 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE);
197 mp->ctx_quota = ctx_quota;
198 mp->input_queue = (uword) vl_input_queue;
199 strncpy ((char *) mp->name, name, sizeof (mp->name) - 1);
201 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
206 struct timespec ts, tsrem;
209 /* Wait up to 10 seconds */
210 for (i = 0; i < 1000; i++)
212 qstatus = svm_queue_sub (vl_input_queue, (u8 *) & rp,
217 ts.tv_nsec = 10000 * 1000; /* 10 ms */
218 while (nanosleep (&ts, &tsrem) < 0)
222 clib_warning ("memclnt_create_reply timeout");
226 VL_MSG_API_UNPOISON (rp);
227 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_CREATE_REPLY)
229 clib_warning ("unexpected reply: id %d", ntohs (rp->_vl_msg_id));
232 rv = clib_net_to_host_u32 (rp->response);
234 vl_msg_api_handler ((void *) rp);
241 vl_api_memclnt_delete_reply_t_handler (vl_api_memclnt_delete_reply_t * mp)
244 api_main_t *am = &api_main;
246 pthread_mutex_lock (&am->vlib_rp->mutex);
247 oldheap = svm_push_data_heap (am->vlib_rp);
248 svm_queue_free (am->vl_input_queue);
249 pthread_mutex_unlock (&am->vlib_rp->mutex);
250 svm_pop_heap (oldheap);
252 am->my_client_index = ~0;
253 am->my_registration = 0;
254 am->vl_input_queue = 0;
258 vl_client_send_disconnect (u8 do_cleanup)
260 vl_api_memclnt_delete_t *mp;
261 vl_shmem_hdr_t *shmem_hdr;
262 api_main_t *am = &api_main;
264 ASSERT (am->vlib_rp);
265 shmem_hdr = am->shmem_hdr;
266 ASSERT (shmem_hdr && shmem_hdr->vl_input_queue);
268 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_delete_t));
269 clib_memset (mp, 0, sizeof (*mp));
270 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE);
271 mp->index = am->my_client_index;
272 mp->handle = (uword) am->my_registration;
273 mp->do_cleanup = do_cleanup;
275 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
279 vl_client_disconnect (void)
281 vl_api_memclnt_delete_reply_t *rp;
282 svm_queue_t *vl_input_queue;
283 api_main_t *am = &api_main;
286 vl_input_queue = am->vl_input_queue;
287 vl_client_send_disconnect (0 /* wait for reply */ );
290 * Have to be careful here, in case the client is disconnecting
291 * because e.g. the vlib process died, or is unresponsive.
300 if (now >= (begin + 2))
302 clib_warning ("peer unresponsive, give up");
303 am->my_client_index = ~0;
304 am->my_registration = 0;
308 if (svm_queue_sub (vl_input_queue, (u8 *) & rp, SVM_Q_NOWAIT, 0) < 0)
311 VL_MSG_API_UNPOISON (rp);
313 /* drain the queue */
314 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_DELETE_REPLY)
316 clib_warning ("queue drain: %d", ntohs (rp->_vl_msg_id));
317 vl_msg_api_handler ((void *) rp);
320 vl_msg_api_handler ((void *) rp);
324 vl_api_name_and_crc_free ();
329 * Stave off the binary API dead client reaper
330 * Only sent to inactive clients
333 vl_api_memclnt_keepalive_t_handler (vl_api_memclnt_keepalive_t * mp)
335 vl_api_memclnt_keepalive_reply_t *rmp;
337 vl_shmem_hdr_t *shmem_hdr;
340 shmem_hdr = am->shmem_hdr;
342 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
343 clib_memset (rmp, 0, sizeof (*rmp));
344 rmp->_vl_msg_id = ntohs (VL_API_MEMCLNT_KEEPALIVE_REPLY);
345 rmp->context = mp->context;
346 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & rmp);
349 #define foreach_api_msg \
350 _(RX_THREAD_EXIT, rx_thread_exit) \
351 _(MEMCLNT_CREATE_REPLY, memclnt_create_reply) \
352 _(MEMCLNT_DELETE_REPLY, memclnt_delete_reply) \
353 _(MEMCLNT_KEEPALIVE, memclnt_keepalive)
356 vl_client_install_client_message_handlers (void)
360 vl_msg_api_set_handlers(VL_API_##N, #n, \
361 vl_api_##n##_t_handler, \
363 vl_api_##n##_t_endian, \
364 vl_api_##n##_t_print, \
365 sizeof(vl_api_##n##_t), 1);
371 vl_client_api_map (const char *region_name)
375 if ((rv = vl_map_shmem (region_name, 0 /* is_vlib */ )) < 0)
378 vl_client_install_client_message_handlers ();
383 vl_client_api_unmap (void)
385 vl_unmap_shmem_client ();
389 vl_mem_client_is_connected (void)
391 return (memory_client_main.connected_to_vlib != 0);
395 connect_to_vlib_internal (const char *svm_name,
396 const char *client_name,
397 int rx_queue_size, void *(*thread_fn) (void *),
401 memory_client_main_t *mm = &memory_client_main;
402 api_main_t *am = &api_main;
404 if (do_map && (rv = vl_client_api_map (svm_name)))
406 clib_warning ("vl_client_api map rv %d", rv);
410 if (vl_client_connect (client_name, 0 /* punt quota */ ,
411 rx_queue_size /* input queue */ ) < 0)
413 vl_client_api_unmap ();
417 /* Start the rx queue thread */
421 rv = pthread_create (&mm->rx_thread_handle,
422 NULL /*attr */ , thread_fn, 0);
425 clib_warning ("pthread_create returned %d", rv);
426 am->rx_thread_handle = 0;
430 am->rx_thread_handle = mm->rx_thread_handle;
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 rx_thread_fn, 1 /* do map */ );
447 vl_client_connect_to_vlib_no_rx_pthread (const char *svm_name,
448 const char *client_name,
451 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
452 0 /* no rx_thread_fn */ ,
457 vl_client_connect_to_vlib_no_map (const char *svm_name,
458 const char *client_name, int rx_queue_size)
460 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
461 rx_thread_fn, 0 /* dont map */ );
465 vl_client_connect_to_vlib_no_rx_pthread_no_map (const char *svm_name,
466 const char *client_name,
469 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
470 0 /* want pthread */ ,
475 vl_client_connect_to_vlib_thread_fn (const char *svm_name,
476 const char *client_name,
478 void *(*thread_fn) (void *))
480 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
481 thread_fn, 1 /* do map */ );
486 disconnect_from_vlib_internal (u8 do_unmap)
488 memory_client_main_t *mm = &memory_client_main;
489 api_main_t *am = &api_main;
492 if (mm->rx_thread_jmpbuf_valid)
494 vl_api_rx_thread_exit_t *ep;
495 ep = vl_msg_api_alloc (sizeof (*ep));
496 ep->_vl_msg_id = ntohs (VL_API_RX_THREAD_EXIT);
497 vl_msg_api_send_shmem (am->vl_input_queue, (u8 *) & ep);
498 pthread_join (mm->rx_thread_handle, (void **) &junk);
500 if (mm->connected_to_vlib)
502 vl_client_disconnect ();
504 vl_client_api_unmap ();
506 clib_memset (mm, 0, sizeof (*mm));
510 vl_client_disconnect_from_vlib (void)
512 disconnect_from_vlib_internal (1);
516 vl_client_disconnect_from_vlib_no_unmap (void)
518 disconnect_from_vlib_internal (0);
521 static void vl_api_get_first_msg_id_reply_t_handler
522 (vl_api_get_first_msg_id_reply_t * mp)
524 memory_client_main_t *mm = &memory_client_main;
525 i32 retval = ntohl (mp->retval);
527 mm->first_msg_id_reply = (retval >= 0) ? ntohs (mp->first_msg_id) : ~0;
528 mm->first_msg_id_reply_ready = 1;
532 vl_client_get_first_plugin_msg_id (const char *plugin_name)
534 vl_api_get_first_msg_id_t *mp;
535 api_main_t *am = &api_main;
536 memory_client_main_t *mm = &memory_client_main;
539 clib_time_t clib_time;
542 if (strlen (plugin_name) + 1 > sizeof (mp->name))
545 clib_memset (&clib_time, 0, sizeof (clib_time));
546 clib_time_init (&clib_time);
548 /* Push this plugin's first_msg_id_reply handler */
549 old_handler = am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY];
550 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = (void *)
551 vl_api_get_first_msg_id_reply_t_handler;
553 /* Ask the data-plane for the message-ID base of the indicated plugin */
554 mm->first_msg_id_reply_ready = 0;
556 /* Not using shm client */
557 if (!am->my_registration)
559 mp = vl_socket_client_msg_alloc (sizeof (*mp));
560 clib_memset (mp, 0, sizeof (*mp));
561 mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
562 mp->client_index = am->my_client_index;
563 strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
565 if (vl_socket_client_write () <= 0)
567 if (vl_socket_client_read (1))
570 if (mm->first_msg_id_reply_ready == 1)
572 rv = mm->first_msg_id_reply;
577 /* Restore old handler */
578 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
584 mp = vl_msg_api_alloc (sizeof (*mp));
585 clib_memset (mp, 0, sizeof (*mp));
586 mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
587 mp->client_index = am->my_client_index;
588 strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
590 vl_msg_api_send_shmem (am->shmem_hdr->vl_input_queue, (u8 *) & mp);
592 /* Synchronously wait for the answer */
593 timeout = clib_time_now (&clib_time) + 1.0;
594 while (clib_time_now (&clib_time) < timeout)
596 if (mm->first_msg_id_reply_ready == 1)
598 rv = mm->first_msg_id_reply;
602 /* Restore old handler */
603 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
610 /* Restore the old handler */
611 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
614 clib_warning ("plugin '%s' not registered", plugin_name);
620 * fd.io coding-style-patch-verification: ON
623 * eval: (c-set-style "gnu")