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>
38 #include <vlibapi/api_common.h>
41 #include <vlibmemory/vl_memory_api_h.h>
44 #define DEBUG_MESSAGE_BUFFER_OVERRUN 0
46 CLIB_NOSANITIZE_ADDR static inline void *
47 vl_msg_api_alloc_internal (svm_region_t * vlib_rp, int nbytes, int pool,
55 vl_shmem_hdr_t *shmem_hdr;
56 api_main_t *am = vlibapi_get_main ();
58 shmem_hdr = (void *) vlib_rp->user_ctx;
60 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
64 ASSERT (pool == 0 || vlib_get_thread_index () == 0);
68 clib_warning ("shared memory header NULL");
72 /* account for the msgbuf_t header */
73 nbytes += sizeof (msgbuf_t);
75 if (shmem_hdr->vl_rings == 0)
77 clib_warning ("vl_rings NULL");
82 if (shmem_hdr->client_rings == 0)
84 clib_warning ("client_rings NULL");
89 ap = pool ? shmem_hdr->vl_rings : shmem_hdr->client_rings;
90 for (i = 0; i < vec_len (ap); i++)
93 if (nbytes > ap[i].size)
101 pthread_mutex_lock (&q->mutex);
103 rv = (msgbuf_t *) (&q->data[0] + q->head * q->elsize);
105 * Is this item still in use?
109 u32 now = (u32) time (0);
111 if (PREDICT_TRUE (rv->gc_mark_timestamp == 0))
112 rv->gc_mark_timestamp = now;
115 if (now - rv->gc_mark_timestamp > 10)
119 u16 *msg_idp, msg_id;
121 ("garbage collect pool %d ring %d index %d", pool, i,
123 msg_idp = (u16 *) (rv->data);
124 msg_id = clib_net_to_host_u16 (*msg_idp);
125 if (msg_id < vec_len (vlibapi_get_main ()->msg_names))
126 clib_warning ("msg id %d name %s", (u32) msg_id,
127 vlibapi_get_main ()->msg_names[msg_id]);
129 shmem_hdr->garbage_collects++;
135 /* yes, loser; try next larger pool */
138 pthread_mutex_unlock (&q->mutex);
143 /* OK, we have a winner */
146 * Remember the source queue, although we
147 * don't need to know the queue to free the item.
150 rv->gc_mark_timestamp = 0;
152 if (q->head == q->maxsize)
156 pthread_mutex_unlock (&q->mutex);
161 * Request too big, or head element of all size-compatible rings
162 * still in use. Fall back to shared-memory malloc.
166 oldheap = vl_msg_push_heap_w_region (vlib_rp);
169 rv = clib_mem_alloc_or_null (nbytes);
170 if (PREDICT_FALSE (rv == 0))
172 vl_msg_pop_heap_w_region (vlib_rp, oldheap);
177 rv = clib_mem_alloc (nbytes);
180 rv->gc_mark_timestamp = 0;
181 vl_msg_pop_heap_w_region (vlib_rp, oldheap);
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));
194 VL_MSG_API_UNPOISON (rv->data);
199 vl_msg_api_alloc (int nbytes)
202 api_main_t *am = vlibapi_get_main ();
203 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
206 * Clients use pool-0, vlib proc uses pool 1
208 pool = (am->our_pid == shmem_hdr->vl_pid);
209 return vl_msg_api_alloc_internal (am->vlib_rp, nbytes, pool,
210 0 /* may_return_null */ );
214 vl_msg_api_alloc_zero (int nbytes)
218 ret = vl_msg_api_alloc (nbytes);
219 clib_memset (ret, 0, nbytes);
224 vl_msg_api_alloc_or_null (int nbytes)
227 api_main_t *am = vlibapi_get_main ();
228 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
230 pool = (am->our_pid == shmem_hdr->vl_pid);
231 return vl_msg_api_alloc_internal (am->vlib_rp, nbytes, pool,
232 1 /* may_return_null */ );
236 vl_msg_api_alloc_as_if_client (int nbytes)
238 api_main_t *am = vlibapi_get_main ();
239 return vl_msg_api_alloc_internal (am->vlib_rp, nbytes, 0,
240 0 /* may_return_null */ );
244 vl_msg_api_alloc_zero_as_if_client (int nbytes)
248 ret = vl_msg_api_alloc_as_if_client (nbytes);
249 clib_memset (ret, 0, nbytes);
254 vl_msg_api_alloc_as_if_client_or_null (int nbytes)
256 api_main_t *am = vlibapi_get_main ();
257 return vl_msg_api_alloc_internal (am->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 oldheap = vl_msg_push_heap_w_region (vlib_rp);
298 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
301 overrun = (u32 *) (rv->data + ntohl (rv->data_len));
302 ASSERT (*overrun == 0x1badbabe);
307 vl_msg_pop_heap_w_region (vlib_rp, oldheap);
311 vl_msg_api_free (void *a)
313 api_main_t *am = vlibapi_get_main ();
314 vl_msg_api_free_w_region (am->vlib_rp, a);
318 vl_msg_api_free_nolock (void *a)
322 api_main_t *am = vlibapi_get_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...
333 VL_MSG_API_POISON (rv->data);
337 oldheap = svm_push_data_heap (am->vlib_rp);
339 svm_pop_heap (oldheap);
343 vl_set_memory_root_path (const char *name)
345 api_main_t *am = vlibapi_get_main ();
347 am->root_path = name;
351 vl_set_memory_uid (int uid)
353 api_main_t *am = vlibapi_get_main ();
359 vl_set_memory_gid (int gid)
361 api_main_t *am = vlibapi_get_main ();
367 vl_set_global_memory_baseva (u64 baseva)
369 api_main_t *am = vlibapi_get_main ();
371 am->global_baseva = baseva;
375 vl_set_global_memory_size (u64 size)
377 api_main_t *am = vlibapi_get_main ();
379 am->global_size = size;
383 vl_set_api_memory_size (u64 size)
385 api_main_t *am = vlibapi_get_main ();
391 vl_set_global_pvt_heap_size (u64 size)
393 api_main_t *am = vlibapi_get_main ();
395 am->global_pvt_heap_size = size;
399 vl_set_api_pvt_heap_size (u64 size)
401 api_main_t *am = vlibapi_get_main ();
403 am->api_pvt_heap_size = size;
407 vl_api_default_mem_config (vl_shmem_hdr_t * shmem_hdr)
409 api_main_t *am = vlibapi_get_main ();
410 u32 vlib_input_queue_length;
412 /* vlib main input queue */
413 vlib_input_queue_length = 1024;
414 if (am->vlib_input_queue_length)
415 vlib_input_queue_length = am->vlib_input_queue_length;
417 shmem_hdr->vl_input_queue =
418 svm_queue_alloc_and_init (vlib_input_queue_length, sizeof (uword),
424 _rp.rp = svm_queue_alloc_and_init ((n), (sz), 0); \
429 vec_add1(shmem_hdr->vl_rings, _rp); \
432 foreach_vl_aring_size;
438 _rp.rp = svm_queue_alloc_and_init ((n), (sz), 0); \
443 vec_add1(shmem_hdr->client_rings, _rp); \
446 foreach_clnt_aring_size;
451 vl_api_mem_config (vl_shmem_hdr_t * hdr, vl_api_shm_elem_config_t * config)
453 vl_api_shm_elem_config_t *c;
459 vl_api_default_mem_config (hdr);
463 vec_foreach (c, config)
468 hdr->vl_input_queue = svm_queue_alloc_and_init (c->count, c->size,
471 case VL_API_VLIB_RING:
472 vec_add2 (hdr->vl_rings, rp, 1);
474 case VL_API_CLIENT_RING:
475 vec_add2 (hdr->client_rings, rp, 1);
478 clib_warning ("unknown config type: %d", c->type);
482 size = sizeof (ring_alloc_t) + c->size;
483 rp->rp = svm_queue_alloc_and_init (c->count, size, 0);
485 rp->nitems = c->count;
492 vl_init_shmem (svm_region_t * vlib_rp, vl_api_shm_elem_config_t * config,
493 int is_vlib, int is_private_region)
495 api_main_t *am = vlibapi_get_main ();
496 vl_shmem_hdr_t *shmem_hdr = 0;
500 /* $$$$ need private region config parameters */
502 oldheap = svm_push_data_heap (vlib_rp);
504 vec_validate (shmem_hdr, 0);
505 shmem_hdr->version = VL_SHM_VERSION;
506 shmem_hdr->clib_file_index = VL_API_INVALID_FI;
508 /* Set up the queue and msg ring allocator */
509 vl_api_mem_config (shmem_hdr, config);
511 if (is_private_region == 0)
513 am->shmem_hdr = shmem_hdr;
514 am->vlib_rp = vlib_rp;
515 am->our_pid = getpid ();
517 am->shmem_hdr->vl_pid = am->our_pid;
520 shmem_hdr->vl_pid = am->our_pid;
522 svm_pop_heap (oldheap);
525 * After absolutely everything that a client might see is set up,
526 * declare the shmem region valid
528 vlib_rp->user_ctx = shmem_hdr;
530 pthread_mutex_unlock (&vlib_rp->mutex);
534 vl_map_shmem (const char *region_name, int is_vlib)
536 svm_map_region_args_t _a, *a = &_a;
537 svm_region_t *vlib_rp, *root_rp;
538 api_main_t *am = vlibapi_get_main ();
540 struct timespec ts, tsrem;
541 char *vpe_api_region_suffix = "-vpe-api";
543 clib_memset (a, 0, sizeof (*a));
545 if (strstr (region_name, vpe_api_region_suffix))
547 u8 *root_path = format (0, "%s", region_name);
548 _vec_len (root_path) = (vec_len (root_path) -
549 strlen (vpe_api_region_suffix));
550 vec_terminate_c_string (root_path);
551 a->root_path = (const char *) root_path;
552 am->root_path = (const char *) root_path;
560 * Clients wait for vpp to set up the root / API regioins
563 api_name = format (0, "/dev/shm/%s-%s%c", am->root_path,
566 api_name = format (0, "/dev/shm%s%c", region_name, 0);
568 /* Wait up to 100 seconds... */
569 for (i = 0; i < 10000; i++)
572 ts.tv_nsec = 10000 * 1000; /* 10 ms */
573 while (nanosleep (&ts, &tsrem) < 0)
575 tfd = open ((char *) api_name, O_RDWR);
582 clib_warning ("region init fail");
586 svm_region_init_chroot_uid_gid (am->root_path, getuid (), getgid ());
589 if (a->root_path != NULL)
591 a->name = "/vpe-api";
594 a->name = region_name;
595 a->size = am->api_size ? am->api_size : (16 << 20);
596 a->flags = SVM_FLAGS_MHEAP;
597 a->uid = am->api_uid;
598 a->gid = am->api_gid;
599 a->pvt_heap_size = am->api_pvt_heap_size;
601 vlib_rp = svm_region_find_or_create (a);
606 pthread_mutex_lock (&vlib_rp->mutex);
607 /* Has someone else set up the shared-memory variable table? */
608 if (vlib_rp->user_ctx)
610 am->shmem_hdr = (void *) vlib_rp->user_ctx;
611 am->our_pid = getpid ();
617 * application restart. Reset cached pids, API message
618 * rings, list of clients; otherwise, various things
619 * fail. (e.g. queue non-empty notification)
622 /* ghosts keep the region from disappearing properly */
623 svm_client_scan_this_region_nolock (vlib_rp);
624 am->shmem_hdr->application_restarts++;
625 q = am->shmem_hdr->vl_input_queue;
626 am->shmem_hdr->vl_pid = getpid ();
627 q->consumer_pid = am->shmem_hdr->vl_pid;
628 /* Drain the input queue, freeing msgs */
629 for (i = 0; i < 10; i++)
631 if (pthread_mutex_trylock (&q->mutex) == 0)
633 pthread_mutex_unlock (&q->mutex);
637 ts.tv_nsec = 10000 * 1000; /* 10 ms */
638 while (nanosleep (&ts, &tsrem) < 0)
641 /* Mutex buggered, "fix" it */
642 clib_memset (&q->mutex, 0, sizeof (q->mutex));
643 clib_warning ("forcibly release main input queue mutex");
646 am->vlib_rp = vlib_rp;
647 while (svm_queue_sub (q, (u8 *) & old_msg, SVM_Q_NOWAIT, 0)
648 != -2 /* queue underflow */ )
650 vl_msg_api_free_nolock ((void *) old_msg);
651 am->shmem_hdr->restart_reclaims++;
653 pthread_mutex_unlock (&vlib_rp->mutex);
654 root_rp = svm_get_root_rp ();
656 /* Clean up the root region client list */
657 pthread_mutex_lock (&root_rp->mutex);
658 svm_client_scan_this_region_nolock (root_rp);
659 pthread_mutex_unlock (&root_rp->mutex);
663 pthread_mutex_unlock (&vlib_rp->mutex);
665 am->vlib_rp = vlib_rp;
666 vec_add1 (am->mapped_shmem_regions, vlib_rp);
669 /* Clients simply have to wait... */
672 pthread_mutex_unlock (&vlib_rp->mutex);
674 /* Wait up to 100 seconds... */
675 for (i = 0; i < 10000; i++)
678 ts.tv_nsec = 10000 * 1000; /* 10 ms */
679 while (nanosleep (&ts, &tsrem) < 0)
681 if (vlib_rp->user_ctx)
684 /* Clean up and leave... */
685 svm_region_unmap (vlib_rp);
686 clib_warning ("region init fail");
690 am->shmem_hdr = (void *) vlib_rp->user_ctx;
691 am->our_pid = getpid ();
692 am->vlib_rp = vlib_rp;
693 vec_add1 (am->mapped_shmem_regions, vlib_rp);
697 /* Nope, it's our problem... */
698 vl_init_shmem (vlib_rp, 0 /* default config */ , 1 /* is vlib */ ,
699 0 /* is_private_region */ );
701 vec_add1 (am->mapped_shmem_regions, vlib_rp);
706 vl_register_mapped_shmem_region (svm_region_t * rp)
708 api_main_t *am = vlibapi_get_main ();
710 vec_add1 (am->mapped_shmem_regions, rp);
714 vl_unmap_shmem_internal (u8 is_client)
718 api_main_t *am = vlibapi_get_main ();
720 if (!svm_get_root_rp ())
723 for (i = 0; i < vec_len (am->mapped_shmem_regions); i++)
725 rp = am->mapped_shmem_regions[i];
726 is_client ? svm_region_unmap_client (rp) : svm_region_unmap (rp);
729 vec_free (am->mapped_shmem_regions);
732 is_client ? svm_region_exit_client () : svm_region_exit ();
734 /* $$$ more careful cleanup, valgrind run... */
735 vec_free (am->msg_handlers);
736 vec_free (am->msg_endian_handlers);
737 vec_free (am->msg_print_handlers);
741 vl_unmap_shmem (void)
743 vl_unmap_shmem_internal (0);
747 vl_unmap_shmem_client (void)
749 vl_unmap_shmem_internal (1);
753 vl_msg_api_send_shmem (svm_queue_t * q, u8 * elem)
755 api_main_t *am = vlibapi_get_main ();
756 void *msg = (void *) *(uword *) elem;
758 if (am->tx_trace && am->tx_trace->enabled)
759 vl_msg_api_trace (am, am->tx_trace, msg);
762 * Announce a probable binary API client bug:
763 * some client's input queue is stuffed.
764 * The situation may be recoverable, or not.
767 (am->vl_clients /* vpp side */ && (q->cursize == q->maxsize)))
769 if (PREDICT_FALSE (am->elog_trace_api_messages))
772 ELOG_TYPE_DECLARE (e) =
774 .format = "api-client-queue-stuffed: %x%x",
775 .format_args = "i4i4",
782 ed = ELOG_DATA (am->elog_main, e);
783 ed->hi = (uword) q >> 32;
784 ed->low = (uword) q & 0xFFFFFFFF;
785 clib_warning ("WARNING: client input queue at %llx is stuffed...",
789 VL_MSG_API_POISON (msg);
790 (void) svm_queue_add (q, elem, 0 /* nowait */ );
794 vl_mem_api_can_send (svm_queue_t * q)
796 return (q->cursize < q->maxsize);
800 vl_msg_api_send_shmem_nolock (svm_queue_t * q, u8 * elem)
802 api_main_t *am = vlibapi_get_main ();
803 void *msg = (void *) *(uword *) elem;
805 if (am->tx_trace && am->tx_trace->enabled)
806 vl_msg_api_trace (am, am->tx_trace, msg);
808 (void) svm_queue_add_nolock (q, elem);
809 VL_MSG_API_POISON (msg);
813 * fd.io coding-style-patch-verification: ON
816 * eval: (c-set-style "gnu")