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>
42 socket_main_t socket_main;
44 #define DEBUG_MESSAGE_BUFFER_OVERRUN 0
47 vl_msg_api_alloc_internal (int nbytes, int pool, int may_return_null)
52 unix_shared_memory_queue_t *q;
54 vl_shmem_hdr_t *shmem_hdr;
55 api_main_t *am = &api_main;
57 shmem_hdr = am->shmem_hdr;
59 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 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 svm_pop_heap (oldheap);
180 pthread_mutex_unlock (&am->vlib_rp->mutex);
183 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
187 overrun = (u32 *) (rv->data + nbytes - sizeof (msgbuf_t));
188 *overrun = 0x1badbabe;
191 rv->data_len = htonl (nbytes - sizeof (msgbuf_t));
197 vl_msg_api_alloc (int nbytes)
200 api_main_t *am = &api_main;
201 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
204 * Clients use pool-0, vlib proc uses pool 1
206 pool = (am->our_pid == shmem_hdr->vl_pid);
207 return vl_msg_api_alloc_internal (nbytes, pool, 0 /* may_return_null */ );
211 vl_msg_api_alloc_or_null (int nbytes)
214 api_main_t *am = &api_main;
215 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
217 pool = (am->our_pid == shmem_hdr->vl_pid);
218 return vl_msg_api_alloc_internal (nbytes, pool, 1 /* may_return_null */ );
222 vl_msg_api_alloc_as_if_client (int nbytes)
224 return vl_msg_api_alloc_internal (nbytes, 0, 0 /* may_return_null */ );
228 vl_msg_api_alloc_as_if_client_or_null (int nbytes)
230 return vl_msg_api_alloc_internal (nbytes, 0, 1 /* may_return_null */ );
234 vl_msg_api_free (void *a)
238 api_main_t *am = &api_main;
240 rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
243 * Here's the beauty of the scheme. Only one proc/thread has
244 * control of a given message buffer. To free a buffer, we just clear the
245 * queue field, and leave. No locks, no hits, no errors...
250 rv->gc_mark_timestamp = 0;
251 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
254 overrun = (u32 *) (rv->data + ntohl (rv->data_len));
255 ASSERT (*overrun == 0x1badbabe);
261 pthread_mutex_lock (&am->vlib_rp->mutex);
262 oldheap = svm_push_data_heap (am->vlib_rp);
264 #if DEBUG_MESSAGE_BUFFER_OVERRUN > 0
267 overrun = (u32 *) (rv->data + ntohl (rv->data_len));
268 ASSERT (*overrun == 0x1badbabe);
273 svm_pop_heap (oldheap);
274 pthread_mutex_unlock (&am->vlib_rp->mutex);
278 vl_msg_api_free_nolock (void *a)
282 api_main_t *am = &api_main;
284 rv = (msgbuf_t *) (((u8 *) a) - offsetof (msgbuf_t, data));
286 * Here's the beauty of the scheme. Only one proc/thread has
287 * control of a given message buffer. To free a buffer, we just clear the
288 * queue field, and leave. No locks, no hits, no errors...
296 oldheap = svm_push_data_heap (am->vlib_rp);
298 svm_pop_heap (oldheap);
302 vl_set_memory_root_path (const char *name)
304 api_main_t *am = &api_main;
306 am->root_path = name;
310 vl_set_memory_uid (int uid)
312 api_main_t *am = &api_main;
318 vl_set_memory_gid (int gid)
320 api_main_t *am = &api_main;
326 vl_set_global_memory_baseva (u64 baseva)
328 api_main_t *am = &api_main;
330 am->global_baseva = baseva;
334 vl_set_global_memory_size (u64 size)
336 api_main_t *am = &api_main;
338 am->global_size = size;
342 vl_set_api_memory_size (u64 size)
344 api_main_t *am = &api_main;
350 vl_set_global_pvt_heap_size (u64 size)
352 api_main_t *am = &api_main;
354 am->global_pvt_heap_size = size;
358 vl_set_api_pvt_heap_size (u64 size)
360 api_main_t *am = &api_main;
362 am->api_pvt_heap_size = size;
366 vl_init_shmem (svm_region_t * vlib_rp, int is_vlib, int is_private_region)
368 api_main_t *am = &api_main;
369 vl_shmem_hdr_t *shmem_hdr = 0;
370 u32 vlib_input_queue_length;
374 /* $$$$ need private region config parameters */
376 oldheap = svm_push_data_heap (vlib_rp);
378 vec_validate (shmem_hdr, 0);
379 shmem_hdr->version = VL_SHM_VERSION;
381 /* vlib main input queue */
382 vlib_input_queue_length = 1024;
383 if (am->vlib_input_queue_length)
384 vlib_input_queue_length = am->vlib_input_queue_length;
386 shmem_hdr->vl_input_queue =
387 unix_shared_memory_queue_init (vlib_input_queue_length, sizeof (uword),
388 getpid (), am->vlib_signal);
390 /* Set up the msg ring allocator */
394 _rp.rp = unix_shared_memory_queue_init ((n), (sz), 0, 0); \
399 vec_add1(shmem_hdr->vl_rings, _rp); \
402 foreach_vl_aring_size;
408 _rp.rp = unix_shared_memory_queue_init ((n), (sz), 0, 0); \
413 vec_add1(shmem_hdr->client_rings, _rp); \
416 foreach_clnt_aring_size;
419 if (is_private_region == 0)
421 am->shmem_hdr = shmem_hdr;
422 am->vlib_rp = vlib_rp;
423 am->our_pid = getpid ();
425 am->shmem_hdr->vl_pid = am->our_pid;
428 shmem_hdr->vl_pid = am->our_pid;
430 svm_pop_heap (oldheap);
433 * After absolutely everything that a client might see is set up,
434 * declare the shmem region valid
436 vlib_rp->user_ctx = shmem_hdr;
438 pthread_mutex_unlock (&vlib_rp->mutex);
443 vl_map_shmem (const char *region_name, int is_vlib)
445 svm_map_region_args_t _a, *a = &_a;
446 svm_region_t *vlib_rp, *root_rp;
447 api_main_t *am = &api_main;
449 struct timespec ts, tsrem;
450 char *vpe_api_region_suffix = "-vpe-api";
452 memset (a, 0, sizeof (*a));
454 if (strstr (region_name, vpe_api_region_suffix))
456 u8 *root_path = format (0, "%s", region_name);
457 _vec_len (root_path) = (vec_len (root_path) -
458 strlen (vpe_api_region_suffix));
459 vec_terminate_c_string (root_path);
460 a->root_path = (const char *) root_path;
461 am->root_path = (const char *) root_path;
466 rv = svm_region_init_chroot (am->root_path);
471 if (a->root_path != NULL)
473 a->name = "/vpe-api";
476 a->name = region_name;
477 a->size = am->api_size ? am->api_size : (16 << 20);
478 a->flags = SVM_FLAGS_MHEAP;
479 a->uid = am->api_uid;
480 a->gid = am->api_gid;
481 a->pvt_heap_size = am->api_pvt_heap_size;
483 vlib_rp = svm_region_find_or_create (a);
488 pthread_mutex_lock (&vlib_rp->mutex);
489 /* Has someone else set up the shared-memory variable table? */
490 if (vlib_rp->user_ctx)
492 am->shmem_hdr = (void *) vlib_rp->user_ctx;
493 am->our_pid = getpid ();
496 unix_shared_memory_queue_t *q;
499 * application restart. Reset cached pids, API message
500 * rings, list of clients; otherwise, various things
501 * fail. (e.g. queue non-empty notification)
504 /* ghosts keep the region from disappearing properly */
505 svm_client_scan_this_region_nolock (vlib_rp);
506 am->shmem_hdr->application_restarts++;
507 q = am->shmem_hdr->vl_input_queue;
508 am->shmem_hdr->vl_pid = getpid ();
509 q->consumer_pid = am->shmem_hdr->vl_pid;
510 /* Drain the input queue, freeing msgs */
511 for (i = 0; i < 10; i++)
513 if (pthread_mutex_trylock (&q->mutex) == 0)
515 pthread_mutex_unlock (&q->mutex);
519 ts.tv_nsec = 10000 * 1000; /* 10 ms */
520 while (nanosleep (&ts, &tsrem) < 0)
523 /* Mutex buggered, "fix" it */
524 memset (&q->mutex, 0, sizeof (q->mutex));
525 clib_warning ("forcibly release main input queue mutex");
528 am->vlib_rp = vlib_rp;
529 while (unix_shared_memory_queue_sub (q,
532 != -2 /* queue underflow */ )
534 vl_msg_api_free_nolock ((void *) old_msg);
535 am->shmem_hdr->restart_reclaims++;
537 pthread_mutex_unlock (&vlib_rp->mutex);
538 root_rp = svm_get_root_rp ();
540 /* Clean up the root region client list */
541 pthread_mutex_lock (&root_rp->mutex);
542 svm_client_scan_this_region_nolock (root_rp);
543 pthread_mutex_unlock (&root_rp->mutex);
547 pthread_mutex_unlock (&vlib_rp->mutex);
549 am->vlib_rp = vlib_rp;
550 vec_add1 (am->mapped_shmem_regions, vlib_rp);
553 /* Clients simply have to wait... */
556 pthread_mutex_unlock (&vlib_rp->mutex);
558 /* Wait up to 100 seconds... */
559 for (i = 0; i < 10000; i++)
562 ts.tv_nsec = 10000 * 1000; /* 10 ms */
563 while (nanosleep (&ts, &tsrem) < 0)
565 if (vlib_rp->user_ctx)
568 /* Clean up and leave... */
569 svm_region_unmap (vlib_rp);
570 clib_warning ("region init fail");
574 am->shmem_hdr = (void *) vlib_rp->user_ctx;
575 am->our_pid = getpid ();
576 am->vlib_rp = vlib_rp;
577 vec_add1 (am->mapped_shmem_regions, vlib_rp);
581 /* Nope, it's our problem... */
582 vl_init_shmem (vlib_rp, 1 /* is vlib */ , 0 /* is_private_region */ );
584 vec_add1 (am->mapped_shmem_regions, vlib_rp);
589 vl_register_mapped_shmem_region (svm_region_t * rp)
591 api_main_t *am = &api_main;
593 vec_add1 (am->mapped_shmem_regions, rp);
597 vl_unmap_shmem (void)
601 api_main_t *am = &api_main;
603 if (!svm_get_root_rp ())
606 for (i = 0; i < vec_len (am->mapped_shmem_regions); i++)
608 rp = am->mapped_shmem_regions[i];
609 svm_region_unmap (rp);
612 vec_free (am->mapped_shmem_regions);
616 /* $$$ more careful cleanup, valgrind run... */
617 vec_free (am->msg_handlers);
618 vec_free (am->msg_endian_handlers);
619 vec_free (am->msg_print_handlers);
623 vl_msg_api_send_shmem (unix_shared_memory_queue_t * q, u8 * elem)
625 api_main_t *am = &api_main;
626 uword *trace = (uword *) elem;
628 if (am->tx_trace && am->tx_trace->enabled)
629 vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
631 (void) unix_shared_memory_queue_add (q, elem, 0 /* nowait */ );
635 vl_msg_api_send_shmem_nolock (unix_shared_memory_queue_t * q, u8 * elem)
637 api_main_t *am = &api_main;
638 uword *trace = (uword *) elem;
640 if (am->tx_trace && am->tx_trace->enabled)
641 vl_msg_api_trace (am, am->tx_trace, (void *) trace[0]);
643 (void) unix_shared_memory_queue_add_nolock (q, elem);
647 vl_api_get_msg_index (u8 * name_and_crc)
649 api_main_t *am = &api_main;
652 if (am->msg_index_by_name_and_crc)
654 p = hash_get_mem (am->msg_index_by_name_and_crc, name_and_crc);
661 static inline vl_api_registration_t *
662 vl_api_client_index_to_registration_internal (u32 handle)
664 vl_api_registration_t **regpp;
665 vl_api_registration_t *regp;
666 api_main_t *am = &api_main;
669 index = vl_msg_api_handle_get_index (handle);
670 if ((am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK)
671 != vl_msg_api_handle_get_epoch (handle))
673 vl_msg_api_increment_missing_client_counter ();
677 regpp = am->vl_clients + index;
679 if (pool_is_free (am->vl_clients, regpp))
681 vl_msg_api_increment_missing_client_counter ();
688 vl_api_registration_t *
689 vl_api_client_index_to_registration (u32 index)
691 if (PREDICT_FALSE (socket_main.current_rp != 0))
692 return socket_main.current_rp;
694 return (vl_api_client_index_to_registration_internal (index));
697 unix_shared_memory_queue_t *
698 vl_api_client_index_to_input_queue (u32 index)
700 vl_api_registration_t *regp;
701 api_main_t *am = &api_main;
703 /* Special case: vlib trying to send itself a message */
704 if (index == (u32) ~ 0)
705 return (am->shmem_hdr->vl_input_queue);
707 regp = vl_api_client_index_to_registration_internal (index);
710 return (regp->vl_input_queue);
714 * fd.io coding-style-patch-verification: ON
717 * eval: (c-set-style "gnu")