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>
27 #include <vppinfra/vec.h>
28 #include <vppinfra/hash.h>
29 #include <vppinfra/pool.h>
30 #include <vppinfra/format.h>
31 #include <vppinfra/byte_order.h>
32 #include <vppinfra/elog.h>
34 #include <vlib/vlib.h>
35 #include <vlib/unix/unix.h>
36 #include <vlibapi/api.h>
37 #include <vlibmemory/api.h>
39 #define TRACE_VLIB_MEMORY_QUEUE 0
41 #include <vlibmemory/vl_memory_msg_enum.h> /* enumerate all vlib messages */
43 #define vl_typedefs /* define message structures */
44 #include <vlibmemory/vl_memory_api_h.h>
47 /* instantiate all the print functions we know about */
48 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
50 #include <vlibmemory/vl_memory_api_h.h>
54 vl_api_memclnt_create_t_print (vl_api_memclnt_create_t * a, void *handle)
56 vl_print (handle, "vl_api_memclnt_create_t:\n");
57 vl_print (handle, "name: %s\n", a->name);
58 vl_print (handle, "input_queue: 0x%wx\n", a->input_queue);
59 vl_print (handle, "context: %u\n", (unsigned) a->context);
60 vl_print (handle, "ctx_quota: %ld\n", (long) a->ctx_quota);
65 vl_api_memclnt_delete_t_print (vl_api_memclnt_delete_t * a, void *handle)
67 vl_print (handle, "vl_api_memclnt_delete_t:\n");
68 vl_print (handle, "index: %u\n", (unsigned) a->index);
69 vl_print (handle, "handle: 0x%wx\n", a->handle);
73 /* instantiate all the endian swap functions we know about */
75 #include <vlibmemory/vl_memory_api_h.h>
78 void vl_socket_api_send (vl_api_registration_t * rp, u8 * elem)
79 __attribute__ ((weak));
82 vl_socket_api_send (vl_api_registration_t * rp, u8 * elem)
87 clib_warning ("need to link against -lvlibsocket, msg not sent!");
91 vl_msg_api_send (vl_api_registration_t * rp, u8 * elem)
93 if (PREDICT_FALSE (rp->registration_type > REGISTRATION_TYPE_SHMEM))
95 vl_socket_api_send (rp, elem);
99 vl_msg_api_send_shmem (rp->vl_input_queue, elem);
103 int vl_msg_api_version_check (vl_api_memclnt_create_t * mp)
104 __attribute__ ((weak));
107 vl_msg_api_version_check (vl_api_memclnt_create_t * mp)
113 * vl_api_memclnt_create_t_handler
116 vl_api_memclnt_create_t_handler (vl_api_memclnt_create_t * mp)
118 vl_api_registration_t **regpp;
119 vl_api_registration_t *regp;
120 vl_api_memclnt_create_reply_t *rp;
122 unix_shared_memory_queue_t *q;
125 api_main_t *am = &api_main;
127 /* Indicate API version mismatch if appropriate */
128 rv = vl_msg_api_version_check (mp);
131 * This is tortured. Maintain a vlib-address-space private
132 * pool of client registrations. We use the shared-memory virtual
133 * address of client structure as a handle, to allow direct
134 * manipulation of context quota vbls from the client library.
136 * This scheme causes trouble w/ API message trace replay, since
137 * some random VA from clib_mem_alloc() certainly won't
138 * occur in the Linux sim. The (very) few places
139 * that care need to use the pool index.
141 * Putting the registration object(s) into a pool in shared memory and
142 * using the pool index as a handle seems like a great idea.
143 * Unfortunately, each and every reference to that pool would need
144 * to be protected by a mutex:
148 * convert pool index to
156 pool_get (am->vl_clients, regpp);
160 pthread_mutex_lock (&svm->mutex);
161 oldheap = svm_push_data_heap (svm);
162 *regpp = clib_mem_alloc (sizeof (vl_api_registration_t));
165 memset (regp, 0, sizeof (*regp));
166 regp->registration_type = REGISTRATION_TYPE_SHMEM;
167 regp->vl_api_registration_pool_index = regpp - am->vl_clients;
169 q = regp->vl_input_queue = (unix_shared_memory_queue_t *) (uword)
172 regp->name = format (0, "%s", mp->name);
173 vec_add1 (regp->name, 0);
175 pthread_mutex_unlock (&svm->mutex);
176 svm_pop_heap (oldheap);
178 rp = vl_msg_api_alloc (sizeof (*rp));
179 rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE_REPLY);
180 rp->handle = (uword) regp;
181 rp->index = vl_msg_api_handle_from_index_and_epoch
182 (regp->vl_api_registration_pool_index,
183 am->shmem_hdr->application_restarts);
184 rp->context = mp->context;
185 rp->response = ntohl (rv);
187 vl_msg_api_send_shmem (q, (u8 *) & rp);
190 /* Application callback to clean up leftover registrations from this client */
191 int vl_api_memclnt_delete_callback (u32 client_index) __attribute__ ((weak));
194 vl_api_memclnt_delete_callback (u32 client_index)
200 * vl_api_memclnt_delete_t_handler
203 vl_api_memclnt_delete_t_handler (vl_api_memclnt_delete_t * mp)
205 vl_api_registration_t **regpp;
206 vl_api_registration_t *regp;
207 vl_api_memclnt_delete_reply_t *rp;
210 api_main_t *am = &api_main;
211 u32 handle, client_index, epoch;
215 if (vl_api_memclnt_delete_callback (handle))
218 epoch = vl_msg_api_handle_get_epoch (handle);
219 client_index = vl_msg_api_handle_get_index (handle);
221 if (epoch != (am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK))
224 ("Stale clnt delete index %d old epoch %d cur epoch %d",
226 (am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK));
230 regpp = am->vl_clients + client_index;
232 if (!pool_is_free (am->vl_clients, regpp))
237 /* $$$ check the input queue for e.g. punted sf's */
239 rp = vl_msg_api_alloc (sizeof (*rp));
240 rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE_REPLY);
241 rp->handle = mp->handle;
244 vl_msg_api_send_shmem (regp->vl_input_queue, (u8 *) & rp);
246 if (client_index != regp->vl_api_registration_pool_index)
248 clib_warning ("mismatch client_index %d pool_index %d",
249 client_index, regp->vl_api_registration_pool_index);
250 vl_msg_api_free (rp);
254 /* No dangling references, please */
257 pool_put_index (am->vl_clients, regp->vl_api_registration_pool_index);
259 pthread_mutex_lock (&svm->mutex);
260 oldheap = svm_push_data_heap (svm);
261 /* Poison the old registration */
262 memset (regp, 0xF1, sizeof (*regp));
263 clib_mem_free (regp);
264 pthread_mutex_unlock (&svm->mutex);
265 svm_pop_heap (oldheap);
269 clib_warning ("unknown client ID %d", mp->index);
274 vl_api_get_first_msg_id_t_handler (vl_api_get_first_msg_id_t * mp)
276 vl_api_get_first_msg_id_reply_t *rmp;
277 unix_shared_memory_queue_t *q;
279 api_main_t *am = &api_main;
280 vl_api_msg_range_t *rp;
282 u16 first_msg_id = ~0;
283 int rv = -7; /* VNET_API_ERROR_INVALID_VALUE */
285 q = vl_api_client_index_to_input_queue (mp->client_index);
289 if (am->msg_range_by_name == 0)
292 strncpy ((char *) name, (char *) mp->name, ARRAY_LEN (name) - 1);
294 p = hash_get_mem (am->msg_range_by_name, name);
298 rp = vec_elt_at_index (am->msg_ranges, p[0]);
300 first_msg_id = rp->first_msg_id;
305 rmp = vl_msg_api_alloc (sizeof (*rmp));
306 rmp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID_REPLY);
307 rmp->context = mp->context;
308 rmp->retval = ntohl (rv);
309 rmp->first_msg_id = ntohs (first_msg_id);
310 vl_msg_api_send_shmem (q, (u8 *) & rmp);
313 #define foreach_vlib_api_msg \
314 _(MEMCLNT_CREATE, memclnt_create) \
315 _(MEMCLNT_DELETE, memclnt_delete) \
316 _(GET_FIRST_MSG_ID, get_first_msg_id)
322 memory_api_init (char *region_name)
325 vl_msg_api_msg_config_t cfg;
326 vl_msg_api_msg_config_t *c = &cfg;
328 if ((rv = vl_map_shmem (region_name, 1 /* is_vlib */ )) < 0)
331 #define _(N,n) do { \
332 c->id = VL_API_##N; \
334 c->handler = vl_api_##n##_t_handler; \
335 c->cleanup = vl_noop_handler; \
336 c->endian = vl_api_##n##_t_endian; \
337 c->print = vl_api_##n##_t_print; \
338 c->size = sizeof(vl_api_##n##_t); \
339 c->traced = 1; /* trace, so these msgs print */ \
340 c->replay = 0; /* don't replay client create/delete msgs */ \
341 vl_msg_api_config(c);} while (0);
343 foreach_vlib_api_msg;
349 #define foreach_histogram_bucket \
357 #define _(n) SLEEP_##n##_US,
358 foreach_histogram_bucket
363 static u64 vector_rate_histogram[SLEEP_N_BUCKETS];
365 static void memclnt_queue_callback (vlib_main_t * vm);
368 memclnt_process (vlib_main_t * vm,
369 vlib_node_runtime_t * node, vlib_frame_t * f)
373 unix_shared_memory_queue_t *q;
376 api_main_t *am = &api_main;
377 f64 dead_client_scan_time;
378 f64 sleep_time, start_time;
381 vlib_set_queue_signal_callback (vm, memclnt_queue_callback);
383 if ((rv = memory_api_init (am->region_name)) < 0)
385 clib_warning ("memory_api_init returned %d, wait for godot...", rv);
386 vlib_process_suspend (vm, 1e70);
391 q = shm->vl_input_queue;
394 e = vlib_call_init_exit_functions
395 (vm, vm->api_init_function_registrations, 1 /* call_once */ );
397 clib_error_report (e);
400 dead_client_scan_time = vlib_time_now (vm) + 20.0;
402 /* $$$ pay attention to frame size, control CPU usage */
405 uword event_type __attribute__ ((unused));
410 * There's a reason for checking the queue before
411 * sleeping. If the vlib application crashes, it's entirely
412 * possible for a client to enqueue a connect request
413 * during the process restart interval.
415 * Unless some force of physics causes the new incarnation
416 * of the application to process the request, the client will
417 * sit and wait for Godot...
419 vector_rate = vlib_last_vector_length_per_node (vm);
420 start_time = vlib_time_now (vm);
423 pthread_mutex_lock (&q->mutex);
426 vm->api_queue_nonempty = 0;
427 pthread_mutex_unlock (&q->mutex);
429 if (TRACE_VLIB_MEMORY_QUEUE)
432 ELOG_TYPE_DECLARE (e) =
434 .format = "q-underflow: len %d",
442 ed = ELOG_DATA (&vm->elog_main, e);
449 headp = (i8 *) (q->data + sizeof (uword) * q->head);
450 clib_memcpy (&mp, headp, sizeof (uword));
453 need_broadcast = (q->cursize == q->maxsize / 2);
456 if (PREDICT_FALSE (q->head == q->maxsize))
458 pthread_mutex_unlock (&q->mutex);
460 (void) pthread_cond_broadcast (&q->condvar);
462 vl_msg_api_handler_with_vm_node (am, (void *) mp, vm, node);
464 /* Allow no more than 10us without a pause */
465 if (vlib_time_now (vm) > start_time + 10e-6)
467 int index = SLEEP_400_US;
468 if (vector_rate > 40.0)
470 else if (vector_rate > 20.0)
472 index = SLEEP_200_US;
475 else if (vector_rate >= 1.0)
477 index = SLEEP_100_US;
485 vector_rate_histogram[index] += 1;
490 event_type = vlib_process_wait_for_event_or_clock (vm, sleep_time);
491 vm->queue_signal_pending = 0;
492 vlib_process_get_events (vm, 0 /* event_data */ );
494 if (vlib_time_now (vm) > dead_client_scan_time)
496 vl_api_registration_t **regpp;
497 vl_api_registration_t *regp;
498 unix_shared_memory_queue_t *q;
499 static u32 *dead_indices;
500 static u32 *confused_indices;
502 vec_reset_length (dead_indices);
503 vec_reset_length (confused_indices);
506 pool_foreach (regpp, am->vl_clients,
511 q = regp->vl_input_queue;
512 if (kill (q->consumer_pid, 0) < 0)
514 vec_add1(dead_indices, regpp - am->vl_clients);
519 clib_warning ("NULL client registration index %d",
520 regpp - am->vl_clients);
521 vec_add1 (confused_indices, regpp - am->vl_clients);
525 /* This should "never happen," but if it does, fix it... */
526 if (PREDICT_FALSE (vec_len (confused_indices) > 0))
529 for (i = 0; i < vec_len (confused_indices); i++)
531 pool_put_index (am->vl_clients, confused_indices[i]);
535 if (PREDICT_FALSE (vec_len (dead_indices) > 0))
541 /* Allow the application to clean up its registrations */
542 for (i = 0; i < vec_len (dead_indices); i++)
544 regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
549 handle = vl_msg_api_handle_from_index_and_epoch
550 (dead_indices[i], shm->application_restarts);
551 (void) vl_api_memclnt_delete_callback (handle);
556 pthread_mutex_lock (&svm->mutex);
557 oldheap = svm_push_data_heap (svm);
559 for (i = 0; i < vec_len (dead_indices); i++)
561 regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
564 /* Poison the old registration */
565 memset (*regpp, 0xF3, sizeof (**regpp));
566 clib_mem_free (*regpp);
567 /* no dangling references, please */
572 svm_pop_heap (oldheap);
573 clib_warning ("Duplicate free, client index %d",
574 regpp - am->vl_clients);
575 oldheap = svm_push_data_heap (svm);
579 svm_client_scan_this_region_nolock (am->vlib_rp);
581 pthread_mutex_unlock (&svm->mutex);
582 svm_pop_heap (oldheap);
583 for (i = 0; i < vec_len (dead_indices); i++)
584 pool_put_index (am->vl_clients, dead_indices[i]);
587 dead_client_scan_time = vlib_time_now (vm) + 20.0;
590 if (TRACE_VLIB_MEMORY_QUEUE)
593 ELOG_TYPE_DECLARE (e) = {
594 .format = "q-awake: len %d",
602 ed = ELOG_DATA (&vm->elog_main, e);
603 ed->len = q->cursize;
610 static clib_error_t *
611 vl_api_show_histogram_command (vlib_main_t * vm,
612 unformat_input_t * input,
613 vlib_cli_command_t * cli_cmd)
615 u64 total_counts = 0;
618 for (i = 0; i < SLEEP_N_BUCKETS; i++)
620 total_counts += vector_rate_histogram[i];
623 if (total_counts == 0)
625 vlib_cli_output (vm, "No control-plane activity.");
632 percent = ((f64) vector_rate_histogram[SLEEP_##n##_US]) \
633 / (f64) total_counts; \
635 vlib_cli_output (vm, "Sleep %3d us: %llu, %.2f%%",n, \
636 vector_rate_histogram[SLEEP_##n##_US], \
639 foreach_histogram_bucket;
646 VLIB_CLI_COMMAND (cli_show_api_histogram_command, static) = {
647 .path = "show api histogram",
648 .short_help = "show api histogram",
649 .function = vl_api_show_histogram_command,
653 static clib_error_t *
654 vl_api_clear_histogram_command (vlib_main_t * vm,
655 unformat_input_t * input,
656 vlib_cli_command_t * cli_cmd)
660 for (i = 0; i < SLEEP_N_BUCKETS; i++)
661 vector_rate_histogram[i] = 0;
666 VLIB_CLI_COMMAND (cli_clear_api_histogram_command, static) = {
667 .path = "clear api histogram",
668 .short_help = "clear api histogram",
669 .function = vl_api_clear_histogram_command,
675 VLIB_REGISTER_NODE (memclnt_node,static) = {
676 .function = memclnt_process,
677 .type = VLIB_NODE_TYPE_PROCESS,
678 .name = "api-rx-from-ring",
679 .state = VLIB_NODE_STATE_DISABLED,
684 memclnt_queue_callback (vlib_main_t * vm)
686 static volatile int *cursizep;
688 if (PREDICT_FALSE (cursizep == 0))
690 api_main_t *am = &api_main;
691 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
692 unix_shared_memory_queue_t *q;
697 q = shmem_hdr->vl_input_queue;
700 cursizep = &q->cursize;
705 vm->queue_signal_pending = 1;
706 vm->api_queue_nonempty = 1;
707 vlib_process_signal_event (vm, memclnt_node.index,
708 /* event_type */ 0, /* event_data */ 0);
713 vl_enable_disable_memory_api (vlib_main_t * vm, int enable)
715 vlib_node_set_state (vm, memclnt_node.index,
717 ? VLIB_NODE_STATE_POLLING
718 : VLIB_NODE_STATE_DISABLED));
722 api_rx_from_node (vlib_main_t * vm,
723 vlib_node_runtime_t * node, vlib_frame_t * frame)
725 uword n_packets = frame->n_vectors;
730 vec_validate (long_msg, 4095);
731 n_left_from = frame->n_vectors;
732 from = vlib_frame_args (frame);
734 while (n_left_from > 0)
742 b0 = vlib_get_buffer (vm, bi0);
746 msg = b0->data + b0->current_data;
747 msg_len = b0->current_length;
748 if (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
750 ASSERT (long_msg != 0);
751 _vec_len (long_msg) = 0;
752 vec_add (long_msg, msg, msg_len);
753 while (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
755 b0 = vlib_get_buffer (vm, b0->next_buffer);
756 msg = b0->data + b0->current_data;
757 msg_len = b0->current_length;
758 vec_add (long_msg, msg, msg_len);
762 vl_msg_api_handler_no_trace_no_free (msg);
765 /* Free what we've been given. */
766 vlib_buffer_free (vm, vlib_frame_args (frame), n_packets);
772 VLIB_REGISTER_NODE (api_rx_from_node_node,static) = {
773 .function = api_rx_from_node,
774 .type = VLIB_NODE_TYPE_INTERNAL,
776 .name = "api-rx-from-node",
780 static clib_error_t *
781 setup_memclnt_exit (vlib_main_t * vm)
783 atexit (vl_unmap_shmem);
787 VLIB_INIT_FUNCTION (setup_memclnt_exit);
790 static clib_error_t *
791 vl_api_ring_command (vlib_main_t * vm,
792 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
796 vl_shmem_hdr_t *shmem_hdr;
797 api_main_t *am = &api_main;
799 shmem_hdr = am->shmem_hdr;
803 vlib_cli_output (vm, "Shared memory segment not initialized...\n");
807 vlib_cli_output (vm, "%8s %8s %8s %8s %8s\n",
808 "Owner", "Size", "Nitems", "Hits", "Misses");
810 ap = shmem_hdr->vl_rings;
812 for (i = 0; i < vec_len (shmem_hdr->vl_rings); i++)
814 vlib_cli_output (vm, "%8s %8d %8d %8d %8d\n",
815 "vlib", ap->size, ap->nitems, ap->hits, ap->misses);
819 ap = shmem_hdr->client_rings;
821 for (i = 0; i < vec_len (shmem_hdr->client_rings); i++)
823 vlib_cli_output (vm, "%8s %8d %8d %8d %8d\n",
824 "clnt", ap->size, ap->nitems, ap->hits, ap->misses);
828 vlib_cli_output (vm, "%d ring miss fallback allocations\n",
831 vlib_cli_output (vm, "%d application restarts, %d reclaimed msgs\n",
832 shmem_hdr->application_restarts,
833 shmem_hdr->restart_reclaims);
837 void dump_socket_clients (vlib_main_t * vm, api_main_t * am)
838 __attribute__ ((weak));
841 dump_socket_clients (vlib_main_t * vm, api_main_t * am)
845 static clib_error_t *
846 vl_api_client_command (vlib_main_t * vm,
847 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
849 vl_api_registration_t **regpp, *regp;
850 unix_shared_memory_queue_t *q;
852 api_main_t *am = &api_main;
853 u32 *confused_indices = 0;
855 if (!pool_elts (am->vl_clients))
857 vlib_cli_output (vm, "Shared memory clients");
858 vlib_cli_output (vm, "%16s %8s %14s %18s %s",
859 "Name", "PID", "Queue Length", "Queue VA", "Health");
862 pool_foreach (regpp, am->vl_clients,
868 q = regp->vl_input_queue;
869 if (kill (q->consumer_pid, 0) < 0)
877 vlib_cli_output (vm, "%16s %8d %14d 0x%016llx %s\n",
878 regp->name, q->consumer_pid, q->cursize,
883 clib_warning ("NULL client registration index %d",
884 regpp - am->vl_clients);
885 vec_add1 (confused_indices, regpp - am->vl_clients);
890 /* This should "never happen," but if it does, fix it... */
891 if (PREDICT_FALSE (vec_len (confused_indices) > 0))
894 for (i = 0; i < vec_len (confused_indices); i++)
896 pool_put_index (am->vl_clients, confused_indices[i]);
899 vec_free (confused_indices);
901 if (am->missing_clients)
902 vlib_cli_output (vm, "%u messages with missing clients",
903 am->missing_clients);
905 dump_socket_clients (vm, am);
910 static clib_error_t *
911 vl_api_status_command (vlib_main_t * vm,
912 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
914 api_main_t *am = &api_main;
916 // check if rx_trace and tx_trace are not null pointers
918 if (am->rx_trace == 0)
920 vlib_cli_output (vm, "RX Trace disabled\n");
924 if (am->rx_trace->enabled == 0)
925 vlib_cli_output (vm, "RX Trace disabled\n");
927 vlib_cli_output (vm, "RX Trace enabled\n");
930 if (am->tx_trace == 0)
932 vlib_cli_output (vm, "TX Trace disabled\n");
936 if (am->tx_trace->enabled == 0)
937 vlib_cli_output (vm, "TX Trace disabled\n");
939 vlib_cli_output (vm, "TX Trace enabled\n");
946 VLIB_CLI_COMMAND (cli_show_api_command, static) = {
948 .short_help = "Show API information",
953 VLIB_CLI_COMMAND (cli_show_api_ring_command, static) = {
954 .path = "show api ring-stats",
955 .short_help = "Message ring statistics",
956 .function = vl_api_ring_command,
961 VLIB_CLI_COMMAND (cli_show_api_clients_command, static) = {
962 .path = "show api clients",
963 .short_help = "Client information",
964 .function = vl_api_client_command,
969 VLIB_CLI_COMMAND (cli_show_api_status_command, static) = {
970 .path = "show api status",
971 .short_help = "Show API trace status",
972 .function = vl_api_status_command,
976 static clib_error_t *
977 vl_api_message_table_command (vlib_main_t * vm,
978 unformat_input_t * input,
979 vlib_cli_command_t * cli_cmd)
981 api_main_t *am = &api_main;
985 if (unformat (input, "verbose"))
990 vlib_cli_output (vm, "%-4s %s", "ID", "Name");
992 vlib_cli_output (vm, "%-4s %-40s %6s %7s", "ID", "Name", "Bounce",
995 for (i = 1; i < vec_len (am->msg_names); i++)
999 vlib_cli_output (vm, "%-4d %s", i,
1000 am->msg_names[i] ? am->msg_names[i] :
1005 vlib_cli_output (vm, "%-4d %-40s %6d %7d", i,
1006 am->msg_names[i] ? am->msg_names[i] :
1007 " [no handler]", am->message_bounce[i],
1016 VLIB_CLI_COMMAND (cli_show_api_message_table_command, static) = {
1017 .path = "show api message-table",
1018 .short_help = "Message Table",
1019 .function = vl_api_message_table_command,
1024 vl_api_trace_print_file_cmd (vlib_main_t * vm, u32 first, u32 last,
1028 static vl_api_trace_t *tp = 0;
1029 int endian_swap = 0;
1032 static u8 *msg_buf = 0;
1033 void (*endian_fp) (void *);
1034 u8 *(*print_fp) (void *, void *);
1036 api_main_t *am = &api_main;
1039 * On-demand: allocate enough space for the largest message
1043 vec_validate (tp, 0);
1045 for (i = 0; i < vec_len (am->api_trace_cfg); i++)
1047 if (am->api_trace_cfg[i].size > max_size)
1048 max_size = am->api_trace_cfg[i].size;
1050 /* round size to a multiple of the cache-line size */
1051 max_size = (max_size + (CLIB_CACHE_LINE_BYTES - 1)) &
1052 (~(CLIB_CACHE_LINE_BYTES - 1));
1053 vec_validate (msg_buf, max_size - 1);
1056 fp = fopen ((char *) filename, "r");
1060 vlib_cli_output (vm, "Couldn't open %s\n", filename);
1064 /* first, fish the header record from the file */
1066 if (fread (tp, sizeof (*tp), 1, fp) != 1)
1069 vlib_cli_output (vm, "Header read error\n");
1073 /* Endian swap required? */
1074 if (clib_arch_is_big_endian != tp->endian)
1079 for (i = 0; i <= last; i++)
1081 /* First 2 bytes are the message type */
1082 if (fread (&msg_id, sizeof (u16), 1, fp) != 1)
1086 msg_id = ntohs (msg_id);
1088 if (fseek (fp, -2, SEEK_CUR) < 0)
1090 vlib_cli_output (vm, "fseek failed, %s", strerror (errno));
1095 /* Mild sanity check */
1096 if (msg_id >= vec_len (am->msg_handlers))
1099 vlib_cli_output (vm, "msg_id %d out of bounds\n", msg_id);
1103 size = am->api_trace_cfg[msg_id].size;
1105 if (fread (msg_buf, size, 1, fp) != 1)
1108 vlib_cli_output (vm, "read error on %s\n", filename);
1117 endian_fp = am->msg_endian_handlers[msg_id];
1118 (*endian_fp) (msg_buf);
1121 vlib_cli_output (vm, "[%d]: %s\n", i, am->msg_names[msg_id]);
1123 print_fp = (void *) am->msg_print_handlers[msg_id];
1124 (*print_fp) (msg_buf, vm);
1125 vlib_cli_output (vm, "-------------\n");
1130 static clib_error_t *
1131 vl_api_trace_command (vlib_main_t * vm,
1132 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
1135 vl_api_trace_which_t which = VL_API_TRACE_RX;
1139 api_main_t *am = &api_main;
1141 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1143 if (unformat (input, "rx nitems %u", &nitems) || unformat (input, "rx"))
1145 else if (unformat (input, "tx nitems %u", &nitems)
1146 || unformat (input, "tx"))
1148 which = VL_API_TRACE_RX;
1151 else if (unformat (input, "on rx"))
1153 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 1);
1155 else if (unformat (input, "on tx"))
1157 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 1);
1159 else if (unformat (input, "on"))
1161 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 1);
1163 else if (unformat (input, "off"))
1165 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 0);
1166 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 0);
1168 else if (unformat (input, "free"))
1170 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 0);
1171 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 0);
1172 vl_msg_api_trace_free (am, VL_API_TRACE_RX);
1173 vl_msg_api_trace_free (am, VL_API_TRACE_TX);
1175 else if (unformat (input, "print %s from %d to %d", &filename,
1177 || unformat (input, "print %s", &filename))
1181 else if (unformat (input, "debug on"))
1183 am->msg_print_flag = 1;
1185 else if (unformat (input, "debug off"))
1187 am->msg_print_flag = 0;
1190 return clib_error_return (0, "unknown input `%U'",
1191 format_unformat_error, input);
1196 vl_api_trace_print_file_cmd (vm, first, last, filename);
1200 if (vl_msg_api_trace_configure (am, which, nitems))
1202 vlib_cli_output (vm, "warning: trace configure error (%d, %d)",
1211 VLIB_CLI_COMMAND (trace, static) = {
1212 .path = "set api-trace",
1213 .short_help = "API trace",
1214 .function = vl_api_trace_command,
1219 vlibmemory_init (vlib_main_t * vm)
1221 api_main_t *am = &api_main;
1222 svm_map_region_args_t _a, *a = &_a;
1224 memset (a, 0, sizeof (*a));
1225 a->root_path = am->root_path;
1226 a->name = SVM_GLOBAL_REGION_NAME;
1227 a->baseva = (am->global_baseva != 0) ?
1228 am->global_baseva : SVM_GLOBAL_REGION_BASEVA;
1229 a->size = (am->global_size != 0) ? am->global_size : SVM_GLOBAL_REGION_SIZE;
1230 a->flags = SVM_FLAGS_NODATA;
1231 a->uid = am->api_uid;
1232 a->gid = am->api_gid;
1234 (am->global_pvt_heap_size !=
1235 0) ? am->global_pvt_heap_size : SVM_PVT_MHEAP_SIZE;
1237 svm_region_init_args (a);
1241 VLIB_INIT_FUNCTION (vlibmemory_init);
1244 vl_set_memory_region_name (char *name)
1246 api_main_t *am = &api_main;
1248 am->region_name = name;
1252 range_compare (vl_api_msg_range_t * a0, vl_api_msg_range_t * a1)
1254 int len0, len1, clen;
1256 len0 = vec_len (a0->name);
1257 len1 = vec_len (a1->name);
1258 clen = len0 < len1 ? len0 : len1;
1259 return (strncmp ((char *) a0->name, (char *) a1->name, clen));
1263 format_api_msg_range (u8 * s, va_list * args)
1265 vl_api_msg_range_t *rp = va_arg (*args, vl_api_msg_range_t *);
1268 s = format (s, "%-20s%9s%9s", "Name", "First-ID", "Last-ID");
1270 s = format (s, "%-20s%9d%9d", rp->name, rp->first_msg_id,
1276 static clib_error_t *
1277 vl_api_show_plugin_command (vlib_main_t * vm,
1278 unformat_input_t * input,
1279 vlib_cli_command_t * cli_cmd)
1281 api_main_t *am = &api_main;
1282 vl_api_msg_range_t *rp = 0;
1285 if (vec_len (am->msg_ranges) == 0)
1287 vlib_cli_output (vm, "No plugin API message ranges configured...");
1291 rp = vec_dup (am->msg_ranges);
1293 vec_sort_with_function (rp, range_compare);
1295 vlib_cli_output (vm, "Plugin API message ID ranges...\n");
1296 vlib_cli_output (vm, "%U", format_api_msg_range, 0 /* header */ );
1298 for (i = 0; i < vec_len (rp); i++)
1299 vlib_cli_output (vm, "%U", format_api_msg_range, rp + i);
1305 VLIB_CLI_COMMAND (cli_show_api_plugin_command, static) = {
1306 .path = "show api plugin",
1307 .short_help = "show api plugin",
1308 .function = vl_api_show_plugin_command,
1313 vl_api_rpc_call_t_handler (vl_api_rpc_call_t * mp)
1315 vl_api_rpc_reply_t *rmp;
1318 vlib_main_t *vm = vlib_get_main ();
1320 if (mp->function == 0)
1323 clib_warning ("rpc NULL function pointer");
1328 if (mp->need_barrier_sync)
1329 vlib_worker_thread_barrier_sync (vm);
1331 fp = uword_to_pointer (mp->function, int (*)(void *));
1334 if (mp->need_barrier_sync)
1335 vlib_worker_thread_barrier_release (vm);
1340 unix_shared_memory_queue_t *q =
1341 vl_api_client_index_to_input_queue (mp->client_index);
1344 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
1345 rmp->_vl_msg_id = ntohs (VL_API_RPC_REPLY);
1346 rmp->context = mp->context;
1348 vl_msg_api_send_shmem (q, (u8 *) & rmp);
1353 clib_warning ("multicast not yet implemented...");
1358 vl_api_rpc_reply_t_handler (vl_api_rpc_reply_t * mp)
1360 clib_warning ("unimplemented");
1364 vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length)
1366 vl_api_rpc_call_t *mp;
1367 api_main_t *am = &api_main;
1368 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
1370 mp = vl_msg_api_alloc_as_if_client (sizeof (*mp) + data_length);
1371 memset (mp, 0, sizeof (*mp));
1372 clib_memcpy (mp->data, data, data_length);
1373 mp->_vl_msg_id = ntohs (VL_API_RPC_CALL);
1374 mp->function = pointer_to_uword (fp);
1375 mp->need_barrier_sync = 1;
1377 /* Use the "normal" control-plane mechanism for the main thread */
1378 vl_msg_api_send_shmem (shmem_hdr->vl_input_queue, (u8 *) & mp);
1381 #define foreach_rpc_api_msg \
1382 _(RPC_CALL,rpc_call) \
1383 _(RPC_REPLY,rpc_reply)
1385 static clib_error_t *
1386 rpc_api_hookup (vlib_main_t * vm)
1389 vl_msg_api_set_handlers(VL_API_##N, #n, \
1390 vl_api_##n##_t_handler, \
1393 vl_api_##n##_t_print, \
1394 sizeof(vl_api_##n##_t), 0 /* do not trace */);
1395 foreach_rpc_api_msg;
1400 VLIB_API_INIT_FUNCTION (rpc_api_hookup);
1403 * fd.io coding-style-patch-verification: ON
1406 * eval: (c-set-style "gnu")