2 *------------------------------------------------------------------
3 * api.c - message handler registration
5 * Copyright (c) 2010-2018 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 *------------------------------------------------------------------
23 #include <sys/types.h>
26 #include <netinet/in.h>
36 #include <vppinfra/clib.h>
37 #include <vppinfra/vec.h>
38 #include <vppinfra/hash.h>
39 #include <vppinfra/bitmap.h>
40 #include <vppinfra/fifo.h>
41 #include <vppinfra/time.h>
42 #include <vppinfra/mheap.h>
43 #include <vppinfra/heap.h>
44 #include <vppinfra/pool.h>
45 #include <vppinfra/format.h>
46 #include <vppinfra/error.h>
48 #include <vnet/api_errno.h>
49 #include <vnet/vnet.h>
51 #include <vlib/vlib.h>
52 #include <vlib/unix/unix.h>
53 #include <vlibapi/api.h>
54 #include <vlibmemory/api.h>
57 #undef __included_bihash_template_h__
59 #include <vnet/ip/format.h>
61 #include <vpp/api/vpe_msg_enum.h>
63 #define vl_typedefs /* define message structures */
64 #include <vpp/api/vpe_all_api_h.h>
66 #define vl_endianfun /* define message structures */
67 #include <vpp/api/vpe_all_api_h.h>
69 /* instantiate all the print functions we know about */
70 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
72 #include <vpp/api/vpe_all_api_h.h>
74 #include <vlibapi/api_helper_macros.h>
76 #define foreach_vpe_api_msg \
77 _(CONTROL_PING, control_ping) \
79 _(CLI_INBAND, cli_inband) \
80 _(GET_NODE_INDEX, get_node_index) \
81 _(ADD_NODE_NEXT, add_node_next) \
82 _(SHOW_VERSION, show_version) \
83 _(SHOW_THREADS, show_threads) \
84 _(GET_NODE_GRAPH, get_node_graph) \
85 _(GET_NEXT_INDEX, get_next_index) \
88 #define QUOTE(x) QUOTE_(x)
92 RESOLVE_IP4_ADD_DEL_ROUTE = 1,
93 RESOLVE_IP6_ADD_DEL_ROUTE,
96 extern vpe_api_main_t vpe_api_main;
98 /* Clean up all registrations belonging to the indicated client */
100 memclnt_delete_callback (u32 client_index)
102 vpe_api_main_t *vam = &vpe_api_main;
103 vpe_client_registration_t *rp;
107 p = hash_get (vam->a##_registration_hash, client_index); \
109 rp = pool_elt_at_index (vam->a##_registrations, p[0]); \
110 pool_put (vam->a##_registrations, rp); \
111 hash_unset (vam->a##_registration_hash, client_index); \
113 foreach_registration_hash;
118 VL_MSG_API_REAPER_FUNCTION (memclnt_delete_callback);
121 vl_api_control_ping_t_handler (vl_api_control_ping_t * mp)
123 vl_api_control_ping_reply_t *rmp;
127 REPLY_MACRO2(VL_API_CONTROL_PING_REPLY,
129 rmp->vpe_pid = ntohl (getpid());
135 shmem_cli_output (uword arg, u8 * buffer, uword buffer_bytes)
137 u8 **shmem_vecp = (u8 **) arg;
140 api_main_t *am = &api_main;
143 shmem_vec = *shmem_vecp;
145 offset = vec_len (shmem_vec);
147 pthread_mutex_lock (&am->vlib_rp->mutex);
148 oldheap = svm_push_data_heap (am->vlib_rp);
150 vec_validate (shmem_vec, offset + buffer_bytes - 1);
152 clib_memcpy (shmem_vec + offset, buffer, buffer_bytes);
154 svm_pop_heap (oldheap);
155 pthread_mutex_unlock (&am->vlib_rp->mutex);
157 *shmem_vecp = shmem_vec;
162 vl_api_cli_t_handler (vl_api_cli_t * mp)
164 vl_api_cli_reply_t *rp;
165 vl_api_registration_t *reg;
166 vlib_main_t *vm = vlib_get_main ();
167 api_main_t *am = &api_main;
168 unformat_input_t input;
172 reg = vl_api_client_index_to_registration (mp->client_index);
176 rp = vl_msg_api_alloc (sizeof (*rp));
177 rp->_vl_msg_id = ntohs (VL_API_CLI_REPLY);
178 rp->context = mp->context;
180 unformat_init_vector (&input, (u8 *) (uword) mp->cmd_in_shmem);
182 vlib_cli_input (vm, &input, shmem_cli_output, (uword) & shmem_vec);
184 pthread_mutex_lock (&am->vlib_rp->mutex);
185 oldheap = svm_push_data_heap (am->vlib_rp);
187 vec_add1 (shmem_vec, 0);
189 svm_pop_heap (oldheap);
190 pthread_mutex_unlock (&am->vlib_rp->mutex);
192 rp->reply_in_shmem = (uword) shmem_vec;
194 vl_api_send_msg (reg, (u8 *) rp);
198 inband_cli_output (uword arg, u8 * buffer, uword buffer_bytes)
200 u8 **mem_vecp = (u8 **) arg;
201 u8 *mem_vec = *mem_vecp;
202 u32 offset = vec_len (mem_vec);
204 vec_validate (mem_vec, offset + buffer_bytes - 1);
205 clib_memcpy (mem_vec + offset, buffer, buffer_bytes);
210 vl_api_cli_inband_t_handler (vl_api_cli_inband_t * mp)
212 vl_api_cli_inband_reply_t *rmp;
214 vlib_main_t *vm = vlib_get_main ();
215 unformat_input_t input;
219 if (vl_msg_api_get_msg_length (mp) <
220 vl_api_string_len (&mp->cmd) + sizeof (*mp))
226 unformat_init_string (&input, (char *) vl_api_from_api_string (&mp->cmd),
227 vl_api_string_len (&mp->cmd));
228 vlib_cli_input (vm, &input, inband_cli_output, (uword) & out_vec);
230 len = vec_len (out_vec);
234 REPLY_MACRO3(VL_API_CLI_INBAND_REPLY, len,
236 vl_api_to_api_string(len, (const char *)out_vec, &rmp->reply);
243 vl_api_show_version_t_handler (vl_api_show_version_t * mp)
245 vl_api_show_version_reply_t *rmp;
247 char *vpe_api_get_build_directory (void);
248 char *vpe_api_get_version (void);
249 char *vpe_api_get_build_date (void);
251 u32 program_len = strnlen_s ("vpe", 32);
252 u32 version_len = strnlen_s (vpe_api_get_version (), 32);
253 u32 build_date_len = strnlen_s (vpe_api_get_build_date (), 32);
254 u32 build_directory_len = strnlen_s (vpe_api_get_build_directory (), 256);
256 u32 n = program_len + version_len + build_date_len + build_directory_len;
259 REPLY_MACRO3(VL_API_SHOW_VERSION_REPLY, n,
261 char *p = (char *)&rmp->program;
262 p += vl_api_to_api_string(program_len, "vpe", (vl_api_string_t *)p);
263 p += vl_api_to_api_string(version_len, vpe_api_get_version(), (vl_api_string_t *)p);
264 p += vl_api_to_api_string(build_date_len, vpe_api_get_build_date(), (vl_api_string_t *)p);
265 vl_api_to_api_string(build_directory_len, vpe_api_get_build_directory(), (vl_api_string_t *)p);
271 get_thread_data (vl_api_thread_data_t * td, int index)
273 vlib_worker_thread_t *w = vlib_worker_threads + index;
274 td->id = htonl (index);
276 strncpy ((char *) td->name, (char *) w->name, ARRAY_LEN (td->name) - 1);
278 strncpy ((char *) td->type, (char *) w->registration->name,
279 ARRAY_LEN (td->type) - 1);
280 td->pid = htonl (w->lwp);
281 td->cpu_id = htonl (w->cpu_id);
282 td->core = htonl (w->core_id);
283 td->cpu_socket = htonl (w->socket_id);
287 vl_api_show_threads_t_handler (vl_api_show_threads_t * mp)
289 vlib_main_t *vm = vlib_get_main ();
290 int rv = 0, count = 0;
292 #if !defined(__powerpc64__)
293 vl_api_registration_t *reg;
294 vl_api_show_threads_reply_t *rmp;
295 vl_api_thread_data_t *td;
297 count = vec_len (vlib_worker_threads);
301 msg_size = sizeof (*rmp) + sizeof (rmp->thread_data[0]) * count;
302 reg = vl_api_client_index_to_registration (mp->client_index);
306 rmp = vl_msg_api_alloc (msg_size);
307 clib_memset (rmp, 0, msg_size);
308 rmp->_vl_msg_id = htons (VL_API_SHOW_THREADS_REPLY);
309 rmp->context = mp->context;
310 rmp->count = htonl (count);
311 td = rmp->thread_data;
313 for (i = 0; i < count; i++)
315 get_thread_data (&td[i], i);
318 vl_api_send_msg (reg, (u8 *) rmp);
321 /* unimplemented support */
323 clib_warning ("power pc does not support show threads api");
325 REPLY_MACRO2(VL_API_SHOW_THREADS_REPLY,
327 rmp->count = htonl(count);
334 vl_api_get_node_index_t_handler (vl_api_get_node_index_t * mp)
336 vlib_main_t *vm = vlib_get_main ();
337 vl_api_get_node_index_reply_t *rmp;
342 n = vlib_get_node_by_name (vm, mp->node_name);
345 rv = VNET_API_ERROR_NO_SUCH_NODE;
347 node_index = n->index;
350 REPLY_MACRO2(VL_API_GET_NODE_INDEX_REPLY,
352 rmp->node_index = ntohl(node_index);
358 vl_api_get_next_index_t_handler (vl_api_get_next_index_t * mp)
360 vlib_main_t *vm = vlib_get_main ();
361 vl_api_get_next_index_reply_t *rmp;
362 vlib_node_t *node, *next_node;
364 u32 next_node_index = ~0, next_index = ~0;
367 node = vlib_get_node_by_name (vm, mp->node_name);
371 rv = VNET_API_ERROR_NO_SUCH_NODE;
375 next_node = vlib_get_node_by_name (vm, mp->next_name);
379 rv = VNET_API_ERROR_NO_SUCH_NODE2;
383 next_node_index = next_node->index;
385 p = hash_get (node->next_slot_by_node, next_node_index);
389 rv = VNET_API_ERROR_NO_SUCH_ENTRY;
397 REPLY_MACRO2(VL_API_GET_NEXT_INDEX_REPLY,
399 rmp->next_index = ntohl(next_index);
405 vl_api_add_node_next_t_handler (vl_api_add_node_next_t * mp)
407 vlib_main_t *vm = vlib_get_main ();
408 vl_api_add_node_next_reply_t *rmp;
409 vlib_node_t *n, *next;
413 n = vlib_get_node_by_name (vm, mp->node_name);
417 rv = VNET_API_ERROR_NO_SUCH_NODE;
421 next = vlib_get_node_by_name (vm, mp->next_name);
424 rv = VNET_API_ERROR_NO_SUCH_NODE2;
426 next_index = vlib_node_add_next (vm, n->index, next->index);
430 REPLY_MACRO2(VL_API_GET_NODE_INDEX_REPLY,
432 rmp->next_index = ntohl(next_index);
438 vl_api_get_node_graph_t_handler (vl_api_get_node_graph_t * mp)
442 api_main_t *am = &api_main;
443 vlib_main_t *vm = vlib_get_main ();
445 vl_api_get_node_graph_reply_t *rmp;
446 static vlib_node_t ***node_dups;
447 static vlib_main_t **stat_vms;
449 pthread_mutex_lock (&am->vlib_rp->mutex);
450 oldheap = svm_push_data_heap (am->vlib_rp);
453 * Keep the number of memcpy ops to a minimum (e.g. 1).
455 vec_validate (vector, 16384);
456 vec_reset_length (vector);
458 vlib_node_get_nodes (vm, 0 /* main threads */ ,
459 0 /* include stats */ ,
460 1 /* barrier sync */ ,
461 &node_dups, &stat_vms);
462 vector = vlib_node_serialize (vm, node_dups, vector, 1 /* include nexts */ ,
463 1 /* include stats */ );
465 svm_pop_heap (oldheap);
466 pthread_mutex_unlock (&am->vlib_rp->mutex);
469 REPLY_MACRO2(VL_API_GET_NODE_GRAPH_REPLY,
471 rmp->reply_in_shmem = (uword) vector;
476 #define BOUNCE_HANDLER(nn) \
477 static void vl_api_##nn##_t_handler ( \
478 vl_api_##nn##_t *mp) \
480 vpe_client_registration_t *reg; \
481 vpe_api_main_t * vam = &vpe_api_main; \
484 /* One registration only... */ \
485 pool_foreach(reg, vam->nn##_registrations, \
487 q = vl_api_client_index_to_input_queue (reg->client_index); \
490 * If the queue is stuffed, turf the msg and complain \
491 * It's unlikely that the intended recipient is \
492 * alive; avoid deadlock at all costs. \
494 if (q->cursize == q->maxsize) { \
495 clib_warning ("ERROR: receiver queue full, drop msg"); \
496 vl_msg_api_free (mp); \
499 vl_msg_api_send_shmem (q, (u8 *)&mp); \
503 vl_msg_api_free (mp); \
506 static void setup_message_id_table (api_main_t * am);
510 * Add vpe's API message handlers to the table.
511 * vlib has already mapped shared memory and
512 * added the client registration handlers.
513 * See .../open-repo/vlib/memclnt_vlib.c:memclnt_process()
515 static clib_error_t *
516 vpe_api_hookup (vlib_main_t * vm)
518 api_main_t *am = &api_main;
521 vl_msg_api_set_handlers(VL_API_##N, #n, \
522 vl_api_##n##_t_handler, \
524 vl_api_##n##_t_endian, \
525 vl_api_##n##_t_print, \
526 sizeof(vl_api_##n##_t), 1);
531 * Trace space for classifier mask+match
533 am->api_trace_cfg[VL_API_CLASSIFY_ADD_DEL_TABLE].size += 5 * sizeof (u32x4);
534 am->api_trace_cfg[VL_API_CLASSIFY_ADD_DEL_SESSION].size
535 += 5 * sizeof (u32x4);
538 * Thread-safe API messages
540 am->is_mp_safe[VL_API_IP_ADD_DEL_ROUTE] = 1;
541 am->is_mp_safe[VL_API_GET_NODE_GRAPH] = 1;
544 * Set up the (msg_name, crc, message-id) table
546 setup_message_id_table (am);
551 VLIB_API_INIT_FUNCTION (vpe_api_hookup);
554 vpe_api_init (vlib_main_t * vm)
556 vpe_api_main_t *am = &vpe_api_main;
559 am->vnet_main = vnet_get_main ();
561 am->a##_registration_hash = hash_create (0, sizeof (uword));
562 foreach_registration_hash;
565 vl_set_memory_region_name ("/vpe-api");
566 vl_mem_api_enable_disable (vm, 1 /* enable it */ );
571 static clib_error_t *
572 api_segment_config (vlib_main_t * vm, unformat_input_t * input)
575 u64 baseva, size, pvt_heap_size;
577 const int max_buf_size = 4096;
579 struct passwd _pw, *pw;
580 struct group _grp, *grp;
582 buf = vec_new (char, 128);
583 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
585 if (unformat (input, "prefix %s", &chroot_path))
587 vec_add1 (chroot_path, 0);
588 vl_set_memory_root_path ((char *) chroot_path);
590 else if (unformat (input, "uid %d", &uid))
591 vl_set_memory_uid (uid);
592 else if (unformat (input, "gid %d", &gid))
593 vl_set_memory_gid (gid);
594 else if (unformat (input, "baseva %llx", &baseva))
595 vl_set_global_memory_baseva (baseva);
596 else if (unformat (input, "global-size %lldM", &size))
597 vl_set_global_memory_size (size * (1ULL << 20));
598 else if (unformat (input, "global-size %lldG", &size))
599 vl_set_global_memory_size (size * (1ULL << 30));
600 else if (unformat (input, "global-size %lld", &size))
601 vl_set_global_memory_size (size);
602 else if (unformat (input, "global-pvt-heap-size %lldM", &pvt_heap_size))
603 vl_set_global_pvt_heap_size (pvt_heap_size * (1ULL << 20));
604 else if (unformat (input, "global-pvt-heap-size size %lld",
606 vl_set_global_pvt_heap_size (pvt_heap_size);
607 else if (unformat (input, "api-pvt-heap-size %lldM", &pvt_heap_size))
608 vl_set_api_pvt_heap_size (pvt_heap_size * (1ULL << 20));
609 else if (unformat (input, "api-pvt-heap-size size %lld",
611 vl_set_api_pvt_heap_size (pvt_heap_size);
612 else if (unformat (input, "api-size %lldM", &size))
613 vl_set_api_memory_size (size * (1ULL << 20));
614 else if (unformat (input, "api-size %lldG", &size))
615 vl_set_api_memory_size (size * (1ULL << 30));
616 else if (unformat (input, "api-size %lld", &size))
617 vl_set_api_memory_size (size);
618 else if (unformat (input, "uid %s", &s))
620 /* lookup the username */
623 getpwnam_r (s, &_pw, buf, vec_len (buf), &pw)) == ERANGE)
624 && (vec_len (buf) <= max_buf_size))
626 vec_resize (buf, vec_len (buf) * 2);
630 e = clib_error_return_code (0, rv,
631 CLIB_ERROR_ERRNO_VALID |
633 "cannot fetch username %s", s);
641 clib_error_return_fatal (0, "username %s does not exist", s);
647 vl_set_memory_uid (pw->pw_uid);
649 else if (unformat (input, "gid %s", &s))
651 /* lookup the group name */
654 getgrnam_r (s, &_grp, buf, vec_len (buf), &grp)) == ERANGE)
655 && (vec_len (buf) <= max_buf_size))
657 vec_resize (buf, vec_len (buf) * 2);
661 e = clib_error_return_code (0, rv,
662 CLIB_ERROR_ERRNO_VALID |
664 "cannot fetch group %s", s);
671 e = clib_error_return_fatal (0, "group %s does not exist", s);
678 vl_set_memory_gid (grp->gr_gid);
681 return clib_error_return (0, "unknown input `%U'",
682 format_unformat_error, input);
687 VLIB_EARLY_CONFIG_FUNCTION (api_segment_config, "api-segment");
690 get_unformat_vnet_sw_interface (void)
692 return (void *) &unformat_vnet_sw_interface;
696 format_arp_event (u8 * s, va_list * args)
698 vl_api_ip4_arp_event_t *event = va_arg (*args, vl_api_ip4_arp_event_t *);
700 s = format (s, "pid %d: ", ntohl (event->pid));
701 s = format (s, "resolution for %U", format_ip4_address, &event->address);
706 format_nd_event (u8 * s, va_list * args)
708 vl_api_ip6_nd_event_t *event = va_arg (*args, vl_api_ip6_nd_event_t *);
710 s = format (s, "pid %d: ", ntohl (event->pid));
711 s = format (s, "resolution for %U", format_ip6_address, event->address);
715 static clib_error_t *
716 show_ip_arp_nd_events_fn (vlib_main_t * vm,
717 unformat_input_t * input, vlib_cli_command_t * cmd)
719 vpe_api_main_t *am = &vpe_api_main;
720 vl_api_ip4_arp_event_t *arp_event;
721 vl_api_ip6_nd_event_t *nd_event;
723 if (pool_elts (am->arp_events) == 0 && pool_elts (am->nd_events) == 0 &&
724 pool_elts (am->wc_ip4_arp_events_registrations) == 0 &&
725 pool_elts (am->wc_ip6_nd_events_registrations) == 0)
727 vlib_cli_output (vm, "No active arp or nd event registrations");
732 pool_foreach (arp_event, am->arp_events,
734 vlib_cli_output (vm, "%U", format_arp_event, arp_event);
737 vpe_client_registration_t *reg;
738 pool_foreach(reg, am->wc_ip4_arp_events_registrations,
740 vlib_cli_output (vm, "pid %d: bd mac/ip4 binding events",
741 ntohl (reg->client_pid));
744 pool_foreach (nd_event, am->nd_events,
746 vlib_cli_output (vm, "%U", format_nd_event, nd_event);
749 pool_foreach(reg, am->wc_ip6_nd_events_registrations,
751 vlib_cli_output (vm, "pid %d: bd mac/ip6 binding events",
752 ntohl (reg->client_pid));
760 VLIB_CLI_COMMAND (show_ip_arp_nd_events, static) = {
761 .path = "show arp-nd-event registrations",
762 .function = show_ip_arp_nd_events_fn,
763 .short_help = "Show ip4 arp and ip6 nd event registrations",
767 #define vl_msg_name_crc_list
768 #include <vpp/api/vpe_all_api_h.h>
769 #undef vl_msg_name_crc_list
772 setup_message_id_table (api_main_t * am)
774 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
775 foreach_vl_msg_name_crc_memclnt;
776 foreach_vl_msg_name_crc_vpe;
779 #define vl_api_version_tuple(n,mj, mi, p) \
780 vl_msg_api_add_version (am, #n, mj, mi, p);
781 #include <vpp/api/vpe_all_api_h.h>
782 #undef vl_api_version_tuple
787 * fd.io coding-style-patch-verification: ON
790 * eval: (c-set-style "gnu")