2 *------------------------------------------------------------------
3 * memclnt_shared.c - API message handling, common code for both clients
4 * and the vlib process itself.
7 * Copyright (c) 2009 Cisco and/or its affiliates.
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at:
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 *------------------------------------------------------------------
28 #include <vppinfra/format.h>
29 #include <vppinfra/byte_order.h>
30 #include <vppinfra/error.h>
31 #include <vlib/vlib.h>
32 #include <vlib/unix/unix.h>
33 #include <vlibmemory/api.h>
34 #include <vlibmemory/unix_shared_memory_queue.h>
36 #include <vlibmemory/vl_memory_msg_enum.h>
39 #include <vlibmemory/vl_memory_api_h.h>
43 vl_msg_api_alloc_internal (int nbytes, int pool, int may_return_null)
48 unix_shared_memory_queue_t *q;
50 vl_shmem_hdr_t *shmem_hdr;
51 api_main_t *am = &api_main;
53 shmem_hdr = am->shmem_hdr;
57 clib_warning ("shared memory header NULL");
61 /* account for the msgbuf_t header */
62 nbytes += sizeof (msgbuf_t);
64 if (shmem_hdr->vl_rings == 0)
66 clib_warning ("vl_rings NULL");
71 if (shmem_hdr->client_rings == 0)
73 clib_warning ("client_rings NULL");
78 ap = pool ? shmem_hdr->vl_rings : shmem_hdr->client_rings;
79 for (i = 0; i < vec_len (ap); i++)
82 if (nbytes > ap[i].size)
90 pthread_mutex_lock (&q->mutex);
92 rv = (msgbuf_t *) (&q->data[0] + q->head * q->elsize);
94 * Is this item still in use?
98 u32 now = (u32) time (0);
100 if (PREDICT_TRUE (rv->gc_mark_timestamp == 0))
101 rv->gc_mark_timestamp = now;
104 if (now - rv->gc_mark_timestamp > 10)
107 clib_warning ("garbage collect pool %d ring %d index %d",
109 shmem_hdr->garbage_collects++;
115 /* yes, loser; try next larger pool */
118 pthread_mutex_unlock (&q->mutex);
123 /* OK, we have a winner */
126 * Remember the source queue, although we
127 * don't need to know the queue to free the item.
130 rv->gc_mark_timestamp = 0;
132 if (q->head == q->maxsize)
136 pthread_mutex_unlock (&q->mutex);
141 * Request too big, or head element of all size-compatible rings
142 * still in use. Fall back to shared-memory malloc.
146 pthread_mutex_lock (&am->vlib_rp->mutex);
147 oldheap = svm_push_data_heap (am->vlib_rp);
150 rv = clib_mem_alloc_or_null (nbytes);
151 if (PREDICT_FALSE (rv == 0))
153 svm_pop_heap (oldheap);
154 pthread_mutex_unlock (&am->vlib_rp->mutex);
159 rv = clib_mem_alloc (nbytes);
162 svm_pop_heap (oldheap);
163 pthread_mutex_unlock (&am->vlib_rp->mutex);
166 rv->data_len = htonl (nbytes - sizeof (msgbuf_t));
171 vl_msg_api_alloc (int nbytes)
174 api_main_t *am = &api_main;
175 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
178 * Clients use pool-0, vlib proc uses pool 1
180 pool = (am->our_pid == shmem_hdr->vl_pid);
181 return vl_msg_api_alloc_internal (nbytes, pool, 0 /* may_return_null */ );
185 vl_msg_api_alloc_or_null (int nbytes)
188 api_main_t *am = &api_main;
189 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
191 pool = (am->our_pid == shmem_hdr->vl_pid);
192 return vl_msg_api_alloc_internal (nbytes, pool, 1 /* may_return_null */ );
196 vl_msg_api_alloc_as_if_client (int nbytes)
198 return vl_msg_api_alloc_internal (nbytes, 0, 0 /* may_return_null */ );
202 vl_msg_api_alloc_as_if_client_or_null (int nbytes)
204 return vl_msg_api_alloc_internal (nbytes, 0, 1 /* may_return_null */ );
208 vl_msg_api_free (void *a)
212 api_main_t *am = &api_main;
214 rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
217 * Here's the beauty of the scheme. Only one proc/thread has
218 * control of a given message buffer. To free a buffer, we just clear the
219 * queue field, and leave. No locks, no hits, no errors...
224 rv->gc_mark_timestamp = 0;
228 pthread_mutex_lock (&am->vlib_rp->mutex);
229 oldheap = svm_push_data_heap (am->vlib_rp);
231 svm_pop_heap (oldheap);
232 pthread_mutex_unlock (&am->vlib_rp->mutex);
236 vl_msg_api_free_nolock (void *a)
240 api_main_t *am = &api_main;
242 rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
244 * Here's the beauty of the scheme. Only one proc/thread has
245 * control of a given message buffer. To free a buffer, we just clear the
246 * queue field, and leave. No locks, no hits, no errors...
254 oldheap = svm_push_data_heap (am->vlib_rp);
256 svm_pop_heap (oldheap);
260 vl_set_memory_root_path (char *name)
262 api_main_t *am = &api_main;
264 am->root_path = name;
268 vl_set_memory_uid (int uid)
270 api_main_t *am = &api_main;
276 vl_set_memory_gid (int gid)
278 api_main_t *am = &api_main;
284 vl_set_global_memory_baseva (u64 baseva)
286 api_main_t *am = &api_main;
288 am->global_baseva = baseva;
292 vl_set_global_memory_size (u64 size)
294 api_main_t *am = &api_main;
296 am->global_size = size;
300 vl_set_api_memory_size (u64 size)
302 api_main_t *am = &api_main;
308 vl_set_global_pvt_heap_size (u64 size)
310 api_main_t *am = &api_main;
312 am->global_pvt_heap_size = size;
316 vl_set_api_pvt_heap_size (u64 size)
318 api_main_t *am = &api_main;
320 am->api_pvt_heap_size = size;
324 vl_map_shmem (char *region_name, int is_vlib)
326 svm_map_region_args_t _a, *a = &_a;
327 svm_region_t *vlib_rp, *root_rp;
329 vl_shmem_hdr_t *shmem_hdr = 0;
330 api_main_t *am = &api_main;
332 struct timespec ts, tsrem;
335 svm_region_init_chroot (am->root_path);
337 memset (a, 0, sizeof (*a));
339 a->name = region_name;
340 a->size = am->api_size ? am->api_size : (16 << 20);
341 a->flags = SVM_FLAGS_MHEAP;
342 a->uid = am->api_uid;
343 a->gid = am->api_gid;
344 a->pvt_heap_size = am->api_pvt_heap_size;
346 vlib_rp = svm_region_find_or_create (a);
351 pthread_mutex_lock (&vlib_rp->mutex);
352 /* Has someone else set up the shared-memory variable table? */
353 if (vlib_rp->user_ctx)
355 am->shmem_hdr = (void *) vlib_rp->user_ctx;
356 am->our_pid = getpid ();
359 unix_shared_memory_queue_t *q;
362 * application restart. Reset cached pids, API message
363 * rings, list of clients; otherwise, various things
364 * fail. (e.g. queue non-empty notification)
367 /* ghosts keep the region from disappearing properly */
368 svm_client_scan_this_region_nolock (vlib_rp);
369 am->shmem_hdr->application_restarts++;
370 q = am->shmem_hdr->vl_input_queue;
371 am->shmem_hdr->vl_pid = getpid ();
372 q->consumer_pid = am->shmem_hdr->vl_pid;
373 /* Drain the input queue, freeing msgs */
374 for (i = 0; i < 10; i++)
376 if (pthread_mutex_trylock (&q->mutex) == 0)
378 pthread_mutex_unlock (&q->mutex);
382 ts.tv_nsec = 10000 * 1000; /* 10 ms */
383 while (nanosleep (&ts, &tsrem) < 0)
386 /* Mutex buggered, "fix" it */
387 memset (&q->mutex, 0, sizeof (q->mutex));
388 clib_warning ("forcibly release main input queue mutex");
391 am->vlib_rp = vlib_rp;
392 while (unix_shared_memory_queue_sub (q,
395 != -2 /* queue underflow */ )
397 vl_msg_api_free_nolock ((void *) old_msg);
398 am->shmem_hdr->restart_reclaims++;
400 pthread_mutex_unlock (&vlib_rp->mutex);
401 root_rp = svm_get_root_rp ();
403 /* Clean up the root region client list */
404 pthread_mutex_lock (&root_rp->mutex);
405 svm_client_scan_this_region_nolock (root_rp);
406 pthread_mutex_unlock (&root_rp->mutex);
410 pthread_mutex_unlock (&vlib_rp->mutex);
412 am->vlib_rp = vlib_rp;
413 vec_add1 (am->mapped_shmem_regions, vlib_rp);
416 /* Clients simply have to wait... */
419 pthread_mutex_unlock (&vlib_rp->mutex);
421 /* Wait up to 100 seconds... */
422 for (i = 0; i < 10000; i++)
425 ts.tv_nsec = 10000 * 1000; /* 10 ms */
426 while (nanosleep (&ts, &tsrem) < 0)
428 if (vlib_rp->user_ctx)
431 /* Clean up and leave... */
432 svm_region_unmap (vlib_rp);
433 clib_warning ("region init fail");
437 am->shmem_hdr = (void *) vlib_rp->user_ctx;
438 am->our_pid = getpid ();
439 am->vlib_rp = vlib_rp;
440 vec_add1 (am->mapped_shmem_regions, vlib_rp);
444 /* Nope, it's our problem... */
446 oldheap = svm_push_data_heap (vlib_rp);
448 vec_validate (shmem_hdr, 0);
449 shmem_hdr->version = VL_SHM_VERSION;
451 /* vlib main input queue */
452 shmem_hdr->vl_input_queue =
453 unix_shared_memory_queue_init (1024, sizeof (uword), getpid (),
456 /* Set up the msg ring allocator */
460 _rp.rp = unix_shared_memory_queue_init ((n), (sz), 0, 0); \
465 vec_add1(shmem_hdr->vl_rings, _rp); \
468 foreach_vl_aring_size;
474 _rp.rp = unix_shared_memory_queue_init ((n), (sz), 0, 0); \
479 vec_add1(shmem_hdr->client_rings, _rp); \
482 foreach_clnt_aring_size;
485 am->shmem_hdr = shmem_hdr;
486 am->vlib_rp = vlib_rp;
487 am->our_pid = getpid ();
489 am->shmem_hdr->vl_pid = am->our_pid;
491 svm_pop_heap (oldheap);
494 * After absolutely everything that a client might see is set up,
495 * declare the shmem region valid
497 vlib_rp->user_ctx = shmem_hdr;
499 pthread_mutex_unlock (&vlib_rp->mutex);
500 vec_add1 (am->mapped_shmem_regions, vlib_rp);
505 vl_register_mapped_shmem_region (svm_region_t * rp)
507 api_main_t *am = &api_main;
509 vec_add1 (am->mapped_shmem_regions, rp);
513 vl_unmap_shmem (void)
517 api_main_t *am = &api_main;
519 if (!svm_get_root_rp ())
522 for (i = 0; i < vec_len (am->mapped_shmem_regions); i++)
524 rp = am->mapped_shmem_regions[i];
525 svm_region_unmap (rp);
528 vec_free (am->mapped_shmem_regions);
532 /* $$$ more careful cleanup, valgrind run... */
533 vec_free (am->msg_handlers);
534 vec_free (am->msg_endian_handlers);
535 vec_free (am->msg_print_handlers);
539 vl_msg_api_send_shmem (unix_shared_memory_queue_t * q, u8 * elem)
541 api_main_t *am = &api_main;
542 uword *trace = (uword *) elem;
544 if (am->tx_trace && am->tx_trace->enabled)
545 vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
547 (void) unix_shared_memory_queue_add (q, elem, 0 /* nowait */ );
551 vl_msg_api_send_shmem_nolock (unix_shared_memory_queue_t * q, u8 * elem)
553 api_main_t *am = &api_main;
554 uword *trace = (uword *) elem;
556 if (am->tx_trace && am->tx_trace->enabled)
557 vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
559 (void) unix_shared_memory_queue_add_nolock (q, elem);
563 vl_api_memclnt_create_reply_t_handler (vl_api_memclnt_create_reply_t * mp)
565 serialize_main_t _sm, *sm = &_sm;
566 api_main_t *am = &api_main;
573 am->my_client_index = mp->index;
574 am->my_registration = (vl_api_registration_t *) (uword) mp->handle;
576 /* Clean out any previous hash table (unlikely) */
577 if (am->msg_index_by_name_and_crc)
583 hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
585 vec_add1 (keys, (u8 *) hp->key);
588 for (i = 0; i < vec_len (keys); i++)
593 am->msg_index_by_name_and_crc = hash_create_string (0, sizeof (uword));
595 /* Recreate the vnet-side API message handler table */
596 tblv = (u8 *) mp->message_table;
597 serialize_open_vector (sm, tblv);
598 unserialize_integer (sm, &nmsgs, sizeof (u32));
600 for (i = 0; i < nmsgs; i++)
602 msg_index = unserialize_likely_small_unsigned_integer (sm);
603 unserialize_cstring (sm, (char **) &name_and_crc);
604 hash_set_mem (am->msg_index_by_name_and_crc, name_and_crc, msg_index);
609 vl_api_get_msg_index (u8 * name_and_crc)
611 api_main_t *am = &api_main;
614 if (am->msg_index_by_name_and_crc)
616 p = hash_get_mem (am->msg_index_by_name_and_crc, name_and_crc);
624 vl_client_connect (char *name, int ctx_quota, int input_queue_size)
627 vl_api_memclnt_create_t *mp;
628 vl_api_memclnt_create_reply_t *rp;
629 unix_shared_memory_queue_t *vl_input_queue;
630 vl_shmem_hdr_t *shmem_hdr;
633 api_main_t *am = &api_main;
635 if (am->my_registration)
637 clib_warning ("client %s already connected...", name);
641 if (am->vlib_rp == 0)
643 clib_warning ("am->vlib_rp NULL");
648 shmem_hdr = am->shmem_hdr;
650 if (shmem_hdr == 0 || shmem_hdr->vl_input_queue == 0)
652 clib_warning ("shmem_hdr / input queue NULL");
656 pthread_mutex_lock (&svm->mutex);
657 oldheap = svm_push_data_heap (svm);
659 unix_shared_memory_queue_init (input_queue_size, sizeof (uword),
661 pthread_mutex_unlock (&svm->mutex);
662 svm_pop_heap (oldheap);
664 am->my_client_index = ~0;
665 am->my_registration = 0;
666 am->vl_input_queue = vl_input_queue;
668 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_create_t));
669 memset (mp, 0, sizeof (*mp));
670 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE);
671 mp->ctx_quota = ctx_quota;
672 mp->input_queue = (uword) vl_input_queue;
673 strncpy ((char *) mp->name, name, sizeof (mp->name) - 1);
675 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
680 struct timespec ts, tsrem;
683 /* Wait up to 10 seconds */
684 for (i = 0; i < 1000; i++)
686 qstatus = unix_shared_memory_queue_sub (vl_input_queue, (u8 *) & rp,
691 ts.tv_nsec = 10000 * 1000; /* 10 ms */
692 while (nanosleep (&ts, &tsrem) < 0)
696 clib_warning ("memclnt_create_reply timeout");
700 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_CREATE_REPLY)
702 clib_warning ("unexpected reply: id %d", ntohs (rp->_vl_msg_id));
705 rv = clib_net_to_host_u32 (rp->response);
707 vl_msg_api_handler ((void *) rp);
714 vl_api_memclnt_delete_reply_t_handler (vl_api_memclnt_delete_reply_t * mp)
717 api_main_t *am = &api_main;
719 pthread_mutex_lock (&am->vlib_rp->mutex);
720 oldheap = svm_push_data_heap (am->vlib_rp);
721 unix_shared_memory_queue_free (am->vl_input_queue);
722 pthread_mutex_unlock (&am->vlib_rp->mutex);
723 svm_pop_heap (oldheap);
725 am->my_client_index = ~0;
726 am->my_registration = 0;
727 am->vl_input_queue = 0;
731 vl_client_disconnect (void)
733 vl_api_memclnt_delete_t *mp;
734 vl_api_memclnt_delete_reply_t *rp;
735 unix_shared_memory_queue_t *vl_input_queue;
736 vl_shmem_hdr_t *shmem_hdr;
738 api_main_t *am = &api_main;
740 ASSERT (am->vlib_rp);
741 shmem_hdr = am->shmem_hdr;
742 ASSERT (shmem_hdr && shmem_hdr->vl_input_queue);
744 vl_input_queue = am->vl_input_queue;
746 mp = vl_msg_api_alloc (sizeof (vl_api_memclnt_delete_t));
747 memset (mp, 0, sizeof (*mp));
748 mp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE);
749 mp->index = am->my_client_index;
750 mp->handle = (uword) am->my_registration;
752 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
755 * Have to be careful here, in case the client is disconnecting
756 * because e.g. the vlib process died, or is unresponsive.
766 if (now >= (begin + 2))
768 clib_warning ("peer unresponsive, give up");
769 am->my_client_index = ~0;
770 am->my_registration = 0;
774 if (unix_shared_memory_queue_sub (vl_input_queue, (u8 *) & rp, 1) < 0)
777 /* drain the queue */
778 if (ntohs (rp->_vl_msg_id) != VL_API_MEMCLNT_DELETE_REPLY)
780 vl_msg_api_handler ((void *) rp);
783 vl_msg_api_handler ((void *) rp);
788 static inline vl_api_registration_t *
789 vl_api_client_index_to_registration_internal (u32 handle)
791 vl_api_registration_t **regpp;
792 vl_api_registration_t *regp;
793 api_main_t *am = &api_main;
796 index = vl_msg_api_handle_get_index (handle);
797 if ((am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK)
798 != vl_msg_api_handle_get_epoch (handle))
800 vl_msg_api_increment_missing_client_counter ();
804 regpp = am->vl_clients + index;
806 if (pool_is_free (am->vl_clients, regpp))
808 vl_msg_api_increment_missing_client_counter ();
815 vl_api_registration_t *
816 vl_api_client_index_to_registration (u32 index)
818 return (vl_api_client_index_to_registration_internal (index));
821 unix_shared_memory_queue_t *
822 vl_api_client_index_to_input_queue (u32 index)
824 vl_api_registration_t *regp;
825 api_main_t *am = &api_main;
827 /* Special case: vlib trying to send itself a message */
828 if (index == (u32) ~ 0)
829 return (am->shmem_hdr->vl_input_queue);
831 regp = vl_api_client_index_to_registration_internal (index);
834 return (regp->vl_input_queue);
837 #define foreach_api_client_msg \
838 _(MEMCLNT_CREATE_REPLY, memclnt_create_reply) \
839 _(MEMCLNT_DELETE_REPLY, memclnt_delete_reply)
842 vl_client_api_map (char *region_name)
846 if ((rv = vl_map_shmem (region_name, 0 /* is_vlib */ )) < 0)
852 vl_msg_api_set_handlers(VL_API_##N, 0 /* name */, \
853 vl_api_##n##_t_handler, \
854 0/* cleanup */, 0/* endian */, 0/* print */, \
855 sizeof(vl_api_##n##_t), 1);
856 foreach_api_client_msg;
862 vl_client_api_unmap (void)
868 * fd.io coding-style-patch-verification: ON
871 * eval: (c-set-style "gnu")