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);
473 #define foreach_vlib_api_msg \
474 _(MEMCLNT_CREATE, memclnt_create) \
475 _(MEMCLNT_DELETE, memclnt_delete) \
476 _(GET_FIRST_MSG_ID, get_first_msg_id) \
477 _(MEMCLNT_KEEPALIVE, memclnt_keepalive) \
478 _(MEMCLNT_KEEPALIVE_REPLY, memclnt_keepalive_reply)
484 memory_api_init (const char *region_name)
487 api_main_t *am = &api_main;
488 vl_msg_api_msg_config_t cfg;
489 vl_msg_api_msg_config_t *c = &cfg;
491 memset (c, 0, sizeof (*c));
493 if ((rv = vl_map_shmem (region_name, 1 /* is_vlib */ )) < 0)
496 #define _(N,n) do { \
497 c->id = VL_API_##N; \
499 c->handler = vl_api_##n##_t_handler; \
500 c->cleanup = vl_noop_handler; \
501 c->endian = vl_api_##n##_t_endian; \
502 c->print = vl_api_##n##_t_print; \
503 c->size = sizeof(vl_api_##n##_t); \
504 c->traced = 1; /* trace, so these msgs print */ \
505 c->replay = 0; /* don't replay client create/delete msgs */ \
506 c->message_bounce = 0; /* don't bounce this message */ \
507 vl_msg_api_config(c);} while (0);
509 foreach_vlib_api_msg;
513 * special-case freeing of memclnt_delete messages, so we can
514 * simply munmap pairwise / private API segments...
516 am->message_bounce[VL_API_MEMCLNT_DELETE] = 1;
517 am->is_mp_safe[VL_API_MEMCLNT_KEEPALIVE_REPLY] = 1;
522 #define foreach_histogram_bucket \
530 #define _(n) SLEEP_##n##_US,
531 foreach_histogram_bucket
536 static u64 vector_rate_histogram[SLEEP_N_BUCKETS];
538 static void memclnt_queue_callback (vlib_main_t * vm);
541 * Callback to send ourselves a plugin numbering-space trace msg
544 send_one_plugin_msg_ids_msg (u8 * name, u16 first_msg_id, u16 last_msg_id)
546 vl_api_trace_plugin_msg_ids_t *mp;
547 api_main_t *am = &api_main;
548 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
549 unix_shared_memory_queue_t *q;
551 mp = vl_msg_api_alloc_as_if_client (sizeof (*mp));
552 memset (mp, 0, sizeof (*mp));
554 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_TRACE_PLUGIN_MSG_IDS);
555 strncpy ((char *) mp->plugin_name, (char *) name,
556 sizeof (mp->plugin_name) - 1);
557 mp->first_msg_id = clib_host_to_net_u16 (first_msg_id);
558 mp->last_msg_id = clib_host_to_net_u16 (last_msg_id);
560 q = shmem_hdr->vl_input_queue;
562 vl_msg_api_send_shmem (q, (u8 *) & mp);
566 send_memclnt_keepalive (vl_api_registration_t * regp, f64 now)
568 vl_api_memclnt_keepalive_t *mp;
569 unix_shared_memory_queue_t *q;
570 api_main_t *am = &api_main;
571 svm_region_t *save_vlib_rp = am->vlib_rp;
572 vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
574 q = regp->vl_input_queue;
577 * If the queue head is moving, assume that the client is processing
578 * messages and skip the ping. This heuristic may fail if the queue
579 * is in the same position as last time, net of wrapping; in which
580 * case, the client will receive a keepalive.
582 if (regp->last_queue_head != q->head)
584 regp->last_heard = now;
585 regp->unanswered_pings = 0;
586 regp->last_queue_head = q->head;
591 * push/pop shared memory segment, so this routine
592 * will work with "normal" as well as "private segment"
596 am->vlib_rp = regp->vlib_rp;
597 am->shmem_hdr = regp->shmem_hdr;
599 mp = vl_msg_api_alloc (sizeof (*mp));
600 memset (mp, 0, sizeof (*mp));
601 mp->_vl_msg_id = clib_host_to_net_u16 (VL_API_MEMCLNT_KEEPALIVE);
602 mp->context = mp->client_index =
603 vl_msg_api_handle_from_index_and_epoch
604 (regp->vl_api_registration_pool_index,
605 am->shmem_hdr->application_restarts);
607 regp->unanswered_pings++;
609 /* Failure-to-send due to a stuffed queue is absolutely expected */
610 if (unix_shared_memory_queue_add (q, (u8 *) & mp, 1 /* nowait */ ))
611 vl_msg_api_free (mp);
613 am->vlib_rp = save_vlib_rp;
614 am->shmem_hdr = save_shmem_hdr;
618 dead_client_scan (api_main_t * am, vl_shmem_hdr_t * shm, f64 now)
621 vl_api_registration_t **regpp;
622 vl_api_registration_t *regp;
623 static u32 *dead_indices;
624 static u32 *confused_indices;
626 vec_reset_length (dead_indices);
627 vec_reset_length (confused_indices);
630 pool_foreach (regpp, am->vl_clients,
635 /* If we haven't heard from this client recently... */
636 if (regp->last_heard < (now - 10.0))
638 if (regp->unanswered_pings == 2)
640 unix_shared_memory_queue_t *q;
641 q = regp->vl_input_queue;
642 if (kill (q->consumer_pid, 0) >=0)
644 clib_warning ("REAPER: lazy binary API client '%s'",
646 regp->unanswered_pings = 0;
647 regp->last_heard = now;
651 clib_warning ("REAPER: binary API client '%s' died",
653 vec_add1(dead_indices, regpp - am->vl_clients);
657 send_memclnt_keepalive (regp, now);
660 regp->unanswered_pings = 0;
664 clib_warning ("NULL client registration index %d",
665 regpp - am->vl_clients);
666 vec_add1 (confused_indices, regpp - am->vl_clients);
670 /* This should "never happen," but if it does, fix it... */
671 if (PREDICT_FALSE (vec_len (confused_indices) > 0))
674 for (i = 0; i < vec_len (confused_indices); i++)
676 pool_put_index (am->vl_clients, confused_indices[i]);
680 if (PREDICT_FALSE (vec_len (dead_indices) > 0))
686 /* Allow the application to clean up its registrations */
687 for (i = 0; i < vec_len (dead_indices); i++)
689 regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
694 handle = vl_msg_api_handle_from_index_and_epoch
695 (dead_indices[i], shm->application_restarts);
696 (void) call_reaper_functions (handle);
701 pthread_mutex_lock (&svm->mutex);
702 oldheap = svm_push_data_heap (svm);
704 for (i = 0; i < vec_len (dead_indices); i++)
706 regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
709 /* Is this a pairwise SVM segment? */
710 if ((*regpp)->vlib_rp != svm)
713 svm_region_t *dead_rp = (*regpp)->vlib_rp;
714 /* Note: account for the memfd header page */
715 u64 virtual_base = dead_rp->virtual_base - MMAP_PAGESIZE;
716 u64 virtual_size = dead_rp->virtual_size + MMAP_PAGESIZE;
718 /* For horizontal scaling, add a hash table... */
719 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
720 if (am->vlib_private_rps[i] == dead_rp)
722 vec_delete (am->vlib_private_rps, 1, i);
725 clib_warning ("private rp %llx AWOL", dead_rp);
728 /* Kill it, accounting for the memfd header page */
729 if (munmap ((void *) virtual_base, virtual_size) < 0)
730 clib_unix_warning ("munmap");
731 /* Reset the queue-length-address cache */
732 vec_reset_length (vl_api_queue_cursizes);
736 /* Poison the old registration */
737 memset (*regpp, 0xF3, sizeof (**regpp));
738 clib_mem_free (*regpp);
740 /* no dangling references, please */
745 svm_pop_heap (oldheap);
746 clib_warning ("Duplicate free, client index %d",
747 regpp - am->vl_clients);
748 oldheap = svm_push_data_heap (svm);
752 svm_client_scan_this_region_nolock (am->vlib_rp);
754 pthread_mutex_unlock (&svm->mutex);
755 svm_pop_heap (oldheap);
756 for (i = 0; i < vec_len (dead_indices); i++)
757 pool_put_index (am->vl_clients, dead_indices[i]);
763 memclnt_process (vlib_main_t * vm,
764 vlib_node_runtime_t * node, vlib_frame_t * f)
768 unix_shared_memory_queue_t *q;
771 api_main_t *am = &api_main;
772 f64 dead_client_scan_time;
773 f64 sleep_time, start_time;
775 clib_error_t *socksvr_api_init (vlib_main_t * vm);
778 vl_socket_args_for_process_t *a;
780 uword *event_data = 0;
781 int private_segment_rotor = 0;
782 svm_region_t *vlib_rp;
785 vlib_set_queue_signal_callback (vm, memclnt_queue_callback);
787 if ((rv = memory_api_init (am->region_name)) < 0)
789 clib_warning ("memory_api_init returned %d, quitting...", rv);
793 if ((error = socksvr_api_init (vm)))
795 clib_error_report (error);
796 clib_warning ("socksvr_api_init failed, quitting...");
802 q = shm->vl_input_queue;
805 e = vlib_call_init_exit_functions
806 (vm, vm->api_init_function_registrations, 1 /* call_once */ );
808 clib_error_report (e);
811 dead_client_scan_time = vlib_time_now (vm) + 10.0;
814 * Send plugin message range messages for each plugin we loaded
816 for (i = 0; i < vec_len (am->msg_ranges); i++)
818 vl_api_msg_range_t *rp = am->msg_ranges + i;
819 send_one_plugin_msg_ids_msg (rp->name, rp->first_msg_id,
824 * Save the api message table snapshot, if configured
826 if (am->save_msg_table_filename)
830 u8 *serialized_message_table;
833 * Snapshoot the api message table.
835 if (strstr ((char *) am->save_msg_table_filename, "..")
836 || index ((char *) am->save_msg_table_filename, '/'))
838 clib_warning ("illegal save-message-table filename '%s'",
839 am->save_msg_table_filename);
843 chroot_file = format (0, "/tmp/%s%c", am->save_msg_table_filename, 0);
845 fd = creat ((char *) chroot_file, 0644);
849 clib_unix_warning ("creat");
853 serialized_message_table = vl_api_serialize_message_table (am, 0);
855 rv = write (fd, serialized_message_table,
856 vec_len (serialized_message_table));
858 if (rv != vec_len (serialized_message_table))
859 clib_unix_warning ("write");
863 clib_unix_warning ("close");
865 vec_free (chroot_file);
866 vec_free (serialized_message_table);
871 /* $$$ pay attention to frame size, control CPU usage */
878 * There's a reason for checking the queue before
879 * sleeping. If the vlib application crashes, it's entirely
880 * possible for a client to enqueue a connect request
881 * during the process restart interval.
883 * Unless some force of physics causes the new incarnation
884 * of the application to process the request, the client will
885 * sit and wait for Godot...
887 vector_rate = vlib_last_vector_length_per_node (vm);
888 start_time = vlib_time_now (vm);
891 pthread_mutex_lock (&q->mutex);
894 vm->api_queue_nonempty = 0;
895 pthread_mutex_unlock (&q->mutex);
897 if (TRACE_VLIB_MEMORY_QUEUE)
900 ELOG_TYPE_DECLARE (e) =
902 .format = "q-underflow: len %d",
910 ed = ELOG_DATA (&vm->elog_main, e);
917 headp = (i8 *) (q->data + sizeof (uword) * q->head);
918 clib_memcpy (&mp, headp, sizeof (uword));
921 need_broadcast = (q->cursize == q->maxsize / 2);
924 if (PREDICT_FALSE (q->head == q->maxsize))
926 pthread_mutex_unlock (&q->mutex);
928 (void) pthread_cond_broadcast (&q->condvar);
930 vl_msg_api_handler_with_vm_node (am, (void *) mp, vm, node);
932 /* Allow no more than 10us without a pause */
933 if (vlib_time_now (vm) > start_time + 10e-6)
935 int index = SLEEP_400_US;
936 if (vector_rate > 40.0)
938 else if (vector_rate > 20.0)
940 index = SLEEP_200_US;
943 else if (vector_rate >= 1.0)
945 index = SLEEP_100_US;
953 vector_rate_histogram[index] += 1;
959 * see if we have any private api shared-memory segments
960 * If so, push required context variables, and process
963 if (PREDICT_FALSE (vec_len (am->vlib_private_rps)))
965 unix_shared_memory_queue_t *save_vlib_input_queue = q;
966 vl_shmem_hdr_t *save_shmem_hdr = am->shmem_hdr;
967 svm_region_t *save_vlib_rp = am->vlib_rp;
969 vlib_rp = am->vlib_rp = am->vlib_private_rps[private_segment_rotor];
971 am->shmem_hdr = (void *) vlib_rp->user_ctx;
972 q = am->shmem_hdr->vl_input_queue;
974 pthread_mutex_lock (&q->mutex);
977 headp = (i8 *) (q->data + sizeof (uword) * q->head);
978 clib_memcpy (&mp, headp, sizeof (uword));
981 need_broadcast = (q->cursize == q->maxsize / 2);
984 if (PREDICT_FALSE (q->head == q->maxsize))
986 pthread_mutex_unlock (&q->mutex);
988 (void) pthread_cond_broadcast (&q->condvar);
990 pthread_mutex_unlock (&q->mutex);
992 vl_msg_api_handler_with_vm_node (am, (void *) mp, vm, node);
995 pthread_mutex_unlock (&q->mutex);
997 q = save_vlib_input_queue;
998 am->shmem_hdr = save_shmem_hdr;
999 am->vlib_rp = save_vlib_rp;
1001 private_segment_rotor++;
1002 if (private_segment_rotor >= vec_len (am->vlib_private_rps))
1003 private_segment_rotor = 0;
1006 vlib_process_wait_for_event_or_clock (vm, sleep_time);
1007 vec_reset_length (event_data);
1008 event_type = vlib_process_get_events (vm, &event_data);
1009 now = vlib_time_now (vm);
1013 case QUEUE_SIGNAL_EVENT:
1014 vm->queue_signal_pending = 0;
1017 case SOCKET_READ_EVENT:
1018 for (i = 0; i < vec_len (event_data); i++)
1020 a = pool_elt_at_index (socket_main.process_args, event_data[i]);
1021 vl_api_socket_process_msg (a->clib_file, a->regp,
1024 pool_put (socket_main.process_args, a);
1033 clib_warning ("unknown event type %d", event_type);
1037 if (now > dead_client_scan_time)
1039 dead_client_scan (am, shm, now);
1040 dead_client_scan_time = vlib_time_now (vm) + 10.0;
1043 if (TRACE_VLIB_MEMORY_QUEUE)
1046 ELOG_TYPE_DECLARE (e) = {
1047 .format = "q-awake: len %d",
1048 .format_args = "i4",
1055 ed = ELOG_DATA (&vm->elog_main, e);
1056 ed->len = q->cursize;
1063 VLIB_REGISTER_NODE (memclnt_node) =
1065 .function = memclnt_process,
1066 .type = VLIB_NODE_TYPE_PROCESS,
1067 .name = "api-rx-from-ring",
1068 .state = VLIB_NODE_STATE_DISABLED,
1073 static clib_error_t *
1074 vl_api_show_histogram_command (vlib_main_t * vm,
1075 unformat_input_t * input,
1076 vlib_cli_command_t * cli_cmd)
1078 u64 total_counts = 0;
1081 for (i = 0; i < SLEEP_N_BUCKETS; i++)
1083 total_counts += vector_rate_histogram[i];
1086 if (total_counts == 0)
1088 vlib_cli_output (vm, "No control-plane activity.");
1095 percent = ((f64) vector_rate_histogram[SLEEP_##n##_US]) \
1096 / (f64) total_counts; \
1098 vlib_cli_output (vm, "Sleep %3d us: %llu, %.2f%%",n, \
1099 vector_rate_histogram[SLEEP_##n##_US], \
1102 foreach_histogram_bucket;
1109 * Display the binary api sleep-time histogram
1112 VLIB_CLI_COMMAND (cli_show_api_histogram_command, static) =
1114 .path = "show api histogram",
1115 .short_help = "show api histogram",
1116 .function = vl_api_show_histogram_command,
1120 static clib_error_t *
1121 vl_api_clear_histogram_command (vlib_main_t * vm,
1122 unformat_input_t * input,
1123 vlib_cli_command_t * cli_cmd)
1127 for (i = 0; i < SLEEP_N_BUCKETS; i++)
1128 vector_rate_histogram[i] = 0;
1133 * Clear the binary api sleep-time histogram
1136 VLIB_CLI_COMMAND (cli_clear_api_histogram_command, static) =
1138 .path = "clear api histogram",
1139 .short_help = "clear api histogram",
1140 .function = vl_api_clear_histogram_command,
1144 volatile int **vl_api_queue_cursizes;
1147 memclnt_queue_callback (vlib_main_t * vm)
1150 api_main_t *am = &api_main;
1152 if (PREDICT_FALSE (vec_len (vl_api_queue_cursizes) !=
1153 1 + vec_len (am->vlib_private_rps)))
1155 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
1156 unix_shared_memory_queue_t *q;
1161 q = shmem_hdr->vl_input_queue;
1165 vec_add1 (vl_api_queue_cursizes, &q->cursize);
1167 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
1169 svm_region_t *vlib_rp = am->vlib_private_rps[i];
1171 shmem_hdr = (void *) vlib_rp->user_ctx;
1172 q = shmem_hdr->vl_input_queue;
1173 vec_add1 (vl_api_queue_cursizes, &q->cursize);
1177 for (i = 0; i < vec_len (vl_api_queue_cursizes); i++)
1179 if (*vl_api_queue_cursizes[i])
1181 vm->queue_signal_pending = 1;
1182 vm->api_queue_nonempty = 1;
1183 vlib_process_signal_event (vm, memclnt_node.index,
1184 /* event_type */ QUEUE_SIGNAL_EVENT,
1185 /* event_data */ 0);
1192 vl_enable_disable_memory_api (vlib_main_t * vm, int enable)
1194 vlib_node_set_state (vm, memclnt_node.index,
1196 ? VLIB_NODE_STATE_POLLING
1197 : VLIB_NODE_STATE_DISABLED));
1201 api_rx_from_node (vlib_main_t * vm,
1202 vlib_node_runtime_t * node, vlib_frame_t * frame)
1204 uword n_packets = frame->n_vectors;
1207 static u8 *long_msg;
1209 vec_validate (long_msg, 4095);
1210 n_left_from = frame->n_vectors;
1211 from = vlib_frame_args (frame);
1213 while (n_left_from > 0)
1221 b0 = vlib_get_buffer (vm, bi0);
1225 msg = b0->data + b0->current_data;
1226 msg_len = b0->current_length;
1227 if (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
1229 ASSERT (long_msg != 0);
1230 _vec_len (long_msg) = 0;
1231 vec_add (long_msg, msg, msg_len);
1232 while (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
1234 b0 = vlib_get_buffer (vm, b0->next_buffer);
1235 msg = b0->data + b0->current_data;
1236 msg_len = b0->current_length;
1237 vec_add (long_msg, msg, msg_len);
1241 vl_msg_api_handler_no_trace_no_free (msg);
1244 /* Free what we've been given. */
1245 vlib_buffer_free (vm, vlib_frame_args (frame), n_packets);
1251 VLIB_REGISTER_NODE (api_rx_from_node_node,static) = {
1252 .function = api_rx_from_node,
1253 .type = VLIB_NODE_TYPE_INTERNAL,
1255 .name = "api-rx-from-node",
1259 static clib_error_t *
1260 setup_memclnt_exit (vlib_main_t * vm)
1262 atexit (vl_unmap_shmem);
1266 VLIB_INIT_FUNCTION (setup_memclnt_exit);
1269 format_api_message_rings (u8 * s, va_list * args)
1271 api_main_t *am = va_arg (*args, api_main_t *);
1272 vl_shmem_hdr_t *shmem_hdr = va_arg (*args, vl_shmem_hdr_t *);
1273 int main_segment = va_arg (*args, int);
1278 return format (s, "%8s %8s %8s %8s %8s\n",
1279 "Owner", "Size", "Nitems", "Hits", "Misses");
1281 ap = shmem_hdr->vl_rings;
1283 for (i = 0; i < vec_len (shmem_hdr->vl_rings); i++)
1285 s = format (s, "%8s %8d %8d %8d %8d\n",
1286 "vlib", ap->size, ap->nitems, ap->hits, ap->misses);
1290 ap = shmem_hdr->client_rings;
1292 for (i = 0; i < vec_len (shmem_hdr->client_rings); i++)
1294 s = format (s, "%8s %8d %8d %8d %8d\n",
1295 "clnt", ap->size, ap->nitems, ap->hits, ap->misses);
1301 s = format (s, "%d ring miss fallback allocations\n", am->ring_misses);
1304 "%d application restarts, %d reclaimed msgs, %d garbage collects\n",
1305 shmem_hdr->application_restarts, shmem_hdr->restart_reclaims,
1306 shmem_hdr->garbage_collects);
1312 static clib_error_t *
1313 vl_api_ring_command (vlib_main_t * vm,
1314 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
1317 vl_shmem_hdr_t *shmem_hdr;
1318 api_main_t *am = &api_main;
1320 shmem_hdr = am->shmem_hdr;
1324 vlib_cli_output (vm, "Shared memory segment not initialized...\n");
1328 vlib_cli_output (vm, "Main API segment rings:");
1330 vlib_cli_output (vm, "%U", format_api_message_rings, am,
1331 0 /* print header */ , 0 /* notused */ );
1333 vlib_cli_output (vm, "%U", format_api_message_rings, am,
1334 shmem_hdr, 1 /* main segment */ );
1336 for (i = 0; i < vec_len (am->vlib_private_rps); i++)
1338 svm_region_t *vlib_rp = am->vlib_private_rps[i];
1339 shmem_hdr = (void *) vlib_rp->user_ctx;
1340 vl_api_registration_t **regpp;
1341 vl_api_registration_t *regp;
1343 /* For horizontal scaling, add a hash table... */
1345 pool_foreach (regpp, am->vl_clients,
1348 if (regp && regp->vlib_rp == vlib_rp)
1350 vlib_cli_output (vm, "%s segment rings:", regp->name);
1356 vlib_cli_output (vm, "%U", format_api_message_rings, am,
1357 shmem_hdr, 0 /* main segment */ );
1363 void dump_socket_clients (vlib_main_t * vm, api_main_t * am)
1364 __attribute__ ((weak));
1367 dump_socket_clients (vlib_main_t * vm, api_main_t * am)
1371 static clib_error_t *
1372 vl_api_client_command (vlib_main_t * vm,
1373 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
1375 vl_api_registration_t **regpp, *regp;
1376 unix_shared_memory_queue_t *q;
1378 api_main_t *am = &api_main;
1379 u32 *confused_indices = 0;
1381 if (!pool_elts (am->vl_clients))
1382 goto socket_clients;
1383 vlib_cli_output (vm, "Shared memory clients");
1384 vlib_cli_output (vm, "%16s %8s %14s %18s %s",
1385 "Name", "PID", "Queue Length", "Queue VA", "Health");
1388 pool_foreach (regpp, am->vl_clients,
1394 if (regp->unanswered_pings > 0)
1395 health = "questionable";
1399 q = regp->vl_input_queue;
1401 vlib_cli_output (vm, "%16s %8d %14d 0x%016llx %s\n",
1402 regp->name, q->consumer_pid, q->cursize,
1407 clib_warning ("NULL client registration index %d",
1408 regpp - am->vl_clients);
1409 vec_add1 (confused_indices, regpp - am->vl_clients);
1414 /* This should "never happen," but if it does, fix it... */
1415 if (PREDICT_FALSE (vec_len (confused_indices) > 0))
1418 for (i = 0; i < vec_len (confused_indices); i++)
1420 pool_put_index (am->vl_clients, confused_indices[i]);
1423 vec_free (confused_indices);
1425 if (am->missing_clients)
1426 vlib_cli_output (vm, "%u messages with missing clients",
1427 am->missing_clients);
1429 dump_socket_clients (vm, am);
1434 static clib_error_t *
1435 vl_api_status_command (vlib_main_t * vm,
1436 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
1438 api_main_t *am = &api_main;
1440 // check if rx_trace and tx_trace are not null pointers
1442 if (am->rx_trace == 0)
1444 vlib_cli_output (vm, "RX Trace disabled\n");
1448 if (am->rx_trace->enabled == 0)
1449 vlib_cli_output (vm, "RX Trace disabled\n");
1451 vlib_cli_output (vm, "RX Trace enabled\n");
1454 if (am->tx_trace == 0)
1456 vlib_cli_output (vm, "TX Trace disabled\n");
1460 if (am->tx_trace->enabled == 0)
1461 vlib_cli_output (vm, "TX Trace disabled\n");
1463 vlib_cli_output (vm, "TX Trace enabled\n");
1470 VLIB_CLI_COMMAND (cli_show_api_command, static) =
1473 .short_help = "Show API information",
1478 * Display binary api message allocation ring statistics
1481 VLIB_CLI_COMMAND (cli_show_api_ring_command, static) =
1483 .path = "show api ring-stats",
1484 .short_help = "Message ring statistics",
1485 .function = vl_api_ring_command,
1490 * Display current api client connections
1493 VLIB_CLI_COMMAND (cli_show_api_clients_command, static) =
1495 .path = "show api clients",
1496 .short_help = "Client information",
1497 .function = vl_api_client_command,
1502 * Display the current api message tracing status
1505 VLIB_CLI_COMMAND (cli_show_api_status_command, static) =
1507 .path = "show api trace-status",
1508 .short_help = "Display API trace status",
1509 .function = vl_api_status_command,
1513 static clib_error_t *
1514 vl_api_message_table_command (vlib_main_t * vm,
1515 unformat_input_t * input,
1516 vlib_cli_command_t * cli_cmd)
1518 api_main_t *am = &api_main;
1522 if (unformat (input, "verbose"))
1527 vlib_cli_output (vm, "%-4s %s", "ID", "Name");
1529 vlib_cli_output (vm, "%-4s %-40s %6s %7s", "ID", "Name", "Bounce",
1532 for (i = 1; i < vec_len (am->msg_names); i++)
1536 vlib_cli_output (vm, "%-4d %s", i,
1537 am->msg_names[i] ? am->msg_names[i] :
1542 vlib_cli_output (vm, "%-4d %-40s %6d %7d", i,
1543 am->msg_names[i] ? am->msg_names[i] :
1544 " [no handler]", am->message_bounce[i],
1553 * Display the current api message decode tables
1556 VLIB_CLI_COMMAND (cli_show_api_message_table_command, static) =
1558 .path = "show api message-table",
1559 .short_help = "Message Table",
1560 .function = vl_api_message_table_command,
1564 static clib_error_t *
1565 vl_api_trace_command (vlib_main_t * vm,
1566 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
1569 vl_api_trace_which_t which = VL_API_TRACE_RX;
1570 api_main_t *am = &api_main;
1572 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1574 if (unformat (input, "rx nitems %u", &nitems) || unformat (input, "rx"))
1576 else if (unformat (input, "tx nitems %u", &nitems)
1577 || unformat (input, "tx"))
1579 which = VL_API_TRACE_RX;
1582 else if (unformat (input, "on rx"))
1584 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 1);
1586 else if (unformat (input, "on tx"))
1588 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 1);
1590 else if (unformat (input, "on"))
1592 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 1);
1594 else if (unformat (input, "off"))
1596 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 0);
1597 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 0);
1599 else if (unformat (input, "free"))
1601 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 0);
1602 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 0);
1603 vl_msg_api_trace_free (am, VL_API_TRACE_RX);
1604 vl_msg_api_trace_free (am, VL_API_TRACE_TX);
1606 else if (unformat (input, "debug on"))
1608 am->msg_print_flag = 1;
1610 else if (unformat (input, "debug off"))
1612 am->msg_print_flag = 0;
1615 return clib_error_return (0, "unknown input `%U'",
1616 format_unformat_error, input);
1621 if (vl_msg_api_trace_configure (am, which, nitems))
1623 vlib_cli_output (vm, "warning: trace configure error (%d, %d)",
1631 * Control the binary API trace mechanism
1634 VLIB_CLI_COMMAND (trace, static) =
1636 .path = "set api-trace [on][on tx][on rx][off][free][debug on][debug off]",
1637 .short_help = "API trace",
1638 .function = vl_api_trace_command,
1643 vlibmemory_init (vlib_main_t * vm)
1645 api_main_t *am = &api_main;
1646 svm_map_region_args_t _a, *a = &_a;
1647 clib_error_t *error;
1649 memset (a, 0, sizeof (*a));
1650 a->root_path = am->root_path;
1651 a->name = SVM_GLOBAL_REGION_NAME;
1652 a->baseva = (am->global_baseva != 0) ?
1653 am->global_baseva : SVM_GLOBAL_REGION_BASEVA;
1654 a->size = (am->global_size != 0) ? am->global_size : SVM_GLOBAL_REGION_SIZE;
1655 a->flags = SVM_FLAGS_NODATA;
1656 a->uid = am->api_uid;
1657 a->gid = am->api_gid;
1659 (am->global_pvt_heap_size !=
1660 0) ? am->global_pvt_heap_size : SVM_PVT_MHEAP_SIZE;
1662 svm_region_init_args (a);
1664 error = vlib_call_init_function (vm, vlibsocket_init);
1669 VLIB_INIT_FUNCTION (vlibmemory_init);
1672 vl_set_memory_region_name (const char *name)
1674 api_main_t *am = &api_main;
1676 am->region_name = name;
1680 range_compare (vl_api_msg_range_t * a0, vl_api_msg_range_t * a1)
1682 int len0, len1, clen;
1684 len0 = vec_len (a0->name);
1685 len1 = vec_len (a1->name);
1686 clen = len0 < len1 ? len0 : len1;
1687 return (strncmp ((char *) a0->name, (char *) a1->name, clen));
1691 format_api_msg_range (u8 * s, va_list * args)
1693 vl_api_msg_range_t *rp = va_arg (*args, vl_api_msg_range_t *);
1696 s = format (s, "%-50s%9s%9s", "Name", "First-ID", "Last-ID");
1698 s = format (s, "%-50s%9d%9d", rp->name, rp->first_msg_id,
1704 static clib_error_t *
1705 vl_api_show_plugin_command (vlib_main_t * vm,
1706 unformat_input_t * input,
1707 vlib_cli_command_t * cli_cmd)
1709 api_main_t *am = &api_main;
1710 vl_api_msg_range_t *rp = 0;
1713 if (vec_len (am->msg_ranges) == 0)
1715 vlib_cli_output (vm, "No plugin API message ranges configured...");
1719 rp = vec_dup (am->msg_ranges);
1721 vec_sort_with_function (rp, range_compare);
1723 vlib_cli_output (vm, "Plugin API message ID ranges...\n");
1724 vlib_cli_output (vm, "%U", format_api_msg_range, 0 /* header */ );
1726 for (i = 0; i < vec_len (rp); i++)
1727 vlib_cli_output (vm, "%U", format_api_msg_range, rp + i);
1735 * Display the plugin binary API message range table
1738 VLIB_CLI_COMMAND (cli_show_api_plugin_command, static) =
1740 .path = "show api plugin",
1741 .short_help = "show api plugin",
1742 .function = vl_api_show_plugin_command,
1747 vl_api_rpc_call_t_handler (vl_api_rpc_call_t * mp)
1749 vl_api_rpc_call_reply_t *rmp;
1752 vlib_main_t *vm = vlib_get_main ();
1754 if (mp->function == 0)
1757 clib_warning ("rpc NULL function pointer");
1762 if (mp->need_barrier_sync)
1763 vlib_worker_thread_barrier_sync (vm);
1765 fp = uword_to_pointer (mp->function, int (*)(void *));
1768 if (mp->need_barrier_sync)
1769 vlib_worker_thread_barrier_release (vm);
1774 unix_shared_memory_queue_t *q =
1775 vl_api_client_index_to_input_queue (mp->client_index);
1778 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
1779 rmp->_vl_msg_id = ntohs (VL_API_RPC_CALL_REPLY);
1780 rmp->context = mp->context;
1782 vl_msg_api_send_shmem (q, (u8 *) & rmp);
1787 clib_warning ("multicast not yet implemented...");
1792 vl_api_rpc_call_reply_t_handler (vl_api_rpc_call_reply_t * mp)
1794 clib_warning ("unimplemented");
1798 vl_api_rpc_call_main_thread_inline (void *fp, u8 * data, u32 data_length,
1801 vl_api_rpc_call_t *mp;
1802 api_main_t *am = &api_main;
1803 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
1804 unix_shared_memory_queue_t *q;
1806 /* Main thread: call the function directly */
1807 if ((force_rpc == 0) && (vlib_get_thread_index () == 0))
1809 vlib_main_t *vm = vlib_get_main ();
1810 void (*call_fp) (void *);
1812 vlib_worker_thread_barrier_sync (vm);
1817 vlib_worker_thread_barrier_release (vm);
1821 /* Any other thread, actually do an RPC call... */
1822 mp = vl_msg_api_alloc_as_if_client (sizeof (*mp) + data_length);
1824 memset (mp, 0, sizeof (*mp));
1825 clib_memcpy (mp->data, data, data_length);
1826 mp->_vl_msg_id = ntohs (VL_API_RPC_CALL);
1827 mp->function = pointer_to_uword (fp);
1828 mp->need_barrier_sync = 1;
1831 * Use the "normal" control-plane mechanism for the main thread.
1832 * Well, almost. if the main input queue is full, we cannot
1833 * block. Otherwise, we can expect a barrier sync timeout.
1835 q = shmem_hdr->vl_input_queue;
1837 while (pthread_mutex_trylock (&q->mutex))
1838 vlib_worker_thread_barrier_check ();
1840 while (PREDICT_FALSE (unix_shared_memory_queue_is_full (q)))
1842 pthread_mutex_unlock (&q->mutex);
1843 vlib_worker_thread_barrier_check ();
1844 while (pthread_mutex_trylock (&q->mutex))
1845 vlib_worker_thread_barrier_check ();
1848 vl_msg_api_send_shmem_nolock (q, (u8 *) & mp);
1850 pthread_mutex_unlock (&q->mutex);
1854 * Check if called from worker threads.
1855 * If so, make rpc call of fp through shmem.
1856 * Otherwise, call fp directly
1859 vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length)
1861 vl_api_rpc_call_main_thread_inline (fp, data, data_length, /*force_rpc */
1866 * Always make rpc call of fp through shmem, useful for calling from threads
1867 * not setup as worker threads, such as DPDK callback thread
1870 vl_api_force_rpc_call_main_thread (void *fp, u8 * data, u32 data_length)
1872 vl_api_rpc_call_main_thread_inline (fp, data, data_length, /*force_rpc */
1877 vl_api_trace_plugin_msg_ids_t_handler (vl_api_trace_plugin_msg_ids_t * mp)
1879 api_main_t *am = &api_main;
1880 vl_api_msg_range_t *rp;
1883 /* Noop (except for tracing) during normal operation */
1884 if (am->replay_in_progress == 0)
1887 p = hash_get_mem (am->msg_range_by_name, mp->plugin_name);
1890 clib_warning ("WARNING: traced plugin '%s' not in current image",
1895 rp = vec_elt_at_index (am->msg_ranges, p[0]);
1896 if (rp->first_msg_id != clib_net_to_host_u16 (mp->first_msg_id))
1898 clib_warning ("WARNING: traced plugin '%s' first message id %d not %d",
1899 mp->plugin_name, clib_net_to_host_u16 (mp->first_msg_id),
1903 if (rp->last_msg_id != clib_net_to_host_u16 (mp->last_msg_id))
1905 clib_warning ("WARNING: traced plugin '%s' last message id %d not %d",
1906 mp->plugin_name, clib_net_to_host_u16 (mp->last_msg_id),
1911 #define foreach_rpc_api_msg \
1912 _(RPC_CALL,rpc_call) \
1913 _(RPC_CALL_REPLY,rpc_call_reply)
1915 #define foreach_plugin_trace_msg \
1916 _(TRACE_PLUGIN_MSG_IDS,trace_plugin_msg_ids)
1919 * Set the rpc callback at our earliest possible convenience.
1920 * This avoids ordering issues between thread_init() -> start_workers and
1921 * an init function which we could define here. If we ever intend to use
1922 * vlib all by itself, we can't create a link-time dependency on
1923 * an init function here and a typical "call foo_init first"
1927 extern void *rpc_call_main_thread_cb_fn;
1929 static clib_error_t *
1930 rpc_api_hookup (vlib_main_t * vm)
1932 api_main_t *am = &api_main;
1934 vl_msg_api_set_handlers(VL_API_##N, #n, \
1935 vl_api_##n##_t_handler, \
1938 vl_api_##n##_t_print, \
1939 sizeof(vl_api_##n##_t), 0 /* do not trace */);
1940 foreach_rpc_api_msg;
1944 vl_msg_api_set_handlers(VL_API_##N, #n, \
1945 vl_api_##n##_t_handler, \
1948 vl_api_##n##_t_print, \
1949 sizeof(vl_api_##n##_t), 1 /* do trace */);
1950 foreach_plugin_trace_msg;
1953 /* No reason to halt the parade to create a trace record... */
1954 am->is_mp_safe[VL_API_TRACE_PLUGIN_MSG_IDS] = 1;
1955 rpc_call_main_thread_cb_fn = vl_api_rpc_call_main_thread;
1959 VLIB_API_INIT_FUNCTION (rpc_api_hookup);
1970 format_vl_msg_api_trace_status (u8 * s, va_list * args)
1972 api_main_t *am = va_arg (*args, api_main_t *);
1973 vl_api_trace_which_t which = va_arg (*args, vl_api_trace_which_t);
1979 case VL_API_TRACE_TX:
1981 trace_name = "TX trace";
1984 case VL_API_TRACE_RX:
1986 trace_name = "RX trace";
1995 s = format (s, "%s: not yet configured.\n", trace_name);
1999 s = format (s, "%s: used %d of %d items, %s enabled, %s wrapped\n",
2000 trace_name, vec_len (tp->traces), tp->nitems,
2001 tp->enabled ? "is" : "is not", tp->wrapped ? "has" : "has not");
2005 void vl_msg_api_custom_dump_configure (api_main_t * am)
2006 __attribute__ ((weak));
2008 vl_msg_api_custom_dump_configure (api_main_t * am)
2013 vl_msg_api_process_file (vlib_main_t * vm, u8 * filename,
2014 u32 first_index, u32 last_index,
2015 vl_api_replay_t which)
2017 vl_api_trace_file_header_t *hp;
2022 u8 endian_swap_needed = 0;
2023 api_main_t *am = &api_main;
2026 void **saved_print_handlers = 0;
2028 fd = open ((char *) filename, O_RDONLY);
2032 vlib_cli_output (vm, "Couldn't open %s\n", filename);
2036 if (fstat (fd, &statb) < 0)
2038 vlib_cli_output (vm, "Couldn't stat %s\n", filename);
2043 if (!(statb.st_mode & S_IFREG) || (statb.st_size < sizeof (*hp)))
2045 vlib_cli_output (vm, "File not plausible: %s\n", filename);
2050 file_size = statb.st_size;
2051 file_size = (file_size + 4095) & ~(4096);
2053 hp = mmap (0, file_size, PROT_READ, MAP_PRIVATE, fd, 0);
2055 if (hp == (vl_api_trace_file_header_t *) MAP_FAILED)
2057 vlib_cli_output (vm, "mmap failed: %s\n", filename);
2063 if ((clib_arch_is_little_endian && hp->endian == VL_API_BIG_ENDIAN)
2064 || (clib_arch_is_big_endian && hp->endian == VL_API_LITTLE_ENDIAN))
2065 endian_swap_needed = 1;
2067 if (endian_swap_needed)
2068 nitems = ntohl (hp->nitems);
2070 nitems = hp->nitems;
2072 if (last_index == (u32) ~ 0)
2074 last_index = nitems - 1;
2077 if (first_index >= nitems || last_index >= nitems)
2079 vlib_cli_output (vm, "Range (%d, %d) outside file range (0, %d)\n",
2080 first_index, last_index, nitems - 1);
2081 munmap (hp, file_size);
2085 vlib_cli_output (vm,
2086 "Note: wrapped/incomplete trace, results may vary\n");
2088 if (which == CUSTOM_DUMP)
2090 saved_print_handlers = (void **) vec_dup (am->msg_print_handlers);
2091 vl_msg_api_custom_dump_configure (am);
2095 msg = (u8 *) (hp + 1);
2097 for (i = 0; i < first_index; i++)
2103 size = clib_host_to_net_u32 (*(u32 *) msg);
2104 msg += sizeof (u32);
2106 if (clib_arch_is_little_endian)
2107 msg_id = ntohs (*((u16 *) msg));
2109 msg_id = *((u16 *) msg);
2111 cfgp = am->api_trace_cfg + msg_id;
2114 vlib_cli_output (vm, "Ugh: msg id %d no trace config\n", msg_id);
2115 munmap (hp, file_size);
2121 if (which == REPLAY)
2122 am->replay_in_progress = 1;
2124 for (; i <= last_index; i++)
2132 vlib_cli_output (vm, "---------- trace %d -----------\n", i);
2134 size = clib_host_to_net_u32 (*(u32 *) msg);
2135 msg += sizeof (u32);
2137 if (clib_arch_is_little_endian)
2138 msg_id = ntohs (*((u16 *) msg));
2140 msg_id = *((u16 *) msg);
2142 cfgp = am->api_trace_cfg + msg_id;
2145 vlib_cli_output (vm, "Ugh: msg id %d no trace config\n", msg_id);
2146 munmap (hp, file_size);
2148 am->replay_in_progress = 0;
2152 /* Copy the buffer (from the read-only mmap'ed file) */
2153 vec_validate (tmpbuf, size - 1 + sizeof (uword));
2154 clib_memcpy (tmpbuf + sizeof (uword), msg, size);
2155 memset (tmpbuf, 0xf, sizeof (uword));
2158 * Endian swap if needed. All msg data is supposed to be
2159 * in network byte order. All msg handlers are supposed to
2160 * know that. The generic message dumpers don't know that.
2161 * One could fix apigen, I suppose.
2163 if ((which == DUMP && clib_arch_is_little_endian) || endian_swap_needed)
2165 void (*endian_fp) (void *);
2166 if (msg_id >= vec_len (am->msg_endian_handlers)
2167 || (am->msg_endian_handlers[msg_id] == 0))
2169 vlib_cli_output (vm, "Ugh: msg id %d no endian swap\n", msg_id);
2170 munmap (hp, file_size);
2172 am->replay_in_progress = 0;
2175 endian_fp = am->msg_endian_handlers[msg_id];
2176 (*endian_fp) (tmpbuf + sizeof (uword));
2179 /* msg_id always in network byte order */
2180 if (clib_arch_is_little_endian)
2182 msg_idp = (u16 *) (tmpbuf + sizeof (uword));
2190 if (msg_id < vec_len (am->msg_print_handlers) &&
2191 am->msg_print_handlers[msg_id])
2193 u8 *(*print_fp) (void *, void *);
2195 print_fp = (void *) am->msg_print_handlers[msg_id];
2196 (*print_fp) (tmpbuf + sizeof (uword), vm);
2200 vlib_cli_output (vm, "Skipping msg id %d: no print fcn\n",
2207 if (msg_id < vec_len (am->msg_print_handlers) &&
2208 am->msg_print_handlers[msg_id])
2212 u8 *(*print_fp) (void *, void *);
2214 print_fp = (void *) am->msg_print_handlers[msg_id];
2216 vlib_cli_output (vm, "/*");
2218 (*print_fp) (tmpbuf + sizeof (uword), vm);
2219 vlib_cli_output (vm, "*/\n");
2221 s = format (0, "static u8 * vl_api_%s_%d[%d] = {",
2222 am->msg_names[msg_id], i,
2223 am->api_trace_cfg[msg_id].size);
2225 for (j = 0; j < am->api_trace_cfg[msg_id].size; j++)
2228 s = format (s, "\n ");
2229 s = format (s, "0x%02x,", tmpbuf[sizeof (uword) + j]);
2231 s = format (s, "\n};\n%c", 0);
2232 vlib_cli_output (vm, (char *) s);
2238 if (msg_id < vec_len (am->msg_print_handlers) &&
2239 am->msg_print_handlers[msg_id] && cfgp->replay_enable)
2241 void (*handler) (void *);
2243 handler = (void *) am->msg_handlers[msg_id];
2245 if (!am->is_mp_safe[msg_id])
2246 vl_msg_api_barrier_sync ();
2247 (*handler) (tmpbuf + sizeof (uword));
2248 if (!am->is_mp_safe[msg_id])
2249 vl_msg_api_barrier_release ();
2253 if (cfgp->replay_enable)
2254 vlib_cli_output (vm, "Skipping msg id %d: no handler\n",
2261 _vec_len (tmpbuf) = 0;
2265 if (saved_print_handlers)
2267 clib_memcpy (am->msg_print_handlers, saved_print_handlers,
2268 vec_len (am->msg_print_handlers) * sizeof (void *));
2269 vec_free (saved_print_handlers);
2272 munmap (hp, file_size);
2274 am->replay_in_progress = 0;
2277 static clib_error_t *
2278 api_trace_command_fn (vlib_main_t * vm,
2279 unformat_input_t * input, vlib_cli_command_t * cmd)
2281 u32 nitems = 256 << 10;
2282 api_main_t *am = &api_main;
2283 vl_api_trace_which_t which = VL_API_TRACE_RX;
2286 u32 last = (u32) ~ 0;
2290 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2292 if (unformat (input, "on") || unformat (input, "enable"))
2294 if (unformat (input, "nitems %d", &nitems))
2296 vl_msg_api_trace_configure (am, which, nitems);
2297 vl_msg_api_trace_onoff (am, which, 1 /* on */ );
2299 else if (unformat (input, "off"))
2301 vl_msg_api_trace_onoff (am, which, 0);
2303 else if (unformat (input, "save %s", &filename))
2305 u8 *chroot_filename;
2306 if (strstr ((char *) filename, "..")
2307 || index ((char *) filename, '/'))
2309 vlib_cli_output (vm, "illegal characters in filename '%s'",
2314 chroot_filename = format (0, "/tmp/%s%c", filename, 0);
2316 vec_free (filename);
2318 fp = fopen ((char *) chroot_filename, "w");
2321 vlib_cli_output (vm, "Couldn't create %s\n", chroot_filename);
2324 rv = vl_msg_api_trace_save (am, which, fp);
2327 vlib_cli_output (vm, "API Trace data not present\n");
2329 vlib_cli_output (vm, "File for writing is closed\n");
2331 vlib_cli_output (vm, "Error while writing header to file\n");
2333 vlib_cli_output (vm, "Error while writing trace to file\n");
2335 vlib_cli_output (vm,
2336 "Error while writing end of buffer trace to file\n");
2338 vlib_cli_output (vm,
2339 "Error while writing start of buffer trace to file\n");
2341 vlib_cli_output (vm, "Unkown error while saving: %d", rv);
2343 vlib_cli_output (vm, "API trace saved to %s\n", chroot_filename);
2344 vec_free (chroot_filename);
2346 else if (unformat (input, "dump %s", &filename))
2348 vl_msg_api_process_file (vm, filename, first, last, DUMP);
2350 else if (unformat (input, "custom-dump %s", &filename))
2352 vl_msg_api_process_file (vm, filename, first, last, CUSTOM_DUMP);
2354 else if (unformat (input, "replay %s", &filename))
2356 vl_msg_api_process_file (vm, filename, first, last, REPLAY);
2358 else if (unformat (input, "initializers %s", &filename))
2360 vl_msg_api_process_file (vm, filename, first, last, INITIALIZERS);
2362 else if (unformat (input, "tx"))
2364 which = VL_API_TRACE_TX;
2366 else if (unformat (input, "first %d", &first))
2370 else if (unformat (input, "last %d", &last))
2374 else if (unformat (input, "status"))
2376 vlib_cli_output (vm, "%U", format_vl_msg_api_trace_status,
2379 else if (unformat (input, "free"))
2381 vl_msg_api_trace_onoff (am, which, 0);
2382 vl_msg_api_trace_free (am, which);
2384 else if (unformat (input, "post-mortem-on"))
2385 vl_msg_api_post_mortem_dump_enable_disable (1 /* enable */ );
2386 else if (unformat (input, "post-mortem-off"))
2387 vl_msg_api_post_mortem_dump_enable_disable (0 /* enable */ );
2389 return clib_error_return (0, "unknown input `%U'",
2390 format_unformat_error, input);
2396 * Display, replay, or save a binary API trace
2400 VLIB_CLI_COMMAND (api_trace_command, static) =
2402 .path = "api trace",
2404 "api trace [on|off][dump|save|replay <file>][status][free][post-mortem-on]",
2405 .function = api_trace_command_fn,
2409 static clib_error_t *
2410 api_config_fn (vlib_main_t * vm, unformat_input_t * input)
2412 u32 nitems = 256 << 10;
2413 vl_api_trace_which_t which = VL_API_TRACE_RX;
2414 api_main_t *am = &api_main;
2416 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2418 if (unformat (input, "on") || unformat (input, "enable"))
2420 if (unformat (input, "nitems %d", &nitems))
2422 vl_msg_api_trace_configure (am, which, nitems);
2423 vl_msg_api_trace_onoff (am, which, 1 /* on */ );
2424 vl_msg_api_post_mortem_dump_enable_disable (1 /* enable */ );
2426 else if (unformat (input, "save-api-table %s",
2427 &am->save_msg_table_filename))
2430 return clib_error_return (0, "unknown input `%U'",
2431 format_unformat_error, input);
2437 * This module has three configuration parameters:
2438 * "on" or "enable" - enables binary api tracing
2439 * "nitems <nnn>" - sets the size of the circular buffer to <nnn>
2440 * "save-api-table <filename>" - dumps the API message table to /tmp/<filename>
2442 VLIB_CONFIG_FUNCTION (api_config_fn, "api-trace");
2444 static clib_error_t *
2445 api_queue_config_fn (vlib_main_t * vm, unformat_input_t * input)
2447 api_main_t *am = &api_main;
2450 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2452 if (unformat (input, "length %d", &nitems) ||
2453 (unformat (input, "len %d", &nitems)))
2456 am->vlib_input_queue_length = nitems;
2458 clib_warning ("vlib input queue length %d too small, ignored",
2462 return clib_error_return (0, "unknown input `%U'",
2463 format_unformat_error, input);
2468 VLIB_CONFIG_FUNCTION (api_queue_config_fn, "api-queue");
2471 extract_name (u8 * s)
2477 while (vec_len (rv) && rv[vec_len (rv)] != '_')
2480 rv[vec_len (rv)] = 0;
2486 extract_crc (u8 * s)
2493 for (i = vec_len (rv) - 1; i >= 0; i--)
2497 vec_delete (rv, i + 1, 0);
2511 } msg_table_unserialize_t;
2514 table_id_cmp (void *a1, void *a2)
2516 msg_table_unserialize_t *n1 = a1;
2517 msg_table_unserialize_t *n2 = a2;
2519 return (n1->msg_index - n2->msg_index);
2523 table_name_and_crc_cmp (void *a1, void *a2)
2525 msg_table_unserialize_t *n1 = a1;
2526 msg_table_unserialize_t *n2 = a2;
2528 return strcmp ((char *) n1->name_and_crc, (char *) n2->name_and_crc);
2531 static clib_error_t *
2532 dump_api_table_file_command_fn (vlib_main_t * vm,
2533 unformat_input_t * input,
2534 vlib_cli_command_t * cmd)
2537 api_main_t *am = &api_main;
2538 serialize_main_t _sm, *sm = &_sm;
2539 clib_error_t *error;
2543 int compare_current = 0;
2544 int numeric_sort = 0;
2545 msg_table_unserialize_t *table = 0, *item;
2547 u32 ndifferences = 0;
2549 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2551 if (unformat (input, "file %s", &filename))
2553 else if (unformat (input, "compare-current")
2554 || unformat (input, "compare"))
2555 compare_current = 1;
2556 else if (unformat (input, "numeric"))
2559 return clib_error_return (0, "unknown input `%U'",
2560 format_unformat_error, input);
2563 if (numeric_sort && compare_current)
2564 return clib_error_return
2565 (0, "Comparison and numeric sorting are incompatible");
2568 return clib_error_return (0, "File not specified");
2570 /* Load the serialized message table from the table dump */
2572 error = unserialize_open_clib_file (sm, (char *) filename);
2577 unserialize_integer (sm, &nmsgs, sizeof (u32));
2579 for (i = 0; i < nmsgs; i++)
2581 msg_index = unserialize_likely_small_unsigned_integer (sm);
2582 unserialize_cstring (sm, (char **) &name_and_crc);
2583 vec_add2 (table, item, 1);
2584 item->msg_index = msg_index;
2585 item->name_and_crc = name_and_crc;
2586 item->name = extract_name (name_and_crc);
2587 item->crc = extract_crc (name_and_crc);
2588 item->which = 0; /* file */
2590 serialize_close (sm);
2592 /* Compare with the current image? */
2593 if (compare_current)
2595 /* Append the current message table */
2596 u8 *tblv = vl_api_serialize_message_table (am, 0);
2598 serialize_open_vector (sm, tblv);
2599 unserialize_integer (sm, &nmsgs, sizeof (u32));
2601 for (i = 0; i < nmsgs; i++)
2603 msg_index = unserialize_likely_small_unsigned_integer (sm);
2604 unserialize_cstring (sm, (char **) &name_and_crc);
2606 vec_add2 (table, item, 1);
2607 item->msg_index = msg_index;
2608 item->name_and_crc = name_and_crc;
2609 item->name = extract_name (name_and_crc);
2610 item->crc = extract_crc (name_and_crc);
2611 item->which = 1; /* current_image */
2616 /* Sort the table. */
2618 vec_sort_with_function (table, table_id_cmp);
2620 vec_sort_with_function (table, table_name_and_crc_cmp);
2622 if (compare_current)
2627 * In this case, the recovered table will have two entries per
2628 * API message. So, if entries i and i+1 match, the message definitions
2629 * are identical. Otherwise, the crc is different, or a message is
2630 * present in only one of the tables.
2632 vlib_cli_output (vm, "%=60s %s", "Message Name", "Result");
2634 for (i = 0; i < vec_len (table);)
2636 /* Last message lonely? */
2637 if (i == vec_len (table) - 1)
2643 /* Identical pair? */
2645 ((char *) table[i].name_and_crc,
2646 (char *) table[i + 1].name_and_crc,
2647 vec_len (table[i].name_and_crc)))
2655 /* Only in one of two tables? */
2656 if (strncmp ((char *) table[i].name, (char *) table[i + 1].name,
2657 vec_len (table[i].name)))
2660 vlib_cli_output (vm, "%-60s only in %s",
2661 table[i].name, table[i].which ?
2666 /* In both tables, but with different signatures */
2667 vlib_cli_output (vm, "%-60s definition changed", table[i].name);
2670 if (ndifferences == 0)
2671 vlib_cli_output (vm, "No api message signature differences found.");
2673 vlib_cli_output (vm, "Found %u api message signature differences",
2678 /* Dump the table, sorted as shown above */
2679 vlib_cli_output (vm, "%=60s %=8s %=10s", "Message name", "MsgID", "CRC");
2681 for (i = 0; i < vec_len (table); i++)
2684 vlib_cli_output (vm, "%-60s %8u %10s", item->name,
2685 item->msg_index, item->crc);
2689 for (i = 0; i < vec_len (table); i++)
2691 vec_free (table[i].name_and_crc);
2692 vec_free (table[i].name);
2693 vec_free (table[i].crc);
2702 * Displays a serialized API message decode table, sorted by message name
2705 * @cliexstart{show api dump file <filename>}
2706 * Message name MsgID CRC
2707 * accept_session 407 8e2a127e
2708 * accept_session_reply 408 67d8c22a
2709 * add_node_next 549 e4202993
2710 * add_node_next_reply 550 e89d6eed
2716 * Compares a serialized API message decode table with the current image
2719 * @cliexstart{show api dump file <filename> compare}
2720 * ip_add_del_route definition changed
2721 * ip_table_add_del definition changed
2722 * l2_macs_event only in image
2723 * vnet_ip4_fib_counters only in file
2724 * vnet_ip4_nbr_counters only in file
2729 * Display a serialized API message decode table, compare a saved
2730 * decode table with the current image, to establish API differences.
2734 VLIB_CLI_COMMAND (dump_api_table_file, static) =
2736 .path = "show api dump",
2737 .short_help = "show api dump file <filename> [numeric | compare-current]",
2738 .function = dump_api_table_file_command_fn,
2743 * fd.io coding-style-patch-verification: ON
2746 * eval: (c-set-style "gnu")