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 <vppinfra/elog.h>
33 #include <svm/queue.h>
34 #include <vlib/vlib.h>
35 #include <vlib/unix/unix.h>
36 #include <vlibmemory/memory_api.h>
37 #include <vlibmemory/vl_memory_msg_enum.h>
40 #include <vlibmemory/vl_memory_api_h.h>
43 #define DEBUG_MESSAGE_BUFFER_OVERRUN 0
45 CLIB_NOSANITIZE_ADDR static inline void *
46 vl_msg_api_alloc_internal (svm_region_t * vlib_rp, int nbytes, int pool,
54 vl_shmem_hdr_t *shmem_hdr;
55 api_main_t *am = &api_main;
57 shmem_hdr = (void *) vlib_rp->user_ctx;
59 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
63 ASSERT (pool == 0 || vlib_get_thread_index () == 0);
67 clib_warning ("shared memory header NULL");
71 /* account for the msgbuf_t header */
72 nbytes += sizeof (msgbuf_t);
74 if (shmem_hdr->vl_rings == 0)
76 clib_warning ("vl_rings NULL");
81 if (shmem_hdr->client_rings == 0)
83 clib_warning ("client_rings NULL");
88 ap = pool ? shmem_hdr->vl_rings : shmem_hdr->client_rings;
89 for (i = 0; i < vec_len (ap); i++)
92 if (nbytes > ap[i].size)
100 pthread_mutex_lock (&q->mutex);
102 rv = (msgbuf_t *) (&q->data[0] + q->head * q->elsize);
104 * Is this item still in use?
108 u32 now = (u32) time (0);
110 if (PREDICT_TRUE (rv->gc_mark_timestamp == 0))
111 rv->gc_mark_timestamp = now;
114 if (now - rv->gc_mark_timestamp > 10)
118 u16 *msg_idp, msg_id;
120 ("garbage collect pool %d ring %d index %d", pool, i,
122 msg_idp = (u16 *) (rv->data);
123 msg_id = clib_net_to_host_u16 (*msg_idp);
124 if (msg_id < vec_len (api_main.msg_names))
125 clib_warning ("msg id %d name %s", (u32) msg_id,
126 api_main.msg_names[msg_id]);
128 shmem_hdr->garbage_collects++;
134 /* yes, loser; try next larger pool */
137 pthread_mutex_unlock (&q->mutex);
142 /* OK, we have a winner */
145 * Remember the source queue, although we
146 * don't need to know the queue to free the item.
149 rv->gc_mark_timestamp = 0;
151 if (q->head == q->maxsize)
155 pthread_mutex_unlock (&q->mutex);
160 * Request too big, or head element of all size-compatible rings
161 * still in use. Fall back to shared-memory malloc.
165 pthread_mutex_lock (&vlib_rp->mutex);
166 oldheap = svm_push_data_heap (vlib_rp);
169 rv = clib_mem_alloc_or_null (nbytes);
170 if (PREDICT_FALSE (rv == 0))
172 svm_pop_heap (oldheap);
173 pthread_mutex_unlock (&vlib_rp->mutex);
178 rv = clib_mem_alloc (nbytes);
181 rv->gc_mark_timestamp = 0;
182 svm_pop_heap (oldheap);
183 pthread_mutex_unlock (&vlib_rp->mutex);
186 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
190 overrun = (u32 *) (rv->data + nbytes - sizeof (msgbuf_t));
191 *overrun = 0x1badbabe;
194 rv->data_len = htonl (nbytes - sizeof (msgbuf_t));
196 VL_MSG_API_UNPOISON (rv->data);
201 vl_msg_api_alloc (int nbytes)
204 api_main_t *am = &api_main;
205 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
208 * Clients use pool-0, vlib proc uses pool 1
210 pool = (am->our_pid == shmem_hdr->vl_pid);
211 return vl_msg_api_alloc_internal (am->vlib_rp, nbytes, pool,
212 0 /* may_return_null */ );
216 vl_msg_api_alloc_zero (int nbytes)
220 ret = vl_msg_api_alloc (nbytes);
221 clib_memset (ret, 0, nbytes);
226 vl_msg_api_alloc_or_null (int nbytes)
229 api_main_t *am = &api_main;
230 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
232 pool = (am->our_pid == shmem_hdr->vl_pid);
233 return vl_msg_api_alloc_internal (am->vlib_rp, nbytes, pool,
234 1 /* may_return_null */ );
238 vl_msg_api_alloc_as_if_client (int nbytes)
240 return vl_msg_api_alloc_internal (api_main.vlib_rp, nbytes, 0,
241 0 /* may_return_null */ );
245 vl_msg_api_alloc_zero_as_if_client (int nbytes)
249 ret = vl_msg_api_alloc_as_if_client (nbytes);
250 clib_memset (ret, 0, nbytes);
255 vl_msg_api_alloc_as_if_client_or_null (int nbytes)
257 return vl_msg_api_alloc_internal (api_main.vlib_rp, nbytes, 0,
258 1 /* may_return_null */ );
262 vl_mem_api_alloc_as_if_client_w_reg (vl_api_registration_t * reg, int nbytes)
264 return vl_msg_api_alloc_internal (reg->vlib_rp, nbytes, 0,
265 0 /* may_return_null */ );
269 vl_msg_api_free_w_region (svm_region_t * vlib_rp, void *a)
274 rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
277 * Here's the beauty of the scheme. Only one proc/thread has
278 * control of a given message buffer. To free a buffer, we just clear the
279 * queue field, and leave. No locks, no hits, no errors...
284 rv->gc_mark_timestamp = 0;
285 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
288 overrun = (u32 *) (rv->data + ntohl (rv->data_len));
289 ASSERT (*overrun == 0x1badbabe);
292 VL_MSG_API_POISON (rv->data);
296 pthread_mutex_lock (&vlib_rp->mutex);
297 oldheap = svm_push_data_heap (vlib_rp);
299 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
302 overrun = (u32 *) (rv->data + ntohl (rv->data_len));
303 ASSERT (*overrun == 0x1badbabe);
308 svm_pop_heap (oldheap);
309 pthread_mutex_unlock (&vlib_rp->mutex);
313 vl_msg_api_free (void *a)
315 vl_msg_api_free_w_region (api_main.vlib_rp, a);
319 vl_msg_api_free_nolock (void *a)
323 api_main_t *am = &api_main;
325 rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
327 * Here's the beauty of the scheme. Only one proc/thread has
328 * control of a given message buffer. To free a buffer, we just clear the
329 * queue field, and leave. No locks, no hits, no errors...
334 VL_MSG_API_POISON (rv->data);
338 oldheap = svm_push_data_heap (am->vlib_rp);
340 svm_pop_heap (oldheap);
344 vl_set_memory_root_path (const char *name)
346 api_main_t *am = &api_main;
348 am->root_path = name;
352 vl_set_memory_uid (int uid)
354 api_main_t *am = &api_main;
360 vl_set_memory_gid (int gid)
362 api_main_t *am = &api_main;
368 vl_set_global_memory_baseva (u64 baseva)
370 api_main_t *am = &api_main;
372 am->global_baseva = baseva;
376 vl_set_global_memory_size (u64 size)
378 api_main_t *am = &api_main;
380 am->global_size = size;
384 vl_set_api_memory_size (u64 size)
386 api_main_t *am = &api_main;
392 vl_set_global_pvt_heap_size (u64 size)
394 api_main_t *am = &api_main;
396 am->global_pvt_heap_size = size;
400 vl_set_api_pvt_heap_size (u64 size)
402 api_main_t *am = &api_main;
404 am->api_pvt_heap_size = size;
408 vl_api_default_mem_config (vl_shmem_hdr_t * shmem_hdr)
410 api_main_t *am = &api_main;
411 u32 vlib_input_queue_length;
413 /* vlib main input queue */
414 vlib_input_queue_length = 1024;
415 if (am->vlib_input_queue_length)
416 vlib_input_queue_length = am->vlib_input_queue_length;
418 shmem_hdr->vl_input_queue =
419 svm_queue_alloc_and_init (vlib_input_queue_length, sizeof (uword),
425 _rp.rp = svm_queue_alloc_and_init ((n), (sz), 0); \
430 vec_add1(shmem_hdr->vl_rings, _rp); \
433 foreach_vl_aring_size;
439 _rp.rp = svm_queue_alloc_and_init ((n), (sz), 0); \
444 vec_add1(shmem_hdr->client_rings, _rp); \
447 foreach_clnt_aring_size;
452 vl_api_mem_config (vl_shmem_hdr_t * hdr, vl_api_shm_elem_config_t * config)
454 vl_api_shm_elem_config_t *c;
460 vl_api_default_mem_config (hdr);
464 vec_foreach (c, config)
469 hdr->vl_input_queue = svm_queue_alloc_and_init (c->count, c->size,
472 case VL_API_VLIB_RING:
473 vec_add2 (hdr->vl_rings, rp, 1);
475 case VL_API_CLIENT_RING:
476 vec_add2 (hdr->client_rings, rp, 1);
479 clib_warning ("unknown config type: %d", c->type);
483 size = sizeof (ring_alloc_t) + c->size;
484 rp->rp = svm_queue_alloc_and_init (c->count, size, 0);
486 rp->nitems = c->count;
493 vl_init_shmem (svm_region_t * vlib_rp, vl_api_shm_elem_config_t * config,
494 int is_vlib, int is_private_region)
496 api_main_t *am = &api_main;
497 vl_shmem_hdr_t *shmem_hdr = 0;
501 /* $$$$ need private region config parameters */
503 oldheap = svm_push_data_heap (vlib_rp);
505 vec_validate (shmem_hdr, 0);
506 shmem_hdr->version = VL_SHM_VERSION;
507 shmem_hdr->clib_file_index = VL_API_INVALID_FI;
509 /* Set up the queue and msg ring allocator */
510 vl_api_mem_config (shmem_hdr, config);
512 if (is_private_region == 0)
514 am->shmem_hdr = shmem_hdr;
515 am->vlib_rp = vlib_rp;
516 am->our_pid = getpid ();
518 am->shmem_hdr->vl_pid = am->our_pid;
521 shmem_hdr->vl_pid = am->our_pid;
523 svm_pop_heap (oldheap);
526 * After absolutely everything that a client might see is set up,
527 * declare the shmem region valid
529 vlib_rp->user_ctx = shmem_hdr;
531 pthread_mutex_unlock (&vlib_rp->mutex);
535 vl_map_shmem (const char *region_name, int is_vlib)
537 svm_map_region_args_t _a, *a = &_a;
538 svm_region_t *vlib_rp, *root_rp;
539 api_main_t *am = &api_main;
541 struct timespec ts, tsrem;
542 char *vpe_api_region_suffix = "-vpe-api";
544 clib_memset (a, 0, sizeof (*a));
546 if (strstr (region_name, vpe_api_region_suffix))
548 u8 *root_path = format (0, "%s", region_name);
549 _vec_len (root_path) = (vec_len (root_path) -
550 strlen (vpe_api_region_suffix));
551 vec_terminate_c_string (root_path);
552 a->root_path = (const char *) root_path;
553 am->root_path = (const char *) root_path;
561 * Clients wait for vpp to set up the root / API regioins
564 api_name = format (0, "/dev/shm/%s-%s%c", am->root_path,
567 api_name = format (0, "/dev/shm%s%c", region_name, 0);
569 /* Wait up to 100 seconds... */
570 for (i = 0; i < 10000; i++)
573 ts.tv_nsec = 10000 * 1000; /* 10 ms */
574 while (nanosleep (&ts, &tsrem) < 0)
576 tfd = open ((char *) api_name, O_RDWR);
583 clib_warning ("region init fail");
587 svm_region_init_chroot_uid_gid (am->root_path, getuid (), getgid ());
590 if (a->root_path != NULL)
592 a->name = "/vpe-api";
595 a->name = region_name;
596 a->size = am->api_size ? am->api_size : (16 << 20);
597 a->flags = SVM_FLAGS_MHEAP;
598 a->uid = am->api_uid;
599 a->gid = am->api_gid;
600 a->pvt_heap_size = am->api_pvt_heap_size;
602 vlib_rp = svm_region_find_or_create (a);
607 pthread_mutex_lock (&vlib_rp->mutex);
608 /* Has someone else set up the shared-memory variable table? */
609 if (vlib_rp->user_ctx)
611 am->shmem_hdr = (void *) vlib_rp->user_ctx;
612 am->our_pid = getpid ();
618 * application restart. Reset cached pids, API message
619 * rings, list of clients; otherwise, various things
620 * fail. (e.g. queue non-empty notification)
623 /* ghosts keep the region from disappearing properly */
624 svm_client_scan_this_region_nolock (vlib_rp);
625 am->shmem_hdr->application_restarts++;
626 q = am->shmem_hdr->vl_input_queue;
627 am->shmem_hdr->vl_pid = getpid ();
628 q->consumer_pid = am->shmem_hdr->vl_pid;
629 /* Drain the input queue, freeing msgs */
630 for (i = 0; i < 10; i++)
632 if (pthread_mutex_trylock (&q->mutex) == 0)
634 pthread_mutex_unlock (&q->mutex);
638 ts.tv_nsec = 10000 * 1000; /* 10 ms */
639 while (nanosleep (&ts, &tsrem) < 0)
642 /* Mutex buggered, "fix" it */
643 clib_memset (&q->mutex, 0, sizeof (q->mutex));
644 clib_warning ("forcibly release main input queue mutex");
647 am->vlib_rp = vlib_rp;
648 while (svm_queue_sub (q, (u8 *) & old_msg, SVM_Q_NOWAIT, 0)
649 != -2 /* queue underflow */ )
651 vl_msg_api_free_nolock ((void *) old_msg);
652 am->shmem_hdr->restart_reclaims++;
654 pthread_mutex_unlock (&vlib_rp->mutex);
655 root_rp = svm_get_root_rp ();
657 /* Clean up the root region client list */
658 pthread_mutex_lock (&root_rp->mutex);
659 svm_client_scan_this_region_nolock (root_rp);
660 pthread_mutex_unlock (&root_rp->mutex);
664 pthread_mutex_unlock (&vlib_rp->mutex);
666 am->vlib_rp = vlib_rp;
667 vec_add1 (am->mapped_shmem_regions, vlib_rp);
670 /* Clients simply have to wait... */
673 pthread_mutex_unlock (&vlib_rp->mutex);
675 /* Wait up to 100 seconds... */
676 for (i = 0; i < 10000; i++)
679 ts.tv_nsec = 10000 * 1000; /* 10 ms */
680 while (nanosleep (&ts, &tsrem) < 0)
682 if (vlib_rp->user_ctx)
685 /* Clean up and leave... */
686 svm_region_unmap (vlib_rp);
687 clib_warning ("region init fail");
691 am->shmem_hdr = (void *) vlib_rp->user_ctx;
692 am->our_pid = getpid ();
693 am->vlib_rp = vlib_rp;
694 vec_add1 (am->mapped_shmem_regions, vlib_rp);
698 /* Nope, it's our problem... */
699 vl_init_shmem (vlib_rp, 0 /* default config */ , 1 /* is vlib */ ,
700 0 /* is_private_region */ );
702 vec_add1 (am->mapped_shmem_regions, vlib_rp);
707 vl_register_mapped_shmem_region (svm_region_t * rp)
709 api_main_t *am = &api_main;
711 vec_add1 (am->mapped_shmem_regions, rp);
715 vl_unmap_shmem_internal (u8 is_client)
719 api_main_t *am = &api_main;
721 if (!svm_get_root_rp ())
724 for (i = 0; i < vec_len (am->mapped_shmem_regions); i++)
726 rp = am->mapped_shmem_regions[i];
727 is_client ? svm_region_unmap_client (rp) : svm_region_unmap (rp);
730 vec_free (am->mapped_shmem_regions);
733 is_client ? svm_region_exit_client () : svm_region_exit ();
735 /* $$$ more careful cleanup, valgrind run... */
736 vec_free (am->msg_handlers);
737 vec_free (am->msg_endian_handlers);
738 vec_free (am->msg_print_handlers);
742 vl_unmap_shmem (void)
744 vl_unmap_shmem_internal (0);
748 vl_unmap_shmem_client (void)
750 vl_unmap_shmem_internal (1);
754 vl_msg_api_send_shmem (svm_queue_t * q, u8 * elem)
756 api_main_t *am = &api_main;
757 void *msg = (void *) *(uword *) elem;
759 if (am->tx_trace && am->tx_trace->enabled)
760 vl_msg_api_trace (am, am->tx_trace, msg);
763 * Announce a probable binary API client bug:
764 * some client's input queue is stuffed.
765 * The situation may be recoverable, or not.
768 (am->vl_clients /* vpp side */ && (q->cursize == q->maxsize)))
770 if (PREDICT_FALSE (am->elog_trace_api_messages))
773 ELOG_TYPE_DECLARE (e) =
775 .format = "api-client-queue-stuffed: %x%x",
776 .format_args = "i4i4",
783 ed = ELOG_DATA (am->elog_main, e);
784 ed->hi = (uword) q >> 32;
785 ed->low = (uword) q & 0xFFFFFFFF;
786 clib_warning ("WARNING: client input queue at %llx is stuffed...",
790 VL_MSG_API_POISON (msg);
791 (void) svm_queue_add (q, elem, 0 /* nowait */ );
795 vl_mem_api_can_send (svm_queue_t * q)
797 return (q->cursize < q->maxsize);
801 vl_msg_api_send_shmem_nolock (svm_queue_t * q, u8 * elem)
803 api_main_t *am = &api_main;
804 void *msg = (void *) *(uword *) elem;
806 if (am->tx_trace && am->tx_trace->enabled)
807 vl_msg_api_trace (am, am->tx_trace, msg);
809 (void) svm_queue_add_nolock (q, elem);
810 VL_MSG_API_POISON (msg);
814 * fd.io coding-style-patch-verification: ON
817 * eval: (c-set-style "gnu")