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_or_null (int nbytes)
215 api_main_t *am = &api_main;
216 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
218 pool = (am->our_pid == shmem_hdr->vl_pid);
219 return vl_msg_api_alloc_internal (nbytes, pool, 1 /* may_return_null */ );
223 vl_msg_api_alloc_as_if_client (int nbytes)
225 return vl_msg_api_alloc_internal (nbytes, 0, 0 /* may_return_null */ );
229 vl_msg_api_alloc_as_if_client_or_null (int nbytes)
231 return vl_msg_api_alloc_internal (nbytes, 0, 1 /* may_return_null */ );
235 vl_mem_api_alloc_as_if_client_w_reg (vl_api_registration_t * reg, int nbytes)
237 api_main_t *am = &api_main;
238 vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
239 svm_region_t *vlib_rp, *save_vlib_rp = am->vlib_rp;
242 vlib_rp = am->vlib_rp = reg->vlib_rp;
243 am->shmem_hdr = (void *) vlib_rp->user_ctx;
245 msg = vl_msg_api_alloc_internal (nbytes, 0, 0 /* may_return_null */ );
247 am->shmem_hdr = save_shmem_hdr;
248 am->vlib_rp = save_vlib_rp;
254 vl_msg_api_free (void *a)
258 api_main_t *am = &api_main;
260 rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
263 * Here's the beauty of the scheme. Only one proc/thread has
264 * control of a given message buffer. To free a buffer, we just clear the
265 * queue field, and leave. No locks, no hits, no errors...
270 rv->gc_mark_timestamp = 0;
271 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
274 overrun = (u32 *) (rv->data + ntohl (rv->data_len));
275 ASSERT (*overrun == 0x1badbabe);
281 pthread_mutex_lock (&am->vlib_rp->mutex);
282 oldheap = svm_push_data_heap (am->vlib_rp);
284 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
287 overrun = (u32 *) (rv->data + ntohl (rv->data_len));
288 ASSERT (*overrun == 0x1badbabe);
293 svm_pop_heap (oldheap);
294 pthread_mutex_unlock (&am->vlib_rp->mutex);
298 vl_msg_api_free_nolock (void *a)
302 api_main_t *am = &api_main;
304 rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
306 * Here's the beauty of the scheme. Only one proc/thread has
307 * control of a given message buffer. To free a buffer, we just clear the
308 * queue field, and leave. No locks, no hits, no errors...
316 oldheap = svm_push_data_heap (am->vlib_rp);
318 svm_pop_heap (oldheap);
322 vl_set_memory_root_path (const char *name)
324 api_main_t *am = &api_main;
326 am->root_path = name;
330 vl_set_memory_uid (int uid)
332 api_main_t *am = &api_main;
338 vl_set_memory_gid (int gid)
340 api_main_t *am = &api_main;
346 vl_set_global_memory_baseva (u64 baseva)
348 api_main_t *am = &api_main;
350 am->global_baseva = baseva;
354 vl_set_global_memory_size (u64 size)
356 api_main_t *am = &api_main;
358 am->global_size = size;
362 vl_set_api_memory_size (u64 size)
364 api_main_t *am = &api_main;
370 vl_set_global_pvt_heap_size (u64 size)
372 api_main_t *am = &api_main;
374 am->global_pvt_heap_size = size;
378 vl_set_api_pvt_heap_size (u64 size)
380 api_main_t *am = &api_main;
382 am->api_pvt_heap_size = size;
386 vl_api_default_mem_config (vl_shmem_hdr_t * shmem_hdr)
388 api_main_t *am = &api_main;
389 u32 vlib_input_queue_length;
391 /* vlib main input queue */
392 vlib_input_queue_length = 1024;
393 if (am->vlib_input_queue_length)
394 vlib_input_queue_length = am->vlib_input_queue_length;
396 shmem_hdr->vl_input_queue =
397 svm_queue_alloc_and_init (vlib_input_queue_length, sizeof (uword),
403 _rp.rp = svm_queue_alloc_and_init ((n), (sz), 0); \
408 vec_add1(shmem_hdr->vl_rings, _rp); \
411 foreach_vl_aring_size;
417 _rp.rp = svm_queue_alloc_and_init ((n), (sz), 0); \
422 vec_add1(shmem_hdr->client_rings, _rp); \
425 foreach_clnt_aring_size;
430 vl_api_mem_config (vl_shmem_hdr_t * hdr, vl_api_shm_elem_config_t * config)
432 vl_api_shm_elem_config_t *c;
438 vl_api_default_mem_config (hdr);
442 vec_foreach (c, config)
447 hdr->vl_input_queue = svm_queue_alloc_and_init (c->count, c->size,
450 case VL_API_VLIB_RING:
451 vec_add2 (hdr->vl_rings, rp, 1);
453 case VL_API_CLIENT_RING:
454 vec_add2 (hdr->client_rings, rp, 1);
457 clib_warning ("unknown config type: %d", c->type);
461 size = sizeof (ring_alloc_t) + c->size;
462 rp->rp = svm_queue_alloc_and_init (c->count, size, 0);
464 rp->nitems = c->count;
471 vl_init_shmem (svm_region_t * vlib_rp, vl_api_shm_elem_config_t * config,
472 int is_vlib, int is_private_region)
474 api_main_t *am = &api_main;
475 vl_shmem_hdr_t *shmem_hdr = 0;
479 /* $$$$ need private region config parameters */
481 oldheap = svm_push_data_heap (vlib_rp);
483 vec_validate (shmem_hdr, 0);
484 shmem_hdr->version = VL_SHM_VERSION;
485 shmem_hdr->clib_file_index = VL_API_INVALID_FI;
487 /* Set up the queue and msg ring allocator */
488 vl_api_mem_config (shmem_hdr, config);
490 if (is_private_region == 0)
492 am->shmem_hdr = shmem_hdr;
493 am->vlib_rp = vlib_rp;
494 am->our_pid = getpid ();
496 am->shmem_hdr->vl_pid = am->our_pid;
499 shmem_hdr->vl_pid = am->our_pid;
501 svm_pop_heap (oldheap);
504 * After absolutely everything that a client might see is set up,
505 * declare the shmem region valid
507 vlib_rp->user_ctx = shmem_hdr;
509 pthread_mutex_unlock (&vlib_rp->mutex);
513 vl_map_shmem (const char *region_name, int is_vlib)
515 svm_map_region_args_t _a, *a = &_a;
516 svm_region_t *vlib_rp, *root_rp;
517 api_main_t *am = &api_main;
519 struct timespec ts, tsrem;
520 char *vpe_api_region_suffix = "-vpe-api";
522 clib_memset (a, 0, sizeof (*a));
524 if (strstr (region_name, vpe_api_region_suffix))
526 u8 *root_path = format (0, "%s", region_name);
527 _vec_len (root_path) = (vec_len (root_path) -
528 strlen (vpe_api_region_suffix));
529 vec_terminate_c_string (root_path);
530 a->root_path = (const char *) root_path;
531 am->root_path = (const char *) root_path;
539 * Clients wait for vpp to set up the root / API regioins
542 api_name = format (0, "/dev/shm/%s-%s%c", am->root_path,
545 api_name = format (0, "/dev/shm%s%c", region_name, 0);
547 /* Wait up to 100 seconds... */
548 for (i = 0; i < 10000; i++)
551 ts.tv_nsec = 10000 * 1000; /* 10 ms */
552 while (nanosleep (&ts, &tsrem) < 0)
554 tfd = open ((char *) api_name, O_RDWR);
561 clib_warning ("region init fail");
565 svm_region_init_chroot_uid_gid (am->root_path, getuid (), getgid ());
568 if (a->root_path != NULL)
570 a->name = "/vpe-api";
573 a->name = region_name;
574 a->size = am->api_size ? am->api_size : (16 << 20);
575 a->flags = SVM_FLAGS_MHEAP;
576 a->uid = am->api_uid;
577 a->gid = am->api_gid;
578 a->pvt_heap_size = am->api_pvt_heap_size;
580 vlib_rp = svm_region_find_or_create (a);
585 pthread_mutex_lock (&vlib_rp->mutex);
586 /* Has someone else set up the shared-memory variable table? */
587 if (vlib_rp->user_ctx)
589 am->shmem_hdr = (void *) vlib_rp->user_ctx;
590 am->our_pid = getpid ();
596 * application restart. Reset cached pids, API message
597 * rings, list of clients; otherwise, various things
598 * fail. (e.g. queue non-empty notification)
601 /* ghosts keep the region from disappearing properly */
602 svm_client_scan_this_region_nolock (vlib_rp);
603 am->shmem_hdr->application_restarts++;
604 q = am->shmem_hdr->vl_input_queue;
605 am->shmem_hdr->vl_pid = getpid ();
606 q->consumer_pid = am->shmem_hdr->vl_pid;
607 /* Drain the input queue, freeing msgs */
608 for (i = 0; i < 10; i++)
610 if (pthread_mutex_trylock (&q->mutex) == 0)
612 pthread_mutex_unlock (&q->mutex);
616 ts.tv_nsec = 10000 * 1000; /* 10 ms */
617 while (nanosleep (&ts, &tsrem) < 0)
620 /* Mutex buggered, "fix" it */
621 clib_memset (&q->mutex, 0, sizeof (q->mutex));
622 clib_warning ("forcibly release main input queue mutex");
625 am->vlib_rp = vlib_rp;
626 while (svm_queue_sub (q, (u8 *) & old_msg, SVM_Q_NOWAIT, 0)
627 != -2 /* queue underflow */ )
629 vl_msg_api_free_nolock ((void *) old_msg);
630 am->shmem_hdr->restart_reclaims++;
632 pthread_mutex_unlock (&vlib_rp->mutex);
633 root_rp = svm_get_root_rp ();
635 /* Clean up the root region client list */
636 pthread_mutex_lock (&root_rp->mutex);
637 svm_client_scan_this_region_nolock (root_rp);
638 pthread_mutex_unlock (&root_rp->mutex);
642 pthread_mutex_unlock (&vlib_rp->mutex);
644 am->vlib_rp = vlib_rp;
645 vec_add1 (am->mapped_shmem_regions, vlib_rp);
648 /* Clients simply have to wait... */
651 pthread_mutex_unlock (&vlib_rp->mutex);
653 /* Wait up to 100 seconds... */
654 for (i = 0; i < 10000; i++)
657 ts.tv_nsec = 10000 * 1000; /* 10 ms */
658 while (nanosleep (&ts, &tsrem) < 0)
660 if (vlib_rp->user_ctx)
663 /* Clean up and leave... */
664 svm_region_unmap (vlib_rp);
665 clib_warning ("region init fail");
669 am->shmem_hdr = (void *) vlib_rp->user_ctx;
670 am->our_pid = getpid ();
671 am->vlib_rp = vlib_rp;
672 vec_add1 (am->mapped_shmem_regions, vlib_rp);
676 /* Nope, it's our problem... */
677 vl_init_shmem (vlib_rp, 0 /* default config */ , 1 /* is vlib */ ,
678 0 /* is_private_region */ );
680 vec_add1 (am->mapped_shmem_regions, vlib_rp);
685 vl_register_mapped_shmem_region (svm_region_t * rp)
687 api_main_t *am = &api_main;
689 vec_add1 (am->mapped_shmem_regions, rp);
693 vl_unmap_shmem_internal (u8 is_client)
697 api_main_t *am = &api_main;
699 if (!svm_get_root_rp ())
702 for (i = 0; i < vec_len (am->mapped_shmem_regions); i++)
704 rp = am->mapped_shmem_regions[i];
705 is_client ? svm_region_unmap_client (rp) : svm_region_unmap (rp);
708 vec_free (am->mapped_shmem_regions);
711 is_client ? svm_region_exit_client () : svm_region_exit ();
713 /* $$$ more careful cleanup, valgrind run... */
714 vec_free (am->msg_handlers);
715 vec_free (am->msg_endian_handlers);
716 vec_free (am->msg_print_handlers);
720 vl_unmap_shmem (void)
722 vl_unmap_shmem_internal (0);
726 vl_unmap_shmem_client (void)
728 vl_unmap_shmem_internal (1);
732 vl_msg_api_send_shmem (svm_queue_t * q, u8 * elem)
734 api_main_t *am = &api_main;
735 uword *trace = (uword *) elem;
737 if (am->tx_trace && am->tx_trace->enabled)
738 vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
741 * Announce a probable binary API client bug:
742 * some client's input queue is stuffed.
743 * The situation may be recoverable, or not.
746 (am->vl_clients /* vpp side */ && (q->cursize == q->maxsize)))
747 clib_warning ("WARNING: client input queue at %llx is stuffed...", q);
748 (void) svm_queue_add (q, elem, 0 /* nowait */ );
752 vl_mem_api_can_send (svm_queue_t * q)
754 return (q->cursize < q->maxsize);
758 vl_msg_api_send_shmem_nolock (svm_queue_t * q, u8 * elem)
760 api_main_t *am = &api_main;
761 uword *trace = (uword *) elem;
763 if (am->tx_trace && am->tx_trace->enabled)
764 vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
766 (void) svm_queue_add_nolock (q, elem);
770 * fd.io coding-style-patch-verification: ON
773 * eval: (c-set-style "gnu")