2 * Copyright (c) 2021 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 option version = "1.0.0";
18 /** \brief Process a vpe parser cli string request
19 @param client_index - opaque cookie to identify the sender
20 @param context - sender context, to match reply w/ request
21 @param cmd_in_shmem - pointer to cli command string
36 /** \brief vpe parser cli string response
37 @param context - sender context, to match reply w/ request
38 @param retval - return code for request
39 @param reply_in_shmem - Reply string from cli processing if any
47 define cli_inband_reply
54 /** \brief Get node index using name request
55 @param client_index - opaque cookie to identify the sender
56 @param context - sender context, to match reply w/ request
57 @param node_name[] - name of the node
66 /** \brief Get node index using name request
67 @param context - sender context, to match reply w/ request
68 @param retval - return code for the request
69 @param node_index - index of the desired node if found, else ~0
71 define get_node_index_reply
78 /** \brief Set the next node for a given node request
79 @param client_index - opaque cookie to identify the sender
80 @param context - sender context, to match reply w/ request
81 @param node_name[] - node to add the next node to
82 @param next_name[] - node to add as the next node
92 /** \brief IP Set the next node for a given node response
93 @param context - sender context, to match reply w/ request
94 @param retval - return code for the add next node request
95 @param next_index - the index of the next node if success, else ~0
97 define add_node_next_reply
104 /** \brief show_threads display the information about vpp
105 threads running on system along with their process id,
106 cpu id, physical core and cpu socket.
114 /** \brief thread data
115 @param id - thread index
116 @param name - thread name i.e. vpp_main or vpp_wk_0
117 @param type - thread type i.e. workers or stats
118 @param pid - thread Process Id
119 @param cpu_id - thread pinned to cpu.
120 "CPUs or Logical cores are the number of physical cores times
121 the number of threads that can run on each core through
122 the use of hyperthreading." (from unix.stackexchange.com)
123 @param core - thread pinned to actual physical core.
124 @param cpu_socket - thread is running on which cpu socket.
137 /** \brief show_threads_reply
138 @param context - returned sender context, to match reply w/ request
139 @param retval - return code
140 @param count - number of threads in thread_data array
141 @param thread_data - array of thread data
143 define show_threads_reply
148 vl_api_thread_data_t thread_data[count];
151 define get_node_graph
157 /** \brief get_node_graph_reply
158 @param context - returned sender context, to match reply w/ request
159 @param retval - return code
160 @param reply_in_shmem - result from vlib_node_serialize, in shared
161 memory. Process with vlib_node_unserialize, remember to switch
162 heaps and free the result.
165 define get_node_graph_reply
172 /** \brief Query relative index via node names
173 @param client_index - opaque cookie to identify the sender
174 @param context - sender context, to match reply w/ request
175 @param node_name - name of node to find relative index from
176 @param next_name - next node from node_name to find relative index of
178 define get_next_index
182 string node_name[64];
183 string next_name[64];
186 /** \brief Reply for get next node index
187 @param context - sender context which was passed in the request
188 @param retval - return value
189 @param next_index - index of the next_node
191 define get_next_index_reply
198 /** \brief f64 types are not standardized across the wire. Sense wire format in each direction by sending the f64 value 1.0.
199 @param client_index - opaque cookie to identify the sender
200 @param context - sender context, to match reply w/ request
201 @param f64_one - The constant of 1.0. If you send a different value, expect an rv=VNET_API_ERROR_API_ENDIAN_FAILED.
203 define get_f64_endian_value
207 f64 f64_one [default=1.0];
210 /** \brief get_f64_endian_value reply message
211 @param context - sender context which was passed in the request
212 @param retval - return value - VNET_API_ERROR_API_ENDIAN_FAILED if f64_one != 1.0
213 @param f64_one_result - The value of 'f64 1.0'
215 define get_f64_endian_value_reply
222 /** \brief Verify f64 wire format by sending a value and receiving the value + 1.0
223 @param client_index - opaque cookie to identify the sender.
224 @param context - sender context, to match reply w/ request.
225 @param f64_value - The value you want to test. Default: 1.0.
227 define get_f64_increment_by_one
231 f64 f64_value [default=1.0];
234 /** \brief get_f64_increment_by_one reply
235 @param client_index - opaque cookie to identify the sender.
236 @param context - sender context, to match reply w/ request.
237 @param f64_value - The input f64_value incremented by 1.0.
239 define get_f64_increment_by_one_reply
248 * eval: (c-set-style "gnu")