2 *------------------------------------------------------------------
3 * Copyright (c) 2021 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
19 #include <vlibapi/api.h>
20 #include <vlibmemory/api.h>
21 #include <vppinfra/error.h>
23 #include <vpp/api/types.h>
24 #include <vnet/mpls/packet.h>
25 #include <vnet/ip/ip_types_api.h>
32 vlib_test_main_t vlib_test_main;
34 #define __plugin_msg_base vlib_test_main.msg_id_base
35 #include <vlibapi/vat_helper_macros.h>
37 /* Declare message IDs */
38 #include <vlibmemory/vlib.api_enum.h>
39 #include <vlibmemory/vlib.api_types.h>
42 vl_api_cli_reply_t_handler (vl_api_cli_reply_t *mp)
44 vat_main_t *vam = &vat_main;
45 i32 retval = ntohl (mp->retval);
48 vam->shmem_result = uword_to_pointer (mp->reply_in_shmem, u8 *);
49 vam->result_ready = 1;
53 vl_api_cli_inband_reply_t_handler (vl_api_cli_inband_reply_t *mp)
55 vat_main_t *vam = &vat_main;
56 i32 retval = ntohl (mp->retval);
58 vec_reset_length (vam->cmd_reply);
62 vam->cmd_reply = vl_api_from_api_to_new_vec (mp, &mp->reply);
63 vam->result_ready = 1;
67 vl_api_get_node_index_reply_t_handler (vl_api_get_node_index_reply_t *mp)
69 vat_main_t *vam = &vat_main;
70 i32 retval = ntohl (mp->retval);
73 vam->async_errors += (retval < 0);
79 errmsg ("node index %d", ntohl (mp->node_index));
80 vam->result_ready = 1;
85 vl_api_get_next_index_reply_t_handler (vl_api_get_next_index_reply_t *mp)
87 vat_main_t *vam = &vat_main;
88 i32 retval = ntohl (mp->retval);
91 vam->async_errors += (retval < 0);
97 errmsg ("next node index %d", ntohl (mp->next_index));
98 vam->result_ready = 1;
103 vl_api_add_node_next_reply_t_handler (vl_api_add_node_next_reply_t *mp)
105 vat_main_t *vam = &vat_main;
106 i32 retval = ntohl (mp->retval);
109 vam->async_errors += (retval < 0);
113 vam->retval = retval;
115 errmsg ("next index %d", ntohl (mp->next_index));
116 vam->result_ready = 1;
121 vl_api_get_f64_endian_value_reply_t_handler (
122 vl_api_get_f64_endian_value_reply_t *mp)
124 // not yet implemented
128 vl_api_get_f64_increment_by_one_reply_t_handler (
129 vl_api_get_f64_increment_by_one_reply_t *mp)
131 // not yet implemented
135 api_get_f64_endian_value (vat_main_t *vam)
137 // not yet implemented
142 api_get_f64_increment_by_one (vat_main_t *vam)
144 // not yet implemented
149 * Pass CLI buffers directly in the CLI_INBAND API message,
150 * instead of an additional shared memory area.
153 exec_inband (vat_main_t *vam)
155 vl_api_cli_inband_t *mp;
156 unformat_input_t *i = vam->input;
159 if (vec_len (i->buffer) == 0)
162 if (vam->exec_mode == 0 && unformat (i, "mode"))
167 if (vam->exec_mode == 1 && (unformat (i, "exit") || unformat (i, "quit")))
174 * In order for the CLI command to work, it
175 * must be a vector ending in \n, not a C-string ending
178 M2 (CLI_INBAND, mp, vec_len (vam->input->buffer));
179 vl_api_vec_to_api_string (vam->input->buffer, &mp->cmd);
183 /* json responses may or may not include a useful reply... */
184 if (vec_len (vam->cmd_reply))
185 print (vam->ofp, "%v", (char *) (vam->cmd_reply));
189 api_cli_inband (vat_main_t *vam)
191 return exec_inband (vam);
195 exec (vat_main_t *vam)
197 return exec_inband (vam);
201 api_cli (vat_main_t *vam)
207 api_get_node_index (vat_main_t *vam)
209 unformat_input_t *i = vam->input;
210 vl_api_get_node_index_t *mp;
214 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
216 if (unformat (i, "node %s", &name))
223 errmsg ("node name required");
226 if (vec_len (name) >= ARRAY_LEN (mp->node_name))
228 errmsg ("node name too long, max %d", ARRAY_LEN (mp->node_name));
232 M (GET_NODE_INDEX, mp);
233 clib_memcpy (mp->node_name, name, vec_len (name));
242 api_get_next_index (vat_main_t *vam)
244 unformat_input_t *i = vam->input;
245 vl_api_get_next_index_t *mp;
246 u8 *node_name = 0, *next_node_name = 0;
249 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
251 if (unformat (i, "node-name %s", &node_name))
253 else if (unformat (i, "next-node-name %s", &next_node_name))
259 errmsg ("node name required");
262 if (vec_len (node_name) >= ARRAY_LEN (mp->node_name))
264 errmsg ("node name too long, max %d", ARRAY_LEN (mp->node_name));
268 if (next_node_name == 0)
270 errmsg ("next node name required");
273 if (vec_len (next_node_name) >= ARRAY_LEN (mp->next_name))
275 errmsg ("next node name too long, max %d", ARRAY_LEN (mp->next_name));
279 M (GET_NEXT_INDEX, mp);
280 clib_memcpy (mp->node_name, node_name, vec_len (node_name));
281 clib_memcpy (mp->next_name, next_node_name, vec_len (next_node_name));
282 vec_free (node_name);
283 vec_free (next_node_name);
291 api_add_node_next (vat_main_t *vam)
293 unformat_input_t *i = vam->input;
294 vl_api_add_node_next_t *mp;
299 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
301 if (unformat (i, "node %s", &name))
303 else if (unformat (i, "next %s", &next))
310 errmsg ("node name required");
313 if (vec_len (name) >= ARRAY_LEN (mp->node_name))
315 errmsg ("node name too long, max %d", ARRAY_LEN (mp->node_name));
320 errmsg ("next node required");
323 if (vec_len (next) >= ARRAY_LEN (mp->next_name))
325 errmsg ("next name too long, max %d", ARRAY_LEN (mp->next_name));
329 M (ADD_NODE_NEXT, mp);
330 clib_memcpy (mp->node_name, name, vec_len (name));
331 clib_memcpy (mp->next_name, next, vec_len (next));
341 vl_api_show_threads_reply_t_handler (vl_api_show_threads_reply_t *mp)
343 vat_main_t *vam = &vat_main;
344 i32 retval = ntohl (mp->retval);
348 count = ntohl (mp->count);
350 for (i = 0; i < count; i++)
351 print (vam->ofp, "\n%-2d %-11s %-11s %-5d %-6d %-4d %-6d",
352 ntohl (mp->thread_data[i].id), mp->thread_data[i].name,
353 mp->thread_data[i].type, ntohl (mp->thread_data[i].pid),
354 ntohl (mp->thread_data[i].cpu_id), ntohl (mp->thread_data[i].core),
355 ntohl (mp->thread_data[i].cpu_socket));
357 vam->retval = retval;
358 vam->result_ready = 1;
362 api_show_threads (vat_main_t *vam)
364 vl_api_show_threads_t *mp;
367 print (vam->ofp, "\n%-2s %-11s %-11s %-5s %-6s %-4s %-6s", "ID", "Name",
368 "Type", "LWP", "cpu_id", "Core", "Socket");
370 M (SHOW_THREADS, mp);
378 vl_api_get_node_graph_reply_t_handler (vl_api_get_node_graph_reply_t *mp)
380 vat_main_t *vam = &vat_main;
381 i32 retval = ntohl (mp->retval);
382 u8 *pvt_copy, *reply;
389 vam->async_errors += (retval < 0);
393 vam->retval = retval;
394 vam->result_ready = 1;
397 /* "Should never happen..." */
401 reply = uword_to_pointer (mp->reply_in_shmem, u8 *);
402 pvt_copy = vec_dup (reply);
404 /* Toss the shared-memory original... */
405 oldheap = vl_msg_push_heap ();
409 vl_msg_pop_heap (oldheap);
411 if (vam->graph_nodes)
413 hash_free (vam->graph_node_index_by_name);
415 for (i = 0; i < vec_len (vam->graph_nodes[0]); i++)
417 node = vam->graph_nodes[0][i];
418 vec_free (node->name);
419 vec_free (node->next_nodes);
422 vec_free (vam->graph_nodes[0]);
423 vec_free (vam->graph_nodes);
426 vam->graph_node_index_by_name = hash_create_string (0, sizeof (uword));
427 vam->graph_nodes = vlib_node_unserialize (pvt_copy);
430 for (i = 0; i < vec_len (vam->graph_nodes[0]); i++)
432 node = vam->graph_nodes[0][i];
433 hash_set_mem (vam->graph_node_index_by_name, node->name, i);
438 api_get_node_graph (vat_main_t *vam)
440 vl_api_get_node_graph_t *mp;
443 M (GET_NODE_GRAPH, mp);
447 /* Wait for the reply */
452 #define VL_API_LOCAL_SETUP_MESSAGE_ID_TABLE local_setup_message_id_table
454 local_setup_message_id_table (vat_main_t *vam)
456 /* Add exec as an alias for cli_inband */
457 hash_set_mem (vam->function_by_name, "exec", api_cli_inband);
458 hash_set_mem (vam->help_by_name, "exec",
459 "usage: exec <vpe-debug-CLI-command>");
462 #include <vlibmemory/vlib.api_test.c>
465 * fd.io coding-style-patch-verification: ON
468 * eval: (c-set-style "gnu")