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;
300 * Note: the API message handling path will set am->vlib_rp
301 * as appropriate for pairwise / private memory segments
303 rp = vl_msg_api_alloc (sizeof (*rp));
304 rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE_REPLY);
305 rp->handle = mp->handle;
308 vl_msg_api_send_shmem (regp->vl_input_queue, (u8 *) & rp);
310 if (client_index != regp->vl_api_registration_pool_index)
312 clib_warning ("mismatch client_index %d pool_index %d",
313 client_index, regp->vl_api_registration_pool_index);
314 vl_msg_api_free (rp);
318 /* For horizontal scaling, add a hash table... */
319 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
321 /* Is this a pairwise / private API segment? */
322 if (am->vlib_private_rps[i] == svm)
324 /* Note: account for the memfd header page */
325 u64 virtual_base = svm->virtual_base - MMAP_PAGESIZE;
326 u64 virtual_size = svm->virtual_size + MMAP_PAGESIZE;
329 * Kill the registration pool element before we make
330 * the index vanish forever
332 pool_put_index (am->vl_clients,
333 regp->vl_api_registration_pool_index);
335 vec_delete (am->vlib_private_rps, 1, i);
336 /* Kill it, accounting for the memfd header page */
337 if (munmap ((void *) virtual_base, virtual_size) < 0)
338 clib_unix_warning ("munmap");
339 /* Reset the queue-length-address cache */
340 vec_reset_length (vl_api_queue_cursizes);
341 private_registration = 1;
346 /* No dangling references, please */
349 if (private_registration == 0)
351 pool_put_index (am->vl_clients,
352 regp->vl_api_registration_pool_index);
353 pthread_mutex_lock (&svm->mutex);
354 oldheap = svm_push_data_heap (svm);
355 vec_free (regp->name);
356 /* Poison the old registration */
357 clib_memset (regp, 0xF1, sizeof (*regp));
358 clib_mem_free (regp);
359 pthread_mutex_unlock (&svm->mutex);
360 svm_pop_heap (oldheap);
362 * These messages must be freed manually, since they're set up
363 * as "bounce" messages. In the private_registration == 1 case,
364 * we kill the shared-memory segment which contains the message
367 vl_msg_api_free (mp);
372 clib_warning ("unknown client ID %d", mp->index);
377 * client answered a ping, stave off the grim reaper...
380 vl_api_memclnt_keepalive_reply_t_handler
381 (vl_api_memclnt_keepalive_reply_t * mp)
383 vl_api_registration_t *regp;
384 vlib_main_t *vm = vlib_get_main ();
386 regp = vl_api_client_index_to_registration (mp->context);
389 regp->last_heard = vlib_time_now (vm);
390 regp->unanswered_pings = 0;
393 clib_warning ("BUG: anonymous memclnt_keepalive_reply");
397 * We can send ourselves these messages if someone uses the
398 * builtin binary api test tool...
401 vl_api_memclnt_keepalive_t_handler (vl_api_memclnt_keepalive_t * mp)
403 vl_api_memclnt_keepalive_reply_t *rmp;
405 vl_shmem_hdr_t *shmem_hdr;
408 shmem_hdr = am->shmem_hdr;
410 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
411 clib_memset (rmp, 0, sizeof (*rmp));
412 rmp->_vl_msg_id = ntohs (VL_API_MEMCLNT_KEEPALIVE_REPLY);
413 rmp->context = mp->context;
414 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & rmp);
417 #define foreach_vlib_api_msg \
418 _(MEMCLNT_CREATE, memclnt_create) \
419 _(MEMCLNT_DELETE, memclnt_delete) \
420 _(MEMCLNT_KEEPALIVE, memclnt_keepalive) \
421 _(MEMCLNT_KEEPALIVE_REPLY, memclnt_keepalive_reply) \
427 vl_mem_api_init (const char *region_name)
430 api_main_t *am = &api_main;
431 vl_msg_api_msg_config_t cfg;
432 vl_msg_api_msg_config_t *c = &cfg;
434 vlib_main_t *vm = vlib_get_main ();
436 clib_memset (c, 0, sizeof (*c));
438 if ((rv = vl_map_shmem (region_name, 1 /* is_vlib */ )) < 0)
441 #define _(N,n) do { \
442 c->id = VL_API_##N; \
444 c->handler = vl_api_##n##_t_handler; \
445 c->cleanup = vl_noop_handler; \
446 c->endian = vl_api_##n##_t_endian; \
447 c->print = vl_api_##n##_t_print; \
448 c->size = sizeof(vl_api_##n##_t); \
449 c->traced = 1; /* trace, so these msgs print */ \
450 c->replay = 0; /* don't replay client create/delete msgs */ \
451 c->message_bounce = 0; /* don't bounce this message */ \
452 vl_msg_api_config(c);} while (0);
454 foreach_vlib_api_msg;
458 * special-case freeing of memclnt_delete messages, so we can
459 * simply munmap pairwise / private API segments...
461 am->message_bounce[VL_API_MEMCLNT_DELETE] = 1;
462 am->is_mp_safe[VL_API_MEMCLNT_KEEPALIVE_REPLY] = 1;
464 vlib_set_queue_signal_callback (vm, memclnt_queue_callback);
467 ASSERT (shm && shm->vl_input_queue);
469 /* Make a note so we can always find the primary region easily */
470 am->vlib_primary_rp = am->vlib_rp;
476 map_api_segment_init (vlib_main_t * vm)
478 api_main_t *am = &api_main;
481 if ((rv = vl_mem_api_init (am->region_name)) < 0)
483 return clib_error_return (0, "vl_mem_api_init (%s) failed",
490 send_memclnt_keepalive (vl_api_registration_t * regp, f64 now)
492 vl_api_memclnt_keepalive_t *mp;
494 api_main_t *am = &api_main;
495 svm_region_t *save_vlib_rp = am->vlib_rp;
496 vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
498 q = regp->vl_input_queue;
501 * If the queue head is moving, assume that the client is processing
502 * messages and skip the ping. This heuristic may fail if the queue
503 * is in the same position as last time, net of wrapping; in which
504 * case, the client will receive a keepalive.
506 if (regp->last_queue_head != q->head)
508 regp->last_heard = now;
509 regp->unanswered_pings = 0;
510 regp->last_queue_head = q->head;
515 * push/pop shared memory segment, so this routine
516 * will work with "normal" as well as "private segment"
520 am->vlib_rp = regp->vlib_rp;
521 am->shmem_hdr = regp->shmem_hdr;
523 mp = vl_msg_api_alloc (sizeof (*mp));
524 clib_memset (mp, 0, sizeof (*mp));
525 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MEMCLNT_KEEPALIVE);
526 mp->context = mp->client_index =
527 vl_msg_api_handle_from_index_and_epoch
528 (regp->vl_api_registration_pool_index,
529 am->shmem_hdr->application_restarts);
531 regp->unanswered_pings++;
533 /* Failure-to-send due to a stuffed queue is absolutely expected */
534 if (svm_queue_add (q, (u8 *) & mp, 1 /* nowait */ ))
535 vl_msg_api_free (mp);
537 am->vlib_rp = save_vlib_rp;
538 am->shmem_hdr = save_shmem_hdr;
542 vl_mem_send_client_keepalive_w_reg (api_main_t * am, f64 now,
543 vl_api_registration_t ** regpp,
545 u32 ** confused_indices)
547 vl_api_registration_t *regp = *regpp;
550 /* If we haven't heard from this client recently... */
551 if (regp->last_heard < (now - 10.0))
553 if (regp->unanswered_pings == 2)
556 q = regp->vl_input_queue;
557 if (kill (q->consumer_pid, 0) >= 0)
559 clib_warning ("REAPER: lazy binary API client '%s'",
561 regp->unanswered_pings = 0;
562 regp->last_heard = now;
566 clib_warning ("REAPER: binary API client '%s' died",
568 vec_add1 (*dead_indices, regpp - am->vl_clients);
572 send_memclnt_keepalive (regp, now);
575 regp->unanswered_pings = 0;
579 clib_warning ("NULL client registration index %d",
580 regpp - am->vl_clients);
581 vec_add1 (*confused_indices, regpp - am->vl_clients);
586 vl_mem_api_dead_client_scan (api_main_t * am, vl_shmem_hdr_t * shm, f64 now)
588 vl_api_registration_t **regpp;
589 static u32 *dead_indices;
590 static u32 *confused_indices;
592 vec_reset_length (dead_indices);
593 vec_reset_length (confused_indices);
596 pool_foreach (regpp, am->vl_clients, ({
597 vl_mem_send_client_keepalive_w_reg (am, now, regpp, &dead_indices,
602 /* This should "never happen," but if it does, fix it... */
603 if (PREDICT_FALSE (vec_len (confused_indices) > 0))
606 for (i = 0; i < vec_len (confused_indices); i++)
608 pool_put_index (am->vl_clients, confused_indices[i]);
612 if (PREDICT_FALSE (vec_len (dead_indices) > 0))
618 /* Allow the application to clean up its registrations */
619 for (i = 0; i < vec_len (dead_indices); i++)
621 regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
626 handle = vl_msg_api_handle_from_index_and_epoch
627 (dead_indices[i], shm->application_restarts);
628 (void) vl_api_call_reaper_functions (handle);
633 pthread_mutex_lock (&svm->mutex);
634 oldheap = svm_push_data_heap (svm);
636 for (i = 0; i < vec_len (dead_indices); i++)
638 regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
641 /* Is this a pairwise SVM segment? */
642 if ((*regpp)->vlib_rp != svm)
645 svm_region_t *dead_rp = (*regpp)->vlib_rp;
646 /* Note: account for the memfd header page */
647 u64 virtual_base = dead_rp->virtual_base - MMAP_PAGESIZE;
648 u64 virtual_size = dead_rp->virtual_size + MMAP_PAGESIZE;
650 /* For horizontal scaling, add a hash table... */
651 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
652 if (am->vlib_private_rps[i] == dead_rp)
654 vec_delete (am->vlib_private_rps, 1, i);
657 clib_warning ("private rp %llx AWOL", dead_rp);
660 /* Kill it, accounting for the memfd header page */
661 if (munmap ((void *) virtual_base, virtual_size) < 0)
662 clib_unix_warning ("munmap");
663 /* Reset the queue-length-address cache */
664 vec_reset_length (vl_api_queue_cursizes);
668 /* Poison the old registration */
669 clib_memset (*regpp, 0xF3, sizeof (**regpp));
670 clib_mem_free (*regpp);
672 /* no dangling references, please */
677 svm_pop_heap (oldheap);
678 clib_warning ("Duplicate free, client index %d",
679 regpp - am->vl_clients);
680 oldheap = svm_push_data_heap (svm);
684 svm_client_scan_this_region_nolock (am->vlib_rp);
686 pthread_mutex_unlock (&svm->mutex);
687 svm_pop_heap (oldheap);
688 for (i = 0; i < vec_len (dead_indices); i++)
689 pool_put_index (am->vl_clients, dead_indices[i]);
694 void_mem_api_handle_msg_i (api_main_t * am, vlib_main_t * vm,
695 vlib_node_runtime_t * node, svm_queue_t * q)
698 if (!svm_queue_sub2 (q, (u8 *) & mp))
700 vl_msg_api_handler_with_vm_node (am, (void *) mp, vm, node);
707 vl_mem_api_handle_msg_main (vlib_main_t * vm, vlib_node_runtime_t * node)
709 api_main_t *am = &api_main;
710 return void_mem_api_handle_msg_i (am, vm, node,
711 am->shmem_hdr->vl_input_queue);
715 vl_mem_api_handle_rpc (vlib_main_t * vm, vlib_node_runtime_t * node)
717 api_main_t *am = &api_main;
722 * Swap pending and processing vectors, then process the RPCs
723 * Avoid deadlock conditions by construction.
725 clib_spinlock_lock_if_init (&vm->pending_rpc_lock);
726 tmp = vm->processing_rpc_requests;
727 vec_reset_length (tmp);
728 vm->processing_rpc_requests = vm->pending_rpc_requests;
729 vm->pending_rpc_requests = tmp;
730 clib_spinlock_unlock_if_init (&vm->pending_rpc_lock);
732 for (i = 0; i < vec_len (vm->processing_rpc_requests); i++)
734 mp = vm->processing_rpc_requests[i];
735 vl_msg_api_handler_with_vm_node (am, (void *) mp, vm, node);
741 vl_mem_api_handle_msg_private (vlib_main_t * vm, vlib_node_runtime_t * node,
744 api_main_t *am = &api_main;
745 vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
746 svm_region_t *vlib_rp, *save_vlib_rp = am->vlib_rp;
750 vlib_rp = am->vlib_rp = am->vlib_private_rps[reg_index];
752 am->shmem_hdr = (void *) vlib_rp->user_ctx;
753 q = am->shmem_hdr->vl_input_queue;
755 rv = void_mem_api_handle_msg_i (am, vm, node, q);
757 am->shmem_hdr = save_shmem_hdr;
758 am->vlib_rp = save_vlib_rp;
763 vl_api_registration_t *
764 vl_mem_api_client_index_to_registration (u32 handle)
766 vl_api_registration_t **regpp;
767 vl_api_registration_t *regp;
768 api_main_t *am = &api_main;
769 vl_shmem_hdr_t *shmem_hdr;
772 index = vl_msg_api_handle_get_index (handle);
773 regpp = am->vl_clients + index;
775 if (pool_is_free (am->vl_clients, regpp))
777 vl_msg_api_increment_missing_client_counter ();
782 shmem_hdr = (vl_shmem_hdr_t *) regp->shmem_hdr;
783 if (!vl_msg_api_handle_is_valid (handle, shmem_hdr->application_restarts))
785 vl_msg_api_increment_missing_client_counter ();
793 vl_api_client_index_to_input_queue (u32 index)
795 vl_api_registration_t *regp;
796 api_main_t *am = &api_main;
798 /* Special case: vlib trying to send itself a message */
799 if (index == (u32) ~ 0)
800 return (am->shmem_hdr->vl_input_queue);
802 regp = vl_mem_api_client_index_to_registration (index);
805 return (regp->vl_input_queue);
808 static clib_error_t *
809 setup_memclnt_exit (vlib_main_t * vm)
811 atexit (vl_unmap_shmem);
815 VLIB_INIT_FUNCTION (setup_memclnt_exit);
818 format_api_message_rings (u8 * s, va_list * args)
820 api_main_t *am = va_arg (*args, api_main_t *);
821 vl_shmem_hdr_t *shmem_hdr = va_arg (*args, vl_shmem_hdr_t *);
822 int main_segment = va_arg (*args, int);
827 return format (s, "%8s %8s %8s %8s %8s\n",
828 "Owner", "Size", "Nitems", "Hits", "Misses");
830 ap = shmem_hdr->vl_rings;
832 for (i = 0; i < vec_len (shmem_hdr->vl_rings); i++)
834 s = format (s, "%8s %8d %8d %8d %8d\n",
835 "vlib", ap->size, ap->nitems, ap->hits, ap->misses);
839 ap = shmem_hdr->client_rings;
841 for (i = 0; i < vec_len (shmem_hdr->client_rings); i++)
843 s = format (s, "%8s %8d %8d %8d %8d\n",
844 "clnt", ap->size, ap->nitems, ap->hits, ap->misses);
850 s = format (s, "%d ring miss fallback allocations\n", am->ring_misses);
853 "%d application restarts, %d reclaimed msgs, %d garbage collects\n",
854 shmem_hdr->application_restarts, shmem_hdr->restart_reclaims,
855 shmem_hdr->garbage_collects);
860 static clib_error_t *
861 vl_api_ring_command (vlib_main_t * vm,
862 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
865 vl_shmem_hdr_t *shmem_hdr;
866 api_main_t *am = &api_main;
868 /* First, dump the primary region rings.. */
870 if (am->vlib_primary_rp == 0 || am->vlib_primary_rp->user_ctx == 0)
872 vlib_cli_output (vm, "Shared memory segment not initialized...\n");
876 shmem_hdr = (void *) am->vlib_primary_rp->user_ctx;
878 vlib_cli_output (vm, "Main API segment rings:");
880 vlib_cli_output (vm, "%U", format_api_message_rings, am,
881 0 /* print header */ , 0 /* notused */ );
883 vlib_cli_output (vm, "%U", format_api_message_rings, am,
884 shmem_hdr, 1 /* main segment */ );
886 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
888 svm_region_t *vlib_rp = am->vlib_private_rps[i];
889 shmem_hdr = (void *) vlib_rp->user_ctx;
890 vl_api_registration_t **regpp;
891 vl_api_registration_t *regp = 0;
893 /* For horizontal scaling, add a hash table... */
895 pool_foreach (regpp, am->vl_clients,
898 if (regp && regp->vlib_rp == vlib_rp)
900 vlib_cli_output (vm, "%s segment rings:", regp->name);
904 vlib_cli_output (vm, "regp %llx not found?", regp);
908 vlib_cli_output (vm, "%U", format_api_message_rings, am,
909 0 /* print header */ , 0 /* notused */ );
910 vlib_cli_output (vm, "%U", format_api_message_rings, am,
911 shmem_hdr, 0 /* main segment */ );
918 * Display binary api message allocation ring statistics
921 VLIB_CLI_COMMAND (cli_show_api_ring_command, static) =
923 .path = "show api ring-stats",
924 .short_help = "Message ring statistics",
925 .function = vl_api_ring_command,
930 vlibmemory_init (vlib_main_t * vm)
932 api_main_t *am = &api_main;
933 svm_map_region_args_t _a, *a = &_a;
936 clib_memset (a, 0, sizeof (*a));
937 a->root_path = am->root_path;
938 a->name = SVM_GLOBAL_REGION_NAME;
939 a->baseva = (am->global_baseva != 0) ?
940 am->global_baseva : +svm_get_global_region_base_va ();
941 a->size = (am->global_size != 0) ? am->global_size : SVM_GLOBAL_REGION_SIZE;
942 a->flags = SVM_FLAGS_NODATA;
943 a->uid = am->api_uid;
944 a->gid = am->api_gid;
946 (am->global_pvt_heap_size !=
947 0) ? am->global_pvt_heap_size : SVM_PVT_MHEAP_SIZE;
949 svm_region_init_args (a);
951 error = vlib_call_init_function (vm, vlibsocket_init);
957 vl_set_memory_region_name (const char *name)
959 api_main_t *am = &api_main;
960 am->region_name = name;
964 * fd.io coding-style-patch-verification: ON
967 * eval: (c-set-style "gnu")