1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
/* Hey Emacs use -*- mode: C -*- */
/*
* Copyright (c) 2015 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
option version = "2.1.0";
/*
* Define services not following the normal conventions here
*/
service {
rpc memclnt_rx_thread_suspend returns null;
rpc memclnt_read_timeout returns null;
rpc rx_thread_exit returns null;
rpc trace_plugin_msg_ids returns null;
};
/*
* Create a client registration
*/
manual_print
define memclnt_create {
u32 context; /* opaque value to be returned in the reply */
i32 ctx_quota; /* requested punt context quota */
u64 input_queue; /* client's queue */
string name [limit=64]; /* for show, find by name, whatever */
u32 api_versions[8]; /* client-server pairs use as desired */
};
define memclnt_create_reply {
u32 context; /* opaque value from the create request */
i32 response; /* Non-negative = success */
u64 handle; /* handle by which vlib knows this client */
u32 index; /* index, used e.g. by API trace replay */
u64 message_table; /* serialized message table in shmem */
};
/*
* Delete a client registration
*/
manual_print
define memclnt_delete {
u32 index; /* index, used e.g. by API trace replay */
u64 handle; /* handle by which vlib knows this client */
u8 do_cleanup; /* vlib to cleanup the registration */
};
define memclnt_delete_reply {
i32 response; /* Non-negative = success */
u64 handle; /* in case the client wonders */
};
/*
* Client RX thread exit
*/
define rx_thread_exit {
u8 dummy;
};
/*
* Client RX thread suspend
*/
define memclnt_rx_thread_suspend {
u8 dummy;
};
/*
* Client read timeout
*/
define memclnt_read_timeout {
u8 dummy;
};
/*
* RPC
*/
autoreply define rpc_call {
u32 client_index;
u32 context;
u64 function;
u8 multicast;
u8 need_barrier_sync;
u8 send_reply;
u32 data_len;
u8 data[data_len];
};
/*
* Lookup message-ID base by name
*/
define get_first_msg_id {
u32 client_index;
u32 context;
string name [limit=64];
};
define get_first_msg_id_reply {
u32 context;
i32 retval;
u16 first_msg_id;
};
/*
* Get API version table (includes built-in and plugins)
*/
typedef module_version {
u32 major;
u32 minor;
u32 patch;
string name [limit=64];
};
define api_versions {
u32 client_index;
u32 context;
};
define api_versions_reply {
u32 context;
i32 retval;
u32 count;
vl_api_module_version_t api_versions[count];
};
/*
* Trace the plugin message-id allocator
* so we stand a chance of dealing with different sets of plugins
* at api trace replay time
*/
manual_print define trace_plugin_msg_ids
{
u32 client_index;
u32 context;
string plugin_name [limit=128];
u16 first_msg_id;
u16 last_msg_id;
};
typedef message_table_entry
{
u16 index;
u8 name[64];
};
/*
* Create a socket client registration.
*/
define sockclnt_create {
u32 context; /* opaque value to be returned in the reply */
string name [limit=64]; /* for show, find by name, whatever */
};
define sockclnt_create_reply {
u32 client_index;
u32 context; /* opaque value from the create request */
i32 response; /* Non-negative = success */
u32 index; /* index, used e.g. by API trace replay */
u16 count;
vl_api_message_table_entry_t message_table[count];
};
/*
* Delete a client registration
*/
define sockclnt_delete {
u32 client_index;
u32 context;
u32 index; /* index, used e.g. by API trace replay */
};
define sockclnt_delete_reply {
u32 context;
i32 response; /* Non-negative = success */
};
/*
* Initialize shm api over socket api
*/
autoreply define sock_init_shm {
u32 client_index;
u32 context;
u32 requested_size;
u8 nitems;
u64 configs[nitems];
};
/* define sock_init_shm_reply {
u32 client_index;
u32 context;
i32 retval;
}; */
/*
* Memory client ping / response
* Only sent on inactive connections
*/
autoreply define memclnt_keepalive
{
u32 client_index;
u32 context;
};
|
