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 = vlibapi_get_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;
125 api_main_t *am = vlibapi_get_main ();
127 ASSERT (vlib_get_thread_index () == 0);
128 pool_get (am->vl_clients, regpp);
131 oldheap = vl_msg_push_heap ();
132 *regpp = clib_mem_alloc (sizeof (vl_api_registration_t));
135 clib_memset (regp, 0, sizeof (*regp));
136 regp->registration_type = REGISTRATION_TYPE_SHMEM;
137 regp->vl_api_registration_pool_index = regpp - am->vl_clients;
138 regp->vlib_rp = am->vlib_rp;
139 regp->shmem_hdr = am->shmem_hdr;
141 regp->vl_input_queue = q;
142 regp->name = format (0, "%s%c", name, 0);
144 vl_msg_pop_heap (oldheap);
145 return vl_msg_api_handle_from_index_and_epoch
146 (regp->vl_api_registration_pool_index,
147 am->shmem_hdr->application_restarts);
151 * vl_api_memclnt_create_t_handler
154 vl_api_memclnt_create_t_handler (vl_api_memclnt_create_t * mp)
156 vl_api_registration_t **regpp;
157 vl_api_registration_t *regp;
158 vl_api_memclnt_create_reply_t *rp;
162 api_main_t *am = vlibapi_get_main ();
166 * This is tortured. Maintain a vlib-address-space private
167 * pool of client registrations. We use the shared-memory virtual
168 * address of client structure as a handle, to allow direct
169 * manipulation of context quota vbls from the client library.
171 * This scheme causes trouble w/ API message trace replay, since
172 * some random VA from clib_mem_alloc() certainly won't
173 * occur in the Linux sim. The (very) few places
174 * that care need to use the pool index.
176 * Putting the registration object(s) into a pool in shared memory and
177 * using the pool index as a handle seems like a great idea.
178 * Unfortunately, each and every reference to that pool would need
179 * to be protected by a mutex:
183 * convert pool index to
191 pool_get (am->vl_clients, regpp);
193 oldheap = vl_msg_push_heap ();
194 *regpp = clib_mem_alloc (sizeof (vl_api_registration_t));
197 clib_memset (regp, 0, sizeof (*regp));
198 regp->registration_type = REGISTRATION_TYPE_SHMEM;
199 regp->vl_api_registration_pool_index = regpp - am->vl_clients;
200 regp->vlib_rp = am->vlib_rp;
201 regp->shmem_hdr = am->shmem_hdr;
202 regp->clib_file_index = am->shmem_hdr->clib_file_index;
204 q = regp->vl_input_queue = (svm_queue_t *) (uword) mp->input_queue;
205 VL_MSG_API_SVM_QUEUE_UNPOISON (q);
207 regp->name = format (0, "%s", mp->name);
208 vec_add1 (regp->name, 0);
210 if (am->serialized_message_table_in_shmem == 0)
211 am->serialized_message_table_in_shmem =
212 vl_api_serialize_message_table (am, 0);
214 if (am->vlib_rp != am->vlib_primary_rp)
215 msg_table = vl_api_serialize_message_table (am, 0);
217 msg_table = am->serialized_message_table_in_shmem;
219 vl_msg_pop_heap (oldheap);
221 rp = vl_msg_api_alloc (sizeof (*rp));
222 rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE_REPLY);
223 rp->handle = (uword) regp;
224 rp->index = vl_msg_api_handle_from_index_and_epoch
225 (regp->vl_api_registration_pool_index,
226 am->shmem_hdr->application_restarts);
227 rp->context = mp->context;
228 rp->response = ntohl (rv);
229 rp->message_table = pointer_to_uword (msg_table);
231 vl_msg_api_send_shmem (q, (u8 *) & rp);
235 vl_api_call_reaper_functions (u32 client_index)
237 clib_error_t *error = 0;
238 _vl_msg_api_function_list_elt_t *i;
240 i = vlibapi_get_main ()->reaper_function_registrations;
243 error = i->f (client_index);
245 clib_error_report (error);
246 i = i->next_init_function;
252 * vl_api_memclnt_delete_t_handler
255 vl_api_memclnt_delete_t_handler (vl_api_memclnt_delete_t * mp)
257 vl_api_registration_t **regpp;
258 vl_api_registration_t *regp;
259 vl_api_memclnt_delete_reply_t *rp;
261 api_main_t *am = vlibapi_get_main ();
262 u32 handle, client_index, epoch;
266 if (vl_api_call_reaper_functions (handle))
269 epoch = vl_msg_api_handle_get_epoch (handle);
270 client_index = vl_msg_api_handle_get_index (handle);
272 if (epoch != (am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK))
275 ("Stale clnt delete index %d old epoch %d cur epoch %d",
277 (am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK));
281 regpp = pool_elt_at_index (am->vl_clients, client_index);
283 if (!pool_is_free (am->vl_clients, regpp))
287 int private_registration = 0;
289 /* Send reply unless client asked us to do the cleanup */
293 * Note: the API message handling path will set am->vlib_rp
294 * as appropriate for pairwise / private memory segments
296 rp = vl_msg_api_alloc (sizeof (*rp));
297 rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE_REPLY);
298 rp->handle = mp->handle;
301 vl_msg_api_send_shmem (regp->vl_input_queue, (u8 *) & rp);
302 if (client_index != regp->vl_api_registration_pool_index)
304 clib_warning ("mismatch client_index %d pool_index %d",
306 regp->vl_api_registration_pool_index);
307 vl_msg_api_free (rp);
312 /* No dangling references, please */
315 /* For horizontal scaling, add a hash table... */
316 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
318 /* Is this a pairwise / private API segment? */
319 if (am->vlib_private_rps[i] == am->vlib_rp)
321 /* Note: account for the memfd header page */
322 uword virtual_base = am->vlib_rp->virtual_base - MMAP_PAGESIZE;
323 uword virtual_size = am->vlib_rp->virtual_size + MMAP_PAGESIZE;
326 * Kill the registration pool element before we make
327 * the index vanish forever
329 pool_put_index (am->vl_clients,
330 regp->vl_api_registration_pool_index);
332 vec_delete (am->vlib_private_rps, 1, i);
333 /* Kill it, accounting for the memfd header page */
334 if (munmap ((void *) virtual_base, virtual_size) < 0)
335 clib_unix_warning ("munmap");
336 /* Reset the queue-length-address cache */
337 vec_reset_length (vl_api_queue_cursizes);
338 private_registration = 1;
343 if (private_registration == 0)
345 pool_put_index (am->vl_clients,
346 regp->vl_api_registration_pool_index);
347 oldheap = vl_msg_push_heap ();
349 svm_queue_free (regp->vl_input_queue);
350 vec_free (regp->name);
351 /* Poison the old registration */
352 clib_memset (regp, 0xF1, sizeof (*regp));
353 clib_mem_free (regp);
354 vl_msg_pop_heap (oldheap);
356 * These messages must be freed manually, since they're set up
357 * as "bounce" messages. In the private_registration == 1 case,
358 * we kill the shared-memory segment which contains the message
361 vl_msg_api_free (mp);
366 clib_warning ("unknown client ID %d", mp->index);
371 * client answered a ping, stave off the grim reaper...
374 vl_api_memclnt_keepalive_reply_t_handler
375 (vl_api_memclnt_keepalive_reply_t * mp)
377 vl_api_registration_t *regp;
378 vlib_main_t *vm = vlib_get_main ();
380 regp = vl_api_client_index_to_registration (mp->context);
383 regp->last_heard = vlib_time_now (vm);
384 regp->unanswered_pings = 0;
387 clib_warning ("BUG: anonymous memclnt_keepalive_reply");
391 * We can send ourselves these messages if someone uses the
392 * builtin binary api test tool...
395 vl_api_memclnt_keepalive_t_handler (vl_api_memclnt_keepalive_t * mp)
397 vl_api_memclnt_keepalive_reply_t *rmp;
399 vl_shmem_hdr_t *shmem_hdr;
401 am = vlibapi_get_main ();
402 shmem_hdr = am->shmem_hdr;
404 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
405 clib_memset (rmp, 0, sizeof (*rmp));
406 rmp->_vl_msg_id = ntohs (VL_API_MEMCLNT_KEEPALIVE_REPLY);
407 rmp->context = mp->context;
408 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & rmp);
412 * To avoid filling the API trace buffer with boring messages,
413 * don't trace memclnt_keepalive[_reply] msgs
416 #define foreach_vlib_api_msg \
417 _(MEMCLNT_CREATE, memclnt_create, 1) \
418 _(MEMCLNT_DELETE, memclnt_delete, 1) \
419 _(MEMCLNT_KEEPALIVE, memclnt_keepalive, 0) \
420 _(MEMCLNT_KEEPALIVE_REPLY, memclnt_keepalive_reply, 0)
426 vl_mem_api_init (const char *region_name)
429 api_main_t *am = vlibapi_get_main ();
430 vl_msg_api_msg_config_t cfg;
431 vl_msg_api_msg_config_t *c = &cfg;
433 vlib_main_t *vm = vlib_get_main ();
435 clib_memset (c, 0, sizeof (*c));
437 if ((rv = vl_map_shmem (region_name, 1 /* is_vlib */ )) < 0)
440 #define _(N,n,t) do { \
441 c->id = VL_API_##N; \
443 c->handler = vl_api_##n##_t_handler; \
444 c->cleanup = vl_noop_handler; \
445 c->endian = vl_api_##n##_t_endian; \
446 c->print = vl_api_##n##_t_print; \
447 c->size = sizeof(vl_api_##n##_t); \
448 c->traced = t; /* trace, so these msgs print */ \
449 c->replay = 0; /* don't replay client create/delete msgs */ \
450 c->message_bounce = 0; /* don't bounce this message */ \
451 vl_msg_api_config(c);} while (0);
453 foreach_vlib_api_msg;
457 * special-case freeing of memclnt_delete messages, so we can
458 * simply munmap pairwise / private API segments...
460 am->message_bounce[VL_API_MEMCLNT_DELETE] = 1;
461 am->is_mp_safe[VL_API_MEMCLNT_KEEPALIVE_REPLY] = 1;
462 am->is_mp_safe[VL_API_MEMCLNT_KEEPALIVE] = 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 = vlibapi_get_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 = vlibapi_get_main ();
496 q = regp->vl_input_queue;
499 * If the queue head is moving, assume that the client is processing
500 * messages and skip the ping. This heuristic may fail if the queue
501 * is in the same position as last time, net of wrapping; in which
502 * case, the client will receive a keepalive.
504 if (regp->last_queue_head != q->head)
506 regp->last_heard = now;
507 regp->unanswered_pings = 0;
508 regp->last_queue_head = q->head;
513 * push/pop shared memory segment, so this routine
514 * will work with "normal" as well as "private segment"
518 mp = vl_mem_api_alloc_as_if_client_w_reg (regp, sizeof (*mp));
519 clib_memset (mp, 0, sizeof (*mp));
520 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MEMCLNT_KEEPALIVE);
521 mp->context = mp->client_index =
522 vl_msg_api_handle_from_index_and_epoch
523 (regp->vl_api_registration_pool_index,
524 am->shmem_hdr->application_restarts);
526 regp->unanswered_pings++;
528 /* Failure-to-send due to a stuffed queue is absolutely expected */
529 if (svm_queue_add (q, (u8 *) & mp, 1 /* nowait */ ))
530 vl_msg_api_free_w_region (regp->vlib_rp, mp);
534 vl_mem_send_client_keepalive_w_reg (api_main_t * am, f64 now,
535 vl_api_registration_t ** regpp,
537 u32 ** confused_indices)
539 vl_api_registration_t *regp = *regpp;
542 /* If we haven't heard from this client recently... */
543 if (regp->last_heard < (now - 10.0))
545 if (regp->unanswered_pings == 2)
548 q = regp->vl_input_queue;
549 if (kill (q->consumer_pid, 0) >= 0)
551 clib_warning ("REAPER: lazy binary API client '%s'",
553 regp->unanswered_pings = 0;
554 regp->last_heard = now;
558 clib_warning ("REAPER: binary API client '%s' died",
560 vec_add1 (*dead_indices, regpp - am->vl_clients);
564 send_memclnt_keepalive (regp, now);
567 regp->unanswered_pings = 0;
571 clib_warning ("NULL client registration index %d",
572 regpp - am->vl_clients);
573 vec_add1 (*confused_indices, regpp - am->vl_clients);
578 vl_mem_api_dead_client_scan (api_main_t * am, vl_shmem_hdr_t * shm, f64 now)
580 vl_api_registration_t **regpp;
581 static u32 *dead_indices;
582 static u32 *confused_indices;
584 vec_reset_length (dead_indices);
585 vec_reset_length (confused_indices);
588 pool_foreach (regpp, am->vl_clients, ({
589 vl_mem_send_client_keepalive_w_reg (am, now, regpp, &dead_indices,
594 /* This should "never happen," but if it does, fix it... */
595 if (PREDICT_FALSE (vec_len (confused_indices) > 0))
598 for (i = 0; i < vec_len (confused_indices); i++)
600 pool_put_index (am->vl_clients, confused_indices[i]);
604 if (PREDICT_FALSE (vec_len (dead_indices) > 0))
609 /* Allow the application to clean up its registrations */
610 for (i = 0; i < vec_len (dead_indices); i++)
612 regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
617 handle = vl_msg_api_handle_from_index_and_epoch
618 (dead_indices[i], shm->application_restarts);
619 (void) vl_api_call_reaper_functions (handle);
623 oldheap = vl_msg_push_heap ();
625 for (i = 0; i < vec_len (dead_indices); i++)
627 regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
630 /* Is this a pairwise SVM segment? */
631 if ((*regpp)->vlib_rp != am->vlib_rp)
634 svm_region_t *dead_rp = (*regpp)->vlib_rp;
635 /* Note: account for the memfd header page */
636 uword virtual_base = dead_rp->virtual_base - MMAP_PAGESIZE;
637 uword virtual_size = dead_rp->virtual_size + MMAP_PAGESIZE;
639 /* For horizontal scaling, add a hash table... */
640 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
641 if (am->vlib_private_rps[i] == dead_rp)
643 vec_delete (am->vlib_private_rps, 1, i);
646 svm_pop_heap (oldheap);
647 clib_warning ("private rp %llx AWOL", dead_rp);
648 oldheap = svm_push_data_heap (am->vlib_rp);
651 /* Kill it, accounting for the memfd header page */
652 svm_pop_heap (oldheap);
653 if (munmap ((void *) virtual_base, virtual_size) < 0)
654 clib_unix_warning ("munmap");
655 /* Reset the queue-length-address cache */
656 vec_reset_length (vl_api_queue_cursizes);
657 oldheap = svm_push_data_heap (am->vlib_rp);
661 /* Poison the old registration */
662 clib_memset (*regpp, 0xF3, sizeof (**regpp));
663 clib_mem_free (*regpp);
665 /* no dangling references, please */
670 svm_pop_heap (oldheap);
671 clib_warning ("Duplicate free, client index %d",
672 regpp - am->vl_clients);
673 oldheap = svm_push_data_heap (am->vlib_rp);
677 svm_client_scan_this_region_nolock (am->vlib_rp);
679 vl_msg_pop_heap (oldheap);
680 for (i = 0; i < vec_len (dead_indices); i++)
681 pool_put_index (am->vl_clients, dead_indices[i]);
686 void_mem_api_handle_msg_i (api_main_t * am, svm_region_t * vlib_rp,
687 vlib_main_t * vm, vlib_node_runtime_t * node,
693 q = ((vl_shmem_hdr_t *) (void *) vlib_rp->user_ctx)->vl_input_queue;
695 if (!svm_queue_sub2 (q, (u8 *) & mp))
697 VL_MSG_API_UNPOISON ((void *) mp);
698 vl_msg_api_handler_with_vm_node (am, vlib_rp, (void *) mp, vm, node,
706 vl_mem_api_handle_msg_main (vlib_main_t * vm, vlib_node_runtime_t * node)
708 api_main_t *am = vlibapi_get_main ();
709 return void_mem_api_handle_msg_i (am, am->vlib_rp, vm, node,
710 0 /* is_private */ );
714 vl_mem_api_handle_rpc (vlib_main_t * vm, vlib_node_runtime_t * node)
716 api_main_t *am = vlibapi_get_main ();
721 * Swap pending and processing vectors, then process the RPCs
722 * Avoid deadlock conditions by construction.
724 clib_spinlock_lock_if_init (&vm->pending_rpc_lock);
725 tmp = vm->processing_rpc_requests;
726 vec_reset_length (tmp);
727 vm->processing_rpc_requests = vm->pending_rpc_requests;
728 vm->pending_rpc_requests = tmp;
729 clib_spinlock_unlock_if_init (&vm->pending_rpc_lock);
732 * RPCs are used to reflect function calls to thread 0
733 * when the underlying code is not thread-safe.
735 * Grabbing the thread barrier across a set of RPCs
736 * greatly increases efficiency, and avoids
737 * running afoul of the barrier sync holddown timer.
738 * The barrier sync code supports recursive locking.
740 * We really need to rewrite RPC-based code...
742 if (PREDICT_TRUE (vec_len (vm->processing_rpc_requests)))
744 vl_msg_api_barrier_sync ();
745 for (i = 0; i < vec_len (vm->processing_rpc_requests); i++)
747 mp = vm->processing_rpc_requests[i];
748 vl_msg_api_handler_with_vm_node (am, am->vlib_rp, (void *) mp, vm,
749 node, 0 /* is_private */ );
751 vl_msg_api_barrier_release ();
758 vl_mem_api_handle_msg_private (vlib_main_t * vm, vlib_node_runtime_t * node,
761 api_main_t *am = vlibapi_get_main ();
762 return void_mem_api_handle_msg_i (am, am->vlib_private_rps[reg_index], vm,
763 node, 1 /* is_private */ );
766 vl_api_registration_t *
767 vl_mem_api_client_index_to_registration (u32 handle)
769 vl_api_registration_t **regpp;
770 vl_api_registration_t *regp;
771 api_main_t *am = vlibapi_get_main ();
772 vl_shmem_hdr_t *shmem_hdr;
775 index = vl_msg_api_handle_get_index (handle);
776 regpp = am->vl_clients + index;
778 if (pool_is_free (am->vl_clients, regpp))
780 vl_msg_api_increment_missing_client_counter ();
785 shmem_hdr = (vl_shmem_hdr_t *) regp->shmem_hdr;
786 if (!vl_msg_api_handle_is_valid (handle, shmem_hdr->application_restarts))
788 vl_msg_api_increment_missing_client_counter ();
796 vl_api_client_index_to_input_queue (u32 index)
798 vl_api_registration_t *regp;
799 api_main_t *am = vlibapi_get_main ();
801 /* Special case: vlib trying to send itself a message */
802 if (index == (u32) ~ 0)
803 return (am->shmem_hdr->vl_input_queue);
805 regp = vl_mem_api_client_index_to_registration (index);
808 return (regp->vl_input_queue);
811 static clib_error_t *
812 setup_memclnt_exit (vlib_main_t * vm)
814 atexit (vl_unmap_shmem);
818 VLIB_INIT_FUNCTION (setup_memclnt_exit);
821 format_api_message_rings (u8 * s, va_list * args)
823 api_main_t *am = va_arg (*args, api_main_t *);
824 vl_shmem_hdr_t *shmem_hdr = va_arg (*args, vl_shmem_hdr_t *);
825 int main_segment = va_arg (*args, int);
830 return format (s, "%8s %8s %8s %8s %8s\n",
831 "Owner", "Size", "Nitems", "Hits", "Misses");
833 ap = shmem_hdr->vl_rings;
835 for (i = 0; i < vec_len (shmem_hdr->vl_rings); i++)
837 s = format (s, "%8s %8d %8d %8d %8d\n",
838 "vlib", ap->size, ap->nitems, ap->hits, ap->misses);
842 ap = shmem_hdr->client_rings;
844 for (i = 0; i < vec_len (shmem_hdr->client_rings); i++)
846 s = format (s, "%8s %8d %8d %8d %8d\n",
847 "clnt", ap->size, ap->nitems, ap->hits, ap->misses);
853 s = format (s, "%d ring miss fallback allocations\n", am->ring_misses);
856 "%d application restarts, %d reclaimed msgs, %d garbage collects\n",
857 shmem_hdr->application_restarts, shmem_hdr->restart_reclaims,
858 shmem_hdr->garbage_collects);
863 static clib_error_t *
864 vl_api_ring_command (vlib_main_t * vm,
865 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
868 vl_shmem_hdr_t *shmem_hdr;
869 api_main_t *am = vlibapi_get_main ();
871 /* First, dump the primary region rings.. */
873 if (am->vlib_primary_rp == 0 || am->vlib_primary_rp->user_ctx == 0)
875 vlib_cli_output (vm, "Shared memory segment not initialized...\n");
879 shmem_hdr = (void *) am->vlib_primary_rp->user_ctx;
881 vlib_cli_output (vm, "Main API segment rings:");
883 vlib_cli_output (vm, "%U", format_api_message_rings, am,
884 0 /* print header */ , 0 /* notused */ );
886 vlib_cli_output (vm, "%U", format_api_message_rings, am,
887 shmem_hdr, 1 /* main segment */ );
889 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
891 svm_region_t *vlib_rp = am->vlib_private_rps[i];
892 shmem_hdr = (void *) vlib_rp->user_ctx;
893 vl_api_registration_t **regpp;
894 vl_api_registration_t *regp = 0;
896 /* For horizontal scaling, add a hash table... */
898 pool_foreach (regpp, am->vl_clients,
901 if (regp && regp->vlib_rp == vlib_rp)
903 vlib_cli_output (vm, "%s segment rings:", regp->name);
907 vlib_cli_output (vm, "regp %llx not found?", regp);
911 vlib_cli_output (vm, "%U", format_api_message_rings, am,
912 0 /* print header */ , 0 /* notused */ );
913 vlib_cli_output (vm, "%U", format_api_message_rings, am,
914 shmem_hdr, 0 /* main segment */ );
921 * Display binary api message allocation ring statistics
924 VLIB_CLI_COMMAND (cli_show_api_ring_command, static) =
926 .path = "show api ring-stats",
927 .short_help = "Message ring statistics",
928 .function = vl_api_ring_command,
933 vlibmemory_init (vlib_main_t * vm)
935 api_main_t *am = vlibapi_get_main ();
936 svm_map_region_args_t _a, *a = &_a;
937 u8 *remove_path1, *remove_path2;
938 void vlibsocket_reference (void);
940 vlibsocket_reference ();
943 * By popular request / to avoid support fires, remove any old api segment
946 if (am->root_path == 0)
948 remove_path1 = format (0, "/dev/shm/global_vm%c", 0);
949 remove_path2 = format (0, "/dev/shm/vpe-api%c", 0);
953 remove_path1 = format (0, "/dev/shm/%s-global_vm%c", am->root_path, 0);
954 remove_path2 = format (0, "/dev/shm/%s-vpe-api%c", am->root_path, 0);
957 (void) unlink ((char *) remove_path1);
958 (void) unlink ((char *) remove_path2);
960 vec_free (remove_path1);
961 vec_free (remove_path2);
963 clib_memset (a, 0, sizeof (*a));
964 a->root_path = am->root_path;
965 a->name = SVM_GLOBAL_REGION_NAME;
966 a->baseva = (am->global_baseva != 0) ?
967 am->global_baseva : +svm_get_global_region_base_va ();
968 a->size = (am->global_size != 0) ? am->global_size : SVM_GLOBAL_REGION_SIZE;
969 a->flags = SVM_FLAGS_NODATA;
970 a->uid = am->api_uid;
971 a->gid = am->api_gid;
973 (am->global_pvt_heap_size !=
974 0) ? am->global_pvt_heap_size : SVM_PVT_MHEAP_SIZE;
976 svm_region_init_args (a);
982 vl_set_memory_region_name (const char *name)
984 api_main_t *am = vlibapi_get_main ();
985 am->region_name = name;
989 * fd.io coding-style-patch-verification: ON
992 * eval: (c-set-style "gnu")