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;
67 q = am->vl_input_queue;
69 /* So we can make the rx thread terminate cleanly */
70 if (setjmp (mm->rx_thread_jmpbuf) == 0)
72 mm->rx_thread_jmpbuf_valid = 1;
73 clib_mem_set_thread_index ();
75 vl_msg_api_queue_handler (q);
81 vl_api_rx_thread_exit_t_handler (vl_api_rx_thread_exit_t * mp)
83 memory_client_main_t *mm = &memory_client_main;
84 if (mm->rx_thread_jmpbuf_valid)
85 longjmp (mm->rx_thread_jmpbuf, 1);
89 vl_api_name_and_crc_free (void)
91 api_main_t *am = &api_main;
96 if (!am->msg_index_by_name_and_crc)
100 hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
102 vec_add1 (keys, (u8 *) hp->key);
105 for (i = 0; i < vec_len (keys); i++)
108 hash_free (am->msg_index_by_name_and_crc);
112 vl_api_memclnt_create_reply_t_handler (vl_api_memclnt_create_reply_t * mp)
114 serialize_main_t _sm, *sm = &_sm;
115 api_main_t *am = &api_main;
122 am->my_client_index = mp->index;
123 am->my_registration = (vl_api_registration_t *) (uword) mp->handle;
125 /* Clean out any previous hash table (unlikely) */
126 vl_api_name_and_crc_free ();
128 am->msg_index_by_name_and_crc = hash_create_string (0, sizeof (uword));
130 /* Recreate the vnet-side API message handler table */
131 tblv = uword_to_pointer (mp->message_table, u8 *);
132 unserialize_open_data (sm, tblv, vec_len (tblv));
133 unserialize_integer (sm, &nmsgs, sizeof (u32));
135 for (i = 0; i < nmsgs; i++)
137 msg_index = unserialize_likely_small_unsigned_integer (sm);
138 unserialize_cstring (sm, (char **) &name_and_crc);
139 hash_set_mem (am->msg_index_by_name_and_crc, name_and_crc, msg_index);
144 noop_handler (void *notused)
148 void vl_msg_api_send_shmem (svm_queue_t * q, u8 * elem);
150 vl_client_connect (const char *name, int ctx_quota, int input_queue_size)
153 vl_api_memclnt_create_t *mp;
154 vl_api_memclnt_create_reply_t *rp;
155 svm_queue_t *vl_input_queue;
156 vl_shmem_hdr_t *shmem_hdr;
159 api_main_t *am = &api_main;
161 if (am->my_registration)
163 clib_warning ("client %s already connected...", name);
167 if (am->vlib_rp == 0)
169 clib_warning ("am->vlib_rp NULL");
174 shmem_hdr = am->shmem_hdr;
176 if (shmem_hdr == 0 || shmem_hdr->vl_input_queue == 0)
178 clib_warning ("shmem_hdr / input queue NULL");
182 pthread_mutex_lock (&svm->mutex);
183 oldheap = svm_push_data_heap (svm);
184 vl_input_queue = svm_queue_alloc_and_init (input_queue_size, sizeof (uword),
186 svm_pop_heap (oldheap);
187 pthread_mutex_unlock (&svm->mutex);
189 am->my_client_index = ~0;
190 am->my_registration = 0;
191 am->vl_input_queue = vl_input_queue;
193 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_create_t));
194 clib_memset (mp, 0, sizeof (*mp));
195 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE);
196 mp->ctx_quota = ctx_quota;
197 mp->input_queue = (uword) vl_input_queue;
198 strncpy ((char *) mp->name, name, sizeof (mp->name) - 1);
200 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
205 struct timespec ts, tsrem;
208 /* Wait up to 10 seconds */
209 for (i = 0; i < 1000; i++)
211 qstatus = svm_queue_sub (vl_input_queue, (u8 *) & rp,
216 ts.tv_nsec = 10000 * 1000; /* 10 ms */
217 while (nanosleep (&ts, &tsrem) < 0)
221 clib_warning ("memclnt_create_reply timeout");
225 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_CREATE_REPLY)
227 clib_warning ("unexpected reply: id %d", ntohs (rp->_vl_msg_id));
230 rv = clib_net_to_host_u32 (rp->response);
232 vl_msg_api_handler ((void *) rp);
239 vl_api_memclnt_delete_reply_t_handler (vl_api_memclnt_delete_reply_t * mp)
242 api_main_t *am = &api_main;
244 pthread_mutex_lock (&am->vlib_rp->mutex);
245 oldheap = svm_push_data_heap (am->vlib_rp);
246 svm_queue_free (am->vl_input_queue);
247 pthread_mutex_unlock (&am->vlib_rp->mutex);
248 svm_pop_heap (oldheap);
250 am->my_client_index = ~0;
251 am->my_registration = 0;
252 am->vl_input_queue = 0;
256 vl_client_send_disconnect (u8 do_cleanup)
258 vl_api_memclnt_delete_t *mp;
259 vl_shmem_hdr_t *shmem_hdr;
260 api_main_t *am = &api_main;
262 ASSERT (am->vlib_rp);
263 shmem_hdr = am->shmem_hdr;
264 ASSERT (shmem_hdr && shmem_hdr->vl_input_queue);
266 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_delete_t));
267 clib_memset (mp, 0, sizeof (*mp));
268 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE);
269 mp->index = am->my_client_index;
270 mp->handle = (uword) am->my_registration;
271 mp->do_cleanup = do_cleanup;
273 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
277 vl_client_disconnect (void)
279 vl_api_memclnt_delete_reply_t *rp;
280 svm_queue_t *vl_input_queue;
281 api_main_t *am = &api_main;
284 vl_input_queue = am->vl_input_queue;
285 vl_client_send_disconnect (0 /* wait for reply */ );
288 * Have to be careful here, in case the client is disconnecting
289 * because e.g. the vlib process died, or is unresponsive.
298 if (now >= (begin + 2))
300 clib_warning ("peer unresponsive, give up");
301 am->my_client_index = ~0;
302 am->my_registration = 0;
306 if (svm_queue_sub (vl_input_queue, (u8 *) & rp, SVM_Q_NOWAIT, 0) < 0)
309 /* drain the queue */
310 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_DELETE_REPLY)
312 clib_warning ("queue drain: %d", ntohs (rp->_vl_msg_id));
313 vl_msg_api_handler ((void *) rp);
316 vl_msg_api_handler ((void *) rp);
320 vl_api_name_and_crc_free ();
325 * Stave off the binary API dead client reaper
326 * Only sent to inactive clients
329 vl_api_memclnt_keepalive_t_handler (vl_api_memclnt_keepalive_t * mp)
331 vl_api_memclnt_keepalive_reply_t *rmp;
333 vl_shmem_hdr_t *shmem_hdr;
336 shmem_hdr = am->shmem_hdr;
338 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
339 clib_memset (rmp, 0, sizeof (*rmp));
340 rmp->_vl_msg_id = ntohs (VL_API_MEMCLNT_KEEPALIVE_REPLY);
341 rmp->context = mp->context;
342 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & rmp);
345 #define foreach_api_msg \
346 _(RX_THREAD_EXIT, rx_thread_exit) \
347 _(MEMCLNT_CREATE_REPLY, memclnt_create_reply) \
348 _(MEMCLNT_DELETE_REPLY, memclnt_delete_reply) \
349 _(MEMCLNT_KEEPALIVE, memclnt_keepalive)
352 vl_client_install_client_message_handlers (void)
356 vl_msg_api_set_handlers(VL_API_##N, #n, \
357 vl_api_##n##_t_handler, \
359 vl_api_##n##_t_endian, \
360 vl_api_##n##_t_print, \
361 sizeof(vl_api_##n##_t), 1);
367 vl_client_api_map (const char *region_name)
371 if ((rv = vl_map_shmem (region_name, 0 /* is_vlib */ )) < 0)
374 vl_client_install_client_message_handlers ();
379 vl_client_api_unmap (void)
381 vl_unmap_shmem_client ();
385 vl_mem_client_is_connected (void)
387 return (memory_client_main.connected_to_vlib != 0);
391 connect_to_vlib_internal (const char *svm_name,
392 const char *client_name,
393 int rx_queue_size, int want_pthread, int do_map)
396 memory_client_main_t *mm = &memory_client_main;
398 if (do_map && (rv = vl_client_api_map (svm_name)))
400 clib_warning ("vl_client_api map rv %d", rv);
404 if (vl_client_connect (client_name, 0 /* punt quota */ ,
405 rx_queue_size /* input queue */ ) < 0)
407 vl_client_api_unmap ();
411 /* Start the rx queue thread */
415 rv = pthread_create (&mm->rx_thread_handle,
416 NULL /*attr */ , rx_thread_fn, 0);
418 clib_warning ("pthread_create returned %d", rv);
421 mm->connected_to_vlib = 1;
426 vl_client_connect_to_vlib (const char *svm_name,
427 const char *client_name, int rx_queue_size)
429 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
430 1 /* want pthread */ ,
435 vl_client_connect_to_vlib_no_rx_pthread (const char *svm_name,
436 const char *client_name,
439 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
440 0 /* want pthread */ ,
445 vl_client_connect_to_vlib_no_map (const char *svm_name,
446 const char *client_name, int rx_queue_size)
448 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
449 1 /* want pthread */ ,
454 vl_client_connect_to_vlib_no_rx_pthread_no_map (const char *svm_name,
455 const char *client_name,
458 return connect_to_vlib_internal (svm_name, client_name, rx_queue_size,
459 0 /* want pthread */ ,
464 disconnect_from_vlib_internal (u8 do_unmap)
466 memory_client_main_t *mm = &memory_client_main;
467 api_main_t *am = &api_main;
470 if (mm->rx_thread_jmpbuf_valid)
472 vl_api_rx_thread_exit_t *ep;
473 ep = vl_msg_api_alloc (sizeof (*ep));
474 ep->_vl_msg_id = ntohs (VL_API_RX_THREAD_EXIT);
475 vl_msg_api_send_shmem (am->vl_input_queue, (u8 *) & ep);
476 pthread_join (mm->rx_thread_handle, (void **) &junk);
478 if (mm->connected_to_vlib)
480 vl_client_disconnect ();
482 vl_client_api_unmap ();
484 clib_memset (mm, 0, sizeof (*mm));
488 vl_client_disconnect_from_vlib (void)
490 disconnect_from_vlib_internal (1);
494 vl_client_disconnect_from_vlib_no_unmap (void)
496 disconnect_from_vlib_internal (0);
499 static void vl_api_get_first_msg_id_reply_t_handler
500 (vl_api_get_first_msg_id_reply_t * mp)
502 memory_client_main_t *mm = &memory_client_main;
503 i32 retval = ntohl (mp->retval);
505 mm->first_msg_id_reply = (retval >= 0) ? ntohs (mp->first_msg_id) : ~0;
506 mm->first_msg_id_reply_ready = 1;
510 vl_client_get_first_plugin_msg_id (const char *plugin_name)
512 vl_api_get_first_msg_id_t *mp;
513 api_main_t *am = &api_main;
514 memory_client_main_t *mm = &memory_client_main;
517 clib_time_t clib_time;
520 if (strlen (plugin_name) + 1 > sizeof (mp->name))
523 clib_memset (&clib_time, 0, sizeof (clib_time));
524 clib_time_init (&clib_time);
526 /* Push this plugin's first_msg_id_reply handler */
527 old_handler = am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY];
528 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = (void *)
529 vl_api_get_first_msg_id_reply_t_handler;
531 /* Ask the data-plane for the message-ID base of the indicated plugin */
532 mm->first_msg_id_reply_ready = 0;
534 /* Not using shm client */
535 if (!am->my_registration)
537 mp = vl_socket_client_msg_alloc (sizeof (*mp));
538 clib_memset (mp, 0, sizeof (*mp));
539 mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
540 mp->client_index = am->my_client_index;
541 strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
543 if (vl_socket_client_write () <= 0)
545 if (vl_socket_client_read (1))
548 if (mm->first_msg_id_reply_ready == 1)
550 rv = mm->first_msg_id_reply;
555 /* Restore old handler */
556 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
562 mp = vl_msg_api_alloc (sizeof (*mp));
563 clib_memset (mp, 0, sizeof (*mp));
564 mp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID);
565 mp->client_index = am->my_client_index;
566 strncpy ((char *) mp->name, plugin_name, sizeof (mp->name) - 1);
568 vl_msg_api_send_shmem (am->shmem_hdr->vl_input_queue, (u8 *) & mp);
570 /* Synchronously wait for the answer */
571 timeout = clib_time_now (&clib_time) + 1.0;
572 while (clib_time_now (&clib_time) < timeout)
574 if (mm->first_msg_id_reply_ready == 1)
576 rv = mm->first_msg_id_reply;
580 /* Restore old handler */
581 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
588 /* Restore the old handler */
589 am->msg_handlers[VL_API_GET_FIRST_MSG_ID_REPLY] = old_handler;
592 clib_warning ("plugin '%s' not registered", plugin_name);
598 * fd.io coding-style-patch-verification: ON
601 * eval: (c-set-style "gnu")