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 option version = "1.0.2";
18 /** \brief client->vpp, attach application to session layer
19 @param client_index - opaque cookie to identify the sender
20 @param context - sender context, to match reply w/ request
21 @param initial_segment_size - size of the initial shm segment to be
23 @param options - segment size, fifo sizes, etc.
24 @param namespace_id_len - length of the namespace id c-string
25 @param namespace_id - 0 terminted c-string
27 define application_attach {
30 u32 initial_segment_size;
36 /** \brief Application attach reply
37 @param context - sender context, to match reply w/ request
38 @param retval - return code for the request
39 @param app_event_queue_address - vpp event queue address or 0 if this
40 connection shouldn't send events
41 @param segment_size - size of first shm segment
42 @param segment_name_length - length of segment name
43 @param segment_name - name of segment client needs to attach to
45 define application_attach_reply {
48 u64 app_event_queue_address;
50 u8 segment_name_length;
54 /** \brief Application add TLS certificate
55 @param client_index - opaque cookie to identify the sender
56 @param context - sender context, to match reply w/ request
57 @param cert_len - certificate length
58 @param cert - certificate as a string
60 autoreply define application_tls_cert_add {
68 /** \brief Application add TLS key
69 @param client_index - opaque cookie to identify the sender
70 @param context - sender context, to match reply w/ request
71 @param key_len - certificate length
72 @param key - PEM encoded key as a string
74 autoreply define application_tls_key_add {
82 /** \brief client->vpp, attach application to session layer
83 @param client_index - opaque cookie to identify the sender
84 @param context - sender context, to match reply w/ request
86 autoreply define application_detach {
91 /** \brief vpp->client, please map an additional shared memory segment
92 @param client_index - opaque cookie to identify the sender
93 @param context - sender context, to match reply w/ request
96 autoreply define map_another_segment {
100 u8 segment_name[128];
103 /** \brief vpp->client unmap shared memory segment
104 @param client_index - opaque cookie to identify the sender
105 @param context - sender context, to match reply w/ request
106 @param segment_name -
108 autoreply define unmap_segment {
111 u8 segment_name[128];
114 /** \brief Bind to a given URI
115 @param client_index - opaque cookie to identify the sender
116 @param context - sender context, to match reply w/ request
117 @param accept_cookie - sender accept cookie, to identify this bind flavor
118 @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
119 "tcp://::/0/80" [ipv6] etc.
120 @param options - socket options, fifo sizes, etc.
122 autoreply define bind_uri {
129 /** \brief Unbind a given URI
130 @param client_index - opaque cookie to identify the sender
131 @param context - sender context, to match reply w/ request
132 @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
133 "tcp://::/0/80" [ipv6], etc.
134 @param options - socket options, fifo sizes, etc.
136 autoreply define unbind_uri {
142 /** \brief Connect to a given URI
143 @param client_index - opaque cookie to identify the sender
144 @param context - sender context, to match reply w/ request
145 @param client_queue_address - binary API client queue address. Used by
146 local server when connect was redirected.
147 @param options - socket options, fifo sizes, etc. passed by vpp to the
148 server when redirecting connects
149 @param uri - a URI, e.g. "tcp4://0.0.0.0/0/80"
150 "tcp6://::/0/80" [ipv6], etc.
152 autoreply define connect_uri {
155 u64 client_queue_address;
160 /** \brief vpp->client, accept this session
161 @param context - sender context, to match reply w/ request
162 @param listener_handle - tells client which listener this pertains to
163 @param handle - unique session identifier
164 @param rx_fifo_address - rx (vpp -> vpp-client) fifo address
165 @param tx_fifo_address - tx (vpp-client -> vpp) fifo address
166 @param vpp_event_queue_address - vpp's event queue address or client's
167 event queue for cut through
168 @param server_event_queue_address - server's event queue address for
170 @param port - remote port
171 @param is_ip4 - 1 if the ip is ip4
172 @param ip - remote ip
174 define accept_session {
181 u64 vpp_event_queue_address;
182 u64 server_event_queue_address;
188 /** \brief client->vpp, reply to an accept message
189 @param context - sender context, to match reply w/ request
190 @param retval - return code for the request
191 @param session_index - session index from accept_session / connect_reply
192 @param session_thread_index - thread index from accept_session /
195 define accept_session_reply {
201 /** \brief bidirectional disconnect API
202 @param client_index - opaque cookie to identify the sender
203 client to vpp direction only
204 @param context - sender context, to match reply w/ request
205 @param handle - session handle obtained from accept/connect
207 define disconnect_session {
213 /** \brief bidirectional disconnect reply API
214 @param client_index - opaque cookie to identify the sender
215 client to vpp direction only
216 @param context - sender context, to match reply w/ request
217 @param retval - return code for the request
218 @param handle - session handle
220 define disconnect_session_reply {
226 /** \brief vpp->client reset session API
227 @param client_index - opaque cookie to identify the sender
228 client to vpp direction only
229 @param context - sender context, to match reply w/ request
230 @param handle - session handle obtained via accept/connects
232 define reset_session {
238 /** \brief client->vpp reset session reply
239 @param client_index - opaque cookie to identify the sender
240 client to vpp direction only
241 @param context - sender context, to match reply w/ request
242 @param retval - return code for the request
243 @param handle - session handle obtained via accept/connect
245 define reset_session_reply {
252 /** \brief Bind to an ip:port pair for a given transport protocol
253 @param client_index - opaque cookie to identify the sender
254 @param context - sender context, to match reply w/ request
255 @param vrf - bind namespace
256 @param is_ip4 - flag that is 1 if ip address family is IPv4
257 @param ip - ip address
259 @param proto - protocol 0 - TCP 1 - UDP
260 @param options - socket options, fifo sizes, etc.
274 @param client_index - opaque cookie to identify the sender
275 @param context - sender context, to match reply w/ request
276 @param handle - bind handle obtained from bind reply
278 autoreply define unbind_sock {
284 /** \brief Connect to a remote peer
285 @param client_index - opaque cookie to identify the sender
286 @param context - sender context, to match reply w/ request
287 @param client_queue_address - client's API queue address. Non-zero when
288 used to perform redirects
289 @param options - socket options, fifo sizes, etc. when doing redirects
290 @param vrf - connection namespace
291 @param is_ip4 - flag that is 1 if ip address family is IPv4
292 @param ip - ip address
294 @param proto - protocol 0 - TCP 1 - UDP
295 @param hostname-len - length of hostname
296 @param hostname - destination's hostname. If present, used by protocols
299 autoreply define connect_sock {
302 u64 client_queue_address;
310 u8 hostname[hostname_len];
313 /** \brief Bind reply
314 @param context - sender context, to match reply w/ request
315 @param handle - bind handle
316 @param retval - return code for the request
317 @param event_queue_address - vpp event queue address or 0 if this
318 connection shouldn't send events
319 @param segment_name_length - length of segment name
320 @param segment_name - name of segment client needs to attach to
322 define bind_sock_reply {
326 u64 server_event_queue_address;
331 u8 segment_name_length;
332 u8 segment_name[128];
335 /* Dummy connect message -- needed to satisfy api generators
337 * NEVER USED, doxygen tags elided on purpose.
339 define connect_session {
344 /** \brief vpp/server->client, connect reply -- used for all connect_* messages
345 @param context - sender context, to match reply w/ request
346 @param retval - return code for the request
347 @param handle - connection handle
348 @param server_rx_fifo - rx (vpp -> vpp-client) fifo address
349 @param server_tx_fifo - tx (vpp-client -> vpp) fifo address
350 @param vpp_event_queue_address - vpp's event queue address
351 @param client_event_queue_address - client's event queue address
352 @param segment_size - size of segment to be attached. Only for redirects.
353 @param segment_name_length - non-zero if the client needs to attach to
355 @param segment_name - set if the client needs to attach to the segment
356 @param lcl_ip - local ip for connection
357 @param is_ip4 - flag to indicate if ip is v4 or v6
358 @param lcl_port - local port
360 define connect_session_reply {
366 u64 vpp_event_queue_address;
367 u64 client_event_queue_address;
369 u8 segment_name_length;
370 u8 segment_name[128];
376 /** \brief enable/disable session layer
377 @param client_index - opaque cookie to identify the sender
378 client to vpp direction only
379 @param context - sender context, to match reply w/ request
380 @param is_enable - disable session layer if 0, enable otherwise
382 autoreply define session_enable_disable {
388 /** \brief add/del application namespace
389 @param client_index - opaque cookie to identify the sender
390 client to vpp direction only
391 @param context - sender context, to match reply w/ request
392 @param secret - secret shared between app and vpp
393 @param sw_if_index - local interface that "supports" namespace. Set to
395 @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored
397 @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored
399 @param namespace_id_len - length of namespace id lower
400 @param namespace_id - namespace id
402 define app_namespace_add_del {
413 /** \brief Reply for app namespace add/del
414 @param context - returned sender context, to match reply w/ request
415 @param retval - return code
416 @param appns_index - app namespace index
418 define app_namespace_add_del_reply
425 /** \brief add/del session rule
426 @param client_index - opaque cookie to identify the sender
427 client to vpp direction only
428 @param context - sender context, to match reply w/ request
429 @param transport_proto - transport protocol (0 - tcp 1 - udp)
430 @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
431 @param lcl_ip - local ip
432 @param lcl_plen - local prefix length
433 @param rmt_ip - remote ip
434 @param rmt_ple - remote prefix length
435 @param lcl_port - local port
436 @param rmt_port - remote port
437 @param action_index - the only action defined now is forward to
438 application with index action_index
439 @param is_add - flag to indicate if add or del
440 @param appns_index - application namespace where rule is to be applied
442 @param scope - flag that indicates scope of the rule: global or local.
443 If 0, default is global, 1 is global 2 is local, 3 is
446 autoreply define session_rule_add_del {
464 /** \brief Dump session rules
465 @param client_index - opaque cookie to identify the sender
466 @param context - sender context, to match reply w/ request
468 define session_rules_dump
474 /** \brief Session rules details
475 @param context - sender context, to match reply w/ request
476 @param transport_proto - transport protocol (0 - tcp 1 - udp)
477 @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
478 @param lcl_ip - local ip
479 @param lcl_plen - local prefix length
480 @param rmt_ip - remote ip
481 @param rmt_ple - remote prefix length
482 @param lcl_port - local port
483 @param rmt_port - remote port
484 @param action_index - the only action defined now is forward to
485 application with index action_index
486 @param appns_index - application namespace where rule is to be applied
488 @param scope - flag that indicates scope of the rule: global or local.
489 If 0, default is global, 1 is global 2 is local, 3 is
492 define session_rules_details
511 * eval: (c-set-style "gnu")