2 *------------------------------------------------------------------
5 * Copyright (c) 2009 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
24 #include <sys/types.h>
29 #include <vppinfra/vec.h>
30 #include <vppinfra/hash.h>
31 #include <vppinfra/pool.h>
32 #include <vppinfra/format.h>
33 #include <vppinfra/byte_order.h>
34 #include <vppinfra/elog.h>
36 #include <vlib/vlib.h>
37 #include <vlib/unix/unix.h>
38 #include <vlibapi/api.h>
39 #include <vlibmemory/api.h>
43 * @brief Binary API messaging via shared memory
44 * Low-level, primary provisioning interface
46 /*? %%clicmd:group_label Binary API CLI %% ?*/
47 /*? %%syscfg:group_label Binary API configuration %% ?*/
49 #define TRACE_VLIB_MEMORY_QUEUE 0
51 #include <vlibmemory/vl_memory_msg_enum.h> /* enumerate all vlib messages */
53 #define vl_typedefs /* define message structures */
54 #include <vlibmemory/vl_memory_api_h.h>
57 /* instantiate all the print functions we know about */
58 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
60 #include <vlibmemory/vl_memory_api_h.h>
64 vl_api_memclnt_create_t_print (vl_api_memclnt_create_t * a, void *handle)
66 vl_print (handle, "vl_api_memclnt_create_t:\n");
67 vl_print (handle, "name: %s\n", a->name);
68 vl_print (handle, "input_queue: 0x%wx\n", a->input_queue);
69 vl_print (handle, "context: %u\n", (unsigned) a->context);
70 vl_print (handle, "ctx_quota: %ld\n", (long) a->ctx_quota);
75 vl_api_memclnt_delete_t_print (vl_api_memclnt_delete_t * a, void *handle)
77 vl_print (handle, "vl_api_memclnt_delete_t:\n");
78 vl_print (handle, "index: %u\n", (unsigned) a->index);
79 vl_print (handle, "handle: 0x%wx\n", a->handle);
84 vl_api_trace_plugin_msg_ids_t_print (vl_api_trace_plugin_msg_ids_t * a,
87 vl_print (handle, "vl_api_trace_plugin_msg_ids: %s first %u last %u\n",
89 clib_host_to_net_u16 (a->first_msg_id),
90 clib_host_to_net_u16 (a->last_msg_id));
94 /* instantiate all the endian swap functions we know about */
96 #include <vlibmemory/vl_memory_api_h.h>
99 extern void vl_socket_api_send (vl_api_registration_t * rp, u8 * elem);
102 vl_msg_api_send (vl_api_registration_t * rp, u8 * elem)
104 if (PREDICT_FALSE (rp->registration_type > REGISTRATION_TYPE_SHMEM))
106 vl_socket_api_send (rp, elem);
110 vl_msg_api_send_shmem (rp->vl_input_queue, (u8 *) & elem);
115 vl_api_serialize_message_table (api_main_t * am, u8 * vector)
117 serialize_main_t _sm, *sm = &_sm;
119 u32 nmsg = hash_elts (am->msg_index_by_name_and_crc);
121 serialize_open_vector (sm, vector);
123 /* serialize the count */
124 serialize_integer (sm, nmsg, sizeof (u32));
127 hash_foreach_pair (hp, am->msg_index_by_name_and_crc,
129 serialize_likely_small_unsigned_integer (sm, hp->value[0]);
130 serialize_cstring (sm, (char *) hp->key);
134 return serialize_close_vector (sm);
138 * vl_api_memclnt_create_internal
142 vl_api_memclnt_create_internal (char *name, unix_shared_memory_queue_t * q)
144 vl_api_registration_t **regpp;
145 vl_api_registration_t *regp;
148 api_main_t *am = &api_main;
150 ASSERT (vlib_get_thread_index () == 0);
151 pool_get (am->vl_clients, regpp);
155 pthread_mutex_lock (&svm->mutex);
156 oldheap = svm_push_data_heap (svm);
157 *regpp = clib_mem_alloc (sizeof (vl_api_registration_t));
160 memset (regp, 0, sizeof (*regp));
161 regp->registration_type = REGISTRATION_TYPE_SHMEM;
162 regp->vl_api_registration_pool_index = regpp - am->vl_clients;
164 regp->shmem_hdr = am->shmem_hdr;
166 regp->vl_input_queue = q;
167 regp->name = format (0, "%s%c", name, 0);
169 pthread_mutex_unlock (&svm->mutex);
170 svm_pop_heap (oldheap);
171 return vl_msg_api_handle_from_index_and_epoch
172 (regp->vl_api_registration_pool_index,
173 am->shmem_hdr->application_restarts);
178 * vl_api_memclnt_create_t_handler
181 vl_api_memclnt_create_t_handler (vl_api_memclnt_create_t * mp)
183 vl_api_registration_t **regpp;
184 vl_api_registration_t *regp;
185 vl_api_memclnt_create_reply_t *rp;
187 unix_shared_memory_queue_t *q;
190 api_main_t *am = &api_main;
191 u8 *serialized_message_table_in_shmem;
194 * This is tortured. Maintain a vlib-address-space private
195 * pool of client registrations. We use the shared-memory virtual
196 * address of client structure as a handle, to allow direct
197 * manipulation of context quota vbls from the client library.
199 * This scheme causes trouble w/ API message trace replay, since
200 * some random VA from clib_mem_alloc() certainly won't
201 * occur in the Linux sim. The (very) few places
202 * that care need to use the pool index.
204 * Putting the registration object(s) into a pool in shared memory and
205 * using the pool index as a handle seems like a great idea.
206 * Unfortunately, each and every reference to that pool would need
207 * to be protected by a mutex:
211 * convert pool index to
219 pool_get (am->vl_clients, regpp);
223 pthread_mutex_lock (&svm->mutex);
224 oldheap = svm_push_data_heap (svm);
225 *regpp = clib_mem_alloc (sizeof (vl_api_registration_t));
228 memset (regp, 0, sizeof (*regp));
229 regp->registration_type = REGISTRATION_TYPE_SHMEM;
230 regp->vl_api_registration_pool_index = regpp - am->vl_clients;
232 regp->shmem_hdr = am->shmem_hdr;
234 q = regp->vl_input_queue = (unix_shared_memory_queue_t *) (uword)
237 regp->name = format (0, "%s", mp->name);
238 vec_add1 (regp->name, 0);
240 serialized_message_table_in_shmem = vl_api_serialize_message_table (am, 0);
242 pthread_mutex_unlock (&svm->mutex);
243 svm_pop_heap (oldheap);
245 rp = vl_msg_api_alloc (sizeof (*rp));
246 rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE_REPLY);
247 rp->handle = (uword) regp;
248 rp->index = vl_msg_api_handle_from_index_and_epoch
249 (regp->vl_api_registration_pool_index,
250 am->shmem_hdr->application_restarts);
251 rp->context = mp->context;
252 rp->response = ntohl (rv);
253 rp->message_table = pointer_to_uword (serialized_message_table_in_shmem);
255 vl_msg_api_send_shmem (q, (u8 *) & rp);
259 call_reaper_functions (u32 client_index)
261 clib_error_t *error = 0;
262 _vl_msg_api_function_list_elt_t *i;
264 i = api_main.reaper_function_registrations;
267 error = i->f (client_index);
269 clib_error_report (error);
270 i = i->next_init_function;
276 * vl_api_memclnt_delete_t_handler
279 vl_api_memclnt_delete_t_handler (vl_api_memclnt_delete_t * mp)
281 vl_api_registration_t **regpp;
282 vl_api_registration_t *regp;
283 vl_api_memclnt_delete_reply_t *rp;
286 api_main_t *am = &api_main;
287 u32 handle, client_index, epoch;
291 if (call_reaper_functions (handle))
294 epoch = vl_msg_api_handle_get_epoch (handle);
295 client_index = vl_msg_api_handle_get_index (handle);
297 if (epoch != (am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK))
300 ("Stale clnt delete index %d old epoch %d cur epoch %d",
302 (am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK));
306 regpp = am->vl_clients + client_index;
308 if (!pool_is_free (am->vl_clients, regpp))
313 int private_registration = 0;
316 * Note: the API message handling path will set am->vlib_rp
317 * as appropriate for pairwise / private memory segments
319 rp = vl_msg_api_alloc (sizeof (*rp));
320 rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE_REPLY);
321 rp->handle = mp->handle;
324 vl_msg_api_send_shmem (regp->vl_input_queue, (u8 *) & rp);
326 if (client_index != regp->vl_api_registration_pool_index)
328 clib_warning ("mismatch client_index %d pool_index %d",
329 client_index, regp->vl_api_registration_pool_index);
330 vl_msg_api_free (rp);
334 /* For horizontal scaling, add a hash table... */
335 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
337 /* Is this a pairwise / private API segment? */
338 if (am->vlib_private_rps[i] == svm)
340 /* Note: account for the memfd header page */
341 u64 virtual_base = svm->virtual_base - MMAP_PAGESIZE;
342 u64 virtual_size = svm->virtual_size + MMAP_PAGESIZE;
345 * Kill the registration pool element before we make
346 * the index vanish forever
348 pool_put_index (am->vl_clients,
349 regp->vl_api_registration_pool_index);
351 vec_delete (am->vlib_private_rps, 1, i);
352 /* Kill it, accounting for the memfd header page */
353 if (munmap ((void *) virtual_base, virtual_size) < 0)
354 clib_unix_warning ("munmap");
355 /* Reset the queue-length-address cache */
356 vec_reset_length (vl_api_queue_cursizes);
357 private_registration = 1;
362 /* No dangling references, please */
365 if (private_registration == 0)
367 pool_put_index (am->vl_clients,
368 regp->vl_api_registration_pool_index);
369 pthread_mutex_lock (&svm->mutex);
370 oldheap = svm_push_data_heap (svm);
371 /* Poison the old registration */
372 memset (regp, 0xF1, sizeof (*regp));
373 clib_mem_free (regp);
374 pthread_mutex_unlock (&svm->mutex);
375 svm_pop_heap (oldheap);
377 * These messages must be freed manually, since they're set up
378 * as "bounce" messages. In the private_registration == 1 case,
379 * we kill the shared-memory segment which contains the message
382 vl_msg_api_free (mp);
387 clib_warning ("unknown client ID %d", mp->index);
392 vl_api_get_first_msg_id_t_handler (vl_api_get_first_msg_id_t * mp)
394 vl_api_get_first_msg_id_reply_t *rmp;
395 unix_shared_memory_queue_t *q;
397 api_main_t *am = &api_main;
398 vl_api_msg_range_t *rp;
400 u16 first_msg_id = ~0;
401 int rv = -7; /* VNET_API_ERROR_INVALID_VALUE */
403 q = vl_api_client_index_to_input_queue (mp->client_index);
407 if (am->msg_range_by_name == 0)
410 strncpy ((char *) name, (char *) mp->name, ARRAY_LEN (name) - 1);
412 p = hash_get_mem (am->msg_range_by_name, name);
416 rp = vec_elt_at_index (am->msg_ranges, p[0]);
418 first_msg_id = rp->first_msg_id;
423 rmp = vl_msg_api_alloc (sizeof (*rmp));
424 rmp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID_REPLY);
425 rmp->context = mp->context;
426 rmp->retval = ntohl (rv);
427 rmp->first_msg_id = ntohs (first_msg_id);
428 vl_msg_api_send_shmem (q, (u8 *) & rmp);
432 * client answered a ping, stave off the grim reaper...
436 vl_api_memclnt_keepalive_reply_t_handler
437 (vl_api_memclnt_keepalive_reply_t * mp)
439 vl_api_registration_t *regp;
440 vlib_main_t *vm = vlib_get_main ();
442 regp = vl_api_client_index_to_registration (mp->context);
445 regp->last_heard = vlib_time_now (vm);
446 regp->unanswered_pings = 0;
449 clib_warning ("BUG: anonymous memclnt_keepalive_reply");
453 * We can send ourselves these messages if someone uses the
454 * builtin binary api test tool...
457 vl_api_memclnt_keepalive_t_handler (vl_api_memclnt_keepalive_t * mp)
459 vl_api_memclnt_keepalive_reply_t *rmp;
461 vl_shmem_hdr_t *shmem_hdr;
464 shmem_hdr = am->shmem_hdr;
466 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
467 memset (rmp, 0, sizeof (*rmp));
468 rmp->_vl_msg_id = ntohs (VL_API_MEMCLNT_KEEPALIVE_REPLY);
469 rmp->context = mp->context;
470 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & rmp);
474 vl_api_api_versions_t_handler (vl_api_api_versions_t * mp)
476 api_main_t *am = &api_main;
477 vl_api_api_versions_reply_t *rmp;
478 unix_shared_memory_queue_t *q;
479 u32 nmsg = vec_len (am->api_version_list);
480 int msg_size = sizeof (*rmp) + sizeof (rmp->api_versions[0]) * nmsg;
483 q = vl_api_client_index_to_input_queue (mp->client_index);
487 rmp = vl_msg_api_alloc (msg_size);
488 memset (rmp, 0, msg_size);
489 rmp->_vl_msg_id = ntohs (VL_API_API_VERSIONS_REPLY);
491 /* fill in the message */
492 rmp->context = mp->context;
493 rmp->count = htonl (nmsg);
495 for (i = 0; i < nmsg; ++i)
497 api_version_t *vl = &am->api_version_list[i];
498 rmp->api_versions[i].major = htonl (vl->major);
499 rmp->api_versions[i].minor = htonl (vl->minor);
500 rmp->api_versions[i].patch = htonl (vl->patch);
501 strncpy ((char *) rmp->api_versions[i].name, vl->name, 64 - 1);
504 vl_msg_api_send_shmem (q, (u8 *) & rmp);
508 #define foreach_vlib_api_msg \
509 _(MEMCLNT_CREATE, memclnt_create) \
510 _(MEMCLNT_DELETE, memclnt_delete) \
511 _(GET_FIRST_MSG_ID, get_first_msg_id) \
512 _(MEMCLNT_KEEPALIVE, memclnt_keepalive) \
513 _(MEMCLNT_KEEPALIVE_REPLY, memclnt_keepalive_reply) \
514 _(API_VERSIONS, api_versions)
520 memory_api_init (const char *region_name)
523 api_main_t *am = &api_main;
524 vl_msg_api_msg_config_t cfg;
525 vl_msg_api_msg_config_t *c = &cfg;
527 memset (c, 0, sizeof (*c));
529 if ((rv = vl_map_shmem (region_name, 1 /* is_vlib */ )) < 0)
532 #define _(N,n) do { \
533 c->id = VL_API_##N; \
535 c->handler = vl_api_##n##_t_handler; \
536 c->cleanup = vl_noop_handler; \
537 c->endian = vl_api_##n##_t_endian; \
538 c->print = vl_api_##n##_t_print; \
539 c->size = sizeof(vl_api_##n##_t); \
540 c->traced = 1; /* trace, so these msgs print */ \
541 c->replay = 0; /* don't replay client create/delete msgs */ \
542 c->message_bounce = 0; /* don't bounce this message */ \
543 vl_msg_api_config(c);} while (0);
545 foreach_vlib_api_msg;
549 * special-case freeing of memclnt_delete messages, so we can
550 * simply munmap pairwise / private API segments...
552 am->message_bounce[VL_API_MEMCLNT_DELETE] = 1;
553 am->is_mp_safe[VL_API_MEMCLNT_KEEPALIVE_REPLY] = 1;
558 #define foreach_histogram_bucket \
566 #define _(n) SLEEP_##n##_US,
567 foreach_histogram_bucket
572 static u64 vector_rate_histogram[SLEEP_N_BUCKETS];
574 static void memclnt_queue_callback (vlib_main_t * vm);
577 * Callback to send ourselves a plugin numbering-space trace msg
580 send_one_plugin_msg_ids_msg (u8 * name, u16 first_msg_id, u16 last_msg_id)
582 vl_api_trace_plugin_msg_ids_t *mp;
583 api_main_t *am = &api_main;
584 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
585 unix_shared_memory_queue_t *q;
587 mp = vl_msg_api_alloc_as_if_client (sizeof (*mp));
588 memset (mp, 0, sizeof (*mp));
590 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_TRACE_PLUGIN_MSG_IDS);
591 strncpy ((char *) mp->plugin_name, (char *) name,
592 sizeof (mp->plugin_name) - 1);
593 mp->first_msg_id = clib_host_to_net_u16 (first_msg_id);
594 mp->last_msg_id = clib_host_to_net_u16 (last_msg_id);
596 q = shmem_hdr->vl_input_queue;
598 vl_msg_api_send_shmem (q, (u8 *) & mp);
602 send_memclnt_keepalive (vl_api_registration_t * regp, f64 now)
604 vl_api_memclnt_keepalive_t *mp;
605 unix_shared_memory_queue_t *q;
606 api_main_t *am = &api_main;
607 svm_region_t *save_vlib_rp = am->vlib_rp;
608 vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
610 q = regp->vl_input_queue;
613 * If the queue head is moving, assume that the client is processing
614 * messages and skip the ping. This heuristic may fail if the queue
615 * is in the same position as last time, net of wrapping; in which
616 * case, the client will receive a keepalive.
618 if (regp->last_queue_head != q->head)
620 regp->last_heard = now;
621 regp->unanswered_pings = 0;
622 regp->last_queue_head = q->head;
627 * push/pop shared memory segment, so this routine
628 * will work with "normal" as well as "private segment"
632 am->vlib_rp = regp->vlib_rp;
633 am->shmem_hdr = regp->shmem_hdr;
635 mp = vl_msg_api_alloc (sizeof (*mp));
636 memset (mp, 0, sizeof (*mp));
637 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MEMCLNT_KEEPALIVE);
638 mp->context = mp->client_index =
639 vl_msg_api_handle_from_index_and_epoch
640 (regp->vl_api_registration_pool_index,
641 am->shmem_hdr->application_restarts);
643 regp->unanswered_pings++;
645 /* Failure-to-send due to a stuffed queue is absolutely expected */
646 if (unix_shared_memory_queue_add (q, (u8 *) & mp, 1 /* nowait */ ))
647 vl_msg_api_free (mp);
649 am->vlib_rp = save_vlib_rp;
650 am->shmem_hdr = save_shmem_hdr;
654 dead_client_scan (api_main_t * am, vl_shmem_hdr_t * shm, f64 now)
657 vl_api_registration_t **regpp;
658 vl_api_registration_t *regp;
659 static u32 *dead_indices;
660 static u32 *confused_indices;
662 vec_reset_length (dead_indices);
663 vec_reset_length (confused_indices);
666 pool_foreach (regpp, am->vl_clients,
671 /* If we haven't heard from this client recently... */
672 if (regp->last_heard < (now - 10.0))
674 if (regp->unanswered_pings == 2)
676 unix_shared_memory_queue_t *q;
677 q = regp->vl_input_queue;
678 if (kill (q->consumer_pid, 0) >=0)
680 clib_warning ("REAPER: lazy binary API client '%s'",
682 regp->unanswered_pings = 0;
683 regp->last_heard = now;
687 clib_warning ("REAPER: binary API client '%s' died",
689 vec_add1(dead_indices, regpp - am->vl_clients);
693 send_memclnt_keepalive (regp, now);
696 regp->unanswered_pings = 0;
700 clib_warning ("NULL client registration index %d",
701 regpp - am->vl_clients);
702 vec_add1 (confused_indices, regpp - am->vl_clients);
706 /* This should "never happen," but if it does, fix it... */
707 if (PREDICT_FALSE (vec_len (confused_indices) > 0))
710 for (i = 0; i < vec_len (confused_indices); i++)
712 pool_put_index (am->vl_clients, confused_indices[i]);
716 if (PREDICT_FALSE (vec_len (dead_indices) > 0))
722 /* Allow the application to clean up its registrations */
723 for (i = 0; i < vec_len (dead_indices); i++)
725 regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
730 handle = vl_msg_api_handle_from_index_and_epoch
731 (dead_indices[i], shm->application_restarts);
732 (void) call_reaper_functions (handle);
737 pthread_mutex_lock (&svm->mutex);
738 oldheap = svm_push_data_heap (svm);
740 for (i = 0; i < vec_len (dead_indices); i++)
742 regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
745 /* Is this a pairwise SVM segment? */
746 if ((*regpp)->vlib_rp != svm)
749 svm_region_t *dead_rp = (*regpp)->vlib_rp;
750 /* Note: account for the memfd header page */
751 u64 virtual_base = dead_rp->virtual_base - MMAP_PAGESIZE;
752 u64 virtual_size = dead_rp->virtual_size + MMAP_PAGESIZE;
754 /* For horizontal scaling, add a hash table... */
755 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
756 if (am->vlib_private_rps[i] == dead_rp)
758 vec_delete (am->vlib_private_rps, 1, i);
761 clib_warning ("private rp %llx AWOL", dead_rp);
764 /* Kill it, accounting for the memfd header page */
765 if (munmap ((void *) virtual_base, virtual_size) < 0)
766 clib_unix_warning ("munmap");
767 /* Reset the queue-length-address cache */
768 vec_reset_length (vl_api_queue_cursizes);
772 /* Poison the old registration */
773 memset (*regpp, 0xF3, sizeof (**regpp));
774 clib_mem_free (*regpp);
776 /* no dangling references, please */
781 svm_pop_heap (oldheap);
782 clib_warning ("Duplicate free, client index %d",
783 regpp - am->vl_clients);
784 oldheap = svm_push_data_heap (svm);
788 svm_client_scan_this_region_nolock (am->vlib_rp);
790 pthread_mutex_unlock (&svm->mutex);
791 svm_pop_heap (oldheap);
792 for (i = 0; i < vec_len (dead_indices); i++)
793 pool_put_index (am->vl_clients, dead_indices[i]);
799 memclnt_process (vlib_main_t * vm,
800 vlib_node_runtime_t * node, vlib_frame_t * f)
804 unix_shared_memory_queue_t *q;
807 api_main_t *am = &api_main;
808 f64 dead_client_scan_time;
809 f64 sleep_time, start_time;
811 clib_error_t *socksvr_api_init (vlib_main_t * vm);
814 vl_socket_args_for_process_t *a;
816 uword *event_data = 0;
817 int private_segment_rotor = 0;
818 svm_region_t *vlib_rp;
821 vlib_set_queue_signal_callback (vm, memclnt_queue_callback);
823 if ((rv = memory_api_init (am->region_name)) < 0)
825 clib_warning ("memory_api_init returned %d, quitting...", rv);
829 if ((error = socksvr_api_init (vm)))
831 clib_error_report (error);
832 clib_warning ("socksvr_api_init failed, quitting...");
838 q = shm->vl_input_queue;
840 /* Make a note so we can always find the primary region easily */
841 am->vlib_primary_rp = am->vlib_rp;
843 e = vlib_call_init_exit_functions
844 (vm, vm->api_init_function_registrations, 1 /* call_once */ );
846 clib_error_report (e);
849 dead_client_scan_time = vlib_time_now (vm) + 10.0;
852 * Send plugin message range messages for each plugin we loaded
854 for (i = 0; i < vec_len (am->msg_ranges); i++)
856 vl_api_msg_range_t *rp = am->msg_ranges + i;
857 send_one_plugin_msg_ids_msg (rp->name, rp->first_msg_id,
862 * Save the api message table snapshot, if configured
864 if (am->save_msg_table_filename)
868 u8 *serialized_message_table;
871 * Snapshoot the api message table.
873 if (strstr ((char *) am->save_msg_table_filename, "..")
874 || index ((char *) am->save_msg_table_filename, '/'))
876 clib_warning ("illegal save-message-table filename '%s'",
877 am->save_msg_table_filename);
881 chroot_file = format (0, "/tmp/%s%c", am->save_msg_table_filename, 0);
883 fd = creat ((char *) chroot_file, 0644);
887 clib_unix_warning ("creat");
891 serialized_message_table = vl_api_serialize_message_table (am, 0);
893 rv = write (fd, serialized_message_table,
894 vec_len (serialized_message_table));
896 if (rv != vec_len (serialized_message_table))
897 clib_unix_warning ("write");
901 clib_unix_warning ("close");
903 vec_free (chroot_file);
904 vec_free (serialized_message_table);
909 /* $$$ pay attention to frame size, control CPU usage */
916 * There's a reason for checking the queue before
917 * sleeping. If the vlib application crashes, it's entirely
918 * possible for a client to enqueue a connect request
919 * during the process restart interval.
921 * Unless some force of physics causes the new incarnation
922 * of the application to process the request, the client will
923 * sit and wait for Godot...
925 vector_rate = vlib_last_vector_length_per_node (vm);
926 start_time = vlib_time_now (vm);
929 pthread_mutex_lock (&q->mutex);
932 vm->api_queue_nonempty = 0;
933 pthread_mutex_unlock (&q->mutex);
935 if (TRACE_VLIB_MEMORY_QUEUE)
938 ELOG_TYPE_DECLARE (e) =
940 .format = "q-underflow: len %d",
948 ed = ELOG_DATA (&vm->elog_main, e);
955 headp = (i8 *) (q->data + sizeof (uword) * q->head);
956 clib_memcpy (&mp, headp, sizeof (uword));
959 need_broadcast = (q->cursize == q->maxsize / 2);
962 if (PREDICT_FALSE (q->head == q->maxsize))
964 pthread_mutex_unlock (&q->mutex);
966 (void) pthread_cond_broadcast (&q->condvar);
968 vl_msg_api_handler_with_vm_node (am, (void *) mp, vm, node);
970 /* Allow no more than 10us without a pause */
971 if (vlib_time_now (vm) > start_time + 10e-6)
973 int index = SLEEP_400_US;
974 if (vector_rate > 40.0)
976 else if (vector_rate > 20.0)
978 index = SLEEP_200_US;
981 else if (vector_rate >= 1.0)
983 index = SLEEP_100_US;
991 vector_rate_histogram[index] += 1;
997 * see if we have any private api shared-memory segments
998 * If so, push required context variables, and process
1001 if (PREDICT_FALSE (vec_len (am->vlib_private_rps)))
1003 unix_shared_memory_queue_t *save_vlib_input_queue = q;
1004 vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
1005 svm_region_t *save_vlib_rp = am->vlib_rp;
1007 vlib_rp = am->vlib_rp = am->vlib_private_rps[private_segment_rotor];
1009 am->shmem_hdr = (void *) vlib_rp->user_ctx;
1010 q = am->shmem_hdr->vl_input_queue;
1012 pthread_mutex_lock (&q->mutex);
1015 headp = (i8 *) (q->data + sizeof (uword) * q->head);
1016 clib_memcpy (&mp, headp, sizeof (uword));
1019 need_broadcast = (q->cursize == q->maxsize / 2);
1022 if (PREDICT_FALSE (q->head == q->maxsize))
1024 pthread_mutex_unlock (&q->mutex);
1026 (void) pthread_cond_broadcast (&q->condvar);
1028 pthread_mutex_unlock (&q->mutex);
1030 vl_msg_api_handler_with_vm_node (am, (void *) mp, vm, node);
1033 pthread_mutex_unlock (&q->mutex);
1035 q = save_vlib_input_queue;
1036 am->shmem_hdr = save_shmem_hdr;
1037 am->vlib_rp = save_vlib_rp;
1039 private_segment_rotor++;
1040 if (private_segment_rotor >= vec_len (am->vlib_private_rps))
1041 private_segment_rotor = 0;
1044 vlib_process_wait_for_event_or_clock (vm, sleep_time);
1045 vec_reset_length (event_data);
1046 event_type = vlib_process_get_events (vm, &event_data);
1047 now = vlib_time_now (vm);
1051 case QUEUE_SIGNAL_EVENT:
1052 vm->queue_signal_pending = 0;
1055 case SOCKET_READ_EVENT:
1056 for (i = 0; i < vec_len (event_data); i++)
1058 a = pool_elt_at_index (socket_main.process_args, event_data[i]);
1059 vl_api_socket_process_msg (a->clib_file, a->regp,
1062 pool_put (socket_main.process_args, a);
1071 clib_warning ("unknown event type %d", event_type);
1075 if (now > dead_client_scan_time)
1077 dead_client_scan (am, shm, now);
1078 dead_client_scan_time = vlib_time_now (vm) + 10.0;
1081 if (TRACE_VLIB_MEMORY_QUEUE)
1084 ELOG_TYPE_DECLARE (e) = {
1085 .format = "q-awake: len %d",
1086 .format_args = "i4",
1093 ed = ELOG_DATA (&vm->elog_main, e);
1094 ed->len = q->cursize;
1101 VLIB_REGISTER_NODE (memclnt_node) =
1103 .function = memclnt_process,
1104 .type = VLIB_NODE_TYPE_PROCESS,
1105 .name = "api-rx-from-ring",
1106 .state = VLIB_NODE_STATE_DISABLED,
1111 static clib_error_t *
1112 vl_api_show_histogram_command (vlib_main_t * vm,
1113 unformat_input_t * input,
1114 vlib_cli_command_t * cli_cmd)
1116 u64 total_counts = 0;
1119 for (i = 0; i < SLEEP_N_BUCKETS; i++)
1121 total_counts += vector_rate_histogram[i];
1124 if (total_counts == 0)
1126 vlib_cli_output (vm, "No control-plane activity.");
1133 percent = ((f64) vector_rate_histogram[SLEEP_##n##_US]) \
1134 / (f64) total_counts; \
1136 vlib_cli_output (vm, "Sleep %3d us: %llu, %.2f%%",n, \
1137 vector_rate_histogram[SLEEP_##n##_US], \
1140 foreach_histogram_bucket;
1147 * Display the binary api sleep-time histogram
1150 VLIB_CLI_COMMAND (cli_show_api_histogram_command, static) =
1152 .path = "show api histogram",
1153 .short_help = "show api histogram",
1154 .function = vl_api_show_histogram_command,
1158 static clib_error_t *
1159 vl_api_clear_histogram_command (vlib_main_t * vm,
1160 unformat_input_t * input,
1161 vlib_cli_command_t * cli_cmd)
1165 for (i = 0; i < SLEEP_N_BUCKETS; i++)
1166 vector_rate_histogram[i] = 0;
1171 * Clear the binary api sleep-time histogram
1174 VLIB_CLI_COMMAND (cli_clear_api_histogram_command, static) =
1176 .path = "clear api histogram",
1177 .short_help = "clear api histogram",
1178 .function = vl_api_clear_histogram_command,
1182 volatile int **vl_api_queue_cursizes;
1185 memclnt_queue_callback (vlib_main_t * vm)
1188 api_main_t *am = &api_main;
1190 if (PREDICT_FALSE (vec_len (vl_api_queue_cursizes) !=
1191 1 + vec_len (am->vlib_private_rps)))
1193 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
1194 unix_shared_memory_queue_t *q;
1199 q = shmem_hdr->vl_input_queue;
1203 vec_add1 (vl_api_queue_cursizes, &q->cursize);
1205 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
1207 svm_region_t *vlib_rp = am->vlib_private_rps[i];
1209 shmem_hdr = (void *) vlib_rp->user_ctx;
1210 q = shmem_hdr->vl_input_queue;
1211 vec_add1 (vl_api_queue_cursizes, &q->cursize);
1215 for (i = 0; i < vec_len (vl_api_queue_cursizes); i++)
1217 if (*vl_api_queue_cursizes[i])
1219 vm->queue_signal_pending = 1;
1220 vm->api_queue_nonempty = 1;
1221 vlib_process_signal_event (vm, memclnt_node.index,
1222 /* event_type */ QUEUE_SIGNAL_EVENT,
1223 /* event_data */ 0);
1230 vl_enable_disable_memory_api (vlib_main_t * vm, int enable)
1232 vlib_node_set_state (vm, memclnt_node.index,
1234 ? VLIB_NODE_STATE_POLLING
1235 : VLIB_NODE_STATE_DISABLED));
1239 api_rx_from_node (vlib_main_t * vm,
1240 vlib_node_runtime_t * node, vlib_frame_t * frame)
1242 uword n_packets = frame->n_vectors;
1245 static u8 *long_msg;
1247 vec_validate (long_msg, 4095);
1248 n_left_from = frame->n_vectors;
1249 from = vlib_frame_args (frame);
1251 while (n_left_from > 0)
1259 b0 = vlib_get_buffer (vm, bi0);
1263 msg = b0->data + b0->current_data;
1264 msg_len = b0->current_length;
1265 if (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
1267 ASSERT (long_msg != 0);
1268 _vec_len (long_msg) = 0;
1269 vec_add (long_msg, msg, msg_len);
1270 while (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
1272 b0 = vlib_get_buffer (vm, b0->next_buffer);
1273 msg = b0->data + b0->current_data;
1274 msg_len = b0->current_length;
1275 vec_add (long_msg, msg, msg_len);
1279 vl_msg_api_handler_no_trace_no_free (msg);
1282 /* Free what we've been given. */
1283 vlib_buffer_free (vm, vlib_frame_args (frame), n_packets);
1289 VLIB_REGISTER_NODE (api_rx_from_node_node,static) = {
1290 .function = api_rx_from_node,
1291 .type = VLIB_NODE_TYPE_INTERNAL,
1293 .name = "api-rx-from-node",
1297 static clib_error_t *
1298 setup_memclnt_exit (vlib_main_t * vm)
1300 atexit (vl_unmap_shmem);
1304 VLIB_INIT_FUNCTION (setup_memclnt_exit);
1307 format_api_message_rings (u8 * s, va_list * args)
1309 api_main_t *am = va_arg (*args, api_main_t *);
1310 vl_shmem_hdr_t *shmem_hdr = va_arg (*args, vl_shmem_hdr_t *);
1311 int main_segment = va_arg (*args, int);
1316 return format (s, "%8s %8s %8s %8s %8s\n",
1317 "Owner", "Size", "Nitems", "Hits", "Misses");
1319 ap = shmem_hdr->vl_rings;
1321 for (i = 0; i < vec_len (shmem_hdr->vl_rings); i++)
1323 s = format (s, "%8s %8d %8d %8d %8d\n",
1324 "vlib", ap->size, ap->nitems, ap->hits, ap->misses);
1328 ap = shmem_hdr->client_rings;
1330 for (i = 0; i < vec_len (shmem_hdr->client_rings); i++)
1332 s = format (s, "%8s %8d %8d %8d %8d\n",
1333 "clnt", ap->size, ap->nitems, ap->hits, ap->misses);
1339 s = format (s, "%d ring miss fallback allocations\n", am->ring_misses);
1342 "%d application restarts, %d reclaimed msgs, %d garbage collects\n",
1343 shmem_hdr->application_restarts, shmem_hdr->restart_reclaims,
1344 shmem_hdr->garbage_collects);
1350 static clib_error_t *
1351 vl_api_ring_command (vlib_main_t * vm,
1352 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
1355 vl_shmem_hdr_t *shmem_hdr;
1356 api_main_t *am = &api_main;
1358 /* First, dump the primary region rings.. */
1360 if (am->vlib_primary_rp == 0 || am->vlib_primary_rp->user_ctx == 0)
1362 vlib_cli_output (vm, "Shared memory segment not initialized...\n");
1366 shmem_hdr = (void *) am->vlib_primary_rp->user_ctx;
1368 vlib_cli_output (vm, "Main API segment rings:");
1370 vlib_cli_output (vm, "%U", format_api_message_rings, am,
1371 0 /* print header */ , 0 /* notused */ );
1373 vlib_cli_output (vm, "%U", format_api_message_rings, am,
1374 shmem_hdr, 1 /* main segment */ );
1376 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
1378 svm_region_t *vlib_rp = am->vlib_private_rps[i];
1379 shmem_hdr = (void *) vlib_rp->user_ctx;
1380 vl_api_registration_t **regpp;
1381 vl_api_registration_t *regp = 0;
1383 /* For horizontal scaling, add a hash table... */
1385 pool_foreach (regpp, am->vl_clients,
1388 if (regp && regp->vlib_rp == vlib_rp)
1390 vlib_cli_output (vm, "%s segment rings:", regp->name);
1394 vlib_cli_output (vm, "regp %llx not found?", regp);
1398 vlib_cli_output (vm, "%U", format_api_message_rings, am,
1399 0 /* print header */ , 0 /* notused */ );
1400 vlib_cli_output (vm, "%U", format_api_message_rings, am,
1401 shmem_hdr, 0 /* main segment */ );
1407 void dump_socket_clients (vlib_main_t * vm, api_main_t * am)
1408 __attribute__ ((weak));
1411 dump_socket_clients (vlib_main_t * vm, api_main_t * am)
1415 static clib_error_t *
1416 vl_api_client_command (vlib_main_t * vm,
1417 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
1419 vl_api_registration_t **regpp, *regp;
1420 unix_shared_memory_queue_t *q;
1422 api_main_t *am = &api_main;
1423 u32 *confused_indices = 0;
1425 if (!pool_elts (am->vl_clients))
1426 goto socket_clients;
1427 vlib_cli_output (vm, "Shared memory clients");
1428 vlib_cli_output (vm, "%16s %8s %14s %18s %s",
1429 "Name", "PID", "Queue Length", "Queue VA", "Health");
1432 pool_foreach (regpp, am->vl_clients,
1438 if (regp->unanswered_pings > 0)
1439 health = "questionable";
1443 q = regp->vl_input_queue;
1445 vlib_cli_output (vm, "%16s %8d %14d 0x%016llx %s\n",
1446 regp->name, q->consumer_pid, q->cursize,
1451 clib_warning ("NULL client registration index %d",
1452 regpp - am->vl_clients);
1453 vec_add1 (confused_indices, regpp - am->vl_clients);
1458 /* This should "never happen," but if it does, fix it... */
1459 if (PREDICT_FALSE (vec_len (confused_indices) > 0))
1462 for (i = 0; i < vec_len (confused_indices); i++)
1464 pool_put_index (am->vl_clients, confused_indices[i]);
1467 vec_free (confused_indices);
1469 if (am->missing_clients)
1470 vlib_cli_output (vm, "%u messages with missing clients",
1471 am->missing_clients);
1473 dump_socket_clients (vm, am);
1478 static clib_error_t *
1479 vl_api_status_command (vlib_main_t * vm,
1480 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
1482 api_main_t *am = &api_main;
1484 // check if rx_trace and tx_trace are not null pointers
1486 if (am->rx_trace == 0)
1488 vlib_cli_output (vm, "RX Trace disabled\n");
1492 if (am->rx_trace->enabled == 0)
1493 vlib_cli_output (vm, "RX Trace disabled\n");
1495 vlib_cli_output (vm, "RX Trace enabled\n");
1498 if (am->tx_trace == 0)
1500 vlib_cli_output (vm, "TX Trace disabled\n");
1504 if (am->tx_trace->enabled == 0)
1505 vlib_cli_output (vm, "TX Trace disabled\n");
1507 vlib_cli_output (vm, "TX Trace enabled\n");
1514 VLIB_CLI_COMMAND (cli_show_api_command, static) =
1517 .short_help = "Show API information",
1522 * Display binary api message allocation ring statistics
1525 VLIB_CLI_COMMAND (cli_show_api_ring_command, static) =
1527 .path = "show api ring-stats",
1528 .short_help = "Message ring statistics",
1529 .function = vl_api_ring_command,
1534 * Display current api client connections
1537 VLIB_CLI_COMMAND (cli_show_api_clients_command, static) =
1539 .path = "show api clients",
1540 .short_help = "Client information",
1541 .function = vl_api_client_command,
1546 * Display the current api message tracing status
1549 VLIB_CLI_COMMAND (cli_show_api_status_command, static) =
1551 .path = "show api trace-status",
1552 .short_help = "Display API trace status",
1553 .function = vl_api_status_command,
1557 static clib_error_t *
1558 vl_api_message_table_command (vlib_main_t * vm,
1559 unformat_input_t * input,
1560 vlib_cli_command_t * cli_cmd)
1562 api_main_t *am = &api_main;
1566 if (unformat (input, "verbose"))
1571 vlib_cli_output (vm, "%-4s %s", "ID", "Name");
1573 vlib_cli_output (vm, "%-4s %-40s %6s %7s", "ID", "Name", "Bounce",
1576 for (i = 1; i < vec_len (am->msg_names); i++)
1580 vlib_cli_output (vm, "%-4d %s", i,
1581 am->msg_names[i] ? am->msg_names[i] :
1586 vlib_cli_output (vm, "%-4d %-40s %6d %7d", i,
1587 am->msg_names[i] ? am->msg_names[i] :
1588 " [no handler]", am->message_bounce[i],
1597 * Display the current api message decode tables
1600 VLIB_CLI_COMMAND (cli_show_api_message_table_command, static) =
1602 .path = "show api message-table",
1603 .short_help = "Message Table",
1604 .function = vl_api_message_table_command,
1608 static clib_error_t *
1609 vl_api_trace_command (vlib_main_t * vm,
1610 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
1613 vl_api_trace_which_t which = VL_API_TRACE_RX;
1614 api_main_t *am = &api_main;
1616 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1618 if (unformat (input, "rx nitems %u", &nitems) || unformat (input, "rx"))
1620 else if (unformat (input, "tx nitems %u", &nitems)
1621 || unformat (input, "tx"))
1623 which = VL_API_TRACE_RX;
1626 else if (unformat (input, "on rx"))
1628 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 1);
1630 else if (unformat (input, "on tx"))
1632 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 1);
1634 else if (unformat (input, "on"))
1636 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 1);
1638 else if (unformat (input, "off"))
1640 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 0);
1641 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 0);
1643 else if (unformat (input, "free"))
1645 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 0);
1646 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 0);
1647 vl_msg_api_trace_free (am, VL_API_TRACE_RX);
1648 vl_msg_api_trace_free (am, VL_API_TRACE_TX);
1650 else if (unformat (input, "debug on"))
1652 am->msg_print_flag = 1;
1654 else if (unformat (input, "debug off"))
1656 am->msg_print_flag = 0;
1659 return clib_error_return (0, "unknown input `%U'",
1660 format_unformat_error, input);
1665 if (vl_msg_api_trace_configure (am, which, nitems))
1667 vlib_cli_output (vm, "warning: trace configure error (%d, %d)",
1675 * Control the binary API trace mechanism
1678 VLIB_CLI_COMMAND (trace, static) =
1680 .path = "set api-trace [on][on tx][on rx][off][free][debug on][debug off]",
1681 .short_help = "API trace",
1682 .function = vl_api_trace_command,
1687 vlibmemory_init (vlib_main_t * vm)
1689 api_main_t *am = &api_main;
1690 svm_map_region_args_t _a, *a = &_a;
1691 clib_error_t *error;
1693 memset (a, 0, sizeof (*a));
1694 a->root_path = am->root_path;
1695 a->name = SVM_GLOBAL_REGION_NAME;
1696 a->baseva = (am->global_baseva != 0) ?
1697 am->global_baseva : SVM_GLOBAL_REGION_BASEVA;
1698 a->size = (am->global_size != 0) ? am->global_size : SVM_GLOBAL_REGION_SIZE;
1699 a->flags = SVM_FLAGS_NODATA;
1700 a->uid = am->api_uid;
1701 a->gid = am->api_gid;
1703 (am->global_pvt_heap_size !=
1704 0) ? am->global_pvt_heap_size : SVM_PVT_MHEAP_SIZE;
1706 svm_region_init_args (a);
1708 error = vlib_call_init_function (vm, vlibsocket_init);
1713 VLIB_INIT_FUNCTION (vlibmemory_init);
1716 vl_set_memory_region_name (const char *name)
1718 api_main_t *am = &api_main;
1720 am->region_name = name;
1724 range_compare (vl_api_msg_range_t * a0, vl_api_msg_range_t * a1)
1726 int len0, len1, clen;
1728 len0 = vec_len (a0->name);
1729 len1 = vec_len (a1->name);
1730 clen = len0 < len1 ? len0 : len1;
1731 return (strncmp ((char *) a0->name, (char *) a1->name, clen));
1735 format_api_msg_range (u8 * s, va_list * args)
1737 vl_api_msg_range_t *rp = va_arg (*args, vl_api_msg_range_t *);
1740 s = format (s, "%-50s%9s%9s", "Name", "First-ID", "Last-ID");
1742 s = format (s, "%-50s%9d%9d", rp->name, rp->first_msg_id,
1748 static clib_error_t *
1749 vl_api_show_plugin_command (vlib_main_t * vm,
1750 unformat_input_t * input,
1751 vlib_cli_command_t * cli_cmd)
1753 api_main_t *am = &api_main;
1754 vl_api_msg_range_t *rp = 0;
1757 if (vec_len (am->msg_ranges) == 0)
1759 vlib_cli_output (vm, "No plugin API message ranges configured...");
1763 rp = vec_dup (am->msg_ranges);
1765 vec_sort_with_function (rp, range_compare);
1767 vlib_cli_output (vm, "Plugin API message ID ranges...\n");
1768 vlib_cli_output (vm, "%U", format_api_msg_range, 0 /* header */ );
1770 for (i = 0; i < vec_len (rp); i++)
1771 vlib_cli_output (vm, "%U", format_api_msg_range, rp + i);
1779 * Display the plugin binary API message range table
1782 VLIB_CLI_COMMAND (cli_show_api_plugin_command, static) =
1784 .path = "show api plugin",
1785 .short_help = "show api plugin",
1786 .function = vl_api_show_plugin_command,
1791 vl_api_rpc_call_t_handler (vl_api_rpc_call_t * mp)
1793 vl_api_rpc_call_reply_t *rmp;
1796 vlib_main_t *vm = vlib_get_main ();
1798 if (mp->function == 0)
1801 clib_warning ("rpc NULL function pointer");
1806 if (mp->need_barrier_sync)
1807 vlib_worker_thread_barrier_sync (vm);
1809 fp = uword_to_pointer (mp->function, int (*)(void *));
1812 if (mp->need_barrier_sync)
1813 vlib_worker_thread_barrier_release (vm);
1818 unix_shared_memory_queue_t *q =
1819 vl_api_client_index_to_input_queue (mp->client_index);
1822 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
1823 rmp->_vl_msg_id = ntohs (VL_API_RPC_CALL_REPLY);
1824 rmp->context = mp->context;
1826 vl_msg_api_send_shmem (q, (u8 *) & rmp);
1831 clib_warning ("multicast not yet implemented...");
1836 vl_api_rpc_call_reply_t_handler (vl_api_rpc_call_reply_t * mp)
1838 clib_warning ("unimplemented");
1842 vl_api_rpc_call_main_thread_inline (void *fp, u8 * data, u32 data_length,
1845 vl_api_rpc_call_t *mp;
1846 api_main_t *am = &api_main;
1847 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
1848 unix_shared_memory_queue_t *q;
1850 /* Main thread: call the function directly */
1851 if ((force_rpc == 0) && (vlib_get_thread_index () == 0))
1853 vlib_main_t *vm = vlib_get_main ();
1854 void (*call_fp) (void *);
1856 vlib_worker_thread_barrier_sync (vm);
1861 vlib_worker_thread_barrier_release (vm);
1865 /* Any other thread, actually do an RPC call... */
1866 mp = vl_msg_api_alloc_as_if_client (sizeof (*mp) + data_length);
1868 memset (mp, 0, sizeof (*mp));
1869 clib_memcpy (mp->data, data, data_length);
1870 mp->_vl_msg_id = ntohs (VL_API_RPC_CALL);
1871 mp->function = pointer_to_uword (fp);
1872 mp->need_barrier_sync = 1;
1875 * Use the "normal" control-plane mechanism for the main thread.
1876 * Well, almost. if the main input queue is full, we cannot
1877 * block. Otherwise, we can expect a barrier sync timeout.
1879 q = shmem_hdr->vl_input_queue;
1881 while (pthread_mutex_trylock (&q->mutex))
1882 vlib_worker_thread_barrier_check ();
1884 while (PREDICT_FALSE (unix_shared_memory_queue_is_full (q)))
1886 pthread_mutex_unlock (&q->mutex);
1887 vlib_worker_thread_barrier_check ();
1888 while (pthread_mutex_trylock (&q->mutex))
1889 vlib_worker_thread_barrier_check ();
1892 vl_msg_api_send_shmem_nolock (q, (u8 *) & mp);
1894 pthread_mutex_unlock (&q->mutex);
1898 * Check if called from worker threads.
1899 * If so, make rpc call of fp through shmem.
1900 * Otherwise, call fp directly
1903 vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length)
1905 vl_api_rpc_call_main_thread_inline (fp, data, data_length, /*force_rpc */
1910 * Always make rpc call of fp through shmem, useful for calling from threads
1911 * not setup as worker threads, such as DPDK callback thread
1914 vl_api_force_rpc_call_main_thread (void *fp, u8 * data, u32 data_length)
1916 vl_api_rpc_call_main_thread_inline (fp, data, data_length, /*force_rpc */
1921 vl_api_trace_plugin_msg_ids_t_handler (vl_api_trace_plugin_msg_ids_t * mp)
1923 api_main_t *am = &api_main;
1924 vl_api_msg_range_t *rp;
1927 /* Noop (except for tracing) during normal operation */
1928 if (am->replay_in_progress == 0)
1931 p = hash_get_mem (am->msg_range_by_name, mp->plugin_name);
1934 clib_warning ("WARNING: traced plugin '%s' not in current image",
1939 rp = vec_elt_at_index (am->msg_ranges, p[0]);
1940 if (rp->first_msg_id != clib_net_to_host_u16 (mp->first_msg_id))
1942 clib_warning ("WARNING: traced plugin '%s' first message id %d not %d",
1943 mp->plugin_name, clib_net_to_host_u16 (mp->first_msg_id),
1947 if (rp->last_msg_id != clib_net_to_host_u16 (mp->last_msg_id))
1949 clib_warning ("WARNING: traced plugin '%s' last message id %d not %d",
1950 mp->plugin_name, clib_net_to_host_u16 (mp->last_msg_id),
1955 #define foreach_rpc_api_msg \
1956 _(RPC_CALL,rpc_call) \
1957 _(RPC_CALL_REPLY,rpc_call_reply)
1959 #define foreach_plugin_trace_msg \
1960 _(TRACE_PLUGIN_MSG_IDS,trace_plugin_msg_ids)
1963 * Set the rpc callback at our earliest possible convenience.
1964 * This avoids ordering issues between thread_init() -> start_workers and
1965 * an init function which we could define here. If we ever intend to use
1966 * vlib all by itself, we can't create a link-time dependency on
1967 * an init function here and a typical "call foo_init first"
1971 extern void *rpc_call_main_thread_cb_fn;
1973 static clib_error_t *
1974 rpc_api_hookup (vlib_main_t * vm)
1976 api_main_t *am = &api_main;
1978 vl_msg_api_set_handlers(VL_API_##N, #n, \
1979 vl_api_##n##_t_handler, \
1982 vl_api_##n##_t_print, \
1983 sizeof(vl_api_##n##_t), 0 /* do not trace */);
1984 foreach_rpc_api_msg;
1988 vl_msg_api_set_handlers(VL_API_##N, #n, \
1989 vl_api_##n##_t_handler, \
1992 vl_api_##n##_t_print, \
1993 sizeof(vl_api_##n##_t), 1 /* do trace */);
1994 foreach_plugin_trace_msg;
1997 /* No reason to halt the parade to create a trace record... */
1998 am->is_mp_safe[VL_API_TRACE_PLUGIN_MSG_IDS] = 1;
1999 rpc_call_main_thread_cb_fn = vl_api_rpc_call_main_thread;
2003 VLIB_API_INIT_FUNCTION (rpc_api_hookup);
2014 format_vl_msg_api_trace_status (u8 * s, va_list * args)
2016 api_main_t *am = va_arg (*args, api_main_t *);
2017 vl_api_trace_which_t which = va_arg (*args, vl_api_trace_which_t);
2023 case VL_API_TRACE_TX:
2025 trace_name = "TX trace";
2028 case VL_API_TRACE_RX:
2030 trace_name = "RX trace";
2039 s = format (s, "%s: not yet configured.\n", trace_name);
2043 s = format (s, "%s: used %d of %d items, %s enabled, %s wrapped\n",
2044 trace_name, vec_len (tp->traces), tp->nitems,
2045 tp->enabled ? "is" : "is not", tp->wrapped ? "has" : "has not");
2049 void vl_msg_api_custom_dump_configure (api_main_t * am)
2050 __attribute__ ((weak));
2052 vl_msg_api_custom_dump_configure (api_main_t * am)
2057 vl_msg_api_process_file (vlib_main_t * vm, u8 * filename,
2058 u32 first_index, u32 last_index,
2059 vl_api_replay_t which)
2061 vl_api_trace_file_header_t *hp;
2066 u8 endian_swap_needed = 0;
2067 api_main_t *am = &api_main;
2070 void **saved_print_handlers = 0;
2072 fd = open ((char *) filename, O_RDONLY);
2076 vlib_cli_output (vm, "Couldn't open %s\n", filename);
2080 if (fstat (fd, &statb) < 0)
2082 vlib_cli_output (vm, "Couldn't stat %s\n", filename);
2087 if (!(statb.st_mode & S_IFREG) || (statb.st_size < sizeof (*hp)))
2089 vlib_cli_output (vm, "File not plausible: %s\n", filename);
2094 file_size = statb.st_size;
2095 file_size = (file_size + 4095) & ~(4096);
2097 hp = mmap (0, file_size, PROT_READ, MAP_PRIVATE, fd, 0);
2099 if (hp == (vl_api_trace_file_header_t *) MAP_FAILED)
2101 vlib_cli_output (vm, "mmap failed: %s\n", filename);
2107 if ((clib_arch_is_little_endian && hp->endian == VL_API_BIG_ENDIAN)
2108 || (clib_arch_is_big_endian && hp->endian == VL_API_LITTLE_ENDIAN))
2109 endian_swap_needed = 1;
2111 if (endian_swap_needed)
2112 nitems = ntohl (hp->nitems);
2114 nitems = hp->nitems;
2116 if (last_index == (u32) ~ 0)
2118 last_index = nitems - 1;
2121 if (first_index >= nitems || last_index >= nitems)
2123 vlib_cli_output (vm, "Range (%d, %d) outside file range (0, %d)\n",
2124 first_index, last_index, nitems - 1);
2125 munmap (hp, file_size);
2129 vlib_cli_output (vm,
2130 "Note: wrapped/incomplete trace, results may vary\n");
2132 if (which == CUSTOM_DUMP)
2134 saved_print_handlers = (void **) vec_dup (am->msg_print_handlers);
2135 vl_msg_api_custom_dump_configure (am);
2139 msg = (u8 *) (hp + 1);
2141 for (i = 0; i < first_index; i++)
2147 size = clib_host_to_net_u32 (*(u32 *) msg);
2148 msg += sizeof (u32);
2150 if (clib_arch_is_little_endian)
2151 msg_id = ntohs (*((u16 *) msg));
2153 msg_id = *((u16 *) msg);
2155 cfgp = am->api_trace_cfg + msg_id;
2158 vlib_cli_output (vm, "Ugh: msg id %d no trace config\n", msg_id);
2159 munmap (hp, file_size);
2165 if (which == REPLAY)
2166 am->replay_in_progress = 1;
2168 for (; i <= last_index; i++)
2176 vlib_cli_output (vm, "---------- trace %d -----------\n", i);
2178 size = clib_host_to_net_u32 (*(u32 *) msg);
2179 msg += sizeof (u32);
2181 if (clib_arch_is_little_endian)
2182 msg_id = ntohs (*((u16 *) msg));
2184 msg_id = *((u16 *) msg);
2186 cfgp = am->api_trace_cfg + msg_id;
2189 vlib_cli_output (vm, "Ugh: msg id %d no trace config\n", msg_id);
2190 munmap (hp, file_size);
2192 am->replay_in_progress = 0;
2196 /* Copy the buffer (from the read-only mmap'ed file) */
2197 vec_validate (tmpbuf, size - 1 + sizeof (uword));
2198 clib_memcpy (tmpbuf + sizeof (uword), msg, size);
2199 memset (tmpbuf, 0xf, sizeof (uword));
2202 * Endian swap if needed. All msg data is supposed to be
2203 * in network byte order. All msg handlers are supposed to
2204 * know that. The generic message dumpers don't know that.
2205 * One could fix apigen, I suppose.
2207 if ((which == DUMP && clib_arch_is_little_endian) || endian_swap_needed)
2209 void (*endian_fp) (void *);
2210 if (msg_id >= vec_len (am->msg_endian_handlers)
2211 || (am->msg_endian_handlers[msg_id] == 0))
2213 vlib_cli_output (vm, "Ugh: msg id %d no endian swap\n", msg_id);
2214 munmap (hp, file_size);
2216 am->replay_in_progress = 0;
2219 endian_fp = am->msg_endian_handlers[msg_id];
2220 (*endian_fp) (tmpbuf + sizeof (uword));
2223 /* msg_id always in network byte order */
2224 if (clib_arch_is_little_endian)
2226 msg_idp = (u16 *) (tmpbuf + sizeof (uword));
2234 if (msg_id < vec_len (am->msg_print_handlers) &&
2235 am->msg_print_handlers[msg_id])
2237 u8 *(*print_fp) (void *, void *);
2239 print_fp = (void *) am->msg_print_handlers[msg_id];
2240 (*print_fp) (tmpbuf + sizeof (uword), vm);
2244 vlib_cli_output (vm, "Skipping msg id %d: no print fcn\n",
2251 if (msg_id < vec_len (am->msg_print_handlers) &&
2252 am->msg_print_handlers[msg_id])
2256 u8 *(*print_fp) (void *, void *);
2258 print_fp = (void *) am->msg_print_handlers[msg_id];
2260 vlib_cli_output (vm, "/*");
2262 (*print_fp) (tmpbuf + sizeof (uword), vm);
2263 vlib_cli_output (vm, "*/\n");
2265 s = format (0, "static u8 * vl_api_%s_%d[%d] = {",
2266 am->msg_names[msg_id], i,
2267 am->api_trace_cfg[msg_id].size);
2269 for (j = 0; j < am->api_trace_cfg[msg_id].size; j++)
2272 s = format (s, "\n ");
2273 s = format (s, "0x%02x,", tmpbuf[sizeof (uword) + j]);
2275 s = format (s, "\n};\n%c", 0);
2276 vlib_cli_output (vm, (char *) s);
2282 if (msg_id < vec_len (am->msg_print_handlers) &&
2283 am->msg_print_handlers[msg_id] && cfgp->replay_enable)
2285 void (*handler) (void *);
2287 handler = (void *) am->msg_handlers[msg_id];
2289 if (!am->is_mp_safe[msg_id])
2290 vl_msg_api_barrier_sync ();
2291 (*handler) (tmpbuf + sizeof (uword));
2292 if (!am->is_mp_safe[msg_id])
2293 vl_msg_api_barrier_release ();
2297 if (cfgp->replay_enable)
2298 vlib_cli_output (vm, "Skipping msg id %d: no handler\n",
2305 _vec_len (tmpbuf) = 0;
2309 if (saved_print_handlers)
2311 clib_memcpy (am->msg_print_handlers, saved_print_handlers,
2312 vec_len (am->msg_print_handlers) * sizeof (void *));
2313 vec_free (saved_print_handlers);
2316 munmap (hp, file_size);
2318 am->replay_in_progress = 0;
2321 static clib_error_t *
2322 api_trace_command_fn (vlib_main_t * vm,
2323 unformat_input_t * input, vlib_cli_command_t * cmd)
2325 u32 nitems = 256 << 10;
2326 api_main_t *am = &api_main;
2327 vl_api_trace_which_t which = VL_API_TRACE_RX;
2330 u32 last = (u32) ~ 0;
2334 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2336 if (unformat (input, "on") || unformat (input, "enable"))
2338 if (unformat (input, "nitems %d", &nitems))
2340 vl_msg_api_trace_configure (am, which, nitems);
2341 vl_msg_api_trace_onoff (am, which, 1 /* on */ );
2343 else if (unformat (input, "off"))
2345 vl_msg_api_trace_onoff (am, which, 0);
2347 else if (unformat (input, "save %s", &filename))
2349 u8 *chroot_filename;
2350 if (strstr ((char *) filename, "..")
2351 || index ((char *) filename, '/'))
2353 vlib_cli_output (vm, "illegal characters in filename '%s'",
2358 chroot_filename = format (0, "/tmp/%s%c", filename, 0);
2360 vec_free (filename);
2362 fp = fopen ((char *) chroot_filename, "w");
2365 vlib_cli_output (vm, "Couldn't create %s\n", chroot_filename);
2368 rv = vl_msg_api_trace_save (am, which, fp);
2371 vlib_cli_output (vm, "API Trace data not present\n");
2373 vlib_cli_output (vm, "File for writing is closed\n");
2375 vlib_cli_output (vm, "Error while writing header to file\n");
2377 vlib_cli_output (vm, "Error while writing trace to file\n");
2379 vlib_cli_output (vm,
2380 "Error while writing end of buffer trace to file\n");
2382 vlib_cli_output (vm,
2383 "Error while writing start of buffer trace to file\n");
2385 vlib_cli_output (vm, "Unkown error while saving: %d", rv);
2387 vlib_cli_output (vm, "API trace saved to %s\n", chroot_filename);
2388 vec_free (chroot_filename);
2390 else if (unformat (input, "dump %s", &filename))
2392 vl_msg_api_process_file (vm, filename, first, last, DUMP);
2394 else if (unformat (input, "custom-dump %s", &filename))
2396 vl_msg_api_process_file (vm, filename, first, last, CUSTOM_DUMP);
2398 else if (unformat (input, "replay %s", &filename))
2400 vl_msg_api_process_file (vm, filename, first, last, REPLAY);
2402 else if (unformat (input, "initializers %s", &filename))
2404 vl_msg_api_process_file (vm, filename, first, last, INITIALIZERS);
2406 else if (unformat (input, "tx"))
2408 which = VL_API_TRACE_TX;
2410 else if (unformat (input, "first %d", &first))
2414 else if (unformat (input, "last %d", &last))
2418 else if (unformat (input, "status"))
2420 vlib_cli_output (vm, "%U", format_vl_msg_api_trace_status,
2423 else if (unformat (input, "free"))
2425 vl_msg_api_trace_onoff (am, which, 0);
2426 vl_msg_api_trace_free (am, which);
2428 else if (unformat (input, "post-mortem-on"))
2429 vl_msg_api_post_mortem_dump_enable_disable (1 /* enable */ );
2430 else if (unformat (input, "post-mortem-off"))
2431 vl_msg_api_post_mortem_dump_enable_disable (0 /* enable */ );
2433 return clib_error_return (0, "unknown input `%U'",
2434 format_unformat_error, input);
2440 * Display, replay, or save a binary API trace
2444 VLIB_CLI_COMMAND (api_trace_command, static) =
2446 .path = "api trace",
2448 "api trace [on|off][dump|save|replay <file>][status][free][post-mortem-on]",
2449 .function = api_trace_command_fn,
2453 static clib_error_t *
2454 api_config_fn (vlib_main_t * vm, unformat_input_t * input)
2456 u32 nitems = 256 << 10;
2457 vl_api_trace_which_t which = VL_API_TRACE_RX;
2458 api_main_t *am = &api_main;
2460 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2462 if (unformat (input, "on") || unformat (input, "enable"))
2464 if (unformat (input, "nitems %d", &nitems))
2466 vl_msg_api_trace_configure (am, which, nitems);
2467 vl_msg_api_trace_onoff (am, which, 1 /* on */ );
2468 vl_msg_api_post_mortem_dump_enable_disable (1 /* enable */ );
2470 else if (unformat (input, "save-api-table %s",
2471 &am->save_msg_table_filename))
2474 return clib_error_return (0, "unknown input `%U'",
2475 format_unformat_error, input);
2481 * This module has three configuration parameters:
2482 * "on" or "enable" - enables binary api tracing
2483 * "nitems <nnn>" - sets the size of the circular buffer to <nnn>
2484 * "save-api-table <filename>" - dumps the API message table to /tmp/<filename>
2486 VLIB_CONFIG_FUNCTION (api_config_fn, "api-trace");
2488 static clib_error_t *
2489 api_queue_config_fn (vlib_main_t * vm, unformat_input_t * input)
2491 api_main_t *am = &api_main;
2494 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2496 if (unformat (input, "length %d", &nitems) ||
2497 (unformat (input, "len %d", &nitems)))
2500 am->vlib_input_queue_length = nitems;
2502 clib_warning ("vlib input queue length %d too small, ignored",
2506 return clib_error_return (0, "unknown input `%U'",
2507 format_unformat_error, input);
2512 VLIB_CONFIG_FUNCTION (api_queue_config_fn, "api-queue");
2515 extract_name (u8 * s)
2521 while (vec_len (rv) && rv[vec_len (rv)] != '_')
2524 rv[vec_len (rv)] = 0;
2530 extract_crc (u8 * s)
2537 for (i = vec_len (rv) - 1; i >= 0; i--)
2541 vec_delete (rv, i + 1, 0);
2555 } msg_table_unserialize_t;
2558 table_id_cmp (void *a1, void *a2)
2560 msg_table_unserialize_t *n1 = a1;
2561 msg_table_unserialize_t *n2 = a2;
2563 return (n1->msg_index - n2->msg_index);
2567 table_name_and_crc_cmp (void *a1, void *a2)
2569 msg_table_unserialize_t *n1 = a1;
2570 msg_table_unserialize_t *n2 = a2;
2572 return strcmp ((char *) n1->name_and_crc, (char *) n2->name_and_crc);
2575 static clib_error_t *
2576 dump_api_table_file_command_fn (vlib_main_t * vm,
2577 unformat_input_t * input,
2578 vlib_cli_command_t * cmd)
2581 api_main_t *am = &api_main;
2582 serialize_main_t _sm, *sm = &_sm;
2583 clib_error_t *error;
2587 int compare_current = 0;
2588 int numeric_sort = 0;
2589 msg_table_unserialize_t *table = 0, *item;
2591 u32 ndifferences = 0;
2593 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2595 if (unformat (input, "file %s", &filename))
2597 else if (unformat (input, "compare-current")
2598 || unformat (input, "compare"))
2599 compare_current = 1;
2600 else if (unformat (input, "numeric"))
2603 return clib_error_return (0, "unknown input `%U'",
2604 format_unformat_error, input);
2607 if (numeric_sort && compare_current)
2608 return clib_error_return
2609 (0, "Comparison and numeric sorting are incompatible");
2612 return clib_error_return (0, "File not specified");
2614 /* Load the serialized message table from the table dump */
2616 error = unserialize_open_clib_file (sm, (char *) filename);
2621 unserialize_integer (sm, &nmsgs, sizeof (u32));
2623 for (i = 0; i < nmsgs; i++)
2625 msg_index = unserialize_likely_small_unsigned_integer (sm);
2626 unserialize_cstring (sm, (char **) &name_and_crc);
2627 vec_add2 (table, item, 1);
2628 item->msg_index = msg_index;
2629 item->name_and_crc = name_and_crc;
2630 item->name = extract_name (name_and_crc);
2631 item->crc = extract_crc (name_and_crc);
2632 item->which = 0; /* file */
2634 serialize_close (sm);
2636 /* Compare with the current image? */
2637 if (compare_current)
2639 /* Append the current message table */
2640 u8 *tblv = vl_api_serialize_message_table (am, 0);
2642 serialize_open_vector (sm, tblv);
2643 unserialize_integer (sm, &nmsgs, sizeof (u32));
2645 for (i = 0; i < nmsgs; i++)
2647 msg_index = unserialize_likely_small_unsigned_integer (sm);
2648 unserialize_cstring (sm, (char **) &name_and_crc);
2650 vec_add2 (table, item, 1);
2651 item->msg_index = msg_index;
2652 item->name_and_crc = name_and_crc;
2653 item->name = extract_name (name_and_crc);
2654 item->crc = extract_crc (name_and_crc);
2655 item->which = 1; /* current_image */
2660 /* Sort the table. */
2662 vec_sort_with_function (table, table_id_cmp);
2664 vec_sort_with_function (table, table_name_and_crc_cmp);
2666 if (compare_current)
2671 * In this case, the recovered table will have two entries per
2672 * API message. So, if entries i and i+1 match, the message definitions
2673 * are identical. Otherwise, the crc is different, or a message is
2674 * present in only one of the tables.
2676 vlib_cli_output (vm, "%=60s %s", "Message Name", "Result");
2678 for (i = 0; i < vec_len (table);)
2680 /* Last message lonely? */
2681 if (i == vec_len (table) - 1)
2687 /* Identical pair? */
2689 ((char *) table[i].name_and_crc,
2690 (char *) table[i + 1].name_and_crc,
2691 vec_len (table[i].name_and_crc)))
2699 /* Only in one of two tables? */
2700 if (strncmp ((char *) table[i].name, (char *) table[i + 1].name,
2701 vec_len (table[i].name)))
2704 vlib_cli_output (vm, "%-60s only in %s",
2705 table[i].name, table[i].which ?
2710 /* In both tables, but with different signatures */
2711 vlib_cli_output (vm, "%-60s definition changed", table[i].name);
2714 if (ndifferences == 0)
2715 vlib_cli_output (vm, "No api message signature differences found.");
2717 vlib_cli_output (vm, "Found %u api message signature differences",
2722 /* Dump the table, sorted as shown above */
2723 vlib_cli_output (vm, "%=60s %=8s %=10s", "Message name", "MsgID", "CRC");
2725 for (i = 0; i < vec_len (table); i++)
2728 vlib_cli_output (vm, "%-60s %8u %10s", item->name,
2729 item->msg_index, item->crc);
2733 for (i = 0; i < vec_len (table); i++)
2735 vec_free (table[i].name_and_crc);
2736 vec_free (table[i].name);
2737 vec_free (table[i].crc);
2746 * Displays a serialized API message decode table, sorted by message name
2749 * @cliexstart{show api dump file <filename>}
2750 * Message name MsgID CRC
2751 * accept_session 407 8e2a127e
2752 * accept_session_reply 408 67d8c22a
2753 * add_node_next 549 e4202993
2754 * add_node_next_reply 550 e89d6eed
2760 * Compares a serialized API message decode table with the current image
2763 * @cliexstart{show api dump file <filename> compare}
2764 * ip_add_del_route definition changed
2765 * ip_table_add_del definition changed
2766 * l2_macs_event only in image
2767 * vnet_ip4_fib_counters only in file
2768 * vnet_ip4_nbr_counters only in file
2773 * Display a serialized API message decode table, compare a saved
2774 * decode table with the current image, to establish API differences.
2778 VLIB_CLI_COMMAND (dump_api_table_file, static) =
2780 .path = "show api dump",
2781 .short_help = "show api dump file <filename> [numeric | compare-current]",
2782 .function = dump_api_table_file_command_fn,
2787 * fd.io coding-style-patch-verification: ON
2790 * eval: (c-set-style "gnu")