1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2015 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.
17 option version = "2.1.0";
20 * Define services not following the normal conventions here
23 rpc memclnt_rx_thread_suspend returns null;
24 rpc memclnt_read_timeout returns null;
25 rpc rx_thread_exit returns null;
26 rpc trace_plugin_msg_ids returns null;
30 * Create a client registration
32 define memclnt_create {
35 u32 context; /* opaque value to be returned in the reply */
36 i32 ctx_quota; /* requested punt context quota */
37 u64 input_queue; /* client's queue */
38 string name[64]; /* for show, find by name, whatever */
39 u32 api_versions[8]; /* client-server pairs use as desired */
42 define memclnt_create_reply {
45 u32 context; /* opaque value from the create request */
46 i32 response; /* Non-negative = success */
47 u64 handle; /* handle by which vlib knows this client */
48 u32 index; /* index, used e.g. by API trace replay */
49 u64 message_table; /* serialized message table in shmem */
53 * Delete a client registration
55 define memclnt_delete {
56 u32 index; /* index, used e.g. by API trace replay */
57 u64 handle; /* handle by which vlib knows this client */
58 bool do_cleanup; /* vlib to cleanup the registration */
61 define memclnt_delete_reply {
62 i32 response; /* Non-negative = success */
63 u64 handle; /* in case the client wonders */
67 * Client RX thread exit
69 define rx_thread_exit {
74 * Client RX thread suspend
76 define memclnt_rx_thread_suspend {
83 define memclnt_read_timeout {
90 autoreply define rpc_call {
102 * Lookup message-ID base by name
104 define get_first_msg_id {
110 define get_first_msg_id_reply {
117 * Get API version table (includes built-in and plugins)
119 typedef module_version {
125 define api_versions {
129 define api_versions_reply {
133 vl_api_module_version_t api_versions[count];
137 * Trace the plugin message-id allocator
138 * so we stand a chance of dealing with different sets of plugins
139 * at api trace replay time
142 define trace_plugin_msg_ids
146 string plugin_name[128];
151 typedef message_table_entry
158 * Create a socket client registration.
160 define sockclnt_create {
161 u32 context; /* opaque value to be returned in the reply */
162 string name[64]; /* for show, find by name, whatever */
165 define sockclnt_create_reply {
167 u32 context; /* opaque value from the create request */
168 i32 response; /* Non-negative = success */
169 u32 index; /* index, used e.g. by API trace replay */
171 vl_api_message_table_entry_t message_table[count];
175 * Delete a client registration
177 define sockclnt_delete {
180 u32 index; /* index, used e.g. by API trace replay */
183 define sockclnt_delete_reply {
185 i32 response; /* Non-negative = success */
189 * Initialize shm api over socket api
191 autoreply define sock_init_shm {
199 /* define sock_init_shm_reply {
206 * Memory client ping / response
207 * Only sent on inactive connections
209 autoreply define memclnt_keepalive
215 /** \brief Control ping from client to api server request
216 @param client_index - opaque cookie to identify the sender
217 @param context - sender context, to match reply w/ request
225 /** \brief Control ping from the client to the server response
226 @param client_index - opaque cookie to identify the sender
227 @param context - sender context, to match reply w/ request
228 @param retval - return code for the request
229 @param vpe_pid - the pid of the vpe, returned by the server
231 define control_ping_reply
239 define memclnt_create_v2 {
240 u32 context; /* opaque value to be returned in the reply */
241 i32 ctx_quota; /* requested punt context quota */
242 u64 input_queue; /* client's queue */
243 string name[64]; /* for show, find by name, whatever */
244 u32 api_versions[8]; /* client-server pairs use as desired */
245 bool keepalive[default=true]; /* dead client scan keepalives */
248 define memclnt_create_v2_reply {
249 u32 context; /* opaque value from the create request */
250 i32 response; /* Non-negative = success */
251 u64 handle; /* handle by which vlib knows this client */
252 u32 index; /* index, used e.g. by API trace replay */
253 u64 message_table; /* serialized message table in shmem */
256 define get_api_json {
261 define get_api_json_reply {