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.
20 * Create a client registration
23 define memclnt_create {
24 i32 ctx_quota; /* requested punt context quota */
25 u32 context; /* opaque value to be returned in the reply */
26 u64 input_queue; /* client's queue */
27 u8 name[64]; /* for show, find by name, whatever */
28 u32 api_versions[8]; /* client-server pairs use as desired */
31 define memclnt_create_reply {
32 i32 response; /* Non-negative = success */
33 u64 handle; /* handle by which vlib knows this client */
34 u32 index; /* index, used e.g. by API trace replay */
35 u32 context; /* opaque value from the create request */
36 u64 message_table; /* serialized message table in shmem */
40 * Delete a client registration
43 define memclnt_delete {
44 u32 index; /* index, used e.g. by API trace replay */
45 u64 handle; /* handle by which vlib knows this client */
48 define memclnt_delete_reply {
49 i32 response; /* Non-negative = success */
50 u64 handle; /* in case the client wonders */
54 * Client RX thread exit
56 define rx_thread_exit {
61 * Client RX thread suspend
63 define memclnt_rx_thread_suspend {
70 define memclnt_read_timeout {
77 autoreply define rpc_call {
88 * Lookup message-ID base by name
90 define get_first_msg_id {
96 define get_first_msg_id_reply {
104 * Get API version table (includes built-in and plugins)
106 typeonly define module_version {
112 define api_versions {
116 define api_versions_reply {
121 vl_api_module_version_t api_versions[count];
125 * Trace the plugin message-id allocator
126 * so we stand a chance of dealing with different sets of plugins
127 * at api trace replay time
130 manual_print define trace_plugin_msg_ids
140 * Create a socket client registration.
142 define sockclnt_create {
143 u8 name[64]; /* for show, find by name, whatever */
144 u32 context; /* opaque value to be returned in the reply */
147 define sockclnt_create_reply {
148 i32 response; /* Non-negative = success */
149 u64 handle; /* handle by which vlib knows this client */
150 u32 index; /* index, used e.g. by API trace replay */
151 u32 context; /* opaque value from the create request */
155 * Delete a client registration
157 define sockclnt_delete {
158 u32 index; /* index, used e.g. by API trace replay */
159 u64 handle; /* handle by which vlib knows this client */
162 define sockclnt_delete_reply {
163 i32 response; /* Non-negative = success */
164 u64 handle; /* in case the client wonders */
168 * Ask vpp for a memfd shared segment
170 define memfd_segment_create {
179 define memfd_segment_create_reply
187 * Initialize shm api over socket api
189 define sock_init_shm {
197 define sock_init_shm_reply {
204 * Memory client ping / response
205 * Only sent on inactive connections
207 autoreply define memclnt_keepalive