2 * Copyright (c) 2015-2016 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 /** \brief client->vpp, attach application to session layer
17 @param client_index - opaque cookie to identify the sender
18 @param context - sender context, to match reply w/ request
19 @param initial_segment_size - size of the initial shm segment to be
21 @param options - segment size, fifo sizes, etc.
23 define application_attach {
26 u32 initial_segment_size;
30 /** \brief Application attach reply
31 @param context - sender context, to match reply w/ request
32 @param retval - return code for the request
33 @param app_event_queue_address - vpp event queue address or 0 if this
34 connection shouldn't send events
35 @param segment_size - size of first shm segment
36 @param segment_name_length - length of segment name
37 @param segment_name - name of segment client needs to attach to
39 define application_attach_reply {
42 u64 app_event_queue_address;
44 u8 segment_name_length;
48 /** \brief client->vpp, attach application to session layer
49 @param client_index - opaque cookie to identify the sender
50 @param context - sender context, to match reply w/ request
52 autoreply define application_detach {
57 /** \brief vpp->client, please map an additional shared memory segment
58 @param client_index - opaque cookie to identify the sender
59 @param context - sender context, to match reply w/ request
62 autoreply define map_another_segment {
69 /** \brief Bind to a given URI
70 @param client_index - opaque cookie to identify the sender
71 @param context - sender context, to match reply w/ request
72 @param accept_cookie - sender accept cookie, to identify this bind flavor
73 @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
74 "tcp://::/0/80" [ipv6] etc.
75 @param options - socket options, fifo sizes, etc.
77 autoreply define bind_uri {
84 /** \brief Unbind a given URI
85 @param client_index - opaque cookie to identify the sender
86 @param context - sender context, to match reply w/ request
87 @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
88 "tcp://::/0/80" [ipv6], etc.
89 @param options - socket options, fifo sizes, etc.
91 autoreply define unbind_uri {
97 /** \brief Connect to a given URI
98 @param client_index - opaque cookie to identify the sender
99 @param context - sender context, to match reply w/ request
100 @param accept_cookie - sender accept cookie, to identify this bind flavor
101 @param uri - a URI, e.g. "tcp4://0.0.0.0/0/80"
102 "tcp6://::/0/80" [ipv6], etc.
103 @param options - socket options, fifo sizes, etc. passed by vpp to the
104 server when redirecting connects
105 @param client_queue_address - binary API client queue address. Used by
106 local server when connect was redirected.
112 u64 client_queue_address;
116 /** \brief vpp->client, connect reply
117 @param context - sender context, to match reply w/ request
118 @param retval - return code for the request
119 @param handle - session handle
120 @param server_rx_fifo - rx (vpp -> vpp-client) fifo address
121 @param server_tx_fifo - tx (vpp-client -> vpp) fifo address
122 @param vpp_event_queue_address - vpp's event queue address
123 @param segment_size - size of segment to be attached. Only for redirects.
124 @param segment_name_length - non-zero if the client needs to attach to
125 the fifo segment. This should only happen
126 if session was redirected.
127 @param segment_name - set if the client needs to attach to the segment
129 define connect_uri_reply {
135 u64 vpp_event_queue_address;
137 u8 segment_name_length;
138 u8 segment_name[128];
141 /** \brief vpp->client, accept this session
142 @param context - sender context, to match reply w/ request
143 @param listener_handle - tells client which listener this pertains to
144 @param handle - unique session identifier
145 @param session_thread_index - thread index of new session
146 @param rx_fifo_address - rx (vpp -> vpp-client) fifo address
147 @param tx_fifo_address - tx (vpp-client -> vpp) fifo address
148 @param vpp_event_queue_address - vpp's event queue address
149 @param port - remote port
150 @param is_ip4 - 1 if the ip is ip4
151 @param ip - remote ip
153 define accept_session {
160 u64 vpp_event_queue_address;
166 /** \brief client->vpp, reply to an accept message
167 @param context - sender context, to match reply w/ request
168 @param retval - return code for the request
169 @param session_index - session index from accept_session / connect_reply
170 @param session_thread_index - thread index from accept_session /
173 define accept_session_reply {
179 /** \brief bidirectional disconnect API
180 @param client_index - opaque cookie to identify the sender
181 client to vpp direction only
182 @param context - sender context, to match reply w/ request
183 @param handle - session handle obtained from accept/connect
185 define disconnect_session {
191 /** \brief bidirectional disconnect reply API
192 @param client_index - opaque cookie to identify the sender
193 client to vpp direction only
194 @param context - sender context, to match reply w/ request
195 @param retval - return code for the request
196 @param handle - session handle
198 define disconnect_session_reply {
205 /** \brief vpp->client reset session API
206 @param client_index - opaque cookie to identify the sender
207 client to vpp direction only
208 @param context - sender context, to match reply w/ request
209 @param handle - session handle obtained via accept/connects
211 define reset_session {
217 /** \brief client->vpp reset session reply
218 @param client_index - opaque cookie to identify the sender
219 client to vpp direction only
220 @param context - sender context, to match reply w/ request
221 @param retval - return code for the request
222 @param handle - session handle obtained via accept/connect
224 define reset_session_reply {
231 /** \brief Bind to an ip:port pair for a given transport protocol
232 @param client_index - opaque cookie to identify the sender
233 @param context - sender context, to match reply w/ request
234 @param vrf - bind namespace
235 @param is_ip4 - flag that is 1 if ip address family is IPv4
236 @param ip - ip address
238 @param proto - protocol 0 - TCP 1 - UDP
239 @param options - socket options, fifo sizes, etc.
253 @param client_index - opaque cookie to identify the sender
254 @param context - sender context, to match reply w/ request
255 @param handle - bind handle obtained from bind reply
257 autoreply define unbind_sock {
263 /** \brief Connect to a remote peer
264 @param client_index - opaque cookie to identify the sender
265 @param context - sender context, to match reply w/ request
266 @param app_connect - application connection id to be returned in reply
267 @param vrf - connection namespace
268 @param is_ip4 - flag that is 1 if ip address family is IPv4
269 @param ip - ip address
271 @param proto - protocol 0 - TCP 1 - UDP
272 @param client_queue_address - client's API queue address. Non-zero when
273 used to perform redirects
274 @param options - socket options, fifo sizes, etc. when doing redirects
276 define connect_sock {
285 u64 client_queue_address;
289 /** \brief Bind reply
290 @param context - sender context, to match reply w/ request
291 @param handle - bind handle
292 @param retval - return code for the request
293 @param event_queue_address - vpp event queue address or 0 if this
294 connection shouldn't send events
295 @param segment_name_length - length of segment name
296 @param segment_name - name of segment client needs to attach to
298 define bind_sock_reply {
302 u64 server_event_queue_address;
304 u8 segment_name_length;
305 u8 segment_name[128];
308 /** \brief vpp/server->client, connect reply
309 @param context - sender context, to match reply w/ request
310 @param retval - return code for the request
311 @param handle - connection handle
312 @param app_connect - application connection id from connect msg
313 @param server_rx_fifo - rx (vpp -> vpp-client) fifo address
314 @param server_tx_fifo - tx (vpp-client -> vpp) fifo address
315 @param vpp_event_queue_address - vpp's event queue address
316 @param segment_size - size of segment to be attached. Only for redirects.
317 @param segment_name_length - non-zero if the client needs to attach to
319 @param segment_name - set if the client needs to attach to the segment
321 define connect_sock_reply {
328 u64 vpp_event_queue_address;
330 u8 segment_name_length;
331 u8 segment_name[128];
334 /** \brief enable/disable session layer
335 @param client_index - opaque cookie to identify the sender
336 client to vpp direction only
337 @param context - sender context, to match reply w/ request
338 @param is_enable - disable session layer if 0, enable otherwise
340 autoreply define session_enable_disable {
348 * eval: (c-set-style "gnu")