2 *------------------------------------------------------------------
3 * Copyright (c) 2018 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
19 #include <vlib/vlib.h>
20 #include <vlibapi/api.h>
21 #include <vlibmemory/api.h>
22 #include <vlibmemory/memory_api.h>
24 #include <vlibmemory/vl_memory_msg_enum.h> /* enumerate all vlib messages */
26 #define vl_typedefs /* define message structures */
27 #include <vlibmemory/vl_memory_api_h.h>
30 /* instantiate all the print functions we know about */
31 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
33 #include <vlibmemory/vl_memory_api_h.h>
36 /* instantiate all the endian swap functions we know about */
38 #include <vlibmemory/vl_memory_api_h.h>
42 vl_api_memclnt_create_t_print (vl_api_memclnt_create_t * a, void *handle)
44 vl_print (handle, "vl_api_memclnt_create_t:\n");
45 vl_print (handle, "name: %s\n", a->name);
46 vl_print (handle, "input_queue: 0x%wx\n", a->input_queue);
47 vl_print (handle, "context: %u\n", (unsigned) a->context);
48 vl_print (handle, "ctx_quota: %ld\n", (long) a->ctx_quota);
53 vl_api_memclnt_delete_t_print (vl_api_memclnt_delete_t * a, void *handle)
55 vl_print (handle, "vl_api_memclnt_delete_t:\n");
56 vl_print (handle, "index: %u\n", (unsigned) a->index);
57 vl_print (handle, "handle: 0x%wx\n", a->handle);
61 volatile int **vl_api_queue_cursizes;
64 memclnt_queue_callback (vlib_main_t * vm)
67 api_main_t *am = &api_main;
69 if (PREDICT_FALSE (vec_len (vl_api_queue_cursizes) !=
70 1 + vec_len (am->vlib_private_rps)))
72 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
78 q = shmem_hdr->vl_input_queue;
82 vec_add1 (vl_api_queue_cursizes, &q->cursize);
84 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
86 svm_region_t *vlib_rp = am->vlib_private_rps[i];
88 shmem_hdr = (void *) vlib_rp->user_ctx;
89 q = shmem_hdr->vl_input_queue;
90 vec_add1 (vl_api_queue_cursizes, &q->cursize);
94 for (i = 0; i < vec_len (vl_api_queue_cursizes); i++)
96 if (*vl_api_queue_cursizes[i])
98 vm->queue_signal_pending = 1;
99 vm->api_queue_nonempty = 1;
100 vlib_process_signal_event (vm, vl_api_clnt_node.index,
101 /* event_type */ QUEUE_SIGNAL_EVENT,
106 if (vec_len (vm->pending_rpc_requests))
108 vm->queue_signal_pending = 1;
109 vm->api_queue_nonempty = 1;
110 vlib_process_signal_event (vm, vl_api_clnt_node.index,
111 /* event_type */ QUEUE_SIGNAL_EVENT,
117 * vl_api_memclnt_create_internal
120 vl_api_memclnt_create_internal (char *name, svm_queue_t * q)
122 vl_api_registration_t **regpp;
123 vl_api_registration_t *regp;
126 api_main_t *am = &api_main;
128 ASSERT (vlib_get_thread_index () == 0);
129 pool_get (am->vl_clients, regpp);
133 pthread_mutex_lock (&svm->mutex);
134 oldheap = svm_push_data_heap (svm);
135 *regpp = clib_mem_alloc (sizeof (vl_api_registration_t));
138 clib_memset (regp, 0, sizeof (*regp));
139 regp->registration_type = REGISTRATION_TYPE_SHMEM;
140 regp->vl_api_registration_pool_index = regpp - am->vl_clients;
142 regp->shmem_hdr = am->shmem_hdr;
144 regp->vl_input_queue = q;
145 regp->name = format (0, "%s%c", name, 0);
147 pthread_mutex_unlock (&svm->mutex);
148 svm_pop_heap (oldheap);
149 return vl_msg_api_handle_from_index_and_epoch
150 (regp->vl_api_registration_pool_index,
151 am->shmem_hdr->application_restarts);
155 * vl_api_memclnt_create_t_handler
158 vl_api_memclnt_create_t_handler (vl_api_memclnt_create_t * mp)
160 vl_api_registration_t **regpp;
161 vl_api_registration_t *regp;
162 vl_api_memclnt_create_reply_t *rp;
167 api_main_t *am = &api_main;
171 * This is tortured. Maintain a vlib-address-space private
172 * pool of client registrations. We use the shared-memory virtual
173 * address of client structure as a handle, to allow direct
174 * manipulation of context quota vbls from the client library.
176 * This scheme causes trouble w/ API message trace replay, since
177 * some random VA from clib_mem_alloc() certainly won't
178 * occur in the Linux sim. The (very) few places
179 * that care need to use the pool index.
181 * Putting the registration object(s) into a pool in shared memory and
182 * using the pool index as a handle seems like a great idea.
183 * Unfortunately, each and every reference to that pool would need
184 * to be protected by a mutex:
188 * convert pool index to
196 pool_get (am->vl_clients, regpp);
200 pthread_mutex_lock (&svm->mutex);
201 oldheap = svm_push_data_heap (svm);
202 *regpp = clib_mem_alloc (sizeof (vl_api_registration_t));
205 clib_memset (regp, 0, sizeof (*regp));
206 regp->registration_type = REGISTRATION_TYPE_SHMEM;
207 regp->vl_api_registration_pool_index = regpp - am->vl_clients;
209 regp->shmem_hdr = am->shmem_hdr;
210 regp->clib_file_index = am->shmem_hdr->clib_file_index;
212 q = regp->vl_input_queue = (svm_queue_t *) (uword) mp->input_queue;
214 regp->name = format (0, "%s", mp->name);
215 vec_add1 (regp->name, 0);
217 if (am->serialized_message_table_in_shmem == 0)
218 am->serialized_message_table_in_shmem =
219 vl_api_serialize_message_table (am, 0);
221 if (am->vlib_rp != am->vlib_primary_rp)
222 msg_table = vl_api_serialize_message_table (am, 0);
224 msg_table = am->serialized_message_table_in_shmem;
226 pthread_mutex_unlock (&svm->mutex);
227 svm_pop_heap (oldheap);
229 rp = vl_msg_api_alloc (sizeof (*rp));
230 rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE_REPLY);
231 rp->handle = (uword) regp;
232 rp->index = vl_msg_api_handle_from_index_and_epoch
233 (regp->vl_api_registration_pool_index,
234 am->shmem_hdr->application_restarts);
235 rp->context = mp->context;
236 rp->response = ntohl (rv);
237 rp->message_table = pointer_to_uword (msg_table);
239 vl_msg_api_send_shmem (q, (u8 *) & rp);
243 vl_api_call_reaper_functions (u32 client_index)
245 clib_error_t *error = 0;
246 _vl_msg_api_function_list_elt_t *i;
248 i = api_main.reaper_function_registrations;
251 error = i->f (client_index);
253 clib_error_report (error);
254 i = i->next_init_function;
260 * vl_api_memclnt_delete_t_handler
263 vl_api_memclnt_delete_t_handler (vl_api_memclnt_delete_t * mp)
265 vl_api_registration_t **regpp;
266 vl_api_registration_t *regp;
267 vl_api_memclnt_delete_reply_t *rp;
270 api_main_t *am = &api_main;
271 u32 handle, client_index, epoch;
275 if (vl_api_call_reaper_functions (handle))
278 epoch = vl_msg_api_handle_get_epoch (handle);
279 client_index = vl_msg_api_handle_get_index (handle);
281 if (epoch != (am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK))
284 ("Stale clnt delete index %d old epoch %d cur epoch %d",
286 (am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK));
290 regpp = pool_elt_at_index (am->vl_clients, client_index);
292 if (!pool_is_free (am->vl_clients, regpp))
297 int private_registration = 0;
299 /* Send reply unless client asked us to do the cleanup */
303 * Note: the API message handling path will set am->vlib_rp
304 * as appropriate for pairwise / private memory segments
306 rp = vl_msg_api_alloc (sizeof (*rp));
307 rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE_REPLY);
308 rp->handle = mp->handle;
311 vl_msg_api_send_shmem (regp->vl_input_queue, (u8 *) & rp);
312 if (client_index != regp->vl_api_registration_pool_index)
314 clib_warning ("mismatch client_index %d pool_index %d",
316 regp->vl_api_registration_pool_index);
317 vl_msg_api_free (rp);
322 /* For horizontal scaling, add a hash table... */
323 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
325 /* Is this a pairwise / private API segment? */
326 if (am->vlib_private_rps[i] == svm)
328 /* Note: account for the memfd header page */
329 uword virtual_base = svm->virtual_base - MMAP_PAGESIZE;
330 uword virtual_size = svm->virtual_size + MMAP_PAGESIZE;
333 * Kill the registration pool element before we make
334 * the index vanish forever
336 pool_put_index (am->vl_clients,
337 regp->vl_api_registration_pool_index);
339 vec_delete (am->vlib_private_rps, 1, i);
340 /* Kill it, accounting for the memfd header page */
341 if (munmap ((void *) virtual_base, virtual_size) < 0)
342 clib_unix_warning ("munmap");
343 /* Reset the queue-length-address cache */
344 vec_reset_length (vl_api_queue_cursizes);
345 private_registration = 1;
350 /* No dangling references, please */
353 if (private_registration == 0)
355 pool_put_index (am->vl_clients,
356 regp->vl_api_registration_pool_index);
357 pthread_mutex_lock (&svm->mutex);
358 oldheap = svm_push_data_heap (svm);
360 svm_queue_free (regp->vl_input_queue);
361 vec_free (regp->name);
362 /* Poison the old registration */
363 clib_memset (regp, 0xF1, sizeof (*regp));
364 clib_mem_free (regp);
365 pthread_mutex_unlock (&svm->mutex);
366 svm_pop_heap (oldheap);
368 * These messages must be freed manually, since they're set up
369 * as "bounce" messages. In the private_registration == 1 case,
370 * we kill the shared-memory segment which contains the message
373 vl_msg_api_free (mp);
378 clib_warning ("unknown client ID %d", mp->index);
383 * client answered a ping, stave off the grim reaper...
386 vl_api_memclnt_keepalive_reply_t_handler
387 (vl_api_memclnt_keepalive_reply_t * mp)
389 vl_api_registration_t *regp;
390 vlib_main_t *vm = vlib_get_main ();
392 regp = vl_api_client_index_to_registration (mp->context);
395 regp->last_heard = vlib_time_now (vm);
396 regp->unanswered_pings = 0;
399 clib_warning ("BUG: anonymous memclnt_keepalive_reply");
403 * We can send ourselves these messages if someone uses the
404 * builtin binary api test tool...
407 vl_api_memclnt_keepalive_t_handler (vl_api_memclnt_keepalive_t * mp)
409 vl_api_memclnt_keepalive_reply_t *rmp;
411 vl_shmem_hdr_t *shmem_hdr;
414 shmem_hdr = am->shmem_hdr;
416 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
417 clib_memset (rmp, 0, sizeof (*rmp));
418 rmp->_vl_msg_id = ntohs (VL_API_MEMCLNT_KEEPALIVE_REPLY);
419 rmp->context = mp->context;
420 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & rmp);
423 #define foreach_vlib_api_msg \
424 _(MEMCLNT_CREATE, memclnt_create) \
425 _(MEMCLNT_DELETE, memclnt_delete) \
426 _(MEMCLNT_KEEPALIVE, memclnt_keepalive) \
427 _(MEMCLNT_KEEPALIVE_REPLY, memclnt_keepalive_reply) \
433 vl_mem_api_init (const char *region_name)
436 api_main_t *am = &api_main;
437 vl_msg_api_msg_config_t cfg;
438 vl_msg_api_msg_config_t *c = &cfg;
440 vlib_main_t *vm = vlib_get_main ();
442 clib_memset (c, 0, sizeof (*c));
444 if ((rv = vl_map_shmem (region_name, 1 /* is_vlib */ )) < 0)
447 #define _(N,n) do { \
448 c->id = VL_API_##N; \
450 c->handler = vl_api_##n##_t_handler; \
451 c->cleanup = vl_noop_handler; \
452 c->endian = vl_api_##n##_t_endian; \
453 c->print = vl_api_##n##_t_print; \
454 c->size = sizeof(vl_api_##n##_t); \
455 c->traced = 1; /* trace, so these msgs print */ \
456 c->replay = 0; /* don't replay client create/delete msgs */ \
457 c->message_bounce = 0; /* don't bounce this message */ \
458 vl_msg_api_config(c);} while (0);
460 foreach_vlib_api_msg;
464 * special-case freeing of memclnt_delete messages, so we can
465 * simply munmap pairwise / private API segments...
467 am->message_bounce[VL_API_MEMCLNT_DELETE] = 1;
468 am->is_mp_safe[VL_API_MEMCLNT_KEEPALIVE_REPLY] = 1;
470 vlib_set_queue_signal_callback (vm, memclnt_queue_callback);
473 ASSERT (shm && shm->vl_input_queue);
475 /* Make a note so we can always find the primary region easily */
476 am->vlib_primary_rp = am->vlib_rp;
482 map_api_segment_init (vlib_main_t * vm)
484 api_main_t *am = &api_main;
487 if ((rv = vl_mem_api_init (am->region_name)) < 0)
489 return clib_error_return (0, "vl_mem_api_init (%s) failed",
496 send_memclnt_keepalive (vl_api_registration_t * regp, f64 now)
498 vl_api_memclnt_keepalive_t *mp;
500 api_main_t *am = &api_main;
501 svm_region_t *save_vlib_rp = am->vlib_rp;
502 vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
504 q = regp->vl_input_queue;
507 * If the queue head is moving, assume that the client is processing
508 * messages and skip the ping. This heuristic may fail if the queue
509 * is in the same position as last time, net of wrapping; in which
510 * case, the client will receive a keepalive.
512 if (regp->last_queue_head != q->head)
514 regp->last_heard = now;
515 regp->unanswered_pings = 0;
516 regp->last_queue_head = q->head;
521 * push/pop shared memory segment, so this routine
522 * will work with "normal" as well as "private segment"
526 am->vlib_rp = regp->vlib_rp;
527 am->shmem_hdr = regp->shmem_hdr;
529 mp = vl_msg_api_alloc (sizeof (*mp));
530 clib_memset (mp, 0, sizeof (*mp));
531 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MEMCLNT_KEEPALIVE);
532 mp->context = mp->client_index =
533 vl_msg_api_handle_from_index_and_epoch
534 (regp->vl_api_registration_pool_index,
535 am->shmem_hdr->application_restarts);
537 regp->unanswered_pings++;
539 /* Failure-to-send due to a stuffed queue is absolutely expected */
540 if (svm_queue_add (q, (u8 *) & mp, 1 /* nowait */ ))
541 vl_msg_api_free (mp);
543 am->vlib_rp = save_vlib_rp;
544 am->shmem_hdr = save_shmem_hdr;
548 vl_mem_send_client_keepalive_w_reg (api_main_t * am, f64 now,
549 vl_api_registration_t ** regpp,
551 u32 ** confused_indices)
553 vl_api_registration_t *regp = *regpp;
556 /* If we haven't heard from this client recently... */
557 if (regp->last_heard < (now - 10.0))
559 if (regp->unanswered_pings == 2)
562 q = regp->vl_input_queue;
563 if (kill (q->consumer_pid, 0) >= 0)
565 clib_warning ("REAPER: lazy binary API client '%s'",
567 regp->unanswered_pings = 0;
568 regp->last_heard = now;
572 clib_warning ("REAPER: binary API client '%s' died",
574 vec_add1 (*dead_indices, regpp - am->vl_clients);
578 send_memclnt_keepalive (regp, now);
581 regp->unanswered_pings = 0;
585 clib_warning ("NULL client registration index %d",
586 regpp - am->vl_clients);
587 vec_add1 (*confused_indices, regpp - am->vl_clients);
592 vl_mem_api_dead_client_scan (api_main_t * am, vl_shmem_hdr_t * shm, f64 now)
594 vl_api_registration_t **regpp;
595 static u32 *dead_indices;
596 static u32 *confused_indices;
598 vec_reset_length (dead_indices);
599 vec_reset_length (confused_indices);
602 pool_foreach (regpp, am->vl_clients, ({
603 vl_mem_send_client_keepalive_w_reg (am, now, regpp, &dead_indices,
608 /* This should "never happen," but if it does, fix it... */
609 if (PREDICT_FALSE (vec_len (confused_indices) > 0))
612 for (i = 0; i < vec_len (confused_indices); i++)
614 pool_put_index (am->vl_clients, confused_indices[i]);
618 if (PREDICT_FALSE (vec_len (dead_indices) > 0))
624 /* Allow the application to clean up its registrations */
625 for (i = 0; i < vec_len (dead_indices); i++)
627 regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
632 handle = vl_msg_api_handle_from_index_and_epoch
633 (dead_indices[i], shm->application_restarts);
634 (void) vl_api_call_reaper_functions (handle);
639 pthread_mutex_lock (&svm->mutex);
640 oldheap = svm_push_data_heap (svm);
642 for (i = 0; i < vec_len (dead_indices); i++)
644 regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
647 /* Is this a pairwise SVM segment? */
648 if ((*regpp)->vlib_rp != svm)
651 svm_region_t *dead_rp = (*regpp)->vlib_rp;
652 /* Note: account for the memfd header page */
653 uword virtual_base = dead_rp->virtual_base - MMAP_PAGESIZE;
654 uword virtual_size = dead_rp->virtual_size + MMAP_PAGESIZE;
656 /* For horizontal scaling, add a hash table... */
657 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
658 if (am->vlib_private_rps[i] == dead_rp)
660 vec_delete (am->vlib_private_rps, 1, i);
663 clib_warning ("private rp %llx AWOL", dead_rp);
666 /* Kill it, accounting for the memfd header page */
667 if (munmap ((void *) virtual_base, virtual_size) < 0)
668 clib_unix_warning ("munmap");
669 /* Reset the queue-length-address cache */
670 vec_reset_length (vl_api_queue_cursizes);
674 /* Poison the old registration */
675 clib_memset (*regpp, 0xF3, sizeof (**regpp));
676 clib_mem_free (*regpp);
678 /* no dangling references, please */
683 svm_pop_heap (oldheap);
684 clib_warning ("Duplicate free, client index %d",
685 regpp - am->vl_clients);
686 oldheap = svm_push_data_heap (svm);
690 svm_client_scan_this_region_nolock (am->vlib_rp);
692 pthread_mutex_unlock (&svm->mutex);
693 svm_pop_heap (oldheap);
694 for (i = 0; i < vec_len (dead_indices); i++)
695 pool_put_index (am->vl_clients, dead_indices[i]);
700 void_mem_api_handle_msg_i (api_main_t * am, vlib_main_t * vm,
701 vlib_node_runtime_t * node, svm_queue_t * q)
704 if (!svm_queue_sub2 (q, (u8 *) & mp))
706 vl_msg_api_handler_with_vm_node (am, (void *) mp, vm, node);
713 vl_mem_api_handle_msg_main (vlib_main_t * vm, vlib_node_runtime_t * node)
715 api_main_t *am = &api_main;
716 return void_mem_api_handle_msg_i (am, vm, node,
717 am->shmem_hdr->vl_input_queue);
721 vl_mem_api_handle_rpc (vlib_main_t * vm, vlib_node_runtime_t * node)
723 api_main_t *am = &api_main;
728 * Swap pending and processing vectors, then process the RPCs
729 * Avoid deadlock conditions by construction.
731 clib_spinlock_lock_if_init (&vm->pending_rpc_lock);
732 tmp = vm->processing_rpc_requests;
733 vec_reset_length (tmp);
734 vm->processing_rpc_requests = vm->pending_rpc_requests;
735 vm->pending_rpc_requests = tmp;
736 clib_spinlock_unlock_if_init (&vm->pending_rpc_lock);
739 * RPCs are used to reflect function calls to thread 0
740 * when the underlying code is not thread-safe.
742 * Grabbing the thread barrier across a set of RPCs
743 * greatly increases efficiency, and avoids
744 * running afoul of the barrier sync holddown timer.
745 * The barrier sync code supports recursive locking.
747 * We really need to rewrite RPC-based code...
749 if (PREDICT_TRUE (vec_len (vm->processing_rpc_requests)))
751 vl_msg_api_barrier_sync ();
752 for (i = 0; i < vec_len (vm->processing_rpc_requests); i++)
754 mp = vm->processing_rpc_requests[i];
755 vl_msg_api_handler_with_vm_node (am, (void *) mp, vm, node);
757 vl_msg_api_barrier_release ();
764 vl_mem_api_handle_msg_private (vlib_main_t * vm, vlib_node_runtime_t * node,
767 api_main_t *am = &api_main;
768 vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
769 svm_region_t *vlib_rp, *save_vlib_rp = am->vlib_rp;
773 vlib_rp = am->vlib_rp = am->vlib_private_rps[reg_index];
775 am->shmem_hdr = (void *) vlib_rp->user_ctx;
776 q = am->shmem_hdr->vl_input_queue;
778 rv = void_mem_api_handle_msg_i (am, vm, node, q);
780 am->shmem_hdr = save_shmem_hdr;
781 am->vlib_rp = save_vlib_rp;
786 vl_api_registration_t *
787 vl_mem_api_client_index_to_registration (u32 handle)
789 vl_api_registration_t **regpp;
790 vl_api_registration_t *regp;
791 api_main_t *am = &api_main;
792 vl_shmem_hdr_t *shmem_hdr;
795 index = vl_msg_api_handle_get_index (handle);
796 regpp = am->vl_clients + index;
798 if (pool_is_free (am->vl_clients, regpp))
800 vl_msg_api_increment_missing_client_counter ();
805 shmem_hdr = (vl_shmem_hdr_t *) regp->shmem_hdr;
806 if (!vl_msg_api_handle_is_valid (handle, shmem_hdr->application_restarts))
808 vl_msg_api_increment_missing_client_counter ();
816 vl_api_client_index_to_input_queue (u32 index)
818 vl_api_registration_t *regp;
819 api_main_t *am = &api_main;
821 /* Special case: vlib trying to send itself a message */
822 if (index == (u32) ~ 0)
823 return (am->shmem_hdr->vl_input_queue);
825 regp = vl_mem_api_client_index_to_registration (index);
828 return (regp->vl_input_queue);
831 static clib_error_t *
832 setup_memclnt_exit (vlib_main_t * vm)
834 atexit (vl_unmap_shmem);
838 VLIB_INIT_FUNCTION (setup_memclnt_exit);
841 format_api_message_rings (u8 * s, va_list * args)
843 api_main_t *am = va_arg (*args, api_main_t *);
844 vl_shmem_hdr_t *shmem_hdr = va_arg (*args, vl_shmem_hdr_t *);
845 int main_segment = va_arg (*args, int);
850 return format (s, "%8s %8s %8s %8s %8s\n",
851 "Owner", "Size", "Nitems", "Hits", "Misses");
853 ap = shmem_hdr->vl_rings;
855 for (i = 0; i < vec_len (shmem_hdr->vl_rings); i++)
857 s = format (s, "%8s %8d %8d %8d %8d\n",
858 "vlib", ap->size, ap->nitems, ap->hits, ap->misses);
862 ap = shmem_hdr->client_rings;
864 for (i = 0; i < vec_len (shmem_hdr->client_rings); i++)
866 s = format (s, "%8s %8d %8d %8d %8d\n",
867 "clnt", ap->size, ap->nitems, ap->hits, ap->misses);
873 s = format (s, "%d ring miss fallback allocations\n", am->ring_misses);
876 "%d application restarts, %d reclaimed msgs, %d garbage collects\n",
877 shmem_hdr->application_restarts, shmem_hdr->restart_reclaims,
878 shmem_hdr->garbage_collects);
883 static clib_error_t *
884 vl_api_ring_command (vlib_main_t * vm,
885 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
888 vl_shmem_hdr_t *shmem_hdr;
889 api_main_t *am = &api_main;
891 /* First, dump the primary region rings.. */
893 if (am->vlib_primary_rp == 0 || am->vlib_primary_rp->user_ctx == 0)
895 vlib_cli_output (vm, "Shared memory segment not initialized...\n");
899 shmem_hdr = (void *) am->vlib_primary_rp->user_ctx;
901 vlib_cli_output (vm, "Main API segment rings:");
903 vlib_cli_output (vm, "%U", format_api_message_rings, am,
904 0 /* print header */ , 0 /* notused */ );
906 vlib_cli_output (vm, "%U", format_api_message_rings, am,
907 shmem_hdr, 1 /* main segment */ );
909 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
911 svm_region_t *vlib_rp = am->vlib_private_rps[i];
912 shmem_hdr = (void *) vlib_rp->user_ctx;
913 vl_api_registration_t **regpp;
914 vl_api_registration_t *regp = 0;
916 /* For horizontal scaling, add a hash table... */
918 pool_foreach (regpp, am->vl_clients,
921 if (regp && regp->vlib_rp == vlib_rp)
923 vlib_cli_output (vm, "%s segment rings:", regp->name);
927 vlib_cli_output (vm, "regp %llx not found?", regp);
931 vlib_cli_output (vm, "%U", format_api_message_rings, am,
932 0 /* print header */ , 0 /* notused */ );
933 vlib_cli_output (vm, "%U", format_api_message_rings, am,
934 shmem_hdr, 0 /* main segment */ );
941 * Display binary api message allocation ring statistics
944 VLIB_CLI_COMMAND (cli_show_api_ring_command, static) =
946 .path = "show api ring-stats",
947 .short_help = "Message ring statistics",
948 .function = vl_api_ring_command,
953 vlibmemory_init (vlib_main_t * vm)
955 api_main_t *am = &api_main;
956 svm_map_region_args_t _a, *a = &_a;
958 u8 *remove_path1, *remove_path2;
961 * By popular request / to avoid support fires, remove any old api segment
964 if (am->root_path == 0)
966 remove_path1 = format (0, "/dev/shm/global_vm%c", 0);
967 remove_path2 = format (0, "/dev/shm/vpe-api%c", 0);
971 remove_path1 = format (0, "/dev/shm/%s-global_vm%c", am->root_path, 0);
972 remove_path2 = format (0, "/dev/shm/%s-vpe-api%c", am->root_path, 0);
975 (void) unlink ((char *) remove_path1);
976 (void) unlink ((char *) remove_path2);
978 vec_free (remove_path1);
979 vec_free (remove_path2);
981 clib_memset (a, 0, sizeof (*a));
982 a->root_path = am->root_path;
983 a->name = SVM_GLOBAL_REGION_NAME;
984 a->baseva = (am->global_baseva != 0) ?
985 am->global_baseva : +svm_get_global_region_base_va ();
986 a->size = (am->global_size != 0) ? am->global_size : SVM_GLOBAL_REGION_SIZE;
987 a->flags = SVM_FLAGS_NODATA;
988 a->uid = am->api_uid;
989 a->gid = am->api_gid;
991 (am->global_pvt_heap_size !=
992 0) ? am->global_pvt_heap_size : SVM_PVT_MHEAP_SIZE;
994 svm_region_init_args (a);
996 error = vlib_call_init_function (vm, vlibsocket_init);
1002 vl_set_memory_region_name (const char *name)
1004 api_main_t *am = &api_main;
1005 am->region_name = name;
1009 * fd.io coding-style-patch-verification: ON
1012 * eval: (c-set-style "gnu")