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);
104 vl_api_serialize_message_table (api_main_t * am, u8 * vector)
106 serialize_main_t _sm, *sm = &_sm;
108 u32 nmsg = hash_elts (am->msg_index_by_name_and_crc);
110 serialize_open_vector (sm, vector);
112 /* serialize the count */
113 serialize_integer (sm, nmsg, sizeof (u32));
115 hash_foreach_pair (hp, am->msg_index_by_name_and_crc, (
117 serialize_likely_small_unsigned_integer
124 return serialize_close_vector (sm);
128 * vl_api_memclnt_create_t_handler
131 vl_api_memclnt_create_t_handler (vl_api_memclnt_create_t * mp)
133 vl_api_registration_t **regpp;
134 vl_api_registration_t *regp;
135 vl_api_memclnt_create_reply_t *rp;
137 unix_shared_memory_queue_t *q;
140 api_main_t *am = &api_main;
141 u8 *serialized_message_table = 0;
144 * This is tortured. Maintain a vlib-address-space private
145 * pool of client registrations. We use the shared-memory virtual
146 * address of client structure as a handle, to allow direct
147 * manipulation of context quota vbls from the client library.
149 * This scheme causes trouble w/ API message trace replay, since
150 * some random VA from clib_mem_alloc() certainly won't
151 * occur in the Linux sim. The (very) few places
152 * that care need to use the pool index.
154 * Putting the registration object(s) into a pool in shared memory and
155 * using the pool index as a handle seems like a great idea.
156 * Unfortunately, each and every reference to that pool would need
157 * to be protected by a mutex:
161 * convert pool index to
169 pool_get (am->vl_clients, regpp);
173 if (am->serialized_message_table_in_shmem == 0)
174 serialized_message_table = vl_api_serialize_message_table (am, 0);
176 pthread_mutex_lock (&svm->mutex);
177 oldheap = svm_push_data_heap (svm);
178 *regpp = clib_mem_alloc (sizeof (vl_api_registration_t));
181 memset (regp, 0, sizeof (*regp));
182 regp->registration_type = REGISTRATION_TYPE_SHMEM;
183 regp->vl_api_registration_pool_index = regpp - am->vl_clients;
185 q = regp->vl_input_queue = (unix_shared_memory_queue_t *) (uword)
188 regp->name = format (0, "%s", mp->name);
189 vec_add1 (regp->name, 0);
190 if (serialized_message_table)
191 am->serialized_message_table_in_shmem =
192 vec_dup (serialized_message_table);
194 pthread_mutex_unlock (&svm->mutex);
195 svm_pop_heap (oldheap);
197 vec_free (serialized_message_table);
199 rp = vl_msg_api_alloc (sizeof (*rp));
200 rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_CREATE_REPLY);
201 rp->handle = (uword) regp;
202 rp->index = vl_msg_api_handle_from_index_and_epoch
203 (regp->vl_api_registration_pool_index,
204 am->shmem_hdr->application_restarts);
205 rp->context = mp->context;
206 rp->response = ntohl (rv);
207 rp->message_table = (u64) am->serialized_message_table_in_shmem;
209 vl_msg_api_send_shmem (q, (u8 *) & rp);
212 /* Application callback to clean up leftover registrations from this client */
213 int vl_api_memclnt_delete_callback (u32 client_index) __attribute__ ((weak));
216 vl_api_memclnt_delete_callback (u32 client_index)
222 * vl_api_memclnt_delete_t_handler
225 vl_api_memclnt_delete_t_handler (vl_api_memclnt_delete_t * mp)
227 vl_api_registration_t **regpp;
228 vl_api_registration_t *regp;
229 vl_api_memclnt_delete_reply_t *rp;
232 api_main_t *am = &api_main;
233 u32 handle, client_index, epoch;
237 if (vl_api_memclnt_delete_callback (handle))
240 epoch = vl_msg_api_handle_get_epoch (handle);
241 client_index = vl_msg_api_handle_get_index (handle);
243 if (epoch != (am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK))
246 ("Stale clnt delete index %d old epoch %d cur epoch %d",
248 (am->shmem_hdr->application_restarts & VL_API_EPOCH_MASK));
252 regpp = am->vl_clients + client_index;
254 if (!pool_is_free (am->vl_clients, regpp))
259 /* $$$ check the input queue for e.g. punted sf's */
261 rp = vl_msg_api_alloc (sizeof (*rp));
262 rp->_vl_msg_id = ntohs (VL_API_MEMCLNT_DELETE_REPLY);
263 rp->handle = mp->handle;
266 vl_msg_api_send_shmem (regp->vl_input_queue, (u8 *) & rp);
268 if (client_index != regp->vl_api_registration_pool_index)
270 clib_warning ("mismatch client_index %d pool_index %d",
271 client_index, regp->vl_api_registration_pool_index);
272 vl_msg_api_free (rp);
276 /* No dangling references, please */
279 pool_put_index (am->vl_clients, regp->vl_api_registration_pool_index);
281 pthread_mutex_lock (&svm->mutex);
282 oldheap = svm_push_data_heap (svm);
283 /* Poison the old registration */
284 memset (regp, 0xF1, sizeof (*regp));
285 clib_mem_free (regp);
286 pthread_mutex_unlock (&svm->mutex);
287 svm_pop_heap (oldheap);
291 clib_warning ("unknown client ID %d", mp->index);
296 vl_api_get_first_msg_id_t_handler (vl_api_get_first_msg_id_t * mp)
298 vl_api_get_first_msg_id_reply_t *rmp;
299 unix_shared_memory_queue_t *q;
301 api_main_t *am = &api_main;
302 vl_api_msg_range_t *rp;
304 u16 first_msg_id = ~0;
305 int rv = -7; /* VNET_API_ERROR_INVALID_VALUE */
307 q = vl_api_client_index_to_input_queue (mp->client_index);
311 if (am->msg_range_by_name == 0)
314 strncpy ((char *) name, (char *) mp->name, ARRAY_LEN (name) - 1);
316 p = hash_get_mem (am->msg_range_by_name, name);
320 rp = vec_elt_at_index (am->msg_ranges, p[0]);
322 first_msg_id = rp->first_msg_id;
327 rmp = vl_msg_api_alloc (sizeof (*rmp));
328 rmp->_vl_msg_id = ntohs (VL_API_GET_FIRST_MSG_ID_REPLY);
329 rmp->context = mp->context;
330 rmp->retval = ntohl (rv);
331 rmp->first_msg_id = ntohs (first_msg_id);
332 vl_msg_api_send_shmem (q, (u8 *) & rmp);
335 #define foreach_vlib_api_msg \
336 _(MEMCLNT_CREATE, memclnt_create) \
337 _(MEMCLNT_DELETE, memclnt_delete) \
338 _(GET_FIRST_MSG_ID, get_first_msg_id)
344 memory_api_init (char *region_name)
347 vl_msg_api_msg_config_t cfg;
348 vl_msg_api_msg_config_t *c = &cfg;
350 memset (c, 0, sizeof (*c));
352 if ((rv = vl_map_shmem (region_name, 1 /* is_vlib */ )) < 0)
355 #define _(N,n) do { \
356 c->id = VL_API_##N; \
358 c->handler = vl_api_##n##_t_handler; \
359 c->cleanup = vl_noop_handler; \
360 c->endian = vl_api_##n##_t_endian; \
361 c->print = vl_api_##n##_t_print; \
362 c->size = sizeof(vl_api_##n##_t); \
363 c->traced = 1; /* trace, so these msgs print */ \
364 c->replay = 0; /* don't replay client create/delete msgs */ \
365 c->message_bounce = 0; /* don't bounce this message */ \
366 vl_msg_api_config(c);} while (0);
368 foreach_vlib_api_msg;
374 #define foreach_histogram_bucket \
382 #define _(n) SLEEP_##n##_US,
383 foreach_histogram_bucket
388 static u64 vector_rate_histogram[SLEEP_N_BUCKETS];
390 static void memclnt_queue_callback (vlib_main_t * vm);
393 memclnt_process (vlib_main_t * vm,
394 vlib_node_runtime_t * node, vlib_frame_t * f)
398 unix_shared_memory_queue_t *q;
401 api_main_t *am = &api_main;
402 f64 dead_client_scan_time;
403 f64 sleep_time, start_time;
406 vlib_set_queue_signal_callback (vm, memclnt_queue_callback);
408 if ((rv = memory_api_init (am->region_name)) < 0)
410 clib_warning ("memory_api_init returned %d, wait for godot...", rv);
411 vlib_process_suspend (vm, 1e70);
416 q = shm->vl_input_queue;
419 e = vlib_call_init_exit_functions
420 (vm, vm->api_init_function_registrations, 1 /* call_once */ );
422 clib_error_report (e);
425 dead_client_scan_time = vlib_time_now (vm) + 20.0;
427 /* $$$ pay attention to frame size, control CPU usage */
430 uword event_type __attribute__ ((unused));
435 * There's a reason for checking the queue before
436 * sleeping. If the vlib application crashes, it's entirely
437 * possible for a client to enqueue a connect request
438 * during the process restart interval.
440 * Unless some force of physics causes the new incarnation
441 * of the application to process the request, the client will
442 * sit and wait for Godot...
444 vector_rate = vlib_last_vector_length_per_node (vm);
445 start_time = vlib_time_now (vm);
448 pthread_mutex_lock (&q->mutex);
451 vm->api_queue_nonempty = 0;
452 pthread_mutex_unlock (&q->mutex);
454 if (TRACE_VLIB_MEMORY_QUEUE)
457 ELOG_TYPE_DECLARE (e) =
459 .format = "q-underflow: len %d",
467 ed = ELOG_DATA (&vm->elog_main, e);
474 headp = (i8 *) (q->data + sizeof (uword) * q->head);
475 clib_memcpy (&mp, headp, sizeof (uword));
478 need_broadcast = (q->cursize == q->maxsize / 2);
481 if (PREDICT_FALSE (q->head == q->maxsize))
483 pthread_mutex_unlock (&q->mutex);
485 (void) pthread_cond_broadcast (&q->condvar);
487 vl_msg_api_handler_with_vm_node (am, (void *) mp, vm, node);
489 /* Allow no more than 10us without a pause */
490 if (vlib_time_now (vm) > start_time + 10e-6)
492 int index = SLEEP_400_US;
493 if (vector_rate > 40.0)
495 else if (vector_rate > 20.0)
497 index = SLEEP_200_US;
500 else if (vector_rate >= 1.0)
502 index = SLEEP_100_US;
510 vector_rate_histogram[index] += 1;
515 event_type = vlib_process_wait_for_event_or_clock (vm, sleep_time);
516 vm->queue_signal_pending = 0;
517 vlib_process_get_events (vm, 0 /* event_data */ );
519 if (vlib_time_now (vm) > dead_client_scan_time)
521 vl_api_registration_t **regpp;
522 vl_api_registration_t *regp;
523 unix_shared_memory_queue_t *q;
524 static u32 *dead_indices;
525 static u32 *confused_indices;
527 vec_reset_length (dead_indices);
528 vec_reset_length (confused_indices);
531 pool_foreach (regpp, am->vl_clients,
536 q = regp->vl_input_queue;
537 if (kill (q->consumer_pid, 0) < 0)
539 vec_add1(dead_indices, regpp - am->vl_clients);
544 clib_warning ("NULL client registration index %d",
545 regpp - am->vl_clients);
546 vec_add1 (confused_indices, regpp - am->vl_clients);
550 /* This should "never happen," but if it does, fix it... */
551 if (PREDICT_FALSE (vec_len (confused_indices) > 0))
554 for (i = 0; i < vec_len (confused_indices); i++)
556 pool_put_index (am->vl_clients, confused_indices[i]);
560 if (PREDICT_FALSE (vec_len (dead_indices) > 0))
566 /* Allow the application to clean up its registrations */
567 for (i = 0; i < vec_len (dead_indices); i++)
569 regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
574 handle = vl_msg_api_handle_from_index_and_epoch
575 (dead_indices[i], shm->application_restarts);
576 (void) vl_api_memclnt_delete_callback (handle);
581 pthread_mutex_lock (&svm->mutex);
582 oldheap = svm_push_data_heap (svm);
584 for (i = 0; i < vec_len (dead_indices); i++)
586 regpp = pool_elt_at_index (am->vl_clients, dead_indices[i]);
589 /* Poison the old registration */
590 memset (*regpp, 0xF3, sizeof (**regpp));
591 clib_mem_free (*regpp);
592 /* no dangling references, please */
597 svm_pop_heap (oldheap);
598 clib_warning ("Duplicate free, client index %d",
599 regpp - am->vl_clients);
600 oldheap = svm_push_data_heap (svm);
604 svm_client_scan_this_region_nolock (am->vlib_rp);
606 pthread_mutex_unlock (&svm->mutex);
607 svm_pop_heap (oldheap);
608 for (i = 0; i < vec_len (dead_indices); i++)
609 pool_put_index (am->vl_clients, dead_indices[i]);
612 dead_client_scan_time = vlib_time_now (vm) + 20.0;
615 if (TRACE_VLIB_MEMORY_QUEUE)
618 ELOG_TYPE_DECLARE (e) = {
619 .format = "q-awake: len %d",
627 ed = ELOG_DATA (&vm->elog_main, e);
628 ed->len = q->cursize;
635 static clib_error_t *
636 vl_api_show_histogram_command (vlib_main_t * vm,
637 unformat_input_t * input,
638 vlib_cli_command_t * cli_cmd)
640 u64 total_counts = 0;
643 for (i = 0; i < SLEEP_N_BUCKETS; i++)
645 total_counts += vector_rate_histogram[i];
648 if (total_counts == 0)
650 vlib_cli_output (vm, "No control-plane activity.");
657 percent = ((f64) vector_rate_histogram[SLEEP_##n##_US]) \
658 / (f64) total_counts; \
660 vlib_cli_output (vm, "Sleep %3d us: %llu, %.2f%%",n, \
661 vector_rate_histogram[SLEEP_##n##_US], \
664 foreach_histogram_bucket;
671 VLIB_CLI_COMMAND (cli_show_api_histogram_command, static) = {
672 .path = "show api histogram",
673 .short_help = "show api histogram",
674 .function = vl_api_show_histogram_command,
678 static clib_error_t *
679 vl_api_clear_histogram_command (vlib_main_t * vm,
680 unformat_input_t * input,
681 vlib_cli_command_t * cli_cmd)
685 for (i = 0; i < SLEEP_N_BUCKETS; i++)
686 vector_rate_histogram[i] = 0;
691 VLIB_CLI_COMMAND (cli_clear_api_histogram_command, static) = {
692 .path = "clear api histogram",
693 .short_help = "clear api histogram",
694 .function = vl_api_clear_histogram_command,
700 VLIB_REGISTER_NODE (memclnt_node,static) = {
701 .function = memclnt_process,
702 .type = VLIB_NODE_TYPE_PROCESS,
703 .name = "api-rx-from-ring",
704 .state = VLIB_NODE_STATE_DISABLED,
709 memclnt_queue_callback (vlib_main_t * vm)
711 static volatile int *cursizep;
713 if (PREDICT_FALSE (cursizep == 0))
715 api_main_t *am = &api_main;
716 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
717 unix_shared_memory_queue_t *q;
722 q = shmem_hdr->vl_input_queue;
725 cursizep = &q->cursize;
730 vm->queue_signal_pending = 1;
731 vm->api_queue_nonempty = 1;
732 vlib_process_signal_event (vm, memclnt_node.index,
733 /* event_type */ 0, /* event_data */ 0);
738 vl_enable_disable_memory_api (vlib_main_t * vm, int enable)
740 vlib_node_set_state (vm, memclnt_node.index,
742 ? VLIB_NODE_STATE_POLLING
743 : VLIB_NODE_STATE_DISABLED));
747 api_rx_from_node (vlib_main_t * vm,
748 vlib_node_runtime_t * node, vlib_frame_t * frame)
750 uword n_packets = frame->n_vectors;
755 vec_validate (long_msg, 4095);
756 n_left_from = frame->n_vectors;
757 from = vlib_frame_args (frame);
759 while (n_left_from > 0)
767 b0 = vlib_get_buffer (vm, bi0);
771 msg = b0->data + b0->current_data;
772 msg_len = b0->current_length;
773 if (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
775 ASSERT (long_msg != 0);
776 _vec_len (long_msg) = 0;
777 vec_add (long_msg, msg, msg_len);
778 while (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
780 b0 = vlib_get_buffer (vm, b0->next_buffer);
781 msg = b0->data + b0->current_data;
782 msg_len = b0->current_length;
783 vec_add (long_msg, msg, msg_len);
787 vl_msg_api_handler_no_trace_no_free (msg);
790 /* Free what we've been given. */
791 vlib_buffer_free (vm, vlib_frame_args (frame), n_packets);
797 VLIB_REGISTER_NODE (api_rx_from_node_node,static) = {
798 .function = api_rx_from_node,
799 .type = VLIB_NODE_TYPE_INTERNAL,
801 .name = "api-rx-from-node",
805 static clib_error_t *
806 setup_memclnt_exit (vlib_main_t * vm)
808 atexit (vl_unmap_shmem);
812 VLIB_INIT_FUNCTION (setup_memclnt_exit);
815 static clib_error_t *
816 vl_api_ring_command (vlib_main_t * vm,
817 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
821 vl_shmem_hdr_t *shmem_hdr;
822 api_main_t *am = &api_main;
824 shmem_hdr = am->shmem_hdr;
828 vlib_cli_output (vm, "Shared memory segment not initialized...\n");
832 vlib_cli_output (vm, "%8s %8s %8s %8s %8s\n",
833 "Owner", "Size", "Nitems", "Hits", "Misses");
835 ap = shmem_hdr->vl_rings;
837 for (i = 0; i < vec_len (shmem_hdr->vl_rings); i++)
839 vlib_cli_output (vm, "%8s %8d %8d %8d %8d\n",
840 "vlib", ap->size, ap->nitems, ap->hits, ap->misses);
844 ap = shmem_hdr->client_rings;
846 for (i = 0; i < vec_len (shmem_hdr->client_rings); i++)
848 vlib_cli_output (vm, "%8s %8d %8d %8d %8d\n",
849 "clnt", ap->size, ap->nitems, ap->hits, ap->misses);
853 vlib_cli_output (vm, "%d ring miss fallback allocations\n",
857 (vm, "%d application restarts, %d reclaimed msgs, %d garbage collects\n",
858 shmem_hdr->application_restarts,
859 shmem_hdr->restart_reclaims, shmem_hdr->garbage_collects);
863 void dump_socket_clients (vlib_main_t * vm, api_main_t * am)
864 __attribute__ ((weak));
867 dump_socket_clients (vlib_main_t * vm, api_main_t * am)
871 static clib_error_t *
872 vl_api_client_command (vlib_main_t * vm,
873 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
875 vl_api_registration_t **regpp, *regp;
876 unix_shared_memory_queue_t *q;
878 api_main_t *am = &api_main;
879 u32 *confused_indices = 0;
881 if (!pool_elts (am->vl_clients))
883 vlib_cli_output (vm, "Shared memory clients");
884 vlib_cli_output (vm, "%16s %8s %14s %18s %s",
885 "Name", "PID", "Queue Length", "Queue VA", "Health");
888 pool_foreach (regpp, am->vl_clients,
894 q = regp->vl_input_queue;
895 if (kill (q->consumer_pid, 0) < 0)
903 vlib_cli_output (vm, "%16s %8d %14d 0x%016llx %s\n",
904 regp->name, q->consumer_pid, q->cursize,
909 clib_warning ("NULL client registration index %d",
910 regpp - am->vl_clients);
911 vec_add1 (confused_indices, regpp - am->vl_clients);
916 /* This should "never happen," but if it does, fix it... */
917 if (PREDICT_FALSE (vec_len (confused_indices) > 0))
920 for (i = 0; i < vec_len (confused_indices); i++)
922 pool_put_index (am->vl_clients, confused_indices[i]);
925 vec_free (confused_indices);
927 if (am->missing_clients)
928 vlib_cli_output (vm, "%u messages with missing clients",
929 am->missing_clients);
931 dump_socket_clients (vm, am);
936 static clib_error_t *
937 vl_api_status_command (vlib_main_t * vm,
938 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
940 api_main_t *am = &api_main;
942 // check if rx_trace and tx_trace are not null pointers
944 if (am->rx_trace == 0)
946 vlib_cli_output (vm, "RX Trace disabled\n");
950 if (am->rx_trace->enabled == 0)
951 vlib_cli_output (vm, "RX Trace disabled\n");
953 vlib_cli_output (vm, "RX Trace enabled\n");
956 if (am->tx_trace == 0)
958 vlib_cli_output (vm, "TX Trace disabled\n");
962 if (am->tx_trace->enabled == 0)
963 vlib_cli_output (vm, "TX Trace disabled\n");
965 vlib_cli_output (vm, "TX Trace enabled\n");
972 VLIB_CLI_COMMAND (cli_show_api_command, static) = {
974 .short_help = "Show API information",
979 VLIB_CLI_COMMAND (cli_show_api_ring_command, static) = {
980 .path = "show api ring-stats",
981 .short_help = "Message ring statistics",
982 .function = vl_api_ring_command,
987 VLIB_CLI_COMMAND (cli_show_api_clients_command, static) = {
988 .path = "show api clients",
989 .short_help = "Client information",
990 .function = vl_api_client_command,
995 VLIB_CLI_COMMAND (cli_show_api_status_command, static) = {
996 .path = "show api status",
997 .short_help = "Show API trace status",
998 .function = vl_api_status_command,
1002 static clib_error_t *
1003 vl_api_message_table_command (vlib_main_t * vm,
1004 unformat_input_t * input,
1005 vlib_cli_command_t * cli_cmd)
1007 api_main_t *am = &api_main;
1011 if (unformat (input, "verbose"))
1016 vlib_cli_output (vm, "%-4s %s", "ID", "Name");
1018 vlib_cli_output (vm, "%-4s %-40s %6s %7s", "ID", "Name", "Bounce",
1021 for (i = 1; i < vec_len (am->msg_names); i++)
1025 vlib_cli_output (vm, "%-4d %s", i,
1026 am->msg_names[i] ? am->msg_names[i] :
1031 vlib_cli_output (vm, "%-4d %-40s %6d %7d", i,
1032 am->msg_names[i] ? am->msg_names[i] :
1033 " [no handler]", am->message_bounce[i],
1042 VLIB_CLI_COMMAND (cli_show_api_message_table_command, static) = {
1043 .path = "show api message-table",
1044 .short_help = "Message Table",
1045 .function = vl_api_message_table_command,
1049 static clib_error_t *
1050 vl_api_trace_command (vlib_main_t * vm,
1051 unformat_input_t * input, vlib_cli_command_t * cli_cmd)
1054 vl_api_trace_which_t which = VL_API_TRACE_RX;
1055 api_main_t *am = &api_main;
1057 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1059 if (unformat (input, "rx nitems %u", &nitems) || unformat (input, "rx"))
1061 else if (unformat (input, "tx nitems %u", &nitems)
1062 || unformat (input, "tx"))
1064 which = VL_API_TRACE_RX;
1067 else if (unformat (input, "on rx"))
1069 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 1);
1071 else if (unformat (input, "on tx"))
1073 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 1);
1075 else if (unformat (input, "on"))
1077 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 1);
1079 else if (unformat (input, "off"))
1081 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 0);
1082 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 0);
1084 else if (unformat (input, "free"))
1086 vl_msg_api_trace_onoff (am, VL_API_TRACE_RX, 0);
1087 vl_msg_api_trace_onoff (am, VL_API_TRACE_TX, 0);
1088 vl_msg_api_trace_free (am, VL_API_TRACE_RX);
1089 vl_msg_api_trace_free (am, VL_API_TRACE_TX);
1091 else if (unformat (input, "debug on"))
1093 am->msg_print_flag = 1;
1095 else if (unformat (input, "debug off"))
1097 am->msg_print_flag = 0;
1100 return clib_error_return (0, "unknown input `%U'",
1101 format_unformat_error, input);
1106 if (vl_msg_api_trace_configure (am, which, nitems))
1108 vlib_cli_output (vm, "warning: trace configure error (%d, %d)",
1116 VLIB_CLI_COMMAND (trace, static) = {
1117 .path = "set api-trace",
1118 .short_help = "API trace",
1119 .function = vl_api_trace_command,
1124 vlibmemory_init (vlib_main_t * vm)
1126 api_main_t *am = &api_main;
1127 svm_map_region_args_t _a, *a = &_a;
1129 memset (a, 0, sizeof (*a));
1130 a->root_path = am->root_path;
1131 a->name = SVM_GLOBAL_REGION_NAME;
1132 a->baseva = (am->global_baseva != 0) ?
1133 am->global_baseva : SVM_GLOBAL_REGION_BASEVA;
1134 a->size = (am->global_size != 0) ? am->global_size : SVM_GLOBAL_REGION_SIZE;
1135 a->flags = SVM_FLAGS_NODATA;
1136 a->uid = am->api_uid;
1137 a->gid = am->api_gid;
1139 (am->global_pvt_heap_size !=
1140 0) ? am->global_pvt_heap_size : SVM_PVT_MHEAP_SIZE;
1142 svm_region_init_args (a);
1146 VLIB_INIT_FUNCTION (vlibmemory_init);
1149 vl_set_memory_region_name (char *name)
1151 api_main_t *am = &api_main;
1153 am->region_name = name;
1157 range_compare (vl_api_msg_range_t * a0, vl_api_msg_range_t * a1)
1159 int len0, len1, clen;
1161 len0 = vec_len (a0->name);
1162 len1 = vec_len (a1->name);
1163 clen = len0 < len1 ? len0 : len1;
1164 return (strncmp ((char *) a0->name, (char *) a1->name, clen));
1168 format_api_msg_range (u8 * s, va_list * args)
1170 vl_api_msg_range_t *rp = va_arg (*args, vl_api_msg_range_t *);
1173 s = format (s, "%-20s%9s%9s", "Name", "First-ID", "Last-ID");
1175 s = format (s, "%-20s%9d%9d", rp->name, rp->first_msg_id,
1181 static clib_error_t *
1182 vl_api_show_plugin_command (vlib_main_t * vm,
1183 unformat_input_t * input,
1184 vlib_cli_command_t * cli_cmd)
1186 api_main_t *am = &api_main;
1187 vl_api_msg_range_t *rp = 0;
1190 if (vec_len (am->msg_ranges) == 0)
1192 vlib_cli_output (vm, "No plugin API message ranges configured...");
1196 rp = vec_dup (am->msg_ranges);
1198 vec_sort_with_function (rp, range_compare);
1200 vlib_cli_output (vm, "Plugin API message ID ranges...\n");
1201 vlib_cli_output (vm, "%U", format_api_msg_range, 0 /* header */ );
1203 for (i = 0; i < vec_len (rp); i++)
1204 vlib_cli_output (vm, "%U", format_api_msg_range, rp + i);
1210 VLIB_CLI_COMMAND (cli_show_api_plugin_command, static) = {
1211 .path = "show api plugin",
1212 .short_help = "show api plugin",
1213 .function = vl_api_show_plugin_command,
1218 vl_api_rpc_call_t_handler (vl_api_rpc_call_t * mp)
1220 vl_api_rpc_reply_t *rmp;
1223 vlib_main_t *vm = vlib_get_main ();
1225 if (mp->function == 0)
1228 clib_warning ("rpc NULL function pointer");
1233 if (mp->need_barrier_sync)
1234 vlib_worker_thread_barrier_sync (vm);
1236 fp = uword_to_pointer (mp->function, int (*)(void *));
1239 if (mp->need_barrier_sync)
1240 vlib_worker_thread_barrier_release (vm);
1245 unix_shared_memory_queue_t *q =
1246 vl_api_client_index_to_input_queue (mp->client_index);
1249 rmp = vl_msg_api_alloc_as_if_client (sizeof (*rmp));
1250 rmp->_vl_msg_id = ntohs (VL_API_RPC_REPLY);
1251 rmp->context = mp->context;
1253 vl_msg_api_send_shmem (q, (u8 *) & rmp);
1258 clib_warning ("multicast not yet implemented...");
1263 vl_api_rpc_reply_t_handler (vl_api_rpc_reply_t * mp)
1265 clib_warning ("unimplemented");
1269 vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length)
1271 vl_api_rpc_call_t *mp;
1272 api_main_t *am = &api_main;
1273 vl_shmem_hdr_t *shmem_hdr = am->shmem_hdr;
1274 unix_shared_memory_queue_t *q;
1276 /* Main thread: call the function directly */
1277 if (os_get_cpu_number () == 0)
1279 vlib_main_t *vm = vlib_get_main ();
1280 void (*call_fp) (void *);
1282 vlib_worker_thread_barrier_sync (vm);
1287 vlib_worker_thread_barrier_release (vm);
1291 /* Any other thread, actually do an RPC call... */
1292 mp = vl_msg_api_alloc_as_if_client (sizeof (*mp) + data_length);
1294 memset (mp, 0, sizeof (*mp));
1295 clib_memcpy (mp->data, data, data_length);
1296 mp->_vl_msg_id = ntohs (VL_API_RPC_CALL);
1297 mp->function = pointer_to_uword (fp);
1298 mp->need_barrier_sync = 1;
1301 * Use the "normal" control-plane mechanism for the main thread.
1302 * Well, almost. if the main input queue is full, we cannot
1303 * block. Otherwise, we can expect a barrier sync timeout.
1305 q = shmem_hdr->vl_input_queue;
1307 while (pthread_mutex_trylock (&q->mutex))
1308 vlib_worker_thread_barrier_check ();
1310 while (PREDICT_FALSE (unix_shared_memory_queue_is_full (q)))
1312 pthread_mutex_unlock (&q->mutex);
1313 vlib_worker_thread_barrier_check ();
1314 while (pthread_mutex_trylock (&q->mutex))
1315 vlib_worker_thread_barrier_check ();
1318 vl_msg_api_send_shmem_nolock (q, (u8 *) & mp);
1320 pthread_mutex_unlock (&q->mutex);
1323 #define foreach_rpc_api_msg \
1324 _(RPC_CALL,rpc_call) \
1325 _(RPC_REPLY,rpc_reply)
1327 static clib_error_t *
1328 rpc_api_hookup (vlib_main_t * vm)
1331 vl_msg_api_set_handlers(VL_API_##N, #n, \
1332 vl_api_##n##_t_handler, \
1335 vl_api_##n##_t_print, \
1336 sizeof(vl_api_##n##_t), 0 /* do not trace */);
1337 foreach_rpc_api_msg;
1342 VLIB_API_INIT_FUNCTION (rpc_api_hookup);
1345 * fd.io coding-style-patch-verification: ON
1348 * eval: (c-set-style "gnu")