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 *------------------------------------------------------------------
29 #include <vppinfra/format.h>
30 #include <vppinfra/byte_order.h>
31 #include <vppinfra/error.h>
32 #include <svm/queue.h>
33 #include <vlib/vlib.h>
34 #include <vlib/unix/unix.h>
35 #include <vlibmemory/memory_api.h>
36 #include <vlibmemory/vl_memory_msg_enum.h>
39 #include <vlibmemory/vl_memory_api_h.h>
42 #define DEBUG_MESSAGE_BUFFER_OVERRUN 0
45 vl_msg_api_alloc_internal (int nbytes, int pool, int may_return_null)
52 vl_shmem_hdr_t *shmem_hdr;
53 api_main_t *am = &api_main;
55 shmem_hdr = am->shmem_hdr;
57 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
61 ASSERT (pool == 0 || vlib_get_thread_index () == 0);
65 clib_warning ("shared memory header NULL");
69 /* account for the msgbuf_t header */
70 nbytes += sizeof (msgbuf_t);
72 if (shmem_hdr->vl_rings == 0)
74 clib_warning ("vl_rings NULL");
79 if (shmem_hdr->client_rings == 0)
81 clib_warning ("client_rings NULL");
86 ap = pool ? shmem_hdr->vl_rings : shmem_hdr->client_rings;
87 for (i = 0; i < vec_len (ap); i++)
90 if (nbytes > ap[i].size)
98 pthread_mutex_lock (&q->mutex);
100 rv = (msgbuf_t *) (&q->data[0] + q->head * q->elsize);
102 * Is this item still in use?
106 u32 now = (u32) time (0);
108 if (PREDICT_TRUE (rv->gc_mark_timestamp == 0))
109 rv->gc_mark_timestamp = now;
112 if (now - rv->gc_mark_timestamp > 10)
116 u16 *msg_idp, msg_id;
118 ("garbage collect pool %d ring %d index %d", pool, i,
120 msg_idp = (u16 *) (rv->data);
121 msg_id = clib_net_to_host_u16 (*msg_idp);
122 if (msg_id < vec_len (api_main.msg_names))
123 clib_warning ("msg id %d name %s", (u32) msg_id,
124 api_main.msg_names[msg_id]);
126 shmem_hdr->garbage_collects++;
132 /* yes, loser; try next larger pool */
135 pthread_mutex_unlock (&q->mutex);
140 /* OK, we have a winner */
143 * Remember the source queue, although we
144 * don't need to know the queue to free the item.
147 rv->gc_mark_timestamp = 0;
149 if (q->head == q->maxsize)
153 pthread_mutex_unlock (&q->mutex);
158 * Request too big, or head element of all size-compatible rings
159 * still in use. Fall back to shared-memory malloc.
163 pthread_mutex_lock (&am->vlib_rp->mutex);
164 oldheap = svm_push_data_heap (am->vlib_rp);
167 rv = clib_mem_alloc_or_null (nbytes);
168 if (PREDICT_FALSE (rv == 0))
170 svm_pop_heap (oldheap);
171 pthread_mutex_unlock (&am->vlib_rp->mutex);
176 rv = clib_mem_alloc (nbytes);
179 rv->gc_mark_timestamp = 0;
180 svm_pop_heap (oldheap);
181 pthread_mutex_unlock (&am->vlib_rp->mutex);
184 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
188 overrun = (u32 *) (rv->data + nbytes - sizeof (msgbuf_t));
189 *overrun = 0x1badbabe;
192 rv->data_len = htonl (nbytes - sizeof (msgbuf_t));
198 vl_msg_api_alloc (int nbytes)
201 api_main_t *am = &api_main;
202 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
205 * Clients use pool-0, vlib proc uses pool 1
207 pool = (am->our_pid == shmem_hdr->vl_pid);
208 return vl_msg_api_alloc_internal (nbytes, pool, 0 /* may_return_null */ );
212 vl_msg_api_alloc_zero (int nbytes)
216 ret = vl_msg_api_alloc (nbytes);
217 clib_memset (ret, 0, nbytes);
222 vl_msg_api_alloc_or_null (int nbytes)
225 api_main_t *am = &api_main;
226 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
228 pool = (am->our_pid == shmem_hdr->vl_pid);
229 return vl_msg_api_alloc_internal (nbytes, pool, 1 /* may_return_null */ );
233 vl_msg_api_alloc_as_if_client (int nbytes)
235 return vl_msg_api_alloc_internal (nbytes, 0, 0 /* may_return_null */ );
239 vl_msg_api_alloc_zero_as_if_client (int nbytes)
243 ret = vl_msg_api_alloc_as_if_client (nbytes);
244 clib_memset (ret, 0, nbytes);
249 vl_msg_api_alloc_as_if_client_or_null (int nbytes)
251 return vl_msg_api_alloc_internal (nbytes, 0, 1 /* may_return_null */ );
255 vl_mem_api_alloc_as_if_client_w_reg (vl_api_registration_t * reg, int nbytes)
257 api_main_t *am = &api_main;
258 vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
259 svm_region_t *vlib_rp, *save_vlib_rp = am->vlib_rp;
262 vlib_rp = am->vlib_rp = reg->vlib_rp;
263 am->shmem_hdr = (void *) vlib_rp->user_ctx;
265 msg = vl_msg_api_alloc_internal (nbytes, 0, 0 /* may_return_null */ );
267 am->shmem_hdr = save_shmem_hdr;
268 am->vlib_rp = save_vlib_rp;
274 vl_msg_api_free (void *a)
278 api_main_t *am = &api_main;
280 rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
283 * Here's the beauty of the scheme. Only one proc/thread has
284 * control of a given message buffer. To free a buffer, we just clear the
285 * queue field, and leave. No locks, no hits, no errors...
290 rv->gc_mark_timestamp = 0;
291 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
294 overrun = (u32 *) (rv->data + ntohl (rv->data_len));
295 ASSERT (*overrun == 0x1badbabe);
301 pthread_mutex_lock (&am->vlib_rp->mutex);
302 oldheap = svm_push_data_heap (am->vlib_rp);
304 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
307 overrun = (u32 *) (rv->data + ntohl (rv->data_len));
308 ASSERT (*overrun == 0x1badbabe);
313 svm_pop_heap (oldheap);
314 pthread_mutex_unlock (&am->vlib_rp->mutex);
318 vl_msg_api_free_nolock (void *a)
322 api_main_t *am = &api_main;
324 rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
326 * Here's the beauty of the scheme. Only one proc/thread has
327 * control of a given message buffer. To free a buffer, we just clear the
328 * queue field, and leave. No locks, no hits, no errors...
336 oldheap = svm_push_data_heap (am->vlib_rp);
338 svm_pop_heap (oldheap);
342 vl_set_memory_root_path (const char *name)
344 api_main_t *am = &api_main;
346 am->root_path = name;
350 vl_set_memory_uid (int uid)
352 api_main_t *am = &api_main;
358 vl_set_memory_gid (int gid)
360 api_main_t *am = &api_main;
366 vl_set_global_memory_baseva (u64 baseva)
368 api_main_t *am = &api_main;
370 am->global_baseva = baseva;
374 vl_set_global_memory_size (u64 size)
376 api_main_t *am = &api_main;
378 am->global_size = size;
382 vl_set_api_memory_size (u64 size)
384 api_main_t *am = &api_main;
390 vl_set_global_pvt_heap_size (u64 size)
392 api_main_t *am = &api_main;
394 am->global_pvt_heap_size = size;
398 vl_set_api_pvt_heap_size (u64 size)
400 api_main_t *am = &api_main;
402 am->api_pvt_heap_size = size;
406 vl_api_default_mem_config (vl_shmem_hdr_t * shmem_hdr)
408 api_main_t *am = &api_main;
409 u32 vlib_input_queue_length;
411 /* vlib main input queue */
412 vlib_input_queue_length = 1024;
413 if (am->vlib_input_queue_length)
414 vlib_input_queue_length = am->vlib_input_queue_length;
416 shmem_hdr->vl_input_queue =
417 svm_queue_alloc_and_init (vlib_input_queue_length, sizeof (uword),
423 _rp.rp = svm_queue_alloc_and_init ((n), (sz), 0); \
428 vec_add1(shmem_hdr->vl_rings, _rp); \
431 foreach_vl_aring_size;
437 _rp.rp = svm_queue_alloc_and_init ((n), (sz), 0); \
442 vec_add1(shmem_hdr->client_rings, _rp); \
445 foreach_clnt_aring_size;
450 vl_api_mem_config (vl_shmem_hdr_t * hdr, vl_api_shm_elem_config_t * config)
452 vl_api_shm_elem_config_t *c;
458 vl_api_default_mem_config (hdr);
462 vec_foreach (c, config)
467 hdr->vl_input_queue = svm_queue_alloc_and_init (c->count, c->size,
470 case VL_API_VLIB_RING:
471 vec_add2 (hdr->vl_rings, rp, 1);
473 case VL_API_CLIENT_RING:
474 vec_add2 (hdr->client_rings, rp, 1);
477 clib_warning ("unknown config type: %d", c->type);
481 size = sizeof (ring_alloc_t) + c->size;
482 rp->rp = svm_queue_alloc_and_init (c->count, size, 0);
484 rp->nitems = c->count;
491 vl_init_shmem (svm_region_t * vlib_rp, vl_api_shm_elem_config_t * config,
492 int is_vlib, int is_private_region)
494 api_main_t *am = &api_main;
495 vl_shmem_hdr_t *shmem_hdr = 0;
499 /* $$$$ need private region config parameters */
501 oldheap = svm_push_data_heap (vlib_rp);
503 vec_validate (shmem_hdr, 0);
504 shmem_hdr->version = VL_SHM_VERSION;
505 shmem_hdr->clib_file_index = VL_API_INVALID_FI;
507 /* Set up the queue and msg ring allocator */
508 vl_api_mem_config (shmem_hdr, config);
510 if (is_private_region == 0)
512 am->shmem_hdr = shmem_hdr;
513 am->vlib_rp = vlib_rp;
514 am->our_pid = getpid ();
516 am->shmem_hdr->vl_pid = am->our_pid;
519 shmem_hdr->vl_pid = am->our_pid;
521 svm_pop_heap (oldheap);
524 * After absolutely everything that a client might see is set up,
525 * declare the shmem region valid
527 vlib_rp->user_ctx = shmem_hdr;
529 pthread_mutex_unlock (&vlib_rp->mutex);
533 vl_map_shmem (const char *region_name, int is_vlib)
535 svm_map_region_args_t _a, *a = &_a;
536 svm_region_t *vlib_rp, *root_rp;
537 api_main_t *am = &api_main;
539 struct timespec ts, tsrem;
540 char *vpe_api_region_suffix = "-vpe-api";
542 clib_memset (a, 0, sizeof (*a));
544 if (strstr (region_name, vpe_api_region_suffix))
546 u8 *root_path = format (0, "%s", region_name);
547 _vec_len (root_path) = (vec_len (root_path) -
548 strlen (vpe_api_region_suffix));
549 vec_terminate_c_string (root_path);
550 a->root_path = (const char *) root_path;
551 am->root_path = (const char *) root_path;
559 * Clients wait for vpp to set up the root / API regioins
562 api_name = format (0, "/dev/shm/%s-%s%c", am->root_path,
565 api_name = format (0, "/dev/shm%s%c", region_name, 0);
567 /* Wait up to 100 seconds... */
568 for (i = 0; i < 10000; i++)
571 ts.tv_nsec = 10000 * 1000; /* 10 ms */
572 while (nanosleep (&ts, &tsrem) < 0)
574 tfd = open ((char *) api_name, O_RDWR);
581 clib_warning ("region init fail");
585 svm_region_init_chroot_uid_gid (am->root_path, getuid (), getgid ());
588 if (a->root_path != NULL)
590 a->name = "/vpe-api";
593 a->name = region_name;
594 a->size = am->api_size ? am->api_size : (16 << 20);
595 a->flags = SVM_FLAGS_MHEAP;
596 a->uid = am->api_uid;
597 a->gid = am->api_gid;
598 a->pvt_heap_size = am->api_pvt_heap_size;
600 vlib_rp = svm_region_find_or_create (a);
605 pthread_mutex_lock (&vlib_rp->mutex);
606 /* Has someone else set up the shared-memory variable table? */
607 if (vlib_rp->user_ctx)
609 am->shmem_hdr = (void *) vlib_rp->user_ctx;
610 am->our_pid = getpid ();
616 * application restart. Reset cached pids, API message
617 * rings, list of clients; otherwise, various things
618 * fail. (e.g. queue non-empty notification)
621 /* ghosts keep the region from disappearing properly */
622 svm_client_scan_this_region_nolock (vlib_rp);
623 am->shmem_hdr->application_restarts++;
624 q = am->shmem_hdr->vl_input_queue;
625 am->shmem_hdr->vl_pid = getpid ();
626 q->consumer_pid = am->shmem_hdr->vl_pid;
627 /* Drain the input queue, freeing msgs */
628 for (i = 0; i < 10; i++)
630 if (pthread_mutex_trylock (&q->mutex) == 0)
632 pthread_mutex_unlock (&q->mutex);
636 ts.tv_nsec = 10000 * 1000; /* 10 ms */
637 while (nanosleep (&ts, &tsrem) < 0)
640 /* Mutex buggered, "fix" it */
641 clib_memset (&q->mutex, 0, sizeof (q->mutex));
642 clib_warning ("forcibly release main input queue mutex");
645 am->vlib_rp = vlib_rp;
646 while (svm_queue_sub (q, (u8 *) & old_msg, SVM_Q_NOWAIT, 0)
647 != -2 /* queue underflow */ )
649 vl_msg_api_free_nolock ((void *) old_msg);
650 am->shmem_hdr->restart_reclaims++;
652 pthread_mutex_unlock (&vlib_rp->mutex);
653 root_rp = svm_get_root_rp ();
655 /* Clean up the root region client list */
656 pthread_mutex_lock (&root_rp->mutex);
657 svm_client_scan_this_region_nolock (root_rp);
658 pthread_mutex_unlock (&root_rp->mutex);
662 pthread_mutex_unlock (&vlib_rp->mutex);
664 am->vlib_rp = vlib_rp;
665 vec_add1 (am->mapped_shmem_regions, vlib_rp);
668 /* Clients simply have to wait... */
671 pthread_mutex_unlock (&vlib_rp->mutex);
673 /* Wait up to 100 seconds... */
674 for (i = 0; i < 10000; i++)
677 ts.tv_nsec = 10000 * 1000; /* 10 ms */
678 while (nanosleep (&ts, &tsrem) < 0)
680 if (vlib_rp->user_ctx)
683 /* Clean up and leave... */
684 svm_region_unmap (vlib_rp);
685 clib_warning ("region init fail");
689 am->shmem_hdr = (void *) vlib_rp->user_ctx;
690 am->our_pid = getpid ();
691 am->vlib_rp = vlib_rp;
692 vec_add1 (am->mapped_shmem_regions, vlib_rp);
696 /* Nope, it's our problem... */
697 vl_init_shmem (vlib_rp, 0 /* default config */ , 1 /* is vlib */ ,
698 0 /* is_private_region */ );
700 vec_add1 (am->mapped_shmem_regions, vlib_rp);
705 vl_register_mapped_shmem_region (svm_region_t * rp)
707 api_main_t *am = &api_main;
709 vec_add1 (am->mapped_shmem_regions, rp);
713 vl_unmap_shmem_internal (u8 is_client)
717 api_main_t *am = &api_main;
719 if (!svm_get_root_rp ())
722 for (i = 0; i < vec_len (am->mapped_shmem_regions); i++)
724 rp = am->mapped_shmem_regions[i];
725 is_client ? svm_region_unmap_client (rp) : svm_region_unmap (rp);
728 vec_free (am->mapped_shmem_regions);
731 is_client ? svm_region_exit_client () : svm_region_exit ();
733 /* $$$ more careful cleanup, valgrind run... */
734 vec_free (am->msg_handlers);
735 vec_free (am->msg_endian_handlers);
736 vec_free (am->msg_print_handlers);
740 vl_unmap_shmem (void)
742 vl_unmap_shmem_internal (0);
746 vl_unmap_shmem_client (void)
748 vl_unmap_shmem_internal (1);
752 vl_msg_api_send_shmem (svm_queue_t * q, u8 * elem)
754 api_main_t *am = &api_main;
755 uword *trace = (uword *) elem;
757 if (am->tx_trace && am->tx_trace->enabled)
758 vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
761 * Announce a probable binary API client bug:
762 * some client's input queue is stuffed.
763 * The situation may be recoverable, or not.
766 (am->vl_clients /* vpp side */ && (q->cursize == q->maxsize)))
767 clib_warning ("WARNING: client input queue at %llx is stuffed...", q);
768 (void) svm_queue_add (q, elem, 0 /* nowait */ );
772 vl_mem_api_can_send (svm_queue_t * q)
774 return (q->cursize < q->maxsize);
778 vl_msg_api_send_shmem_nolock (svm_queue_t * q, u8 * elem)
780 api_main_t *am = &api_main;
781 uword *trace = (uword *) elem;
783 if (am->tx_trace && am->tx_trace->enabled)
784 vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
786 (void) svm_queue_add_nolock (q, elem);
790 * fd.io coding-style-patch-verification: ON
793 * eval: (c-set-style "gnu")