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.3.0";
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 n_fds - number of fds exchanged
42 @param fd_flags - set of flags that indicate which fds are to be expected
43 over the socket (set only if socket transport available)
44 @param segment_size - size of first shm segment
45 @param segment_name_length - length of segment name
46 @param segment_name - name of segment client needs to attach to
47 @param app_index - index of the newly created app
49 define application_attach_reply {
52 u64 app_event_queue_address;
56 u8 segment_name_length;
61 /** \brief Application add TLS certificate
62 @param client_index - opaque cookie to identify the sender
63 @param context - sender context, to match reply w/ request
64 @param cert_len - certificate length
65 @param cert - certificate as a string
67 autoreply define application_tls_cert_add {
75 /** \brief Application add TLS key
76 @param client_index - opaque cookie to identify the sender
77 @param context - sender context, to match reply w/ request
78 @param key_len - certificate length
79 @param key - PEM encoded key as a string
81 autoreply define application_tls_key_add {
89 /** \brief client->vpp, attach application to session layer
90 @param client_index - opaque cookie to identify the sender
91 @param context - sender context, to match reply w/ request
93 autoreply define application_detach {
98 /** \brief vpp->client, please map an additional shared memory segment
99 @param client_index - opaque cookie to identify the sender
100 @param context - sender context, to match reply w/ request
101 @param fd_flags - set of flags that indicate which, if any, fds are
102 to be expected over the socket. This is set only if
103 socket transport available
104 @param segment_size - size of the segment to be mapped
105 @param segment_name - name of the segment to be mapped
107 autoreply define map_another_segment {
112 u8 segment_name[128];
115 /** \brief vpp->client unmap shared memory segment
116 @param client_index - opaque cookie to identify the sender
117 @param context - sender context, to match reply w/ request
118 @param segment_name -
120 autoreply define unmap_segment {
123 u8 segment_name[128];
126 /** \brief Bind to a given URI
127 @param client_index - opaque cookie to identify the sender
128 @param context - sender context, to match reply w/ request
129 @param accept_cookie - sender accept cookie, to identify this bind flavor
130 @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
131 "tcp://::/0/80" [ipv6] etc.
132 @param options - socket options, fifo sizes, etc.
140 /** *** Will be DEPRECATED. Use message queue instead. *** */
141 define bind_uri_reply {
153 /** \brief Unbind a given URI
154 @param client_index - opaque cookie to identify the sender
155 @param context - sender context, to match reply w/ request
156 @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
157 "tcp://::/0/80" [ipv6], etc.
158 @param options - socket options, fifo sizes, etc.
160 autoreply define unbind_uri {
166 /** \brief Connect to a given URI
167 @param client_index - opaque cookie to identify the sender
168 @param context - sender context, to match reply w/ request
169 @param client_queue_address - binary API client queue address. Used by
170 local server when connect was redirected.
171 @param options - socket options, fifo sizes, etc. passed by vpp to the
172 server when redirecting connects
173 @param uri - a URI, e.g. "tcp4://0.0.0.0/0/80"
174 "tcp6://::/0/80" [ipv6], etc.
176 autoreply define connect_uri {
179 u64 client_queue_address;
184 /** \brief vpp->client, accept this session
185 *** Will be DEPRECATED. Use message queue instead. ***
186 @param context - sender context, to match reply w/ request
187 @param listener_handle - tells client which listener this pertains to
188 @param handle - unique session identifier
189 @param rx_fifo_address - rx (vpp -> vpp-client) fifo address
190 @param tx_fifo_address - tx (vpp-client -> vpp) fifo address
191 @param vpp_event_queue_address - vpp's event queue address or client's
192 event queue for cut through
193 @param server_event_queue_address - server's event queue address for
195 @param port - remote port
196 @param is_ip4 - 1 if the ip is ip4
197 @param ip - remote ip
199 define accept_session {
206 u64 vpp_event_queue_address;
207 u64 server_event_queue_address;
213 /** \brief client->vpp, reply to an accept message
214 *** Will be DEPRECATED. Use message queue instead. ***
215 @param context - sender context, to match reply w/ request
216 @param retval - return code for the request
217 @param session_index - session index from accept_session / connect_reply
218 @param session_thread_index - thread index from accept_session /
221 define accept_session_reply {
227 /** \brief bidirectional disconnect API
228 @param client_index - opaque cookie to identify the sender
229 client to vpp direction only
230 @param context - sender context, to match reply w/ request
231 @param handle - session handle obtained from accept/connect
233 define disconnect_session {
239 /** \brief bidirectional disconnect reply API
240 *** Will be DEPRECATED. Use message queue instead. ***
241 @param client_index - opaque cookie to identify the sender
242 client to vpp direction only
243 @param context - sender context, to match reply w/ request
244 @param retval - return code for the request
245 @param handle - session handle
247 define disconnect_session_reply {
253 /** \brief vpp->client reset session API
254 *** Will be DEPRECATED. Use message queue instead. ***
255 @param client_index - opaque cookie to identify the sender
256 client to vpp direction only
257 @param context - sender context, to match reply w/ request
258 @param handle - session handle obtained via accept/connects
260 define reset_session {
266 /** \brief client->vpp reset session reply
267 *** Will be DEPRECATED. Use message queue instead. ***
268 @param context - sender context, to match reply w/ request
269 @param retval - return code for the request
270 @param handle - session handle obtained via accept/connect
272 define reset_session_reply {
278 /** \brief Bind to an ip:port pair for a given transport protocol
279 @param client_index - opaque cookie to identify the sender
280 @param context - sender context, to match reply w/ request
281 @param wrk_index - index of worker requesting the bind
282 @param vrf - bind namespace
283 @param is_ip4 - flag that is 1 if ip address family is IPv4
284 @param ip - ip address
286 @param proto - protocol 0 - TCP 1 - UDP
287 @param options - socket options, fifo sizes, etc.
302 @param client_index - opaque cookie to identify the sender
303 @param context - sender context, to match reply w/ request
304 @param wrk_index - index of worker requesting the bind
305 @param handle - bind handle obtained from bind reply
307 autoreply define unbind_sock {
314 /** \brief Connect to a remote peer
315 @param client_index - opaque cookie to identify the sender
316 @param context - sender context, to match reply w/ request
317 @param wrk_index - worker that requests the connect
318 @param client_queue_address - client's API queue address. Non-zero when
319 used to perform redirects
320 @param options - socket options, fifo sizes, etc. when doing redirects
321 @param vrf - connection namespace
322 @param is_ip4 - flag that is 1 if ip address family is IPv4
323 @param ip - ip address
325 @param proto - protocol 0 - TCP 1 - UDP
326 @param hostname-len - length of hostname
327 @param hostname - destination's hostname. If present, used by protocols
330 autoreply define connect_sock {
334 u64 client_queue_address;
342 u8 hostname[hostname_len];
345 /** \brief Bind reply
346 *** Will be DEPRECATED. Use message queue instead. ***
347 @param context - sender context, to match reply w/ request
348 @param handle - bind handle
349 @param retval - return code for the request
350 @param lcl_is_ip4 - local ip address type
351 @param lcl_ip6 - local ip address
352 @param lcl_port - local port
353 @param rx_fifo - rx fifo address if allocated (connectionless)
354 @param tx_fifo - tx fifo address if allocated (connectionless)
355 @param vpp_evt_q - vpp event queue address (connectionless)
356 @param segment_name_length - length of segment name
357 @param segment_name - name of segment client needs to attach to
359 define bind_sock_reply {
370 u8 segment_name_length;
371 u8 segment_name[128];
374 /* Dummy connect message -- needed to satisfy api generators
376 * NEVER USED, doxygen tags elided on purpose.
378 define connect_session {
383 /** \brief vpp/server->client, connect reply -- used for all connect_* messages
384 *** Will be DEPRECATED. Use message queue instead. ***
385 @param context - sender context, to match reply w/ request
386 @param retval - return code for the request
387 @param handle - connection handle
388 @param server_rx_fifo - rx (vpp -> vpp-client) fifo address
389 @param server_tx_fifo - tx (vpp-client -> vpp) fifo address
390 @param vpp_event_queue_address - vpp's event queue address
391 @param client_event_queue_address - client's event queue address
392 @param segment_size - size of segment to be attached. Only for redirects.
393 @param segment_name_length - non-zero if the client needs to attach to
395 @param segment_name - set if the client needs to attach to the segment
396 @param lcl_ip - local ip for connection
397 @param is_ip4 - flag to indicate if ip is v4 or v6
398 @param lcl_port - local port
400 define connect_session_reply {
406 u64 vpp_event_queue_address;
407 u64 client_event_queue_address;
409 u8 segment_name_length;
410 u8 segment_name[128];
416 /** \brief ask app to add a new cut-through registration
417 @param client_index - opaque cookie to identify the sender
418 client to vpp direction only
419 @param context - sender context, to match reply w/ request
420 @param evt_q_address - address of the mq in ssvm segment
421 @param peer_evt_q_address - address of peer's mq in ssvm segment
422 @param wrk_index - index of worker to receive the registration
423 @param n_fds - number of fds exchanged
424 @param fd_flags - flag indicating the fds that will be exchanged over
427 autoreply define app_cut_through_registration_add
432 u64 peer_evt_q_address;
438 /** \brief add/del application worker
439 @param client_index - opaque cookie to identify the sender
440 client to vpp direction only
441 @param context - sender context, to match reply w/ request
442 @param app_index - application index
443 @param wrk_index - worker index, if a delete
444 @param is_add - set if an add
446 define app_worker_add_del
455 /** \brief Reply for app worker add/del
456 @param context - returned sender context, to match reply w/ request
457 @param retval - return code
458 @param wrk_index - worker index, if add
459 @param app_event_queue_address - vpp event queue address of new worker
460 @param n_fds - number of fds exchanged
461 @param fd_flags - set of flags that indicate which fds are to be expected
462 over the socket (set only if socket transport available)
463 @param segment_name_length - length of segment name
464 @param segment_name - name of segment client needs to attach to
466 define app_worker_add_del_reply
471 u64 app_event_queue_address;
474 u8 segment_name_length;
475 u8 segment_name[128];
479 /** \brief enable/disable session layer
480 @param client_index - opaque cookie to identify the sender
481 client to vpp direction only
482 @param context - sender context, to match reply w/ request
483 @param is_enable - disable session layer if 0, enable otherwise
485 autoreply define session_enable_disable {
491 /** \brief add/del application namespace
492 @param client_index - opaque cookie to identify the sender
493 client to vpp direction only
494 @param context - sender context, to match reply w/ request
495 @param secret - secret shared between app and vpp
496 @param sw_if_index - local interface that "supports" namespace. Set to
498 @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored
500 @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored
502 @param namespace_id_len - length of namespace id lower
503 @param namespace_id - namespace id
505 define app_namespace_add_del {
516 /** \brief Reply for app namespace add/del
517 @param context - returned sender context, to match reply w/ request
518 @param retval - return code
519 @param appns_index - app namespace index
521 define app_namespace_add_del_reply
528 /** \brief add/del session rule
529 @param client_index - opaque cookie to identify the sender
530 client to vpp direction only
531 @param context - sender context, to match reply w/ request
532 @param transport_proto - transport protocol (0 - tcp 1 - udp)
533 @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
534 @param lcl_ip - local ip
535 @param lcl_plen - local prefix length
536 @param rmt_ip - remote ip
537 @param rmt_ple - remote prefix length
538 @param lcl_port - local port
539 @param rmt_port - remote port
540 @param action_index - the only action defined now is forward to
541 application with index action_index
542 @param is_add - flag to indicate if add or del
543 @param appns_index - application namespace where rule is to be applied
545 @param scope - flag that indicates scope of the rule: global or local.
546 If 0, default is global, 1 is global 2 is local, 3 is
549 autoreply define session_rule_add_del {
567 /** \brief Dump session rules
568 @param client_index - opaque cookie to identify the sender
569 @param context - sender context, to match reply w/ request
571 define session_rules_dump
577 /** \brief Session rules details
578 @param context - sender context, to match reply w/ request
579 @param transport_proto - transport protocol (0 - tcp 1 - udp)
580 @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
581 @param lcl_ip - local ip
582 @param lcl_plen - local prefix length
583 @param rmt_ip - remote ip
584 @param rmt_ple - remote prefix length
585 @param lcl_port - local port
586 @param rmt_port - remote port
587 @param action_index - the only action defined now is forward to
588 application with index action_index
589 @param appns_index - application namespace where rule is to be applied
591 @param scope - flag that indicates scope of the rule: global or local.
592 If 0, default is global, 1 is global 2 is local, 3 is
595 define session_rules_details
614 * eval: (c-set-style "gnu")